diff --git a/.fern/metadata.json b/.fern/metadata.json new file mode 100644 index 00000000..757181e8 --- /dev/null +++ b/.fern/metadata.json @@ -0,0 +1,12 @@ +{ + "cliVersion": "3.0.2", + "generatorName": "fernapi/fern-java-sdk", + "generatorVersion": "3.21.0", + "generatorConfig": { + "enable-inline-types": true, + "client-class-name": "Intercom", + "inline-path-parameters": true, + "enable-forward-compatible-enums": true, + "enable-wire-tests": false + } +} \ No newline at end of file diff --git a/.fernignore b/.fernignore new file mode 100644 index 00000000..88a7de55 --- /dev/null +++ b/.fernignore @@ -0,0 +1,6 @@ +# Specify files that shouldn't be modified by Fern + +src/test/java/com/intercom/api/integration +src/test/java/com/intercom/api/utils + +.github/workflows/ci.yml diff --git a/.github/workflows-disabled/ci.yml b/.github/workflows-disabled/ci.yml new file mode 100644 index 00000000..923e5103 --- /dev/null +++ b/.github/workflows-disabled/ci.yml @@ -0,0 +1,67 @@ +name: ci + +on: [push] + +jobs: + compile: + runs-on: ubuntu-latest + + steps: + - name: Checkout repo + uses: actions/checkout@v3 + + - name: Set up Java + id: setup-jre + uses: actions/setup-java@v1 + with: + java-version: "11" + architecture: x64 + + - name: Compile + run: ./gradlew compileJava + + test: + needs: [ compile ] + runs-on: ubuntu-latest + steps: + - name: Checkout repo + uses: actions/checkout@v3 + + - name: Set up Java + id: setup-jre + uses: actions/setup-java@v1 + with: + java-version: "11" + architecture: x64 + + - name: Test + run: ./gradlew test + env: + INTERCOM_API_KEY: ${{ secrets.INTERCOM_API_KEY }} + + publish: + needs: [ compile ] + if: github.event_name == 'push' && contains(github.ref, 'refs/tags/') + runs-on: ubuntu-latest + + steps: + - name: Checkout repo + uses: actions/checkout@v3 + + - name: Set up Java + id: setup-jre + uses: actions/setup-java@v1 + with: + java-version: "11" + architecture: x64 + + - name: Publish to maven + run: | + ./gradlew sonatypeCentralUpload -x test + env: + MAVEN_USERNAME: ${{ secrets.MAVEN_USERNAME }} + MAVEN_PASSWORD: ${{ secrets.MAVEN_PASSWORD }} + MAVEN_PUBLISH_REGISTRY_URL: "https://s01.oss.sonatype.org/content/repositories/releases/" + MAVEN_SIGNATURE_KID: ${{ secrets.MAVEN_SIGNATURE_KID }} + MAVEN_SIGNATURE_SECRET_KEY: ${{ secrets.MAVEN_SIGNATURE_SECRET_KEY }} + MAVEN_SIGNATURE_PASSWORD: ${{ secrets.MAVEN_SIGNATURE_PASSWORD }} diff --git a/.gitignore b/.gitignore index edcdd547..d4199abc 100644 --- a/.gitignore +++ b/.gitignore @@ -1,14 +1,24 @@ -*/**/SpikeMain.java -.gradle *.class -out/* +.project +.gradle +? +.classpath +.checkstyle +.settings +.node +build + +# IntelliJ *.iml *.ipr *.iws -build -*/build/* -*/build/**/*.jar -*.war -*.ear -hs_err_pid* -.idea +.idea/ +out/ + +# Eclipse/IntelliJ APT +generated_src/ +generated_testSrc/ +generated/ + +bin +build \ No newline at end of file diff --git a/.publish/prepare.sh b/.publish/prepare.sh new file mode 100755 index 00000000..df3948e3 --- /dev/null +++ b/.publish/prepare.sh @@ -0,0 +1,8 @@ +# Write key ring file +echo "$MAVEN_SIGNATURE_SECRET_KEY" > armored_key.asc +gpg -o publish_key.gpg --dearmor armored_key.asc + +# Generate gradle.properties file +echo "signing.keyId=$MAVEN_SIGNATURE_KID" > gradle.properties +echo "signing.secretKeyRingFile=publish_key.gpg" >> gradle.properties +echo "signing.password=$MAVEN_SIGNATURE_PASSWORD" >> gradle.properties diff --git a/CHANGES.md b/CHANGES.md deleted file mode 100644 index db5e1592..00000000 --- a/CHANGES.md +++ /dev/null @@ -1,56 +0,0 @@ -### Changes - -#### 1.0.3 - -encode social profile urls for user objects - -#### 1.0.2 - -- fix NPE when errors have no data [30](https://github.com/intercom/intercom-java/pull/30) - -#### 1.0.1 - - - send custom company attributes on update - - - fix NPE when company has no plan on update - - - invalidate setSessionCount on Company [27](https://github.com/intercom/intercom-java/issues/27) - -#### 1.0.0 - - - removed tag methods requiring collections - - - handle non-json error entities from server - -#### 0.1.0 - - - support untag of users and companies - - - renamed of current page and page methods on collections (breaking) - -#### 0.0.5 - -- fix bulk user tagging when using fully populated users [13](https://github.com/intercom/intercom-java/issues/13) -- add client side validation of events [14](https://github.com/intercom/intercom-java/issues/14) -- fix npe when updating users [15](https://github.com/intercom/intercom-java/issues/15) - - -#### 0.0.4 - -- send false boolean values for user updates [8](https://github.com/intercom/intercom-java/issues/8) - -#### 0.0.3 - -- only send allowed fields when adding a company to a user [7](https://github.com/intercom/intercom-java/issues/7) - -#### 0.0.2 - - - add toString methods on some classes - -#### 0.0.1 - - - fix bintray publication task (was sending empty jars) - -#### 0.0.0 - - - initial client diff --git a/LICENSE b/LICENSE deleted file mode 100644 index 305509fc..00000000 --- a/LICENSE +++ /dev/null @@ -1,202 +0,0 @@ - - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - -TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - -1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - -2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - -3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - -4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - -5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - -6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - -7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - -8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - -9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - -END OF TERMS AND CONDITIONS - -APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "[]" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - -Copyright 2014 Intercom, Inc. - -Licensed under the Apache License, Version 2.0 (the "License"); -you may not use this file except in compliance with the License. -You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. \ No newline at end of file diff --git a/README.md b/README.md index ac69e137..8ba7df9c 100644 --- a/README.md +++ b/README.md @@ -1,542 +1,318 @@ -[![Circle CI](https://circleci.com/gh/intercom/intercom-java.png?style=badge)](https://circleci.com/gh/intercom/intercom-java) +# Intercom Java Library -# intercom-java +[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2Fintercom%2Fintercom-java) +[![Maven Central](https://img.shields.io/maven-central/v/io.intercom/intercom-java)](https://central.sonatype.com/artifact/io.intercom/intercom-java) -Java bindings for the [Intercom API](https://api.intercom.io/docs) +The Intercom Java library provides convenient access to the Intercom APIs from Java. - - [Installation](#installation) - - [Resources](#resources) - - [Authorization](#authorization) - - [Usage](#usage) - - [Idioms](#idioms) - - [Configuration](#configuration) +## Table of Contents +- [Installation](#installation) +- [Reference](#reference) +- [Usage](#usage) +- [Environments](#environments) +- [Base Url](#base-url) +- [Exception Handling](#exception-handling) +- [Advanced](#advanced) + - [Custom Client](#custom-client) + - [Retries](#retries) + - [Timeouts](#timeouts) + - [Custom Headers](#custom-headers) + - [Access Raw Response Data](#access-raw-response-data) +- [Contributing](#contributing) -## Add a dependency +## Installation -[ ![Download](https://api.bintray.com/packages/intercom/intercom-maven/intercom-java/images/download.svg) ](https://bintray.com/intercom/intercom-maven/intercom-java/_latestVersion) +### Gradle -The distribution is hosted on [bintray](https://bintray.com/intercom/intercom-maven/intercom-java/view). -To use the client, you can add the jcenter repository to your dependencies. +Add the dependency in your `build.gradle` file: -### maven +```groovy +dependencies { + implementation 'io.intercom:intercom-java' +} +``` -Add jcenter to your repositories in `pom.xml` or `settings.xml`: +### Maven + +Add the dependency in your `pom.xml` file: -```xml - - - jcenter - http://jcenter.bintray.com - - -``` - -and add the project declaration to your `pom.xml`: - ```xml io.intercom intercom-java - 1.0.3 + 4.0.4 ``` -### gradle +## Reference -Add jcenter to your `repositories` block: +A full reference for this library is available [here](https://github.com/intercom/intercom-java/blob/HEAD/./reference.md). -```groovy -repositories { - jcenter() -} -``` +## Usage -and add the project to the `dependencies` block in your `build.gradle`: +Instantiate and use the client with the following: -```groovy -dependencies { - compile 'io.intercom:intercom-java:1.0.3' -} +```java +package com.example.usage; + +import com.intercom.api.Intercom; +import com.intercom.api.resources.aicontent.requests.CreateContentImportSourceRequest; + +public class Example { + public static void main(String[] args) { + Intercom client = Intercom + .builder() + .token("") + .build(); + + client.aiContent().createContentImportSource( + CreateContentImportSourceRequest + .builder() + .url("https://www.example.com") + .build() + ); + } +} ``` +## Environments -## Resources - -Resources this API supports: - -- [Users](#users) -- [Companies](#companies) -- [Admins](#admins) -- [Events](#events) -- [Tags](#tags) -- [Segments](#segments) -- [Notes](#notes) -- [Conversations](#conversations) -- [Messages](#messages) -- [Counts](#counts) -- [Webhooks](#webhooks) +This SDK allows you to configure different environments for API requests. +```java +import com.intercom.api.Intercom; +import com.intercom.api.core.Environment; +Intercom client = Intercom + .builder() + .environment(Environment.USProduction) + .build(); +``` -## Authorization +## Base Url -You can set the app's id and api key via the `Intercom` object - +You can set a custom base URL when constructing the client. ```java -Intercom.setAppID("pi3243fa"); -Intercom.setApiKey("da39a3ee5e6b4b0d3255bfef95601890afd80709"); -``` +import com.intercom.api.Intercom; +Intercom client = Intercom + .builder() + .url("https://example.com") + .build(); +``` -## Usage +## Exception Handling -### Users +When the API returns a non-success status code (4xx or 5xx response), an API exception will be thrown. ```java -// Create a user -User user = new User() - .setEmail("malcolm@serenity.io") - .setUserId("1") - .addCustomAttribute(CustomAttribute.newStringAttribute("role", "sergeant")) - .addCustomAttribute(CustomAttribute.newBooleanAttribute("browncoat", true)); -User created = User.create(user); - -// Find user by id -user = User.find("541a144b201ebf2ec5000001"); - -// Find user by email -Map params = Maps.newHashMap(); -params.put("email", "malcolm@serenity.io"); -user = User.find(params); - -// Find user by user_id -params = Maps.newHashMap(); -params.put("user_id", "1"); -user = User.find(params); - -// Update custom_attributes for a user -user.addCustomAttribute(CustomAttribute.newStringAttribute("role", "captain")); -User.update(user); - -// Iterate over all users -UserCollection users = User.list(); -while(users.hasNext()) { - System.out.println(users.next().getUserId()); +import com.intercom.api.core.IntercomApiApiException; + +try{ + client.aiContent().createContentImportSource(...); +} catch (IntercomApiApiException e){ + // Do something with the API exception... } ``` -### Companies +## Advanced -```java -// Create a company -Company company = new Company(); - company.setName("Blue Sun"); - company.setCompanyID("1"); - company.setPlan(new Company.Plan("premium")); - company.addCustomAttribute(CustomAttribute.newIntegerAttribute("foddstuff-items", 246)); - company.addCustomAttribute(CustomAttribute.newStringAttribute("bestseller", "fruity oaty bar")); -Company.create(company); - -// Find a company by company_id -map = Maps.newHashMap(); -map.put("company_id", "1"); -Company company = Company.find(map); - -// Find a company by name -map = Maps.newHashMap(); -map.put("name", "Blue Sun"); -Company company = Company.find(map); - -// Find a company by id -Company company = Company.find("541a144b201ebf2ec5000001"); - -// Update a company -company.setName("Blue Sun Corporation"); -Company.update(company); - -// Iterate over all companies -CompanyCollection companies = Company.list(); -while(companies.hasNext()) { - System.out.println(companies.next().getName()); -} +### Custom Client -// Get a list of users in a company -map = Maps.newHashMap(); -map.put("company_id", "6"); -UserCollection users = Company.listUsers(map); +This SDK is built to work with any instance of `OkHttpClient`. By default, if no client is provided, the SDK will construct one. +However, you can pass your own client like so: -// Add a user to one or more companies -User user = User.find("541a144b201ebf2ec5000001"); -user.addCompany(company); -User.update(user); -``` +```java +import com.intercom.api.Intercom; +import okhttp3.OkHttpClient; -### Admins +OkHttpClient customClient = ...; -```java -// Iterate over all admins -AdminCollection admins = Admin.list(); -while(admins.hasNext()) { - System.out.println(admins.next().getName()); -} +Intercom client = Intercom + .builder() + .httpClient(customClient) + .build(); ``` +### Retries -### Events +The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long +as the request is deemed retryable and the number of retry attempts has not grown larger than the configured +retry limit (default: 2). Before defaulting to exponential backoff, the SDK will first attempt to respect +the `Retry-After` header (as either in seconds or as an HTTP date), and then the `X-RateLimit-Reset` header +(as a Unix timestamp in epoch seconds); failing both of those, it will fall back to exponential backoff. -```java -Event event = new Event().setEventName("bought-hat") - .setUserID("1") - .putMetadata("invitee_email", "jayne@serenity.io") - .putMetadata("found_date", System.currentTimeMillis()) - .putMetadata("new_signup", true); -Event.create(event); -``` +A request is deemed retryable when any of the following HTTP status codes is returned: +- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout) +- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests) +- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors) -### Tags +Use the `maxRetries` client option to configure this behavior. ```java -// create a tag -Tag tag = new Tag().setName("alliance"); -tag = Tag.create(tag); - -// update a tag -tag.setName("independent"); -tag = Tag.update(tag); - -// tag and untag users -User one = new User().setEmail("river@serenity.io"); -User two = new User().setEmail("simon@serenity.io").untag(); -User.create(one); -User.create(two); -Tag.tag(tag, one, two); - -// iterate over all tags -final TagCollection tags = Tag.list(); -while (tags.hasNext()) { - System.out.println(tags.next().getId()); -} +import com.intercom.api.Intercom; -// tag and untag companies -Company c1 = new Company().setCompanyID("1"); -Company c2 = new Company().setCompanyID("2").untag(); -Company.create(c1); -Company.create(c2); -Tag.tag(tag, c1, c2); - -// delete a tag -Tag.delete(tag); +Intercom client = Intercom + .builder() + .maxRetries(1) + .build(); ``` -### Segments - -```java -// Find a segment -Segment segment = Segment.find("1"); - -// Update a segment -segment.setName("new name"); -Segment.update(segment); - -// Iterate over all segments -SegmentCollection segments = Segment.list(); -while(segments.hasNext()) { - System.out.println(segments.next().getId()); -} -``` +### Timeouts -### Notes +The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level. ```java -// create a user note -User user = new User().setId("5310d8e8598c9a0b24000005"); -Author author = new Author().setId("1"); -Note note = new Note() - .setUser(user) - .setAuthor(author) - .setBody("The note"); -Note.create(note); - -// Find a note by id -note = Note.find("1"); - -// Iterate over all notes for a user via their user_id -Map params = Maps.newHashMap(); -params.put("user_id", "1"); -NoteCollection notes = Note.list(params); -while(notes.hasNext()) { - System.out.println(notes.next().getBody()); -} - -// Iterate over all notes for a user via their email address -params = Maps.newHashMap(); -params.put("email", "malcolm@serenity.io"); -notes = Note.list(params); -while(notes.hasNext()) { - System.out.println(notes.next().getBody()); -} +import com.intercom.api.Intercom; +import com.intercom.api.core.RequestOptions; + +// Client level +Intercom client = Intercom + .builder() + .timeout(10) + .build(); + +// Request level +client.aiContent().createContentImportSource( + ..., + RequestOptions + .builder() + .timeout(10) + .build() +); ``` -### Conversations +### Custom Headers -```java -// send a message to a user -User user = new User().setId("5310d8e8598c9a0b24000005"); -Admin admin = new Admin().setId("1"); -AdminMessage adminMessage = new AdminMessage() - .setAdmin(admin) - .setUser(user) - .setSubject("This Land") - .setBody("Har har har! Mine is an evil laugh!") - .setMessageType("email") - .setTemplate("plain"); -Conversation.create(adminMessage); - -// send a message from a user -UserMessage userMessage = new UserMessage() - .setBody("Hey! Is there, is there a reward?") - .setUser(user); -Conversation.create(userMessage); - -// find admin conversations -Map params = Maps.newHashMap(); -params.put("type", "admin"); -params.put("admin_id", "1"); -ConversationCollection adminConversations = Conversation.list(params); -while (adminConversations.hasNext()) { - Conversation conversation = adminConversations.next(); -} - -// find user conversations -params = Maps.newHashMap(); -params.put("type", "user"); -params.put("user_id", "1"); -ConversationCollection userConversations = Conversation.list(params); -while (userConversations.hasNext()) { - Conversation conversation = userConversations.next(); -} - -// find a conversation by id -final Conversation conversation = Conversation.find("66"); -ConversationMessage conversationMessage = conversation.getConversationMessage(); -ConversationPartCollection parts = conversation.getConversationPartCollection(); -List partList = parts.getPageItems(); -for (ConversationPart part : partList) { - String partType = part.getPartType(); - Author author = part.getAuthor(); - String body = part.getBody(); -} -ConversationPart part = conversation.getMostRecentConversationPart(); -Admin assignee = conversation.getAssignee(); -User user = conversation.getUser(); - -// admin reply -Admin admin = new Admin().setId("1"); -AdminReply adminReply = new AdminReply(admin); -adminReply.setBody("These apples are healthsome"); -Conversation.reply("66", adminReply); - -// user reply -User user1 = new User().setId("5310d8e8598c9a0b24000005"); -UserReply userReply = new UserReply(user1); -userReply.setBody("Mighty fine shindig"); -System.out.println(MapperSupport.objectMapper().writeValueAsString(userReply)); -Conversation.reply("66", userReply); -``` - -### Webhooks +The SDK allows you to add custom headers to requests. You can configure headers at the client level or at the request level. ```java -// create a subscription -Subscription subscription = new Subscription(); -subscription.setUrl(new URI("https://example.org/webhooks/1")); -subscription.addTopic(Subscription.Topic.USER_CREATED); -subscription.addTopic(Subscription.Topic.USER_TAG_CREATED); -subscription.addTopic(Subscription.Topic.COMPANY); -subscription.setAppID("pi3243fa"); -Subscription.create(subscription); - -// find a subscription -subscription = Subscription.find("nsub_60ca7690-4020-11e4-b789-4961958e51bd"); - -// list subscriptions -SubscriptionCollection list = Subscription.list(); -while(list.hasNext()) { - Subscription sub = list.next(); - String appID = sub.getAppID(); - String serviceType = sub.getServiceType(); - List topics = sub.getTopics(); - String hubSecret = sub.getHubSecret(); -} +import com.intercom.api.Intercom; +import com.intercom.api.core.RequestOptions; + +// Client level +Intercom client = Intercom + .builder() + .addHeader("X-Custom-Header", "custom-value") + .addHeader("X-Request-Id", "abc-123") + .build(); +; + +// Request level +client.aiContent().createContentImportSource( + ..., + RequestOptions + .builder() + .addHeader("X-Request-Header", "request-value") + .build() +); +``` -// notification sent feed -NotificationCollection sent = Subscription.sentFeed(subscription.getId()); -while(sent.hasNext()) { - Notification notification = sent.next(); - String id = notification.getId(); - String topic = notification.getTopic(); - NotificationData data = notification.getData(); - String type = data.getType(); - // raw map representation of the payload - Map item = data.getItem(); -} +### Access Raw Response Data -// notification error feed -NotificationErrorCollection errors = Subscription.errorFeed(subscription.getId()); -while (errors.hasNext()) { - NotificationError notificationError = errors.next(); - RequestResponseCapture capture = notificationError.getCapture(); - URI requestURI = capture.getRequestURI(); - String requestMethod = capture.getRequestMethod(); - Map requestHeaders = capture.getRequestHeaders(); - String requestEntity = capture.getRequestEntity(); - int statusCode = capture.getResponseStatusCode(); - Map responseHeaders = capture.getResponseHeaders(); - String responseEntity = capture.getResponseEntity(); -} +The SDK provides access to raw response data, including headers, through the `withRawResponse()` method. +The `withRawResponse()` method returns a raw client that wraps all responses with `body()` and `headers()` methods. +(A normal client's `response` is identical to a raw client's `response.body()`.) -// consume a webhook notification -InputStream jsonStream = ...; -final Notification notification = Notification.readJSON(jsonStream); +```java +CreateContentImportSourceHttpResponse response = client.aiContent().withRawResponse().createContentImportSource(...); -String jsonString = ...; -final Notification notification = Notification.readJSON(jsonString); +System.out.println(response.body()); +System.out.println(response.headers().get("X-My-Header")); ``` -### Counts +## Contributing -```java -// app totals -Counts.Totals totals = Counts.appTotals(); -System.out.println("companies: " + totals.getCompany().getValue()); -System.out.println("segments: :" + totals.getSegment().getValue()); -System.out.println("tags: :" + totals.getTag().getValue()); -System.out.println("users: :" + totals.getUser().getValue()); - -// conversation totals -Counts.Conversation conversationTotals = Counts.conversationTotals(); -System.out.println("assigned: " + conversationTotals.getAssigned()); -System.out.println("closed: :" + conversationTotals.getClosed()); -System.out.println("open: :" + conversationTotals.getOpen()); -System.out.println("unassigned: :" + conversationTotals.getUnassigned()); - -// admin open/close counts -Counts.Conversation adminCounts = Counts.conversationAdmins(); -List admins = adminCounts.getAdmins(); -for (Admin admin : admins) { - System.out.println(admin.getName() + ": " + admin.getClosed() + ", " + admin.getOpen()); -} +While we value open-source contributions to this SDK, this library is generated programmatically. +Additions made directly to this library would have to be moved over to our generation code, +otherwise they would be overwritten upon the next generated release. Feel free to open a PR as +a proof of concept, but know that we will not be able to merge it as-is. We suggest opening +an issue first to discuss with us! -// tag user counts -System.out.println("tag user counts: "); -List tags = Counts.userTags(); -for (Counts.CountItem tag : tags) { - System.out.println(tag.getName()+": " +tag.getValue()); -} +On the other hand, contributions to the README are always very welcome! -// segment user counts -List segments = Counts.userSegments(); -for (Counts.CountItem segment : segments) { - System.out.println(segment.getName()+": " +segment.getValue()); -} +## For Maintainers -// company user counts -List companyUsers = Counts.companyUsers(); -for (Counts.CountItem company : companyUsers) { - System.out.println(company.getName()+": " +company.getValue()); -} +### Regenerating the SDK -// company tag counts -List companyTags = Counts.companyTags(); -for (Counts.CountItem tag : companyTags) { - System.out.println(tag.getName()+": " +tag.getValue()); -} -``` +This SDK is generated using [Fern](https://buildwithfern.com). To regenerate the SDK after API changes: -## Idioms +#### Prerequisites -### HTTP requests +- Ensure you have Fern CLI installed +- Navigate to the `fern/` directory of the Fern config repo +- If you only need regeneration without publishing, you can empty credentials in `generators.yml` to skip the publish step: + ```yaml + # Example: Clear Maven credentials to skip publish + username: "" + password: "" + signing-key-id: "" + ``` -To signal local versus remote methods, calls that result in HTTP requests are performed -using static methods, for example `User.find()`. The objects returned by static methods -are built from server responses. The exception to the static idiom is where the `next()`, -`hasNext()` and `nextPage()` methods on Collections are used to abstract over pagination. +#### Regeneration Command -### Pagination +```bash +fern generate --group java-sdk +``` -Some API classes have static `list()` methods that correspond to paginated API responses. -These return a Collection object (eg `UserCollection`) which can be iterated in two - ways - -- The collection's `getPageItems()`, `hasNextPage()` and `nextPage()` methods - these are useful when you want to fetch one or just a few pages directly. +#### Common Issues -- Java's inbuilt iterator methods `next()` and `hasNext()` - these are useful when you want to fetch data without manually handling pagination. +- **Integration tests failing**: Fix the tests locally and push updates to the PR branch +- **Spotless formatting errors**: Run the Spotless formatter locally to fix formatting issues +- **Maven signing errors**: If publishing is enabled, ensure these environment variables are set: + - `MAVEN_SIGNING_KEY_ID` + - `MAVEN_SIGNING_KEY` + - `MAVEN_SIGNING_PASSWORD` +- **GitHub Actions delays**: If CI is degraded, pipelines may need retries -### Error handling +### Publishing to Maven Central -You do not need to deal with the HTTP response from an API call directly. -If there is an unsuccessful response then an IntercomException or a subclass -of IntercomException will be thrown. The exception will have Error objects - that can be examined via `getErrorCollection` and `getFirstError` for more detail. - -The API throws the following runtime exceptions - - - - AuthorizationException: for a 401 or 403 response - - InvalidException: for a 422 response or a local validation failure - - RateLimitException: for a 429 rate limit exceeded response - - ClientException: for a general 4xx response - - ServerException: for a 500 or 503 response - - IntercomException: general exception +After regenerating the SDK and merging the PR: +#### 1. Create a Release Tag -## Configuration +Manually create and push a Git tag for the release: -### HTTP +```bash +git tag v4.0.x +git push origin v4.0.x +``` -The client can be configured to accept any http stack that implements -`java.net.HttpURLConnection` by implementing the `HttpConnectorSupplier` - interface. - -For example, to use [OkHttp](http://square.github.io/okhttp/) as a connection -supplier, create a supplier class - - -```java -public class OkHttpSupplier implements HttpConnectorSupplier { - private final OkUrlFactory urlFactory; +#### 2. Trigger Publish Workflow - public OkHttpSupplier(OkUrlFactory urlFactory) { - this.urlFactory = urlFactory; - } +The tag push triggers the publish workflow automatically. Ensure the version in the repo config aligns with the intended release. - @Override - public HttpURLConnection connect(URI uri) throws IOException { - return urlFactory.open(uri.toURL()); - } -} -``` +#### 3. Verify Publication -and hand a supplier to the Intercom object - +- Check [Maven Central](https://central.sonatype.com/artifact/io.intercom/intercom-java/overview) for the new version +- Note: Maven Central indexing can take some time to appear -``` -final OkHttpClient client = new OkHttpClient(); -final OkUrlFactory factory = new OkUrlFactory(client); -final OkHttpSupplier supplier = new OkHttpSupplier(factory); -Intercom.setHttpConnectorSupplier(supplier); -``` +#### Required Credentials -#### Timeouts +Publishing requires: +- Maven Central credentials (username/password) +- GPG signing key configuration: + - `MAVEN_SIGNING_KEY_ID` + - `MAVEN_SIGNING_KEY` + - `MAVEN_SIGNING_PASSWORD` -The default connection and request timeouts can be set in milliseconds using the -`Intercom.setConnectionTimeout` and `Intercom.setRequestTimeout` methods. +Contributors without publish credentials can open regeneration PRs. Team members with credentials can complete the publish steps. +### Example Workflow -### Target API Server +1. **Update OpenAPI spec** (if needed): Add overrides in `openapi-overrides.yml` in the Intercom-OpenAPI repo +2. **Regenerate SDK**: Run `fern generate --group java-sdk` +3. **Fix any issues**: Address integration test failures or formatting issues +4. **Create PR**: Open a pull request with the regenerated code +5. **Merge PR**: After review and approval +6. **Tag release**: Create and push a Git tag +7. **Verify publish**: Check Maven Central for the new version -The base URI to target can be changed for testing purposes +### Related Resources -```java -URI baseURI = new URI("https://example.org/server"); -Intercom.setApiBaseURI(baseURI); -``` +- [Fern Documentation](https://buildwithfern.com) +- [Maven Central Repository](https://central.sonatype.com/artifact/io.intercom/intercom-java) +- [Intercom OpenAPI Spec](https://github.com/intercom/Intercom-OpenAPI) \ No newline at end of file diff --git a/build.gradle b/build.gradle index f58b503d..2c41feb7 100644 --- a/build.gradle +++ b/build.gradle @@ -1,59 +1,132 @@ -buildscript { - repositories { - jcenter() +plugins { + id 'java-library' + id 'maven-publish' + id 'com.diffplug.spotless' version '6.11.0' + id 'signing' + id 'cl.franciscosolis.sonatype-central-upload' version '1.0.3' +} + +repositories { mavenCentral() - } - //noinspection GroovyAssignabilityCheck - dependencies { - classpath 'com.jfrog.bintray.gradle:gradle-bintray-plugin:0.6' - classpath 'org.ajoberstar:gradle-git:0.10.0' - } + maven { + url 'https://oss.sonatype.org/service/local/staging/deploy/maven2/' + } } -allprojects { - apply plugin: 'idea' +dependencies { + api 'com.squareup.okhttp3:okhttp:5.2.1' + api 'com.fasterxml.jackson.core:jackson-databind:2.18.2' + api 'com.fasterxml.jackson.datatype:jackson-datatype-jdk8:2.18.2' + api 'com.fasterxml.jackson.datatype:jackson-datatype-jsr310:2.18.2' + testImplementation 'org.junit.jupiter:junit-jupiter-api:5.8.2' + testImplementation 'org.junit.jupiter:junit-jupiter-engine:5.8.2' + testImplementation 'org.junit.jupiter:junit-jupiter-params:5.8.2' } -subprojects { - buildscript { - repositories { - jcenter() - mavenCentral() - } - //noinspection GroovyAssignabilityCheck - dependencies { - classpath 'com.jfrog.bintray.gradle:gradle-bintray-plugin:0.6' - classpath 'org.ajoberstar:gradle-git:0.10.0' +sourceCompatibility = 1.8 +targetCompatibility = 1.8 + +tasks.withType(Javadoc) { + failOnError false + options.addStringOption('Xdoclint:none', '-quiet') +} + +spotless { + java { + palantirJavaFormat() } - } +} - repositories { - jcenter() - mavenCentral() - } - apply plugin: 'maven' - apply plugin: 'maven-publish' - apply plugin: 'java' - apply plugin: 'com.jfrog.bintray' +java { + withSourcesJar() + withJavadocJar() +} + + +group = 'io.intercom' + +version = '4.0.4' + +jar { + dependsOn(":generatePomFileForMavenPublication") + archiveBaseName = "intercom-java" +} + +sourcesJar { + archiveBaseName = "intercom-java" +} + +javadocJar { + archiveBaseName = "intercom-java" +} + +signing { + sign(publishing.publications) +} - sourceCompatibility = 1.7 - targetCompatibility = 1.7 +test { + useJUnitPlatform() + testLogging { + showStandardStreams = true + } +} - //noinspection GroovyAssignabilityCheck - dependencies { - compile 'com.fasterxml.jackson.core:jackson-core:2.4.2' - compile 'com.fasterxml.jackson.core:jackson-annotations:2.4.2' - compile 'com.fasterxml.jackson.core:jackson-databind:2.4.2' - compile 'com.google.guava:guava:17.0' - compile 'org.slf4j:slf4j-api:1.7.7' - compile 'commons-codec:commons-codec:1.9' - testCompile 'junit:junit:4.11' - } +publishing { + publications { + maven(MavenPublication) { + groupId = 'io.intercom' + artifactId = 'intercom-java' + version = '4.0.4' + from components.java + pom { + name = 'intercom' + description = 'The official SDK of intercom' + url = 'https://buildwithfern.com' + licenses { + license { + name = 'The MIT License (MIT)' + url = 'https://mit-license.org/' + } + } + developers { + developer { + name = 'intercom' + email = 'developers@intercom.com' + } + } + scm { + connection = 'scm:git:git://github.com/intercom/intercom-java.git' + developerConnection = 'scm:git:git://github.com/intercom/intercom-java.git' + url = 'https://github.com/intercom/intercom-java' + } + } + } + } } +sonatypeCentralUpload { + username = "$System.env.MAVEN_USERNAME" + password = "$System.env.MAVEN_PASSWORD" + + archives = files( + "$buildDir/libs/intercom-java-" + version + ".jar", + "$buildDir/libs/intercom-java-" + version + "-sources.jar", + "$buildDir/libs/intercom-java-" + version + "-javadoc.jar" + ) -task wrapper(type: Wrapper) { - gradleVersion = '2.0' + pom = file("$buildDir/publications/maven/pom-default.xml") + signingKey = "$System.env.MAVEN_SIGNATURE_SECRET_KEY" + signingKeyPassphrase = "$System.env.MAVEN_SIGNATURE_PASSWORD" } + +signing { + def signingKeyId = "$System.env.MAVEN_SIGNATURE_KID" + def signingKey = "$System.env.MAVEN_SIGNATURE_SECRET_KEY" + def signingPassword = "$System.env.MAVEN_SIGNATURE_PASSWORD" + useInMemoryPgpKeys(signingKeyId, signingKey, signingPassword) + sign publishing.publications.maven +} + +sonatypeCentralUpload.dependsOn build diff --git a/gradle.properties b/gradle.properties index 8914ba6c..e69de29b 100644 --- a/gradle.properties +++ b/gradle.properties @@ -1,8 +0,0 @@ -version: 1.0.3 - -groupId: io.intercom - -modules: \ - intercom-java - -org.gradle.daemon: true \ No newline at end of file diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar index b7612167..1b33c55b 100644 Binary files a/gradle/wrapper/gradle-wrapper.jar and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties index 09495e50..d4081da4 100644 --- a/gradle/wrapper/gradle-wrapper.properties +++ b/gradle/wrapper/gradle-wrapper.properties @@ -1,6 +1,7 @@ -#Wed Sep 24 10:57:43 IST 2014 distributionBase=GRADLE_USER_HOME distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-8.14.3-bin.zip +networkTimeout=10000 +validateDistributionUrl=true zipStoreBase=GRADLE_USER_HOME zipStorePath=wrapper/dists -distributionUrl=https\://services.gradle.org/distributions/gradle-2.0-bin.zip diff --git a/gradlew b/gradlew index 91a7e269..23d15a93 100755 --- a/gradlew +++ b/gradlew @@ -1,79 +1,129 @@ -#!/usr/bin/env bash +#!/bin/sh + +# +# Copyright © 2015-2021 the original authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# SPDX-License-Identifier: Apache-2.0 +# ############################################################################## -## -## Gradle start up script for UN*X -## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/HEAD/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# ############################################################################## -# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. -DEFAULT_JVM_OPTS="" +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done -APP_NAME="Gradle" -APP_BASE_NAME=`basename "$0"` +# This is normally unused +# shellcheck disable=SC2034 +APP_BASE_NAME=${0##*/} +# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) +APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s\n' "$PWD" ) || exit # Use the maximum available, or set MAX_FD != -1 to use that value. -MAX_FD="maximum" +MAX_FD=maximum -warn ( ) { +warn () { echo "$*" -} +} >&2 -die ( ) { +die () { echo echo "$*" echo exit 1 -} +} >&2 # OS specific support (must be 'true' or 'false'). cygwin=false msys=false darwin=false -case "`uname`" in - CYGWIN* ) - cygwin=true - ;; - Darwin* ) - darwin=true - ;; - MINGW* ) - msys=true - ;; +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; esac -# For Cygwin, ensure paths are in UNIX format before anything is touched. -if $cygwin ; then - [ -n "$JAVA_HOME" ] && JAVA_HOME=`cygpath --unix "$JAVA_HOME"` -fi +CLASSPATH="\\\"\\\"" -# Attempt to set APP_HOME -# Resolve links: $0 may be a link -PRG="$0" -# Need this for relative symlinks. -while [ -h "$PRG" ] ; do - ls=`ls -ld "$PRG"` - link=`expr "$ls" : '.*-> \(.*\)$'` - if expr "$link" : '/.*' > /dev/null; then - PRG="$link" - else - PRG=`dirname "$PRG"`"/$link" - fi -done -SAVED="`pwd`" -cd "`dirname \"$PRG\"`/" >&- -APP_HOME="`pwd -P`" -cd "$SAVED" >&- - -CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar # Determine the Java command to use to start the JVM. if [ -n "$JAVA_HOME" ] ; then if [ -x "$JAVA_HOME/jre/sh/java" ] ; then # IBM's JDK on AIX uses strange locations for the executables - JAVACMD="$JAVA_HOME/jre/sh/java" + JAVACMD=$JAVA_HOME/jre/sh/java else - JAVACMD="$JAVA_HOME/bin/java" + JAVACMD=$JAVA_HOME/bin/java fi if [ ! -x "$JAVACMD" ] ; then die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME @@ -82,83 +132,120 @@ Please set the JAVA_HOME variable in your environment to match the location of your Java installation." fi else - JAVACMD="java" - which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + JAVACMD=java + if ! command -v java >/dev/null 2>&1 + then + die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. Please set the JAVA_HOME variable in your environment to match the location of your Java installation." + fi fi # Increase the maximum file descriptors if we can. -if [ "$cygwin" = "false" -a "$darwin" = "false" ] ; then - MAX_FD_LIMIT=`ulimit -H -n` - if [ $? -eq 0 ] ; then - if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then - MAX_FD="$MAX_FD_LIMIT" - fi - ulimit -n $MAX_FD - if [ $? -ne 0 ] ; then - warn "Could not set maximum file descriptor limit: $MAX_FD" - fi - else - warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" - fi +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac fi -# For Darwin, add options to specify how the application appears in the dock -if $darwin; then - GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" -fi +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) -# For Cygwin, switch paths to Windows format before running java -if $cygwin ; then - APP_HOME=`cygpath --path --mixed "$APP_HOME"` - CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` - - # We build the pattern for arguments to be converted via cygpath - ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` - SEP="" - for dir in $ROOTDIRSRAW ; do - ROOTDIRS="$ROOTDIRS$SEP$dir" - SEP="|" - done - OURCYGPATTERN="(^($ROOTDIRS))" - # Add a user-defined pattern to the cygpath arguments - if [ "$GRADLE_CYGPATTERN" != "" ] ; then - OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" - fi # Now convert the arguments - kludge to limit ourselves to /bin/sh - i=0 - for arg in "$@" ; do - CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` - CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option - - if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition - eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` - else - eval `echo args$i`="\"$arg\"" + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) fi - i=$((i+1)) + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg done - case $i in - (0) set -- ;; - (1) set -- "$args0" ;; - (2) set -- "$args0" "$args1" ;; - (3) set -- "$args0" "$args1" "$args2" ;; - (4) set -- "$args0" "$args1" "$args2" "$args3" ;; - (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; - (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; - (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; - (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; - (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; - esac fi -# Split up the JVM_OPTS And GRADLE_OPTS values into an array, following the shell quoting and substitution rules -function splitJvmOpts() { - JVM_OPTS=("$@") -} -eval splitJvmOpts $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS -JVM_OPTS[${#JVM_OPTS[*]}]="-Dorg.gradle.appname=$APP_BASE_NAME" -exec "$JAVACMD" "${JVM_OPTS[@]}" -classpath "$CLASSPATH" org.gradle.wrapper.GradleWrapperMain "$@" +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Collect all arguments for the java command: +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, +# and any embedded shellness will be escaped. +# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be +# treated as '${Hostname}' itself on the command line. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + -jar "$APP_HOME/gradle/wrapper/gradle-wrapper.jar" \ + "$@" + +# Stop when "xargs" is not available. +if ! command -v xargs >/dev/null 2>&1 +then + die "xargs is not available" +fi + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat index aec99730..5eed7ee8 100644 --- a/gradlew.bat +++ b/gradlew.bat @@ -1,4 +1,22 @@ -@if "%DEBUG%" == "" @echo off +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem +@rem SPDX-License-Identifier: Apache-2.0 +@rem + +@if "%DEBUG%"=="" @echo off @rem ########################################################################## @rem @rem Gradle startup script for Windows @@ -8,26 +26,30 @@ @rem Set local scope for the variables with windows NT shell if "%OS%"=="Windows_NT" setlocal -@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. -set DEFAULT_JVM_OPTS= - set DIRNAME=%~dp0 -if "%DIRNAME%" == "" set DIRNAME=. +if "%DIRNAME%"=="" set DIRNAME=. +@rem This is normally unused set APP_BASE_NAME=%~n0 set APP_HOME=%DIRNAME% +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + @rem Find java.exe if defined JAVA_HOME goto findJavaFromJavaHome set JAVA_EXE=java.exe %JAVA_EXE% -version >NUL 2>&1 -if "%ERRORLEVEL%" == "0" goto init +if %ERRORLEVEL% equ 0 goto execute -echo. -echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. -echo. -echo Please set the JAVA_HOME variable in your environment to match the -echo location of your Java installation. +echo. 1>&2 +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 goto fail @@ -35,54 +57,36 @@ goto fail set JAVA_HOME=%JAVA_HOME:"=% set JAVA_EXE=%JAVA_HOME%/bin/java.exe -if exist "%JAVA_EXE%" goto init +if exist "%JAVA_EXE%" goto execute -echo. -echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% -echo. -echo Please set the JAVA_HOME variable in your environment to match the -echo location of your Java installation. +echo. 1>&2 +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 goto fail -:init -@rem Get command-line arguments, handling Windowz variants - -if not "%OS%" == "Windows_NT" goto win9xME_args -if "%@eval[2+2]" == "4" goto 4NT_args - -:win9xME_args -@rem Slurp the command line arguments. -set CMD_LINE_ARGS= -set _SKIP=2 - -:win9xME_args_slurp -if "x%~1" == "x" goto execute - -set CMD_LINE_ARGS=%* -goto execute - -:4NT_args -@rem Get arguments from the 4NT Shell from JP Software -set CMD_LINE_ARGS=%$ - :execute @rem Setup the command line -set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar +set CLASSPATH= + @rem Execute Gradle -"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" -jar "%APP_HOME%\gradle\wrapper\gradle-wrapper.jar" %* :end @rem End local scope for the variables with windows NT shell -if "%ERRORLEVEL%"=="0" goto mainEnd +if %ERRORLEVEL% equ 0 goto mainEnd :fail rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of rem the _cmd.exe /c_ return code! -if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 -exit /b 1 +set EXIT_CODE=%ERRORLEVEL% +if %EXIT_CODE% equ 0 set EXIT_CODE=1 +if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% +exit /b %EXIT_CODE% :mainEnd if "%OS%"=="Windows_NT" endlocal diff --git a/init.gradle b/init.gradle deleted file mode 100644 index ce7f86da..00000000 --- a/init.gradle +++ /dev/null @@ -1,14 +0,0 @@ -gradle.projectsLoaded { - rootProject.allprojects { - buildscript { - repositories { - maven{ - url "http://repo.jfrog.org/artifactory/gradle" - } - dependencies { - classpath(group: 'org.jfrog.buildinfo', name: 'build-info-extractor-gradle', version: '2.0.12') - } - } - } - } -} \ No newline at end of file diff --git a/intercom-java/build.gradle b/intercom-java/build.gradle deleted file mode 100644 index 47243735..00000000 --- a/intercom-java/build.gradle +++ /dev/null @@ -1,130 +0,0 @@ -import org.ajoberstar.grgit.Grgit -import java.text.SimpleDateFormat - -final publicationVersion = new Version(version) -def rawVersion = version - -group = 'io.intercom' -version = publicationVersion -status = version.status -ext.publish = true - - -task sourcesJar(type: Jar, dependsOn: classes) { - classifier = 'sources' - from sourceSets.main.allSource -} - -task javadocJar(type: Jar, dependsOn: javadoc) { - classifier = 'javadoc' - from javadoc.destinationDir -} - -artifacts { - archives sourcesJar, javadocJar -} - -publishing { - publications { - mavenJava(MavenPublication) { - from components.java - - artifact sourcesJar { - classifier "sources" - } - - artifact javadocJar { - classifier "javadoc" - } - } - } -} - - -bintray { - // gradle apslodes if the bintray* props aren't found and we never run this task in circle - if (System.getenv('release') != null) { - user = bintrayUser - key = bintrayKey - } - publications = ['mavenJava'] - dryRun = false - publish = project.publish - pkg { - repo = 'intercom-maven' - userOrg = 'intercom' - name = 'intercom-java' - desc = 'Java bindings for the Intercom API' - websiteUrl = 'https://github.com/intercom/intercom-java' - issueTrackerUrl = 'https://github.com/intercom/intercom-java/issues' - vcsUrl = 'https://github.com/intercom/intercom-java.git' - licenses = ['Apache-2.0'] - labels = ['intercom', 'java', 'api'] - publicDownloadNumbers = true - //noinspection GroovyAssignabilityCheck - version { - name = publicationVersion - vcsTag = publicationVersion - } - } -} - -ext.repo = Grgit.open(project.file('..')) - -task printVersion << { - println "publication version: ${publicationVersion}" - println "raw version: ${rawVersion}" -} - -task tagRelease << { - repo.tag.add { - name = publicationVersion - message = "Release of ${rawVersion}" - } - repo.push(tags: true) -} - -/* - export release=1 && gradle publishRelease -*/ -task publishRelease(dependsOn: ['clean', 'tagRelease', 'bintrayUpload']) -tagRelease.mustRunAfter clean -bintrayUpload.mustRunAfter tagRelease - - -/** - * A version object for use in the publication and tagging tasks. - * If the version ends with SNAPSHOT, that will be replaced with a timestamp. - * - * Based on https://github.com/bintray/bintray-examples - */ -class Version { - // - String originalVersion - String thisVersion - String status - Date buildTime - - Version(String versionValue) { - buildTime = new Date() - originalVersion = versionValue - if (originalVersion.endsWith('-SNAPSHOT')) { - status = 'integration' - thisVersion = originalVersion.substring(0, originalVersion.length() - 'SNAPSHOT'.length()) + getTimestamp() - } else { - status = 'release' - thisVersion = versionValue - } - } - - String getTimestamp() { - // Convert local file timestamp to UTC - def format = new SimpleDateFormat('yyyyMMddHHmmss') - format.setCalendar(Calendar.getInstance(TimeZone.getTimeZone('UTC'))); - return format.format(buildTime) - } - - String toString() { - thisVersion - } -} diff --git a/intercom-java/src/main/java/io/intercom/api/Admin.java b/intercom-java/src/main/java/io/intercom/api/Admin.java deleted file mode 100644 index 3f8cb0aa..00000000 --- a/intercom-java/src/main/java/io/intercom/api/Admin.java +++ /dev/null @@ -1,156 +0,0 @@ -package io.intercom.api; - - -import com.fasterxml.jackson.annotation.JsonIgnore; -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.google.common.collect.Maps; - -import java.util.Map; - - -@SuppressWarnings("UnusedDeclaration") -@JsonIgnoreProperties(ignoreUnknown = true) -@JsonInclude(JsonInclude.Include.NON_EMPTY) -public class Admin extends TypedData implements Replier { - - private static final Map SENTINEL = Maps.newHashMap(); - - public static final String TYPE_NOBODY = "nobody_admin"; - - // don't make public for now - static AdminCollection list(Map params) - throws AuthorizationException, ClientException, ServerException, InvalidException, RateLimitException { - return DataResource.list(params, "admins", AdminCollection.class); - } - - public static AdminCollection list() - throws AuthorizationException, ClientException, ServerException, InvalidException, RateLimitException { - return DataResource.list(SENTINEL, "admins", AdminCollection.class); - } - - @SuppressWarnings("FieldCanBeLocal") - @JsonProperty("type") - private final String type = "admin"; - - @JsonProperty("id") - private String id; - - @JsonProperty("name") - private String name; - - @JsonProperty("email") - private String email; - - @JsonProperty("created_at") - private long createdAt; - - @JsonProperty("updated_at") - private long updatedAt; - - @JsonProperty("open") - private long open; - - @JsonProperty("closed") - private long closed; - - public Admin() { - } - - public String getReplyType() { - return getType() + "_reply"; - } - - public String getType() { - return type; - } - - @JsonIgnore - public boolean isNobody() { - return TYPE_NOBODY.equalsIgnoreCase(getType()); - } - - @JsonIgnore - public boolean isSomebody() { - return (!isNobody()) && (getId() != null); - } - - public String getId() { - return id; - } - - public Admin setId(String id) { - this.id = id; - return this; - } - - public String getName() { - return name; - } - - public String getEmail() { - return email; - } - - public long getCreatedAt() { - return createdAt; - } - - public long getUpdatedAt() { - return updatedAt; - } - - public long getOpen() { - return open; - } - - public long getClosed() { - return closed; - } - - @Override - public boolean equals(Object o) { - if (this == o) return true; - if (o == null || getClass() != o.getClass()) return false; - - Admin admin = (Admin) o; - - if (closed != admin.closed) return false; - if (createdAt != admin.createdAt) return false; - if (open != admin.open) return false; - if (updatedAt != admin.updatedAt) return false; - if (email != null ? !email.equals(admin.email) : admin.email != null) return false; - if (id != null ? !id.equals(admin.id) : admin.id != null) return false; - if (name != null ? !name.equals(admin.name) : admin.name != null) return false; - //noinspection RedundantIfStatement - if (!type.equals(admin.type)) return false; - - return true; - } - - @Override - public int hashCode() { - int result = type.hashCode(); - result = 31 * result + (id != null ? id.hashCode() : 0); - result = 31 * result + (name != null ? name.hashCode() : 0); - result = 31 * result + (email != null ? email.hashCode() : 0); - result = 31 * result + (int) (createdAt ^ (createdAt >>> 32)); - result = 31 * result + (int) (updatedAt ^ (updatedAt >>> 32)); - result = 31 * result + (int) (open ^ (open >>> 32)); - result = 31 * result + (int) (closed ^ (closed >>> 32)); - return result; - } - - @Override - public String toString() { - return "Admin{" + - "id='" + id + '\'' + - ", name='" + name + '\'' + - ", email='" + email + '\'' + - ", createdAt=" + createdAt + - ", updatedAt=" + updatedAt + - "} " + super.toString(); - } - -} diff --git a/intercom-java/src/main/java/io/intercom/api/AdminCollection.java b/intercom-java/src/main/java/io/intercom/api/AdminCollection.java deleted file mode 100644 index 7f37a2a5..00000000 --- a/intercom-java/src/main/java/io/intercom/api/AdminCollection.java +++ /dev/null @@ -1,45 +0,0 @@ -package io.intercom.api; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; - -import java.util.Iterator; -import java.util.List; - -@SuppressWarnings("UnusedDeclaration") -@JsonIgnoreProperties(ignoreUnknown = true) -@JsonInclude(JsonInclude.Include.NON_EMPTY) -public class AdminCollection extends TypedDataCollection implements Iterator { - protected TypedDataCollectionIterator iterator; - - public AdminCollection() { - type = "company.list"; - iterator = new TypedDataCollectionIterator(this); - } - - @Override - public AdminCollection nextPage() { - return fetchNextPage(AdminCollection.class); - } - - @SuppressWarnings("EmptyMethod") - @JsonProperty("admins") - @Override - public List getPage() { - return super.getPage(); - } - - public boolean hasNext() { - return iterator.hasNext(); - } - - public Admin next() { - return iterator.next(); - } - - public void remove() { - iterator.remove(); - } - -} diff --git a/intercom-java/src/main/java/io/intercom/api/AdminMessage.java b/intercom-java/src/main/java/io/intercom/api/AdminMessage.java deleted file mode 100644 index 24f253ab..00000000 --- a/intercom-java/src/main/java/io/intercom/api/AdminMessage.java +++ /dev/null @@ -1,173 +0,0 @@ -package io.intercom.api; - - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.google.common.annotations.VisibleForTesting; - - -@SuppressWarnings("UnusedDeclaration") -@JsonIgnoreProperties(ignoreUnknown = true) -@JsonInclude(JsonInclude.Include.NON_EMPTY) -public class AdminMessage extends TypedData { - - @JsonProperty("type") - private final String type = "admin_message"; - - @JsonProperty("id") - private String id; - - @JsonProperty("message_type") - private String messageType; - - @JsonProperty("subject") - private String subject; - - @JsonProperty("body") - private String body; - - @JsonProperty("template") - private String template; - - @JsonProperty("created_at") - private long createdAt; - - @JsonProperty("from") - private Admin admin; - - @JsonProperty("to") - private User user; - - public AdminMessage() { - } - - public String getType() { - return type; - } - - public String getId() { - return id; - } - - @SuppressWarnings("UnusedReturnValue") - @VisibleForTesting - AdminMessage setId(String id) { - this.id = id; - return this; - } - - public String getMessageType() { - return messageType; - } - - public AdminMessage setMessageType(String messageType) { - this.messageType = messageType; - return this; - } - - public String getSubject() { - return subject; - } - - public AdminMessage setSubject(String subject) { - this.subject = subject; - return this; - } - - public String getBody() { - return body; - } - - public AdminMessage setBody(String body) { - this.body = body; - return this; - } - - public String getTemplate() { - return template; - } - - public AdminMessage setTemplate(String template) { - this.template = template; - return this; - } - - public long getCreatedAt() { - return createdAt; - } - - @SuppressWarnings("UnusedReturnValue") - public AdminMessage setCreatedAt(long createdAt) { - this.createdAt = createdAt; - return this; - } - - public Admin getAdmin() { - return admin; - } - - public AdminMessage setAdmin(Admin admin) { - this.admin = admin; - return this; - } - - public User getUser() { - return user; - } - - public AdminMessage setUser(User user) { - this.user = user; - return this; - } - - @Override - public boolean equals(Object o) { - if (this == o) return true; - if (o == null || getClass() != o.getClass()) return false; - - AdminMessage message = (AdminMessage) o; - - if (createdAt != message.createdAt) return false; - if (admin != null ? !admin.equals(message.admin) : message.admin != null) return false; - if (body != null ? !body.equals(message.body) : message.body != null) return false; - if (id != null ? !id.equals(message.id) : message.id != null) return false; - if (messageType != null ? !messageType.equals(message.messageType) : message.messageType != null) return false; - if (subject != null ? !subject.equals(message.subject) : message.subject != null) return false; - if (template != null ? !template.equals(message.template) : message.template != null) return false; - if (!type.equals(message.type)) return false; - //noinspection RedundantIfStatement - if (user != null ? !user.equals(message.user) : message.user != null) return false; - - return true; - } - - @Override - public int hashCode() { - int result = type.hashCode(); - result = 31 * result + (id != null ? id.hashCode() : 0); - result = 31 * result + (messageType != null ? messageType.hashCode() : 0); - result = 31 * result + (subject != null ? subject.hashCode() : 0); - result = 31 * result + (body != null ? body.hashCode() : 0); - result = 31 * result + (template != null ? template.hashCode() : 0); - result = 31 * result + (int) (createdAt ^ (createdAt >>> 32)); - result = 31 * result + (admin != null ? admin.hashCode() : 0); - result = 31 * result + (user != null ? user.hashCode() : 0); - return result; - } - - @Override - public String toString() { - return "AdminMessage{" + - "id='" + id + '\'' + - ", messageType='" + messageType + '\'' + - ", subject='" + subject + '\'' + - ", body='" + body + '\'' + - ", template='" + template + '\'' + - ", createdAt=" + createdAt + - ", admin=" + admin + - ", user=" + user + - "} " + super.toString(); - } - -} diff --git a/intercom-java/src/main/java/io/intercom/api/AdminMessageResponse.java b/intercom-java/src/main/java/io/intercom/api/AdminMessageResponse.java deleted file mode 100644 index 9e55d20e..00000000 --- a/intercom-java/src/main/java/io/intercom/api/AdminMessageResponse.java +++ /dev/null @@ -1,129 +0,0 @@ -package io.intercom.api; - - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; - - -@SuppressWarnings("UnusedDeclaration") -@JsonIgnoreProperties(ignoreUnknown = true) -@JsonInclude(JsonInclude.Include.NON_EMPTY) -class AdminMessageResponse extends TypedData { - - @JsonProperty("id") - private String id; - - @JsonProperty("message_type") - private String messageType; - - @JsonProperty("subject") - private String subject; - - @JsonProperty("body") - private String body; - - @JsonProperty("template") - private String template; - - @JsonProperty("created_at") - private long createdAt; - - @JsonProperty("updated_at") - private long updatedAt; - - @JsonProperty("owner") - private Admin admin; - - @JsonProperty("to") - private User user; - - public AdminMessageResponse() { - } - - public String getType() { - return "admin_message"; - } - - public String getId() { - return id; - } - - public AdminMessageResponse setId(String id) { - this.id = id; - return this; - } - - public String getMessageType() { - return messageType; - } - - public AdminMessageResponse setMessageType(String messageType) { - this.messageType = messageType; - return this; - } - - public String getSubject() { - return subject; - } - - public AdminMessageResponse setSubject(String subject) { - this.subject = subject; - return this; - } - - public String getBody() { - return body; - } - - public AdminMessageResponse setBody(String body) { - this.body = body; - return this; - } - - public String getTemplate() { - return template; - } - - public AdminMessageResponse setTemplate(String template) { - this.template = template; - return this; - } - - public long getCreatedAt() { - return createdAt; - } - - public AdminMessageResponse setCreatedAt(long createdAt) { - this.createdAt = createdAt; - return this; - } - - public long getUpdatedAt() { - return updatedAt; - } - - public AdminMessageResponse setUpdatedAt(long updatedAt) { - this.updatedAt = updatedAt; - return this; - } - - public Admin getAdmin() { - return admin; - } - - public AdminMessageResponse setAdmin(Admin admin) { - this.admin = admin; - return this; - } - - public User getUser() { - return user; - } - - public AdminMessageResponse setUser(User user) { - this.user = user; - return this; - } - -} diff --git a/intercom-java/src/main/java/io/intercom/api/AdminReply.java b/intercom-java/src/main/java/io/intercom/api/AdminReply.java deleted file mode 100644 index 473c4a70..00000000 --- a/intercom-java/src/main/java/io/intercom/api/AdminReply.java +++ /dev/null @@ -1,54 +0,0 @@ -package io.intercom.api; - - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; - - -@SuppressWarnings("UnusedDeclaration") -@JsonIgnoreProperties(ignoreUnknown = true) -@JsonInclude(JsonInclude.Include.NON_EMPTY) -public class AdminReply extends Reply { - - @SuppressWarnings("UnusedDeclaration") - @JsonIgnoreProperties(ignoreUnknown = true) - @JsonInclude(JsonInclude.Include.NON_EMPTY) - static class AdminStringReply { - - private AdminReply reply; - - public AdminStringReply(AdminReply reply) { - this.reply = reply; - } - - @JsonProperty("type") - public String getType() { - return reply.getType(); - } - - @JsonProperty("message_type") - public String getMessageType() { - return reply.getMessageType(); - } - - @JsonProperty("body") - public String getBody() { - return reply.getBody(); - } - - @JsonProperty("admin_id") - public String getAdminID() { - return reply.getFrom().getId(); - } - } - - public AdminReply(Admin admin) { - this.from = admin; - } - - @Override - public String toString() { - return "AdminReply{} " + super.toString(); - } -} diff --git a/intercom-java/src/main/java/io/intercom/api/Author.java b/intercom-java/src/main/java/io/intercom/api/Author.java deleted file mode 100644 index 204c84b9..00000000 --- a/intercom-java/src/main/java/io/intercom/api/Author.java +++ /dev/null @@ -1,117 +0,0 @@ -package io.intercom.api; - - -import com.fasterxml.jackson.annotation.JsonIgnore; -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; - -@SuppressWarnings("UnusedDeclaration") -@JsonIgnoreProperties(ignoreUnknown = true) -@JsonInclude(JsonInclude.Include.NON_EMPTY) -public class Author extends TypedData { - - @JsonProperty("type") - private String type; - - @JsonProperty("id") - private String id; - - @JsonProperty("name") - private String name; - - @JsonProperty("email") - private String email; - - @JsonProperty("user_id") - private String userId; - - public Author() { - } - - public String getType() { - return type; - } - - @JsonIgnore - public boolean isUser() { - return "user".equalsIgnoreCase(getType()); - } - - @JsonIgnore - public boolean isAdmin() { - return "admin".equalsIgnoreCase(getType()); - } - - public String getId() { - return id; - } - - public Author setId(String id) { - this.id = id; - return this; - } - - public String getName() { - return name; - } - - public Author setName(String name) { - this.name = name; - return this; - } - - public String getEmail() { - return email; - } - - public Author setEmail(String email) { - this.email = email; - return this; - } - - public String getUserId() { - return userId; - } - - public Author setUserId(String userId) { - this.userId = userId; - return this; - } - - @Override - public int hashCode() { - int result = id != null ? id.hashCode() : 0; - result = 31 * result + (name != null ? name.hashCode() : 0); - result = 31 * result + (email != null ? email.hashCode() : 0); - result = 31 * result + (userId != null ? userId.hashCode() : 0); - return result; - } - - @Override - public boolean equals(Object o) { - if (this == o) return true; - if (o == null || getClass() != o.getClass()) return false; - - Author author = (Author) o; - - if (email != null ? !email.equals(author.email) : author.email != null) return false; - if (id != null ? !id.equals(author.id) : author.id != null) return false; - if (name != null ? !name.equals(author.name) : author.name != null) return false; - //noinspection RedundantIfStatement - if (userId != null ? !userId.equals(author.userId) : author.userId != null) return false; - - return true; - } - - @Override - public String toString() { - return "Author{" + - "id='" + id + '\'' + - ", name='" + name + '\'' + - ", email='" + email + '\'' + - ", userId='" + userId + '\'' + - "} " + super.toString(); - } - -} diff --git a/intercom-java/src/main/java/io/intercom/api/AuthorizationException.java b/intercom-java/src/main/java/io/intercom/api/AuthorizationException.java deleted file mode 100644 index 4ecc7584..00000000 --- a/intercom-java/src/main/java/io/intercom/api/AuthorizationException.java +++ /dev/null @@ -1,22 +0,0 @@ -package io.intercom.api; - -public class AuthorizationException extends IntercomException { - - private static final long serialVersionUID = 2917082281352001861L; - - public AuthorizationException(String message) { - super(message); - } - - public AuthorizationException(String message, Throwable cause) { - super(message, cause); - } - - public AuthorizationException(ErrorCollection errorCollection) { - super(errorCollection); - } - - public AuthorizationException(ErrorCollection errorCollection, Throwable cause) { - super(errorCollection, cause); - } -} diff --git a/intercom-java/src/main/java/io/intercom/api/Avatar.java b/intercom-java/src/main/java/io/intercom/api/Avatar.java deleted file mode 100644 index 7cfd9897..00000000 --- a/intercom-java/src/main/java/io/intercom/api/Avatar.java +++ /dev/null @@ -1,60 +0,0 @@ -package io.intercom.api; - - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; - -import java.net.URI; - -@SuppressWarnings("UnusedDeclaration") -@JsonIgnoreProperties(ignoreUnknown = true) -@JsonInclude(JsonInclude.Include.NON_DEFAULT) -public class Avatar extends TypedData { - - @JsonProperty("type") - private final String type = "avatar"; - - @JsonProperty("image_url") - private URI imageURL; - - Avatar() { - } - - public String getType() { - return type; - } - - public URI getImageURL() { - return imageURL; - } - - @Override - public boolean equals(Object o) { - if (this == o) return true; - if (o == null || getClass() != o.getClass()) return false; - - Avatar avatar = (Avatar) o; - - if (imageURL != null ? !imageURL.equals(avatar.imageURL) : avatar.imageURL != null) return false; - //noinspection RedundantIfStatement - if (!type.equals(avatar.type)) return false; - - return true; - } - - @Override - public int hashCode() { - int result = type.hashCode(); - result = 31 * result + (imageURL != null ? imageURL.hashCode() : 0); - return result; - } - - @Override - public String toString() { - return "Avatar{" + - "type='" + type + '\'' + - ", imageURL=" + imageURL + - "} " + super.toString(); - } -} diff --git a/intercom-java/src/main/java/io/intercom/api/ClientException.java b/intercom-java/src/main/java/io/intercom/api/ClientException.java deleted file mode 100644 index e670983f..00000000 --- a/intercom-java/src/main/java/io/intercom/api/ClientException.java +++ /dev/null @@ -1,22 +0,0 @@ -package io.intercom.api; - -public class ClientException extends IntercomException { - - private static final long serialVersionUID = -2111295679006526646L; - - public ClientException(String message) { - super(message); - } - - public ClientException(String message, Throwable cause) { - super(message, cause); - } - - public ClientException(ErrorCollection errorCollection) { - super(errorCollection); - } - - public ClientException(ErrorCollection errorCollection, Throwable cause) { - super(errorCollection, cause); - } -} diff --git a/intercom-java/src/main/java/io/intercom/api/Company.java b/intercom-java/src/main/java/io/intercom/api/Company.java deleted file mode 100644 index 773097eb..00000000 --- a/intercom-java/src/main/java/io/intercom/api/Company.java +++ /dev/null @@ -1,394 +0,0 @@ -package io.intercom.api; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.google.common.annotations.VisibleForTesting; -import com.google.common.collect.Maps; - -import java.net.URI; -import java.util.Map; - -@SuppressWarnings("UnusedDeclaration") -@JsonInclude(JsonInclude.Include.NON_DEFAULT) -@JsonIgnoreProperties(ignoreUnknown = true) -public class Company extends TypedData { - - private static final Map SENTINEL = Maps.newHashMap(); - - public static Company find(String id) throws InvalidException, AuthorizationException { - final HttpClient resource = new HttpClient(UriBuilder.newBuilder().path("companies").path(id).build()); - return resource.get(Company.class); - } - - public static Company find(Map params) throws InvalidException, AuthorizationException { - if (!params.containsKey("company_id") && !params.containsKey("name")) { - throw new InvalidException("a company find must include a company_id or name parameter"); - } - return DataResource.find(params, "companies", Company.class); - } - - public static Company create(Company company) throws InvalidException, AuthorizationException { - return update(company); - } - - public static Company update(Company company) throws InvalidException, AuthorizationException { - // because the data is asymmetric on the plan field - final CompanyWithStringPlan entity = new CompanyWithStringPlan(); - entity.setCompanyID(company.getCompanyID()); - entity.setName(company.getName()); - entity.setSessionCount(company.getSessionCount()); - entity.setMonthlySpend(company.getMonthlySpend()); - entity.setRemoteCreatedAt(company.getRemoteCreatedAt()); - if(company.getCustomAttributes() != null) { - entity.getCustomAttributes().putAll(company.getCustomAttributes()); - } - if(company.getPlan() !=null ) { - entity.setPlan(company.getPlan().getName()); - } - return DataResource.update(entity, "companies", Company.class); - } - - public static Company delete(String id) throws InvalidException, AuthorizationException { - return DataResource.delete(id, "companies", Company.class); - } - - public static CompanyCollection list(Map params) throws InvalidException, AuthorizationException { - return DataResource.list(params, "companies", CompanyCollection.class); - } - - public static CompanyCollection list() throws InvalidException, AuthorizationException { - return DataResource.list(SENTINEL, "companies", CompanyCollection.class); - } - - public static UserCollection listUsers(Map params) throws InvalidException, AuthorizationException { - URI usersURI; - if (params.containsKey("company_id")) { - usersURI = UriBuilder.newBuilder() - .path("companies") - .query("company_id", params.get("company_id")) - .query("type", "users") - .build(); - } else if (params.containsKey("id")) { - usersURI = UriBuilder.newBuilder() - .path("companies") - .path(params.get("id")) - .path("users") - .build(); - } else { - throw new InvalidException("a company user list query must supply a company_id or id parameter"); - } - final HttpClient resource = new HttpClient(usersURI); - return resource.get(UserCollection.class); - } - - @SuppressWarnings("UnusedDeclaration") - @JsonInclude(JsonInclude.Include.NON_DEFAULT) - @JsonIgnoreProperties(ignoreUnknown = true) - public static class Plan extends TypedData { - - @JsonProperty("type") - protected String type; - - @JsonProperty("id") - private String id; - - @JsonProperty("name") - private String name; - - public Plan() { - type = "plan"; - } - - public Plan(String name) { - this(); - this.name = name; - } - - public String getId() { - return id; - } - - public String getName() { - return name; - } - - public void setName(String name) { - this.name = name; - } - - public String getType() { - return type; - } - - @Override - public int hashCode() { - int result = id != null ? id.hashCode() : 0; - result = 31 * result + (name != null ? name.hashCode() : 0); - return result; - } - - @Override - public boolean equals(Object o) { - if (this == o) return true; - if (o == null || getClass() != o.getClass()) return false; - - Plan plan = (Plan) o; - - if (id != null ? !id.equals(plan.id) : plan.id != null) return false; - //noinspection RedundantIfStatement - if (name != null ? !name.equals(plan.name) : plan.name != null) return false; - - return true; - } - - - @Override - public String toString() { - return "Plan{" + - "id='" + id + '\'' + - ", name='" + name + '\'' + - "} " + super.toString(); - } - - - } - - @SuppressWarnings("FieldCanBeLocal") - @JsonProperty("type") - private final String type = "company"; - - @JsonProperty("id") - private String id; - - @JsonProperty("name") - private String name; - - @JsonProperty("company_id") - private String companyID; - - @JsonProperty("session_count") - private int sessionCount; - - @JsonProperty("monthly_spend") - private float monthlySpend; - - @JsonProperty("remote_created_at") - private long remoteCreatedAt; - - @JsonProperty("created_at") - private long createdAt; - - @JsonProperty("updated_at") - private long updatedAt; - - @JsonProperty("plan") - private Plan plan; - - @JsonProperty("user_count") - private Integer userCount; - - @JsonIgnoreProperties(ignoreUnknown = false) - @JsonProperty("custom_attributes") - private Map customAttributes = Maps.newHashMap(); - - @JsonProperty("segments") - private SegmentCollection segmentCollection = new SegmentCollection(); - - @JsonProperty("tags") - private TagCollection tagCollection = new TagCollection(); - - private Boolean untag; - - public Company() { - } - - public Company untag() { - untag = Boolean.TRUE; - return this; - } - - public String getType() { - return type; - } - - public String getId() { - return id; - } - - @VisibleForTesting - Company setId(String id) { - this.id = id; - return this; - } - - public String getName() { - return name; - } - - public Company setName(String name) { - this.name = name; - return this; - } - - public long getCreatedAt() { - return createdAt; - } - - public long getUpdatedAt() { - return updatedAt; - } - - public String getCompanyID() { - return companyID; - } - - public Company setCompanyID(String companyID) { - this.companyID = companyID; - return this; - } - - public int getSessionCount() { - return sessionCount; - } - - /** - * Deprecated. The Intercom API does not support changing the - * session value for a company. Calling this method has no - * effect. - * - * @param sessionCount this value is ignored - * @return the company object - */ - @Deprecated - public Company setSessionCount(int sessionCount) { - return this; - } - - public long getRemoteCreatedAt() { - return remoteCreatedAt; - } - - public Company setRemoteCreatedAt(long remoteCreatedAt) { - this.remoteCreatedAt = remoteCreatedAt; - return this; - } - - public Map getCustomAttributes() { - return customAttributes; - } - - public Company setCustomAttributes(Map customAttributes) { - this.customAttributes = customAttributes; - return this; - } - - public Company addCustomAttribute(CustomAttribute customAttribute) { - this.customAttributes.put(customAttribute.getName(), customAttribute); - return this; - } - - public Plan getPlan() { - return plan; - } - - public Company setPlan(Plan plan) { - this.plan = plan; - return this; - } - - public Integer getUserCount() { - return userCount; - } - - public float getMonthlySpend() { - return monthlySpend; - } - - public Company setMonthlySpend(float monthlySpend) { - this.monthlySpend = monthlySpend; - return this; - } - - public SegmentCollection getSegmentCollection() { - return segmentCollection; - } - - public TagCollection getTagCollection() { - return tagCollection; - } - - boolean isUntag() { - return untag == null ? false : untag; - } - - @Override - public boolean equals(Object o) { - if (this == o) return true; - if (o == null || getClass() != o.getClass()) return false; - - Company company = (Company) o; - - if (createdAt != company.createdAt) return false; - if (Float.compare(company.monthlySpend, monthlySpend) != 0) return false; - if (remoteCreatedAt != company.remoteCreatedAt) return false; - if (sessionCount != company.sessionCount) return false; - if (updatedAt != company.updatedAt) return false; - if (companyID != null ? !companyID.equals(company.companyID) : company.companyID != null) return false; - if (customAttributes != null ? !customAttributes.equals(company.customAttributes) : company.customAttributes != null) - return false; - if (id != null ? !id.equals(company.id) : company.id != null) return false; - if (name != null ? !name.equals(company.name) : company.name != null) return false; - if (plan != null ? !plan.equals(company.plan) : company.plan != null) return false; - if (segmentCollection != null ? !segmentCollection.equals(company.segmentCollection) : company.segmentCollection != null) - return false; - if (tagCollection != null ? !tagCollection.equals(company.tagCollection) : company.tagCollection != null) - return false; - if (!type.equals(company.type)) return false; - if (untag != null ? !untag.equals(company.untag) : company.untag != null) return false; - //noinspection RedundantIfStatement - if (userCount != null ? !userCount.equals(company.userCount) : company.userCount != null) return false; - - return true; - } - - @Override - public int hashCode() { - int result = type.hashCode(); - result = 31 * result + (id != null ? id.hashCode() : 0); - result = 31 * result + (name != null ? name.hashCode() : 0); - result = 31 * result + (companyID != null ? companyID.hashCode() : 0); - result = 31 * result + sessionCount; - result = 31 * result + (monthlySpend != +0.0f ? Float.floatToIntBits(monthlySpend) : 0); - result = 31 * result + (int) (remoteCreatedAt ^ (remoteCreatedAt >>> 32)); - result = 31 * result + (int) (createdAt ^ (createdAt >>> 32)); - result = 31 * result + (int) (updatedAt ^ (updatedAt >>> 32)); - result = 31 * result + (plan != null ? plan.hashCode() : 0); - result = 31 * result + (userCount != null ? userCount.hashCode() : 0); - result = 31 * result + (customAttributes != null ? customAttributes.hashCode() : 0); - result = 31 * result + (segmentCollection != null ? segmentCollection.hashCode() : 0); - result = 31 * result + (tagCollection != null ? tagCollection.hashCode() : 0); - result = 31 * result + (untag != null ? untag.hashCode() : 0); - return result; - } - - @Override - public String toString() { - return "Company{" + - "id='" + id + '\'' + - ", name='" + name + '\'' + - ", companyID='" + companyID + '\'' + - ", sessionCount=" + sessionCount + - ", monthlySpend=" + monthlySpend + - ", remoteCreatedAt=" + remoteCreatedAt + - ", createdAt=" + createdAt + - ", updatedAt=" + updatedAt + - ", plan=" + plan + - ", customAttributes=" + customAttributes + - ", segmentCollection=" + segmentCollection + - ", tagCollection=" + tagCollection + - "} " + super.toString(); - } - - -} diff --git a/intercom-java/src/main/java/io/intercom/api/CompanyCollection.java b/intercom-java/src/main/java/io/intercom/api/CompanyCollection.java deleted file mode 100644 index 37f8019e..00000000 --- a/intercom-java/src/main/java/io/intercom/api/CompanyCollection.java +++ /dev/null @@ -1,66 +0,0 @@ -package io.intercom.api; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonProperty; - -import java.util.Iterator; -import java.util.List; - -@SuppressWarnings("UnusedDeclaration") -@JsonIgnoreProperties(ignoreUnknown = true) -public class CompanyCollection extends TypedDataCollection implements Iterator { - - protected TypedDataCollectionIterator iterator; - - @JsonProperty("total_count") - private long totalCount; - - public CompanyCollection() { - type = "company.list"; - iterator = new TypedDataCollectionIterator(this); - } - - public CompanyCollection(List companies) { - this(); - this.page = companies; - } - - @SuppressWarnings("EmptyMethod") - @JsonProperty("companies") - @Override - public List getPage() { - return super.getPage(); - } - - public long getTotalCount() { - return totalCount; - } - - @Override - public CompanyCollection nextPage() { - return fetchNextPage(CompanyCollection.class); - } - - public boolean hasNext() { - return iterator.hasNext(); - } - - public Company next() { - return iterator.next(); - } - - public void remove() { - iterator.remove(); - } - - @Override - public String toString() { - return "CompanyCollection{" + - ", totalCount=" + totalCount + - "} " + super.toString(); - } - - void addCompany(Company company) { - page.add(company); - } -} diff --git a/intercom-java/src/main/java/io/intercom/api/CompanyWithStringPlan.java b/intercom-java/src/main/java/io/intercom/api/CompanyWithStringPlan.java deleted file mode 100644 index 1c8387f5..00000000 --- a/intercom-java/src/main/java/io/intercom/api/CompanyWithStringPlan.java +++ /dev/null @@ -1,111 +0,0 @@ -package io.intercom.api; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.google.common.collect.Maps; - -import java.util.Map; - -@SuppressWarnings("UnusedDeclaration") -@JsonInclude(JsonInclude.Include.NON_DEFAULT) -@JsonIgnoreProperties(ignoreUnknown = true) -class CompanyWithStringPlan extends TypedData { - - @JsonProperty("id") - private String id; - - @JsonProperty("name") - private String name; - - @JsonProperty("company_id") - private String companyID; - - @JsonProperty("session_count") - private int sessionCount; - - @JsonProperty("monthly_spend") - private float monthlySpend; - - @JsonProperty("remote_created_at") - private long remoteCreatedAt; - - @JsonProperty("plan") - private String plan; - - @JsonIgnoreProperties(ignoreUnknown = false) - @JsonProperty("custom_attributes") - private Map customAttributes = Maps.newHashMap(); - - public CompanyWithStringPlan() { - } - - public String getType() { - return "company"; - } - - public String getId() { - return id; - } - - public void setId(String id) { - this.id = id; - } - - public String getName() { - return name; - } - - public void setName(String name) { - this.name = name; - } - - public String getCompanyID() { - return companyID; - } - - public void setCompanyID(String companyID) { - this.companyID = companyID; - } - - public Integer getSessionCount() { - return sessionCount; - } - - public void setSessionCount(Integer sessionCount) { - this.sessionCount = sessionCount; - } - - public float getMonthlySpend() { - return monthlySpend; - } - - public void setMonthlySpend(float monthlySpend) { - this.monthlySpend = monthlySpend; - } - - public long getRemoteCreatedAt() { - return remoteCreatedAt; - } - - public void setRemoteCreatedAt(long remoteCreatedAt) { - this.remoteCreatedAt = remoteCreatedAt; - } - - public String getPlan() { - return plan; - } - - public void setPlan(String plan) { - this.plan = plan; - } - - public Map getCustomAttributes() { - return customAttributes; - } - - public void setCustomAttributes(Map customAttributes) { - this.customAttributes = customAttributes; - } - -} diff --git a/intercom-java/src/main/java/io/intercom/api/Conversation.java b/intercom-java/src/main/java/io/intercom/api/Conversation.java deleted file mode 100644 index c8e35cf0..00000000 --- a/intercom-java/src/main/java/io/intercom/api/Conversation.java +++ /dev/null @@ -1,267 +0,0 @@ -package io.intercom.api; - - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.google.common.base.Optional; -import com.google.common.collect.Maps; - -import java.net.URI; -import java.util.HashMap; -import java.util.List; -import java.util.Map; - -@SuppressWarnings("UnusedDeclaration") -@JsonIgnoreProperties(ignoreUnknown = true) -public class Conversation extends TypedData { - - private static final HashMap SENTINEL = Maps.newHashMap(); - - public static Conversation find(String id) throws InvalidException, AuthorizationException { - final HttpClient resource = new HttpClient(UriBuilder.newBuilder().path("conversations").path(id).build()); - return resource.get(Conversation.class); - } - - public static ConversationCollection list() throws InvalidException, AuthorizationException { - return DataResource.list(SENTINEL, "conversations", ConversationCollection.class); - } - - public static ConversationCollection list(Map params) throws InvalidException, AuthorizationException { - if (!params.containsKey("type")) { - throw new InvalidException("a user or admin type must be supplied for a conversation query"); - } - - if (isAdminQuery(params) - && !(params.containsKey("admin_id"))) { - throw new InvalidException("an admin_id must be supplied for an admin conversation query"); - } - - if (isUserQuery(params) - && (!params.containsKey("intercom_user_id") - && !params.containsKey("user_id") - && !params.containsKey("email"))) { - throw new InvalidException( - "One of intercom_user_id, user_id or email must be supplied for a user conversation query"); - } - - return DataResource.list(params, "conversations", ConversationCollection.class); - } - - public static Conversation reply(String id, UserReply reply) { - final URI uri = UriBuilder.newBuilder() - .path("conversations") - .path(id) - .path("reply") - .build(); - return new HttpClient(uri) - .post(Conversation.class, new UserReply.UserStringReply(reply)); - } - - public static Conversation reply(String id, AdminReply reply) { - final URI uri = UriBuilder.newBuilder() - .path("conversations") - .path(id) - .path("reply") - .build(); - return new HttpClient(uri) - .post(Conversation.class, new AdminReply.AdminStringReply(reply)); - } - - public static UserMessage create(UserMessage message) { - return DataResource.create(message, "messages", UserMessage.class); - } - - public static AdminMessage create(AdminMessage message) throws InvalidException { - if ((!message.getTemplate().equals("plain")) && (!message.getTemplate().equals("personal"))) { - throw new InvalidException("The template must be either personal or plain"); - } - if ((!message.getMessageType().equals("email")) && (!message.getMessageType().equals("inapp"))) { - throw new InvalidException("The message type must be either email or inapp"); - } - /* - the message api is asymmetric because reasons. this wraps the response - type so we only expose AdminMessage in the client surface - */ - final AdminMessageResponse adminMessageResponse = - DataResource.create(message, "messages", AdminMessageResponse.class); - AdminMessage response = new AdminMessage(); - response.setAdmin(adminMessageResponse.getAdmin()); - response.setBody(adminMessageResponse.getBody()); - response.setCreatedAt(adminMessageResponse.getCreatedAt()); - response.setId(adminMessageResponse.getId()); - response.setMessageType(adminMessageResponse.getMessageType()); - response.setSubject(adminMessageResponse.getSubject()); - response.setTemplate(adminMessageResponse.getTemplate()); - // user returns null - // response.setUser(adminMessageResponse.getFrom()); - return response; - } - - private static boolean isUserQuery(Map params) { - return params.containsKey("type") && params.get("type").equals("user"); - } - - private static boolean isAdminQuery(Map params) { - return params.containsKey("type") && params.get("type").equals("admin"); - } - - @JsonProperty("type") - private final String type = "conversation"; - - @JsonProperty("id") - private String id; - - @JsonProperty("conversation_message") - private ConversationMessage conversationMessage; - - @JsonProperty("user") - private User user; - - @JsonProperty("assignee") - private Admin assignee; - - @JsonProperty("created_at") - private long createdAt; - - @JsonProperty("updated_at") - private long updatedAt; - - @JsonProperty("conversation_parts") - private ConversationPartCollection conversationPartCollection; - - @JsonProperty("open") - private boolean open; - - @JsonProperty("read") - private boolean read; - - @JsonProperty("links") - private Map links; - - public Conversation() { - } - - public String getType() { - return type; - } - - public Admin getCurrentAssignee() { - Admin assignee = null; - if (getAssignee() != null) { - assignee = getAssignee(); - } else if (getMostRecentConversationPart() != null && getMostRecentConversationPart().getAssignedTo() != null) { - assignee = getMostRecentConversationPart().getAssignedTo(); - } - - return assignee; - } - - public Optional getFirstConversationPart() { - return Optional.fromNullable(getConversationPartCollection().getPage().get(0)); - } - - public ConversationPart getMostRecentConversationPart() { - final ConversationPartCollection conversationParts = getConversationPartCollection(); - final List items = conversationParts.getPage(); - if (items.isEmpty()) { - return null; - } else { - return items.get(items.size() - 1); - } - } - - public String getId() { - return id; - } - - public ConversationMessage getConversationMessage() { - return conversationMessage; - } - - public User getUser() { - return user; - } - - public Admin getAssignee() { - return assignee; - } - - public long getCreatedAt() { - return createdAt; - } - - public long getUpdatedAt() { - return updatedAt; - } - - public ConversationPartCollection getConversationPartCollection() { - return conversationPartCollection; - } - - public boolean getOpen() { - return open; - } - - public boolean getRead() { - return read; - } - - @Override - public boolean equals(Object o) { - if (this == o) return true; - if (o == null || getClass() != o.getClass()) return false; - - Conversation that = (Conversation) o; - - if (createdAt != that.createdAt) return false; - if (open != that.open) return false; - if (read != that.read) return false; - if (updatedAt != that.updatedAt) return false; - if (assignee != null ? !assignee.equals(that.assignee) : that.assignee != null) return false; - if (conversationMessage != null ? !conversationMessage.equals(that.conversationMessage) : that.conversationMessage != null) - return false; - if (conversationPartCollection != null ? !conversationPartCollection.equals(that.conversationPartCollection) : that.conversationPartCollection != null) - return false; - if (id != null ? !id.equals(that.id) : that.id != null) return false; - if (links != null ? !links.equals(that.links) : that.links != null) return false; - if (!type.equals(that.type)) return false; - //noinspection RedundantIfStatement - if (user != null ? !user.equals(that.user) : that.user != null) return false; - - return true; - } - - @Override - public int hashCode() { - int result = type.hashCode(); - result = 31 * result + (id != null ? id.hashCode() : 0); - result = 31 * result + (conversationMessage != null ? conversationMessage.hashCode() : 0); - result = 31 * result + (user != null ? user.hashCode() : 0); - result = 31 * result + (assignee != null ? assignee.hashCode() : 0); - result = 31 * result + (int) (createdAt ^ (createdAt >>> 32)); - result = 31 * result + (int) (updatedAt ^ (updatedAt >>> 32)); - result = 31 * result + (conversationPartCollection != null ? conversationPartCollection.hashCode() : 0); - result = 31 * result + (open ? 1 : 0); - result = 31 * result + (read ? 1 : 0); - result = 31 * result + (links != null ? links.hashCode() : 0); - return result; - } - - @Override - public String toString() { - return "Conversation{" + - "type='" + type + '\'' + - ", id='" + id + '\'' + - ", conversationMessage=" + conversationMessage + - ", user=" + user + - ", assignee=" + assignee + - ", createdAt=" + createdAt + - ", updatedAt=" + updatedAt + - ", conversationPartCollection=" + conversationPartCollection + - ", open=" + open + - ", read=" + read + - ", links=" + links + - "} " + super.toString(); - } -} - diff --git a/intercom-java/src/main/java/io/intercom/api/ConversationCollection.java b/intercom-java/src/main/java/io/intercom/api/ConversationCollection.java deleted file mode 100644 index 68251f0c..00000000 --- a/intercom-java/src/main/java/io/intercom/api/ConversationCollection.java +++ /dev/null @@ -1,44 +0,0 @@ -package io.intercom.api; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonProperty; - -import java.util.Iterator; -import java.util.List; - -@SuppressWarnings("UnusedDeclaration") -@JsonIgnoreProperties(ignoreUnknown = true) -public class ConversationCollection extends TypedDataCollection implements Iterator { - - protected TypedDataCollectionIterator iterator; - - public ConversationCollection() { - type = "conversation.list"; - iterator = new TypedDataCollectionIterator(this); - } - - @SuppressWarnings("EmptyMethod") - @JsonProperty("conversations") - public List getPage() { - return super.getPage(); - } - - @Override - public ConversationCollection nextPage() { - return fetchNextPage(ConversationCollection.class); - } - - - public boolean hasNext() { - return iterator.hasNext(); - } - - public Conversation next() { - return iterator.next(); - } - - public void remove() { - iterator.remove(); - } - -} diff --git a/intercom-java/src/main/java/io/intercom/api/ConversationMessage.java b/intercom-java/src/main/java/io/intercom/api/ConversationMessage.java deleted file mode 100644 index 328a7b3b..00000000 --- a/intercom-java/src/main/java/io/intercom/api/ConversationMessage.java +++ /dev/null @@ -1,74 +0,0 @@ -package io.intercom.api; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonProperty; - -@SuppressWarnings("UnusedDeclaration") -@JsonIgnoreProperties(ignoreUnknown = true) -public class ConversationMessage extends TypedData { - - @SuppressWarnings("FieldCanBeLocal") - @JsonProperty("type") - private final String type = "conversation_message"; - - @JsonProperty - private String subject; - - @JsonProperty - private String body; - - @JsonProperty - private Author author; - - public ConversationMessage() { - } - - public String getType() { - return type; - } - - public String getSubject() { - return subject; - } - - public String getBody() { - return body; - } - - public Author getAuthor() { - return author; - } - - @Override - public int hashCode() { - int result = subject != null ? subject.hashCode() : 0; - result = 31 * result + (body != null ? body.hashCode() : 0); - result = 31 * result + (author != null ? author.hashCode() : 0); - return result; - } - - @Override - public boolean equals(Object o) { - if (this == o) return true; - if (o == null || getClass() != o.getClass()) return false; - - ConversationMessage that = (ConversationMessage) o; - - if (author != null ? !author.equals(that.author) : that.author != null) return false; - if (body != null ? !body.equals(that.body) : that.body != null) return false; - //noinspection RedundantIfStatement - if (subject != null ? !subject.equals(that.subject) : that.subject != null) return false; - - return true; - } - - @Override - public String toString() { - return "ConversationMessage{" + - "type='" + type + '\'' + - ", subject='" + subject + '\'' + - ", body='" + body + '\'' + - ", author=" + author + - "} " + super.toString(); - } -} diff --git a/intercom-java/src/main/java/io/intercom/api/ConversationPart.java b/intercom-java/src/main/java/io/intercom/api/ConversationPart.java deleted file mode 100644 index 74240721..00000000 --- a/intercom-java/src/main/java/io/intercom/api/ConversationPart.java +++ /dev/null @@ -1,125 +0,0 @@ -package io.intercom.api; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonProperty; - -@SuppressWarnings("UnusedDeclaration") -@JsonIgnoreProperties(ignoreUnknown = true) -public class ConversationPart extends TypedData { - - @JsonProperty("type") - private final String type = "conversation_part"; - - @JsonProperty - private String id; - - @JsonProperty("part_type") - private String partType; - - @JsonProperty - private String body; - - @JsonProperty - private Author author; - - @JsonProperty("assigned_to") - private Admin assignedTo; - - @JsonProperty("created_at") - private long createdAt; - - @JsonProperty("updated_at") - private long updatedAt; - - @JsonProperty("notified_at") - private long NotifiedAt; - - public ConversationPart() { - } - - public String getType() { - return type; - } - - public String getId() { - return id; - } - - public String getPartType() { - return partType; - } - - public String getBody() { - return body; - } - - public Author getAuthor() { - return author; - } - - public Admin getAssignedTo() { - return assignedTo; - } - - public long getCreatedAt() { - return createdAt; - } - - public long getUpdatedAt() { - return updatedAt; - } - - public long getNotifiedAt() { - return NotifiedAt; - } - - @Override - public boolean equals(Object o) { - if (this == o) return true; - if (o == null || getClass() != o.getClass()) return false; - - ConversationPart that = (ConversationPart) o; - - if (NotifiedAt != that.NotifiedAt) return false; - if (createdAt != that.createdAt) return false; - if (updatedAt != that.updatedAt) return false; - if (assignedTo != null ? !assignedTo.equals(that.assignedTo) : that.assignedTo != null) return false; - if (author != null ? !author.equals(that.author) : that.author != null) return false; - if (body != null ? !body.equals(that.body) : that.body != null) return false; - if (id != null ? !id.equals(that.id) : that.id != null) return false; - if (partType != null ? !partType.equals(that.partType) : that.partType != null) return false; - //noinspection RedundantIfStatement - if (!type.equals(that.type)) return false; - - return true; - } - - @Override - public int hashCode() { - int result = type.hashCode(); - result = 31 * result + (id != null ? id.hashCode() : 0); - result = 31 * result + (partType != null ? partType.hashCode() : 0); - result = 31 * result + (body != null ? body.hashCode() : 0); - result = 31 * result + (author != null ? author.hashCode() : 0); - result = 31 * result + (assignedTo != null ? assignedTo.hashCode() : 0); - result = 31 * result + (int) (createdAt ^ (createdAt >>> 32)); - result = 31 * result + (int) (updatedAt ^ (updatedAt >>> 32)); - result = 31 * result + (int) (NotifiedAt ^ (NotifiedAt >>> 32)); - return result; - } - - @Override - public String toString() { - return "ConversationPart{" + - "type='" + type + '\'' + - ", id='" + id + '\'' + - ", partType='" + partType + '\'' + - ", body='" + body + '\'' + - ", author=" + author + - ", assignedTo=" + assignedTo + - ", createdAt=" + createdAt + - ", updatedAt=" + updatedAt + - ", NotifiedAt=" + NotifiedAt + - "} " + super.toString(); - } -} diff --git a/intercom-java/src/main/java/io/intercom/api/ConversationPartCollection.java b/intercom-java/src/main/java/io/intercom/api/ConversationPartCollection.java deleted file mode 100644 index 0a67e617..00000000 --- a/intercom-java/src/main/java/io/intercom/api/ConversationPartCollection.java +++ /dev/null @@ -1,26 +0,0 @@ -package io.intercom.api; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonProperty; - -import java.util.List; - -@SuppressWarnings("UnusedDeclaration") -@JsonIgnoreProperties(ignoreUnknown = true) -public class ConversationPartCollection extends TypedDataCollection { - - public ConversationPartCollection() { - type = "conversation_part.list"; - } - - @SuppressWarnings("EmptyMethod") - @JsonProperty("conversation_parts") - public List getPage() { - return super.getPage(); - } - - @Override - public ConversationPartCollection nextPage() { - return new ConversationPartCollection(); - } -} diff --git a/intercom-java/src/main/java/io/intercom/api/CountItemDeserializer.java b/intercom-java/src/main/java/io/intercom/api/CountItemDeserializer.java deleted file mode 100644 index e991d642..00000000 --- a/intercom-java/src/main/java/io/intercom/api/CountItemDeserializer.java +++ /dev/null @@ -1,27 +0,0 @@ -package io.intercom.api; - -import com.fasterxml.jackson.core.JsonParser; -import com.fasterxml.jackson.core.TreeNode; -import com.fasterxml.jackson.databind.DeserializationContext; -import com.fasterxml.jackson.databind.JsonNode; -import com.fasterxml.jackson.databind.deser.std.StdDeserializer; -import com.fasterxml.jackson.databind.node.ObjectNode; - -import java.io.IOException; -import java.util.Map; - -class CountItemDeserializer extends StdDeserializer { - - private static final long serialVersionUID = 8226175715446656115L; - - public CountItemDeserializer() { - super(Counts.CountItem.class); - } - - @Override - public Counts.CountItem deserialize(JsonParser jp, DeserializationContext ctxt) throws IOException { - final TreeNode treeNode = jp.getCodec().readTree(jp); - final Map.Entry next = ((ObjectNode) treeNode).fields().next(); - return new Counts.CountItem(next.getKey(), next.getValue().asLong()); - } -} diff --git a/intercom-java/src/main/java/io/intercom/api/CountItemSerializer.java b/intercom-java/src/main/java/io/intercom/api/CountItemSerializer.java deleted file mode 100644 index bdd581b0..00000000 --- a/intercom-java/src/main/java/io/intercom/api/CountItemSerializer.java +++ /dev/null @@ -1,22 +0,0 @@ -package io.intercom.api; - -import com.fasterxml.jackson.core.JsonGenerator; -import com.fasterxml.jackson.databind.SerializerProvider; -import com.fasterxml.jackson.databind.ser.std.StdSerializer; - -import java.io.IOException; - -class CountItemSerializer extends StdSerializer { - - public CountItemSerializer() { - super(Counts.CountItem.class); - } - - @Override - public void serialize(Counts.CountItem value, JsonGenerator jgen, SerializerProvider provider) - throws IOException { - jgen.writeStartObject(); - jgen.writeNumberField(value.getName(), value.getValue()); - jgen.writeEndObject(); - } -} diff --git a/intercom-java/src/main/java/io/intercom/api/Counts.java b/intercom-java/src/main/java/io/intercom/api/Counts.java deleted file mode 100644 index 170687de..00000000 --- a/intercom-java/src/main/java/io/intercom/api/Counts.java +++ /dev/null @@ -1,340 +0,0 @@ -package io.intercom.api; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.google.common.collect.Maps; - -import java.net.URI; -import java.util.HashMap; -import java.util.List; -import java.util.Map; - -@SuppressWarnings("UnusedDeclaration") -@JsonIgnoreProperties(ignoreUnknown = true) -@JsonInclude(JsonInclude.Include.NON_EMPTY) -public class Counts { - - static Counts countQuery(Map query) { - final URI build = UriBuilder.newBuilder() - .path("counts") - .query(query) - .build(); - final HttpClient resource = new HttpClient(build); - return resource.get(Counts.class); - } - - public static Counts.Totals appTotals() throws InvalidException, AuthorizationException { - final HttpClient resource = new HttpClient(UriBuilder.newBuilder().path("counts").build()); - return resource.get(Totals.class); - } - -// public static Long userCount() throws InvalidException, AuthorizationException{ -// final HashMap params = Maps.newHashMap(); -// params.put("type", "user"); -// return countQuery(params).getUser().getUser(); -// } - - public static List userTags() throws InvalidException, AuthorizationException { - final HashMap params = Maps.newHashMap(); - params.put("type", "user"); - params.put("count", "tag"); - return countQuery(params).getUser().getTags(); - } - - public static List userSegments() throws InvalidException, AuthorizationException { - final HashMap params = Maps.newHashMap(); - params.put("type", "user"); - params.put("count", "segment"); - return countQuery(params).getUser().getSegments(); - } - - public static Counts.Conversation conversationTotals() throws InvalidException, AuthorizationException { - final HashMap params = Maps.newHashMap(); - params.put("type", "conversation"); - return countQuery(params).getConversation(); - } - - public static Counts.Conversation conversationAdmins() throws InvalidException, AuthorizationException { - final HashMap params = Maps.newHashMap(); - params.put("type", "conversation"); - params.put("count", "admin"); - return countQuery(params).getConversation(); - } - -// public static Long companyCount() throws InvalidException, AuthorizationException{ -// final HashMap params = Maps.newHashMap(); -// params.put("type", "company"); -// return countQuery(params).getCompany().getCompanies(); -// } - - public static List companySegments() throws InvalidException, AuthorizationException { - final HashMap params = Maps.newHashMap(); - params.put("type", "company"); - params.put("count", "segment"); - return countQuery(params).getCompany().getSegments(); - } - - public static List companyTags() throws InvalidException, AuthorizationException { - final HashMap params = Maps.newHashMap(); - params.put("type", "company"); - params.put("count", "tag"); - return countQuery(params).getCompany().getTags(); - } - - public static List companyUsers() throws InvalidException, AuthorizationException { - final HashMap params = Maps.newHashMap(); - params.put("type", "company"); - params.put("count", "user"); - return countQuery(params).getCompany().getUsers(); - } - - @JsonIgnoreProperties(ignoreUnknown = true) - @JsonInclude(JsonInclude.Include.NON_EMPTY) - public static class Totals { - - @JsonProperty("company") - private CountItem company; - - @JsonProperty("segment") - private CountItem segment; - - @JsonProperty("tag") - private CountItem tag; - - @JsonProperty("user") - private CountItem user; - - public CountItem getCompany() { - return company; - } - - public CountItem getSegment() { - return segment; - } - - public CountItem getTag() { - return tag; - } - - public CountItem getUser() { - return user; - } - - @Override - public String toString() { - return "Totals{" + - "company=" + company + - ", segment=" + segment + - ", tag=" + tag + - ", user=" + user + - '}'; - } - } - - @JsonIgnoreProperties(ignoreUnknown = true) - @JsonInclude(JsonInclude.Include.NON_EMPTY) - public static class CountItem { - - private String name; - - private long value; - - public CountItem(String name, long value) { - this.name = name; - this.value = value; - } - - public String getName() { - return name; - } - - public long getValue() { - return value; - } - - @Override - public String toString() { - return "CountItem{" + - "name='" + name + '\'' + - ", value=" + value + - '}'; - } - } - - @JsonIgnoreProperties(ignoreUnknown = true) - @JsonInclude(JsonInclude.Include.NON_EMPTY) - public static class Conversation { - - @JsonProperty("admin") - List admins; - - @JsonProperty("assigned") - private long assigned; - - @JsonProperty("closed") - private long closed; - - @JsonProperty("open") - private long open; - - @JsonProperty("unassigned") - private long unassigned; - - Conversation() { - } - - public List getAdmins() { - return admins; - } - - public long getAssigned() { - return assigned; - } - - public long getClosed() { - return closed; - } - - public long getOpen() { - return open; - } - - public long getUnassigned() { - return unassigned; - } - - @Override - public String toString() { - return "Conversation{" + - "assigned=" + assigned + - ", closed=" + closed + - ", open=" + open + - ", unassigned=" + unassigned + - ", admins=" + admins + - '}'; - } - } - - @JsonIgnoreProperties(ignoreUnknown = true) - @JsonInclude(JsonInclude.Include.NON_EMPTY) - public static class User { - - @JsonProperty("user") - private long user; - - @JsonProperty("tag") - private List tags; - - @JsonProperty("segment") - private List segments; - - User() { - } - - public long getUser() { - return user; - } - - public List getTags() { - return tags; - } - - public List getSegments() { - return segments; - } - - @Override - public String toString() { - return "User{" + - "user=" + user + - ", tags=" + tags + - ", segments=" + segments + - '}'; - } - } - - @JsonIgnoreProperties(ignoreUnknown = true) - @JsonInclude(JsonInclude.Include.NON_EMPTY) - public static class Company { - - @JsonProperty("company") - private long companies; - - @JsonProperty("tag") - private List tags; - - @JsonProperty("user") - private List users; - - @JsonProperty("segment") - private List segments; - - Company() { - } - - public long getCompanies() { - return companies; - } - - public List getTags() { - return tags; - } - - public List getUsers() { - return users; - } - - public List getSegments() { - return segments; - } - - @Override - public String toString() { - return "Company{" + - "companies=" + companies + - ", tags=" + tags + - ", users=" + users + - ", segments=" + segments + - '}'; - } - } - - @JsonProperty("type") - private String type = "count"; - - @JsonProperty("company") - private Counts.Company company; - - @JsonProperty("user") - private Counts.User user; - - @JsonProperty("conversation") - private Counts.Conversation conversation; - - public String getType() { - return type; - } - - public Company getCompany() { - return company; - } - - public User getUser() { - return user; - } - - public Conversation getConversation() { - return conversation; - } - - @Override - public String toString() { - return "Counts{" + - "type='" + type + '\'' + - ", company=" + company + - ", user=" + user + - ", conversation=" + conversation + - '}'; - } -} diff --git a/intercom-java/src/main/java/io/intercom/api/CustomAttribute.java b/intercom-java/src/main/java/io/intercom/api/CustomAttribute.java deleted file mode 100644 index 1415fa32..00000000 --- a/intercom-java/src/main/java/io/intercom/api/CustomAttribute.java +++ /dev/null @@ -1,202 +0,0 @@ -package io.intercom.api; - -import com.google.common.collect.Lists; - -import java.io.Serializable; -import java.util.ArrayList; - -@SuppressWarnings("UnusedDeclaration") -public class CustomAttribute { - - @SuppressWarnings("unchecked") - private static final ArrayList> CLASSES = Lists.newArrayList(String.class, Long.class, Float.class, Double.class, Boolean.class, Integer.class); - - public static StringAttribute newStringAttribute(String name, String value) { - return new StringAttribute(name, value); - } - - public static BooleanAttribute newBooleanAttribute(String name, boolean value) { - return new BooleanAttribute(name, value); - } - - public static DoubleAttribute newDoubleAttribute(String name, double value) { - return new DoubleAttribute(name, value); - } - - public static LongAttribute newLongAttribute(String name, long value) { - return new LongAttribute(name, value); - } - - public static IntegerAttribute newIntegerAttribute(String name, int value) { - return new IntegerAttribute(name, value); - } - - public static FloatAttribute newFloatAttribute(String name, float value) { - return new FloatAttribute(name, value); - } - - public static class StringAttribute extends CustomAttribute { - - private StringAttribute(String name, String value) { - super(name, value, String.class); - } - - private StringAttribute(String name, String value, Class clazz) { - super(name, value, clazz); - } - } - - public static class BooleanAttribute extends CustomAttribute { - - private BooleanAttribute(String name, boolean value) { - super(name, value, Boolean.class); - } - - private BooleanAttribute(String name, boolean value, Class clazz) { - super(name, value, clazz); - } - } - - public static class DoubleAttribute extends CustomAttribute { - - private DoubleAttribute(String name, double value, Class clazz) { - super(name, value, clazz); - } - - private DoubleAttribute(String name, double value) { - super(name, value, Double.class); - } - } - - public static class FloatAttribute extends CustomAttribute { - - private FloatAttribute(String name, float value, Class clazz) { - super(name, value, clazz); - } - - private FloatAttribute(String name, float value) { - super(name, value, Float.class); - } - } - - public static class IntegerAttribute extends CustomAttribute { - - private IntegerAttribute(String name, int value) { - super(name, value, Integer.class); - } - - private IntegerAttribute(String name, int value, Class clazz) { - super(name, value, clazz); - } - } - - public static class LongAttribute extends CustomAttribute { - - public LongAttribute(String name, long value, Class clazz) { - super(name, value, clazz); - } - - public LongAttribute(String name, long value) { - super(name, value, Long.class); - } - - } - - private String name; - - private T value; - - private Class clazz; - - public CustomAttribute(String name, T value, Class clazz) { - //noinspection SuspiciousMethodCalls - if (!CLASSES.contains(clazz)) { - throw new InvalidException(String.format("cannot accept class type [%s] for custom attribute", clazz.getName())); - } - this.name = name; - this.value = value; - this.clazz = clazz; - - } - - public Class getValueClass() { - return clazz; - } - - public String getName() { - return name; - } - - public void setName(String name) { - this.name = name; - } - - public T getValue() { - return value; - } - - public void setValue(T value) { - this.value = value; - } - - public C as(Class c) { - //noinspection unchecked - return (C) getValue(); - } - - public long longValue() { - return as(Long.class); - } - - public String textValue() { - return as(String.class); - } - - public boolean booleanValue() { - return as(Boolean.class); - } - - public float floatValue() { - return as(Float.class); - } - - public double doubleValue() { - return as(Double.class); - } - - public int integerValue() { - return as(Integer.class); - } - - @Override - public int hashCode() { - int result = name != null ? name.hashCode() : 0; - result = 31 * result + (value != null ? value.hashCode() : 0); - result = 31 * result + (clazz != null ? clazz.hashCode() : 0); - return result; - } - - @Override - public boolean equals(Object o) { - if (this == o) return true; - if (o == null || getClass() != o.getClass()) return false; - - CustomAttribute that = (CustomAttribute) o; - - if (clazz != null ? !clazz.equals(that.clazz) : that.clazz != null) return false; - if (name != null ? !name.equals(that.name) : that.name != null) return false; - //noinspection RedundantIfStatement - if (value != null ? !value.equals(that.value) : that.value != null) return false; - - return true; - } - - @Override - public String toString() { - return "CustomAttribute{" + - "name='" + name + '\'' + - ", value=" + value + - ", clazz=" + clazz + - '}'; - } -} diff --git a/intercom-java/src/main/java/io/intercom/api/CustomAttributeDeserializer.java b/intercom-java/src/main/java/io/intercom/api/CustomAttributeDeserializer.java deleted file mode 100644 index 4756b257..00000000 --- a/intercom-java/src/main/java/io/intercom/api/CustomAttributeDeserializer.java +++ /dev/null @@ -1,53 +0,0 @@ -package io.intercom.api; - -import com.fasterxml.jackson.core.JsonParser; -import com.fasterxml.jackson.databind.DeserializationContext; -import com.fasterxml.jackson.databind.ObjectMapper; -import com.fasterxml.jackson.databind.deser.std.StdDeserializer; -import com.fasterxml.jackson.databind.node.JsonNodeType; -import com.fasterxml.jackson.databind.node.NumericNode; -import com.fasterxml.jackson.databind.node.ValueNode; - -import java.io.IOException; - -class CustomAttributeDeserializer extends StdDeserializer { - - private static final long serialVersionUID = 5069924730975394938L; - - public CustomAttributeDeserializer() { - super(CustomAttribute.class); - } - - @Override - public CustomAttribute deserialize(JsonParser jp, DeserializationContext ctxt) throws IOException { - CustomAttribute cda = null; - final String currentName = jp.getParsingContext().getCurrentName(); - final ObjectMapper mapper = (ObjectMapper) jp.getCodec(); - final ValueNode vNode = mapper.readTree(jp); - if (vNode.asToken().isScalarValue()) { - if (vNode.getNodeType() == JsonNodeType.BOOLEAN) { - cda = new CustomAttribute(currentName, vNode.asBoolean(), Boolean.class); - } else if (vNode.getNodeType() == JsonNodeType.STRING) { - cda = new CustomAttribute(currentName, vNode.asText(), String.class); - } else if (vNode.getNodeType() == JsonNodeType.NUMBER) { - final NumericNode nNode = (NumericNode) vNode; - if (currentName.endsWith("_at")) { - cda = new CustomAttribute(currentName, vNode.longValue(), Long.class); - } else if (nNode.isInt()) { - cda = new CustomAttribute(currentName, vNode.intValue(), Integer.class); - } else if (nNode.isFloat()) { - cda = new CustomAttribute(currentName, vNode.floatValue(), Float.class); - } else if (nNode.isDouble()) { - cda = new CustomAttribute(currentName, vNode.doubleValue(), Double.class); - } else if (nNode.isLong()) { - cda = new CustomAttribute(currentName, vNode.longValue(), Long.class); - } else { - cda = new CustomAttribute(currentName, vNode.asText(), String.class); - } - } else { - cda = new CustomAttribute(currentName, vNode.asText(), String.class); - } - } - return cda; - } -} diff --git a/intercom-java/src/main/java/io/intercom/api/CustomAttributeSerializer.java b/intercom-java/src/main/java/io/intercom/api/CustomAttributeSerializer.java deleted file mode 100644 index 07c2cf08..00000000 --- a/intercom-java/src/main/java/io/intercom/api/CustomAttributeSerializer.java +++ /dev/null @@ -1,21 +0,0 @@ -package io.intercom.api; - -import com.fasterxml.jackson.core.JsonGenerator; -import com.fasterxml.jackson.databind.SerializerProvider; -import com.fasterxml.jackson.databind.ser.std.StdSerializer; - -import java.io.IOException; - -class CustomAttributeSerializer extends StdSerializer { - - public CustomAttributeSerializer() { - super(CustomAttribute.class); - } - - @Override - public void serialize(CustomAttribute value, JsonGenerator jgen, SerializerProvider provider) - throws IOException { - // the field name has already been written - jgen.writeObject(value.getValue()); - } -} diff --git a/intercom-java/src/main/java/io/intercom/api/DataResource.java b/intercom-java/src/main/java/io/intercom/api/DataResource.java deleted file mode 100644 index 71f69eae..00000000 --- a/intercom-java/src/main/java/io/intercom/api/DataResource.java +++ /dev/null @@ -1,44 +0,0 @@ -package io.intercom.api; - -import java.util.Map; - -abstract class DataResource { - - @SuppressWarnings("SameParameterValue") - public static T find(String id, String collectionPath, Class c) { - final HttpClient resource = new HttpClient(UriBuilder.newBuilder().path(collectionPath).path(id).build()); - return resource.get(c); - } - - public static T find(Map params, String collectionPath, Class c) { - final HttpClient resource = new HttpClient(UriBuilder.newBuilder().path(collectionPath).query(params).build()); - return resource.get(c); - } - - public static R create(T entity, String collectionPath, Class response) { - final HttpClient resource = new HttpClient(UriBuilder.newBuilder().path(collectionPath).build()); - return resource.post(response, entity); - } - - public static R update(T entity, String collectionPath, Class response) { - final HttpClient resource = new HttpClient(UriBuilder.newBuilder().path(collectionPath).build()); - return resource.post(response, entity); - } - - @SuppressWarnings("SameParameterValue") - public static R update(T entity, String collectionPath, String id, Class response) { - final HttpClient resource = new HttpClient(UriBuilder.newBuilder().path(collectionPath).path(id).build()); - return resource.post(response, entity); - } - - public static T delete(String id, String collectionPath, Class c) { - final HttpClient resource = new HttpClient(UriBuilder.newBuilder().path(collectionPath).path(id).build()); - return resource.delete(c); - } - - public static C list(Map params, String collectionPath, Class c) { - final HttpClient resource = new HttpClient(UriBuilder.newBuilder().path(collectionPath).query(params).build()); - return resource.get(c); - } - -} diff --git a/intercom-java/src/main/java/io/intercom/api/Error.java b/intercom-java/src/main/java/io/intercom/api/Error.java deleted file mode 100644 index 10beabd2..00000000 --- a/intercom-java/src/main/java/io/intercom/api/Error.java +++ /dev/null @@ -1,77 +0,0 @@ -package io.intercom.api; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonProperty; - -@SuppressWarnings("UnusedDeclaration") -@JsonIgnoreProperties(ignoreUnknown = true) -public class Error extends TypedData { - - @SuppressWarnings("FieldCanBeLocal") - @JsonProperty("type") - private final String type = "error"; - - @JsonProperty("code") - private String code; - - @JsonProperty("message") - private String message; - - public Error() { - } - - public Error(String code, String message) { - this.code = code; - this.message = message; - } - - public String getType() { - return type; - } - - public String getCode() { - return code; - } - - public void setCode(String code) { - this.code = code; - } - - public String getMessage() { - return message; - } - - public void setMessage(String message) { - this.message = message; - } - - @Override - public int hashCode() { - int result = code != null ? code.hashCode() : 0; - result = 31 * result + (message != null ? message.hashCode() : 0); - return result; - } - - @Override - public boolean equals(Object o) { - if (this == o) return true; - if (o == null || getClass() != o.getClass()) return false; - - Error error = (Error) o; - - if (code != null ? !code.equals(error.code) : error.code != null) return false; - //noinspection RedundantIfStatement - if (message != null ? !message.equals(error.message) : error.message != null) return false; - - return true; - } - - @Override - public String toString() { - return getType() + "{" + - "code='" + code + '\'' + - ", message='" + message + '\'' + - "} " + super.toString(); - } - -} diff --git a/intercom-java/src/main/java/io/intercom/api/ErrorCollection.java b/intercom-java/src/main/java/io/intercom/api/ErrorCollection.java deleted file mode 100644 index d9720516..00000000 --- a/intercom-java/src/main/java/io/intercom/api/ErrorCollection.java +++ /dev/null @@ -1,33 +0,0 @@ -package io.intercom.api; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.google.common.base.Preconditions; - -import java.util.List; - -@SuppressWarnings("UnusedDeclaration") -@JsonIgnoreProperties(ignoreUnknown = true) -public final class ErrorCollection { - - @JsonProperty("errors") - private List errors; - - // for jackson - ErrorCollection() { - } - - public ErrorCollection(List errors) { - Preconditions.checkNotNull(errors, "cannot create an error collection with a null error list"); - Preconditions.checkArgument(errors.size() > 0, "cannot create an error collection with an empty error list"); - this.errors = errors; - } - - public List getErrors() { - return errors; - } - - public String getType() { - return "error.list"; - } -} diff --git a/intercom-java/src/main/java/io/intercom/api/Event.java b/intercom-java/src/main/java/io/intercom/api/Event.java deleted file mode 100644 index f42fe875..00000000 --- a/intercom-java/src/main/java/io/intercom/api/Event.java +++ /dev/null @@ -1,192 +0,0 @@ -package io.intercom.api; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.google.common.annotations.VisibleForTesting; -import com.google.common.base.Strings; -import com.google.common.collect.Lists; -import com.google.common.collect.Maps; - -import java.util.Map; - -@SuppressWarnings("UnusedDeclaration") -@JsonIgnoreProperties(ignoreUnknown = true) -@JsonInclude(JsonInclude.Include.NON_DEFAULT) -public class Event extends TypedData { - - public static void create(Event event) throws InvalidException, AuthorizationException { - - validateCreateEvent(event); - - if (event.getCreatedAt() == 0L) { - event.setCreatedAt(System.currentTimeMillis() / 1000); - } - DataResource.create(event, "events", Void.class); - } - - private static final ErrorCollection INVALID_NAME = new ErrorCollection( - Lists.newArrayList( - new Error("invalid", "an event must supply an event name"))); - - private static final ErrorCollection INVALID_USER = new ErrorCollection( - Lists.newArrayList( - new Error("invalid", "an event must supply either an email or a user id"))); - - @VisibleForTesting - static void validateCreateEvent(Event event) { - if (Strings.isNullOrEmpty(event.getEventName())) { - throw new InvalidException(INVALID_NAME); - } - - if (Strings.isNullOrEmpty(event.getUserID()) - && Strings.isNullOrEmpty(event.getEmail())) { - throw new InvalidException(INVALID_USER); - } - } - - @SuppressWarnings("FieldCanBeLocal") - @JsonProperty("type") - private final String type = "event"; - - @JsonProperty("event_name") - private String eventName; - - @JsonProperty("created_at") - private long createdAt; - - @JsonProperty("email") - private String email; - - @JsonProperty("user_id") - private String userID; - - @JsonProperty("metadata") - private Map metadata = Maps.newHashMap(); - - public Event() { - } - - public String getType() { - return type; - } - - public String getEventName() { - return eventName; - } - - public Event setEventName(String eventName) { - this.eventName = eventName; - return this; - } - - public long getCreatedAt() { - return createdAt; - } - - @SuppressWarnings("UnusedReturnValue") - public Event setCreatedAt(long createdAt) { - this.createdAt = createdAt; - return this; - } - - public String getEmail() { - return email; - } - - public Event setEmail(String email) { - this.email = email; - return this; - } - - public String getUserID() { - return userID; - } - - public Event setUserID(String userID) { - this.userID = userID; - return this; - } - - public Event putMetadata(String name, String value) { - metadata.put(name, value); - return this; - } - - public Event putMetadata(String name, boolean value) { - metadata.put(name, value); - return this; - } - - public Event putMetadata(String name, int value) { - metadata.put(name, value); - return this; - } - - public Event putMetadata(String name, double value) { - metadata.put(name, value); - return this; - } - - public Event putMetadata(String name, long value) { - metadata.put(name, value); - return this; - } - - public Event putMetadata(String name, float value) { - metadata.put(name, value); - return this; - } - - public Map getMetadata() { - return metadata; - } - - public Event setMetadata(Map metadata) { - this.metadata = metadata; - return this; - } - - @Override - public boolean equals(Object o) { - if (this == o) return true; - if (o == null || getClass() != o.getClass()) return false; - - Event event = (Event) o; - - if (createdAt != event.createdAt) return false; - if (email != null ? !email.equals(event.email) : event.email != null) return false; - if (eventName != null ? !eventName.equals(event.eventName) : event.eventName != null) return false; - if (metadata != null ? !metadata.equals(event.metadata) : event.metadata != null) return false; - if (!type.equals(event.type)) return false; - //noinspection RedundantIfStatement - if (userID != null ? !userID.equals(event.userID) : event.userID != null) return false; - - return true; - } - - @Override - public int hashCode() { - int result = type.hashCode(); - result = 31 * result + (eventName != null ? eventName.hashCode() : 0); - result = 31 * result + (int) (createdAt ^ (createdAt >>> 32)); - result = 31 * result + (email != null ? email.hashCode() : 0); - result = 31 * result + (userID != null ? userID.hashCode() : 0); - result = 31 * result + (metadata != null ? metadata.hashCode() : 0); - return result; - } - - @Override - public String toString() { - return "Event{" + - "type='" + type + '\'' + - ", eventName='" + eventName + '\'' + - ", createdAt=" + createdAt + - ", email='" + email + '\'' + - ", userID='" + userID + '\'' + - ", metadata=" + metadata + - "} " + super.toString(); - } -} - - diff --git a/intercom-java/src/main/java/io/intercom/api/HttpClient.java b/intercom-java/src/main/java/io/intercom/api/HttpClient.java deleted file mode 100644 index b45af129..00000000 --- a/intercom-java/src/main/java/io/intercom/api/HttpClient.java +++ /dev/null @@ -1,256 +0,0 @@ -package io.intercom.api; - -import com.fasterxml.jackson.databind.ObjectMapper; -import com.fasterxml.jackson.databind.SerializationFeature; -import com.google.common.collect.Lists; -import com.google.common.collect.Maps; -import com.google.common.io.CharStreams; -import org.apache.commons.codec.binary.Base64; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; - -import java.io.ByteArrayOutputStream; -import java.io.IOException; -import java.io.InputStream; -import java.io.InputStreamReader; -import java.io.OutputStream; -import java.net.HttpURLConnection; -import java.net.URI; -import java.util.ArrayList; -import java.util.HashMap; -import java.util.Map; -import java.util.concurrent.ThreadLocalRandom; - -class HttpClient { - - private static final Logger logger = LoggerFactory.getLogger("intercom-java"); - - private static final String CLIENT_AGENT_DETAILS = clientAgentDetails(); - - private static final String USER_AGENT = Intercom.USER_AGENT; - - private static final String UTF_8 = "UTF-8"; - - private static final String APPLICATION_JSON = "application/json"; - - private static String clientAgentDetails() { - final HashMap map = Maps.newHashMap(); - final ArrayList propKeys = Lists.newArrayList( - "os.arch", "os.name", "os.version", - "user.language", "user.timezone", - "java.class.version", "java.runtime.version", "java.version", - "java.vm.name", "java.vm.vendor", "java.vm.version"); - for (String propKey : propKeys) { - map.put(propKey, System.getProperty(propKey)); - } - final ByteArrayOutputStream baos = new ByteArrayOutputStream(); - try { - MapperSupport.objectMapper().disable(SerializationFeature.INDENT_OUTPUT).writeValue(baos, map); - } catch (IOException e) { - logger.warn(String.format("could not serialize client agent details [%s]", e.getMessage()), e); - } - return baos.toString(); - } - - private final ObjectMapper objectMapper; - - private final URI uri; - - private final Map headers; - - private final String apiKey = Intercom.getApiKey(); - - private final HttpConnectorSupplier connection = Intercom.getHttpConnectorSupplier(); - - public HttpClient(URI uri) { - this(uri, Maps.newHashMap()); - } - - private HttpClient(URI uri, Map headers) { - this.uri = uri; - this.headers = headers; - this.objectMapper = MapperSupport.objectMapper(); - } - - public T get(Class reqres) throws IntercomException { - HttpURLConnection conn = null; - try { - conn = initializeConnection(uri, "GET"); - return runRequest(uri, reqres, conn); - } catch (IOException e) { - return throwLocalException(e); - } finally { - IOUtils.disconnectQuietly(conn); - } - } - - public T post(Class reqres, E entity) { - headers.put("Content-Type", APPLICATION_JSON); - HttpURLConnection conn = null; - try { - conn = initializeConnection(uri, "POST"); - prepareRequestEntity(entity, conn); - return runRequest(uri, reqres, conn); - } catch (IOException e) { - return throwLocalException(e); - } finally { - IOUtils.disconnectQuietly(conn); - } - } - - public T delete(Class reqres) { - HttpURLConnection conn = null; - try { - conn = initializeConnection(uri, "DELETE"); - return runRequest(uri, reqres, conn); - } catch (IOException e) { - return throwLocalException(e); - } finally { - IOUtils.disconnectQuietly(conn); - } - } - - // trick java with a dummy return - private T throwLocalException(IOException e) { - throw new IntercomException(String.format("Local exception calling [%s]. Check connectivity and settings. [%s]", uri.toASCIIString(), e.getMessage()), e); - } - - private void prepareRequestEntity(Object entity, HttpURLConnection conn) throws IOException { - conn.setDoOutput(true); - OutputStream stream = null; - try { - stream = conn.getOutputStream(); - if (logger.isDebugEnabled()) { - logger.info(String.format("api server request --\n%s\n-- ", objectMapper.writeValueAsString(entity))); - } - objectMapper.writeValue(stream, entity); - } finally { - IOUtils.closeQuietly(stream); - } - } - - private HttpURLConnection initializeConnection(URI uri, String method) throws IOException { - HttpURLConnection conn = connection.connect(uri); - conn.setRequestMethod(method); - conn = prepareConnection(conn); - conn = applyHeaders(conn); - return conn; - } - - private T runRequest(URI uri, Class response, HttpURLConnection conn) throws IOException { - conn.connect(); - final int responseCode = conn.getResponseCode(); - if (responseCode >= 200 && responseCode < 300) { - return handleSuccess(response, conn, responseCode); - } else { - // errors are redirects for now - return handleError(uri, conn, responseCode); - } - } - - private T handleError(URI uri, HttpURLConnection conn, int responseCode) throws IOException { - ErrorCollection errors; - try { - errors = objectMapper.readValue(conn.getErrorStream(), ErrorCollection.class); - } catch (IOException e) { - errors = createUnprocessableErrorResponse(e); - } - if (logger.isDebugEnabled()) { - logger.debug("error json follows --\n{}\n-- ", objectMapper.writeValueAsString(errors)); - } - return throwException(responseCode, errors); - } - - private T handleSuccess(Class response, HttpURLConnection conn, int responseCode) throws IOException { - if (responseCode == 202 || responseCode == 204 || Void.class.equals(response)) { - return null; - } else { - return readEntity(conn, responseCode, response); - } - } - - private T readEntity(HttpURLConnection conn, int responseCode, Class entityType) throws IOException { - final InputStream entityStream = conn.getInputStream(); - try { - if (logger.isDebugEnabled()) { - final String text = CharStreams.toString(new InputStreamReader(entityStream)); - logger.debug("api server response status[{}] --\n{}\n-- ", responseCode, text); - return objectMapper.readValue(text, entityType); - } else { - return objectMapper.readValue(entityStream, entityType); - } - } finally { - IOUtils.closeQuietly(entityStream); - } - } - - private T throwException(int responseCode, ErrorCollection errors) { - // bind some well known response codes to exceptions - if (responseCode == 403 || responseCode == 401) { - throw new AuthorizationException(errors); - } else if (responseCode == 429) { - throw new RateLimitException(errors); - } else if (responseCode == 404) { - throw new NotFoundException(errors); - } else if (responseCode == 422) { - throw new InvalidException(errors); - } else if (responseCode == 400 || responseCode == 405 || responseCode == 406) { - throw new ClientException(errors); - } else if (responseCode == 500 || responseCode == 503) { - throw new ServerException(errors); - } else { - throw new IntercomException(errors); - } - } - - private HttpURLConnection applyHeaders(HttpURLConnection conn) { - for (Map.Entry entry : createHeaders().entrySet()) { - conn.setRequestProperty(entry.getKey(), entry.getValue()); - } - for (Map.Entry entry : createAuthorizationHeaders().entrySet()) { - conn.setRequestProperty(entry.getKey(), entry.getValue()); - } - return conn; - } - - // todo: expose this config - private HttpURLConnection prepareConnection(HttpURLConnection conn) { - conn.setConnectTimeout(Intercom.getConnectionTimeout()); - conn.setReadTimeout(Intercom.getRequestTimeout()); - conn.setUseCaches(Intercom.isRequestUsingCaches()); - return conn; - } - - private Map createAuthorizationHeaders() { - if (Intercom.getAuthScheme().equals(Intercom.AUTH_BEARER)) { - headers.put("Authorization", "Bearer " + apiKey); - } else if (Intercom.getAuthScheme().equals(Intercom.AUTH_BASIC)) { - final String authString = Intercom.getAppID() + ":" + Intercom.getApiKey(); - headers.put("Authorization", "Basic " + Base64.encodeBase64String(authString.getBytes())); - } - return headers; - } - - private Map createHeaders() { - headers.put("User-Agent", USER_AGENT); - headers.put("X-Client-Platform-Details", CLIENT_AGENT_DETAILS); - headers.put("Accept-Charset", UTF_8); - headers.put("Accept", APPLICATION_JSON); - return headers; - } - - private ErrorCollection createUnprocessableErrorResponse(IOException e) { - ErrorCollection errors; - final long grepCode = getGrepCode(); - final String msg = String.format("could not parse error response: [%s]", e.getLocalizedMessage()); - logger.error(String.format("[%016x] %s", grepCode, msg), e); - Error err = new Error("unprocessable_entity", String.format("%s logged with code [%016x]", msg, grepCode)); - errors = new ErrorCollection(Lists.newArrayList(err)); - return errors; - } - - private long getGrepCode() { - return ThreadLocalRandom.current().nextLong(); - } - -} diff --git a/intercom-java/src/main/java/io/intercom/api/HttpConnectorSupplier.java b/intercom-java/src/main/java/io/intercom/api/HttpConnectorSupplier.java deleted file mode 100644 index de02df36..00000000 --- a/intercom-java/src/main/java/io/intercom/api/HttpConnectorSupplier.java +++ /dev/null @@ -1,16 +0,0 @@ -package io.intercom.api; - -import java.io.IOException; -import java.net.HttpURLConnection; -import java.net.URI; - -public interface HttpConnectorSupplier { - - HttpURLConnection connect(URI uri) throws IOException; - - HttpConnectorSupplier defaultSupplier = new HttpConnectorSupplier() { - public HttpURLConnection connect(URI uri) throws IOException { - return (HttpURLConnection) uri.toURL().openConnection(); - } - }; -} diff --git a/intercom-java/src/main/java/io/intercom/api/IOUtils.java b/intercom-java/src/main/java/io/intercom/api/IOUtils.java deleted file mode 100644 index b6f5966d..00000000 --- a/intercom-java/src/main/java/io/intercom/api/IOUtils.java +++ /dev/null @@ -1,47 +0,0 @@ -package io.intercom.api; - -import org.slf4j.LoggerFactory; - -import java.io.Closeable; -import java.net.HttpURLConnection; - -class IOUtils { - - private static final org.slf4j.Logger logger = LoggerFactory.getLogger("intercom-java"); - - /** - * Close a HttpURLConnection, ignores checked Exceptions and nulls, - * but rethrows RuntimeExceptions. - * - * @param connection the connection to disconnect - */ - public static void disconnectQuietly(HttpURLConnection connection) { - if (connection != null) { - try { - connection.disconnect(); - } catch (RuntimeException rethrow) { - throw rethrow; - } catch (Exception e) { - logger.warn(e.getMessage()); - } - } - } - - /** - * Close a stream, ignores checked Exceptions and nulls, - * but rethrows RuntimeExceptions. - * - * @param stream the object to close - */ - public static void closeQuietly(Closeable stream) { - if (stream != null) { - try { - stream.close(); - } catch (RuntimeException rethrow) { - throw rethrow; - } catch (Exception e) { - logger.warn(e.getMessage()); - } - } - } -} diff --git a/intercom-java/src/main/java/io/intercom/api/Intercom.java b/intercom-java/src/main/java/io/intercom/api/Intercom.java deleted file mode 100644 index 737a1d39..00000000 --- a/intercom-java/src/main/java/io/intercom/api/Intercom.java +++ /dev/null @@ -1,95 +0,0 @@ -package io.intercom.api; - -import java.net.URI; - -public class Intercom { - - private static final URI API_BASE_URI = URI.create("https://api.intercom.io/"); - - private static volatile URI apiBaseURI = API_BASE_URI; - - static final String AUTH_BASIC = "Basic"; - - private static final String AUTH_SCHEME = AUTH_BASIC; - - static final String AUTH_BEARER = "Bearer"; - - private static final String VERSION = "1.0.3"; - - public static final String USER_AGENT = "intercom-java/" + Intercom.VERSION; - - private static volatile String apiKey; - - private static volatile String appID; - - private static volatile int connectionTimeout = 3 * 1000; - - private static volatile int requestTimeout = 60 * 1000; - - private static volatile boolean requestUsingCaches = false; - - private static volatile HttpConnectorSupplier httpConnectorSupplier = HttpConnectorSupplier.defaultSupplier; - - public static int getConnectionTimeout() { - return connectionTimeout; - } - - @SuppressWarnings("UnusedDeclaration") - public static void setConnectionTimeout(int connectionTimeout) { - Intercom.connectionTimeout = connectionTimeout; - } - - public static int getRequestTimeout() { - return requestTimeout; - } - - @SuppressWarnings("UnusedDeclaration") - public static void setRequestTimeout(int requestTimeout) { - Intercom.requestTimeout = requestTimeout; - } - - public static boolean isRequestUsingCaches() { - return requestUsingCaches; - } - - public static void setRequestUsingCaches(boolean requestUsingCaches) { - Intercom.requestUsingCaches = requestUsingCaches; - } - - public static HttpConnectorSupplier getHttpConnectorSupplier() { - return httpConnectorSupplier; - } - - public static void setHttpConnectorSupplier(HttpConnectorSupplier supplier) { - Intercom.httpConnectorSupplier = supplier; - } - - public static String getAppID() { - return appID; - } - - public static void setAppID(String appID) { - Intercom.appID = appID; - } - - public static String getApiKey() { - return Intercom.apiKey; - } - - public static void setApiKey(String apiKey) { - Intercom.apiKey = apiKey; - } - - public static URI getApiBaseURI() { - return Intercom.apiBaseURI; - } - - public static void setApiBaseURI(URI apiBaseURI) { - Intercom.apiBaseURI = apiBaseURI; - } - - static String getAuthScheme() { - return AUTH_SCHEME; - } - -} diff --git a/intercom-java/src/main/java/io/intercom/api/IntercomException.java b/intercom-java/src/main/java/io/intercom/api/IntercomException.java deleted file mode 100644 index b32441fc..00000000 --- a/intercom-java/src/main/java/io/intercom/api/IntercomException.java +++ /dev/null @@ -1,48 +0,0 @@ -package io.intercom.api; - -public class IntercomException extends RuntimeException { - - private static final long serialVersionUID = -2723350106062183796L; - - private ErrorCollection errorCollection; - - @SuppressWarnings("WeakerAccess") - public IntercomException(String message) { - super(message); - } - - public IntercomException(String message, Throwable cause) { - super(message, cause); - } - - public IntercomException(ErrorCollection errorCollection) { - this(getMessage(errorCollection)); - this.errorCollection = errorCollection; - } - - public static String getMessage(ErrorCollection errorCollection) { - String message = "Could not read error message from server"; - if(errorCollection!=null - && errorCollection.getErrors() != null - && errorCollection.getErrors().size() > 0 - && errorCollection.getErrors().get(0) != null - && errorCollection.getErrors().get(0).getMessage() != null){ - message = errorCollection.getErrors().get(0).getMessage(); - } - return message; - } - - @SuppressWarnings("WeakerAccess") - public IntercomException(ErrorCollection errorCollection, Throwable cause) { - this(getMessage(errorCollection), cause); - this.errorCollection = errorCollection; - } - - public ErrorCollection getErrorCollection() { - return errorCollection; - } - - public Error getFirstError() { - return errorCollection.getErrors().get(0); - } -} diff --git a/intercom-java/src/main/java/io/intercom/api/InvalidException.java b/intercom-java/src/main/java/io/intercom/api/InvalidException.java deleted file mode 100644 index 6a4381bd..00000000 --- a/intercom-java/src/main/java/io/intercom/api/InvalidException.java +++ /dev/null @@ -1,22 +0,0 @@ -package io.intercom.api; - -public class InvalidException extends IntercomException { - - private static final long serialVersionUID = -2111295679006526646L; - - public InvalidException(String message) { - super(message); - } - - public InvalidException(String message, Throwable cause) { - super(message, cause); - } - - public InvalidException(ErrorCollection errorCollection) { - super(errorCollection); - } - - public InvalidException(ErrorCollection errorCollection, Throwable cause) { - super(errorCollection, cause); - } -} diff --git a/intercom-java/src/main/java/io/intercom/api/LocationData.java b/intercom-java/src/main/java/io/intercom/api/LocationData.java deleted file mode 100644 index 48cb7806..00000000 --- a/intercom-java/src/main/java/io/intercom/api/LocationData.java +++ /dev/null @@ -1,136 +0,0 @@ -package io.intercom.api; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonProperty; - -@SuppressWarnings("UnusedDeclaration") -@JsonIgnoreProperties(ignoreUnknown = true) -public class LocationData extends TypedData { - - @JsonProperty("type") - private final String type = "location_data"; - - @JsonProperty("city_name") - private String city_Name; - - @JsonProperty("continent_code") - private String continentCode; - - @JsonProperty("country_code") - private String countryCode; - - @JsonProperty("country_name") - private String countryName; - - @JsonProperty("latitude") - private float latitude; - - @JsonProperty("longitude") - private float longitude; - - @JsonProperty("postal_code") - private String postalCode; - - @JsonProperty("region_name") - private String regionName; - - @JsonProperty("timezone") - private String timezone; - - public LocationData() { - } - - public String getType() { - return type; - } - - public String getCity_Name() { - return city_Name; - } - - public String getContinentCode() { - return continentCode; - } - - public String getCountryCode() { - return countryCode; - } - - public String getCountryName() { - return countryName; - } - - public float getLatitude() { - return latitude; - } - - public float getLongitude() { - return longitude; - } - - public String getPostalCode() { - return postalCode; - } - - public String getRegionName() { - return regionName; - } - - public String getTimezone() { - return timezone; - } - - @Override - public boolean equals(Object o) { - if (this == o) return true; - if (o == null || getClass() != o.getClass()) return false; - - LocationData that = (LocationData) o; - - if (Float.compare(that.latitude, latitude) != 0) return false; - if (Float.compare(that.longitude, longitude) != 0) return false; - if (city_Name != null ? !city_Name.equals(that.city_Name) : that.city_Name != null) return false; - if (continentCode != null ? !continentCode.equals(that.continentCode) : that.continentCode != null) - return false; - if (countryCode != null ? !countryCode.equals(that.countryCode) : that.countryCode != null) return false; - if (countryName != null ? !countryName.equals(that.countryName) : that.countryName != null) return false; - if (postalCode != null ? !postalCode.equals(that.postalCode) : that.postalCode != null) return false; - if (regionName != null ? !regionName.equals(that.regionName) : that.regionName != null) return false; - if (timezone != null ? !timezone.equals(that.timezone) : that.timezone != null) return false; - //noinspection RedundantIfStatement - if (!type.equals(that.type)) return false; - - return true; - } - - @Override - public int hashCode() { - int result = type.hashCode(); - result = 31 * result + (city_Name != null ? city_Name.hashCode() : 0); - result = 31 * result + (continentCode != null ? continentCode.hashCode() : 0); - result = 31 * result + (countryCode != null ? countryCode.hashCode() : 0); - result = 31 * result + (countryName != null ? countryName.hashCode() : 0); - result = 31 * result + (latitude != +0.0f ? Float.floatToIntBits(latitude) : 0); - result = 31 * result + (longitude != +0.0f ? Float.floatToIntBits(longitude) : 0); - result = 31 * result + (postalCode != null ? postalCode.hashCode() : 0); - result = 31 * result + (regionName != null ? regionName.hashCode() : 0); - result = 31 * result + (timezone != null ? timezone.hashCode() : 0); - return result; - } - - @Override - public String toString() { - return "LocationData{" + - "type='" + type + '\'' + - ", city_Name='" + city_Name + '\'' + - ", continentCode='" + continentCode + '\'' + - ", countryCode='" + countryCode + '\'' + - ", countryName='" + countryName + '\'' + - ", latitude=" + latitude + - ", longitude=" + longitude + - ", postalCode='" + postalCode + '\'' + - ", regionName='" + regionName + '\'' + - ", timezone='" + timezone + '\'' + - "} " + super.toString(); - } -} diff --git a/intercom-java/src/main/java/io/intercom/api/MapperSupport.java b/intercom-java/src/main/java/io/intercom/api/MapperSupport.java deleted file mode 100644 index b239698d..00000000 --- a/intercom-java/src/main/java/io/intercom/api/MapperSupport.java +++ /dev/null @@ -1,42 +0,0 @@ -package io.intercom.api; - -import com.fasterxml.jackson.core.Version; -import com.fasterxml.jackson.databind.DeserializationFeature; -import com.fasterxml.jackson.databind.ObjectMapper; -import com.fasterxml.jackson.databind.SerializationFeature; -import com.fasterxml.jackson.databind.module.SimpleModule; - -public class MapperSupport { - - public static ObjectMapper objectMapper() { - final ObjectMapper om = Holder.INSTANCE; - configure(om); - return om; - } - - private static void configure(ObjectMapper objectMapper) { - objectMapper.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, true); - objectMapper.configure(SerializationFeature.INDENT_OUTPUT, true); - objectMapper.configure(SerializationFeature.WRITE_DATE_TIMESTAMPS_AS_NANOSECONDS, false); - objectMapper.configure(DeserializationFeature.READ_DATE_TIMESTAMPS_AS_NANOSECONDS, false); - objectMapper.registerModule(customAttributeModule()); - } - - private static SimpleModule customAttributeModule() { - final SimpleModule customAttributeModule = new SimpleModule( - "IntercomClientModule", - new Version(1, 0, 0, null, "", "") - ); - customAttributeModule.addDeserializer(CustomAttribute.class, new CustomAttributeDeserializer()); - customAttributeModule.addSerializer(CustomAttribute.class, new CustomAttributeSerializer()); - customAttributeModule.addDeserializer(Subscription.Topic.class, new TopicDeserializer()); - customAttributeModule.addSerializer(Subscription.Topic.class, new TopicSerializer()); - customAttributeModule.addSerializer(Counts.CountItem.class, new CountItemSerializer()); - customAttributeModule.addDeserializer(Counts.CountItem.class, new CountItemDeserializer()); - return customAttributeModule; - } - - private static class Holder { - private static final ObjectMapper INSTANCE = new ObjectMapper(); - } -} diff --git a/intercom-java/src/main/java/io/intercom/api/NotFoundException.java b/intercom-java/src/main/java/io/intercom/api/NotFoundException.java deleted file mode 100644 index e0806ad9..00000000 --- a/intercom-java/src/main/java/io/intercom/api/NotFoundException.java +++ /dev/null @@ -1,22 +0,0 @@ -package io.intercom.api; - -public class NotFoundException extends IntercomException { - - private static final long serialVersionUID = 2917082281352001861L; - - public NotFoundException(String message) { - super(message); - } - - public NotFoundException(String message, Throwable cause) { - super(message, cause); - } - - public NotFoundException(ErrorCollection errorCollection) { - super(errorCollection); - } - - public NotFoundException(ErrorCollection errorCollection, Throwable cause) { - super(errorCollection, cause); - } -} diff --git a/intercom-java/src/main/java/io/intercom/api/Note.java b/intercom-java/src/main/java/io/intercom/api/Note.java deleted file mode 100644 index fa7b8b3e..00000000 --- a/intercom-java/src/main/java/io/intercom/api/Note.java +++ /dev/null @@ -1,133 +0,0 @@ -package io.intercom.api; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.google.common.collect.Maps; - -import java.util.HashMap; -import java.util.Map; - -@SuppressWarnings("UnusedDeclaration") -@JsonIgnoreProperties(ignoreUnknown = true) -@JsonInclude(JsonInclude.Include.NON_EMPTY) -public class Note extends TypedData { - - private static final HashMap SENTINEL = Maps.newHashMap(); - - public static Note find(String id) throws InvalidException, AuthorizationException { - return DataResource.find(id, "notes", Note.class); - } - - public static Note create(Note note) throws InvalidException, AuthorizationException { - return DataResource.create(note, "notes", Note.class); - } - - public static NoteCollection list(Map params) throws InvalidException, AuthorizationException { - if ((!params.containsKey("email")) && (!params.containsKey("id")) && (!params.containsKey("user_id")) && (!params.containsKey("intercom_user_id"))) { - throw new InvalidException("a notes query must include an email, user_id or intercom_user_id parameter"); - } - return DataResource.list(params, "notes", NoteCollection.class); - } - - @JsonProperty("type") - private final String type = "note"; - - @JsonProperty("id") - private String id; - - @JsonProperty("body") - private String body; - - @JsonProperty("created_at") - private long createdAt; - - @JsonProperty("user") - private User user; - - @JsonProperty("author") - private Author author; - - public Note() { - } - - public String getType() { - return type; - } - - public String getId() { - return id; - } - - public String getBody() { - return body; - } - - public Note setBody(String body) { - this.body = body; - return this; - } - - public long getCreatedAt() { - return createdAt; - } - - public User getUser() { - return user; - } - - public Note setUser(User user) { - this.user = user; - return this; - } - - public Author getAuthor() { - return author; - } - - public Note setAuthor(Author author) { - this.author = author; - return this; - } - - @Override - public boolean equals(Object o) { - if (this == o) return true; - if (o == null || getClass() != o.getClass()) return false; - - Note note = (Note) o; - - if (createdAt != note.createdAt) return false; - if (author != null ? !author.equals(note.author) : note.author != null) return false; - if (body != null ? !body.equals(note.body) : note.body != null) return false; - if (id != null ? !id.equals(note.id) : note.id != null) return false; - if (!type.equals(note.type)) return false; - //noinspection RedundantIfStatement - if (user != null ? !user.equals(note.user) : note.user != null) return false; - - return true; - } - - @Override - public int hashCode() { - int result = type.hashCode(); - result = 31 * result + (id != null ? id.hashCode() : 0); - result = 31 * result + (body != null ? body.hashCode() : 0); - result = 31 * result + (int) (createdAt ^ (createdAt >>> 32)); - result = 31 * result + (user != null ? user.hashCode() : 0); - result = 31 * result + (author != null ? author.hashCode() : 0); - return result; - } - - @Override - public String toString() { - return "Note{" + - "id='" + id + '\'' + - ", body='" + body + '\'' + - ", createdAt=" + createdAt + - ", user=" + user + - ", author=" + author + - "} " + super.toString(); - } - -} diff --git a/intercom-java/src/main/java/io/intercom/api/NoteCollection.java b/intercom-java/src/main/java/io/intercom/api/NoteCollection.java deleted file mode 100644 index 8a389088..00000000 --- a/intercom-java/src/main/java/io/intercom/api/NoteCollection.java +++ /dev/null @@ -1,43 +0,0 @@ -package io.intercom.api; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonProperty; - -import java.util.Iterator; -import java.util.List; - -@SuppressWarnings("UnusedDeclaration") -@JsonIgnoreProperties(ignoreUnknown = true) -public class NoteCollection extends TypedDataCollection implements Iterator { - - protected TypedDataCollectionIterator iterator; - - public NoteCollection() { - iterator = new TypedDataCollectionIterator(this); - } - - @Override - public NoteCollection nextPage() { - return fetchNextPage(NoteCollection.class); - } - - @SuppressWarnings("EmptyMethod") - @JsonProperty("notes") - @Override - public List getPage() { - return super.getPage(); - } - - public boolean hasNext() { - return iterator.hasNext(); - } - - public Note next() { - return iterator.next(); - } - - public void remove() { - iterator.remove(); - } - -} diff --git a/intercom-java/src/main/java/io/intercom/api/Notification.java b/intercom-java/src/main/java/io/intercom/api/Notification.java deleted file mode 100644 index 04f9d424..00000000 --- a/intercom-java/src/main/java/io/intercom/api/Notification.java +++ /dev/null @@ -1,217 +0,0 @@ -package io.intercom.api; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.google.common.collect.Maps; - -import java.io.IOException; -import java.io.InputStream; -import java.net.URI; -import java.util.Map; - -@SuppressWarnings("UnusedDeclaration") -@JsonIgnoreProperties({"intercom"}) -public class Notification extends TypedData { - - public static Notification readJSON(String json) throws InvalidException { - try { - return MapperSupport.objectMapper().readValue(json, Notification.class); - } catch (IOException e) { - throw new InvalidException("could not parse json string [" + e.getMessage() + "]", e); - } - } - - public static Notification readJSON(InputStream json) throws InvalidException { - try { - return MapperSupport.objectMapper().readValue(json, Notification.class); - } catch (IOException e) { - throw new InvalidException("could not parse json stream [" + e.getMessage() + "]", e); - } - } - - @JsonProperty("type") - private final String type = "notification_event"; - - @JsonProperty("id") - private String id; - - @JsonProperty("topic") - private String topic; - - @JsonProperty("app_id") - private String appID; - - @JsonProperty("data") - private NotificationData data; - - @JsonProperty("delivery_status") - private String deliveryStatus; - - @JsonProperty("delivery_attempts") - private int deliveryAttempts; - - @JsonProperty("delivered_at") - private long deliveredAt; - - @JsonProperty("first_sent_at") - private long firstSentAt; - - @JsonProperty("created_at") - private long createdAt; - - @JsonProperty - private Map links = Maps.newHashMap(); - - @JsonProperty("self") - private URI self; - - public Notification() { - } - - public String getType() { - return type; - } - - public String getId() { - return id; - } - - public void setId(String id) { - this.id = id; - } - - public String getTopic() { - return topic; - } - - public void setTopic(String topic) { - this.topic = topic; - } - - public String getAppID() { - return appID; - } - - public void setAppID(String appID) { - this.appID = appID; - } - - public NotificationData getData() { - return data; - } - - public void setData(NotificationData data) { - this.data = data; - } - - public String getDeliveryStatus() { - return deliveryStatus; - } - - public void setDeliveryStatus(String deliveryStatus) { - this.deliveryStatus = deliveryStatus; - } - - public int getDeliveryAttempts() { - return deliveryAttempts; - } - - public void setDeliveryAttempts(int deliveryAttempts) { - this.deliveryAttempts = deliveryAttempts; - } - - public long getDeliveredAt() { - return deliveredAt; - } - - public void setDeliveredAt(long deliveredAt) { - this.deliveredAt = deliveredAt; - } - - public long getFirstSentAt() { - return firstSentAt; - } - - public void setFirstSentAt(long firstSentAt) { - this.firstSentAt = firstSentAt; - } - - - public long getCreatedAt() { - return createdAt; - } - - public Map getLinks() { - return links; - } - - public void setLinks(Map links) { - this.links = links; - } - - public URI getSelf() { - return self; - } - - public void setSelf(URI self) { - this.self = self; - } - - @Override - public int hashCode() { - int result = id != null ? id.hashCode() : 0; - result = 31 * result + (topic != null ? topic.hashCode() : 0); - result = 31 * result + (appID != null ? appID.hashCode() : 0); - result = 31 * result + (data != null ? data.hashCode() : 0); - result = 31 * result + (deliveryStatus != null ? deliveryStatus.hashCode() : 0); - result = 31 * result + deliveryAttempts; - result = 31 * result + (int) (deliveredAt ^ (deliveredAt >>> 32)); - result = 31 * result + (int) (firstSentAt ^ (firstSentAt >>> 32)); - result = 31 * result + (int) (createdAt ^ (createdAt >>> 32)); - result = 31 * result + (links != null ? links.hashCode() : 0); - result = 31 * result + (self != null ? self.hashCode() : 0); - return result; - } - - @Override - public boolean equals(Object o) { - if (this == o) return true; - if (o == null || getClass() != o.getClass()) return false; - - Notification that = (Notification) o; - - if (createdAt != that.createdAt) return false; - if (deliveredAt != that.deliveredAt) return false; - if (deliveryAttempts != that.deliveryAttempts) return false; - if (firstSentAt != that.firstSentAt) return false; - if (appID != null ? !appID.equals(that.appID) : that.appID != null) return false; - if (data != null ? !data.equals(that.data) : that.data != null) return false; - if (deliveryStatus != null ? !deliveryStatus.equals(that.deliveryStatus) : that.deliveryStatus != null) - return false; - if (id != null ? !id.equals(that.id) : that.id != null) return false; - if (links != null ? !links.equals(that.links) : that.links != null) return false; - if (self != null ? !self.equals(that.self) : that.self != null) return false; - //noinspection RedundantIfStatement - if (topic != null ? !topic.equals(that.topic) : that.topic != null) return false; - - return true; - } - - @Override - public String toString() { - return "Notification{" + - "type='" + type + '\'' + - ", id='" + id + '\'' + - ", topic='" + topic + '\'' + - ", appID='" + appID + '\'' + - ", data=" + data + - ", deliveryStatus='" + deliveryStatus + '\'' + - ", deliveryAttempts=" + deliveryAttempts + - ", deliveredAt=" + deliveredAt + - ", firstSentAt=" + firstSentAt + - ", createdAt=" + createdAt + - ", links=" + links + - ", self=" + self + - "} " + super.toString(); - } -} diff --git a/intercom-java/src/main/java/io/intercom/api/NotificationCollection.java b/intercom-java/src/main/java/io/intercom/api/NotificationCollection.java deleted file mode 100644 index ff27f3c8..00000000 --- a/intercom-java/src/main/java/io/intercom/api/NotificationCollection.java +++ /dev/null @@ -1,44 +0,0 @@ -package io.intercom.api; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonProperty; - -import java.util.Iterator; -import java.util.List; - -@SuppressWarnings("UnusedDeclaration") -@JsonIgnoreProperties(ignoreUnknown = true) -public class NotificationCollection extends TypedDataCollection implements Iterator { - - protected TypedDataCollectionIterator iterator; - - public NotificationCollection() { - type = "notification.list"; - iterator = new TypedDataCollectionIterator(this); - } - - @Override - public NotificationCollection nextPage() { - return fetchNextPage(NotificationCollection.class); - } - - @SuppressWarnings("EmptyMethod") - @JsonProperty("notifications") - @Override - public List getPage() { - return super.getPage(); - } - - public boolean hasNext() { - return iterator.hasNext(); - } - - public Notification next() { - return iterator.next(); - } - - public void remove() { - iterator.remove(); - } - -} diff --git a/intercom-java/src/main/java/io/intercom/api/NotificationData.java b/intercom-java/src/main/java/io/intercom/api/NotificationData.java deleted file mode 100644 index 0aa6d230..00000000 --- a/intercom-java/src/main/java/io/intercom/api/NotificationData.java +++ /dev/null @@ -1,63 +0,0 @@ -package io.intercom.api; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonProperty; - -import java.util.Map; - -@SuppressWarnings("UnusedDeclaration") -@JsonIgnoreProperties(ignoreUnknown = true) -public class NotificationData extends TypedData { - - @JsonProperty("type") - protected String type; - - @JsonProperty - private Map item; - - public NotificationData() { - type = "notification_event_data"; - } - - public String getType() { - return type; - } - - public void setType(String type) { - this.type = type; - } - - public Map getItem() { - return item; - } - - public void setItem(Map item) { - this.item = item; - } - - @Override - public int hashCode() { - return item != null ? item.hashCode() : 0; - } - - @Override - public boolean equals(Object o) { - if (this == o) return true; - if (o == null || getClass() != o.getClass()) return false; - - NotificationData that = (NotificationData) o; - - //noinspection RedundantIfStatement - if (item != null ? !item.equals(that.item) : that.item != null) return false; - - return true; - } - - @Override - public String toString() { - return "NotificationData{" + - "type='" + type + '\'' + - ", item=" + item + - "} " + super.toString(); - } -} diff --git a/intercom-java/src/main/java/io/intercom/api/NotificationError.java b/intercom-java/src/main/java/io/intercom/api/NotificationError.java deleted file mode 100644 index d72fc2f9..00000000 --- a/intercom-java/src/main/java/io/intercom/api/NotificationError.java +++ /dev/null @@ -1,29 +0,0 @@ -package io.intercom.api; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; - -@SuppressWarnings("UnusedDeclaration") -@JsonIgnoreProperties(ignoreUnknown = true) -@JsonInclude(JsonInclude.Include.NON_DEFAULT) -public class NotificationError extends Notification { - - @JsonProperty("http_request") - private RequestResponseCapture capture; - - public RequestResponseCapture getCapture() { - return capture; - } - - public void setCapture(RequestResponseCapture capture) { - this.capture = capture; - } - - @Override - public String toString() { - return "NotificationError{" + - "capture=" + capture + - "} " + super.toString(); - } -} diff --git a/intercom-java/src/main/java/io/intercom/api/NotificationErrorCollection.java b/intercom-java/src/main/java/io/intercom/api/NotificationErrorCollection.java deleted file mode 100644 index 8121449a..00000000 --- a/intercom-java/src/main/java/io/intercom/api/NotificationErrorCollection.java +++ /dev/null @@ -1,43 +0,0 @@ -package io.intercom.api; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonProperty; - -import java.util.Iterator; -import java.util.List; - -@SuppressWarnings("UnusedDeclaration") -@JsonIgnoreProperties(ignoreUnknown = true) -public class NotificationErrorCollection extends TypedDataCollection implements Iterator { - - protected TypedDataCollectionIterator iterator; - - public NotificationErrorCollection() { - type = "notification.list"; - iterator = new TypedDataCollectionIterator(this); - } - - @SuppressWarnings("EmptyMethod") - @JsonProperty("notifications") - @Override - public List getPage() { - return super.getPage(); - } - - @Override - public NotificationErrorCollection nextPage() { - return fetchNextPage(NotificationErrorCollection.class); - } - - public boolean hasNext() { - return iterator.hasNext(); - } - - public NotificationError next() { - return iterator.next(); - } - - public void remove() { - iterator.remove(); - } -} diff --git a/intercom-java/src/main/java/io/intercom/api/RateLimitException.java b/intercom-java/src/main/java/io/intercom/api/RateLimitException.java deleted file mode 100644 index b4334238..00000000 --- a/intercom-java/src/main/java/io/intercom/api/RateLimitException.java +++ /dev/null @@ -1,22 +0,0 @@ -package io.intercom.api; - -public class RateLimitException extends IntercomException { - - private static final long serialVersionUID = -6100754169056165622L; - - public RateLimitException(String message) { - super(message); - } - - public RateLimitException(String message, Throwable cause) { - super(message, cause); - } - - public RateLimitException(ErrorCollection errorCollection) { - super(errorCollection); - } - - public RateLimitException(ErrorCollection errorCollection, Throwable cause) { - super(errorCollection, cause); - } -} diff --git a/intercom-java/src/main/java/io/intercom/api/Replier.java b/intercom-java/src/main/java/io/intercom/api/Replier.java deleted file mode 100644 index 042d322b..00000000 --- a/intercom-java/src/main/java/io/intercom/api/Replier.java +++ /dev/null @@ -1,7 +0,0 @@ -package io.intercom.api; - -interface Replier { - - String getReplyType(); - -} diff --git a/intercom-java/src/main/java/io/intercom/api/Reply.java b/intercom-java/src/main/java/io/intercom/api/Reply.java deleted file mode 100644 index 98b83be7..00000000 --- a/intercom-java/src/main/java/io/intercom/api/Reply.java +++ /dev/null @@ -1,78 +0,0 @@ -package io.intercom.api; - -import com.fasterxml.jackson.annotation.JsonProperty; - -class Reply extends TypedData { - - @JsonProperty("message_type") - private final String messageType = "comment"; - - @JsonProperty("body") - private String body; - - @JsonProperty("from") - T from; - - Reply() { - } - - @JsonProperty("type") - String getType() { - return from.getReplyType(); - } - - String getBody() { - return body; - } - - public Reply setBody(String body) { - this.body = body; - return this; - } - - T getFrom() { - return from; - } - - @SuppressWarnings("UnusedDeclaration") - public Reply setFrom(T from) { - this.from = from; - return this; - } - - String getMessageType() { - return messageType; - } - - @Override - public boolean equals(Object o) { - if (this == o) return true; - if (o == null || getClass() != o.getClass()) return false; - - Reply reply = (Reply) o; - - if (body != null ? !body.equals(reply.body) : reply.body != null) return false; - if (from != null ? !from.equals(reply.from) : reply.from != null) return false; - //noinspection RedundantIfStatement - if (!messageType.equals(reply.messageType)) return false; - - return true; - } - - @Override - public int hashCode() { - int result = messageType.hashCode(); - result = 31 * result + (body != null ? body.hashCode() : 0); - result = 31 * result + (from != null ? from.hashCode() : 0); - return result; - } - - @Override - public String toString() { - return "Reply{" + - "messageType='" + messageType + '\'' + - ", body='" + body + '\'' + - ", from=" + from + - "} " + super.toString(); - } -} diff --git a/intercom-java/src/main/java/io/intercom/api/RequestResponseCapture.java b/intercom-java/src/main/java/io/intercom/api/RequestResponseCapture.java deleted file mode 100644 index 08e7f2dc..00000000 --- a/intercom-java/src/main/java/io/intercom/api/RequestResponseCapture.java +++ /dev/null @@ -1,68 +0,0 @@ -package io.intercom.api; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.google.common.collect.ImmutableMap; - -import java.net.URI; -import java.util.Map; - -@SuppressWarnings("UnusedDeclaration") -@JsonIgnoreProperties(ignoreUnknown = true) -@JsonInclude(JsonInclude.Include.NON_EMPTY) -public class RequestResponseCapture { - - @JsonProperty("request_method") - private String requestMethod; - - @JsonProperty("request_uri") - private URI requestURI; - - @JsonProperty("request_headers") - private Map requestHeaders; - - @JsonProperty("response_status_code") - private int responseStatusCode; - - @JsonProperty("response_headers") - private Map responseHeaders; - - @JsonProperty("response_entity") - private String responseEntity; - - @JsonProperty("request_entity") - private String requestEntity; - - public RequestResponseCapture() { - } - - public String getRequestMethod() { - return requestMethod; - } - - public URI getRequestURI() { - return requestURI; - } - - public Map getRequestHeaders() { - return ImmutableMap.builder().putAll(requestHeaders).build(); - } - - public int getResponseStatusCode() { - return responseStatusCode; - } - - public Map getResponseHeaders() { - return ImmutableMap.builder().putAll(responseHeaders).build(); - } - - public String getResponseEntity() { - return responseEntity; - } - - public String getRequestEntity() { - return requestEntity; - } - -} \ No newline at end of file diff --git a/intercom-java/src/main/java/io/intercom/api/Segment.java b/intercom-java/src/main/java/io/intercom/api/Segment.java deleted file mode 100644 index 0b12c019..00000000 --- a/intercom-java/src/main/java/io/intercom/api/Segment.java +++ /dev/null @@ -1,113 +0,0 @@ -package io.intercom.api; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.google.common.collect.Maps; - -import java.util.HashMap; - -@JsonIgnoreProperties(ignoreUnknown = true) -@JsonInclude(JsonInclude.Include.NON_EMPTY) -public class Segment extends TypedData { - - private static final HashMap SENTINEL = Maps.newHashMap(); - - public static Segment find(String id) throws InvalidException, AuthorizationException { - final HttpClient resource = new HttpClient(UriBuilder.newBuilder().path("segments").path(id).build()); - return resource.get(Segment.class); - } - - public static SegmentCollection list() throws InvalidException, AuthorizationException { - return DataResource.list(SENTINEL, "segments", SegmentCollection.class); - } - - public static Segment update(Segment segment) throws InvalidException, AuthorizationException { - if (segment.getId() == null) { - throw new InvalidException("segment updates must supply an id"); - } - return DataResource.update(segment, "segments", Segment.class); - } - - @JsonProperty("type") - private final String type = "segment"; - - @JsonProperty("id") - private String id; - - @JsonProperty("name") - private String name; - - @JsonProperty("created_at") - private long createdAt; - - @JsonProperty("updated_at") - private long updatedAt; - - @SuppressWarnings("WeakerAccess") - public Segment() { - } - - public String getType() { - return type; - } - - public String getId() { - return id; - } - - public String getName() { - return name; - } - - public Segment setName(String name) { - this.name = name; - return this; - } - - public long getCreatedAt() { - return createdAt; - } - - public long getUpdatedAt() { - return updatedAt; - } - - @Override - public boolean equals(Object o) { - if (this == o) return true; - if (o == null || getClass() != o.getClass()) return false; - - Segment segment = (Segment) o; - - if (createdAt != segment.createdAt) return false; - if (updatedAt != segment.updatedAt) return false; - if (id != null ? !id.equals(segment.id) : segment.id != null) return false; - if (name != null ? !name.equals(segment.name) : segment.name != null) return false; - //noinspection RedundantIfStatement - if (!type.equals(segment.type)) return false; - - return true; - } - - @Override - public int hashCode() { - int result = type.hashCode(); - result = 31 * result + (id != null ? id.hashCode() : 0); - result = 31 * result + (name != null ? name.hashCode() : 0); - result = 31 * result + (int) (createdAt ^ (createdAt >>> 32)); - result = 31 * result + (int) (updatedAt ^ (updatedAt >>> 32)); - return result; - } - - @Override - public String toString() { - return "Segment{" + - "id='" + id + '\'' + - ", name='" + name + '\'' + - ", createdAt=" + createdAt + - ", updatedAt=" + updatedAt + - "} " + super.toString(); - } - -} diff --git a/intercom-java/src/main/java/io/intercom/api/SegmentCollection.java b/intercom-java/src/main/java/io/intercom/api/SegmentCollection.java deleted file mode 100644 index 309697f0..00000000 --- a/intercom-java/src/main/java/io/intercom/api/SegmentCollection.java +++ /dev/null @@ -1,51 +0,0 @@ -package io.intercom.api; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; - -import java.util.Iterator; -import java.util.List; - -@SuppressWarnings("UnusedDeclaration") -@JsonIgnoreProperties(ignoreUnknown = true) -@JsonInclude(JsonInclude.Include.NON_EMPTY) -public class SegmentCollection extends TypedDataCollection implements Iterator { - - protected TypedDataCollectionIterator iterator; - - public SegmentCollection() { - type = "segment.list"; - iterator = new TypedDataCollectionIterator(this); - } - - @Override - public SegmentCollection nextPage() { - return fetchNextPage(SegmentCollection.class); - } - - @SuppressWarnings("EmptyMethod") - @JsonProperty("segments") - @Override - public List getPage() { - return super.getPage(); - } - - public boolean hasNext() { - return iterator.hasNext(); - } - - public Segment next() { - return iterator.next(); - } - - public void remove() { - iterator.remove(); - } - - @Override - public String toString() { - return "SegmentCollection{" + - "} " + super.toString(); - } -} diff --git a/intercom-java/src/main/java/io/intercom/api/ServerException.java b/intercom-java/src/main/java/io/intercom/api/ServerException.java deleted file mode 100644 index 66475320..00000000 --- a/intercom-java/src/main/java/io/intercom/api/ServerException.java +++ /dev/null @@ -1,22 +0,0 @@ -package io.intercom.api; - -public class ServerException extends IntercomException { - - private static final long serialVersionUID = 7823280575981918941L; - - public ServerException(String message) { - super(message); - } - - public ServerException(String message, Throwable cause) { - super(message, cause); - } - - public ServerException(ErrorCollection errorCollection) { - super(errorCollection); - } - - public ServerException(ErrorCollection errorCollection, Throwable cause) { - super(errorCollection, cause); - } -} diff --git a/intercom-java/src/main/java/io/intercom/api/SocialProfile.java b/intercom-java/src/main/java/io/intercom/api/SocialProfile.java deleted file mode 100644 index 38e89cf6..00000000 --- a/intercom-java/src/main/java/io/intercom/api/SocialProfile.java +++ /dev/null @@ -1,89 +0,0 @@ -package io.intercom.api; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.databind.annotation.JsonDeserialize; - -import java.net.URI; - -@SuppressWarnings("UnusedDeclaration") -@JsonIgnoreProperties(ignoreUnknown = true) -@JsonInclude(JsonInclude.Include.NON_EMPTY) -public class SocialProfile extends TypedData { - - @JsonProperty("type") - private final String type = "social_profile"; - - @JsonProperty("id") - private String id; - - @JsonProperty("name") - private String name; - - @JsonProperty("username") - private String username; - - @JsonProperty("url") - @JsonDeserialize(using = URIDeserializer.class) - private URI url; - - public SocialProfile() { - } - - public String getType() { - return type; - } - - public String getId() { - return id; - } - - public String getName() { - return name; - } - - public String getUsername() { - return username; - } - - public URI getUrl() { - return url; - } - - @Override - public int hashCode() { - int result = id != null ? id.hashCode() : 0; - result = 31 * result + (name != null ? name.hashCode() : 0); - result = 31 * result + (username != null ? username.hashCode() : 0); - result = 31 * result + (url != null ? url.hashCode() : 0); - return result; - } - - @Override - public boolean equals(Object o) { - if (this == o) return true; - if (o == null || getClass() != o.getClass()) return false; - - SocialProfile that = (SocialProfile) o; - - if (id != null ? !id.equals(that.id) : that.id != null) return false; - if (name != null ? !name.equals(that.name) : that.name != null) return false; - if (url != null ? !url.equals(that.url) : that.url != null) return false; - //noinspection RedundantIfStatement - if (username != null ? !username.equals(that.username) : that.username != null) return false; - - return true; - } - - @Override - public String toString() { - return "SocialProfile{" + - "type='" + type + '\'' + - ", id='" + id + '\'' + - ", name='" + name + '\'' + - ", username='" + username + '\'' + - ", url=" + url + - "} " + super.toString(); - } -} diff --git a/intercom-java/src/main/java/io/intercom/api/SocialProfileCollection.java b/intercom-java/src/main/java/io/intercom/api/SocialProfileCollection.java deleted file mode 100644 index f35cb020..00000000 --- a/intercom-java/src/main/java/io/intercom/api/SocialProfileCollection.java +++ /dev/null @@ -1,62 +0,0 @@ -package io.intercom.api; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.google.common.collect.ImmutableList; -import com.google.common.collect.Lists; - -import java.util.List; - -@SuppressWarnings("UnusedDeclaration") -@JsonIgnoreProperties(ignoreUnknown = true) -@JsonInclude(JsonInclude.Include.NON_EMPTY) -public class SocialProfileCollection extends TypedData { - - @JsonProperty("type") - private String type = "social_profile.list"; - - @JsonProperty("social_profiles") - private List socialProfiles = Lists.newArrayList(); - - SocialProfileCollection() { - } - - public String getType() { - return type; - } - - public List getSocialProfiles() { - return socialProfiles == null ? null : ImmutableList.builder().addAll(socialProfiles).build(); - } - - @Override - public boolean equals(Object o) { - if (this == o) return true; - if (o == null || getClass() != o.getClass()) return false; - - SocialProfileCollection that = (SocialProfileCollection) o; - - if (socialProfiles != null ? !socialProfiles.equals(that.socialProfiles) : that.socialProfiles != null) - return false; - //noinspection RedundantIfStatement - if (type != null ? !type.equals(that.type) : that.type != null) return false; - - return true; - } - - @Override - public int hashCode() { - int result = type != null ? type.hashCode() : 0; - result = 31 * result + (socialProfiles != null ? socialProfiles.hashCode() : 0); - return result; - } - - @Override - public String toString() { - return "SocialProfileCollection{" + - "type='" + type + '\'' + - ", socialProfiles=" + socialProfiles + - "} " + super.toString(); - } -} diff --git a/intercom-java/src/main/java/io/intercom/api/Subscription.java b/intercom-java/src/main/java/io/intercom/api/Subscription.java deleted file mode 100644 index 6ad4471d..00000000 --- a/intercom-java/src/main/java/io/intercom/api/Subscription.java +++ /dev/null @@ -1,419 +0,0 @@ -package io.intercom.api; - -import com.fasterxml.jackson.annotation.JsonIgnore; -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.google.common.base.Preconditions; -import com.google.common.collect.Lists; -import com.google.common.collect.Maps; - -import java.net.URI; -import java.util.HashMap; -import java.util.List; -import java.util.Map; - -@SuppressWarnings("UnusedDeclaration") -@JsonIgnoreProperties(ignoreUnknown = true) -@JsonInclude(JsonInclude.Include.NON_EMPTY) -public class Subscription extends TypedData { - - private static final HashMap SENTINEL = Maps.newHashMap(); - - public static Subscription create(Subscription subscription) throws InvalidException, AuthorizationException { - return DataResource.create(subscription, "subscriptions", Subscription.class); - } - - public static Subscription update(Subscription subscription) throws InvalidException, AuthorizationException { - return DataResource.update(subscription, "subscriptions", subscription.getId(), Subscription.class); - } - - public static Subscription delete(Subscription subscription) throws InvalidException, AuthorizationException { - return DataResource.delete(subscription.getId(), "subscriptions", Subscription.class); - } - - public static Subscription find(String id) throws InvalidException, AuthorizationException { - final HttpClient resource = new HttpClient(UriBuilder.newBuilder().path("subscriptions").path(id).build()); - return resource.get(Subscription.class); - } - - public static SubscriptionCollection list() throws InvalidException, AuthorizationException { - return DataResource.list(SENTINEL, "subscriptions", SubscriptionCollection.class); - } - - public static NotificationCollection sentFeed(String id) throws InvalidException, AuthorizationException { - final URI feedURI = UriBuilder.newBuilder() - .path("subscriptions") - .path(id) - .path("sent") - .build(); - final HttpClient resource = new HttpClient(feedURI); - return resource.get(NotificationCollection.class); - } - - public static NotificationErrorCollection errorFeed(String id) throws InvalidException, AuthorizationException { - final URI feedURI = UriBuilder.newBuilder() - .path("subscriptions") - .path(id) - .path("error") - .build(); - final HttpClient resource = new HttpClient(feedURI); - return resource.get(NotificationErrorCollection.class); - } - - @SuppressWarnings("UnusedDeclaration") - public static class Topic { - private static final String SUBTYPE_WILDCARD = "*"; - - private static final String TEXT = "text"; - - private final static String COMPANY_NAME = "company"; - - private final static String CONVERSATION_NAME = "conversation"; - - private static final String USER_NAME = "user"; - - public static final Topic PING = new Topic("ping", SUBTYPE_WILDCARD); - - public static final Topic COMPANY = new Topic(COMPANY_NAME, SUBTYPE_WILDCARD); - - public static final Topic COMPANY_CREATED = new Topic(COMPANY_NAME, "created"); - - public static final Topic CONVERSATION = new Topic(CONVERSATION_NAME, SUBTYPE_WILDCARD); - - public static final Topic CONVERSATION_USER_CREATED = new Topic(CONVERSATION_NAME, "user.created"); - - public static final Topic CONVERSATION_USER_REPLY = new Topic(CONVERSATION_NAME, "user.replied"); - - public static final Topic CONVERSATION_ADMIN_REPLY = new Topic(CONVERSATION_NAME, "admin.replied"); - - public static final Topic CONVERSATION_ADMIN_ASSIGNED = new Topic(CONVERSATION_NAME, "admin.assigned"); - - public static final Topic CONVERSATION_ADMIN_CLOSED = new Topic(CONVERSATION_NAME, "admin.closed"); - - public static final Topic CONVERSATION_ADMIN_OPEN = new Topic(CONVERSATION_NAME, "admin.open"); - - public static final Topic CONVERSATION_ADMIN_NOTED = new Topic(CONVERSATION_NAME, "admin.noted"); - - public static final Topic USER = new Topic(USER_NAME, SUBTYPE_WILDCARD); - - public static final Topic USER_CREATED = new Topic(USER_NAME, "created"); - - public static final Topic USER_UNSUBSCRIBED = new Topic(USER_NAME, "unsubscribed"); - - public static final Topic USER_TAG_CREATED = new Topic(USER_NAME, "tag.created"); - - public static final Topic USER_TAG_DELETED = new Topic(USER_NAME, "tag.deleted"); - - public static final Topic ALL_TOPIC = valueOf("all"); - - public static Topic valueOf(String type) throws IllegalArgumentException { - if (type.contains(".")) { - final String[] split = type.split("\\.", 2); // fragile: assume one dot - return new Topic(split[0], split[1]); - } else { - return new Topic(type); - } - } - - private String type; - - private String subType; - - private String toString; - - public Topic(String type) { - this(type, SUBTYPE_WILDCARD); - } - - public Topic(String type, String subType) { - Preconditions.checkArgument(type != null, "type part cannot be null"); - Preconditions.checkArgument(subType != null, "subType part cannot be null"); - this.type = type; - this.subType = subType; - // memo the string representation - if (SUBTYPE_WILDCARD.equals(subType)) { - toString = type; - } else { - toString = type + "." + subType; - } - } - - public String getType() { - return type; - } - - public String getSubType() { - return subType; - } - - public boolean isCompatible(String type) { - return this.isCompatible(valueOf(type)); - } - - public boolean isCompatible(Topic other) { - if (other == null) { - return false; - } - //noinspection SimplifiableIfStatement - if (type.equalsIgnoreCase(other.type) && (subType.equals(SUBTYPE_WILDCARD) || other.subType.equals(SUBTYPE_WILDCARD))) { - return true; - } else { - return this.type.equalsIgnoreCase(other.type) && this.subType.equalsIgnoreCase(other.subType); - } - } - - @Override - public int hashCode() { - int result = type != null ? type.hashCode() : 0; - result = 31 * result + (subType != null ? subType.hashCode() : 0); - return result; - } - - @Override - public String toString() { - return toString; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - final Topic Topic = (Topic) o; - if (subType != null ? !subType.equals(Topic.subType) : Topic.subType != null) { - return false; - } - //noinspection RedundantIfStatement - if (type != null ? !type.equals(Topic.type) : Topic.type != null) { - return false; - } - return true; - } - - - } - - @SuppressWarnings("FieldCanBeLocal") - @JsonProperty("type") - private final String type = "notification_subscription"; - - @JsonProperty("id") - private String id; - - @JsonProperty("created_at") - private long createdAt; - - @JsonProperty("updated_at") - private long updatedAt; - - @JsonProperty("service_type") - private final String serviceType = "web"; - - @JsonProperty("app_id") - private String appID; - - @JsonProperty("url") - private URI url; - - @JsonProperty("self") - private URI self; - - @JsonProperty("topics") - private List topics = Lists.newArrayList(); - - @JsonProperty("metadata") - private Map metadata = Maps.newHashMap(); - - @JsonProperty("active") - private boolean active; - - @JsonProperty("hub_secret") - private String hubSecret; - - @JsonProperty("mode") - private String mode = "point"; - - @JsonProperty("links") - private Map links = Maps.newHashMap(); - - @JsonProperty("notes") - private List notes = Lists.newArrayList(); - - public Subscription() { - } - - public String getId() { - return id; - } - - public void setId(String id) { - this.id = id; - } - - public String getType() { - return type; - } - - public long getCreatedAt() { - return createdAt; - } - - public long getUpdatedAt() { - return updatedAt; - } - - public String getServiceType() { - return serviceType; - } - - public String getAppID() { - return appID; - } - - public void setAppID(String appID) { - this.appID = appID; - } - - public URI getUrl() { - return url; - } - - public void setUrl(URI url) { - this.url = url; - } - - public URI getSelf() { - return self; - } - - public List getTopics() { - return topics; - } - - public void setTopics(List topics) { - this.topics = topics; - } - - public void addTopic(Topic topic) { - this.topics.add(topic); - } - - public boolean getActive() { - return active; - } - - public void setActive(boolean active) { - this.active = active; - } - - public Map getMetadata() { - return metadata; - } - - public void setMetadata(Map metadata) { - this.metadata = metadata; - } - - public String getHubSecret() { - return hubSecret; - } - - public void setHubSecret(String hubSecret) { - this.hubSecret = hubSecret; - } - - public String getMode() { - return mode; - } - - public List getNotes() { - return notes; - } - - public void setNotes(List notes) { - this.notes = notes; - } - - @JsonIgnore - public String getURLString() { - return url.toASCIIString(); - } - - @JsonIgnore - public boolean requiresSignature() { - return getHubSecret() != null; - } - - @Override - public boolean equals(Object o) { - if (this == o) return true; - if (o == null || getClass() != o.getClass()) return false; - - Subscription that = (Subscription) o; - - if (active != that.active) return false; - if (createdAt != that.createdAt) return false; - if (updatedAt != that.updatedAt) return false; - if (appID != null ? !appID.equals(that.appID) : that.appID != null) return false; - if (hubSecret != null ? !hubSecret.equals(that.hubSecret) : that.hubSecret != null) return false; - if (id != null ? !id.equals(that.id) : that.id != null) return false; - if (links != null ? !links.equals(that.links) : that.links != null) return false; - if (metadata != null ? !metadata.equals(that.metadata) : that.metadata != null) return false; - if (mode != null ? !mode.equals(that.mode) : that.mode != null) return false; - if (notes != null ? !notes.equals(that.notes) : that.notes != null) return false; - if (self != null ? !self.equals(that.self) : that.self != null) return false; - if (!serviceType.equals(that.serviceType)) return false; - if (topics != null ? !topics.equals(that.topics) : that.topics != null) return false; - if (!type.equals(that.type)) return false; - //noinspection RedundantIfStatement - if (url != null ? !url.equals(that.url) : that.url != null) return false; - - return true; - } - - @Override - public int hashCode() { - int result = type.hashCode(); - result = 31 * result + (id != null ? id.hashCode() : 0); - result = 31 * result + (int) (createdAt ^ (createdAt >>> 32)); - result = 31 * result + (int) (updatedAt ^ (updatedAt >>> 32)); - result = 31 * result + (serviceType.hashCode()); - result = 31 * result + (appID != null ? appID.hashCode() : 0); - result = 31 * result + (url != null ? url.hashCode() : 0); - result = 31 * result + (self != null ? self.hashCode() : 0); - result = 31 * result + (topics != null ? topics.hashCode() : 0); - result = 31 * result + (metadata != null ? metadata.hashCode() : 0); - result = 31 * result + (active ? 1 : 0); - result = 31 * result + (hubSecret != null ? hubSecret.hashCode() : 0); - result = 31 * result + (mode != null ? mode.hashCode() : 0); - result = 31 * result + (links != null ? links.hashCode() : 0); - result = 31 * result + (notes != null ? notes.hashCode() : 0); - return result; - } - - @Override - public String toString() { - return "Subscription{" + - "id='" + id + '\'' + - ", createdAt=" + createdAt + - ", updatedAt=" + updatedAt + - ", serviceType='" + serviceType + '\'' + - ", appID='" + appID + '\'' + - ", url=" + url + - ", self=" + self + - ", topics=" + topics + - ", metadata=" + metadata + - ", active=" + active + - ", hubSecret='" + hubSecret + '\'' + - ", mode='" + mode + '\'' + - ", links=" + links + - ", notes=" + notes + - "} " + super.toString(); - } - - -} diff --git a/intercom-java/src/main/java/io/intercom/api/SubscriptionCollection.java b/intercom-java/src/main/java/io/intercom/api/SubscriptionCollection.java deleted file mode 100644 index ac9aceeb..00000000 --- a/intercom-java/src/main/java/io/intercom/api/SubscriptionCollection.java +++ /dev/null @@ -1,50 +0,0 @@ -package io.intercom.api; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; - -import java.util.Iterator; -import java.util.List; - -@SuppressWarnings("UnusedDeclaration") -@JsonIgnoreProperties(ignoreUnknown = true) -@JsonInclude(JsonInclude.Include.NON_EMPTY) -public class SubscriptionCollection extends TypedDataCollection implements Iterator { - - protected TypedDataCollectionIterator iterator; - - public SubscriptionCollection() { - iterator = new TypedDataCollectionIterator(this); - } - - @Override - public SubscriptionCollection nextPage() { - return fetchNextPage(SubscriptionCollection.class); - } - - @SuppressWarnings("EmptyMethod") - @JsonProperty("items") - @Override - public List getPage() { - return super.getPage(); - } - - public boolean hasNext() { - return iterator.hasNext(); - } - - public Subscription next() { - return iterator.next(); - } - - public void remove() { - iterator.remove(); - } - - @Override - public String toString() { - return "SubscriptionCollection{" + - "} " + super.toString(); - } -} diff --git a/intercom-java/src/main/java/io/intercom/api/Tag.java b/intercom-java/src/main/java/io/intercom/api/Tag.java deleted file mode 100644 index 2482e2ba..00000000 --- a/intercom-java/src/main/java/io/intercom/api/Tag.java +++ /dev/null @@ -1,250 +0,0 @@ -package io.intercom.api; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.google.common.annotations.VisibleForTesting; -import com.google.common.base.Strings; -import com.google.common.collect.Lists; -import com.google.common.collect.Maps; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; - -import java.util.HashMap; -import java.util.List; -import java.util.Map; - -@SuppressWarnings("UnusedDeclaration") -@JsonIgnoreProperties(ignoreUnknown = true) -@JsonInclude(JsonInclude.Include.NON_EMPTY) -public class Tag extends TypedData { - - private static final Logger logger = LoggerFactory.getLogger("intercom-java"); - private static final HashMap SENTINEL = Maps.newHashMap(); - - public static Tag tag(Tag tag, User... users) throws InvalidException, AuthorizationException { - return tag(tag, new UserCollection(Lists.newArrayList(users))); - } - - public static Tag tag(Tag tag, Company... companies) throws InvalidException, AuthorizationException { - return tag(tag, new CompanyCollection(Lists.newArrayList(companies))); - } - - static Tag tag(Tag tag, UserCollection users) throws InvalidException, AuthorizationException { - TaggableCollection taggableCollection = createTagTypedCollection(tag, users); - return DataResource.create(taggableCollection, "tags", Tag.class); - } - - static Tag tag(Tag tag, CompanyCollection companies) throws InvalidException, AuthorizationException { - TaggableCollection taggableCollection = createTagTypedCollection(tag, companies); - return DataResource.create(taggableCollection, "tags", Tag.class); - } - - public static Tag create(Tag tag) throws InvalidException, AuthorizationException { - return DataResource.create(tag, "tags", Tag.class); - } - - public static Tag update(Tag tag) throws InvalidException, AuthorizationException { - if (tag.getId() == null) { - throw new InvalidException("tag updates must supply an id"); - } - return DataResource.update(tag, "tags", Tag.class); - } - - public static Tag delete(String id) throws InvalidException, AuthorizationException { - return DataResource.delete(id, "tags", Tag.class); - } - - public static Tag delete(Tag tag) throws InvalidException, AuthorizationException { - return delete(tag.getId()); - } - - public static TagCollection list() throws InvalidException, AuthorizationException { - return DataResource.list(SENTINEL, "tags", TagCollection.class); - } - - @VisibleForTesting - static TaggableCollection createTagTypedCollection(Tag tag, UserCollection users) { - TaggableCollection taggableCollection = new TaggableCollection(); - taggableCollection.setName(tag.getName()); - taggableCollection.setId(tag.getId()); - final List> usersLite = Lists.newArrayList(); - final List pageItems = users.getPage(); - for (User user : pageItems) { - Map userMap = Maps.newHashMap(); - final String id = user.getId(); - final String email = user.getEmail(); - final String userId = user.getUserId(); - - if (user.isUntag()) { - userMap.put("untag", true); - } - - if (!Strings.isNullOrEmpty(id)) { - userMap.put("id", id); - usersLite.add(userMap); - } else if (!Strings.isNullOrEmpty(email)) { - userMap.put("email", email); - usersLite.add(userMap); - } else if (!Strings.isNullOrEmpty(userId)) { - userMap.put("user_id", userId); - usersLite.add(userMap); - } else { - logger.warn("no identifiers found for user tag target, skipping [" + tag + "] [" + user.toString() + "]"); - } - } - taggableCollection.setUsers(usersLite); - return taggableCollection; - } - - @VisibleForTesting - static TaggableCollection createTagTypedCollection(Tag tag, CompanyCollection companies) { - TaggableCollection taggableCollection = new TaggableCollection(); - taggableCollection.setName(tag.getName()); - taggableCollection.setId(tag.getId()); - - final List> companiesLite = Lists.newArrayList(); - final List pageItems = companies.getPage(); - for (Company company : pageItems) { - Map companyMap = Maps.newHashMap(); - final String companyID = company.getCompanyID(); - final String id = company.getId(); - final String name = company.getName(); - - if (company.isUntag()) { - companyMap.put("untag", true); - } - - if (!Strings.isNullOrEmpty(companyID)) { - companyMap.put("company_id", companyID); - companiesLite.add(companyMap); - } else if (!Strings.isNullOrEmpty(id)) { - companyMap.put("id", id); - companiesLite.add(companyMap); - } else if (!Strings.isNullOrEmpty(name)) { - companyMap.put("name", name); - companiesLite.add(companyMap); - } else { - logger.warn("no identifiers found for company tag target, skipping [" + tag + "] [" + company.toString() + "]"); - } - taggableCollection.setCompanies(companiesLite); - } - return taggableCollection; - } - - @SuppressWarnings("UnusedDeclaration") - @JsonIgnoreProperties(ignoreUnknown = true) - @JsonInclude(JsonInclude.Include.NON_DEFAULT) - static class TaggableCollection extends Tag { - - @JsonProperty("users") - private List> users; - - @JsonProperty("companies") - private List> companies; - - public List> getUsers() { - return users; - } - - public void setUsers(List> usersLite) { - this.users = usersLite; - } - - public List> getCompanies() { - return companies; - } - - public void setCompanies(List> companies) { - this.companies = companies; - } - } - - @JsonProperty("type") - private final String type = "tag"; - - @JsonProperty("id") - private String id; - - @JsonProperty("name") - private String name; - - @JsonProperty("created_at") - private long createdAt; - - @JsonProperty("updated_at") - private long updatedAt; - - public Tag() { - } - - public String getType() { - return type; - } - - public String getId() { - return id; - } - - - @SuppressWarnings("UnusedReturnValue") - @VisibleForTesting - Tag setId(String id) { - this.id = id; - return this; - } - - public String getName() { - return name; - } - - public Tag setName(String name) { - this.name = name; - return this; - } - - public long getCreatedAt() { - return createdAt; - } - - public long getUpdatedAt() { - return updatedAt; - } - - @Override - public boolean equals(Object o) { - if (this == o) return true; - if (o == null || getClass() != o.getClass()) return false; - - Tag tag = (Tag) o; - - if (createdAt != tag.createdAt) return false; - if (updatedAt != tag.updatedAt) return false; - if (id != null ? !id.equals(tag.id) : tag.id != null) return false; - if (name != null ? !name.equals(tag.name) : tag.name != null) return false; - //noinspection RedundantIfStatement - if (!type.equals(tag.type)) return false; - - return true; - } - - @Override - public int hashCode() { - int result = type.hashCode(); - result = 31 * result + (id != null ? id.hashCode() : 0); - result = 31 * result + (name != null ? name.hashCode() : 0); - result = 31 * result + (int) (createdAt ^ (createdAt >>> 32)); - result = 31 * result + (int) (updatedAt ^ (updatedAt >>> 32)); - return result; - } - - @Override - public String toString() { - return "Tag{" + - "id='" + id + '\'' + - ", name='" + name + '\'' + - ", createdAt=" + createdAt + - ", updatedAt=" + updatedAt + - "} " + super.toString(); - } -} diff --git a/intercom-java/src/main/java/io/intercom/api/TagCollection.java b/intercom-java/src/main/java/io/intercom/api/TagCollection.java deleted file mode 100644 index b37e942c..00000000 --- a/intercom-java/src/main/java/io/intercom/api/TagCollection.java +++ /dev/null @@ -1,50 +0,0 @@ -package io.intercom.api; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; - -import java.util.Iterator; -import java.util.List; - -@SuppressWarnings("UnusedDeclaration") -@JsonIgnoreProperties(ignoreUnknown = true) -@JsonInclude(JsonInclude.Include.NON_EMPTY) -public class TagCollection extends TypedDataCollection implements Iterator { - - protected TypedDataCollectionIterator iterator; - - public TagCollection() { - iterator = new TypedDataCollectionIterator(this); - } - - @Override - public TagCollection nextPage() { - return fetchNextPage(TagCollection.class); - } - - @SuppressWarnings("EmptyMethod") - @JsonProperty("tags") - @Override - public List getPage() { - return super.getPage(); - } - - public boolean hasNext() { - return iterator.hasNext(); - } - - public Tag next() { - return iterator.next(); - } - - public void remove() { - iterator.remove(); - } - - @Override - public String toString() { - return "TagCollection{" + - "} " + super.toString(); - } -} diff --git a/intercom-java/src/main/java/io/intercom/api/TopicDeserializer.java b/intercom-java/src/main/java/io/intercom/api/TopicDeserializer.java deleted file mode 100644 index d622b993..00000000 --- a/intercom-java/src/main/java/io/intercom/api/TopicDeserializer.java +++ /dev/null @@ -1,25 +0,0 @@ -package io.intercom.api; - -import com.fasterxml.jackson.core.JsonParser; -import com.fasterxml.jackson.databind.DeserializationContext; -import com.fasterxml.jackson.databind.ObjectMapper; -import com.fasterxml.jackson.databind.deser.std.StdDeserializer; -import com.fasterxml.jackson.databind.node.ValueNode; - -import java.io.IOException; - -class TopicDeserializer extends StdDeserializer { - - private static final long serialVersionUID = 7679767772794559452L; - - public TopicDeserializer() { - super(CustomAttribute.class); - } - - @Override - public Subscription.Topic deserialize(JsonParser jp, DeserializationContext ctxt) throws IOException { - final ObjectMapper mapper = (ObjectMapper) jp.getCodec(); - final ValueNode vNode = mapper.readTree(jp); - return Subscription.Topic.valueOf(vNode.asText()); - } -} diff --git a/intercom-java/src/main/java/io/intercom/api/TopicSerializer.java b/intercom-java/src/main/java/io/intercom/api/TopicSerializer.java deleted file mode 100644 index 7f2f8846..00000000 --- a/intercom-java/src/main/java/io/intercom/api/TopicSerializer.java +++ /dev/null @@ -1,20 +0,0 @@ -package io.intercom.api; - -import com.fasterxml.jackson.core.JsonGenerator; -import com.fasterxml.jackson.databind.SerializerProvider; -import com.fasterxml.jackson.databind.ser.std.StdSerializer; - -import java.io.IOException; - -class TopicSerializer extends StdSerializer { - - public TopicSerializer() { - super(Subscription.Topic.class); - } - - @Override - public void serialize(Subscription.Topic value, JsonGenerator jgen, SerializerProvider provider) - throws IOException { - jgen.writeObject(value.toString()); - } -} diff --git a/intercom-java/src/main/java/io/intercom/api/TypedData.java b/intercom-java/src/main/java/io/intercom/api/TypedData.java deleted file mode 100644 index 69738163..00000000 --- a/intercom-java/src/main/java/io/intercom/api/TypedData.java +++ /dev/null @@ -1,5 +0,0 @@ -package io.intercom.api; - -abstract class TypedData { - -} diff --git a/intercom-java/src/main/java/io/intercom/api/TypedDataCollection.java b/intercom-java/src/main/java/io/intercom/api/TypedDataCollection.java deleted file mode 100644 index e55c6375..00000000 --- a/intercom-java/src/main/java/io/intercom/api/TypedDataCollection.java +++ /dev/null @@ -1,87 +0,0 @@ -package io.intercom.api; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.google.common.collect.ImmutableList; -import com.google.common.collect.ImmutableMap; -import com.google.common.collect.Lists; -import com.google.common.collect.Maps; - -import java.net.URI; -import java.util.List; -import java.util.Map; - -@SuppressWarnings("UnusedDeclaration") -@JsonIgnoreProperties({"page"}) -@JsonInclude(JsonInclude.Include.NON_EMPTY) -public abstract class TypedDataCollection extends TypedData { - - public static final String NEXT_PAGE_REL = "next"; - - protected List page = Lists.newArrayList(); - - @JsonProperty("pages") - protected Map pages = Maps.newHashMap(); - - @JsonProperty("type") - protected String type; - - public abstract TypedDataCollection nextPage(); - - public boolean hasNextPage() { - return pages.containsKey("next") && pages.get("next") != null; - } - - public List getPage() { - return ImmutableList.builder().addAll(page).build(); - } - - protected > C fetchNextPage(Class typeReference) { - if (hasNextPage()) { - final URI next = UriBuilder.newBuilder(pages.get(TypedDataCollection.NEXT_PAGE_REL)).build(); - final HttpClient resource = new HttpClient(next); - return resource.get(typeReference); - } else { - return null; - } - } - - public Map getPages() { - return ImmutableMap.builder().putAll(pages).build(); - } - - public String getType() { - return type; - } - - @Override - public boolean equals(Object o) { - if (this == o) return true; - if (o == null || getClass() != o.getClass()) return false; - - TypedDataCollection that = (TypedDataCollection) o; - - if (page != null ? !page.equals(that.page) : that.page != null) return false; - if (pages != null ? !pages.equals(that.pages) : that.pages != null) return false; - //noinspection RedundantIfStatement - if (type != null ? !type.equals(that.type) : that.type != null) return false; - - return true; - } - - @Override - public int hashCode() { - int result = page != null ? page.hashCode() : 0; - result = 31 * result + (pages != null ? pages.hashCode() : 0); - result = 31 * result + (type != null ? type.hashCode() : 0); - return result; - } - - @Override - public String toString() { - return getType() + "{" + - "page=" + page + - "} " + super.toString(); - } -} diff --git a/intercom-java/src/main/java/io/intercom/api/TypedDataCollectionIterator.java b/intercom-java/src/main/java/io/intercom/api/TypedDataCollectionIterator.java deleted file mode 100644 index db0b1bd5..00000000 --- a/intercom-java/src/main/java/io/intercom/api/TypedDataCollectionIterator.java +++ /dev/null @@ -1,51 +0,0 @@ -package io.intercom.api; - -import java.util.Iterator; -import java.util.NoSuchElementException; - -class TypedDataCollectionIterator implements Iterator { - - private TypedDataCollection rollingCollection; - private int pos; - - public TypedDataCollectionIterator(TypedDataCollection startingCollection) { - this.rollingCollection = startingCollection; - this.pos = 0; - } - - public boolean hasNext() { - if (pos == rollingCollection.getPage().size()) { - if (rollingCollection.hasNextPage()) { - rollingCollection = rollingCollection.nextPage(); - pos = 0; - return true; - } else { - return false; - } - } else { - return pos <= rollingCollection.getPage().size(); - } - } - - public T next() { - iterate(); - final T t = rollingCollection.getPage().get(pos); - pos++; - return t; - } - - private void iterate() { - if (pos == rollingCollection.getPage().size()) { - if (rollingCollection.hasNextPage()) { - rollingCollection = rollingCollection.nextPage(); - pos = 0; - } else { - throw new NoSuchElementException(); - } - } - } - - public void remove() { - throw new UnsupportedOperationException(); - } -} diff --git a/intercom-java/src/main/java/io/intercom/api/URIDeserializer.java b/intercom-java/src/main/java/io/intercom/api/URIDeserializer.java deleted file mode 100644 index c85b0a02..00000000 --- a/intercom-java/src/main/java/io/intercom/api/URIDeserializer.java +++ /dev/null @@ -1,32 +0,0 @@ -package io.intercom.api; - -import com.fasterxml.jackson.core.JsonParser; -import com.fasterxml.jackson.databind.DeserializationContext; -import com.fasterxml.jackson.databind.ObjectMapper; -import com.fasterxml.jackson.databind.deser.std.StdDeserializer; -import com.fasterxml.jackson.databind.node.ValueNode; - -import java.io.IOException; -import java.net.URI; -import java.net.URISyntaxException; -import java.net.URL; - -class URIDeserializer extends StdDeserializer { - - - public URIDeserializer() { - super(URI.class); - } - - @Override - public URI deserialize(JsonParser jp, DeserializationContext ctxt) throws IOException { - final ObjectMapper mapper = (ObjectMapper) jp.getCodec(); - final ValueNode vNode = mapper.readTree(jp); - try { - final URL url = new URL(vNode.asText()); - return new URI(url.getProtocol(), url.getHost(), url.getPath(), url.getQuery(), url.getRef()); - } catch (URISyntaxException e) { - throw new RuntimeException(e); - } - } -} diff --git a/intercom-java/src/main/java/io/intercom/api/UriBuilder.java b/intercom-java/src/main/java/io/intercom/api/UriBuilder.java deleted file mode 100644 index 4feb8265..00000000 --- a/intercom-java/src/main/java/io/intercom/api/UriBuilder.java +++ /dev/null @@ -1,94 +0,0 @@ -package io.intercom.api; - -import com.google.common.base.Charsets; -import com.google.common.collect.Maps; - -import java.io.UnsupportedEncodingException; -import java.net.URI; -import java.net.URISyntaxException; -import java.util.Map; -import java.util.TreeMap; - -class UriBuilder { - - public static UriBuilder newBuilder() { - return new UriBuilder(Intercom.getApiBaseURI()); - } - - public static UriBuilder newBuilder(String uri) { - return new UriBuilder(uri); - } - - public static UriBuilder newBuilder(URI uri) { - return new UriBuilder(uri); - } - - private StringBuilder uri; - - private TreeMap paramsMap; // treemap to simplify testing - - private UriBuilder(String uri) { - try { - this.uri = new StringBuilder(new URI(uri).toASCIIString()); - } catch (URISyntaxException e) { - throw new RuntimeException(e); - } - } - - private UriBuilder(URI uri) { - this.uri = new StringBuilder(uri.toASCIIString()); - } - - public String buildString() { - return build().toASCIIString(); - } - - public URI build() { - if (paramsMap != null) { - uri.append("?"); - final StringBuilder sb = new StringBuilder(); - for (Map.Entry entry : paramsMap.entrySet()) { - sb.append(entry.getKey()).append("=").append(entry.getValue()).append("&"); - } - if (sb.lastIndexOf("&") == sb.length() - 1) { - sb.deleteCharAt(sb.length() - 1); - } - uri.append(sb); - } - - try { - return new URI(uri.toString()); - } catch (URISyntaxException e) { - throw new IntercomException("could not create api url", e); - } - } - - public UriBuilder path(String path) { - uri.append("/").append(urlEncode(path)); - return this; - } - - public UriBuilder query(String param, String value) { - if (paramsMap == null) { - paramsMap = Maps.newTreeMap(); - } - paramsMap.put(urlEncode(param), urlEncode(value)); - return this; - } - - public UriBuilder query(Map params) { - for (Map.Entry entry : params.entrySet()) { - query(entry.getKey(), entry.getValue()); - } - return this; - } - - private String urlEncode(String param) { - try { - // URLEncoder is a html forms encoder not a percent encoder - return java.net.URLEncoder.encode(param, Charsets.UTF_8.name()).replaceAll("\\+", "%20"); - } catch (UnsupportedEncodingException e) { - throw new IntercomException("could not encode url param " + param, e); - } - } -} diff --git a/intercom-java/src/main/java/io/intercom/api/User.java b/intercom-java/src/main/java/io/intercom/api/User.java deleted file mode 100644 index 86cd4673..00000000 --- a/intercom-java/src/main/java/io/intercom/api/User.java +++ /dev/null @@ -1,565 +0,0 @@ -package io.intercom.api; - - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.google.common.annotations.VisibleForTesting; -import com.google.common.collect.Lists; -import com.google.common.collect.Maps; - -import java.net.URI; -import java.util.ArrayList; -import java.util.List; -import java.util.Map; - -@SuppressWarnings("UnusedDeclaration") -@JsonIgnoreProperties(ignoreUnknown = true) -@JsonInclude(JsonInclude.Include.NON_DEFAULT) -public class User extends TypedData implements Replier { - - private static final Map SENTINEL = Maps.newHashMap(); - - private static List buildUserUpdateCompanies(User user) { - // restrictions on the company data that can be sent via a user update - final ArrayList updatableCompanies = Lists.newArrayList(); - if (user.getCompanyCollection() != null) { - final List companies = user.getCompanyCollection().getPage(); - for (Company company : companies) { - final CompanyWithStringPlan updatableCompany = new CompanyWithStringPlan(); - updatableCompany.setCompanyID(company.getCompanyID()); - updatableCompany.setName(company.getName()); - updatableCompany.setSessionCount(company.getSessionCount()); - updatableCompany.setMonthlySpend(company.getMonthlySpend()); - updatableCompany.setRemoteCreatedAt(company.getRemoteCreatedAt()); - // api doesn't send back plan data for a company inside a user - if (company.getPlan() != null) { - updatableCompany.setPlan(company.getPlan().getName()); - } - updatableCompanies.add(updatableCompany); - } - } - return updatableCompanies; - } - - public static User find(String id) - throws AuthorizationException, ClientException, ServerException, InvalidException, RateLimitException { - final URI users = UriBuilder.newBuilder().path("users").path(id).build(); - final HttpClient resource = new HttpClient(users); - return resource.get(User.class); - } - - public static User find(Map params) - throws AuthorizationException, ClientException, ServerException, InvalidException, RateLimitException { - if ((!params.containsKey("email")) && (!params.containsKey("user_id"))) { - throw new InvalidException("a user find must include an email or user_id parameter"); - } - return DataResource.find(params, "users", User.class); - } - - public static User create(User user) - throws AuthorizationException, ClientException, ServerException, InvalidException, RateLimitException { - return DataResource.create(UserUpdate.buildFrom(user), "users", User.class); - } - - public static User update(User user) throws InvalidException, AuthorizationException { - // only send fields the server allows for update - return DataResource.update(UserUpdate.buildFrom(user), "users", User.class); - } - - public static User delete(String id) - throws AuthorizationException, ClientException, ServerException, InvalidException, RateLimitException { - return DataResource.delete(id, "users", User.class); - } - - public static UserCollection list(Map params) - throws AuthorizationException, ClientException, ServerException, InvalidException, RateLimitException { - return DataResource.list(params, "users", UserCollection.class); - } - - public static UserCollection list() - throws AuthorizationException, ClientException, ServerException, InvalidException, RateLimitException { - return DataResource.list(SENTINEL, "users", UserCollection.class); - } - - @SuppressWarnings("UnusedDeclaration") - @JsonIgnoreProperties(ignoreUnknown = true) - @JsonInclude(JsonInclude.Include.NON_DEFAULT) - static class UserUpdate extends TypedData { - - static UserUpdate buildFrom(User user) { - final UserUpdate userUpdate = new UserUpdate(); - userUpdate.userId = user.getUserId(); - userUpdate.email = user.getEmail(); - // userUpdate.id = user.id; // bug: id is treated as custom attribute - userUpdate.remoteCreatedAt = user.getRemoteCreatedAt(); - userUpdate.name = user.getName(); - userUpdate.lastSeenIp = user.getLastSeenIp(); - userUpdate.customAttributes = user.getCustomAttributes(); - userUpdate.lastSeenUserAgent = user.getUserAgentData(); - userUpdate.companyCollection = buildUserUpdateCompanies(user); - userUpdate.lastRequestAt = user.getLastRequestAt(); - userUpdate.unsubscribedFromEmails = user.getUnsubscribedFromEmails(); - userUpdate.updateLastRequestAt = user.isUpdateLastRequestAt(); - userUpdate.newSession = user.isNewSession(); - return userUpdate; - } - - @JsonProperty("type") - private final String type = "user"; - - @JsonProperty("user_id") - private String userId; - - @JsonProperty("email") - private String email; - - @JsonProperty("remote_created_at") - private long remoteCreatedAt; - - @JsonProperty("name") - private String name; - - @JsonProperty("last_seen_ip") - private String lastSeenIp; - - @JsonIgnoreProperties(ignoreUnknown = false) - @JsonProperty("custom_attributes") - private Map customAttributes = Maps.newHashMap(); - - @JsonProperty("last_seen_user_agent") - private String lastSeenUserAgent; - - @JsonProperty("companies") - private List companyCollection; - - @JsonProperty("last_request_at") - private long lastRequestAt; - - /** - * Making this a Boolean allows us to send true or false as set - * values leaving null the ignored field for NON_DEFAULT. A - * primitive would result in false not being sent - */ - @JsonProperty("unsubscribed_from_emails") - private Boolean unsubscribedFromEmails; - - /** - * Making this a Boolean allows us to send true or false as set - * values leaving null the ignored field for NON_DEFAULT. A - * primitive would result in false not being sent - */ - @JsonProperty("update_last_request_at") - private Boolean updateLastRequestAt; - - /** - * Making this a Boolean allows us to send true or false as set - * values leaving null the ignored field for NON_DEFAULT. A - * primitive would result in false not being sent - */ - @JsonProperty("new_session") - private Boolean newSession; - - public UserUpdate() { - } - - public String getType() { - return type; - } - - public String getUserId() { - return userId; - } - - public String getEmail() { - return email; - } - - public long getRemoteCreatedAt() { - return remoteCreatedAt; - } - - public String getName() { - return name; - } - - public String getLastSeenIp() { - return lastSeenIp; - } - - public Map getCustomAttributes() { - return customAttributes; - } - - public String getLastSeenUserAgent() { - return lastSeenUserAgent; - } - - public List getCompanyCollection() { - return companyCollection; - } - - public long getLastRequestAt() { - return lastRequestAt; - } - - public Boolean getUnsubscribedFromEmails() { - return unsubscribedFromEmails; - } - - public Boolean isUpdateLastRequestAt() { - return updateLastRequestAt; - } - - public Boolean isNewSession() { - return newSession; - } - } - - @JsonProperty("type") - private final String type = "user"; - - @JsonProperty("id") - private String id; - - @JsonProperty("name") - private String name; - - @JsonProperty("email") - private String email; - - @JsonProperty("user_id") - private String userId; - - @JsonProperty("avatar") - private Avatar avatar; - - @JsonProperty("created_at") - private long createdAt; - - @JsonProperty("updated_at") - private long updatedAt; - - @JsonProperty("remote_created_at") - private long remoteCreatedAt; - - @JsonProperty("unsubscribed_from_emails") - private boolean unsubscribedFromEmails; - - @JsonProperty("session_count") - private int sessionCount; - - @JsonProperty("last_request_at") - private long lastRequestAt; - - @JsonProperty("last_seen_ip") - private String lastSeenIp; - - @JsonIgnoreProperties(ignoreUnknown = false) - @JsonProperty("custom_attributes") - private Map customAttributes = Maps.newHashMap(); - - @JsonProperty("user_agent_data") - private String userAgentData; - - @JsonProperty("location_data") - private LocationData locationData; - - @JsonIgnoreProperties(ignoreUnknown = false) - @JsonProperty("companies") - private CompanyCollection companyCollection = new CompanyCollection(); - - @JsonProperty("social_profiles") - private SocialProfileCollection socialProfileCollection = new SocialProfileCollection(); - - @JsonProperty("segments") - private SegmentCollection segmentCollection = new SegmentCollection(); - - @JsonProperty("tags") - private TagCollection tagCollection = new TagCollection(); - - @JsonProperty("update_last_request_at") - private boolean updateLastRequestAt; - - @JsonProperty("new_session") - private boolean newSession; - - private Boolean untag; - - public User() { - } - - public User untag() { - untag = Boolean.TRUE; - return this; - } - - boolean isUntag() { - return untag == null ? false : untag; - } - - public String getReplyType() { - return getType() + "_reply"; - } - - public String getType() { - return type; - } - - public String getId() { - return id; - } - - public User setId(String id) { - this.id = id; - return this; - } - - public String getName() { - return name; - } - - public User setName(String name) { - this.name = name; - return this; - } - - public String getEmail() { - return email; - } - - public User setEmail(String email) { - this.email = email; - return this; - } - - public String getUserId() { - return userId; - } - - public User setUserId(String userId) { - this.userId = userId; - return this; - } - - public Avatar getAvatar() { - return avatar; - } - - public long getCreatedAt() { - return createdAt; - } - - public long getUpdatedAt() { - return updatedAt; - } - - public long getRemoteCreatedAt() { - return remoteCreatedAt; - } - - public User setRemoteCreatedAt(long remoteCreatedAt) { - this.remoteCreatedAt = remoteCreatedAt; - return this; - } - - public boolean getUnsubscribedFromEmails() { - return unsubscribedFromEmails; - } - - public User setUnsubscribedFromEmails(boolean unsubscribedFromEmails) { - this.unsubscribedFromEmails = unsubscribedFromEmails; - return this; - } - - public int getSessionCount() { - return sessionCount; - } - - public long getLastRequestAt() { - return lastRequestAt; - } - - public User setLastRequestAt(long lastRequestAt) { - this.lastRequestAt = lastRequestAt; - return this; - } - - public String getLastSeenIp() { - return lastSeenIp; - } - - public User setLastSeenIp(String lastSeenIp) { - this.lastSeenIp = lastSeenIp; - return this; - } - - public Map getCustomAttributes() { - return customAttributes; - } - - public User setCustomAttributes(Map customAttributes) { - this.customAttributes = customAttributes; - return this; - } - - public User addCustomAttribute(CustomAttribute customAttribute) { - this.customAttributes.put(customAttribute.getName(), customAttribute); - return this; - } - - public String getUserAgentData() { - return userAgentData; - } - - @VisibleForTesting - User setUserAgentData(String userAgentData) { - this.userAgentData = userAgentData; - return this; - } - - public LocationData getLocationData() { - return locationData; - } - - public CompanyCollection getCompanyCollection() { - return companyCollection; - } - - public User setCompanyCollection(CompanyCollection companyCollection) { - this.companyCollection = companyCollection; - return this; - } - - public User addCompany(Company company) { - // sneak past the immutable list - this.companyCollection.addCompany(company); - return this; - } - - public SocialProfileCollection getSocialProfileCollection() { - return socialProfileCollection; - } - - public SegmentCollection getSegmentCollection() { - return segmentCollection; - } - - public TagCollection getTagCollection() { - return tagCollection; - } - - public boolean isUpdateLastRequestAt() { - return updateLastRequestAt; - } - - public User setUpdateLastRequestAt(boolean updateLastRequestAt) { - this.updateLastRequestAt = updateLastRequestAt; - return this; - } - - public boolean isNewSession() { - return newSession; - } - - public User setNewSession(boolean newSession) { - this.newSession = newSession; - return this; - } - - @Override - public boolean equals(Object o) { - if (this == o) return true; - if (o == null || getClass() != o.getClass()) return false; - - User user = (User) o; - - if (createdAt != user.createdAt) return false; - if (lastRequestAt != user.lastRequestAt) return false; - if (newSession != user.newSession) return false; - if (remoteCreatedAt != user.remoteCreatedAt) return false; - if (sessionCount != user.sessionCount) return false; - if (unsubscribedFromEmails != user.unsubscribedFromEmails) return false; - if (updateLastRequestAt != user.updateLastRequestAt) return false; - if (updatedAt != user.updatedAt) return false; - if (avatar != null ? !avatar.equals(user.avatar) : user.avatar != null) return false; - if (companyCollection != null ? !companyCollection.equals(user.companyCollection) : user.companyCollection != null) - return false; - if (customAttributes != null ? !customAttributes.equals(user.customAttributes) : user.customAttributes != null) - return false; - if (email != null ? !email.equals(user.email) : user.email != null) return false; - if (id != null ? !id.equals(user.id) : user.id != null) return false; - if (lastSeenIp != null ? !lastSeenIp.equals(user.lastSeenIp) : user.lastSeenIp != null) return false; - if (locationData != null ? !locationData.equals(user.locationData) : user.locationData != null) return false; - if (name != null ? !name.equals(user.name) : user.name != null) return false; - if (segmentCollection != null ? !segmentCollection.equals(user.segmentCollection) : user.segmentCollection != null) - return false; - if (socialProfileCollection != null ? !socialProfileCollection.equals(user.socialProfileCollection) : user.socialProfileCollection != null) - return false; - if (tagCollection != null ? !tagCollection.equals(user.tagCollection) : user.tagCollection != null) - return false; - if (!type.equals(user.type)) return false; - if (untag != null ? !untag.equals(user.untag) : user.untag != null) return false; - if (userAgentData != null ? !userAgentData.equals(user.userAgentData) : user.userAgentData != null) - return false; - //noinspection RedundantIfStatement - if (userId != null ? !userId.equals(user.userId) : user.userId != null) return false; - - return true; - } - - @Override - public int hashCode() { - int result = type.hashCode(); - result = 31 * result + (id != null ? id.hashCode() : 0); - result = 31 * result + (name != null ? name.hashCode() : 0); - result = 31 * result + (email != null ? email.hashCode() : 0); - result = 31 * result + (userId != null ? userId.hashCode() : 0); - result = 31 * result + (avatar != null ? avatar.hashCode() : 0); - result = 31 * result + (int) (createdAt ^ (createdAt >>> 32)); - result = 31 * result + (int) (updatedAt ^ (updatedAt >>> 32)); - result = 31 * result + (int) (remoteCreatedAt ^ (remoteCreatedAt >>> 32)); - result = 31 * result + (unsubscribedFromEmails ? 1 : 0); - result = 31 * result + sessionCount; - result = 31 * result + (int) (lastRequestAt ^ (lastRequestAt >>> 32)); - result = 31 * result + (lastSeenIp != null ? lastSeenIp.hashCode() : 0); - result = 31 * result + (customAttributes != null ? customAttributes.hashCode() : 0); - result = 31 * result + (userAgentData != null ? userAgentData.hashCode() : 0); - result = 31 * result + (locationData != null ? locationData.hashCode() : 0); - result = 31 * result + (companyCollection != null ? companyCollection.hashCode() : 0); - result = 31 * result + (socialProfileCollection != null ? socialProfileCollection.hashCode() : 0); - result = 31 * result + (segmentCollection != null ? segmentCollection.hashCode() : 0); - result = 31 * result + (tagCollection != null ? tagCollection.hashCode() : 0); - result = 31 * result + (updateLastRequestAt ? 1 : 0); - result = 31 * result + (newSession ? 1 : 0); - result = 31 * result + (untag != null ? untag.hashCode() : 0); - return result; - } - - @Override - public String toString() { - return "User{" + - "id='" + id + '\'' + - ", name='" + name + '\'' + - ", email='" + email + '\'' + - ", userId='" + userId + '\'' + - ", avatar=" + avatar + - ", createdAt=" + createdAt + - ", updatedAt=" + updatedAt + - ", remoteCreatedAt=" + remoteCreatedAt + - ", unsubscribedFromEmails=" + unsubscribedFromEmails + - ", sessionCount=" + sessionCount + - ", lastRequestAt=" + lastRequestAt + - ", lastSeenIp='" + lastSeenIp + '\'' + - ", customAttributes=" + customAttributes + - ", userAgentData='" + userAgentData + '\'' + - ", locationData=" + locationData + - ", companyCollection=" + companyCollection + - ", socialProfileCollection=" + socialProfileCollection + - ", segmentCollection=" + segmentCollection + - ", tagCollection=" + tagCollection + - ", updateLastRequestAt=" + updateLastRequestAt + - ", newSession=" + newSession + - "} " + super.toString(); - } -} diff --git a/intercom-java/src/main/java/io/intercom/api/UserCollection.java b/intercom-java/src/main/java/io/intercom/api/UserCollection.java deleted file mode 100644 index eb46c8a1..00000000 --- a/intercom-java/src/main/java/io/intercom/api/UserCollection.java +++ /dev/null @@ -1,48 +0,0 @@ -package io.intercom.api; - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonProperty; - -import java.util.Iterator; -import java.util.List; - -@SuppressWarnings("UnusedDeclaration") -@JsonIgnoreProperties(ignoreUnknown = true) -public class UserCollection extends TypedDataCollection implements Iterator { - - protected TypedDataCollectionIterator iterator; - - public UserCollection() { - iterator = new TypedDataCollectionIterator(this); - } - - public UserCollection(List users) { - this(); - this.page = users; - } - - @SuppressWarnings("EmptyMethod") - @JsonProperty("users") - @Override - public List getPage() { - return super.getPage(); - } - - @Override - public UserCollection nextPage() { - return fetchNextPage(UserCollection.class); - } - - public boolean hasNext() { - return iterator.hasNext(); - } - - public User next() { - return iterator.next(); - } - - public void remove() { - iterator.remove(); - } - -} diff --git a/intercom-java/src/main/java/io/intercom/api/UserMessage.java b/intercom-java/src/main/java/io/intercom/api/UserMessage.java deleted file mode 100644 index a0774487..00000000 --- a/intercom-java/src/main/java/io/intercom/api/UserMessage.java +++ /dev/null @@ -1,120 +0,0 @@ -package io.intercom.api; - - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; - - -@SuppressWarnings("UnusedDeclaration") -@JsonIgnoreProperties(ignoreUnknown = true) -@JsonInclude(JsonInclude.Include.NON_EMPTY) -public class UserMessage extends TypedData { - - @SuppressWarnings("FieldCanBeLocal") - @JsonProperty("type") - private final String type = "user_message"; - - @JsonProperty("message_type") - private final String messageType = "inapp"; - - @JsonProperty("id") - private String id; - - @JsonProperty("body") - private String body; - - @JsonProperty("created_at") - private long createdAt; - - @JsonProperty("from") - private User user; - - public UserMessage() { - } - - public String getType() { - return type; - } - - public String getId() { - return id; - } - - UserMessage setId(String id) { - this.id = id; - return this; - } - - public String getBody() { - return body; - } - - public UserMessage setBody(String body) { - this.body = body; - return this; - } - - public long getCreatedAt() { - return createdAt; - } - - public UserMessage setCreatedAt(long createdAt) { - this.createdAt = createdAt; - return this; - } - - public User getUser() { - return user; - } - - public UserMessage setUser(User user) { - this.user = user; - return this; - } - - public String getMessageType() { - return messageType; - } - - @Override - public boolean equals(Object o) { - if (this == o) return true; - if (o == null || getClass() != o.getClass()) return false; - - UserMessage that = (UserMessage) o; - - if (createdAt != that.createdAt) return false; - if (body != null ? !body.equals(that.body) : that.body != null) return false; - if (id != null ? !id.equals(that.id) : that.id != null) return false; - if (!messageType.equals(that.messageType)) return false; - if (!type.equals(that.type)) return false; - //noinspection RedundantIfStatement - if (user != null ? !user.equals(that.user) : that.user != null) return false; - - return true; - } - - @Override - public int hashCode() { - int result = type.hashCode(); - result = 31 * result + (messageType.hashCode()); - result = 31 * result + (id != null ? id.hashCode() : 0); - result = 31 * result + (body != null ? body.hashCode() : 0); - result = 31 * result + (int) (createdAt ^ (createdAt >>> 32)); - result = 31 * result + (user != null ? user.hashCode() : 0); - return result; - } - - @Override - public String toString() { - return "UserMessage{" + - "id='" + id + '\'' + - ", body='" + body + '\'' + - ", messageType='" + messageType + '\'' + - ", createdAt=" + createdAt + - ", user=" + user + - "} " + super.toString(); - } - -} diff --git a/intercom-java/src/main/java/io/intercom/api/UserReply.java b/intercom-java/src/main/java/io/intercom/api/UserReply.java deleted file mode 100644 index 315e1c8b..00000000 --- a/intercom-java/src/main/java/io/intercom/api/UserReply.java +++ /dev/null @@ -1,64 +0,0 @@ -package io.intercom.api; - - -import com.fasterxml.jackson.annotation.JsonIgnoreProperties; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; - - -@SuppressWarnings("UnusedDeclaration") -@JsonIgnoreProperties(ignoreUnknown = true) -@JsonInclude(JsonInclude.Include.NON_EMPTY) -public class UserReply extends Reply { - - @JsonIgnoreProperties(ignoreUnknown = true) - @JsonInclude(JsonInclude.Include.NON_EMPTY) - static class UserStringReply { - - private UserReply reply; - - public UserStringReply(UserReply reply) { - this.reply = reply; - } - - @JsonProperty("type") - public String getType() { - return reply.getType(); - } - - @SuppressWarnings("SameReturnValue") - @JsonProperty("message_type") - public String getMessageType() { - return "comment"; - } - - @JsonProperty("body") - public String getBody() { - return reply.getBody(); - } - - @JsonProperty("intercom_user_id") - public String getIntercomUserID() { - return reply.getFrom().getId(); - } - - @JsonProperty("user_id") - public String getUserID() { - return reply.getFrom().getUserId(); - } - - @JsonProperty("email") - public String getEmail() { - return reply.getFrom().getEmail(); - } - } - - public UserReply(User user) { - this.from = user; - } - - @Override - public String toString() { - return "UserReply{} " + super.toString(); - } -} diff --git a/intercom-java/src/test/java/io/intercom/api/ErrorCollectionTest.java b/intercom-java/src/test/java/io/intercom/api/ErrorCollectionTest.java deleted file mode 100644 index a6ae32b3..00000000 --- a/intercom-java/src/test/java/io/intercom/api/ErrorCollectionTest.java +++ /dev/null @@ -1,43 +0,0 @@ -package io.intercom.api; - -import com.fasterxml.jackson.databind.ObjectMapper; -import com.google.common.collect.Lists; -import org.junit.BeforeClass; -import org.junit.Test; - -import static org.junit.Assert.assertTrue; -import static org.junit.Assert.fail; - -public class ErrorCollectionTest { - - private static ObjectMapper mapper; - - @BeforeClass - public static void beforeClass() { - mapper = TestSupport.objectMapper(); - } - - @Test - public void load() throws Exception { - String json = TestSupport.load("errors.json"); - final ErrorCollection errors = mapper.readValue(json, ErrorCollection.class); - assertTrue(errors.getErrors().size() == 2); - } - - @Test - public void dontload() { - try { - new ErrorCollection(null); - fail(); - } catch (NullPointerException ignored) { - } - - try { - new ErrorCollection(Lists.newArrayList()); - fail(); - } catch (IllegalArgumentException ignored) { - } - - } - -} \ No newline at end of file diff --git a/intercom-java/src/test/java/io/intercom/api/EventTest.java b/intercom-java/src/test/java/io/intercom/api/EventTest.java deleted file mode 100644 index bd788b7c..00000000 --- a/intercom-java/src/test/java/io/intercom/api/EventTest.java +++ /dev/null @@ -1,96 +0,0 @@ -package io.intercom.api; - -import org.junit.Test; - -import static org.junit.Assert.assertTrue; -import static org.junit.Assert.fail; - -public class EventTest { - - @Test - public void testMissingUser() { - final Event event1 = new Event().setEventName("bought-hat"); - try { - Event.create(event1); - fail("an event with no user id or email should be invalid"); - } catch (InvalidException e) { - assertTrue(e.getFirstError() != null); - } - - final Event event2 = new Event() - .setEventName("bought-hat") - .setUserID("") - .putMetadata("invitee_email", "jayne@serenity.io"); - try { - Event.create(event2); - fail("an event with a blank user id should be invalid"); - } catch (InvalidException e) { - assertTrue(e.getFirstError() != null); - } - - final Event event3 = new Event().setEmail(""); - try { - Event.create(event3); - fail("an event with a blank email should be invalid"); - } catch (InvalidException e) { - assertTrue(e.getFirstError() != null); - } - - } - - @Test - public void testMissingEventName() { - Event event1 = new Event() - .setEmail("jayne@serenity.io"); - try { - Event.create(event1); - fail("an event with a blank name should be invalid"); - } catch (InvalidException e) { - assertTrue(e.getFirstError() != null); - - } - - Event event2 = new Event() - .setEmail("jayne@serenity.io") - .setEventName(""); - try { - Event.create(event2); - fail("an event with a blank name should be invalid"); - } catch (InvalidException e) { - assertTrue(e.getFirstError() != null); - } - } - - @Test - public void testValid() { - Event event1 = new Event() - .setEmail("jayne@serenity.io") - .setEventName("bought-hat"); - try { - Event.validateCreateEvent(event1); - } catch (InvalidException e) { - fail("an event with an email and a name should be valid"); - } - - Event event2 = new Event() - .setUserID("1") - .setEventName("bought-hat"); - try { - Event.validateCreateEvent(event2); - } catch (InvalidException e) { - fail("an event with a user id and a name should be valid"); - } - - Event event3 = new Event() - .setUserID("1") - .setEmail("jayne@serenity.io") - .setEventName("bought-hat"); - try { - Event.validateCreateEvent(event3); - } catch (InvalidException e) { - fail("an event with a user id, email and a name should be valid"); - } - } - - -} \ No newline at end of file diff --git a/intercom-java/src/test/java/io/intercom/api/IntercomExceptionTest.java b/intercom-java/src/test/java/io/intercom/api/IntercomExceptionTest.java deleted file mode 100644 index 6ed41983..00000000 --- a/intercom-java/src/test/java/io/intercom/api/IntercomExceptionTest.java +++ /dev/null @@ -1,32 +0,0 @@ -package io.intercom.api; - -import com.google.common.collect.Lists; -import org.junit.Test; - -import static org.junit.Assert.*; - -public class IntercomExceptionTest { - - @Test - public void testNullCollection() { - assertEquals("Could not read error message from server", IntercomException.getMessage(null)); - } - - @Test - public void testBlankCollection() { - ErrorCollection ec = new ErrorCollection(); - assertEquals("Could not read error message from server", IntercomException.getMessage(ec)); - } - - @Test - public void testEmptyCollection() { - try { - new ErrorCollection(Lists.newArrayList()); - fail(); - } catch (IllegalArgumentException e) { - } - final ErrorCollection ec = new ErrorCollection(Lists.newArrayList(new Error())); - assertEquals("Could not read error message from server", IntercomException.getMessage(ec)); - } - -} \ No newline at end of file diff --git a/intercom-java/src/test/java/io/intercom/api/NoteTest.java b/intercom-java/src/test/java/io/intercom/api/NoteTest.java deleted file mode 100644 index ed055027..00000000 --- a/intercom-java/src/test/java/io/intercom/api/NoteTest.java +++ /dev/null @@ -1,61 +0,0 @@ -package io.intercom.api; - -import com.fasterxml.jackson.databind.ObjectMapper; -import org.junit.BeforeClass; -import org.junit.Test; - -import java.io.ByteArrayOutputStream; - -import static io.intercom.api.TestSupport.load; -import static org.junit.Assert.assertEquals; - -public class NoteTest { - - private static ObjectMapper mapper; - - @BeforeClass - public static void beforeClass() { - mapper = TestSupport.objectMapper(); - } - - @Test - public void TestSerdes() throws Exception { - String json = load("note.json"); - final Note note = mapper.readValue(json, Note.class); - assertEquals("16", note.getId()); - assertEquals(1389913941L, note.getCreatedAt()); - assertEquals("

Text for my note

", note.getBody()); - - final Author author = note.getAuthor(); - assertEquals(true, author.isAdmin()); - assertEquals("21", author.getId()); - assertEquals("Jayne Cobb", author.getName()); - assertEquals("jayne@serenity.io", author.getEmail()); - - final User user = note.getUser(); - assertEquals("user", user.getType()); - assertEquals("5310d8e8598c9a0b24000005", user.getId()); - - - final ByteArrayOutputStream baos = new ByteArrayOutputStream(); - mapper.writeValue(baos, note); - - final String json1 = baos.toString(); - final Note note1 = mapper.readValue(json, Note.class); - assertEquals("16", note1.getId()); - assertEquals(1389913941L, note1.getCreatedAt()); - assertEquals("

Text for my note

", note1.getBody()); - - final Author author1 = note1.getAuthor(); - assertEquals(true, author1.isAdmin()); - assertEquals("21", author1.getId()); - assertEquals("Jayne Cobb", author1.getName()); - assertEquals("jayne@serenity.io", author1.getEmail()); - - final User user1 = note1.getUser(); - assertEquals("user", user1.getType()); - assertEquals("5310d8e8598c9a0b24000005", user1.getId()); - - assertEquals(note, note1); - } -} \ No newline at end of file diff --git a/intercom-java/src/test/java/io/intercom/api/SegmentTest.java b/intercom-java/src/test/java/io/intercom/api/SegmentTest.java deleted file mode 100644 index 29c12cb1..00000000 --- a/intercom-java/src/test/java/io/intercom/api/SegmentTest.java +++ /dev/null @@ -1,45 +0,0 @@ -package io.intercom.api; - -import com.fasterxml.jackson.databind.ObjectMapper; -import org.junit.BeforeClass; -import org.junit.Test; - -import java.io.ByteArrayOutputStream; - -import static io.intercom.api.TestSupport.load; -import static org.junit.Assert.assertEquals; - -public class SegmentTest { - - private static ObjectMapper mapper; - - @BeforeClass - public static void beforeClass() { - mapper = TestSupport.objectMapper(); - } - - @Test - public void TestSerdes() throws Exception { - String json = load("segment.json"); - final Segment segment = mapper.readValue(json, Segment.class); - assertEquals(1392734388L, segment.getCreatedAt()); - assertEquals(1392734398L, segment.getUpdatedAt()); - assertEquals("segment-name", segment.getName()); - assertEquals("segment", segment.getType()); - assertEquals("3142", segment.getId()); - - final ByteArrayOutputStream baos = new ByteArrayOutputStream(); - mapper.writeValue(baos, segment); - - final String json1 = baos.toString(); - final Segment segment1 = mapper.readValue(json1, Segment.class); - assertEquals(1392734388L, segment1.getCreatedAt()); - assertEquals(1392734398L, segment1.getUpdatedAt()); - assertEquals("segment-name", segment1.getName()); - assertEquals("segment", segment1.getType()); - assertEquals("3142", segment1.getId()); - - assertEquals(segment, segment1); - } - -} \ No newline at end of file diff --git a/intercom-java/src/test/java/io/intercom/api/TagTest.java b/intercom-java/src/test/java/io/intercom/api/TagTest.java deleted file mode 100644 index bccb7c61..00000000 --- a/intercom-java/src/test/java/io/intercom/api/TagTest.java +++ /dev/null @@ -1,127 +0,0 @@ -package io.intercom.api; - -import com.fasterxml.jackson.databind.ObjectMapper; -import com.google.common.collect.Lists; -import org.junit.BeforeClass; -import org.junit.Test; - -import java.io.ByteArrayOutputStream; -import java.util.List; -import java.util.Map; - -import static io.intercom.api.TestSupport.load; -import static org.junit.Assert.assertEquals; -import static org.junit.Assert.assertTrue; - -public class TagTest { - - private static ObjectMapper mapper; - - @BeforeClass - public static void beforeClass() { - mapper = TestSupport.objectMapper(); - } - - @Test - public void testTagUsers() throws Exception { - String json = load("tag.json"); - final Tag tag = mapper.readValue(json, Tag.class); - - final User user1 = new User().setEmail("wash@serenity.io").untag(); - final User user2 = new User().setUserId("22"); - final User user3 = new User().setId("3434"); - final User user4 = new User().setEmail("malcolm@serenity.io"); - final User user5 = new User().setUserId("23"); - final User user6 = new User().setId("3435"); - final UserCollection uc = new UserCollection(Lists.newArrayList(user1, user2, user3, user4, user5, user6)); - final Tag.TaggableCollection taggableCollection = Tag.createTagTypedCollection(tag, uc); - final List> users = taggableCollection.getUsers(); - - int match = 0; - for (Map user : users) { - if (user.containsKey("id") && user.get("id").equals("3434")) { - match += 1; - } - if (user.containsKey("email") && user.get("email").equals("wash@serenity.io")) { - match += 1; - assertTrue(user.containsKey("untag") && user.get("untag") == Boolean.TRUE); - } - if (user.containsKey("user_id") && user.get("user_id").equals("22")) { - match += 1; - } - if (user.containsKey("id") && user.get("id").equals("3435")) { - match += 1; - } - if (user.containsKey("email") && user.get("email").equals("malcolm@serenity.io")) { - match += 1; - } - if (user.containsKey("user_id") && user.get("user_id").equals("23")) { - match += 1; - } - } - assertEquals(6, match); - } - - @Test - public void testTagCompanies() throws Exception { - String json = load("tag.json"); - final Tag tag = mapper.readValue(json, Tag.class); - - final Company c1 = new Company().setCompanyID("c1").untag(); - final Company c2 = new Company().setName("name1"); - final Company c3 = new Company().setCompanyID("c3"); - final Company c4 = new Company().setName("name4"); - final Company c5 = new Company().setId("1"); - final Company c6 = new Company().setId("2"); - final CompanyCollection uc = new CompanyCollection(Lists.newArrayList(c1, c2, c3, c4, c5, c6)); - final Tag.TaggableCollection taggableCollection = Tag.createTagTypedCollection(tag, uc); - final List> companies = taggableCollection.getCompanies(); - int match = 0; - for (Map company : companies) { - if (company.containsKey("company_id") && company.get("company_id").equals("c1")) { - match += 1; - assertTrue(company.containsKey("untag") && company.get("untag") == Boolean.TRUE); - } - if (company.containsKey("name") && company.get("name").equals("name1")) { - match += 1; - } - if (company.containsKey("company_id") && company.get("company_id").equals("c3")) { - match += 1; - } - if (company.containsKey("name") && company.get("name").equals("name4")) { - match += 1; - } - if (company.containsKey("id") && company.get("id").equals("1")) { - match += 1; - } - if (company.containsKey("id") && company.get("id").equals("2")) { - match += 1; - } - } - assertEquals(6, match); - } - - @Test - public void TestSerdes() throws Exception { - String json = load("tag.json"); - final Tag tag = mapper.readValue(json, Tag.class); - assertEquals(1392734388L, tag.getCreatedAt()); - assertEquals(1392734398L, tag.getUpdatedAt()); - assertEquals("tag-name", tag.getName()); - assertEquals("tag", tag.getType()); - assertEquals("3142", tag.getId()); - - final ByteArrayOutputStream baos = new ByteArrayOutputStream(); - mapper.writeValue(baos, tag); - - final String json1 = baos.toString(); - final Tag tag1 = mapper.readValue(json1, Tag.class); - assertEquals(1392734388L, tag1.getCreatedAt()); - assertEquals(1392734398L, tag1.getUpdatedAt()); - assertEquals("tag-name", tag1.getName()); - assertEquals("tag", tag1.getType()); - assertEquals("3142", tag1.getId()); - - assertEquals(tag, tag1); - } -} \ No newline at end of file diff --git a/intercom-java/src/test/java/io/intercom/api/TestSupport.java b/intercom-java/src/test/java/io/intercom/api/TestSupport.java deleted file mode 100644 index a37e9d16..00000000 --- a/intercom-java/src/test/java/io/intercom/api/TestSupport.java +++ /dev/null @@ -1,19 +0,0 @@ -package io.intercom.api; - -import com.fasterxml.jackson.databind.ObjectMapper; -import com.google.common.base.Charsets; -import com.google.common.io.Resources; - -import java.io.IOException; - -public class TestSupport { - - public static String load(String name) throws IOException { - return Resources.toString(Resources.getResource(name), Charsets.UTF_8); - } - - public static ObjectMapper objectMapper() { - return MapperSupport.objectMapper(); - } - -} diff --git a/intercom-java/src/test/java/io/intercom/api/UriBuilderTest.java b/intercom-java/src/test/java/io/intercom/api/UriBuilderTest.java deleted file mode 100644 index ef2da6be..00000000 --- a/intercom-java/src/test/java/io/intercom/api/UriBuilderTest.java +++ /dev/null @@ -1,45 +0,0 @@ -package io.intercom.api; - -import com.google.common.collect.Maps; -import org.junit.Test; - -import java.net.URI; -import java.util.HashMap; - -import static org.junit.Assert.assertEquals; - -public class UriBuilderTest { - - @Test - public void builder() { - final UriBuilder uriBuilder = UriBuilder.newBuilder("http://example.org"); - final HashMap map = Maps.newHashMap(); - map.put("c", "quux"); - map.put("b", "bar"); - map.put("a", "foo"); - URI uri = uriBuilder.query(map).build(); - assertEquals("http://example.org?a=foo&b=bar&c=quux", uri.toASCIIString()); - } - - @Test - public void buildPath() { - final UriBuilder uriBuilder = UriBuilder.newBuilder("http://example.org"); - final String s = uriBuilder.path("users").path("3142").build().toASCIIString(); - assertEquals("http://example.org/users/3142", s); - } - - - @Test - public void buildPathMix() { - final UriBuilder uriBuilder = UriBuilder.newBuilder("http://example.org"); - final HashMap map = Maps.newHashMap(); - map.put("c", "quu x"); // check we're encoding ws as '%20' and not '+' - map.put("b", "bar"); - map.put("a", "foo"); - // check that adding params before paths works - final String s = uriBuilder.query(map).path("users").path("3142").buildString(); - assertEquals("http://example.org/users/3142?a=foo&b=bar&c=quu%20x", s); - } - - -} \ No newline at end of file diff --git a/intercom-java/src/test/java/io/intercom/api/UserTest.java b/intercom-java/src/test/java/io/intercom/api/UserTest.java deleted file mode 100644 index 9aefb4c0..00000000 --- a/intercom-java/src/test/java/io/intercom/api/UserTest.java +++ /dev/null @@ -1,151 +0,0 @@ -package io.intercom.api; - -import com.fasterxml.jackson.databind.ObjectMapper; -import org.junit.BeforeClass; -import org.junit.Test; - -import java.util.List; -import java.util.Map; - -import static io.intercom.api.TestSupport.load; -import static org.junit.Assert.assertEquals; -import static org.junit.Assert.assertTrue; - -public class UserTest { - - private static ObjectMapper mapper; - - @BeforeClass - public static void beforeClass() { - mapper = MapperSupport.objectMapper(); - } - - @Test - public void TestUserUpdate() throws Exception { - - final long now = System.currentTimeMillis() / 1000; - final User user = new User() - .setEmail("wash@serenity.io") - .setUserId("22") - .setRemoteCreatedAt(now) - .setName("Wash") - .setUnsubscribedFromEmails(true) - .setUpdateLastRequestAt(true) - .setNewSession(true) - .setUserAgentData("user-agent"); - - final User.UserUpdate userUpdate = User.UserUpdate.buildFrom(user); - - assertEquals("wash@serenity.io", userUpdate.getEmail()); - assertEquals("22", userUpdate.getUserId()); - assertEquals(now, userUpdate.getRemoteCreatedAt()); - assertEquals("Wash", userUpdate.getName()); - assertEquals(true, userUpdate.getUnsubscribedFromEmails()); - assertEquals(true, userUpdate.isUpdateLastRequestAt()); - assertEquals(true, userUpdate.isNewSession()); - assertEquals("user-agent", userUpdate.getLastSeenUserAgent()); - } - - @Test - public void TestUserSerdesNullAndNotEmpty() throws Exception { - final User user = new User(); - user.setEmail("a@b.com"); - user.setUserId("1"); - final String json = mapper.writeValueAsString(user); - final Map map = mapper.readValue(json, Map.class); - assertTrue(map.size() == 2); - assertTrue(map.containsKey("email")); - assertTrue(map.containsKey("user_id")); - } - - @Test - public void TestUserSerdesTrip() throws Exception { - String json = load("user.json"); - final User user = mapper.readValue(json, User.class); - final String json1 = mapper.writeValueAsString(user); - final User user1 = mapper.readValue(json1, User.class); - assertTrue(user.equals(user1)); - } - - @Test - public void TestCustomAttributeSerdesTrip() throws Exception { - String json = load("user.json"); - final User user = mapper.readValue(json, User.class); - final String json1 = mapper.writeValueAsString(user); - final User user1 = mapper.readValue(json1, User.class); - assertEquals(user.getCustomAttributes(), user1.getCustomAttributes()); - } - - @Test - public void TestSerdes() throws Exception { - String json = load("user.json"); - final User user = mapper.readValue(json, User.class); - assertEquals("user", user.getType()); - assertEquals("530370b477ad7120001d", user.getId()); - assertEquals("25", user.getUserId()); - assertEquals("wash@serenity.io", user.getEmail()); - assertEquals("Hoban Washburne", user.getName()); - assertEquals(0, user.getSessionCount()); - assertEquals("1.2.3.4", user.getLastSeenIp()); - assertEquals(Boolean.FALSE, user.getUnsubscribedFromEmails()); - assertEquals("Mozilla/5.0 (Macintosh; Intel Mac OS X 10.9", user.getUserAgentData()); - assertEquals(1397574667L, user.getLastRequestAt()); - assertEquals(1392731331L, user.getRemoteCreatedAt()); - assertEquals(1392734388L, user.getCreatedAt()); - assertEquals(1392734388L, user.getUpdatedAt()); - - final SegmentCollection segmentCollection = user.getSegmentCollection(); - assertEquals("segment.list", segmentCollection.getType()); - final List items = segmentCollection.getPage(); - final Segment segment = items.get(0); - assertEquals("segment", segment.getType()); - assertEquals("5310d8e7598c9a0b24000002", segment.getId()); - - - @SuppressWarnings("UnusedDeclaration") - final CompanyCollection companyCollection = user.getCompanyCollection(); - - final Map customAttributes = user.getCustomAttributes(); - CustomAttribute customAttribute; - - customAttribute = customAttributes.get("truthy_typed"); - assertEquals(Boolean.class, customAttribute.getValueClass()); - assertEquals(Boolean.TRUE, customAttribute.getValue()); - assertEquals(Boolean.TRUE, customAttribute.booleanValue()); - assertEquals("truthy_typed", customAttribute.getName()); - - customAttribute = customAttributes.get("floatly_typed"); - assertEquals(Double.class, customAttribute.getValueClass()); - assertEquals(155.5d, customAttribute.getValue()); - assertEquals(155.5d, customAttribute.doubleValue(), 0d); - assertEquals("floatly_typed", customAttribute.getName()); - - customAttribute = customAttributes.get("stringly_typed"); - assertEquals(String.class, customAttribute.getValueClass()); - assertEquals("data", customAttribute.getValue()); - assertEquals("data", customAttribute.textValue()); - assertEquals("stringly_typed", customAttribute.getName()); - - customAttribute = customAttributes.get("dately_typed_at"); - assertEquals(Long.class, customAttribute.getValueClass()); - assertEquals(1397574667L, customAttribute.getValue()); - assertEquals(1397574667L, customAttribute.longValue()); - assertEquals("dately_typed_at", customAttribute.getName()); - - customAttribute = customAttributes.get("longly_typed"); - assertEquals(Long.class, customAttribute.getValueClass()); - assertEquals(221397574667L, customAttribute.getValue()); - assertEquals(221397574667L, customAttribute.longValue()); - assertEquals("longly_typed", customAttribute.getName()); - - customAttribute = customAttributes.get("intly_typed"); - assertEquals(Integer.class, customAttribute.getValueClass()); - assertEquals(1, customAttribute.getValue()); - assertEquals(1, customAttribute.integerValue()); - assertEquals("intly_typed", customAttribute.getName()); - - // null values are not ignored - customAttribute = customAttributes.get("nully_typed"); - assertEquals(null, customAttribute); - } -} \ No newline at end of file diff --git a/intercom-java/src/test/resources/errors.json b/intercom-java/src/test/resources/errors.json deleted file mode 100644 index 2bea5c5b..00000000 --- a/intercom-java/src/test/resources/errors.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "type": "error.list", - "errors": [ - { - "code": "not_found", - "message": "No such user_id[314159]" - }, - { - "code": "not_found", - "message": "No such email[pi@example.org]" - } - ] -} \ No newline at end of file diff --git a/intercom-java/src/test/resources/note.json b/intercom-java/src/test/resources/note.json deleted file mode 100644 index 0d0dcbe7..00000000 --- a/intercom-java/src/test/resources/note.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "type": "note", - "id": "16", - "created_at": 1389913941, - "body": "

Text for my note

", - "author": { - "type": "admin", - "id": "21", - "name": "Jayne Cobb", - "email": "jayne@serenity.io", - "companies": [] - }, - "user": { - "type": "user", - "id": "5310d8e8598c9a0b24000005" - } -} \ No newline at end of file diff --git a/intercom-java/src/test/resources/segment.json b/intercom-java/src/test/resources/segment.json deleted file mode 100644 index ba530a85..00000000 --- a/intercom-java/src/test/resources/segment.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "type": "segment", - "id": "3142", - "name": "segment-name", - "created_at": 1392734388, - "updated_at": 1392734398 -} diff --git a/intercom-java/src/test/resources/tag.json b/intercom-java/src/test/resources/tag.json deleted file mode 100644 index d4672f09..00000000 --- a/intercom-java/src/test/resources/tag.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "type": "tag", - "id": "3142", - "name": "tag-name", - "created_at": 1392734388, - "updated_at": 1392734398 -} diff --git a/intercom-java/src/test/resources/user.json b/intercom-java/src/test/resources/user.json deleted file mode 100644 index eea5a049..00000000 --- a/intercom-java/src/test/resources/user.json +++ /dev/null @@ -1,75 +0,0 @@ -{ - "type": "user", - "id": "530370b477ad7120001d", - "user_id": "25", - "email": "wash@serenity.io", - "name": "Hoban Washburne", - "remote_created_at": 1392731331, - "updated_at": 1392734388, - "session_count": 0, - "last_seen_ip": "1.2.3.4", - "unsubscribed_from_emails": false, - "last_request_at": 1397574667, - "created_at": 1392734388, - "user_agent_data": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.9", - "custom_attributes": { - "truthy_typed": true, - "floatly_typed": 155.5, - "stringly_typed": "data", - "dately_typed_at": 1397574667, - "longly_typed": 221397574667, - "intly_typed": 1, - "nully_typed": null - }, - "avatar": { - "type": "avatar", - "image_url": "http://example.org/128Wash.jpg" - }, - "location_data": { - "type": "location_data", - "city_name": "Dublin", - "continent_code": "EU", - "country_code": "IRL", - "country_name": "Ireland", - "latitude": 53.159233, - "longitude": -6.723, - "postal_code": null, - "region_name": "Dublin", - "timezone": "Europe/Dublin" - }, - "social_profiles": { - "type": "social_profile.list", - "social_profiles": [ - { - "name": "Twitter", - "id": "1235d3213", - "username": "th1sland", - "url": "http://twitter.com/th1sland" - } - ] - }, - "companies": { - "type": "company.list", - "companies": [ - { - "id": "530370b477ad7120001e" - } - ] - }, - "segments": { - "type": "segment.list", - "segments": [ - { - "id": "5310d8e7598c9a0b24000002" - } - ] - }, - "tags": { - "type": "tag.list", - "tags": [ - { - "id": "202" - } - ] - } -} \ No newline at end of file diff --git a/reference.md b/reference.md new file mode 100644 index 00000000..ca17eb16 --- /dev/null +++ b/reference.md @@ -0,0 +1,22002 @@ +# Reference +## Admins +
client.admins.identify() -> Optional&lt;AdminWithApp&gt; +
+
+ +#### 📝 Description + +
+
+ +
+
+ + +You can view the currently authorised admin along with the embedded app object (a "workspace" in legacy terminology). + +> 🚧 Single Sign On +> +> If you are building a custom "Log in with Intercom" flow for your site, and you call the `/me` endpoint to identify the logged-in user, you should not accept any sign-ins from users with unverified email addresses as it poses a potential impersonation security risk. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.admins().identify(); +``` +
+
+
+
+ + +
+
+
+ +
client.admins.away(adminId, request) -> Optional&lt;Admin&gt; +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can set an Admin as away for the Inbox. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.admins().away( + ConfigureAwayAdminRequest + .builder() + .adminId(1) + .awayModeEnabled(true) + .awayModeReassign(true) + .awayStatusReasonId(12345) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**adminId:** `Integer` — The unique identifier of a given admin + +
+
+ +
+
+ +**awayModeEnabled:** `Boolean` — Set to "true" to change the status of the admin to away. + +
+
+ +
+
+ +**awayModeReassign:** `Boolean` — Set to "true" to assign any new conversation replies to your default inbox. + +
+
+ +
+
+ +**awayStatusReasonId:** `Optional` — The unique identifier of the away status reason + +
+
+
+
+ + +
+
+
+ +
client.admins.listAllActivityLogs() -> ActivityLogList +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can get a log of activities by all admins in an app. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.admins().listAllActivityLogs( + ListAllActivityLogsRequest + .builder() + .createdAtAfter("1677253093") + .createdAtBefore("1677861493") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**createdAtAfter:** `String` — The start date that you request data for. It must be formatted as a UNIX timestamp. + +
+
+ +
+
+ +**createdAtBefore:** `Optional` — The end date that you request data for. It must be formatted as a UNIX timestamp. + +
+
+
+
+ + +
+
+
+ +
client.admins.list() -> AdminList +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch a list of admins for a given workspace. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.admins().list(); +``` +
+
+
+
+ + +
+
+
+ +
client.admins.find(adminId) -> Optional&lt;Admin&gt; +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can retrieve the details of a single admin. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.admins().find( + FindAdminRequest + .builder() + .adminId(1) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**adminId:** `Integer` — The unique identifier of a given admin + +
+
+
+
+ + +
+
+
+ +## AI Content +
client.aiContent.listContentImportSources() -> ContentImportSourcesList +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can retrieve a list of all content import sources for a workspace. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.aiContent().listContentImportSources(); +``` +
+
+
+
+ + +
+
+
+ +
client.aiContent.createContentImportSource(request) -> ContentImportSource +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can create a new content import source by sending a POST request to this endpoint. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.aiContent().createContentImportSource( + CreateContentImportSourceRequest + .builder() + .url("https://www.example.com") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**syncBehavior:** `String` — If you intend to create or update External Pages via the API, this should be set to `api`. + +
+
+ +
+
+ +**status:** `Optional` — The status of the content import source. + +
+
+ +
+
+ +**url:** `String` — The URL of the content import source. + +
+
+
+
+ + +
+
+
+ +
client.aiContent.getContentImportSource(sourceId) -> ContentImportSource +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.aiContent().getContentImportSource( + GetContentImportSourceRequest + .builder() + .sourceId("source_id") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**sourceId:** `String` — The unique identifier for the content import source which is given by Intercom. + +
+
+
+
+ + +
+
+
+ +
client.aiContent.updateContentImportSource(sourceId, request) -> ContentImportSource +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can update an existing content import source. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.aiContent().updateContentImportSource( + UpdateContentImportSourceRequest + .builder() + .sourceId("source_id") + .syncBehavior(UpdateContentImportSourceRequestSyncBehavior.API) + .url("https://www.example.com") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**sourceId:** `String` — The unique identifier for the content import source which is given by Intercom. + +
+
+ +
+
+ +**syncBehavior:** `UpdateContentImportSourceRequestSyncBehavior` — If you intend to create or update External Pages via the API, this should be set to `api`. You can not change the value to or from api. + +
+
+ +
+
+ +**status:** `Optional` — The status of the content import source. + +
+
+ +
+
+ +**url:** `String` — The URL of the content import source. This may only be different from the existing value if the sync behavior is API. + +
+
+
+
+ + +
+
+
+ +
client.aiContent.deleteContentImportSource(sourceId) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can delete a content import source by making a DELETE request this endpoint. This will also delete all external pages that were imported from this source. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.aiContent().deleteContentImportSource( + DeleteContentImportSourceRequest + .builder() + .sourceId("source_id") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**sourceId:** `String` — The unique identifier for the content import source which is given by Intercom. + +
+
+
+
+ + +
+
+
+ +
client.aiContent.listExternalPages() -> ExternalPagesList +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can retrieve a list of all external pages for a workspace. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.aiContent().listExternalPages(); +``` +
+
+
+
+ + +
+
+
+ +
client.aiContent.createExternalPage(request) -> ExternalPage +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can create a new external page by sending a POST request to this endpoint. If an external page already exists with the specified source_id and external_id, it will be updated instead. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.aiContent().createExternalPage( + CreateExternalPageRequest + .builder() + .title("Test") + .html("

Test

") + .sourceId(44) + .externalId("abc1234") + .url("https://www.example.com") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**title:** `String` — The title of the external page. + +
+
+ +
+
+ +**html:** `String` — The body of the external page in HTML. + +
+
+ +
+
+ +**url:** `Optional` — The URL of the external page. This will be used by Fin to link end users to the page it based its answer on. When a URL is not present, Fin will not reference the source. + +
+
+ +
+
+ +**aiAgentAvailability:** `Optional` — Whether the external page should be used to answer questions by AI Agent. Will not default when updating an existing external page. + +
+
+ +
+
+ +**aiCopilotAvailability:** `Optional` — Whether the external page should be used to answer questions by AI Copilot. Will not default when updating an existing external page. + +
+
+ +
+
+ +**locale:** `String` — Always en + +
+
+ +
+
+ +**sourceId:** `Integer` — The unique identifier for the source of the external page which was given by Intercom. Every external page must be associated with a Content Import Source which represents the place it comes from and from which it inherits a default audience (configured in the UI). For a new source, make a POST request to the Content Import Source endpoint and an ID for the source will be returned in the response. + +
+
+ +
+
+ +**externalId:** `String` — The identifier for the external page which was given by the source. Must be unique for the source. + +
+
+
+
+ + +
+
+
+ +
client.aiContent.getExternalPage(pageId) -> ExternalPage +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can retrieve an external page. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.aiContent().getExternalPage( + GetExternalPageRequest + .builder() + .pageId("page_id") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**pageId:** `String` — The unique identifier for the external page which is given by Intercom. + +
+
+
+
+ + +
+
+
+ +
client.aiContent.updateExternalPage(pageId, request) -> ExternalPage +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can update an existing external page (if it was created via the API). +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.aiContent().updateExternalPage( + UpdateExternalPageRequest + .builder() + .pageId("page_id") + .title("Test") + .html("

Test

") + .url("https://www.example.com") + .sourceId(47) + .externalId("5678") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**pageId:** `String` — The unique identifier for the external page which is given by Intercom. + +
+
+ +
+
+ +**title:** `String` — The title of the external page. + +
+
+ +
+
+ +**html:** `String` — The body of the external page in HTML. + +
+
+ +
+
+ +**url:** `String` — The URL of the external page. This will be used by Fin to link end users to the page it based its answer on. + +
+
+ +
+
+ +**finAvailability:** `Optional` — Whether the external page should be used to answer questions by Fin. + +
+
+ +
+
+ +**locale:** `String` — Always en + +
+
+ +
+
+ +**sourceId:** `Integer` — The unique identifier for the source of the external page which was given by Intercom. Every external page must be associated with a Content Import Source which represents the place it comes from and from which it inherits a default audience (configured in the UI). For a new source, make a POST request to the Content Import Source endpoint and an ID for the source will be returned in the response. + +
+
+ +
+
+ +**externalId:** `Optional` — The identifier for the external page which was given by the source. Must be unique for the source. + +
+
+
+
+ + +
+
+
+ +
client.aiContent.deleteExternalPage(pageId) -> ExternalPage +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Sending a DELETE request for an external page will remove it from the content library UI and from being used for AI answers. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.aiContent().deleteExternalPage( + DeleteExternalPageRequest + .builder() + .pageId("page_id") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**pageId:** `String` — The unique identifier for the external page which is given by Intercom. + +
+
+
+
+ + +
+
+
+ +## Articles +
client.articles.list() -> SyncPagingIterable&lt;ArticleListItem&gt; +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch a list of all articles by making a GET request to `https://api.intercom.io/articles`. + +> 📘 How are the articles sorted and ordered? +> +> Articles will be returned in descending order on the `updated_at` attribute. This means if you need to iterate through results then we'll show the most recently updated articles first. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.articles().list( + ListArticlesRequest + .builder() + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**page:** `Optional` — The page of results to fetch. Defaults to first page + +
+
+ +
+
+ +**perPage:** `Optional` — How many results to display per page. Defaults to 15 + +
+
+
+
+ + +
+
+
+ +
client.articles.create(request) -> Article +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can create a new article by making a POST request to `https://api.intercom.io/articles`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.articles().create( + Optional.of( + CreateArticleRequest + .builder() + .title("Thanks for everything") + .authorId(991267497) + .description("Description of the Article") + .body("Body of the Article") + .state(CreateArticleRequestState.PUBLISHED) + .parentId(145) + .parentType(CreateArticleRequestParentType.COLLECTION) + .translatedContent( + ArticleTranslatedContent + .builder() + .fr( + ArticleContent + .builder() + .title("Merci pour tout") + .description("Description de l'article") + .body("Corps de l'article") + .authorId(991267497) + .state(ArticleContentState.PUBLISHED) + .build() + ) + .build() + ) + .build() + ) +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Optional` + +
+
+
+
+ + +
+
+
+ +
client.articles.find(articleId) -> Article +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch the details of a single article by making a GET request to `https://api.intercom.io/articles/`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.articles().find( + FindArticleRequest + .builder() + .articleId(1) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**articleId:** `Integer` — The unique identifier for the article which is given by Intercom. + +
+
+
+
+ + +
+
+
+ +
client.articles.update(articleId, request) -> Article +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can update the details of a single article by making a PUT request to `https://api.intercom.io/articles/`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.articles().update( + UpdateArticleRequest + .builder() + .articleId(1) + .title("Christmas is here!") + .body("

New gifts in store for the jolly season

") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**articleId:** `Integer` — The unique identifier for the article which is given by Intercom. + +
+
+ +
+
+ +**title:** `Optional` — The title of the article.For multilingual articles, this will be the title of the default language's content. + +
+
+ +
+
+ +**description:** `Optional` — The description of the article. For multilingual articles, this will be the description of the default language's content. + +
+
+ +
+
+ +**body:** `Optional` — The content of the article. For multilingual articles, this will be the body of the default language's content. + +
+
+ +
+
+ +**authorId:** `Optional` — The id of the author of the article. For multilingual articles, this will be the id of the author of the default language's content. Must be a teammate on the help center's workspace. + +
+
+ +
+
+ +**state:** `Optional` — Whether the article will be `published` or will be a `draft`. Defaults to draft. For multilingual articles, this will be the state of the default language's content. + +
+
+ +
+
+ +**parentId:** `Optional` — The id of the article's parent collection or section. An article without this field stands alone. + +
+
+ +
+
+ +**parentType:** `Optional` — The type of parent, which can either be a `collection` or `section`. + +
+
+ +
+
+ +**translatedContent:** `Optional` + +
+
+
+
+ + +
+
+
+ +
client.articles.delete(articleId) -> DeletedArticleObject +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can delete a single article by making a DELETE request to `https://api.intercom.io/articles/`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.articles().delete( + DeleteArticleRequest + .builder() + .articleId(1) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**articleId:** `Integer` — The unique identifier for the article which is given by Intercom. + +
+
+
+
+ + +
+
+
+ +
client.articles.search() -> ArticleSearchResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can search for articles by making a GET request to `https://api.intercom.io/articles/search`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.articles().search( + SearchArticlesRequest + .builder() + .phrase("Getting started") + .state("published") + .helpCenterId(1) + .highlight(true) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**phrase:** `Optional` — The phrase within your articles to search for. + +
+
+ +
+
+ +**state:** `Optional` — The state of the Articles returned. One of `published`, `draft` or `all`. + +
+
+ +
+
+ +**helpCenterId:** `Optional` — The ID of the Help Center to search in. + +
+
+ +
+
+ +**highlight:** `Optional` — Return a highlighted version of the matching content within your articles. Refer to the response schema for more details. + +
+
+
+
+ + +
+
+
+ +## Away Status Reasons +
client.awayStatusReasons.listAwayStatusReasons() -> List&lt;AwayStatusReason&gt; +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns a list of all away status reasons configured for the workspace, including deleted ones. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.awayStatusReasons().listAwayStatusReasons(); +``` +
+
+
+
+ + +
+
+
+ +## Export +
client.export.enqueueANewReportingDataExportJob(request) -> PostExportReportingDataEnqueueResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.export().enqueueANewReportingDataExportJob( + PostExportReportingDataEnqueueRequest + .builder() + .datasetId("conversation") + .startTime(1717490000L) + .endTime(1717510000L) + .attributeIds( + Arrays.asList("conversation_id", "conversation_started_at") + ) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**datasetId:** `String` + +
+
+ +
+
+ +**attributeIds:** `List` + +
+
+ +
+
+ +**startTime:** `Long` + +
+
+ +
+
+ +**endTime:** `Long` + +
+
+
+
+ + +
+
+
+ +
client.export.listAvailableDatasetsAndAttributes() -> GetExportReportingDataGetDatasetsResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.export().listAvailableDatasetsAndAttributes(); +``` +
+
+
+
+ + +
+
+
+ +## Data Export +
client.dataExport.exportReportingData(jobIdentifier) -> DataExportExportReportingDataResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.dataExport().exportReportingData( + ExportReportingDataRequest + .builder() + .jobIdentifier("job_identifier") + .appId("app_id") + .clientId("client_id") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**jobIdentifier:** `String` — Unique identifier of the job. + +
+
+ +
+
+ +**appId:** `String` — The Intercom defined code of the workspace the company is associated to. + +
+
+ +
+
+ +**clientId:** `String` + +
+
+
+
+ + +
+
+
+ +
client.dataExport.downloadReportingDataExport(jobIdentifier) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Download the data from a completed reporting data export job. + +> Octet header required +> +> You will have to specify the header Accept: `application/octet-stream` when hitting this endpoint. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.dataExport().downloadReportingDataExport( + DownloadReportingDataExportRequest + .builder() + .jobIdentifier("job_identifier") + .appId("app_id") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**jobIdentifier:** `String` + +
+
+ +
+
+ +**appId:** `String` + +
+
+ +
+
+ +**accept:** `String` — Required header for downloading the export file + +
+
+
+
+ + +
+
+
+ +
client.dataExport.create(request) -> DataExport +
+
+ +#### 📝 Description + +
+
+ +
+
+ +To create your export job, you need to send a `POST` request to the export endpoint `https://api.intercom.io/export/content/data`. + +The only parameters you need to provide are the range of dates that you want exported. + +>🚧 Limit of one active job +> +> You can only have one active job per workspace. You will receive a HTTP status code of 429 with the message Exceeded rate limit of 1 pending message data export jobs if you attempt to create a second concurrent job. + +>❗️ Updated_at not included +> +> It should be noted that the timeframe only includes messages sent during the time period and not messages that were only updated during this period. For example, if a message was updated yesterday but sent two days ago, you would need to set the created_at_after date before the message was sent to include that in your retrieval job. + +>📘 Date ranges are inclusive +> +> Requesting data for 2018-06-01 until 2018-06-30 will get all data for those days including those specified - e.g. 2018-06-01 00:00:00 until 2018-06-30 23:59:99. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.dataExport().create( + CreateDataExportRequest + .builder() + .createdAtAfter(1734519776) + .createdAtBefore(1734537776) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**createdAtAfter:** `Integer` — The start date that you request data for. It must be formatted as a unix timestamp. + +
+
+ +
+
+ +**createdAtBefore:** `Integer` — The end date that you request data for. It must be formatted as a unix timestamp. + +
+
+
+
+ + +
+
+
+ +
client.dataExport.find(jobIdentifier) -> DataExport +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can view the status of your job by sending a `GET` request to the URL +`https://api.intercom.io/export/content/data/{job_identifier}` - the `{job_identifier}` is the value returned in the response when you first created the export job. More on it can be seen in the Export Job Model. + +> 🚧 Jobs expire after two days +> All jobs that have completed processing (and are thus available to download from the provided URL) will have an expiry limit of two days from when the export ob completed. After this, the data will no longer be available. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.dataExport().find( + FindDataExportRequest + .builder() + .jobIdentifier("job_identifier") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**jobIdentifier:** `String` — job_identifier + +
+
+
+
+ + +
+
+
+ +
client.dataExport.cancel(jobIdentifier) -> DataExport +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can cancel your job +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.dataExport().cancel( + CancelDataExportRequest + .builder() + .jobIdentifier("job_identifier") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**jobIdentifier:** `String` — job_identifier + +
+
+
+
+ + +
+
+
+ +
client.dataExport.download(jobIdentifier) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +When a job has a status of complete, and thus a filled download_url, you can download your data by hitting that provided URL, formatted like so: https://api.intercom.io/download/content/data/xyz1234. + +Your exported message data will be streamed continuously back down to you in a gzipped CSV format. + +> 📘 Octet header required +> +> You will have to specify the header Accept: `application/octet-stream` when hitting this endpoint. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.dataExport().download( + DownloadDataExportRequest + .builder() + .jobIdentifier("job_identifier") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**jobIdentifier:** `String` — job_identifier + +
+
+
+
+ + +
+
+
+ +## HelpCenters +
client.helpCenters.find(helpCenterId) -> HelpCenter +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch the details of a single Help Center by making a GET request to `https://api.intercom.io/help_center/help_center/`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.helpCenters().find( + FindHelpCenterRequest + .builder() + .helpCenterId(1) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**helpCenterId:** `Integer` — The unique identifier for the collection which is given by Intercom. + +
+
+
+
+ + +
+
+
+ +
client.helpCenters.list() -> SyncPagingIterable&lt;HelpCenter&gt; +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can list all Help Centers by making a GET request to `https://api.intercom.io/help_center/help_centers`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.helpCenters().list( + ListHelpCentersRequest + .builder() + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**page:** `Optional` — The page of results to fetch. Defaults to first page + +
+
+ +
+
+ +**perPage:** `Optional` — How many results to display per page. Defaults to 15 + +
+
+
+
+ + +
+
+
+ +## Internal Articles +
client.internalArticles.listInternalArticles() -> InternalArticleList +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch a list of all internal articles by making a GET request to `https://api.intercom.io/internal_articles`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.internalArticles().listInternalArticles(); +``` +
+
+
+
+ + +
+
+
+ +
client.internalArticles.createInternalArticle(request) -> InternalArticleListItem +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can create a new internal article by making a POST request to `https://api.intercom.io/internal_articles`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.internalArticles().createInternalArticle( + Optional.of( + CreateInternalArticleRequest + .builder() + .title("Thanks for everything") + .authorId(991266252) + .ownerId(991266252) + .body("Body of the Article") + .build() + ) +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Optional` + +
+
+
+
+ + +
+
+
+ +
client.internalArticles.retrieveInternalArticle(internalArticleId) -> InternalArticleListItem +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch the details of a single internal article by making a GET request to `https://api.intercom.io/internal_articles/`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.internalArticles().retrieveInternalArticle( + RetrieveInternalArticleRequest + .builder() + .internalArticleId(1) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**internalArticleId:** `Integer` — The unique identifier for the article which is given by Intercom. + +
+
+
+
+ + +
+
+
+ +
client.internalArticles.updateInternalArticle(internalArticleId, request) -> InternalArticleListItem +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can update the details of a single internal article by making a PUT request to `https://api.intercom.io/internal_articles/`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.internalArticles().updateInternalArticle( + UpdateInternalArticleRequestBody + .builder() + .internalArticleId(1) + .title("Christmas is here!") + .body("

New gifts in store for the jolly season

") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**internalArticleId:** `Integer` — The unique identifier for the internal article which is given by Intercom. + +
+
+ +
+
+ +**title:** `Optional` — The title of the article. + +
+
+ +
+
+ +**body:** `Optional` — The content of the article. + +
+
+ +
+
+ +**authorId:** `Optional` — The id of the author of the article. + +
+
+ +
+
+ +**ownerId:** `Optional` — The id of the author of the article. + +
+
+
+
+ + +
+
+
+ +
client.internalArticles.deleteInternalArticle(internalArticleId) -> DeletedInternalArticleObject +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can delete a single internal article by making a DELETE request to `https://api.intercom.io/internal_articles/`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.internalArticles().deleteInternalArticle( + DeleteInternalArticleRequest + .builder() + .internalArticleId(1) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**internalArticleId:** `Integer` — The unique identifier for the internal article which is given by Intercom. + +
+
+
+
+ + +
+
+
+ +
client.internalArticles.searchInternalArticles() -> InternalArticleSearchResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can search for internal articles by making a GET request to `https://api.intercom.io/internal_articles/search`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.internalArticles().searchInternalArticles( + SearchInternalArticlesRequest + .builder() + .folderId("folder_id") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**folderId:** `Optional` — The ID of the folder to search in. + +
+
+
+
+ + +
+
+
+ +## IP Allowlist +
client.ipAllowlist.getIpAllowlist() -> IpAllowlist +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieve the current IP allowlist configuration for the workspace. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +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 + +
+
+ +
+
+ +```java +client.ipAllowlist().updateIpAllowlist( + IpAllowlist + .builder() + .enabled(true) + .ipAllowlist( + Optional.of( + Arrays.asList("192.168.1.0/24", "10.0.0.1") + ) + ) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `IpAllowlist` + +
+
+
+
+ + +
+
+
+ +## Companies +
client.companies.retrieve() -> CompaniesRetrieveResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch a single company by passing in `company_id` or `name`. + + `https://api.intercom.io/companies?name={name}` + + `https://api.intercom.io/companies?company_id={company_id}` + +You can fetch all companies and filter by `segment_id` or `tag_id` as a query parameter. + + `https://api.intercom.io/companies?tag_id={tag_id}` + + `https://api.intercom.io/companies?segment_id={segment_id}` +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.companies().retrieve( + RetrieveCompanyRequest + .builder() + .name("my company") + .companyId("12345") + .tagId("678910") + .segmentId("98765") + .page(1) + .perPage(1) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**name:** `Optional` — The `name` of the company to filter by. + +
+
+ +
+
+ +**companyId:** `Optional` — The `company_id` of the company to filter by. + +
+
+ +
+
+ +**tagId:** `Optional` — The `tag_id` of the company to filter by. + +
+
+ +
+
+ +**segmentId:** `Optional` — The `segment_id` of the company to filter by. + +
+
+ +
+
+ +**page:** `Optional` — The page of results to fetch. Defaults to first page + +
+
+ +
+
+ +**perPage:** `Optional` — How many results to display per page. Defaults to 15 + +
+
+
+
+ + +
+
+
+ +
client.companies.createOrUpdate(request) -> Company +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can create or update a company. + +Companies will be only visible in Intercom when there is at least one associated user. + +Companies are looked up via `company_id` in a `POST` request, if not found via `company_id`, the new company will be created, if found, that company will be updated. + +{% admonition type="warning" name="Using `company_id`" %} + You can set a unique `company_id` value when creating a company. However, it is not possible to update `company_id`. Be sure to set a unique value once upon creation of the company. +{% /admonition %} +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.companies().createOrUpdate( + Optional.of( + CreateOrUpdateCompanyRequest + .builder() + .name("my company") + .companyId("company_remote_id") + .remoteCreatedAt(1374138000) + .build() + ) +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Optional` + +
+
+
+
+ + +
+
+
+ +
client.companies.find(companyId) -> Company +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch a single company. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.companies().find( + FindCompanyRequest + .builder() + .companyId("5f4d3c1c-7b1b-4d7d-a97e-6095715c6632") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**companyId:** `String` — The unique identifier for the company which is given by Intercom + +
+
+
+
+ + +
+
+
+ +
client.companies.update(companyId, request) -> Company +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can update a single company using the Intercom provisioned `id`. + +{% admonition type="warning" name="Using `company_id`" %} + When updating a company it is not possible to update `company_id`. This can only be set once upon creation of the company. +{% /admonition %} +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.companies().update( + UpdateCompanyRequest + .builder() + .companyId("5f4d3c1c-7b1b-4d7d-a97e-6095715c6632") + .body( + UpdateCompanyRequestBody + .builder() + .name("my company") + .website("http://www.mycompany.com/") + .build() + ) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**companyId:** `String` — The unique identifier for the company which is given by Intercom + +
+
+ +
+
+ +**request:** `Optional` + +
+
+
+
+ + +
+
+
+ +
client.companies.delete(companyId) -> DeletedCompanyObject +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can delete a single company. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.companies().delete( + DeleteCompanyRequest + .builder() + .companyId("5f4d3c1c-7b1b-4d7d-a97e-6095715c6632") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**companyId:** `String` — The unique identifier for the company which is given by Intercom + +
+
+
+
+ + +
+
+
+ +
client.companies.listAttachedContacts(companyId) -> CompanyAttachedContacts +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch a list of all contacts that belong to a company. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.companies().listAttachedContacts( + ListAttachedContactsRequest + .builder() + .companyId("5f4d3c1c-7b1b-4d7d-a97e-6095715c6632") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**companyId:** `String` — The unique identifier for the company which is given by Intercom + +
+
+
+
+ + +
+
+
+ +
client.companies.listAttachedSegments(companyId) -> CompanyAttachedSegments +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch a list of all segments that belong to a company. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.companies().listAttachedSegments( + ListSegmentsAttachedToCompanyRequest + .builder() + .companyId("5f4d3c1c-7b1b-4d7d-a97e-6095715c6632") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**companyId:** `String` — The unique identifier for the company which is given by Intercom + +
+
+
+
+ + +
+
+
+ +
client.companies.list() -> SyncPagingIterable&lt;Company&gt; +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can list companies. The company list is sorted by the `last_request_at` field and by default is ordered descending, most recently requested first. + +Note that the API does not include companies who have no associated users in list responses. + +When using the Companies endpoint and the pages object to iterate through the returned companies, there is a limit of 10,000 Companies that can be returned. If you need to list or iterate on more than 10,000 Companies, please use the [Scroll API](https://developers.intercom.com/reference#iterating-over-all-companies). +{% admonition type="warning" name="Pagination" %} + You can use pagination to limit the number of results returned. The default is `20` results per page. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis) for more details on how to use the `starting_after` param. +{% /admonition %} +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.companies().list( + ListCompaniesRequest + .builder() + .page(1) + .perPage(1) + .order("desc") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**page:** `Optional` — The page of results to fetch. Defaults to first page + +
+
+ +
+
+ +**perPage:** `Optional` — How many results to return per page. Defaults to 15 + +
+
+ +
+
+ +**order:** `Optional` — `asc` or `desc`. Return the companies in ascending or descending order. Defaults to desc + +
+
+
+
+ + +
+
+
+ +
client.companies.scroll() -> SyncPagingIterable&lt;Company&gt; +
+
+ +#### 📝 Description + +
+
+ +
+
+ + The `list all companies` functionality does not work well for huge datasets, and can result in errors and performance problems when paging deeply. The Scroll API provides an efficient mechanism for iterating over all companies in a dataset. + +- Each app can only have 1 scroll open at a time. You'll get an error message if you try to have more than one open per app. +- If the scroll isn't used for 1 minute, it expires and calls with that scroll param will fail +- If the end of the scroll is reached, "companies" will be empty and the scroll parameter will expire + +{% admonition type="info" name="Scroll Parameter" %} + You can get the first page of companies by simply sending a GET request to the scroll endpoint. + For subsequent requests you will need to use the scroll parameter from the response. +{% /admonition %} +{% admonition type="danger" name="Scroll network timeouts" %} + Since scroll is often used on large datasets network errors such as timeouts can be encountered. When this occurs you will see a HTTP 500 error with the following message: + "Request failed due to an internal network error. Please restart the scroll operation." + If this happens, you will need to restart your scroll query: It is not possible to continue from a specific point when using scroll. +{% /admonition %} +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.companies().scroll( + ScrollCompaniesRequest + .builder() + .scrollParam("scroll_param") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**scrollParam:** `Optional` — + +
+
+
+
+ + +
+
+
+ +
client.companies.attachContact(contactId, request) -> Company +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can attach a company to a single contact. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.companies().attachContact( + AttachContactToCompanyRequest + .builder() + .contactId("contact_id") + .companyId("6762f09a1bb69f9f2193bb34") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**contactId:** `String` — The unique identifier for the contact which is given by Intercom + +
+
+ +
+
+ +**companyId:** `String` — The unique identifier for the company which is given by Intercom + +
+
+
+
+ + +
+
+
+ +
client.companies.detachContact(contactId, companyId) -> Company +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can detach a company from a single contact. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.companies().detachContact( + DetachContactFromCompanyRequest + .builder() + .contactId("58a430d35458202d41b1e65b") + .companyId("58a430d35458202d41b1e65b") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**contactId:** `String` — The unique identifier for the contact which is given by Intercom + +
+
+ +
+
+ +**companyId:** `String` — The unique identifier for the company which is given by Intercom + +
+
+
+
+ + +
+
+
+ +## Contacts +
client.contacts.listAttachedCompanies(contactId) -> SyncPagingIterable&lt;Company&gt; +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch a list of companies that are associated to a contact. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.contacts().listAttachedCompanies( + ListAttachedCompaniesRequest + .builder() + .contactId("63a07ddf05a32042dffac965") + .page(1) + .perPage(1) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**contactId:** `String` — The unique identifier for the contact which is given by Intercom + +
+
+ +
+
+ +**page:** `Optional` — The page of results to fetch. Defaults to first page + +
+
+ +
+
+ +**perPage:** `Optional` — How many results to display per page. Defaults to 15 + +
+
+
+
+ + +
+
+
+ +
client.contacts.listAttachedSegments(contactId) -> ContactSegments +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch a list of segments that are associated to a contact. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.contacts().listAttachedSegments( + ListSegmentsAttachedToContactRequest + .builder() + .contactId("63a07ddf05a32042dffac965") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**contactId:** `String` — The unique identifier for the contact which is given by Intercom + +
+
+
+
+ + +
+
+
+ +
client.contacts.listAttachedSubscriptions(contactId) -> SubscriptionTypeList +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch a list of subscription types that are attached to a contact. These can be subscriptions that a user has 'opted-in' to or has 'opted-out' from, depending on the subscription type. +This will return a list of Subscription Type objects that the contact is associated with. + +The data property will show a combined list of: + + 1.Opt-out subscription types that the user has opted-out from. + 2.Opt-in subscription types that the user has opted-in to receiving. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.contacts().listAttachedSubscriptions( + ListAttachedSubscriptionsRequest + .builder() + .contactId("63a07ddf05a32042dffac965") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**contactId:** `String` — The unique identifier for the contact which is given by Intercom + +
+
+
+
+ + +
+
+
+ +
client.contacts.attachSubscription(contactId, request) -> SubscriptionType +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can add a specific subscription to a contact. In Intercom, we have two different subscription types based on user consent - opt-out and opt-in: + + 1.Attaching a contact to an opt-out subscription type will opt that user out from receiving messages related to that subscription type. + + 2.Attaching a contact to an opt-in subscription type will opt that user in to receiving messages related to that subscription type. + +This will return a subscription type model for the subscription type that was added to the contact. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.contacts().attachSubscription( + AttachSubscriptionToContactRequest + .builder() + .contactId("63a07ddf05a32042dffac965") + .subscriptionId("37846") + .consentType("opt_in") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**contactId:** `String` — The unique identifier for the contact which is given by Intercom + +
+
+ +
+
+ +**subscriptionId:** `String` — The unique identifier for the subscription which is given by Intercom + +
+
+ +
+
+ +**consentType:** `String` — The consent_type of a subscription, opt_out or opt_in. + +
+
+
+
+ + +
+
+
+ +
client.contacts.detachSubscription(contactId, subscriptionId) -> SubscriptionType +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can remove a specific subscription from a contact. This will return a subscription type model for the subscription type that was removed from the contact. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.contacts().detachSubscription( + DetachSubscriptionFromContactRequest + .builder() + .contactId("63a07ddf05a32042dffac965") + .subscriptionId("37846") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**contactId:** `String` — The unique identifier for the contact which is given by Intercom + +
+
+ +
+
+ +**subscriptionId:** `String` — The unique identifier for the subscription type which is given by Intercom + +
+
+
+
+ + +
+
+
+ +
client.contacts.listAttachedTags(contactId) -> TagList +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch a list of all tags that are attached to a specific contact. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.contacts().listAttachedTags( + ListTagsAttachedToContactRequest + .builder() + .contactId("63a07ddf05a32042dffac965") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**contactId:** `String` — The unique identifier for the contact which is given by Intercom + +
+
+
+
+ + +
+
+
+ +
client.contacts.find(contactId) -> ContactsFindResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch the details of a single contact. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.contacts().find( + FindContactRequest + .builder() + .contactId("63a07ddf05a32042dffac965") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**contactId:** `String` — contact_id + +
+
+
+
+ + +
+
+
+ +
client.contacts.update(contactId, request) -> ContactsUpdateResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can update an existing contact (ie. user or lead). + +{% admonition type="info" %} + This endpoint handles both **contact updates** and **custom object associations**. + + See _`update a contact with an association to a custom object instance`_ in the request/response examples to see the custom object association format. +{% /admonition %} +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.contacts().update( + UpdateContactRequest + .builder() + .contactId("63a07ddf05a32042dffac965") + .email("joebloggs@intercom.io") + .name("joe bloggs") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**contactId:** `String` — id + +
+
+ +
+
+ +**role:** `Optional` — The role of the contact. + +
+
+ +
+
+ +**externalId:** `Optional` — A unique identifier for the contact which is given to Intercom + +
+
+ +
+
+ +**email:** `Optional` — The contacts email + +
+
+ +
+
+ +**phone:** `Optional` — The contacts phone + +
+
+ +
+
+ +**name:** `Optional` — The contacts name + +
+
+ +
+
+ +**avatar:** `Optional` — An image URL containing the avatar of a contact + +
+
+ +
+
+ +**signedUpAt:** `Optional` — The time specified for when a contact signed up + +
+
+ +
+
+ +**lastSeenAt:** `Optional` — The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually) + +
+
+ +
+
+ +**ownerId:** `Optional` — The id of an admin that has been assigned account ownership of the contact + +
+
+ +
+
+ +**unsubscribedFromEmails:** `Optional` — Whether the contact is unsubscribed from emails + +
+
+ +
+
+ +**customAttributes:** `Optional>` — The custom attributes which are set for the contact + +
+
+
+
+ + +
+
+
+ +
client.contacts.delete(contactId) -> ContactDeleted +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can delete a single contact. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.contacts().delete( + DeleteContactRequest + .builder() + .contactId("contact_id") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**contactId:** `String` — contact_id + +
+
+
+
+ + +
+
+
+ +
client.contacts.mergeLeadInUser(request) -> ContactsMergeLeadInUserResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can merge a contact with a `role` of `lead` into a contact with a `role` of `user`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.contacts().mergeLeadInUser( + MergeContactsRequest + .builder() + .leadId("6762f0d51bb69f9f2193bb7f") + .contactId("6762f0d51bb69f9f2193bb80") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**leadId:** `Optional` — The unique identifier for the contact to merge away from. Must be a lead. + +
+
+ +
+
+ +**contactId:** `Optional` — The unique identifier for the contact to merge into. Must be a user. + +
+
+
+
+ + +
+
+
+ +
client.contacts.search(request) -> SyncPagingIterable&lt;Contact&gt; +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can search for multiple contacts by the value of their attributes in order to fetch exactly who you want. + +To search for contacts, you need to send a `POST` request to `https://api.intercom.io/contacts/search`. + +This will accept a query object in the body which will define your filters in order to search for contacts. + +{% admonition type="warning" name="Optimizing search queries" %} + Search queries can be complex, so optimizing them can help the performance of your search. + Use the `AND` and `OR` operators to combine multiple filters to get the exact results you need and utilize + pagination to limit the number of results returned. The default is `50` results per page. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#example-search-conversations-request) for more details on how to use the `starting_after` param. +{% /admonition %} +### Contact Creation Delay + +If a contact has recently been created, there is a possibility that it will not yet be available when searching. This means that it may not appear in the response. This delay can take a few minutes. If you need to be instantly notified it is recommended to use webhooks and iterate to see if they match your search filters. + +### Nesting & Limitations + +You can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4). +There are some limitations to the amount of multiple's there can be: +* There's a limit of max 2 nested filters +* There's a limit of max 15 filters for each AND or OR group + +### Searching for Timestamp Fields + +All timestamp fields (created_at, updated_at etc.) are indexed as Dates for Contact Search queries; Datetime queries are not currently supported. This means you can only query for timestamp fields by day - not hour, minute or second. +For example, if you search for all Contacts with a created_at value greater (>) than 1577869200 (the UNIX timestamp for January 1st, 2020 9:00 AM), that will be interpreted as 1577836800 (January 1st, 2020 12:00 AM). The search results will then include Contacts created from January 2nd, 2020 12:00 AM onwards. +If you'd like to get contacts created on January 1st, 2020 you should search with a created_at value equal (=) to 1577836800 (January 1st, 2020 12:00 AM). +This behaviour applies only to timestamps used in search queries. The search results will still contain the full UNIX timestamp and be sorted accordingly. + +### Accepted Fields + +Most key listed as part of the Contacts Model are searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as `created_at` accepts a date, the `value` cannot be a string such as `"foorbar"`). + +| Field | Type | +| ---------------------------------- | ------------------------------ | +| id | String | +| role | String
Accepts user or lead | +| name | String | +| avatar | String | +| owner_id | Integer | +| email | String | +| email_domain | String | +| phone | String | +| external_id | String | +| created_at | Date (UNIX Timestamp) | +| signed_up_at | Date (UNIX Timestamp) | +| updated_at | Date (UNIX Timestamp) | +| last_seen_at | Date (UNIX Timestamp) | +| last_contacted_at | Date (UNIX Timestamp) | +| last_replied_at | Date (UNIX Timestamp) | +| last_email_opened_at | Date (UNIX Timestamp) | +| last_email_clicked_at | Date (UNIX Timestamp) | +| language_override | String | +| browser | String | +| browser_language | String | +| os | String | +| location.country | String | +| location.region | String | +| location.city | String | +| unsubscribed_from_emails | Boolean | +| marked_email_as_spam | Boolean | +| has_hard_bounced | Boolean | +| ios_last_seen_at | Date (UNIX Timestamp) | +| ios_app_version | String | +| ios_device | String | +| ios_app_device | String | +| ios_os_version | String | +| ios_app_name | String | +| ios_sdk_version | String | +| android_last_seen_at | Date (UNIX Timestamp) | +| android_app_version | String | +| android_device | String | +| android_app_name | String | +| andoid_sdk_version | String | +| segment_id | String | +| tag_id | String | +| custom_attributes.{attribute_name} | String | + +### Accepted Operators + +{% admonition type="warning" name="Searching based on `created_at`" %} + You cannot use the `<=` or `>=` operators to search by `created_at`. +{% /admonition %} + +The table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string (`"="`). The operator has to be compatible with the field's type (eg. you cannot search with `>` for a given string value as it's only compatible for integer's and dates). + +| Operator | Valid Types | Description | +| :------- | :------------------------------- | :--------------------------------------------------------------- | +| = | All | Equals | +| != | All | Doesn't Equal | +| IN | All | In
Shortcut for `OR` queries
Values must be in Array | +| NIN | All | Not In
Shortcut for `OR !` queries
Values must be in Array | +| > | Integer
Date (UNIX Timestamp) | Greater than | +| < | Integer
Date (UNIX Timestamp) | Lower than | +| ~ | String | Contains | +| !~ | String | Doesn't Contain | +| ^ | String | Starts With | +| $ | String | Ends With | +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().contacts().searchContacts( + SearchRequest + .builder() + .query( + SearchRequestQuery.of( + SingleFilterSearchRequest + .builder() + .value( + SingleFilterSearchRequestValue.of() + ) + .build() + ) + ) + .pagination( + StartingAfterPaging + .builder() + .perPage(5) + .build() + ) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SearchRequest` + +
+
+
+
+ + +
+
+
+ +
client.contacts.list() -> SyncPagingIterable&lt;Contact&gt; +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch a list of all contacts (ie. users or leads) in your workspace. +{% admonition type="warning" name="Pagination" %} + You can use pagination to limit the number of results returned. The default is `50` results per page. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis) for more details on how to use the `starting_after` param. +{% /admonition %} +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.contacts().list( + ListContactsRequest + .builder() + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**page:** `Optional` — The page of results to fetch. Defaults to first page + +
+
+ +
+
+ +**perPage:** `Optional` — How many results to display per page. Defaults to 15 + +
+
+ +
+
+ +**startingAfter:** `Optional` — String used to get the next page of conversations. + +
+
+
+
+ + +
+
+
+ +
client.contacts.create(request) -> ContactsCreateResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can create a new contact (ie. user or lead). +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.contacts().create( + CreateContactRequest.of( + CreateContactRequestWithEmail + .builder() + .email("joebloggs@intercom.io") + .build() + ) +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `CreateContactRequest` + +
+
+
+
+ + +
+
+
+ +
client.contacts.showContactByExternalId(externalId) -> ShowContactByExternalIdResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch the details of a single contact by external ID. Note that this endpoint only supports users and not leads. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.contacts().showContactByExternalId( + ShowContactByExternalIdRequest + .builder() + .externalId("cdd29344-5e0c-4ef0-ac56-f9ba2979bc27") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**externalId:** `String` — The external ID of the user that you want to retrieve + +
+
+
+
+ + +
+
+
+ +
client.contacts.archive(contactId) -> ContactArchived +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can archive a single contact. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.contacts().archive( + ArchiveContactRequest + .builder() + .contactId("63a07ddf05a32042dffac965") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**contactId:** `String` — contact_id + +
+
+
+
+ + +
+
+
+ +
client.contacts.unarchive(contactId) -> ContactUnarchived +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can unarchive a single contact. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.contacts().unarchive( + UnarchiveContactRequest + .builder() + .contactId("63a07ddf05a32042dffac965") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**contactId:** `String` — contact_id + +
+
+
+
+ + +
+
+
+ +
client.contacts.blockContact(contactId) -> ContactBlocked +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Block a single contact.
**Note:** conversations of the contact will also be archived during the process.
More details in [FAQ How do I block Inbox spam?](https://www.intercom.com/help/en/articles/8838656-inbox-faqs) +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.contacts().blockContact( + BlockContactRequest + .builder() + .contactId("63a07ddf05a32042dffac965") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**contactId:** `String` — contact_id + +
+
+
+
+ + +
+
+
+ +## Notes +
client.notes.list(contactId) -> SyncPagingIterable&lt;Note&gt; +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch a list of notes that are associated to a contact. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.notes().list( + ListContactNotesRequest + .builder() + .contactId("contact_id") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**contactId:** `String` — The unique identifier of a contact. + +
+
+ +
+
+ +**page:** `Optional` — The page of results to fetch. Defaults to first page + +
+
+ +
+
+ +**perPage:** `Optional` — How many results to display per page. Defaults to 15 + +
+
+
+
+ + +
+
+
+ +
client.notes.create(contactId, request) -> Note +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can add a note to a single contact. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.notes().create( + CreateContactNoteRequest + .builder() + .contactId("123") + .body("Hello") + .adminId("123") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**contactId:** `String` — The unique identifier of a given contact. + +
+
+ +
+
+ +**body:** `String` — The text of the note. + +
+
+ +
+
+ +**adminId:** `Optional` — The unique identifier of a given admin. + +
+
+
+
+ + +
+
+
+ +
client.notes.find(noteId) -> Note +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch the details of a single note. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.notes().find( + FindNoteRequest + .builder() + .noteId(1) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**noteId:** `Integer` — The unique identifier of a given note + +
+
+
+
+ + +
+
+
+ +## Tags +
client.tags.tagContact(contactId, request) -> Tag +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can tag a specific contact. This will return a tag object for the tag that was added to the contact. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.tags().tagContact( + TagContactRequest + .builder() + .contactId("63a07ddf05a32042dffac965") + .tagId("7522907") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**contactId:** `String` — The unique identifier for the contact which is given by Intercom + +
+
+ +
+
+ +**tagId:** `String` — The unique identifier for the tag which is given by Intercom + +
+
+
+
+ + +
+
+
+ +
client.tags.untagContact(contactId, tagId) -> Tag +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can remove tag from a specific contact. This will return a tag object for the tag that was removed from the contact. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.tags().untagContact( + UntagContactRequest + .builder() + .contactId("63a07ddf05a32042dffac965") + .tagId("7522907") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**contactId:** `String` — The unique identifier for the contact which is given by Intercom + +
+
+ +
+
+ +**tagId:** `String` — The unique identifier for the tag which is given by Intercom + +
+
+
+
+ + +
+
+
+ +
client.tags.tagConversation(conversationId, request) -> Tag +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can tag a specific conversation. This will return a tag object for the tag that was added to the conversation. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.tags().tagConversation( + TagConversationRequest + .builder() + .conversationId("64619700005694") + .tagId("7522907") + .adminId("780") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**conversationId:** `String` — conversation_id + +
+
+ +
+
+ +**tagId:** `String` — The unique identifier for the tag which is given by Intercom + +
+
+ +
+
+ +**adminId:** `String` — The unique identifier for the admin which is given by Intercom. + +
+
+
+
+ + +
+
+
+ +
client.tags.untagConversation(conversationId, tagId, request) -> Tag +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can remove tag from a specific conversation. This will return a tag object for the tag that was removed from the conversation. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.tags().untagConversation( + UntagConversationRequest + .builder() + .conversationId("64619700005694") + .tagId("7522907") + .adminId("123") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**conversationId:** `String` — conversation_id + +
+
+ +
+
+ +**tagId:** `String` — tag_id + +
+
+ +
+
+ +**adminId:** `String` — The unique identifier for the admin which is given by Intercom. + +
+
+
+
+ + +
+
+
+ +
client.tags.list() -> TagList +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch a list of all tags for a given workspace. + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.tags().list(); +``` +
+
+
+
+ + +
+
+
+ +
client.tags.create(request) -> Tag +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can use this endpoint to perform the following operations: + + **1. Create a new tag:** You can create a new tag by passing in the tag name as specified in "Create or Update Tag Request Payload" described below. + + **2. Update an existing tag:** You can update an existing tag by passing the id of the tag as specified in "Create or Update Tag Request Payload" described below. + + **3. Tag Companies:** You can tag single company or a list of companies. You can tag a company by passing in the tag name and the company details as specified in "Tag Company Request Payload" described below. Also, if the tag doesn't exist then a new one will be created automatically. + + **4. Untag Companies:** You can untag a single company or a list of companies. You can untag a company by passing in the tag id and the company details as specified in "Untag Company Request Payload" described below. + + **5. Tag Multiple Users:** You can tag a list of users. You can tag the users by passing in the tag name and the user details as specified in "Tag Users Request Payload" described below. + +Each operation will return a tag object. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.tags().create( + TagsCreateRequestBody.of( + CreateOrUpdateTagRequest + .builder() + .name("test") + .build() + ) +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `TagsCreateRequestBody` + +
+
+
+
+ + +
+
+
+ +
client.tags.find(tagId) -> Tag +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch the details of tags that are on the workspace by their id. +This will return a tag object. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.tags().find( + FindTagRequest + .builder() + .tagId("123") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**tagId:** `String` — The unique identifier of a given tag + +
+
+
+
+ + +
+
+
+ +
client.tags.delete(tagId) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can delete the details of tags that are on the workspace by passing in the id. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.tags().delete( + DeleteTagRequest + .builder() + .tagId("123") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**tagId:** `String` — The unique identifier of a given tag + +
+
+
+
+ + +
+
+
+ +
client.tags.tagTicket(ticketId, request) -> Tag +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can tag a specific ticket. This will return a tag object for the tag that was added to the ticket. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.tags().tagTicket( + TagTicketRequest + .builder() + .ticketId("64619700005694") + .tagId("7522907") + .adminId("780") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**ticketId:** `String` — ticket_id + +
+
+ +
+
+ +**tagId:** `String` — The unique identifier for the tag which is given by Intercom + +
+
+ +
+
+ +**adminId:** `String` — The unique identifier for the admin which is given by Intercom. + +
+
+
+
+ + +
+
+
+ +
client.tags.untagTicket(ticketId, tagId, request) -> Tag +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can remove tag from a specific ticket. This will return a tag object for the tag that was removed from the ticket. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.tags().untagTicket( + UntagTicketRequest + .builder() + .ticketId("64619700005694") + .tagId("7522907") + .adminId("123") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**ticketId:** `String` — ticket_id + +
+
+ +
+
+ +**tagId:** `String` — The unique identifier for the tag which is given by Intercom + +
+
+ +
+
+ +**adminId:** `String` — The unique identifier for the admin which is given by Intercom. + +
+
+
+
+ + +
+
+
+ +## Conversations +
client.conversations.list() -> SyncPagingIterable&lt;Conversation&gt; +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch a list of all conversations. + +You can optionally request the result page size and the cursor to start after to fetch the result. +{% admonition type="warning" name="Pagination" %} + You can use pagination to limit the number of results returned. The default is `20` results per page. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis) for more details on how to use the `starting_after` param. +{% /admonition %} +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.conversations().list( + ListConversationsRequest + .builder() + .perPage(1) + .startingAfter("starting_after") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**perPage:** `Optional` — How many results per page + +
+
+ +
+
+ +**startingAfter:** `Optional` — String used to get the next page of conversations. + +
+
+
+
+ + +
+
+
+ +
client.conversations.create(request) -> Message +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can create a conversation that has been initiated by a contact (ie. user or lead). +The conversation can be an in-app message only. + +{% admonition type="info" name="Sending for visitors" %} +You can also send a message from a visitor by specifying their `user_id` or `id` value in the `from` field, along with a `type` field value of `contact`. +This visitor will be automatically converted to a contact with a lead role once the conversation is created. +{% /admonition %} + +This will return the Message model that has been created. + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.conversations().create( + CreateConversationRequest + .builder() + .from( + CreateConversationRequestFrom + .builder() + .type(CreateConversationRequestFromType.USER) + .id("6762f11b1bb69f9f2193bba3") + .build() + ) + .body("Hello there") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**from:** `CreateConversationRequestFrom` + +
+
+ +
+
+ +**body:** `String` — The content of the message. HTML is not supported. + +
+
+ +
+
+ +**createdAt:** `Optional` — The time the conversation was created as a UTC Unix timestamp. If not provided, the current time will be used. This field is only recommneded for migrating past conversations from another source into Intercom. + +
+
+
+
+ + +
+
+
+ +
client.conversations.find(conversationId) -> Conversation +
+
+ +#### 📝 Description + +
+
+ +
+
+ + +You can fetch the details of a single conversation. + +This will return a single Conversation model with all its conversation parts. + +{% admonition type="warning" name="Hard limit of 500 parts" %} +The maximum number of conversation parts that can be returned via the API is 500. If you have more than that we will return the 500 most recent conversation parts. +{% /admonition %} + +For AI agent conversation metadata, please note that you need to have the agent enabled in your workspace, which is a [paid feature](https://www.intercom.com/help/en/articles/8205718-fin-resolutions#h_97f8c2e671). +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.conversations().find( + FindConversationRequest + .builder() + .conversationId("123") + .displayAs("plaintext") + .includeTranslations(true) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**conversationId:** `String` — The id of the conversation to target + +
+
+ +
+
+ +**displayAs:** `Optional` — Set to plaintext to retrieve conversation messages in plain text. + +
+
+ +
+
+ +**includeTranslations:** `Optional` — If set to true, conversation parts will be translated to the detected language of the conversation. + +
+
+
+
+ + +
+
+
+ +
client.conversations.update(conversationId, request) -> Conversation +
+
+ +#### 📝 Description + +
+
+ +
+
+ + +You can update an existing conversation. + +{% admonition type="info" name="Replying and other actions" %} +If you want to reply to a coveration or take an action such as assign, unassign, open, close or snooze, take a look at the reply and manage endpoints. +{% /admonition %} + +{% admonition type="info" %} + This endpoint handles both **conversation updates** and **custom object associations**. + + See _`update a conversation with an association to a custom object instance`_ in the request/response examples to see the custom object association format. +{% /admonition %} + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.conversations().update( + UpdateConversationRequest + .builder() + .conversationId("conversation_id") + .displayAs("plaintext") + .read(true) + .title("new conversation title") + .customAttributes( + new HashMap() {{ + put("issue_type", CustomAttributesValue.of("Billing")); + put("priority", CustomAttributesValue.of("High")); + }} + ) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**conversationId:** `String` — The id of the conversation to target + +
+
+ +
+
+ +**displayAs:** `Optional` — Set to plaintext to retrieve conversation messages in plain text. + +
+
+ +
+
+ +**read:** `Optional` — Mark a conversation as read within Intercom. + +
+
+ +
+
+ +**title:** `Optional` — The title given to the conversation + +
+
+ +
+
+ +**customAttributes:** `Optional>` + +
+
+ +
+
+ +**companyId:** `Optional` — The ID of the company that the conversation is associated with. The unique identifier for the company which is given by Intercom. Set to nil to remove company. + +
+
+
+
+ + +
+
+
+ +
client.conversations.deleteConversation(conversationId) -> ConversationDeleted +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can delete a single conversation. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.conversations().deleteConversation( + DeleteConversationRequest + .builder() + .conversationId(1) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**conversationId:** `Integer` — id + +
+
+
+
+ + +
+
+
+ +
client.conversations.search(request) -> SyncPagingIterable&lt;Conversation&gt; +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can search for multiple conversations by the value of their attributes in order to fetch exactly which ones you want. + +To search for conversations, you need to send a `POST` request to `https://api.intercom.io/conversations/search`. + +This will accept a query object in the body which will define your filters in order to search for conversations. +{% admonition type="warning" name="Optimizing search queries" %} + Search queries can be complex, so optimizing them can help the performance of your search. + Use the `AND` and `OR` operators to combine multiple filters to get the exact results you need and utilize + pagination to limit the number of results returned. The default is `20` results per page and maximum is `150`. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#example-search-conversations-request) for more details on how to use the `starting_after` param. +{% /admonition %} + +### Nesting & Limitations + +You can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4). +There are some limitations to the amount of multiple's there can be: +- There's a limit of max 2 nested filters +- There's a limit of max 15 filters for each AND or OR group + +### Accepted Fields + +Most keys listed in the conversation model are searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as `created_at` accepts a date, the `value` cannot be a string such as `"foorbar"`). +The `source.body` field is unique as the search will not be performed against the entire value, but instead against every element of the value separately. For example, when searching for a conversation with a `"I need support"` body - the query should contain a `=` operator with the value `"support"` for such conversation to be returned. A query with a `=` operator and a `"need support"` value will not yield a result. + +| Field | Type | +| :---------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------- | +| id | String | +| created_at | Date (UNIX timestamp) | +| updated_at | Date (UNIX timestamp) | +| source.type | String
Accepted fields are `conversation`, `email`, `facebook`, `instagram`, `phone_call`, `phone_switch`, `push`, `sms`, `twitter` and `whatsapp`. | +| source.id | String | +| source.delivered_as | String | +| source.subject | String | +| source.body | String | +| source.author.id | String | +| source.author.type | String | +| source.author.name | String | +| source.author.email | String | +| source.url | String | +| contact_ids | String | +| teammate_ids | String | +| admin_assignee_id | String | +| team_assignee_id | String | +| channel_initiated | String | +| open | Boolean | +| read | Boolean | +| state | String | +| waiting_since | Date (UNIX timestamp) | +| snoozed_until | Date (UNIX timestamp) | +| tag_ids | String | +| priority | String | +| statistics.time_to_assignment | Integer | +| statistics.time_to_admin_reply | Integer | +| statistics.time_to_first_close | Integer | +| statistics.time_to_last_close | Integer | +| statistics.median_time_to_reply | Integer | +| statistics.first_contact_reply_at | Date (UNIX timestamp) | +| statistics.first_assignment_at | Date (UNIX timestamp) | +| statistics.first_admin_reply_at | Date (UNIX timestamp) | +| statistics.first_close_at | Date (UNIX timestamp) | +| statistics.last_assignment_at | Date (UNIX timestamp) | +| statistics.last_assignment_admin_reply_at | Date (UNIX timestamp) | +| statistics.last_contact_reply_at | Date (UNIX timestamp) | +| statistics.last_admin_reply_at | Date (UNIX timestamp) | +| statistics.last_close_at | Date (UNIX timestamp) | +| statistics.last_closed_by_id | String | +| statistics.count_reopens | Integer | +| statistics.count_assignments | Integer | +| statistics.count_conversation_parts | Integer | +| conversation_rating.requested_at | Date (UNIX timestamp) | +| conversation_rating.replied_at | Date (UNIX timestamp) | +| conversation_rating.score | Integer | +| conversation_rating.remark | String | +| conversation_rating.contact_id | String | +| conversation_rating.admin_d | String | +| ai_agent_participated | Boolean | +| ai_agent.resolution_state | String | +| ai_agent.last_answer_type | String | +| ai_agent.rating | Integer | +| ai_agent.rating_remark | String | +| ai_agent.source_type | String | +| ai_agent.source_title | String | + +### Accepted Operators + +The table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string (`"="`). The operator has to be compatible with the field's type (eg. you cannot search with `>` for a given string value as it's only compatible for integer's and dates). + +| Operator | Valid Types | Description | +| :------- | :----------------------------- | :----------------------------------------------------------- | +| = | All | Equals | +| != | All | Doesn't Equal | +| IN | All | In Shortcut for `OR` queries Values most be in Array | +| NIN | All | Not In Shortcut for `OR !` queries Values must be in Array | +| > | Integer Date (UNIX Timestamp) | Greater (or equal) than | +| < | Integer Date (UNIX Timestamp) | Lower (or equal) than | +| ~ | String | Contains | +| !~ | String | Doesn't Contain | +| ^ | String | Starts With | +| $ | String | Ends With | +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().conversations().searchConversations( + SearchRequest + .builder() + .query( + SearchRequestQuery.of( + SingleFilterSearchRequest + .builder() + .value( + SingleFilterSearchRequestValue.of() + ) + .build() + ) + ) + .pagination( + StartingAfterPaging + .builder() + .perPage(5) + .build() + ) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SearchRequest` + +
+
+
+
+ + +
+
+
+ +
client.conversations.reply(conversationId, request) -> Conversation +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can reply to a conversation with a message from an admin or on behalf of a contact, or with a note for admins. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.conversations().reply( + ReplyToConversationRequest + .builder() + .conversationId("123 or \"last\"") + .body( + ReplyConversationRequest.of( + ContactReplyConversationRequest.of( + ContactReplyIntercomUserIdRequest + .builder() + .messageType("comment") + .type("user") + .body("Thanks again :)") + .intercomUserId("6762f1571bb69f9f2193bbbb") + .build() + ) + ) + ) + .build() + ); + } +} +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**conversationId:** `String` — The Intercom provisioned identifier for the conversation or the string "last" to reply to the last part of the conversation + +
+
+ +
+
+ +**request:** `ReplyConversationRequest` + +
+
+
+
+ + +
+
+
+ +
client.conversations.manage(conversationId, request) -> Conversation +
+
+ +#### 📝 Description + +
+
+ +
+
+ +For managing conversations you can: +- Close a conversation +- Snooze a conversation to reopen on a future date +- Open a conversation which is `snoozed` or `closed` +- Assign a conversation to an admin and/or team. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.conversations().manage( + ManageConversationPartsRequest + .builder() + .conversationId("123") + .body( + ConversationsManageRequestBody.close( + CloseConversationRequest + .builder() + .type("admin") + .adminId("12345") + .build() + ) + ) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**conversationId:** `String` — The identifier for the conversation as given by Intercom. + +
+
+ +
+
+ +**request:** `ConversationsManageRequestBody` + +
+
+
+
+ + +
+
+
+ +
client.conversations.attachContactAsAdmin(conversationId, request) -> Conversation +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can add participants who are contacts to a conversation, on behalf of either another contact or an admin. + +{% admonition type="warning" name="Contacts without an email" %} +If you add a contact via the email parameter and there is no user/lead found on that workspace with he given email, then we will create a new contact with `role` set to `lead`. +{% /admonition %} + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.conversations().attachContactAsAdmin( + AttachContactToConversationRequest + .builder() + .conversationId("123") + .adminId("12345") + .customer( + AttachContactToConversationRequestCustomer.of( + AttachContactToConversationRequestCustomerIntercomUserId + .builder() + .intercomUserId("6762f19b1bb69f9f2193bbd4") + .build() + ) + ) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**conversationId:** `String` — The identifier for the conversation as given by Intercom. + +
+
+ +
+
+ +**adminId:** `Optional` — The `id` of the admin who is adding the new participant. + +
+
+ +
+
+ +**customer:** `Optional` + +
+
+
+
+ + +
+
+
+ +
client.conversations.detachContactAsAdmin(conversationId, contactId, request) -> Conversation +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can add participants who are contacts to a conversation, on behalf of either another contact or an admin. + +{% admonition type="warning" name="Contacts without an email" %} +If you add a contact via the email parameter and there is no user/lead found on that workspace with he given email, then we will create a new contact with `role` set to `lead`. +{% /admonition %} + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.conversations().detachContactAsAdmin( + DetachContactFromConversationRequest + .builder() + .conversationId("123") + .contactId("123") + .adminId("5017690") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**conversationId:** `String` — The identifier for the conversation as given by Intercom. + +
+
+ +
+
+ +**contactId:** `String` — The identifier for the contact as given by Intercom. + +
+
+ +
+
+ +**adminId:** `String` — The `id` of the admin who is performing the action. + +
+
+
+
+ + +
+
+
+ +
client.conversations.redactConversationPart(request) -> Conversation +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can redact a conversation part or the source message of a conversation (as seen in the source object). + +{% admonition type="info" name="Redacting parts and messages" %} +If you are redacting a conversation part, it must have a `body`. If you are redacting a source message, it must have been created by a contact. We will return a `conversation_part_not_redactable` error if these criteria are not met. +{% /admonition %} + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.conversations().redactConversationPart( + RedactConversationRequest.conversationPart( + RedactConversationRequestConversationPart + .builder() + .conversationId("19894788788") + .conversationPartId("19381789428") + .build() + ) +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `RedactConversationRequest` + +
+
+
+
+ + +
+
+
+ +
client.conversations.convertToTicket(conversationId, request) -> Optional&lt;Ticket&gt; +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can convert a conversation to a ticket. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.conversations().convertToTicket( + ConvertConversationToTicketRequest + .builder() + .conversationId(1) + .ticketTypeId("53") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**conversationId:** `Integer` — The id of the conversation to target + +
+
+ +
+
+ +**ticketTypeId:** `String` — The ID of the type of ticket you want to convert the conversation to + +
+
+ +
+
+ +**attributes:** `Optional>` + +
+
+
+
+ + +
+
+
+ +
client.conversations.runAssignmentRules(conversationId) -> Conversation +
+
+ +#### 📝 Description + +
+
+ +
+
+ +{% admonition type="danger" name="Deprecation of Run Assignment Rules" %} +Run assignment rules is now deprecated in version 2.12 and future versions and will be permanently removed on December 31, 2026. After this date, any requests made to this endpoint will fail. +{% /admonition %} +You can let a conversation be automatically assigned following assignment rules. +{% admonition type="warning" name="When using workflows" %} +It is not possible to use this endpoint with Workflows. +{% /admonition %} +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.conversations().runAssignmentRules( + AutoAssignConversationRequest + .builder() + .conversationId("123") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**conversationId:** `String` — The identifier for the conversation as given by Intercom. + +
+
+
+
+ + +
+
+
+ +## Custom Channel Events +
client.customChannelEvents.notifyNewConversation(request) -> CustomChannelNotificationResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Notifies Intercom that a new conversation was created in your custom channel/platform. This triggers conversation creation and workflow automations within Intercom for your custom channel integration. +> **Note:** This endpoint is currently under managed availability. Please reach out to your accounts team to discuss access and tailored, hands-on support. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.customChannelEvents().notifyNewConversation( + CustomChannelBaseEvent + .builder() + .eventId("event_id") + .externalConversationId("external_conversation_id") + .contact( + CustomChannelContact + .builder() + .type(CustomChannelContactType.USER) + .externalId("external_id") + .build() + ) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `CustomChannelBaseEvent` + +
+
+
+
+ + +
+
+
+ +
client.customChannelEvents.notifyNewMessage(request) -> CustomChannelNotificationResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Notifies Intercom that a new message was sent in a conversation on your custom channel/platform. This allows Intercom to process the message and trigger any relevant workflow automations. +> **Note:** This endpoint is currently under managed availability. Please reach out to your accounts team to discuss access and tailored, hands-on support. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.customChannelEvents().notifyNewMessage( + NotifyNewMessageRequest + .builder() + .eventId("event_id") + .externalConversationId("external_conversation_id") + .contact( + CustomChannelContact + .builder() + .type(CustomChannelContactType.USER) + .externalId("external_id") + .build() + ) + .body("body") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**body:** `String` — The message content sent by the user. + +
+
+
+
+ + +
+
+
+ +
client.customChannelEvents.notifyQuickReplySelected(request) -> CustomChannelNotificationResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Notifies Intercom that a user selected a quick reply option in your custom channel/platform. This allows Intercom to process the response and trigger any relevant workflow automations. +> **Note:** This endpoint is currently under managed availability. Please reach out to your accounts team to discuss access and tailored, hands-on support. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.customChannelEvents().notifyQuickReplySelected( + NotifyQuickReplySelectedRequest + .builder() + .eventId("evt_67890") + .externalConversationId("conv_13579") + .contact( + CustomChannelContact + .builder() + .type(CustomChannelContactType.USER) + .externalId("user_003") + .name("Alice Example") + .email("alice@example.com") + .build() + ) + .quickReplyOptionId("1234") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**quickReplyOptionId:** `String` — Id of the selected quick reply option. + +
+
+
+
+ + +
+
+
+ +
client.customChannelEvents.notifyAttributeCollected(request) -> CustomChannelNotificationResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Notifies Intercom that a user provided a response to an attribute collector in your custom channel/platform. This allows Intercom to process the attribute and trigger any relevant workflow automations. +> **Note:** This endpoint is currently under managed availability. Please reach out to your accounts team to discuss access and tailored, hands-on support. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.customChannelEvents().notifyAttributeCollected( + NotifyAttributeCollectedRequest + .builder() + .eventId("event_id") + .externalConversationId("external_conversation_id") + .contact( + CustomChannelContact + .builder() + .type(CustomChannelContactType.USER) + .externalId("external_id") + .build() + ) + .attribute( + CustomChannelAttribute + .builder() + .id("id") + .value("value") + .build() + ) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**attribute:** `CustomChannelAttribute` + +
+
+
+
+ + +
+
+
+ +## Custom Object Instances +
client.customObjectInstances.getCustomObjectInstancesByExternalId(customObjectTypeIdentifier) -> Optional&lt;CustomObjectInstance&gt; +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Fetch a Custom Object Instance by external_id. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.customObjectInstances().getCustomObjectInstancesByExternalId( + GetCustomObjectInstancesByExternalIdRequest + .builder() + .customObjectTypeIdentifier("Order") + .externalId("external_id") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**customObjectTypeIdentifier:** `String` — The unique identifier of the custom object type that defines the structure of the custom object instance. + +
+
+ +
+
+ +**externalId:** `String` + +
+
+
+
+ + +
+
+
+ +
client.customObjectInstances.createCustomObjectInstances(customObjectTypeIdentifier, request) -> Optional&lt;CustomObjectInstance&gt; +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Create or update a custom object instance +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.customObjectInstances().createCustomObjectInstances( + CreateOrUpdateCustomObjectInstanceRequest + .builder() + .customObjectTypeIdentifier("Order") + .externalId("123") + .externalCreatedAt(1392036272) + .externalUpdatedAt(1392036272) + .customAttributes( + new HashMap>() {{ + put("order_number", Optional.of("ORDER-12345")); + put("total_amount", Optional.of("custom_attributes")); + }} + ) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**customObjectTypeIdentifier:** `String` — The unique identifier of the custom object type that defines the structure of the custom object instance. + +
+
+ +
+
+ +**externalId:** `Optional` — A unique identifier for the Custom Object instance in the external system it originated from. + +
+
+ +
+
+ +**externalCreatedAt:** `Optional` — The time when the Custom Object instance was created in the external system it originated from. + +
+
+ +
+
+ +**externalUpdatedAt:** `Optional` — The time when the Custom Object instance was last updated in the external system it originated from. + +
+
+ +
+
+ +**customAttributes:** `Optional>>` — The custom attributes which are set for the Custom Object instance. + +
+
+
+
+ + +
+
+
+ +
client.customObjectInstances.deleteCustomObjectInstancesById(customObjectTypeIdentifier) -> CustomObjectInstanceDeleted +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Delete a single Custom Object instance by external_id. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.customObjectInstances().deleteCustomObjectInstancesById( + DeleteCustomObjectInstancesByIdRequest + .builder() + .customObjectTypeIdentifier("Order") + .externalId("external_id") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**customObjectTypeIdentifier:** `String` — The unique identifier of the custom object type that defines the structure of the custom object instance. + +
+
+ +
+
+ +**externalId:** `String` + +
+
+
+
+ + +
+
+
+ +
client.customObjectInstances.getCustomObjectInstancesById(customObjectTypeIdentifier, customObjectInstanceId) -> Optional&lt;CustomObjectInstance&gt; +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Fetch a Custom Object Instance by id. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.customObjectInstances().getCustomObjectInstancesById( + GetCustomObjectInstancesByIdRequest + .builder() + .customObjectTypeIdentifier("Order") + .customObjectInstanceId("custom_object_instance_id") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**customObjectTypeIdentifier:** `String` — The unique identifier of the custom object type that defines the structure of the custom object instance. + +
+
+ +
+
+ +**customObjectInstanceId:** `String` — The id or external_id of the custom object instance + +
+
+
+
+ + +
+
+
+ +
client.customObjectInstances.deleteCustomObjectInstancesByExternalId(customObjectTypeIdentifier, customObjectInstanceId) -> CustomObjectInstanceDeleted +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Delete a single Custom Object instance using the Intercom defined id. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.customObjectInstances().deleteCustomObjectInstancesByExternalId( + DeleteCustomObjectInstancesByExternalIdRequest + .builder() + .customObjectTypeIdentifier("Order") + .customObjectInstanceId("custom_object_instance_id") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**customObjectTypeIdentifier:** `String` — The unique identifier of the custom object type that defines the structure of the custom object instance. + +
+
+ +
+
+ +**customObjectInstanceId:** `String` — The Intercom defined id of the custom object instance + +
+
+
+
+ + +
+
+
+ +## Data Attributes +
client.dataAttributes.list() -> DataAttributeList +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch a list of all data attributes belonging to a workspace for contacts, companies or conversations. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.dataAttributes().list( + ListDataAttributesRequest + .builder() + .model(DataAttributesListRequestModel.CONTACT) + .includeArchived(true) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**model:** `Optional` — Specify the data attribute model to return. + +
+
+ +
+
+ +**includeArchived:** `Optional` — Include archived attributes in the list. By default we return only non archived data attributes. + +
+
+
+
+ + +
+
+
+ +
client.dataAttributes.create(request) -> DataAttribute +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can create a data attributes for a `contact` or a `company`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.dataAttributes().create( + CreateDataAttributeRequest.of( + CreateDataAttributeRequestOptions + .builder() + .dataType("string") + .build() + ) +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `CreateDataAttributeRequest` + +
+
+
+
+ + +
+
+
+ +
client.dataAttributes.update(dataAttributeId, request) -> DataAttribute +
+
+ +#### 📝 Description + +
+
+ +
+
+ + +You can update a data attribute. + +> 🚧 Updating the data type is not possible +> +> It is currently a dangerous action to execute changing a data attribute's type via the API. You will need to update the type via the UI instead. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.dataAttributes().update( + UpdateDataAttributeRequest + .builder() + .dataAttributeId(1) + .body( + UpdateDataAttributeRequestBody.of( + UpdateDataAttributeRequestOptions + .builder() + .options( + Arrays.asList( + UpdateDataAttributeRequestOptionsOptionsItem + .builder() + .value("1-10") + .build(), + UpdateDataAttributeRequestOptionsOptionsItem + .builder() + .value("11-20") + .build() + ) + ) + .build() + ) + ) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**dataAttributeId:** `Integer` — The data attribute id + +
+
+ +
+
+ +**request:** `UpdateDataAttributeRequestBody` + +
+
+
+
+ + +
+
+
+ +## Events +
client.events.list() -> DataEventSummary +
+
+ +#### 📝 Description + +
+
+ +
+
+ + +> 🚧 +> +> Please note that you can only 'list' events that are less than 90 days old. Event counts and summaries will still include your events older than 90 days but you cannot 'list' these events individually if they are older than 90 days + +The events belonging to a customer can be listed by sending a GET request to `https://api.intercom.io/events` with a user or lead identifier along with a `type` parameter. The identifier parameter can be one of `user_id`, `email` or `intercom_user_id`. The `type` parameter value must be `user`. + +- `https://api.intercom.io/events?type=user&user_id={user_id}` +- `https://api.intercom.io/events?type=user&email={email}` +- `https://api.intercom.io/events?type=user&intercom_user_id={id}` (this call can be used to list leads) + +The `email` parameter value should be [url encoded](http://en.wikipedia.org/wiki/Percent-encoding) when sending. + +You can optionally define the result page size as well with the `per_page` parameter. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.events().list( + ListEventsRequest + .builder() + .type("type") + .userId("user_id") + .intercomUserId("intercom_user_id") + .email("email") + .summary(true) + .perPage(1) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**userId:** `Optional` — user_id query parameter + +
+
+ +
+
+ +**intercomUserId:** `Optional` — intercom_user_id query parameter + +
+
+ +
+
+ +**email:** `Optional` — email query parameter + +
+
+ +
+
+ +**type:** `String` — The value must be user + +
+
+ +
+
+ +**summary:** `Optional` — summary flag + +
+
+ +
+
+ +**perPage:** `Optional` — How many results to display per page. Defaults to 15 + +
+
+
+
+ + +
+
+
+ +
client.events.create(request) +
+
+ +#### 📝 Description + +
+
+ +
+
+ + +You will need an Access Token that has write permissions to send Events. Once you have a key you can submit events via POST to the Events resource, which is located at https://api.intercom.io/events, or you can send events using one of the client libraries. When working with the HTTP API directly a client should send the event with a `Content-Type` of `application/json`. + +When using the JavaScript API, [adding the code to your app](http://docs.intercom.io/configuring-Intercom/tracking-user-events-in-your-app) makes the Events API available. Once added, you can submit an event using the `trackEvent` method. This will associate the event with the Lead or currently logged-in user or logged-out visitor/lead and send it to Intercom. The final parameter is a map that can be used to send optional metadata about the event. + +With the Ruby client you pass a hash describing the event to `Intercom::Event.create`, or call the `track_user` method directly on the current user object (e.g. `user.track_event`). + +**NB: For the JSON object types, please note that we do not currently support nested JSON structure.** + +| Type | Description | Example | +| :-------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------- | +| String | The value is a JSON String | `"source":"desktop"` | +| Number | The value is a JSON Number | `"load": 3.67` | +| Date | The key ends with the String `_date` and the value is a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time), assumed to be in the [UTC](http://en.wikipedia.org/wiki/Coordinated_Universal_Time) timezone. | `"contact_date": 1392036272` | +| Link | The value is a HTTP or HTTPS URI. | `"article": "https://example.org/ab1de.html"` | +| Rich Link | The value is a JSON object that contains `url` and `value` keys. | `"article": {"url": "https://example.org/ab1de.html", "value":"the dude abides"}` | +| Monetary Amount | The value is a JSON object that contains `amount` and `currency` keys. The `amount` key is a positive integer representing the amount in cents. The price in the example to the right denotes €349.99. | `"price": {"amount": 34999, "currency": "eur"}` | + +**Lead Events** + +When submitting events for Leads, you will need to specify the Lead's `id`. + +**Metadata behaviour** + +- We currently limit the number of tracked metadata keys to 10 per event. Once the quota is reached, we ignore any further keys we receive. The first 10 metadata keys are determined by the order in which they are sent in with the event. +- It is not possible to change the metadata keys once the event has been sent. A new event will need to be created with the new keys and you can archive the old one. +- There might be up to 24 hrs delay when you send a new metadata for an existing event. + +**Event de-duplication** + +The API may detect and ignore duplicate events. Each event is uniquely identified as a combination of the following data - the Workspace identifier, the Contact external identifier, the Data Event name and the Data Event created time. As a result, it is **strongly recommended** to send a second granularity Unix timestamp in the `created_at` field. + +Duplicated events are responded to using the normal `202 Accepted` code - an error is not thrown, however repeat requests will be counted against any rate limit that is in place. + +### HTTP API Responses + +- Successful responses to submitted events return `202 Accepted` with an empty body. +- Unauthorised access will be rejected with a `401 Unauthorized` or `403 Forbidden` response code. +- Events sent about users that cannot be found will return a `404 Not Found`. +- Event lists containing duplicate events will have those duplicates ignored. +- Server errors will return a `500` response code and may contain an error message in the body. + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.events().create( + CreateDataEventRequest.of( + CreateDataEventRequestWithId + .builder() + .id("8a88a590-e1c3-41e2-a502-e0649dbf721c") + .eventName("invited-friend") + .createdAt(1671028894) + .build() + ) +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `CreateDataEventRequest` + +
+
+
+
+ + +
+
+
+ +
client.events.summaries(request) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Create event summaries for a user. Event summaries are used to track the number of times an event has occurred, the first time it occurred and the last time it occurred. + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.events().summaries( + ListEventSummariesRequest + .builder() + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**userId:** `Optional` — Your identifier for the user. + +
+
+ +
+
+ +**eventSummaries:** `Optional` — A list of event summaries for the user. Each event summary should contain the event name, the time the event occurred, and the number of times the event occurred. The event name should be a past tense 'verb-noun' combination, to improve readability, for example `updated-plan`. + +
+
+
+
+ + +
+
+
+ +## Jobs +
client.jobs.status(jobId) -> Jobs +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieve the status of job execution. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.jobs().status( + JobsStatusRequest + .builder() + .jobId("job_id") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**jobId:** `String` — The unique identifier for the job which is given by Intercom + +
+
+
+
+ + +
+
+
+ +## Messages +
client.messages.create(request) -> Message +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can create a message that has been initiated by an admin. The conversation can be either an in-app message or an email. + +> 🚧 Sending for visitors +> +> There can be a short delay between when a contact is created and when a contact becomes available to be messaged through the API. A 404 Not Found error will be returned in this case. + +This will return the Message model that has been created. + +> 🚧 Retrieving Associated Conversations +> +> As this is a message, there will be no conversation present until the contact responds. Once they do, you will have to search for a contact's conversations with the id of the message. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.messages().create( + Optional.of( + CreateMessageRequest.email( + CreateMessageRequestWithEmail + .builder() + .subject("Thanks for everything") + .body("Hello there") + .template("plain") + .from( + CreateMessageRequestFrom + .builder() + .type("admin") + .id(394051) + .build() + ) + .to( + CreateMessageRequestTo + .builder() + .type(CreateMessageRequestType.USER) + .id("536e564f316c83104c000020") + .build() + ) + .build() + ) + ) +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Optional` + +
+
+
+
+ + +
+
+
+ +## Segments +
client.segments.list() -> SegmentList +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch a list of all segments. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.segments().list( + ListSegmentsRequest + .builder() + .includeCount(true) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**includeCount:** `Optional` — It includes the count of contacts that belong to each segment. + +
+
+
+
+ + +
+
+
+ +
client.segments.find(segmentId) -> Segment +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch the details of a single segment. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.segments().find( + FindSegmentRequest + .builder() + .segmentId("123") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**segmentId:** `String` — The unique identified of a given segment. + +
+
+
+
+ + +
+
+
+ +## Subscription Types +
client.subscriptionTypes.list() -> SubscriptionTypeList +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can list all subscription types. A list of subscription type objects will be returned. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.subscriptionTypes().list(); +``` +
+
+
+
+ + +
+
+
+ +## PhoneCallRedirects +
client.phoneCallRedirects.create(request) -> Optional&lt;PhoneSwitch&gt; +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can use the API to deflect phone calls to the Intercom Messenger. +Calling this endpoint will send an SMS with a link to the Messenger to the phone number specified. + +If custom attributes are specified, they will be added to the user or lead's custom data attributes. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.phoneCallRedirects().create( + Optional.of( + CreatePhoneSwitchRequest + .builder() + .phone("+353832345678") + .customAttributes( + new HashMap() {{ + put("issue_type", CustomAttributesValue.of("Billing")); + put("priority", CustomAttributesValue.of("High")); + }} + ) + .build() + ) +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Optional` + +
+
+
+
+ + +
+
+
+ +## Calls +
client.calls.listCalls() -> CallList +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieve a paginated list of calls. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.calls().listCalls( + ListCallsRequest + .builder() + .page(1) + .perPage(1) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**page:** `Optional` — The page of results to fetch. Defaults to first page + +
+
+ +
+
+ +**perPage:** `Optional` — How many results to display per page. Defaults to 25. Max 25. + +
+
+
+
+ + +
+
+
+ +
client.calls.showCall(callId) -> Call +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieve a single call by id. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.calls().showCall( + ShowCallRequest + .builder() + .callId("call_id") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**callId:** `String` — The id of the call to retrieve + +
+
+
+
+ + +
+
+
+ +
client.calls.showCallRecording(callId) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Redirects to a signed URL for the call's recording if it exists. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.calls().showCallRecording( + ShowCallRecordingRequest + .builder() + .callId("call_id") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**callId:** `String` — The id of the call + +
+
+
+
+ + +
+
+
+ +
client.calls.showCallTranscript(callId) -> String +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns the transcript for the specified call as a downloadable text file. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.calls().showCallTranscript( + ShowCallTranscriptRequest + .builder() + .callId("call_id") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**callId:** `String` — The id of the call + +
+
+
+
+ + +
+
+
+ +
client.calls.listCallsWithTranscripts(request) -> ListCallsWithTranscriptsResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieve calls by a list of conversation ids and include transcripts when available. +A maximum of 20 `conversation_ids` can be provided. If none are provided or more than 20 are provided, a 400 error is returned. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.calls().listCallsWithTranscripts( + ListCallsWithTranscriptsRequest + .builder() + .conversationIds( + Arrays.asList("64619700005694", "64619700005695") + ) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**conversationIds:** `List` — A list of conversation ids to fetch calls for. Maximum 20. + +
+
+
+
+ + +
+
+
+ +## Teams +
client.teams.list() -> TeamList +
+
+ +#### 📝 Description + +
+
+ +
+
+ +This will return a list of team objects for the App. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.teams().list(); +``` +
+
+
+
+ + +
+
+
+ +
client.teams.find(teamId) -> Team +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch the details of a single team, containing an array of admins that belong to this team. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.teams().find( + FindTeamRequest + .builder() + .teamId("123") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**teamId:** `String` — The unique identifier of a given team. + +
+
+
+
+ + +
+
+
+ +## Ticket States +
client.ticketStates.listTicketStates() -> TicketStateList +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can get a list of all ticket states for a workspace. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.ticketStates().listTicketStates(); +``` +
+
+
+
+ + +
+
+
+ +## Ticket Types +
client.ticketTypes.list() -> TicketTypeList +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can get a list of all ticket types for a workspace. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.ticketTypes().list(); +``` +
+
+
+
+ + +
+
+
+ +
client.ticketTypes.create(request) -> Optional&lt;TicketType&gt; +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can create a new ticket type. +> 📘 Creating ticket types. +> +> Every ticket type will be created with two default attributes: _default_title_ and _default_description_. +> For the `icon` propery, use an emoji from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/) +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.ticketTypes().create( + Optional.of( + CreateTicketTypeRequest + .builder() + .name("Customer Issue") + .description("Customer Report Template") + .category(CreateTicketTypeRequestCategory.CUSTOMER) + .icon("🎟️") + .build() + ) +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Optional` + +
+
+
+
+ + +
+
+
+ +
client.ticketTypes.get(ticketTypeId) -> Optional&lt;TicketType&gt; +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch the details of a single ticket type. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.ticketTypes().get( + FindTicketTypeRequest + .builder() + .ticketTypeId("ticket_type_id") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**ticketTypeId:** `String` — The unique identifier for the ticket type which is given by Intercom. + +
+
+
+
+ + +
+
+
+ +
client.ticketTypes.update(ticketTypeId, request) -> Optional&lt;TicketType&gt; +
+
+ +#### 📝 Description + +
+
+ +
+
+ + +You can update a ticket type. + +> 📘 Updating a ticket type. +> +> For the `icon` propery, use an emoji from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/) +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.ticketTypes().update( + UpdateTicketTypeRequest + .builder() + .ticketTypeId("ticket_type_id") + .name("Bug Report 2") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**ticketTypeId:** `String` — The unique identifier for the ticket type which is given by Intercom. + +
+
+ +
+
+ +**name:** `Optional` — The name of the ticket type. + +
+
+ +
+
+ +**description:** `Optional` — The description of the ticket type. + +
+
+ +
+
+ +**category:** `Optional` — Category of the Ticket Type. + +
+
+ +
+
+ +**icon:** `Optional` — The icon of the ticket type. + +
+
+ +
+
+ +**archived:** `Optional` — The archived status of the ticket type. + +
+
+ +
+
+ +**isInternal:** `Optional` — Whether the tickets associated with this ticket type are intended for internal use only or will be shared with customers. This is currently a limited attribute. + +
+
+
+
+ + +
+
+
+ +## Tickets +
client.tickets.reply(ticketId, request) -> TicketReply +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can reply to a ticket with a message from an admin or on behalf of a contact, or with a note for admins. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.tickets().reply( + ReplyToTicketRequest + .builder() + .ticketId("123") + .body( + TicketsReplyRequestBody.of( + ContactReplyTicketRequest.of( + ContactReplyTicketIntercomUserIdRequest + .builder() + .messageType("comment") + .type("user") + .body("Thanks again :)") + .intercomUserId("6762f2971bb69f9f2193bc49") + .build() + ) + ) + ) + .build() + ); + } +} +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**ticketId:** `String` + +
+
+ +
+
+ +**request:** `TicketsReplyRequestBody` + +
+
+
+
+ + +
+
+
+ +
client.tickets.create(request) -> Optional&lt;Ticket&gt; +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can create a new ticket. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.tickets().create( + CreateTicketRequest + .builder() + .ticketTypeId("1234") + .contacts( + Arrays.asList( + CreateTicketRequestContactsItem.of( + CreateTicketRequestContactsItemId + .builder() + .id("6762f2d81bb69f9f2193bc54") + .build() + ) + ) + ) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**skipNotifications:** `Optional` — Option to disable notifications when a Ticket is created. + +
+
+
+
+ + +
+
+
+ +
client.tickets.enqueueCreateTicket(request) -> Jobs +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Enqueues ticket creation for asynchronous processing, returning if the job was enqueued successfully to be processed. We attempt to perform a best-effort validation on inputs before tasks are enqueued. If the given parameters are incorrect, we won't enqueue the job. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.tickets().enqueueCreateTicket( + EnqueueCreateTicketRequest + .builder() + .ticketTypeId("1234") + .contacts( + Arrays.asList( + CreateTicketRequestContactsItem.of( + CreateTicketRequestContactsItemId + .builder() + .id("6762f2d81bb69f9f2193bc54") + .build() + ) + ) + ) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**skipNotifications:** `Optional` — Option to disable notifications when a Ticket is created. + +
+
+
+
+ + +
+
+
+ +
client.tickets.get(ticketId) -> Optional&lt;Ticket&gt; +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch the details of a single ticket. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.tickets().get( + FindTicketRequest + .builder() + .ticketId("ticket_id") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**ticketId:** `String` — The unique identifier for the ticket which is given by Intercom. + +
+
+
+
+ + +
+
+
+ +
client.tickets.update(ticketId, request) -> Optional&lt;Ticket&gt; +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can update a ticket. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.tickets().update( + UpdateTicketRequest + .builder() + .ticketId("ticket_id") + .ticketAttributes( + new HashMap() {{ + put("_default_title_", "example"); + put("_default_description_", "there is a problem"); + }} + ) + .ticketStateId("123") + .open(true) + .snoozedUntil(1673609604) + .adminId(991268011) + .assigneeId("123") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**ticketId:** `String` — The unique identifier for the ticket which is given by Intercom + +
+
+ +
+
+ +**ticketAttributes:** `Optional>` — The attributes set on the ticket. + +
+
+ +
+
+ +**ticketStateId:** `Optional` — The ID of the ticket state associated with the ticket type. + +
+
+ +
+
+ +**companyId:** `Optional` — The ID of the company that the ticket is associated with. The unique identifier for the company which is given by Intercom. Set to nil to remove company. + +
+
+ +
+
+ +**open:** `Optional` — Specify if a ticket is open. Set to false to close a ticket. Closing a ticket will also unsnooze it. + +
+
+ +
+
+ +**isShared:** `Optional` — Specify whether the ticket is visible to users. + +
+
+ +
+
+ +**snoozedUntil:** `Optional` — The time you want the ticket to reopen. + +
+
+ +
+
+ +**adminId:** `Optional` — The ID of the admin performing ticket update. Needed for workflows execution and attributing actions to specific admins. + +
+
+ +
+
+ +**assigneeId:** `Optional` — The ID of the admin or team to which the ticket is assigned. Set this 0 to unassign it. + +
+
+
+
+ + +
+
+
+ +
client.tickets.deleteTicket(ticketId) -> DeleteTicketResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can delete a ticket using the Intercom provided ID. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.tickets().deleteTicket( + DeleteTicketRequest + .builder() + .ticketId("ticket_id") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**ticketId:** `String` — The unique identifier for the ticket which is given by Intercom. + +
+
+
+
+ + +
+
+
+ +
client.tickets.search(request) -> SyncPagingIterable&lt;Optional&lt;Ticket&gt;&gt; +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can search for multiple tickets by the value of their attributes in order to fetch exactly which ones you want. + +To search for tickets, you send a `POST` request to `https://api.intercom.io/tickets/search`. + +This will accept a query object in the body which will define your filters. +{% admonition type="warning" name="Optimizing search queries" %} + Search queries can be complex, so optimizing them can help the performance of your search. + Use the `AND` and `OR` operators to combine multiple filters to get the exact results you need and utilize + pagination to limit the number of results returned. The default is `20` results per page. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#example-search-conversations-request) for more details on how to use the `starting_after` param. +{% /admonition %} + +### Nesting & Limitations + +You can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4). +There are some limitations to the amount of multiples there can be: +- There's a limit of max 2 nested filters +- There's a limit of max 15 filters for each AND or OR group + +### Accepted Fields + +Most keys listed as part of the Ticket model are searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as `created_at` accepts a date, the `value` cannot be a string such as `"foobar"`). +The `source.body` field is unique as the search will not be performed against the entire value, but instead against every element of the value separately. For example, when searching for a conversation with a `"I need support"` body - the query should contain a `=` operator with the value `"support"` for such conversation to be returned. A query with a `=` operator and a `"need support"` value will not yield a result. + +| Field | Type | +| :---------------------------------------- | :--------------------------------------------------------------------------------------- | +| id | String | +| created_at | Date (UNIX timestamp) | +| updated_at | Date (UNIX timestamp) | +| title | String | +| description | String | +| category | String | +| ticket_type_id | String | +| contact_ids | String | +| teammate_ids | String | +| admin_assignee_id | String | +| team_assignee_id | String | +| open | Boolean | +| state | String | +| snoozed_until | Date (UNIX timestamp) | +| ticket_attribute.{id} | String or Boolean or Date (UNIX timestamp) or Float or Integer | + +{% admonition type="info" name="Searching by Category" %} +When searching for tickets by the **`category`** field, specific terms must be used instead of the category names: +* For **Customer** category tickets, use the term `request`. +* For **Back-office** category tickets, use the term `task`. +* For **Tracker** category tickets, use the term `tracker`. +{% /admonition %} + +### Accepted Operators + +{% admonition type="info" name="Searching based on `created_at`" %} + You may use the `<=` or `>=` operators to search by `created_at`. +{% /admonition %} + +The table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string (`"="`). The operator has to be compatible with the field's type (eg. you cannot search with `>` for a given string value as it's only compatible for integer's and dates). + +| Operator | Valid Types | Description | +| :------- | :----------------------------- | :----------------------------------------------------------- | +| = | All | Equals | +| != | All | Doesn't Equal | +| IN | All | In Shortcut for `OR` queries Values most be in Array | +| NIN | All | Not In Shortcut for `OR !` queries Values must be in Array | +| > | Integer Date (UNIX Timestamp) | Greater (or equal) than | +| < | Integer Date (UNIX Timestamp) | Lower (or equal) than | +| ~ | String | Contains | +| !~ | String | Doesn't Contain | +| ^ | String | Starts With | +| $ | String | Ends With | +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().tickets().searchTickets( + SearchRequest + .builder() + .query( + SearchRequestQuery.of( + SingleFilterSearchRequest + .builder() + .value( + SingleFilterSearchRequestValue.of() + ) + .build() + ) + ) + .pagination( + StartingAfterPaging + .builder() + .perPage(5) + .build() + ) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SearchRequest` + +
+
+
+
+ + +
+
+
+ +## Visitors +
client.visitors.find() -> Optional&lt;Visitor&gt; +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch the details of a single visitor. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.visitors().find( + FindVisitorRequest + .builder() + .userId("user_id") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**userId:** `String` — The user_id of the Visitor you want to retrieve. + +
+
+
+
+ + +
+
+
+ +
client.visitors.update(request) -> Optional&lt;Visitor&gt; +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Sending a PUT request to `/visitors` will result in an update of an existing Visitor. + +**Option 1.** You can update a visitor by passing in the `user_id` of the visitor in the Request body. + +**Option 2.** You can update a visitor by passing in the `id` of the visitor in the Request body. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.visitors().update( + UpdateVisitorRequest.of( + UpdateVisitorRequestWithId + .builder() + .id("6762f30c1bb69f9f2193bc5e") + .name("Gareth Bale") + .build() + ) +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `UpdateVisitorRequest` + +
+
+
+
+ + +
+
+
+ +
client.visitors.mergeToContact(request) -> Contact +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can merge a Visitor to a Contact of role type `lead` or `user`. + +> 📘 What happens upon a visitor being converted? +> +> If the User exists, then the Visitor will be merged into it, the Visitor deleted and the User returned. If the User does not exist, the Visitor will be converted to a User, with the User identifiers replacing it's Visitor identifiers. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().visitors().convertVisitor( + ConvertVisitorRequest + .builder() + .type("user") + .user(new + HashMap() {{put("id", "8a88a590-e1c3-41e2-a502-e0649dbf721c"); + put("email", "foo@bar.com"); + }}) + .visitor(new + HashMap() {{put("user_id", "3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3"); + }}) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**type:** `String` — Represents the role of the Contact model. Accepts `lead` or `user`. + +
+
+ +
+
+ +**user:** `ConvertVisitorRequestUser` — The unique identifiers retained after converting or merging. + +
+
+ +
+
+ +**visitor:** `ConvertVisitorRequestVisitor` — The unique identifiers to convert a single Visitor. + +
+
+
+
+ + +
+
+
+ +## HelpCenters Collections +
client.helpCenters.collections.list() -> SyncPagingIterable&lt;Collection&gt; +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch a list of all collections by making a GET request to `https://api.intercom.io/help_center/collections`. + +Collections will be returned in descending order on the `updated_at` attribute. This means if you need to iterate through results then we'll show the most recently updated collections first. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.helpCenters().collections().list( + ListCollectionsRequest + .builder() + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**page:** `Optional` — The page of results to fetch. Defaults to first page + +
+
+ +
+
+ +**perPage:** `Optional` — How many results to display per page. Defaults to 15 + +
+
+
+
+ + +
+
+
+ +
client.helpCenters.collections.create(request) -> Collection +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can create a new collection by making a POST request to `https://api.intercom.io/help_center/collections.` +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.helpCenters().collections().create( + CreateCollectionRequest + .builder() + .name("Thanks for everything") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**name:** `String` — The name of the collection. For multilingual collections, this will be the name of the default language's content. + +
+
+ +
+
+ +**description:** `Optional` — The description of the collection. For multilingual collections, this will be the description of the default language's content. + +
+
+ +
+
+ +**translatedContent:** `Optional` + +
+
+ +
+
+ +**parentId:** `Optional` — The id of the parent collection. If `null` then it will be created as the first level collection. + +
+
+ +
+
+ +**helpCenterId:** `Optional` — The id of the help center where the collection will be created. If `null` then it will be created in the default help center. + +
+
+
+
+ + +
+
+
+ +
client.helpCenters.collections.find(collectionId) -> Collection +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch the details of a single collection by making a GET request to `https://api.intercom.io/help_center/collections/`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.helpCenters().collections().find( + FindCollectionRequest + .builder() + .collectionId(1) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**collectionId:** `Integer` — The unique identifier for the collection which is given by Intercom. + +
+
+
+
+ + +
+
+
+ +
client.helpCenters.collections.update(collectionId, request) -> Collection +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can update the details of a single collection by making a PUT request to `https://api.intercom.io/collections/`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.helpCenters().collections().update( + UpdateCollectionRequest + .builder() + .collectionId(1) + .name("Update collection name") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**collectionId:** `Integer` — The unique identifier for the collection which is given by Intercom. + +
+
+ +
+
+ +**name:** `Optional` — The name of the collection. For multilingual collections, this will be the name of the default language's content. + +
+
+ +
+
+ +**description:** `Optional` — The description of the collection. For multilingual collections, this will be the description of the default language's content. + +
+
+ +
+
+ +**translatedContent:** `Optional` + +
+
+ +
+
+ +**parentId:** `Optional` — The id of the parent collection. If `null` then it will be updated as the first level collection. + +
+
+
+
+ + +
+
+
+ +
client.helpCenters.collections.delete(collectionId) -> DeletedCollectionObject +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can delete a single collection by making a DELETE request to `https://api.intercom.io/collections/`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.helpCenters().collections().delete( + DeleteCollectionRequest + .builder() + .collectionId(1) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**collectionId:** `Integer` — The unique identifier for the collection which is given by Intercom. + +
+
+
+
+ + +
+
+
+ +## News Items +
client.news.items.list() -> PaginatedResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch a list of all news items +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.news().items().list(); +``` +
+
+
+
+ + +
+
+
+ +
client.news.items.create(request) -> NewsItem +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can create a news item +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.news().items().create( + NewsItemRequest + .builder() + .title("Halloween is here!") + .senderId(991267834) + .body("

New costumes in store for this spooky season

") + .state(NewsItemRequestState.LIVE) + .deliverSilently(true) + .labels( + Optional.of( + Arrays.asList("Product", "Update", "New") + ) + ) + .reactions( + Optional.of( + Arrays.asList(Optional.of("😆"), Optional.of("😅")) + ) + ) + .newsfeedAssignments( + Optional.of( + Arrays.asList( + NewsfeedAssignment + .builder() + .newsfeedId(53) + .publishedAt(1664638214) + .build() + ) + ) + ) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `NewsItemRequest` + +
+
+
+
+ + +
+
+
+ +
client.news.items.find(newsItemId) -> NewsItem +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch the details of a single news item. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.news().items().find( + FindNewsItemRequest + .builder() + .newsItemId(1) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**newsItemId:** `Integer` — The unique identifier for the news item which is given by Intercom. + +
+
+
+
+ + +
+
+
+ +
client.news.items.update(newsItemId, request) -> NewsItem +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.news().items().update( + UpdateNewsItemRequest + .builder() + .newsItemId(1) + .body( + NewsItemRequest + .builder() + .title("Christmas is here!") + .senderId(991267845) + .body("

New gifts in store for the jolly season

") + .reactions( + Optional.of( + Arrays.asList(Optional.of("😝"), Optional.of("😂")) + ) + ) + .build() + ) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**newsItemId:** `Integer` — The unique identifier for the news item which is given by Intercom. + +
+
+ +
+
+ +**request:** `NewsItemRequest` + +
+
+
+
+ + +
+
+
+ +
client.news.items.delete(newsItemId) -> DeletedObject +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can delete a single news item. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.news().items().delete( + DeleteNewsItemRequest + .builder() + .newsItemId(1) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**newsItemId:** `Integer` — The unique identifier for the news item which is given by Intercom. + +
+
+
+
+ + +
+
+
+ +## News Feeds +
client.news.feeds.listItems(newsfeedId) -> PaginatedResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch a list of all news items that are live on a given newsfeed +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.news().feeds().listItems( + ListNewsFeedItemsRequest + .builder() + .newsfeedId("123") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**newsfeedId:** `String` — The unique identifier for the news feed item which is given by Intercom. + +
+
+
+
+ + +
+
+
+ +
client.news.feeds.list() -> PaginatedResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch a list of all newsfeeds +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.news().feeds().list(); +``` +
+
+
+
+ + +
+
+
+ +
client.news.feeds.find(newsfeedId) -> Newsfeed +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch the details of a single newsfeed +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.news().feeds().find( + FindNewsFeedRequest + .builder() + .newsfeedId("123") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**newsfeedId:** `String` — The unique identifier for the news feed item which is given by Intercom. + +
+
+
+
+ + +
+
+
+ +## TicketTypes Attributes +
client.ticketTypes.attributes.create(ticketTypeId, request) -> Optional&lt;TicketTypeAttribute&gt; +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can create a new attribute for a ticket type. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.ticketTypes().attributes().create( + CreateTicketTypeAttributeRequest + .builder() + .ticketTypeId("ticket_type_id") + .name("Attribute Title") + .description("Attribute Description") + .dataType(CreateTicketTypeAttributeRequestDataType.STRING) + .requiredToCreate(false) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**ticketTypeId:** `String` — The unique identifier for the ticket type which is given by Intercom. + +
+
+ +
+
+ +**name:** `String` — The name of the ticket type attribute + +
+
+ +
+
+ +**description:** `String` — The description of the attribute presented to the teammate or contact + +
+
+ +
+
+ +**dataType:** `CreateTicketTypeAttributeRequestDataType` — The data type of the attribute + +
+
+ +
+
+ +**requiredToCreate:** `Optional` — Whether the attribute is required to be filled in when teammates are creating the ticket in Inbox. + +
+
+ +
+
+ +**requiredToCreateForContacts:** `Optional` — Whether the attribute is required to be filled in when contacts are creating the ticket in Messenger. + +
+
+ +
+
+ +**visibleOnCreate:** `Optional` — Whether the attribute is visible to teammates when creating a ticket in Inbox. + +
+
+ +
+
+ +**visibleToContacts:** `Optional` — Whether the attribute is visible to contacts when creating a ticket in Messenger. + +
+
+ +
+
+ +**multiline:** `Optional` — Whether the attribute allows multiple lines of text (only applicable to string attributes) + +
+
+ +
+
+ +**listItems:** `Optional` — A comma delimited list of items for the attribute value (only applicable to list attributes) + +
+
+ +
+
+ +**allowMultipleValues:** `Optional` — Whether the attribute allows multiple files to be attached to it (only applicable to file attributes) + +
+
+
+
+ + +
+
+
+ +
client.ticketTypes.attributes.update(ticketTypeId, attributeId, request) -> Optional&lt;TicketTypeAttribute&gt; +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can update an existing attribute for a ticket type. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.ticketTypes().attributes().update( + UpdateTicketTypeAttributeRequest + .builder() + .ticketTypeId("ticket_type_id") + .attributeId("attribute_id") + .description("New Attribute Description") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**ticketTypeId:** `String` — The unique identifier for the ticket type which is given by Intercom. + +
+
+ +
+
+ +**attributeId:** `String` — The unique identifier for the ticket type attribute which is given by Intercom. + +
+
+ +
+
+ +**name:** `Optional` — The name of the ticket type attribute + +
+
+ +
+
+ +**description:** `Optional` — The description of the attribute presented to the teammate or contact + +
+
+ +
+
+ +**requiredToCreate:** `Optional` — Whether the attribute is required to be filled in when teammates are creating the ticket in Inbox. + +
+
+ +
+
+ +**requiredToCreateForContacts:** `Optional` — Whether the attribute is required to be filled in when contacts are creating the ticket in Messenger. + +
+
+ +
+
+ +**visibleOnCreate:** `Optional` — Whether the attribute is visible to teammates when creating a ticket in Inbox. + +
+
+ +
+
+ +**visibleToContacts:** `Optional` — Whether the attribute is visible to contacts when creating a ticket in Messenger. + +
+
+ +
+
+ +**multiline:** `Optional` — Whether the attribute allows multiple lines of text (only applicable to string attributes) + +
+
+ +
+
+ +**listItems:** `Optional` — A comma delimited list of items for the attribute value (only applicable to list attributes) + +
+
+ +
+
+ +**allowMultipleValues:** `Optional` — Whether the attribute allows multiple files to be attached to it (only applicable to file attributes) + +
+
+ +
+
+ +**archived:** `Optional` — Whether the attribute should be archived and not shown during creation of the ticket (it will still be present on previously created tickets) + +
+
+
+
+ + +
+
+
+ +## Admins +
client.unstable.admins.identifyAdmin() -> Optional&lt;AdminWithApp&gt; +
+
+ +#### 📝 Description + +
+
+ +
+
+ + +You can view the currently authorised admin along with the embedded app object (a "workspace" in legacy terminology). + +> 🚧 Single Sign On +> +> If you are building a custom "Log in with Intercom" flow for your site, and you call the `/me` endpoint to identify the logged-in user, you should not accept any sign-ins from users with unverified email addresses as it poses a potential impersonation security risk. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.admins().identify(); +``` +
+
+
+
+ + +
+
+
+ +
client.unstable.admins.setAwayAdmin(id, request) -> Optional&lt;Admin&gt; +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can set an Admin as away for the Inbox. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().admins().setAwayAdmin( + SetAwayAdminRequest + .builder() + .id(1) + .awayModeEnabled(true) + .awayModeReassign(true) + .awayStatusReasonId(12345) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `Integer` — The unique identifier of a given admin + +
+
+ +
+
+ +**awayModeEnabled:** `Boolean` — Set to "true" to change the status of the admin to away. + +
+
+ +
+
+ +**awayModeReassign:** `Boolean` — Set to "true" to assign any new conversation replies to your default inbox. + +
+
+ +
+
+ +**awayStatusReasonId:** `Optional` — The unique identifier of the away status reason + +
+
+
+
+ + +
+
+
+ +
client.unstable.admins.listActivityLogs() -> ActivityLogList +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can get a log of activities by all admins in an app. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.admins().listAllActivityLogs( + ListAllActivityLogsRequest + .builder() + .createdAtAfter("1677253093") + .createdAtBefore("1677861493") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**createdAtAfter:** `String` — The start date that you request data for. It must be formatted as a UNIX timestamp. + +
+
+ +
+
+ +**createdAtBefore:** `Optional` — The end date that you request data for. It must be formatted as a UNIX timestamp. + +
+
+
+
+ + +
+
+
+ +
client.unstable.admins.listAdmins() -> AdminList +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch a list of admins for a given workspace. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.admins().list(); +``` +
+
+
+
+ + +
+
+
+ +
client.unstable.admins.retrieveAdmin(id) -> Optional&lt;Admin&gt; +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can retrieve the details of a single admin. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().admins().retrieveAdmin( + RetrieveAdminRequest + .builder() + .id(1) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `Integer` — The unique identifier of a given admin + +
+
+
+
+ + +
+
+
+ +## AI Content +
client.unstable.aiContent.listContentImportSources() -> ContentImportSourcesList +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can retrieve a list of all content import sources for a workspace. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.aiContent().listContentImportSources(); +``` +
+
+
+
+ + +
+
+
+ +
client.unstable.aiContent.createContentImportSource(request) -> ContentImportSource +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can create a new content import source by sending a POST request to this endpoint. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.aiContent().createContentImportSource( + CreateContentImportSourceRequest + .builder() + .url("https://www.example.com") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**syncBehavior:** `String` — If you intend to create or update External Pages via the API, this should be set to `api`. + +
+
+ +
+
+ +**status:** `Optional` — The status of the content import source. + +
+
+ +
+
+ +**url:** `String` — The URL of the content import source. + +
+
+
+
+ + +
+
+
+ +
client.unstable.aiContent.getContentImportSource(id) -> ContentImportSource +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().aiContent().getContentImportSource( + GetContentImportSourceRequest + .builder() + .id("id") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` — The unique identifier for the content import source which is given by Intercom. + +
+
+
+
+ + +
+
+
+ +
client.unstable.aiContent.updateContentImportSource(id, request) -> ContentImportSource +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can update an existing content import source. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().aiContent().updateContentImportSource( + UpdateContentImportSourceRequest + .builder() + .id("id") + .syncBehavior(UpdateContentImportSourceRequestSyncBehavior.API) + .url("https://www.example.com") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` — The unique identifier for the content import source which is given by Intercom. + +
+
+ +
+
+ +**syncBehavior:** `UpdateContentImportSourceRequestSyncBehavior` — If you intend to create or update External Pages via the API, this should be set to `api`. You can not change the value to or from api. + +
+
+ +
+
+ +**status:** `Optional` — The status of the content import source. + +
+
+ +
+
+ +**url:** `String` — The URL of the content import source. This may only be different from the existing value if the sync behavior is API. + +
+
+
+
+ + +
+
+
+ +
client.unstable.aiContent.deleteContentImportSource(id) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can delete a content import source by making a DELETE request this endpoint. This will also delete all external pages that were imported from this source. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().aiContent().deleteContentImportSource( + DeleteContentImportSourceRequest + .builder() + .id("id") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` — The unique identifier for the content import source which is given by Intercom. + +
+
+
+
+ + +
+
+
+ +
client.unstable.aiContent.listExternalPages() -> ExternalPagesList +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can retrieve a list of all external pages for a workspace. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.aiContent().listExternalPages(); +``` +
+
+
+
+ + +
+
+
+ +
client.unstable.aiContent.createExternalPage(request) -> ExternalPage +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can create a new external page by sending a POST request to this endpoint. If an external page already exists with the specified source_id and external_id, it will be updated instead. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.aiContent().createExternalPage( + CreateExternalPageRequest + .builder() + .title("Test") + .html("

Test

") + .sourceId(44) + .externalId("abc1234") + .url("https://www.example.com") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**title:** `String` — The title of the external page. + +
+
+ +
+
+ +**html:** `String` — The body of the external page in HTML. + +
+
+ +
+
+ +**url:** `Optional` — The URL of the external page. This will be used by Fin to link end users to the page it based its answer on. When a URL is not present, Fin will not reference the source. + +
+
+ +
+
+ +**aiAgentAvailability:** `Optional` — Whether the external page should be used to answer questions by AI Agent. Will not default when updating an existing external page. + +
+
+ +
+
+ +**aiCopilotAvailability:** `Optional` — Whether the external page should be used to answer questions by AI Copilot. Will not default when updating an existing external page. + +
+
+ +
+
+ +**locale:** `String` — Always en + +
+
+ +
+
+ +**sourceId:** `Integer` — The unique identifier for the source of the external page which was given by Intercom. Every external page must be associated with a Content Import Source which represents the place it comes from and from which it inherits a default audience (configured in the UI). For a new source, make a POST request to the Content Import Source endpoint and an ID for the source will be returned in the response. + +
+
+ +
+
+ +**externalId:** `String` — The identifier for the external page which was given by the source. Must be unique for the source. + +
+
+
+
+ + +
+
+
+ +
client.unstable.aiContent.getExternalPage(id) -> ExternalPage +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can retrieve an external page. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().aiContent().getExternalPage( + GetExternalPageRequest + .builder() + .id("id") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` — The unique identifier for the external page which is given by Intercom. + +
+
+
+
+ + +
+
+
+ +
client.unstable.aiContent.updateExternalPage(id, request) -> ExternalPage +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can update an existing external page (if it was created via the API). +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().aiContent().updateExternalPage( + UpdateExternalPageRequest + .builder() + .id("id") + .title("Test") + .html("

Test

") + .url("https://www.example.com") + .sourceId(47) + .externalId("5678") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` — The unique identifier for the external page which is given by Intercom. + +
+
+ +
+
+ +**title:** `String` — The title of the external page. + +
+
+ +
+
+ +**html:** `String` — The body of the external page in HTML. + +
+
+ +
+
+ +**url:** `String` — The URL of the external page. This will be used by Fin to link end users to the page it based its answer on. + +
+
+ +
+
+ +**finAvailability:** `Optional` — Whether the external page should be used to answer questions by Fin. + +
+
+ +
+
+ +**locale:** `String` — Always en + +
+
+ +
+
+ +**sourceId:** `Integer` — The unique identifier for the source of the external page which was given by Intercom. Every external page must be associated with a Content Import Source which represents the place it comes from and from which it inherits a default audience (configured in the UI). For a new source, make a POST request to the Content Import Source endpoint and an ID for the source will be returned in the response. + +
+
+ +
+
+ +**externalId:** `Optional` — The identifier for the external page which was given by the source. Must be unique for the source. + +
+
+
+
+ + +
+
+
+ +
client.unstable.aiContent.deleteExternalPage(id) -> ExternalPage +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Sending a DELETE request for an external page will remove it from the content library UI and from being used for AI answers. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().aiContent().deleteExternalPage( + DeleteExternalPageRequest + .builder() + .id("id") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` — The unique identifier for the external page which is given by Intercom. + +
+
+
+
+ + +
+
+
+ +## Articles +
client.unstable.articles.listArticles() -> ArticleList +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch a list of all articles by making a GET request to `https://api.intercom.io/articles`. + +> 📘 How are the articles sorted and ordered? +> +> Articles will be returned in descending order on the `updated_at` attribute. This means if you need to iterate through results then we'll show the most recently updated articles first. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.articles().list( + ListArticlesRequest + .builder() + .build() +); +``` +
+
+
+
+ + +
+
+
+ +
client.unstable.articles.createArticle(request) -> Article +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can create a new article by making a POST request to `https://api.intercom.io/articles`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().articles().createArticle(new +HashMap() {{put("key", "value"); +}}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Object` + +
+
+
+
+ + +
+
+
+ +
client.unstable.articles.retrieveArticle(id) -> Article +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch the details of a single article by making a GET request to `https://api.intercom.io/articles/`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().articles().retrieveArticle( + RetrieveArticleRequest + .builder() + .id(1) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `Integer` — The unique identifier for the article which is given by Intercom. + +
+
+
+
+ + +
+
+
+ +
client.unstable.articles.deleteArticle(id) -> DeletedArticleObject +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can delete a single article by making a DELETE request to `https://api.intercom.io/articles/`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().articles().deleteArticle( + DeleteArticleRequest + .builder() + .id(1) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `Integer` — The unique identifier for the article which is given by Intercom. + +
+
+
+
+ + +
+
+
+ +
client.unstable.articles.searchArticles() -> ArticleSearchResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can search for articles by making a GET request to `https://api.intercom.io/articles/search`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.articles().search( + SearchArticlesRequest + .builder() + .phrase("Getting started") + .state("published") + .helpCenterId(1) + .highlight(true) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**phrase:** `Optional` — The phrase within your articles to search for. + +
+
+ +
+
+ +**state:** `Optional` — The state of the Articles returned. One of `published`, `draft` or `all`. + +
+
+ +
+
+ +**helpCenterId:** `Optional` — The ID of the Help Center to search in. + +
+
+ +
+
+ +**highlight:** `Optional` — Return a highlighted version of the matching content within your articles. Refer to the response schema for more details. + +
+
+
+
+ + +
+
+
+ +## Away Status Reasons +
client.unstable.awayStatusReasons.listAwayStatusReasons() -> List&lt;AwayStatusReason&gt; +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns a list of all away status reasons configured for the workspace, including deleted ones. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.awayStatusReasons().listAwayStatusReasons(); +``` +
+
+
+
+ + +
+
+
+ +## Unstable Export +
client.unstable.export.enqueueANewReportingDataExportJob(request) -> PostExportReportingDataEnqueueResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.export().enqueueANewReportingDataExportJob( + PostExportReportingDataEnqueueRequest + .builder() + .datasetId("conversation") + .startTime(1717490000L) + .endTime(1717510000L) + .attributeIds( + Arrays.asList("conversation_id", "conversation_started_at") + ) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**datasetId:** `String` + +
+
+ +
+
+ +**attributeIds:** `List` + +
+
+ +
+
+ +**startTime:** `Long` + +
+
+ +
+
+ +**endTime:** `Long` + +
+
+
+
+ + +
+
+
+ +
client.unstable.export.listAvailableDatasetsAndAttributes() -> GetExportReportingDataGetDatasetsResponse +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.export().listAvailableDatasetsAndAttributes(); +``` +
+
+
+
+ + +
+
+
+ +## Help Center +
client.unstable.helpCenter.listAllCollections() -> CollectionList +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch a list of all collections by making a GET request to `https://api.intercom.io/help_center/collections`. + +Collections will be returned in descending order on the `updated_at` attribute. This means if you need to iterate through results then we'll show the most recently updated collections first. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.helpCenters().collections().list( + ListCollectionsRequest + .builder() + .build() +); +``` +
+
+
+
+ + +
+
+
+ +
client.unstable.helpCenter.createCollection(request) -> Collection +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can create a new collection by making a POST request to `https://api.intercom.io/help_center/collections.` +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.helpCenters().collections().create( + CreateCollectionRequest + .builder() + .name("Thanks for everything") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**name:** `String` — The name of the collection. For multilingual collections, this will be the name of the default language's content. + +
+
+ +
+
+ +**description:** `Optional` — The description of the collection. For multilingual collections, this will be the description of the default language's content. + +
+
+ +
+
+ +**translatedContent:** `Optional` + +
+
+ +
+
+ +**parentId:** `Optional` — The id of the parent collection. If `null` then it will be created as the first level collection. + +
+
+ +
+
+ +**helpCenterId:** `Optional` — The id of the help center where the collection will be created. If `null` then it will be created in the default help center. + +
+
+
+
+ + +
+
+
+ +
client.unstable.helpCenter.retrieveCollection(id) -> Collection +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch the details of a single collection by making a GET request to `https://api.intercom.io/help_center/collections/`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().helpCenter().retrieveCollection( + RetrieveCollectionRequest + .builder() + .id(1) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `Integer` — The unique identifier for the collection which is given by Intercom. + +
+
+
+
+ + +
+
+
+ +
client.unstable.helpCenter.updateCollection(id, request) -> Collection +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can update the details of a single collection by making a PUT request to `https://api.intercom.io/collections/`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().helpCenter().updateCollection( + UpdateCollectionRequest + .builder() + .id(1) + .name("Update collection name") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `Integer` — The unique identifier for the collection which is given by Intercom. + +
+
+ +
+
+ +**name:** `Optional` — The name of the collection. For multilingual collections, this will be the name of the default language's content. + +
+
+ +
+
+ +**description:** `Optional` — The description of the collection. For multilingual collections, this will be the description of the default language's content. + +
+
+ +
+
+ +**translatedContent:** `Optional` + +
+
+ +
+
+ +**parentId:** `Optional` — The id of the parent collection. If `null` then it will be updated as the first level collection. + +
+
+
+
+ + +
+
+
+ +
client.unstable.helpCenter.deleteCollection(id) -> DeletedCollectionObject +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can delete a single collection by making a DELETE request to `https://api.intercom.io/collections/`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().helpCenter().deleteCollection( + DeleteCollectionRequest + .builder() + .id(1) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `Integer` — The unique identifier for the collection which is given by Intercom. + +
+
+
+
+ + +
+
+
+ +
client.unstable.helpCenter.retrieveHelpCenter(id) -> HelpCenter +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch the details of a single Help Center by making a GET request to `https://api.intercom.io/help_center/help_center/`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().helpCenter().retrieveHelpCenter( + RetrieveHelpCenterRequest + .builder() + .id(1) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `Integer` — The unique identifier for the collection which is given by Intercom. + +
+
+
+
+ + +
+
+
+ +
client.unstable.helpCenter.listHelpCenters() -> HelpCenterList +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can list all Help Centers by making a GET request to `https://api.intercom.io/help_center/help_centers`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.helpCenters().list( + ListHelpCentersRequest + .builder() + .build() +); +``` +
+
+
+
+ + +
+
+
+ +## Internal Articles +
client.unstable.internalArticles.listInternalArticles() -> InternalArticleList +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch a list of all internal articles by making a GET request to `https://api.intercom.io/internal_articles`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.internalArticles().listInternalArticles(); +``` +
+
+
+
+ + +
+
+
+ +
client.unstable.internalArticles.createInternalArticle(request) -> InternalArticleListItem +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can create a new internal article by making a POST request to `https://api.intercom.io/internal_articles`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.internalArticles().createInternalArticle( + Optional.of( + CreateInternalArticleRequest + .builder() + .title("Thanks for everything") + .authorId(991266252) + .ownerId(991266252) + .body("Body of the Article") + .build() + ) +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Optional` + +
+
+
+
+ + +
+
+
+ +
client.unstable.internalArticles.retrieveInternalArticle(id) -> InternalArticleListItem +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch the details of a single internal article by making a GET request to `https://api.intercom.io/internal_articles/`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().internalArticles().retrieveInternalArticle( + RetrieveInternalArticleRequest + .builder() + .id(1) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `Integer` — The unique identifier for the article which is given by Intercom. + +
+
+
+
+ + +
+
+
+ +
client.unstable.internalArticles.updateInternalArticle(id, request) -> InternalArticleListItem +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can update the details of a single internal article by making a PUT request to `https://api.intercom.io/internal_articles/`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().internalArticles().updateInternalArticle( + UpdateInternalArticleRequestBody + .builder() + .id(1) + .title("Christmas is here!") + .body("

New gifts in store for the jolly season

") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `Integer` — The unique identifier for the internal article which is given by Intercom. + +
+
+ +
+
+ +**title:** `Optional` — The title of the article. + +
+
+ +
+
+ +**body:** `Optional` — The content of the article. + +
+
+ +
+
+ +**authorId:** `Optional` — The id of the author of the article. + +
+
+ +
+
+ +**ownerId:** `Optional` — The id of the author of the article. + +
+
+
+
+ + +
+
+
+ +
client.unstable.internalArticles.deleteInternalArticle(id) -> DeletedInternalArticleObject +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can delete a single internal article by making a DELETE request to `https://api.intercom.io/internal_articles/`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().internalArticles().deleteInternalArticle( + DeleteInternalArticleRequest + .builder() + .id(1) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `Integer` — The unique identifier for the internal article which is given by Intercom. + +
+
+
+
+ + +
+
+
+ +
client.unstable.internalArticles.searchInternalArticles() -> InternalArticleSearchResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can search for internal articles by making a GET request to `https://api.intercom.io/internal_articles/search`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.internalArticles().searchInternalArticles( + SearchInternalArticlesRequest + .builder() + .folderId("folder_id") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**folderId:** `Optional` — The ID of the folder to search in. + +
+
+
+
+ + +
+
+
+ +## Companies +
client.unstable.companies.retrieveCompany() -> CompanyList +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch a single company by passing in `company_id` or `name`. + + `https://api.intercom.io/companies?name={name}` + + `https://api.intercom.io/companies?company_id={company_id}` + +You can fetch all companies and filter by `segment_id` or `tag_id` as a query parameter. + + `https://api.intercom.io/companies?tag_id={tag_id}` + + `https://api.intercom.io/companies?segment_id={segment_id}` +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.companies().retrieve( + RetrieveCompanyRequest + .builder() + .name("my company") + .companyId("12345") + .tagId("678910") + .segmentId("98765") + .page(1) + .perPage(1) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**name:** `Optional` — The `name` of the company to filter by. + +
+
+ +
+
+ +**companyId:** `Optional` — The `company_id` of the company to filter by. + +
+
+ +
+
+ +**tagId:** `Optional` — The `tag_id` of the company to filter by. + +
+
+ +
+
+ +**segmentId:** `Optional` — The `segment_id` of the company to filter by. + +
+
+ +
+
+ +**page:** `Optional` — The page of results to fetch. Defaults to first page + +
+
+ +
+
+ +**perPage:** `Optional` — How many results to display per page. Defaults to 15 + +
+
+
+
+ + +
+
+
+ +
client.unstable.companies.createOrUpdateCompany(request) -> Company +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can create or update a company. + +Companies will be only visible in Intercom when there is at least one associated user. + +Companies are looked up via `company_id` in a `POST` request, if not found via `company_id`, the new company will be created, if found, that company will be updated. + +{% admonition type="warning" name="Using `company_id`" %} + You can set a unique `company_id` value when creating a company. However, it is not possible to update `company_id`. Be sure to set a unique value once upon creation of the company. +{% /admonition %} +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().companies().createOrUpdateCompany(new +HashMap() {{put("key", "value"); +}}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Object` + +
+
+
+
+ + +
+
+
+ +
client.unstable.companies.retrieveACompanyById(id) -> Company +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch a single company. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().companies().retrieveACompanyById( + RetrieveACompanyByIdRequest + .builder() + .id("5f4d3c1c-7b1b-4d7d-a97e-6095715c6632") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` — The unique identifier for the company which is given by Intercom + +
+
+
+
+ + +
+
+
+ +
client.unstable.companies.updateCompany(id) -> Company +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can update a single company using the Intercom provisioned `id`. + +{% admonition type="warning" name="Using `company_id`" %} + When updating a company it is not possible to update `company_id`. This can only be set once upon creation of the company. +{% /admonition %} +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().companies().updateCompany( + UpdateCompanyRequest + .builder() + .id("5f4d3c1c-7b1b-4d7d-a97e-6095715c6632") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` — The unique identifier for the company which is given by Intercom + +
+
+
+
+ + +
+
+
+ +
client.unstable.companies.deleteCompany(id) -> DeletedCompanyObject +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can delete a single company. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().companies().deleteCompany( + DeleteCompanyRequest + .builder() + .id("5f4d3c1c-7b1b-4d7d-a97e-6095715c6632") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` — The unique identifier for the company which is given by Intercom + +
+
+
+
+ + +
+
+
+ +
client.unstable.companies.listAttachedContacts(id) -> CompanyAttachedContacts +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch a list of all contacts that belong to a company. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().companies().listAttachedContacts( + ListAttachedContactsRequest + .builder() + .id("5f4d3c1c-7b1b-4d7d-a97e-6095715c6632") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` — The unique identifier for the company which is given by Intercom + +
+
+
+
+ + +
+
+
+ +
client.unstable.companies.listAttachedSegmentsForCompanies(id) -> CompanyAttachedSegments +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch a list of all segments that belong to a company. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().companies().listAttachedSegmentsForCompanies( + ListAttachedSegmentsForCompaniesRequest + .builder() + .id("5f4d3c1c-7b1b-4d7d-a97e-6095715c6632") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` — The unique identifier for the company which is given by Intercom + +
+
+
+
+ + +
+
+
+ +
client.unstable.companies.listAllCompanies() -> CompanyList +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can list companies. The company list is sorted by the `last_request_at` field and by default is ordered descending, most recently requested first. + +Note that the API does not include companies who have no associated users in list responses. + +When using the Companies endpoint and the pages object to iterate through the returned companies, there is a limit of 10,000 Companies that can be returned. If you need to list or iterate on more than 10,000 Companies, please use the [Scroll API](https://developers.intercom.com/reference#iterating-over-all-companies). +{% admonition type="warning" name="Pagination" %} + You can use pagination to limit the number of results returned. The default is `20` results per page. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis) for more details on how to use the `starting_after` param. +{% /admonition %} +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.companies().list( + ListCompaniesRequest + .builder() + .page(1) + .perPage(1) + .order("desc") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**page:** `Optional` — The page of results to fetch. Defaults to first page + +
+
+ +
+
+ +**perPage:** `Optional` — How many results to return per page. Defaults to 15 + +
+
+ +
+
+ +**order:** `Optional` — `asc` or `desc`. Return the companies in ascending or descending order. Defaults to desc + +
+
+
+
+ + +
+
+
+ +
client.unstable.companies.scrollOverAllCompanies() -> Optional&lt;CompanyScroll&gt; +
+
+ +#### 📝 Description + +
+
+ +
+
+ + The `list all companies` functionality does not work well for huge datasets, and can result in errors and performance problems when paging deeply. The Scroll API provides an efficient mechanism for iterating over all companies in a dataset. + +- Each app can only have 1 scroll open at a time. You'll get an error message if you try to have more than one open per app. +- If the scroll isn't used for 1 minute, it expires and calls with that scroll param will fail +- If the end of the scroll is reached, "companies" will be empty and the scroll parameter will expire + +{% admonition type="info" name="Scroll Parameter" %} + You can get the first page of companies by simply sending a GET request to the scroll endpoint. + For subsequent requests you will need to use the scroll parameter from the response. +{% /admonition %} +{% admonition type="danger" name="Scroll network timeouts" %} + Since scroll is often used on large datasets network errors such as timeouts can be encountered. When this occurs you will see a HTTP 500 error with the following message: + "Request failed due to an internal network error. Please restart the scroll operation." + If this happens, you will need to restart your scroll query: It is not possible to continue from a specific point when using scroll. +{% /admonition %} +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.companies().scroll( + ScrollCompaniesRequest + .builder() + .scrollParam("scroll_param") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**scrollParam:** `Optional` — + +
+
+
+
+ + +
+
+
+ +
client.unstable.companies.attachContactToACompany(id, request) -> Company +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can attach a company to a single contact. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().companies().attachContactToACompany( + AttachContactToACompanyRequest + .builder() + .id("id") + .companyId("6762f09a1bb69f9f2193bb34") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` — The unique identifier for the contact which is given by Intercom + +
+
+ +
+
+ +**companyId:** `String` — The unique identifier for the company which is given by Intercom + +
+
+
+
+ + +
+
+
+ +
client.unstable.companies.detachContactFromACompany(contactId, id) -> Company +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can detach a company from a single contact. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().companies().detachContactFromACompany( + DetachContactFromACompanyRequest + .builder() + .contactId("58a430d35458202d41b1e65b") + .id("58a430d35458202d41b1e65b") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**contactId:** `String` — The unique identifier for the contact which is given by Intercom + +
+
+ +
+
+ +**id:** `String` — The unique identifier for the company which is given by Intercom + +
+
+
+
+ + +
+
+
+ +## Notes +
client.unstable.notes.listCompanyNotes(id) -> NoteList +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch a list of notes that are associated to a company. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().notes().listCompanyNotes( + ListCompanyNotesRequest + .builder() + .id("5f4d3c1c-7b1b-4d7d-a97e-6095715c6632") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` — The unique identifier for the company which is given by Intercom + +
+
+
+
+ + +
+
+
+ +
client.unstable.notes.listNotes(id) -> NoteList +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch a list of notes that are associated to a contact. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().notes().listNotes( + ListNotesRequest + .builder() + .id(1) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `Integer` — The unique identifier of a contact. + +
+
+
+
+ + +
+
+
+ +
client.unstable.notes.createNote(id, request) -> Note +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can add a note to a single contact. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().notes().createNote( + CreateNoteRequest + .builder() + .id(1) + .body("Hello") + .contactId("6762f0ad1bb69f9f2193bb62") + .adminId("123") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `Integer` — The unique identifier of a given contact. + +
+
+ +
+
+ +**body:** `String` — The text of the note. + +
+
+ +
+
+ +**contactId:** `Optional` — The unique identifier of a given contact. + +
+
+ +
+
+ +**adminId:** `Optional` — The unique identifier of a given admin. + +
+
+
+
+ + +
+
+
+ +
client.unstable.notes.retrieveNote(id) -> Note +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch the details of a single note. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().notes().retrieveNote( + RetrieveNoteRequest + .builder() + .id(1) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `Integer` — The unique identifier of a given note + +
+
+
+
+ + +
+
+
+ +## Contacts +
client.unstable.contacts.listCompaniesForAContact(id) -> ContactAttachedCompanies +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch a list of companies that are associated to a contact. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().contacts().listCompaniesForAContact( + ListCompaniesForAContactRequest + .builder() + .id("63a07ddf05a32042dffac965") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` — The unique identifier for the contact which is given by Intercom + +
+
+
+
+ + +
+
+
+ +
client.unstable.contacts.listSegmentsForAContact(contactId) -> ContactSegments +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch a list of segments that are associated to a contact. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.contacts().listAttachedSegments( + ListSegmentsAttachedToContactRequest + .builder() + .contactId("63a07ddf05a32042dffac965") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**contactId:** `String` — The unique identifier for the contact which is given by Intercom + +
+
+
+
+ + +
+
+
+ +
client.unstable.contacts.listSubscriptionsForAContact(contactId) -> SubscriptionTypeList +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch a list of subscription types that are attached to a contact. These can be subscriptions that a user has 'opted-in' to or has 'opted-out' from, depending on the subscription type. +This will return a list of Subscription Type objects that the contact is associated with. + +The data property will show a combined list of: + + 1.Opt-out subscription types that the user has opted-out from. + 2.Opt-in subscription types that the user has opted-in to receiving. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.contacts().listAttachedSubscriptions( + ListAttachedSubscriptionsRequest + .builder() + .contactId("63a07ddf05a32042dffac965") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**contactId:** `String` — The unique identifier for the contact which is given by Intercom + +
+
+
+
+ + +
+
+
+ +
client.unstable.contacts.listTagsForAContact(contactId) -> TagList +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch a list of all tags that are attached to a specific contact. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.contacts().listAttachedTags( + ListTagsAttachedToContactRequest + .builder() + .contactId("63a07ddf05a32042dffac965") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**contactId:** `String` — The unique identifier for the contact which is given by Intercom + +
+
+
+
+ + +
+
+
+ +
client.unstable.contacts.showContact(id) -> ShowContactResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch the details of a single contact. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().contacts().showContact( + ShowContactRequest + .builder() + .id("63a07ddf05a32042dffac965") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` — id + +
+
+
+
+ + +
+
+
+ +
client.unstable.contacts.updateContact(id, request) -> UpdateContactResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can update an existing contact (ie. user or lead). + +{% admonition type="info" %} + This endpoint handles both **contact updates** and **custom object associations**. + + See _`update a contact with an association to a custom object instance`_ in the request/response examples to see the custom object association format. +{% /admonition %} +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().contacts().updateContact( + UpdateContactRequest + .builder() + .id("63a07ddf05a32042dffac965") + .email("joebloggs@intercom.io") + .name("joe bloggs") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` — id + +
+
+ +
+
+ +**role:** `Optional` — The role of the contact. + +
+
+ +
+
+ +**externalId:** `Optional` — A unique identifier for the contact which is given to Intercom + +
+
+ +
+
+ +**email:** `Optional` — The contacts email + +
+
+ +
+
+ +**phone:** `Optional` — The contacts phone + +
+
+ +
+
+ +**name:** `Optional` — The contacts name + +
+
+ +
+
+ +**avatar:** `Optional` — An image URL containing the avatar of a contact + +
+
+ +
+
+ +**signedUpAt:** `Optional` — The time specified for when a contact signed up + +
+
+ +
+
+ +**lastSeenAt:** `Optional` — The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually) + +
+
+ +
+
+ +**ownerId:** `Optional` — The id of an admin that has been assigned account ownership of the contact + +
+
+ +
+
+ +**unsubscribedFromEmails:** `Optional` — Whether the contact is unsubscribed from emails + +
+
+ +
+
+ +**languageOverride:** `Optional` — 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:** `Optional>` — The custom attributes which are set for the contact + +
+
+
+
+ + +
+
+
+ +
client.unstable.contacts.deleteContact(id) -> ContactDeleted +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can delete a single contact. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().contacts().deleteContact( + DeleteContactRequest + .builder() + .id("id") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` — id + +
+
+
+
+ + +
+
+
+ +
client.unstable.contacts.mergeContact(request) -> MergeContactResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can merge a contact with a `role` of `lead` into a contact with a `role` of `user`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.contacts().mergeLeadInUser( + MergeContactsRequest + .builder() + .leadId("6762f0d51bb69f9f2193bb7f") + .contactId("6762f0d51bb69f9f2193bb80") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**from:** `Optional` — The unique identifier for the contact to merge away from. Must be a lead. + +
+
+ +
+
+ +**into:** `Optional` — The unique identifier for the contact to merge into. Must be a user. + +
+
+
+
+ + +
+
+
+ +
client.unstable.contacts.searchContacts(request) -> ContactList +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can search for multiple contacts by the value of their attributes in order to fetch exactly who you want. + +To search for contacts, you need to send a `POST` request to `https://api.intercom.io/contacts/search`. + +This will accept a query object in the body which will define your filters in order to search for contacts. + +{% admonition type="warning" name="Optimizing search queries" %} + Search queries can be complex, so optimizing them can help the performance of your search. + Use the `AND` and `OR` operators to combine multiple filters to get the exact results you need and utilize + pagination to limit the number of results returned. The default is `50` results per page. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#example-search-conversations-request) for more details on how to use the `starting_after` param. +{% /admonition %} +### Contact Creation Delay + +If a contact has recently been created, there is a possibility that it will not yet be available when searching. This means that it may not appear in the response. This delay can take a few minutes. If you need to be instantly notified it is recommended to use webhooks and iterate to see if they match your search filters. + +### Nesting & Limitations + +You can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4). +There are some limitations to the amount of multiple's there can be: +* There's a limit of max 2 nested filters +* There's a limit of max 15 filters for each AND or OR group + +### Searching for Timestamp Fields + +All timestamp fields (created_at, updated_at etc.) are indexed as Dates for Contact Search queries; Datetime queries are not currently supported. This means you can only query for timestamp fields by day - not hour, minute or second. +For example, if you search for all Contacts with a created_at value greater (>) than 1577869200 (the UNIX timestamp for January 1st, 2020 9:00 AM), that will be interpreted as 1577836800 (January 1st, 2020 12:00 AM). The search results will then include Contacts created from January 2nd, 2020 12:00 AM onwards. +If you'd like to get contacts created on January 1st, 2020 you should search with a created_at value equal (=) to 1577836800 (January 1st, 2020 12:00 AM). +This behaviour applies only to timestamps used in search queries. The search results will still contain the full UNIX timestamp and be sorted accordingly. + +### Accepted Fields + +Most key listed as part of the Contacts Model are searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as `created_at` accepts a date, the `value` cannot be a string such as `"foorbar"`). + +| Field | Type | +| ---------------------------------- | ------------------------------ | +| id | String | +| role | String
Accepts user or lead | +| name | String | +| avatar | String | +| owner_id | Integer | +| email | String | +| email_domain | String | +| phone | String | +| formatted_phone | String | +| external_id | String | +| created_at | Date (UNIX Timestamp) | +| signed_up_at | Date (UNIX Timestamp) | +| updated_at | Date (UNIX Timestamp) | +| last_seen_at | Date (UNIX Timestamp) | +| last_contacted_at | Date (UNIX Timestamp) | +| last_replied_at | Date (UNIX Timestamp) | +| last_email_opened_at | Date (UNIX Timestamp) | +| last_email_clicked_at | Date (UNIX Timestamp) | +| language_override | String | +| browser | String | +| browser_language | String | +| os | String | +| location.country | String | +| location.region | String | +| location.city | String | +| unsubscribed_from_emails | Boolean | +| marked_email_as_spam | Boolean | +| has_hard_bounced | Boolean | +| ios_last_seen_at | Date (UNIX Timestamp) | +| ios_app_version | String | +| ios_device | String | +| ios_app_device | String | +| ios_os_version | String | +| ios_app_name | String | +| ios_sdk_version | String | +| android_last_seen_at | Date (UNIX Timestamp) | +| android_app_version | String | +| android_device | String | +| android_app_name | String | +| andoid_sdk_version | String | +| segment_id | String | +| tag_id | String | +| custom_attributes.{attribute_name} | String | + +### Accepted Operators + +{% admonition type="warning" name="Searching based on `created_at`" %} + You cannot use the `<=` or `>=` operators to search by `created_at`. +{% /admonition %} + +The table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string (`"="`). The operator has to be compatible with the field's type (eg. you cannot search with `>` for a given string value as it's only compatible for integer's and dates). + +| Operator | Valid Types | Description | +| :------- | :------------------------------- | :--------------------------------------------------------------- | +| = | All | Equals | +| != | All | Doesn't Equal | +| IN | All | In
Shortcut for `OR` queries
Values must be in Array | +| NIN | All | Not In
Shortcut for `OR !` queries
Values must be in Array | +| > | Integer
Date (UNIX Timestamp) | Greater than | +| < | Integer
Date (UNIX Timestamp) | Lower than | +| ~ | String | Contains | +| !~ | String | Doesn't Contain | +| ^ | String | Starts With | +| $ | String | Ends With | +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().contacts().searchContacts( + SearchRequest + .builder() + .query( + SearchRequestQuery.of( + SingleFilterSearchRequest + .builder() + .value( + SingleFilterSearchRequestValue.of() + ) + .build() + ) + ) + .pagination( + StartingAfterPaging + .builder() + .perPage(5) + .build() + ) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SearchRequest` + +
+
+
+
+ + +
+
+
+ +
client.unstable.contacts.listContacts() -> ContactList +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch a list of all contacts (ie. users or leads) in your workspace. +{% admonition type="warning" name="Pagination" %} + You can use pagination to limit the number of results returned. The default is `50` results per page. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis) for more details on how to use the `starting_after` param. +{% /admonition %} +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.contacts().list( + ListContactsRequest + .builder() + .build() +); +``` +
+
+
+
+ + +
+
+
+ +
client.unstable.contacts.createContact(request) -> CreateContactResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can create a new contact (ie. user or lead). +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.contacts().create( + CreateContactRequest.of( + CreateContactRequestWithEmail + .builder() + .email("joebloggs@intercom.io") + .build() + ) +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Object` + +
+
+
+
+ + +
+
+
+ +
client.unstable.contacts.showContactByExternalId(externalId) -> ShowContactByExternalIdResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch the details of a single contact by external ID. Note that this endpoint only supports users and not leads. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.contacts().showContactByExternalId( + ShowContactByExternalIdRequest + .builder() + .externalId("cdd29344-5e0c-4ef0-ac56-f9ba2979bc27") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**externalId:** `String` — The external ID of the user that you want to retrieve + +
+
+
+
+ + +
+
+
+ +
client.unstable.contacts.archiveContact(id) -> ContactArchived +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can archive a single contact. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().contacts().archiveContact( + ArchiveContactRequest + .builder() + .id("63a07ddf05a32042dffac965") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` — id + +
+
+
+
+ + +
+
+
+ +
client.unstable.contacts.unarchiveContact(id) -> ContactUnarchived +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can unarchive a single contact. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().contacts().unarchiveContact( + UnarchiveContactRequest + .builder() + .id("63a07ddf05a32042dffac965") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` — id + +
+
+
+
+ + +
+
+
+ +
client.unstable.contacts.blockContact(id) -> ContactBlocked +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Block a single contact.
**Note:** conversations of the contact will also be archived during the process.
More details in [FAQ How do I block Inbox spam?](https://www.intercom.com/help/en/articles/8838656-inbox-faqs) +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().contacts().blockContact( + BlockContactRequest + .builder() + .id("63a07ddf05a32042dffac965") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` — id + +
+
+
+
+ + +
+
+
+ +## Subscription Types +
client.unstable.subscriptionTypes.attachSubscriptionTypeToContact(contactId, request) -> SubscriptionType +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can add a specific subscription to a contact. In Intercom, we have two different subscription types based on user consent - opt-out and opt-in: + + 1.Attaching a contact to an opt-out subscription type will opt that user out from receiving messages related to that subscription type. + + 2.Attaching a contact to an opt-in subscription type will opt that user in to receiving messages related to that subscription type. + +This will return a subscription type model for the subscription type that was added to the contact. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.contacts().attachSubscription( + AttachSubscriptionToContactRequest + .builder() + .contactId("63a07ddf05a32042dffac965") + .subscriptionId("37846") + .consentType("opt_in") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**contactId:** `String` — The unique identifier for the contact which is given by Intercom + +
+
+ +
+
+ +**id:** `String` — The unique identifier for the subscription which is given by Intercom + +
+
+ +
+
+ +**consentType:** `String` — The consent_type of a subscription, opt_out or opt_in. + +
+
+
+
+ + +
+
+
+ +
client.unstable.subscriptionTypes.detachSubscriptionTypeToContact(contactId, id) -> SubscriptionType +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can remove a specific subscription from a contact. This will return a subscription type model for the subscription type that was removed from the contact. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().subscriptionTypes().detachSubscriptionTypeToContact( + DetachSubscriptionTypeToContactRequest + .builder() + .contactId("63a07ddf05a32042dffac965") + .id("37846") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**contactId:** `String` — The unique identifier for the contact which is given by Intercom + +
+
+ +
+
+ +**id:** `String` — The unique identifier for the subscription type which is given by Intercom + +
+
+
+
+ + +
+
+
+ +
client.unstable.subscriptionTypes.listSubscriptionTypes() -> SubscriptionTypeList +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can list all subscription types. A list of subscription type objects will be returned. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.subscriptionTypes().list(); +``` +
+
+
+
+ + +
+
+
+ +## Tags +
client.unstable.tags.attachTagToContact(contactId, request) -> Tag +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can tag a specific contact. This will return a tag object for the tag that was added to the contact. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.tags().tagContact( + TagContactRequest + .builder() + .contactId("63a07ddf05a32042dffac965") + .tagId("7522907") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**contactId:** `String` — The unique identifier for the contact which is given by Intercom + +
+
+ +
+
+ +**id:** `String` — The unique identifier for the tag which is given by Intercom + +
+
+
+
+ + +
+
+
+ +
client.unstable.tags.detachTagFromContact(contactId, id) -> Tag +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can remove tag from a specific contact. This will return a tag object for the tag that was removed from the contact. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().tags().detachTagFromContact( + DetachTagFromContactRequest + .builder() + .contactId("63a07ddf05a32042dffac965") + .id("7522907") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**contactId:** `String` — The unique identifier for the contact which is given by Intercom + +
+
+ +
+
+ +**id:** `String` — The unique identifier for the tag which is given by Intercom + +
+
+
+
+ + +
+
+
+ +
client.unstable.tags.attachTagToConversation(conversationId, request) -> Tag +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can tag a specific conversation. This will return a tag object for the tag that was added to the conversation. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.tags().tagConversation( + TagConversationRequest + .builder() + .conversationId("64619700005694") + .tagId("7522907") + .adminId("780") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**conversationId:** `String` — conversation_id + +
+
+ +
+
+ +**id:** `String` — The unique identifier for the tag which is given by Intercom + +
+
+ +
+
+ +**adminId:** `String` — The unique identifier for the admin which is given by Intercom. + +
+
+
+
+ + +
+
+
+ +
client.unstable.tags.detachTagFromConversation(conversationId, id, request) -> Tag +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can remove tag from a specific conversation. This will return a tag object for the tag that was removed from the conversation. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().tags().detachTagFromConversation( + DetachTagFromConversationRequest + .builder() + .conversationId("64619700005694") + .id("7522907") + .adminId("123") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**conversationId:** `String` — conversation_id + +
+
+ +
+
+ +**id:** `String` — id + +
+
+ +
+
+ +**adminId:** `String` — The unique identifier for the admin which is given by Intercom. + +
+
+
+
+ + +
+
+
+ +
client.unstable.tags.listTags() -> TagList +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch a list of all tags for a given workspace. + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.tags().list(); +``` +
+
+
+
+ + +
+
+
+ +
client.unstable.tags.createTag(request) -> Tag +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can use this endpoint to perform the following operations: + + **1. Create a new tag:** You can create a new tag by passing in the tag name as specified in "Create or Update Tag Request Payload" described below. + + **2. Update an existing tag:** You can update an existing tag by passing the id of the tag as specified in "Create or Update Tag Request Payload" described below. + + **3. Tag Companies:** You can tag single company or a list of companies. You can tag a company by passing in the tag name and the company details as specified in "Tag Company Request Payload" described below. Also, if the tag doesn't exist then a new one will be created automatically. + + **4. Untag Companies:** You can untag a single company or a list of companies. You can untag a company by passing in the tag id and the company details as specified in "Untag Company Request Payload" described below. + + **5. Tag Multiple Users:** You can tag a list of users. You can tag the users by passing in the tag name and the user details as specified in "Tag Users Request Payload" described below. + +Each operation will return a tag object. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.tags().create( + TagsCreateRequestBody.of( + CreateOrUpdateTagRequest + .builder() + .name("test") + .build() + ) +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `CreateTagRequestBody` + +
+
+
+
+ + +
+
+
+ +
client.unstable.tags.findTag(id) -> Tag +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch the details of tags that are on the workspace by their id. +This will return a tag object. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().tags().findTag( + FindTagRequest + .builder() + .id("123") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` — The unique identifier of a given tag + +
+
+
+
+ + +
+
+
+ +
client.unstable.tags.deleteTag(id) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can delete the details of tags that are on the workspace by passing in the id. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().tags().deleteTag( + DeleteTagRequest + .builder() + .id("123") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` — The unique identifier of a given tag + +
+
+
+
+ + +
+
+
+ +
client.unstable.tags.attachTagToTicket(ticketId, request) -> Tag +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can tag a specific ticket. This will return a tag object for the tag that was added to the ticket. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.tags().tagTicket( + TagTicketRequest + .builder() + .ticketId("64619700005694") + .tagId("7522907") + .adminId("780") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**ticketId:** `String` — ticket_id + +
+
+ +
+
+ +**id:** `String` — The unique identifier for the tag which is given by Intercom + +
+
+ +
+
+ +**adminId:** `String` — The unique identifier for the admin which is given by Intercom. + +
+
+
+
+ + +
+
+
+ +
client.unstable.tags.detachTagFromTicket(ticketId, id, request) -> Tag +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can remove tag from a specific ticket. This will return a tag object for the tag that was removed from the ticket. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().tags().detachTagFromTicket( + DetachTagFromTicketRequest + .builder() + .ticketId("64619700005694") + .id("7522907") + .adminId("123") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**ticketId:** `String` — ticket_id + +
+
+ +
+
+ +**id:** `String` — The unique identifier for the tag which is given by Intercom + +
+
+ +
+
+ +**adminId:** `String` — The unique identifier for the admin which is given by Intercom. + +
+
+
+
+ + +
+
+
+ +## Conversations +
client.unstable.conversations.listConversations() -> ConversationList +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch a list of all conversations. + +You can optionally request the result page size and the cursor to start after to fetch the result. +{% admonition type="warning" name="Pagination" %} + You can use pagination to limit the number of results returned. The default is `20` results per page. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis) for more details on how to use the `starting_after` param. +{% /admonition %} +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.conversations().list( + ListConversationsRequest + .builder() + .perPage(1) + .startingAfter("starting_after") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**perPage:** `Optional` — How many results per page + +
+
+ +
+
+ +**startingAfter:** `Optional` — String used to get the next page of conversations. + +
+
+
+
+ + +
+
+
+ +
client.unstable.conversations.createConversation(request) -> Message +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can create a conversation that has been initiated by a contact (ie. user or lead). +The conversation can be an in-app message only. + +{% admonition type="info" name="Sending for visitors" %} +You can also send a message from a visitor by specifying their `user_id` or `id` value in the `from` field, along with a `type` field value of `contact`. +This visitor will be automatically converted to a contact with a lead role once the conversation is created. +{% /admonition %} + +This will return the Message model that has been created. + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.conversations().create( + CreateConversationRequest + .builder() + .from( + CreateConversationRequestFrom + .builder() + .type(CreateConversationRequestFromType.USER) + .id("6762f11b1bb69f9f2193bba3") + .build() + ) + .body("Hello there") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**from:** `CreateConversationRequestFrom` + +
+
+ +
+
+ +**body:** `String` — The content of the message. HTML is not supported. + +
+
+ +
+
+ +**createdAt:** `Optional` — The time the conversation was created as a UTC Unix timestamp. If not provided, the current time will be used. This field is only recommneded for migrating past conversations from another source into Intercom. + +
+
+
+
+ + +
+
+
+ +
client.unstable.conversations.retrieveConversation(id) -> Conversation +
+
+ +#### 📝 Description + +
+
+ +
+
+ + +You can fetch the details of a single conversation. + +This will return a single Conversation model with all its conversation parts. + +{% admonition type="warning" name="Hard limit of 500 parts" %} +The maximum number of conversation parts that can be returned via the API is 500. If you have more than that we will return the 500 most recent conversation parts. +{% /admonition %} + +For AI agent conversation metadata, please note that you need to have the agent enabled in your workspace, which is a [paid feature](https://www.intercom.com/help/en/articles/8205718-fin-resolutions#h_97f8c2e671). +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().conversations().retrieveConversation( + RetrieveConversationRequest + .builder() + .id(1) + .displayAs("plaintext") + .includeTranslations(true) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `Integer` — The id of the conversation to target + +
+
+ +
+
+ +**displayAs:** `Optional` — Set to plaintext to retrieve conversation messages in plain text. This affects both the body and subject fields. + +
+
+ +
+
+ +**includeTranslations:** `Optional` — If set to true, conversation parts will be translated to the detected language of the conversation. + +
+
+
+
+ + +
+
+
+ +
client.unstable.conversations.updateConversation(id, request) -> Conversation +
+
+ +#### 📝 Description + +
+
+ +
+
+ + +You can update an existing conversation. + +{% admonition type="info" name="Replying and other actions" %} +If you want to reply to a coveration or take an action such as assign, unassign, open, close or snooze, take a look at the reply and manage endpoints. +{% /admonition %} + +{% admonition type="info" %} + This endpoint handles both **conversation updates** and **custom object associations**. + + See _`update a conversation with an association to a custom object instance`_ in the request/response examples to see the custom object association format. +{% /admonition %} + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().conversations().updateConversation( + UpdateConversationRequest + .builder() + .id(1) + .displayAs("plaintext") + .read(true) + .title("new conversation title") + .customAttributes( + new HashMap() {{ + put("issue_type", CustomAttributesValue.of("Billing")); + put("priority", CustomAttributesValue.of("High")); + }} + ) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `Integer` — The id of the conversation to target + +
+
+ +
+
+ +**displayAs:** `Optional` — Set to plaintext to retrieve conversation messages in plain text. This affects both the body and subject fields. + +
+
+ +
+
+ +**read:** `Optional` — Mark a conversation as read within Intercom. + +
+
+ +
+
+ +**title:** `Optional` — The title given to the conversation + +
+
+ +
+
+ +**customAttributes:** `Optional>` + +
+
+ +
+
+ +**companyId:** `Optional` — The ID of the company that the conversation is associated with. The unique identifier for the company which is given by Intercom. Set to nil to remove company. + +
+
+
+
+ + +
+
+
+ +
client.unstable.conversations.deleteConversation(id) -> ConversationDeleted +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can delete a single conversation. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().conversations().deleteConversation( + DeleteConversationRequest + .builder() + .id(1) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `Integer` — id + +
+
+
+
+ + +
+
+
+ +
client.unstable.conversations.searchConversations(request) -> ConversationList +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can search for multiple conversations by the value of their attributes in order to fetch exactly which ones you want. + +To search for conversations, you need to send a `POST` request to `https://api.intercom.io/conversations/search`. + +This will accept a query object in the body which will define your filters in order to search for conversations. +{% admonition type="warning" name="Optimizing search queries" %} + Search queries can be complex, so optimizing them can help the performance of your search. + Use the `AND` and `OR` operators to combine multiple filters to get the exact results you need and utilize + pagination to limit the number of results returned. The default is `20` results per page and maximum is `150`. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#example-search-conversations-request) for more details on how to use the `starting_after` param. +{% /admonition %} + +### Nesting & Limitations + +You can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4). +There are some limitations to the amount of multiple's there can be: +- There's a limit of max 2 nested filters +- There's a limit of max 15 filters for each AND or OR group + +### Accepted Fields + +Most keys listed in the conversation model are searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as `created_at` accepts a date, the `value` cannot be a string such as `"foorbar"`). +The `source.body` field is unique as the search will not be performed against the entire value, but instead against every element of the value separately. For example, when searching for a conversation with a `"I need support"` body - the query should contain a `=` operator with the value `"support"` for such conversation to be returned. A query with a `=` operator and a `"need support"` value will not yield a result. + +| Field | Type | +| :---------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------- | +| id | String | +| created_at | Date (UNIX timestamp) | +| updated_at | Date (UNIX timestamp) | +| source.type | String
Accepted fields are `conversation`, `email`, `facebook`, `instagram`, `phone_call`, `phone_switch`, `push`, `sms`, `twitter` and `whatsapp`. | +| source.id | String | +| source.delivered_as | String | +| source.subject | String | +| source.body | String | +| source.author.id | String | +| source.author.type | String | +| source.author.name | String | +| source.author.email | String | +| source.url | String | +| contact_ids | String | +| teammate_ids | String | +| admin_assignee_id | String | +| team_assignee_id | String | +| channel_initiated | String | +| open | Boolean | +| read | Boolean | +| state | String | +| waiting_since | Date (UNIX timestamp) | +| snoozed_until | Date (UNIX timestamp) | +| tag_ids | String | +| priority | String | +| statistics.time_to_assignment | Integer | +| statistics.time_to_admin_reply | Integer | +| statistics.time_to_first_close | Integer | +| statistics.time_to_last_close | Integer | +| statistics.median_time_to_reply | Integer | +| statistics.first_contact_reply_at | Date (UNIX timestamp) | +| statistics.first_assignment_at | Date (UNIX timestamp) | +| statistics.first_admin_reply_at | Date (UNIX timestamp) | +| statistics.first_close_at | Date (UNIX timestamp) | +| statistics.last_assignment_at | Date (UNIX timestamp) | +| statistics.last_assignment_admin_reply_at | Date (UNIX timestamp) | +| statistics.last_contact_reply_at | Date (UNIX timestamp) | +| statistics.last_admin_reply_at | Date (UNIX timestamp) | +| statistics.last_close_at | Date (UNIX timestamp) | +| statistics.last_closed_by_id | String | +| statistics.count_reopens | Integer | +| statistics.count_assignments | Integer | +| statistics.count_conversation_parts | Integer | +| conversation_rating.requested_at | Date (UNIX timestamp) | +| conversation_rating.replied_at | Date (UNIX timestamp) | +| conversation_rating.score | Integer | +| conversation_rating.remark | String | +| conversation_rating.contact_id | String | +| conversation_rating.admin_d | String | +| ai_agent_participated | Boolean | +| ai_agent.resolution_state | String | +| ai_agent.last_answer_type | String | +| ai_agent.rating | Integer | +| ai_agent.rating_remark | String | +| ai_agent.source_type | String | +| ai_agent.source_title | String | + +### Accepted Operators + +The table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string (`"="`). The operator has to be compatible with the field's type (eg. you cannot search with `>` for a given string value as it's only compatible for integer's and dates). + +| Operator | Valid Types | Description | +| :------- | :----------------------------- | :----------------------------------------------------------- | +| = | All | Equals | +| != | All | Doesn't Equal | +| IN | All | In Shortcut for `OR` queries Values most be in Array | +| NIN | All | Not In Shortcut for `OR !` queries Values must be in Array | +| > | Integer Date (UNIX Timestamp) | Greater (or equal) than | +| < | Integer Date (UNIX Timestamp) | Lower (or equal) than | +| ~ | String | Contains | +| !~ | String | Doesn't Contain | +| ^ | String | Starts With | +| $ | String | Ends With | +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().conversations().searchConversations( + SearchRequest + .builder() + .query( + SearchRequestQuery.of( + SingleFilterSearchRequest + .builder() + .value( + SingleFilterSearchRequestValue.of() + ) + .build() + ) + ) + .pagination( + StartingAfterPaging + .builder() + .perPage(5) + .build() + ) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SearchRequest` + +
+
+
+
+ + +
+
+
+ +
client.unstable.conversations.replyConversation(id, request) -> Conversation +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can reply to a conversation with a message from an admin or on behalf of a contact, or with a note for admins. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().conversations().replyConversation( + ReplyConversationRequest + .builder() + .id("123 or \"last\"") + .body( + ReplyConversationRequestBody.of( + ContactReplyConversationRequest.of( + ContactReplyIntercomUserIdRequest + .builder() + .messageType("comment") + .type("user") + .body("Thanks again :)") + .intercomUserId("6762f1571bb69f9f2193bbbb") + .build() + ) + ) + ) + .build() + ); + } +} +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` — The Intercom provisioned identifier for the conversation or the string "last" to reply to the last part of the conversation + +
+
+ +
+
+ +**request:** `ReplyConversationRequestBody` + +
+
+
+
+ + +
+
+
+ +
client.unstable.conversations.manageConversation(id, request) -> Conversation +
+
+ +#### 📝 Description + +
+
+ +
+
+ +For managing conversations you can: +- Close a conversation +- Snooze a conversation to reopen on a future date +- Open a conversation which is `snoozed` or `closed` +- Assign a conversation to an admin and/or team. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().conversations().manageConversation( + ManageConversationRequest + .builder() + .id("123") + .body( + ManageConversationRequestBody.close( + CloseConversationRequest + .builder() + .type("admin") + .adminId("12345") + .build() + ) + ) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` — The identifier for the conversation as given by Intercom. + +
+
+ +
+
+ +**request:** `ManageConversationRequestBody` + +
+
+
+
+ + +
+
+
+ +
client.unstable.conversations.attachContactToConversation(id, request) -> Conversation +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can add participants who are contacts to a conversation, on behalf of either another contact or an admin. + +{% admonition type="warning" name="Contacts without an email" %} +If you add a contact via the email parameter and there is no user/lead found on that workspace with he given email, then we will create a new contact with `role` set to `lead`. +{% /admonition %} + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().conversations().attachContactToConversation( + AttachContactToConversationRequest + .builder() + .id("123") + .adminId("12345") + .customer( + AttachContactToConversationRequestCustomer.of( + AttachContactToConversationRequestCustomerIntercomUserId + .builder() + .intercomUserId("6762f19b1bb69f9f2193bbd4") + .build() + ) + ) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` — The identifier for the conversation as given by Intercom. + +
+
+ +
+
+ +**adminId:** `Optional` — The `id` of the admin who is adding the new participant. + +
+
+ +
+
+ +**customer:** `Optional` + +
+
+
+
+ + +
+
+
+ +
client.unstable.conversations.detachContactFromConversation(conversationId, contactId, request) -> Conversation +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can add participants who are contacts to a conversation, on behalf of either another contact or an admin. + +{% admonition type="warning" name="Contacts without an email" %} +If you add a contact via the email parameter and there is no user/lead found on that workspace with he given email, then we will create a new contact with `role` set to `lead`. +{% /admonition %} + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.conversations().detachContactAsAdmin( + DetachContactFromConversationRequest + .builder() + .conversationId("123") + .contactId("123") + .adminId("5017690") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**conversationId:** `String` — The identifier for the conversation as given by Intercom. + +
+
+ +
+
+ +**contactId:** `String` — The identifier for the contact as given by Intercom. + +
+
+ +
+
+ +**adminId:** `String` — The `id` of the admin who is performing the action. + +
+
+
+
+ + +
+
+
+ +
client.unstable.conversations.listHandlingEvents(id) -> HandlingEventList +
+
+ +#### 📝 Description + +
+
+ +
+
+ +List all pause/resume events for a conversation. These events track when teammates paused or resumed handling a conversation. + +Requires the `read_conversations` OAuth scope. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().conversations().listHandlingEvents( + ListHandlingEventsRequest + .builder() + .id("123") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` — The identifier for the conversation as given by Intercom. + +
+
+
+
+ + +
+
+
+ +
client.unstable.conversations.redactConversation(request) -> Conversation +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can redact a conversation part or the source message of a conversation (as seen in the source object). + +{% admonition type="info" name="Redacting parts and messages" %} +If you are redacting a conversation part, it must have a `body`. If you are redacting a source message, it must have been created by a contact. We will return a `conversation_part_not_redactable` error if these criteria are not met. +{% /admonition %} + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.conversations().redactConversationPart( + RedactConversationRequest.conversationPart( + RedactConversationRequestConversationPart + .builder() + .conversationId("19894788788") + .conversationPartId("19381789428") + .build() + ) +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `RedactConversationRequest` + +
+
+
+
+ + +
+
+
+ +
client.unstable.conversations.convertConversationToTicket(id, request) -> Optional&lt;Ticket&gt; +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can convert a conversation to a ticket. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().conversations().convertConversationToTicket( + ConvertConversationToTicketRequest + .builder() + .id(1) + .ticketTypeId("53") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `Integer` — The id of the conversation to target + +
+
+ +
+
+ +**ticketTypeId:** `String` — The ID of the type of ticket you want to convert the conversation to + +
+
+ +
+
+ +**attributes:** `Optional>` + +
+
+
+
+ + +
+
+
+ +## Unstable CustomChannelEvents +
client.unstable.customChannelEvents.notifyNewConversation(request) -> CustomChannelNotificationResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Notifies Intercom that a new conversation was created in your custom channel/platform. This triggers conversation creation and workflow automations within Intercom for your custom channel integration. +> **Note:** This endpoint is currently under managed availability. Please reach out to your accounts team to discuss access and tailored, hands-on support. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.customChannelEvents().notifyNewConversation( + CustomChannelBaseEvent + .builder() + .eventId("evt_12345") + .externalConversationId("conv_67890") + .contact( + CustomChannelContact + .builder() + .type(CustomChannelContactType.USER) + .externalId("user_001") + .name("Jane Doe") + .email("jane.doe@example.com") + .build() + ) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `CustomChannelBaseEvent` + +
+
+
+
+ + +
+
+
+ +
client.unstable.customChannelEvents.notifyNewMessage(request) -> CustomChannelNotificationResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Notifies Intercom that a new message was sent in a conversation on your custom channel/platform. This allows Intercom to process the message and trigger any relevant workflow automations. +> **Note:** This endpoint is currently under managed availability. Please reach out to your accounts team to discuss access and tailored, hands-on support. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.customChannelEvents().notifyNewMessage( + NotifyNewMessageRequest + .builder() + .eventId("evt_54321") + .externalConversationId("conv_98765") + .contact( + CustomChannelContact + .builder() + .type(CustomChannelContactType.USER) + .externalId("user_002") + .name("John Smith") + .email("john.smith@example.com") + .build() + ) + .body("Hello, I need help with my order.") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**body:** `String` — The message content sent by the user. + +
+
+
+
+ + +
+
+
+ +
client.unstable.customChannelEvents.notifyQuickReplySelected(request) -> CustomChannelNotificationResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Notifies Intercom that a user selected a quick reply option in your custom channel/platform. This allows Intercom to process the response and trigger any relevant workflow automations. +> **Note:** This endpoint is currently under managed availability. Please reach out to your accounts team to discuss access and tailored, hands-on support. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.customChannelEvents().notifyQuickReplySelected( + NotifyQuickReplySelectedRequest + .builder() + .eventId("evt_67890") + .externalConversationId("conv_13579") + .contact( + CustomChannelContact + .builder() + .type(CustomChannelContactType.USER) + .externalId("user_003") + .name("Alice Example") + .email("alice@example.com") + .build() + ) + .quickReplyOptionId("1234") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**quickReplyOptionId:** `String` — Id of the selected quick reply option. + +
+
+
+
+ + +
+
+
+ +
client.unstable.customChannelEvents.notifyAttributeCollected(request) -> CustomChannelNotificationResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Notifies Intercom that a user provided a response to an attribute collector in your custom channel/platform. This allows Intercom to process the attribute and trigger any relevant workflow automations. +> **Note:** This endpoint is currently under managed availability. Please reach out to your accounts team to discuss access and tailored, hands-on support. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.customChannelEvents().notifyAttributeCollected( + NotifyAttributeCollectedRequest + .builder() + .eventId("evt_24680") + .externalConversationId("conv_11223") + .contact( + CustomChannelContact + .builder() + .type(CustomChannelContactType.USER) + .externalId("user_004") + .name("Bob Example") + .email("bob@example.com") + .build() + ) + .attribute( + CustomChannelAttribute + .builder() + .id("shipping_address") + .value("123 Main St, Springfield") + .build() + ) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**attribute:** `CustomChannelAttribute` + +
+
+
+
+ + +
+
+
+ +## Custom Object Instances +
client.unstable.customObjectInstances.getCustomObjectInstancesByExternalId(customObjectTypeIdentifier) -> Optional&lt;CustomObjectInstance&gt; +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Fetch a Custom Object Instance by external_id. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.customObjectInstances().getCustomObjectInstancesByExternalId( + GetCustomObjectInstancesByExternalIdRequest + .builder() + .customObjectTypeIdentifier("Order") + .externalId("external_id") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**customObjectTypeIdentifier:** `String` — The unique identifier of the custom object type that defines the structure of the custom object instance. + +
+
+ +
+
+ +**externalId:** `String` + +
+
+
+
+ + +
+
+
+ +
client.unstable.customObjectInstances.createCustomObjectInstances(customObjectTypeIdentifier, request) -> Optional&lt;CustomObjectInstance&gt; +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Create or update a custom object instance +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.customObjectInstances().createCustomObjectInstances( + CreateOrUpdateCustomObjectInstanceRequest + .builder() + .customObjectTypeIdentifier("Order") + .externalId("123") + .externalCreatedAt(1392036272) + .externalUpdatedAt(1392036272) + .customAttributes( + new HashMap>() {{ + put("order_number", Optional.of("ORDER-12345")); + put("total_amount", Optional.of("custom_attributes")); + }} + ) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**customObjectTypeIdentifier:** `String` — The unique identifier of the custom object type that defines the structure of the custom object instance. + +
+
+ +
+
+ +**externalId:** `Optional` — A unique identifier for the Custom Object instance in the external system it originated from. + +
+
+ +
+
+ +**externalCreatedAt:** `Optional` — The time when the Custom Object instance was created in the external system it originated from. + +
+
+ +
+
+ +**externalUpdatedAt:** `Optional` — The time when the Custom Object instance was last updated in the external system it originated from. + +
+
+ +
+
+ +**customAttributes:** `Optional>>` — The custom attributes which are set for the Custom Object instance. + +
+
+
+
+ + +
+
+
+ +
client.unstable.customObjectInstances.deleteCustomObjectInstancesById(customObjectTypeIdentifier) -> CustomObjectInstanceDeleted +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Delete a single Custom Object instance by external_id. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.customObjectInstances().deleteCustomObjectInstancesById( + DeleteCustomObjectInstancesByIdRequest + .builder() + .customObjectTypeIdentifier("Order") + .externalId("external_id") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**customObjectTypeIdentifier:** `String` — The unique identifier of the custom object type that defines the structure of the custom object instance. + +
+
+ +
+
+ +**externalId:** `String` + +
+
+
+
+ + +
+
+
+ +
client.unstable.customObjectInstances.getCustomObjectInstancesById(customObjectTypeIdentifier, id) -> Optional&lt;CustomObjectInstance&gt; +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Fetch a Custom Object Instance by id. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().customObjectInstances().getCustomObjectInstancesById( + GetCustomObjectInstancesByIdRequest + .builder() + .customObjectTypeIdentifier("Order") + .id("id") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**customObjectTypeIdentifier:** `String` — The unique identifier of the custom object type that defines the structure of the custom object instance. + +
+
+ +
+
+ +**id:** `String` — The id or external_id of the custom object instance + +
+
+
+
+ + +
+
+
+ +
client.unstable.customObjectInstances.deleteCustomObjectInstancesByExternalId(customObjectTypeIdentifier, id) -> CustomObjectInstanceDeleted +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Delete a single Custom Object instance using the Intercom defined id. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().customObjectInstances().deleteCustomObjectInstancesByExternalId( + DeleteCustomObjectInstancesByExternalIdRequest + .builder() + .customObjectTypeIdentifier("Order") + .id("id") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**customObjectTypeIdentifier:** `String` — The unique identifier of the custom object type that defines the structure of the custom object instance. + +
+
+ +
+
+ +**id:** `String` — The Intercom defined id of the custom object instance + +
+
+
+
+ + +
+
+
+ +## Data Attributes +
client.unstable.dataAttributes.lisDataAttributes() -> DataAttributeList +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch a list of all data attributes belonging to a workspace for contacts, companies or conversations. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.dataAttributes().list( + ListDataAttributesRequest + .builder() + .model(DataAttributesListRequestModel.CONTACT) + .includeArchived(true) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**model:** `Optional` — Specify the data attribute model to return. + +
+
+ +
+
+ +**includeArchived:** `Optional` — Include archived attributes in the list. By default we return only non archived data attributes. + +
+
+
+
+ + +
+
+
+ +
client.unstable.dataAttributes.createDataAttribute(request) -> DataAttribute +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can create a data attributes for a `contact` or a `company`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().dataAttributes().createDataAttribute(new +HashMap() {{put("key", "value"); +}}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Object` + +
+
+
+
+ + +
+
+
+ +
client.unstable.dataAttributes.updateDataAttribute(id, request) -> DataAttribute +
+
+ +#### 📝 Description + +
+
+ +
+
+ + +You can update a data attribute. + +> 🚧 Updating the data type is not possible +> +> It is currently a dangerous action to execute changing a data attribute's type via the API. You will need to update the type via the UI instead. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().dataAttributes().updateDataAttribute( + UpdateDataAttributeRequest + .builder() + .id(1) + .body(new + HashMap() {{put("key", "value"); + }}) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `Integer` — The data attribute id + +
+
+ +
+
+ +**request:** `Object` + +
+
+
+
+ + +
+
+
+ +## Data Events +
client.unstable.dataEvents.lisDataEvents() -> DataEventSummary +
+
+ +#### 📝 Description + +
+
+ +
+
+ + +> 🚧 +> +> Please note that you can only 'list' events that are less than 90 days old. Event counts and summaries will still include your events older than 90 days but you cannot 'list' these events individually if they are older than 90 days + +The events belonging to a customer can be listed by sending a GET request to `https://api.intercom.io/events` with a user or lead identifier along with a `type` parameter. The identifier parameter can be one of `user_id`, `email` or `intercom_user_id`. The `type` parameter value must be `user`. + +- `https://api.intercom.io/events?type=user&user_id={user_id}` +- `https://api.intercom.io/events?type=user&email={email}` +- `https://api.intercom.io/events?type=user&intercom_user_id={id}` (this call can be used to list leads) + +The `email` parameter value should be [url encoded](http://en.wikipedia.org/wiki/Percent-encoding) when sending. + +You can optionally define the result page size as well with the `per_page` parameter. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().dataEvents().lisDataEvents( + LisDataEventsRequest + .builder() + .filter( + LisDataEventsRequestFilter.of( + LisDataEventsRequestFilterUserId + .builder() + .userId("user_id") + .build() + ) + ) + .type("type") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**filter:** `LisDataEventsRequestFilter` + +
+
+ +
+
+ +**type:** `String` — The value must be user + +
+
+ +
+
+ +**summary:** `Optional` — summary flag + +
+
+
+
+ + +
+
+
+ +
client.unstable.dataEvents.createDataEvent(request) +
+
+ +#### 📝 Description + +
+
+ +
+
+ + +You will need an Access Token that has write permissions to send Events. Once you have a key you can submit events via POST to the Events resource, which is located at https://api.intercom.io/events, or you can send events using one of the client libraries. When working with the HTTP API directly a client should send the event with a `Content-Type` of `application/json`. + +When using the JavaScript API, [adding the code to your app](http://docs.intercom.io/configuring-Intercom/tracking-user-events-in-your-app) makes the Events API available. Once added, you can submit an event using the `trackEvent` method. This will associate the event with the Lead or currently logged-in user or logged-out visitor/lead and send it to Intercom. The final parameter is a map that can be used to send optional metadata about the event. + +With the Ruby client you pass a hash describing the event to `Intercom::Event.create`, or call the `track_user` method directly on the current user object (e.g. `user.track_event`). + +**NB: For the JSON object types, please note that we do not currently support nested JSON structure.** + +| Type | Description | Example | +| :-------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------- | +| String | The value is a JSON String | `"source":"desktop"` | +| Number | The value is a JSON Number | `"load": 3.67` | +| Date | The key ends with the String `_date` and the value is a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time), assumed to be in the [UTC](http://en.wikipedia.org/wiki/Coordinated_Universal_Time) timezone. | `"contact_date": 1392036272` | +| Link | The value is a HTTP or HTTPS URI. | `"article": "https://example.org/ab1de.html"` | +| Rich Link | The value is a JSON object that contains `url` and `value` keys. | `"article": {"url": "https://example.org/ab1de.html", "value":"the dude abides"}` | +| Monetary Amount | The value is a JSON object that contains `amount` and `currency` keys. The `amount` key is a positive integer representing the amount in cents. The price in the example to the right denotes €349.99. | `"price": {"amount": 34999, "currency": "eur"}` | + +**Lead Events** + +When submitting events for Leads, you will need to specify the Lead's `id`. + +**Metadata behaviour** + +- We currently limit the number of tracked metadata keys to 10 per event. Once the quota is reached, we ignore any further keys we receive. The first 10 metadata keys are determined by the order in which they are sent in with the event. +- It is not possible to change the metadata keys once the event has been sent. A new event will need to be created with the new keys and you can archive the old one. +- There might be up to 24 hrs delay when you send a new metadata for an existing event. + +**Event de-duplication** + +The API may detect and ignore duplicate events. Each event is uniquely identified as a combination of the following data - the Workspace identifier, the Contact external identifier, the Data Event name and the Data Event created time. As a result, it is **strongly recommended** to send a second granularity Unix timestamp in the `created_at` field. + +Duplicated events are responded to using the normal `202 Accepted` code - an error is not thrown, however repeat requests will be counted against any rate limit that is in place. + +### HTTP API Responses + +- Successful responses to submitted events return `202 Accepted` with an empty body. +- Unauthorised access will be rejected with a `401 Unauthorized` or `403 Forbidden` response code. +- Events sent about users that cannot be found will return a `404 Not Found`. +- Event lists containing duplicate events will have those duplicates ignored. +- Server errors will return a `500` response code and may contain an error message in the body. + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().dataEvents().createDataEvent(new +HashMap() {{put("key", "value"); +}}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Object` + +
+
+
+
+ + +
+
+
+ +
client.unstable.dataEvents.dataEventSummaries(request) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Create event summaries for a user. Event summaries are used to track the number of times an event has occurred, the first time it occurred and the last time it occurred. + +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.events().summaries( + ListEventSummariesRequest + .builder() + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**userId:** `Optional` — Your identifier for the user. + +
+
+ +
+
+ +**eventSummaries:** `Optional` — A list of event summaries for the user. Each event summary should contain the event name, the time the event occurred, and the number of times the event occurred. The event name should be a past tense 'verb-noun' combination, to improve readability, for example `updated-plan`. + +
+
+
+
+ + +
+
+
+ +## Data Export +
client.unstable.dataExport.createDataExport(request) -> DataExport +
+
+ +#### 📝 Description + +
+
+ +
+
+ +To create your export job, you need to send a `POST` request to the export endpoint `https://api.intercom.io/export/content/data`. + +The only parameters you need to provide are the range of dates that you want exported. + +>🚧 Limit of one active job +> +> You can only have one active job per workspace. You will receive a HTTP status code of 429 with the message Exceeded rate limit of 1 pending message data export jobs if you attempt to create a second concurrent job. + +>❗️ Updated_at not included +> +> It should be noted that the timeframe only includes messages sent during the time period and not messages that were only updated during this period. For example, if a message was updated yesterday but sent two days ago, you would need to set the created_at_after date before the message was sent to include that in your retrieval job. + +>📘 Date ranges are inclusive +> +> Requesting data for 2018-06-01 until 2018-06-30 will get all data for those days including those specified - e.g. 2018-06-01 00:00:00 until 2018-06-30 23:59:99. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.dataExport().create( + CreateDataExportRequest + .builder() + .createdAtAfter(1734519776) + .createdAtBefore(1734537776) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**createdAtAfter:** `Integer` — The start date that you request data for. It must be formatted as a unix timestamp. + +
+
+ +
+
+ +**createdAtBefore:** `Integer` — The end date that you request data for. It must be formatted as a unix timestamp. + +
+
+
+
+ + +
+
+
+ +
client.unstable.dataExport.getDataExport(jobIdentifier) -> DataExport +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can view the status of your job by sending a `GET` request to the URL +`https://api.intercom.io/export/content/data/{job_identifier}` - the `{job_identifier}` is the value returned in the response when you first created the export job. More on it can be seen in the Export Job Model. + +> 🚧 Jobs expire after two days +> All jobs that have completed processing (and are thus available to download from the provided URL) will have an expiry limit of two days from when the export ob completed. After this, the data will no longer be available. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.dataExport().find( + FindDataExportRequest + .builder() + .jobIdentifier("job_identifier") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**jobIdentifier:** `String` — job_identifier + +
+
+
+
+ + +
+
+
+ +
client.unstable.dataExport.cancelDataExport(jobIdentifier) -> DataExport +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can cancel your job +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.dataExport().cancel( + CancelDataExportRequest + .builder() + .jobIdentifier("job_identifier") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**jobIdentifier:** `String` — job_identifier + +
+
+
+
+ + +
+
+
+ +
client.unstable.dataExport.downloadDataExport(jobIdentifier) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +When a job has a status of complete, and thus a filled download_url, you can download your data by hitting that provided URL, formatted like so: https://api.intercom.io/download/content/data/xyz1234. + +Your exported message data will be streamed continuously back down to you in a gzipped CSV format. + +> 📘 Octet header required +> +> You will have to specify the header Accept: `application/octet-stream` when hitting this endpoint. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.dataExport().download( + DownloadDataExportRequest + .builder() + .jobIdentifier("job_identifier") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**jobIdentifier:** `String` — job_identifier + +
+
+
+
+ + +
+
+
+ +## Workflows +
client.unstable.workflows.exportWorkflow(id) -> WorkflowExport +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Export a workflow configuration by its ID. This endpoint returns the complete workflow definition including its steps, targeting rules, and attributes. + +This endpoint is designed for EU Data Act compliance, allowing customers to export their workflow configurations. + +{% admonition type="warning" name="Unstable API" %} + This API is currently in the Unstable version. Its behavior may change in future releases. +{% /admonition %} +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().workflows().exportWorkflow( + ExportWorkflowRequest + .builder() + .id("12345") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` — The unique identifier for the workflow + +
+
+
+
+ + +
+
+
+ +## Jobs +
client.unstable.jobs.status(id) -> Jobs +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieve the status of job execution. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().jobs().status( + JobsStatusRequest + .builder() + .id("id") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` — The unique identifier for the job which is given by Intercom + +
+
+
+
+ + +
+
+
+ +## Macros +
client.unstable.macros.listMacros() -> MacroList +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch a list of all macros (saved replies) in your workspace for use in automating responses. + +The macros are returned in descending order by updated_at. + +**Pagination** + +This endpoint uses cursor-based pagination via the `starting_after` parameter. The cursor is a Base64-encoded JSON array containing `[updated_at, id]` of the last item from the previous page. + +**Placeholder Transformation** + +The API transforms Intercom placeholders to a more standard XML-like format: +- From: `{{user.name | fallback: 'there'}}` +- To: `` +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().macros().listMacros( + ListMacrosRequest + .builder() + .perPage(1) + .startingAfter("WzE3MTk0OTM3NTcuMCwgIjEyMyJd") + .updatedSince(1000000L) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**perPage:** `Optional` — The number of results per page + +
+
+ +
+
+ +**startingAfter:** `Optional` — Base64-encoded cursor containing [updated_at, id] for pagination + +
+
+ +
+
+ +**updatedSince:** `Optional` — Unix timestamp to filter macros updated after this time + +
+
+
+
+ + +
+
+
+ +
client.unstable.macros.getMacro(id) -> Optional&lt;Macro&gt; +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch a single macro (saved reply) by its ID. The macro will only be returned if it is visible to the authenticated user based on its visibility settings. + +**Visibility Rules** + +A macro is returned based on its `visible_to` setting: +- `everyone`: Always visible to all team members +- `specific_teams`: Only visible if the authenticated user belongs to one of the teams specified in `visible_to_team_ids` + +If a macro exists but is not visible to the authenticated user, a 404 error is returned. + +**Placeholder Transformation** + +The API transforms Intercom placeholders to a more standard XML-like format in the `body` field: +- From: `{{user.name | fallback: 'there'}}` +- To: `` + +Default values in placeholders are HTML-escaped for security. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().macros().getMacro( + GetMacroRequest + .builder() + .id("123") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` — The unique identifier of the macro + +
+
+
+
+ + +
+
+
+ +## Messages +
client.unstable.messages.createMessage(request) -> Message +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can create a message that has been initiated by an admin. The conversation can be either an in-app message, an email, sms or whatsapp. + +> 🚧 Sending for visitors +> +> There can be a short delay between when a contact is created and when a contact becomes available to be messaged through the API. A 404 Not Found error will be returned in this case. + +This will return the Message model that has been created. + +> 🚧 Retrieving Associated Conversations +> +> As this is a message, there will be no conversation present until the contact responds. Once they do, you will have to search for a contact's conversations with the id of the message. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().messages().createMessage(new +HashMap() {{put("from", new + HashMap() {{put("type", "user"); + put("id", "6762f2341bb69f9f2193bc17"); + }}); + put("body", "heyy"); + put("referer", "https://twitter.com/bob"); +}}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Optional` + + + + + + + + + + + +
client.unstable.messages.getWhatsAppMessageStatus() -> WhatsappMessageStatusList +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieves statuses of messages sent from the Outbound module. Currently, this API only supports WhatsApp messages. + + +This endpoint returns paginated status events for WhatsApp messages sent via the Outbound module, providing +information about delivery state and related message details. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().messages().getWhatsAppMessageStatus( + GetWhatsAppMessageStatusRequest + .builder() + .rulesetId("ruleset_id") + .perPage(1) + .startingAfter("starting_after") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**rulesetId:** `String` — The unique identifier for the set of messages to check status for + +
+
+ +
+
+ +**perPage:** `Optional` — Number of results per page (default 50, max 100) + +
+
+ +
+
+ +**startingAfter:** `Optional` — Cursor for pagination, used to fetch the next page of results + +
+
+
+
+ + +
+
+
+ +## News +
client.unstable.news.listNewsItems() -> PaginatedResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch a list of all news items +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.news().items().list(); +``` +
+
+
+
+ + +
+
+
+ +
client.unstable.news.createNewsItem(request) -> NewsItem +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can create a news item +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.news().items().create( + NewsItemRequest + .builder() + .title("Halloween is here!") + .senderId(991267834) + .body("

New costumes in store for this spooky season

") + .state(NewsItemRequestState.LIVE) + .deliverSilently(true) + .labels( + Optional.of( + Arrays.asList("Product", "Update", "New") + ) + ) + .reactions( + Optional.of( + Arrays.asList(Optional.of("😆"), Optional.of("😅")) + ) + ) + .newsfeedAssignments( + Optional.of( + Arrays.asList( + NewsfeedAssignment + .builder() + .newsfeedId(53) + .publishedAt(1664638214) + .build() + ) + ) + ) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `NewsItemRequest` + +
+
+
+
+ + +
+
+
+ +
client.unstable.news.retrieveNewsItem(id) -> NewsItem +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch the details of a single news item. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().news().retrieveNewsItem( + RetrieveNewsItemRequest + .builder() + .id(1) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `Integer` — The unique identifier for the news item which is given by Intercom. + +
+
+
+
+ + +
+
+
+ +
client.unstable.news.updateNewsItem(id, request) -> NewsItem +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().news().updateNewsItem( + UpdateNewsItemRequest + .builder() + .id(1) + .body( + NewsItemRequest + .builder() + .title("Christmas is here!") + .senderId(991267845) + .body("

New gifts in store for the jolly season

") + .reactions( + Optional.of( + Arrays.asList(Optional.of("😝"), Optional.of("😂")) + ) + ) + .build() + ) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `Integer` — The unique identifier for the news item which is given by Intercom. + +
+
+ +
+
+ +**request:** `NewsItemRequest` + +
+
+
+
+ + +
+
+
+ +
client.unstable.news.deleteNewsItem(id) -> DeletedObject +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can delete a single news item. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().news().deleteNewsItem( + DeleteNewsItemRequest + .builder() + .id(1) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `Integer` — The unique identifier for the news item which is given by Intercom. + +
+
+
+
+ + +
+
+
+ +
client.unstable.news.listLiveNewsfeedItems(id) -> PaginatedResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch a list of all news items that are live on a given newsfeed +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().news().listLiveNewsfeedItems( + ListLiveNewsfeedItemsRequest + .builder() + .id("123") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` — The unique identifier for the news feed item which is given by Intercom. + +
+
+
+
+ + +
+
+
+ +
client.unstable.news.listNewsfeeds() -> PaginatedResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch a list of all newsfeeds +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.news().feeds().list(); +``` +
+
+
+
+ + +
+
+
+ +
client.unstable.news.retrieveNewsfeed(id) -> Newsfeed +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch the details of a single newsfeed +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().news().retrieveNewsfeed( + RetrieveNewsfeedRequest + .builder() + .id("123") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` — The unique identifier for the news feed item which is given by Intercom. + +
+
+
+
+ + +
+
+
+ +## Segments +
client.unstable.segments.listSegments() -> SegmentList +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch a list of all segments. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.segments().list( + ListSegmentsRequest + .builder() + .includeCount(true) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**includeCount:** `Optional` — It includes the count of contacts that belong to each segment. + +
+
+
+
+ + +
+
+
+ +
client.unstable.segments.retrieveSegment(id) -> Segment +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch the details of a single segment. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().segments().retrieveSegment( + RetrieveSegmentRequest + .builder() + .id("123") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` — The unique identified of a given segment. + +
+
+
+
+ + +
+
+
+ +## Switch +
client.unstable.switch_.createPhoneSwitch(request) -> Optional&lt;PhoneSwitch&gt; +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can use the API to deflect phone calls to the Intercom Messenger. +Calling this endpoint will send an SMS with a link to the Messenger to the phone number specified. + +If custom attributes are specified, they will be added to the user or lead's custom data attributes. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().switch_().createPhoneSwitch(new +HashMap() {{put("key", "value"); +}}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Object` + +
+
+
+
+ + +
+
+
+ +## Calls +
client.unstable.calls.listCalls() -> CallList +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieve a paginated list of calls. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.calls().listCalls( + ListCallsRequest + .builder() + .page(1) + .perPage(1) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**page:** `Optional` — The page of results to fetch. Defaults to first page + +
+
+ +
+
+ +**perPage:** `Optional` — How many results to display per page. Defaults to 25. Max 25. + +
+
+
+
+ + +
+
+
+ +
client.unstable.calls.showCall(id) -> Call +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieve a single call by id. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().calls().showCall( + ShowCallRequest + .builder() + .id("id") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` — The id of the call to retrieve + +
+
+
+
+ + +
+
+
+ +
client.unstable.calls.showCallRecording(id) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Redirects to a signed URL for the call's recording if it exists. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().calls().showCallRecording( + ShowCallRecordingRequest + .builder() + .id("id") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` — The id of the call + +
+
+
+
+ + +
+
+
+ +
client.unstable.calls.showCallTranscript(id) -> String +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns the transcript for the specified call as a downloadable text file. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().calls().showCallTranscript( + ShowCallTranscriptRequest + .builder() + .id("id") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` — The id of the call + +
+
+
+
+ + +
+
+
+ +
client.unstable.calls.listCallsWithTranscripts(request) -> ListCallsWithTranscriptsResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieve calls by a list of conversation ids and include transcripts when available. +A maximum of 20 `conversation_ids` can be provided. If none are provided or more than 20 are provided, a 400 error is returned. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.calls().listCallsWithTranscripts( + ListCallsWithTranscriptsRequest + .builder() + .conversationIds( + Arrays.asList("64619700005694", "64619700005695") + ) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**conversationIds:** `List` — A list of conversation ids to fetch calls for. Maximum 20. + +
+
+
+
+ + +
+
+
+ +
client.unstable.calls.registerFinVoiceCall(request) -> AiCallResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Register a Fin Voice call with Intercom. This endpoint creates an external reference +that links an external call identifier to an Intercom call and conversation. + +The call can be from different sources: +- AWS Connect (default) +- Five9 +- Zoom Phone +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().calls().registerFinVoiceCall( + Optional.of( + RegisterFinVoiceCallRequest + .builder() + .phoneNumber("+1234567890") + .callId("call-123-abc") + .build() + ) +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Optional` + +
+
+
+
+ + +
+
+
+ +
client.unstable.calls.collectFinVoiceCallById(id) -> AiCallResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieve information about a Fin Voice call using the external reference ID. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().calls().collectFinVoiceCallById( + CollectFinVoiceCallByIdRequest + .builder() + .id(1) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `Integer` — The external reference ID + +
+
+
+
+ + +
+
+
+ +
client.unstable.calls.collectFinVoiceCallByExternalId(externalId) -> AiCallResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieve information about a Fin Voice call using the external call identifier. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().calls().collectFinVoiceCallByExternalId( + CollectFinVoiceCallByExternalIdRequest + .builder() + .externalId("external_id") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**externalId:** `String` — The external call identifier from the call provider + +
+
+
+
+ + +
+
+
+ +
client.unstable.calls.collectFinVoiceCallByPhoneNumber(phoneNumber) -> Error +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieve information about a Fin Voice call using the phone number. + +Returns the most recent matched call for the given phone number, ordered by creation date. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().calls().collectFinVoiceCallByPhoneNumber( + CollectFinVoiceCallByPhoneNumberRequest + .builder() + .phoneNumber("phone_number") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**phoneNumber:** `String` — Phone number in E.164 format + +
+
+
+
+ + +
+
+
+ +## Teams +
client.unstable.teams.listTeams() -> TeamList +
+
+ +#### 📝 Description + +
+
+ +
+
+ +This will return a list of team objects for the App. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.teams().list(); +``` +
+
+
+
+ + +
+
+
+ +
client.unstable.teams.retrieveTeam(id) -> Team +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch the details of a single team, containing an array of admins that belong to this team. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().teams().retrieveTeam( + RetrieveTeamRequest + .builder() + .id("123") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` — The unique identifier of a given team. + +
+
+
+
+ + +
+
+
+ +## Ticket States +
client.unstable.ticketStates.listTicketStates() -> TicketStateList +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can get a list of all ticket states for a workspace. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.ticketStates().listTicketStates(); +``` +
+
+
+
+ + +
+
+
+ +## Ticket Type Attributes +
client.unstable.ticketTypeAttributes.createTicketTypeAttribute(ticketTypeId, request) -> Optional&lt;TicketTypeAttribute&gt; +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can create a new attribute for a ticket type. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.ticketTypes().attributes().create( + CreateTicketTypeAttributeRequest + .builder() + .ticketTypeId("ticket_type_id") + .name("Attribute Title") + .description("Attribute Description") + .dataType(CreateTicketTypeAttributeRequestDataType.STRING) + .requiredToCreate(false) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**ticketTypeId:** `String` — The unique identifier for the ticket type which is given by Intercom. + +
+
+ +
+
+ +**name:** `String` — The name of the ticket type attribute + +
+
+ +
+
+ +**description:** `String` — The description of the attribute presented to the teammate or contact + +
+
+ +
+
+ +**dataType:** `CreateTicketTypeAttributeRequestDataType` — The data type of the attribute + +
+
+ +
+
+ +**requiredToCreate:** `Optional` — Whether the attribute is required to be filled in when teammates are creating the ticket in Inbox. + +
+
+ +
+
+ +**requiredToCreateForContacts:** `Optional` — Whether the attribute is required to be filled in when contacts are creating the ticket in Messenger. + +
+
+ +
+
+ +**visibleOnCreate:** `Optional` — Whether the attribute is visible to teammates when creating a ticket in Inbox. + +
+
+ +
+
+ +**visibleToContacts:** `Optional` — Whether the attribute is visible to contacts when creating a ticket in Messenger. + +
+
+ +
+
+ +**multiline:** `Optional` — Whether the attribute allows multiple lines of text (only applicable to string attributes) + +
+
+ +
+
+ +**listItems:** `Optional` — A comma delimited list of items for the attribute value (only applicable to list attributes) + +
+
+ +
+
+ +**allowMultipleValues:** `Optional` — Whether the attribute allows multiple files to be attached to it (only applicable to file attributes) + +
+
+
+
+ + +
+
+
+ +
client.unstable.ticketTypeAttributes.updateTicketTypeAttribute(ticketTypeId, id, request) -> Optional&lt;TicketTypeAttribute&gt; +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can update an existing attribute for a ticket type. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().ticketTypeAttributes().updateTicketTypeAttribute( + UpdateTicketTypeAttributeRequest + .builder() + .ticketTypeId("ticket_type_id") + .id("id") + .description("New Attribute Description") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**ticketTypeId:** `String` — The unique identifier for the ticket type which is given by Intercom. + +
+
+ +
+
+ +**id:** `String` — The unique identifier for the ticket type attribute which is given by Intercom. + +
+
+ +
+
+ +**name:** `Optional` — The name of the ticket type attribute + +
+
+ +
+
+ +**description:** `Optional` — The description of the attribute presented to the teammate or contact + +
+
+ +
+
+ +**requiredToCreate:** `Optional` — Whether the attribute is required to be filled in when teammates are creating the ticket in Inbox. + +
+
+ +
+
+ +**requiredToCreateForContacts:** `Optional` — Whether the attribute is required to be filled in when contacts are creating the ticket in Messenger. + +
+
+ +
+
+ +**visibleOnCreate:** `Optional` — Whether the attribute is visible to teammates when creating a ticket in Inbox. + +
+
+ +
+
+ +**visibleToContacts:** `Optional` — Whether the attribute is visible to contacts when creating a ticket in Messenger. + +
+
+ +
+
+ +**multiline:** `Optional` — Whether the attribute allows multiple lines of text (only applicable to string attributes) + +
+
+ +
+
+ +**listItems:** `Optional` — A comma delimited list of items for the attribute value (only applicable to list attributes) + +
+
+ +
+
+ +**allowMultipleValues:** `Optional` — Whether the attribute allows multiple files to be attached to it (only applicable to file attributes) + +
+
+ +
+
+ +**archived:** `Optional` — Whether the attribute should be archived and not shown during creation of the ticket (it will still be present on previously created tickets) + +
+
+
+
+ + +
+
+
+ +## Ticket Types +
client.unstable.ticketTypes.listTicketTypes() -> TicketTypeList +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can get a list of all ticket types for a workspace. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.ticketTypes().list(); +``` +
+
+
+
+ + +
+
+
+ +
client.unstable.ticketTypes.createTicketType(request) -> Optional&lt;TicketType&gt; +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can create a new ticket type. +> 📘 Creating ticket types. +> +> Every ticket type will be created with two default attributes: _default_title_ and _default_description_. +> For the `icon` propery, use an emoji from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/) +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().ticketTypes().createTicketType(new +HashMap() {{put("key", "value"); +}}); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Object` + +
+
+
+
+ + +
+
+
+ +
client.unstable.ticketTypes.getTicketType(id) -> Optional&lt;TicketType&gt; +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch the details of a single ticket type. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().ticketTypes().getTicketType( + GetTicketTypeRequest + .builder() + .id("id") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` — The unique identifier for the ticket type which is given by Intercom. + +
+
+
+
+ + +
+
+
+ +## Tickets +
client.unstable.tickets.replyTicket(id, request) -> TicketReply +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can reply to a ticket with a message from an admin or on behalf of a contact, or with a note for admins. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().tickets().replyTicket( + ReplyTicketRequest + .builder() + .id("123") + .body( + ReplyTicketRequestBody.of( + ContactReplyTicketRequest.of( + ContactReplyTicketIntercomUserIdRequest + .builder() + .messageType("comment") + .type("user") + .body("Thanks again :)") + .intercomUserId("6762f2971bb69f9f2193bc49") + .build() + ) + ) + ) + .build() + ); + } +} +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` + +
+
+ +
+
+ +**request:** `ReplyTicketRequestBody` + +
+
+
+
+ + +
+
+
+ +
client.unstable.tickets.enqueueCreateTicket(request) -> Jobs +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Enqueues ticket creation for asynchronous processing, returning if the job was enqueued successfully to be processed. We attempt to perform a best-effort validation on inputs before tasks are enqueued. If the given parameters are incorrect, we won't enqueue the job. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.tickets().enqueueCreateTicket( + EnqueueCreateTicketRequest + .builder() + .ticketTypeId("1234") + .contacts( + Arrays.asList( + CreateTicketRequestContactsItem.of( + CreateTicketRequestContactsItemId + .builder() + .id("6762f2d81bb69f9f2193bc54") + .build() + ) + ) + ) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**skipNotifications:** `Optional` — Option to disable notifications when a Ticket is created. + +
+
+
+
+ + +
+
+
+ +
client.unstable.tickets.getTicket(id) -> Optional&lt;Ticket&gt; +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch the details of a single ticket. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().tickets().getTicket( + GetTicketRequest + .builder() + .id("id") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` — The unique identifier for the ticket which is given by Intercom. + +
+
+
+
+ + +
+
+
+ +
client.unstable.tickets.updateTicket(id, request) -> Optional&lt;Ticket&gt; +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can update a ticket. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().tickets().updateTicket( + UpdateTicketRequest + .builder() + .id("id") + .ticketAttributes( + new HashMap() {{ + put("_default_title_", "example"); + put("_default_description_", "there is a problem"); + }} + ) + .ticketStateId("123") + .open(true) + .snoozedUntil(1673609604) + .adminId(991268011) + .assigneeId("123") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` — The unique identifier for the ticket which is given by Intercom + +
+
+ +
+
+ +**ticketAttributes:** `Optional>` — The attributes set on the ticket. + +
+
+ +
+
+ +**ticketStateId:** `Optional` — The ID of the ticket state associated with the ticket type. + +
+
+ +
+
+ +**companyId:** `Optional` — The ID of the company that the ticket is associated with. The unique identifier for the company which is given by Intercom. Set to nil to remove company. + +
+
+ +
+
+ +**open:** `Optional` — Specify if a ticket is open. Set to false to close a ticket. Closing a ticket will also unsnooze it. + +
+
+ +
+
+ +**isShared:** `Optional` — Specify whether the ticket is visible to users. + +
+
+ +
+
+ +**snoozedUntil:** `Optional` — The time you want the ticket to reopen. + +
+
+ +
+
+ +**adminId:** `Optional` — The ID of the admin performing ticket update. Needed for workflows execution and attributing actions to specific admins. + +
+
+ +
+
+ +**assigneeId:** `Optional` — The ID of the admin or team to which the ticket is assigned. Set this 0 to unassign it. + +
+
+
+
+ + +
+
+
+ +
client.unstable.tickets.deleteTicket(id) -> DeleteTicketResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can delete a ticket using the Intercom provided ID. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().tickets().deleteTicket( + DeleteTicketRequest + .builder() + .id("id") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` — The unique identifier for the ticket which is given by Intercom. + +
+
+
+
+ + +
+
+
+ +
client.unstable.tickets.searchTickets(request) -> TicketList +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can search for multiple tickets by the value of their attributes in order to fetch exactly which ones you want. + +To search for tickets, you send a `POST` request to `https://api.intercom.io/tickets/search`. + +This will accept a query object in the body which will define your filters. +{% admonition type="warning" name="Optimizing search queries" %} + Search queries can be complex, so optimizing them can help the performance of your search. + Use the `AND` and `OR` operators to combine multiple filters to get the exact results you need and utilize + pagination to limit the number of results returned. The default is `20` results per page. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#example-search-conversations-request) for more details on how to use the `starting_after` param. +{% /admonition %} + +### Nesting & Limitations + +You can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4). +There are some limitations to the amount of multiples there can be: +- There's a limit of max 2 nested filters +- There's a limit of max 15 filters for each AND or OR group + +### Accepted Fields + +Most keys listed as part of the Ticket model are searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as `created_at` accepts a date, the `value` cannot be a string such as `"foobar"`). +The `source.body` field is unique as the search will not be performed against the entire value, but instead against every element of the value separately. For example, when searching for a conversation with a `"I need support"` body - the query should contain a `=` operator with the value `"support"` for such conversation to be returned. A query with a `=` operator and a `"need support"` value will not yield a result. + +| Field | Type | +| :---------------------------------------- | :--------------------------------------------------------------------------------------- | +| id | String | +| created_at | Date (UNIX timestamp) | +| updated_at | Date (UNIX timestamp) | +| title | String | +| description | String | +| category | String | +| ticket_type_id | String | +| contact_ids | String | +| teammate_ids | String | +| admin_assignee_id | String | +| team_assignee_id | String | +| open | Boolean | +| state | String | +| snoozed_until | Date (UNIX timestamp) | +| ticket_attribute.{id} | String or Boolean or Date (UNIX timestamp) or Float or Integer | + +{% admonition type="info" name="Searching by Category" %} +When searching for tickets by the **`category`** field, specific terms must be used instead of the category names: +* For **Customer** category tickets, use the term `request`. +* For **Back-office** category tickets, use the term `task`. +* For **Tracker** category tickets, use the term `tracker`. +{% /admonition %} + +### Accepted Operators + +{% admonition type="info" name="Searching based on `created_at`" %} + You may use the `<=` or `>=` operators to search by `created_at`. +{% /admonition %} + +The table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string (`"="`). The operator has to be compatible with the field's type (eg. you cannot search with `>` for a given string value as it's only compatible for integer's and dates). + +| Operator | Valid Types | Description | +| :------- | :----------------------------- | :----------------------------------------------------------- | +| = | All | Equals | +| != | All | Doesn't Equal | +| IN | All | In Shortcut for `OR` queries Values most be in Array | +| NIN | All | Not In Shortcut for `OR !` queries Values must be in Array | +| > | Integer Date (UNIX Timestamp) | Greater (or equal) than | +| < | Integer Date (UNIX Timestamp) | Lower (or equal) than | +| ~ | String | Contains | +| !~ | String | Doesn't Contain | +| ^ | String | Starts With | +| $ | String | Ends With | +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().tickets().searchTickets( + SearchRequest + .builder() + .query( + SearchRequestQuery.of( + SingleFilterSearchRequest + .builder() + .value( + SingleFilterSearchRequestValue.of() + ) + .build() + ) + ) + .pagination( + StartingAfterPaging + .builder() + .perPage(5) + .build() + ) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `SearchRequest` + +
+
+
+
+ + +
+
+
+ +## Visitors +
client.unstable.visitors.retrieveVisitorWithUserId() -> Optional&lt;Visitor&gt; +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can fetch the details of a single visitor. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.visitors().find( + FindVisitorRequest + .builder() + .userId("user_id") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**userId:** `String` — The user_id of the Visitor you want to retrieve. + +
+
+
+
+ + +
+
+
+ +
client.unstable.visitors.updateVisitor(request) -> Optional&lt;Visitor&gt; +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Sending a PUT request to `/visitors` will result in an update of an existing Visitor. + +**Option 1.** You can update a visitor by passing in the `user_id` of the visitor in the Request body. + +**Option 2.** You can update a visitor by passing in the `id` of the visitor in the Request body. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.visitors().update( + UpdateVisitorRequest.of( + UpdateVisitorRequestWithId + .builder() + .id("6762f30c1bb69f9f2193bc5e") + .name("Gareth Bale") + .build() + ) +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Object` + +
+
+
+
+ + +
+
+
+ +
client.unstable.visitors.convertVisitor(request) -> Contact +
+
+ +#### 📝 Description + +
+
+ +
+
+ +You can merge a Visitor to a Contact of role type `lead` or `user`. + +> 📘 What happens upon a visitor being converted? +> +> If the User exists, then the Visitor will be merged into it, the Visitor deleted and the User returned. If the User does not exist, the Visitor will be converted to a User, with the User identifiers replacing it's Visitor identifiers. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().visitors().convertVisitor( + ConvertVisitorRequest + .builder() + .type("user") + .user(new + HashMap() {{put("email", "foo@bar.com"); + }}) + .visitor(new + HashMap() {{put("user_id", "3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3"); + }}) + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**type:** `String` — Represents the role of the Contact model. Accepts `lead` or `user`. + +
+
+ +
+
+ +**user:** `Object` + +
+
+ +
+
+ +**visitor:** `Object` + +
+
+
+
+ + +
+
+
+ +## Brands +
client.unstable.brands.listBrands() -> BrandList +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieves all brands for the workspace, including the default brand. +The default brand id always matches the workspace +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().brands().listBrands(); +``` +
+
+
+
+ + +
+
+
+ +
client.unstable.brands.retrieveBrand(id) -> Brand +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Fetches a specific brand by its unique identifier +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().brands().retrieveBrand( + RetrieveBrandRequest + .builder() + .id("id") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` — The unique identifier of the brand + +
+
+
+
+ + +
+
+
+ +## Emails +
client.unstable.emails.listEmails() -> EmailList +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Lists all sender email address settings for the workspace +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().emails().listEmails(); +``` +
+
+
+
+ + +
+
+
+ +
client.unstable.emails.retrieveEmail(id) -> EmailSetting +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Fetches a specific email setting by its unique identifier +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```java +client.unstable().emails().retrieveEmail( + RetrieveEmailRequest + .builder() + .id("id") + .build() +); +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `String` — The unique identifier of the email setting + +
+
+
+
+ + +
+
+
diff --git a/sample-app/build.gradle b/sample-app/build.gradle new file mode 100644 index 00000000..4ee8f227 --- /dev/null +++ b/sample-app/build.gradle @@ -0,0 +1,19 @@ +plugins { + id 'java-library' +} + +repositories { + mavenCentral() + maven { + url 'https://s01.oss.sonatype.org/content/repositories/releases/' + } +} + +dependencies { + implementation rootProject +} + + +sourceCompatibility = 1.8 +targetCompatibility = 1.8 + diff --git a/sample-app/src/main/java/sample/App.java b/sample-app/src/main/java/sample/App.java new file mode 100644 index 00000000..52575f19 --- /dev/null +++ b/sample-app/src/main/java/sample/App.java @@ -0,0 +1,13 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ + +package sample; + +import java.lang.String; + +public final class App { + public static void main(String[] args) { + // import com.intercom.api.AsyncIntercom + } +} diff --git a/settings.gradle b/settings.gradle index 4c086d76..486d83d2 100644 --- a/settings.gradle +++ b/settings.gradle @@ -1 +1,3 @@ -modules.split(',').each { include it } \ No newline at end of file +rootProject.name = 'intercom-java' + +include 'sample-app' \ No newline at end of file diff --git a/src/main/java/com/intercom/api/AsyncIntercom.java b/src/main/java/com/intercom/api/AsyncIntercom.java new file mode 100644 index 00000000..1bb82ba7 --- /dev/null +++ b/src/main/java/com/intercom/api/AsyncIntercom.java @@ -0,0 +1,268 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api; + +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.Suppliers; +import com.intercom.api.resources.admins.AsyncAdminsClient; +import com.intercom.api.resources.aicontent.AsyncAiContentClient; +import com.intercom.api.resources.articles.AsyncArticlesClient; +import com.intercom.api.resources.awaystatusreasons.AsyncAwayStatusReasonsClient; +import com.intercom.api.resources.calls.AsyncCallsClient; +import com.intercom.api.resources.companies.AsyncCompaniesClient; +import com.intercom.api.resources.contacts.AsyncContactsClient; +import com.intercom.api.resources.conversations.AsyncConversationsClient; +import com.intercom.api.resources.customchannelevents.AsyncCustomChannelEventsClient; +import com.intercom.api.resources.customobjectinstances.AsyncCustomObjectInstancesClient; +import com.intercom.api.resources.dataattributes.AsyncDataAttributesClient; +import com.intercom.api.resources.dataexport.AsyncDataExportClient; +import com.intercom.api.resources.events.AsyncEventsClient; +import com.intercom.api.resources.export.AsyncExportClient; +import com.intercom.api.resources.helpcenters.AsyncHelpCentersClient; +import com.intercom.api.resources.internalarticles.AsyncInternalArticlesClient; +import com.intercom.api.resources.ipallowlist.AsyncIpAllowlistClient; +import com.intercom.api.resources.jobs.AsyncJobsClient; +import com.intercom.api.resources.messages.AsyncMessagesClient; +import com.intercom.api.resources.news.AsyncNewsClient; +import com.intercom.api.resources.notes.AsyncNotesClient; +import com.intercom.api.resources.phonecallredirects.AsyncPhoneCallRedirectsClient; +import com.intercom.api.resources.segments.AsyncSegmentsClient; +import com.intercom.api.resources.subscriptiontypes.AsyncSubscriptionTypesClient; +import com.intercom.api.resources.tags.AsyncTagsClient; +import com.intercom.api.resources.teams.AsyncTeamsClient; +import com.intercom.api.resources.tickets.AsyncTicketsClient; +import com.intercom.api.resources.ticketstates.AsyncTicketStatesClient; +import com.intercom.api.resources.tickettypes.AsyncTicketTypesClient; +import com.intercom.api.resources.unstable.AsyncUnstableClient; +import com.intercom.api.resources.visitors.AsyncVisitorsClient; +import java.util.function.Supplier; + +public class AsyncIntercom { + protected final ClientOptions clientOptions; + + protected final Supplier adminsClient; + + protected final Supplier aiContentClient; + + protected final Supplier articlesClient; + + protected final Supplier awayStatusReasonsClient; + + protected final Supplier exportClient; + + protected final Supplier dataExportClient; + + protected final Supplier helpCentersClient; + + protected final Supplier internalArticlesClient; + + protected final Supplier ipAllowlistClient; + + protected final Supplier companiesClient; + + protected final Supplier contactsClient; + + protected final Supplier notesClient; + + protected final Supplier tagsClient; + + protected final Supplier conversationsClient; + + protected final Supplier customChannelEventsClient; + + protected final Supplier customObjectInstancesClient; + + protected final Supplier dataAttributesClient; + + protected final Supplier eventsClient; + + protected final Supplier jobsClient; + + protected final Supplier messagesClient; + + protected final Supplier segmentsClient; + + protected final Supplier subscriptionTypesClient; + + protected final Supplier phoneCallRedirectsClient; + + protected final Supplier callsClient; + + protected final Supplier teamsClient; + + protected final Supplier ticketStatesClient; + + protected final Supplier ticketTypesClient; + + protected final Supplier ticketsClient; + + protected final Supplier visitorsClient; + + protected final Supplier newsClient; + + protected final Supplier unstableClient; + + public AsyncIntercom(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + this.adminsClient = Suppliers.memoize(() -> new AsyncAdminsClient(clientOptions)); + this.aiContentClient = Suppliers.memoize(() -> new AsyncAiContentClient(clientOptions)); + this.articlesClient = Suppliers.memoize(() -> new AsyncArticlesClient(clientOptions)); + this.awayStatusReasonsClient = Suppliers.memoize(() -> new AsyncAwayStatusReasonsClient(clientOptions)); + this.exportClient = Suppliers.memoize(() -> new AsyncExportClient(clientOptions)); + this.dataExportClient = Suppliers.memoize(() -> new AsyncDataExportClient(clientOptions)); + this.helpCentersClient = Suppliers.memoize(() -> new AsyncHelpCentersClient(clientOptions)); + this.internalArticlesClient = Suppliers.memoize(() -> new AsyncInternalArticlesClient(clientOptions)); + this.ipAllowlistClient = Suppliers.memoize(() -> new AsyncIpAllowlistClient(clientOptions)); + this.companiesClient = Suppliers.memoize(() -> new AsyncCompaniesClient(clientOptions)); + this.contactsClient = Suppliers.memoize(() -> new AsyncContactsClient(clientOptions)); + this.notesClient = Suppliers.memoize(() -> new AsyncNotesClient(clientOptions)); + this.tagsClient = Suppliers.memoize(() -> new AsyncTagsClient(clientOptions)); + this.conversationsClient = Suppliers.memoize(() -> new AsyncConversationsClient(clientOptions)); + this.customChannelEventsClient = Suppliers.memoize(() -> new AsyncCustomChannelEventsClient(clientOptions)); + this.customObjectInstancesClient = Suppliers.memoize(() -> new AsyncCustomObjectInstancesClient(clientOptions)); + this.dataAttributesClient = Suppliers.memoize(() -> new AsyncDataAttributesClient(clientOptions)); + this.eventsClient = Suppliers.memoize(() -> new AsyncEventsClient(clientOptions)); + this.jobsClient = Suppliers.memoize(() -> new AsyncJobsClient(clientOptions)); + this.messagesClient = Suppliers.memoize(() -> new AsyncMessagesClient(clientOptions)); + this.segmentsClient = Suppliers.memoize(() -> new AsyncSegmentsClient(clientOptions)); + this.subscriptionTypesClient = Suppliers.memoize(() -> new AsyncSubscriptionTypesClient(clientOptions)); + this.phoneCallRedirectsClient = Suppliers.memoize(() -> new AsyncPhoneCallRedirectsClient(clientOptions)); + this.callsClient = Suppliers.memoize(() -> new AsyncCallsClient(clientOptions)); + this.teamsClient = Suppliers.memoize(() -> new AsyncTeamsClient(clientOptions)); + this.ticketStatesClient = Suppliers.memoize(() -> new AsyncTicketStatesClient(clientOptions)); + this.ticketTypesClient = Suppliers.memoize(() -> new AsyncTicketTypesClient(clientOptions)); + this.ticketsClient = Suppliers.memoize(() -> new AsyncTicketsClient(clientOptions)); + this.visitorsClient = Suppliers.memoize(() -> new AsyncVisitorsClient(clientOptions)); + this.newsClient = Suppliers.memoize(() -> new AsyncNewsClient(clientOptions)); + this.unstableClient = Suppliers.memoize(() -> new AsyncUnstableClient(clientOptions)); + } + + public AsyncAdminsClient admins() { + return this.adminsClient.get(); + } + + public AsyncAiContentClient aiContent() { + return this.aiContentClient.get(); + } + + public AsyncArticlesClient articles() { + return this.articlesClient.get(); + } + + public AsyncAwayStatusReasonsClient awayStatusReasons() { + return this.awayStatusReasonsClient.get(); + } + + public AsyncExportClient export() { + return this.exportClient.get(); + } + + public AsyncDataExportClient dataExport() { + return this.dataExportClient.get(); + } + + public AsyncHelpCentersClient helpCenters() { + return this.helpCentersClient.get(); + } + + public AsyncInternalArticlesClient internalArticles() { + return this.internalArticlesClient.get(); + } + + public AsyncIpAllowlistClient ipAllowlist() { + return this.ipAllowlistClient.get(); + } + + public AsyncCompaniesClient companies() { + return this.companiesClient.get(); + } + + public AsyncContactsClient contacts() { + return this.contactsClient.get(); + } + + public AsyncNotesClient notes() { + return this.notesClient.get(); + } + + public AsyncTagsClient tags() { + return this.tagsClient.get(); + } + + public AsyncConversationsClient conversations() { + return this.conversationsClient.get(); + } + + public AsyncCustomChannelEventsClient customChannelEvents() { + return this.customChannelEventsClient.get(); + } + + public AsyncCustomObjectInstancesClient customObjectInstances() { + return this.customObjectInstancesClient.get(); + } + + public AsyncDataAttributesClient dataAttributes() { + return this.dataAttributesClient.get(); + } + + public AsyncEventsClient events() { + return this.eventsClient.get(); + } + + public AsyncJobsClient jobs() { + return this.jobsClient.get(); + } + + public AsyncMessagesClient messages() { + return this.messagesClient.get(); + } + + public AsyncSegmentsClient segments() { + return this.segmentsClient.get(); + } + + public AsyncSubscriptionTypesClient subscriptionTypes() { + return this.subscriptionTypesClient.get(); + } + + public AsyncPhoneCallRedirectsClient phoneCallRedirects() { + return this.phoneCallRedirectsClient.get(); + } + + public AsyncCallsClient calls() { + return this.callsClient.get(); + } + + public AsyncTeamsClient teams() { + return this.teamsClient.get(); + } + + public AsyncTicketStatesClient ticketStates() { + return this.ticketStatesClient.get(); + } + + public AsyncTicketTypesClient ticketTypes() { + return this.ticketTypesClient.get(); + } + + public AsyncTicketsClient tickets() { + return this.ticketsClient.get(); + } + + public AsyncVisitorsClient visitors() { + return this.visitorsClient.get(); + } + + public AsyncNewsClient news() { + return this.newsClient.get(); + } + + public AsyncUnstableClient unstable() { + return this.unstableClient.get(); + } + + public static AsyncIntercomBuilder builder() { + return new AsyncIntercomBuilder(); + } +} diff --git a/src/main/java/com/intercom/api/AsyncIntercomBuilder.java b/src/main/java/com/intercom/api/AsyncIntercomBuilder.java new file mode 100644 index 00000000..e01c37bf --- /dev/null +++ b/src/main/java/com/intercom/api/AsyncIntercomBuilder.java @@ -0,0 +1,206 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api; + +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.Environment; +import java.util.HashMap; +import java.util.Map; +import java.util.Optional; +import okhttp3.OkHttpClient; + +public class AsyncIntercomBuilder { + private Optional timeout = Optional.empty(); + + private Optional maxRetries = Optional.empty(); + + private final Map customHeaders = new HashMap<>(); + + private String token = System.getenv("INTERCOM_API_KEY"); + + private Environment environment = Environment.US_PRODUCTION; + + private OkHttpClient httpClient; + + /** + * Sets token. + * Defaults to the INTERCOM_API_KEY environment variable. + */ + public AsyncIntercomBuilder token(String token) { + this.token = token; + return this; + } + + public AsyncIntercomBuilder environment(Environment environment) { + this.environment = environment; + return this; + } + + public AsyncIntercomBuilder url(String url) { + this.environment = Environment.custom(url); + return this; + } + + /** + * Sets the timeout (in seconds) for the client. Defaults to 60 seconds. + */ + public AsyncIntercomBuilder timeout(int timeout) { + this.timeout = Optional.of(timeout); + return this; + } + + /** + * Sets the maximum number of retries for the client. Defaults to 2 retries. + */ + public AsyncIntercomBuilder maxRetries(int maxRetries) { + this.maxRetries = Optional.of(maxRetries); + return this; + } + + /** + * Sets the underlying OkHttp client + */ + public AsyncIntercomBuilder httpClient(OkHttpClient httpClient) { + this.httpClient = httpClient; + return this; + } + + /** + * Add a custom header to be sent with all requests. + * For headers that need to be computed dynamically or conditionally, use the setAdditional() method override instead. + * + * @param name The header name + * @param value The header value + * @return This builder for method chaining + */ + public AsyncIntercomBuilder addHeader(String name, String value) { + this.customHeaders.put(name, value); + return this; + } + + protected ClientOptions buildClientOptions() { + ClientOptions.Builder builder = ClientOptions.builder(); + setEnvironment(builder); + setAuthentication(builder); + setHttpClient(builder); + setTimeouts(builder); + setRetries(builder); + for (Map.Entry header : this.customHeaders.entrySet()) { + builder.addHeader(header.getKey(), header.getValue()); + } + setAdditional(builder); + return builder.build(); + } + + /** + * Sets the environment configuration for the client. + * Override this method to modify URLs or add environment-specific logic. + * + * @param builder The ClientOptions.Builder to configure + */ + protected void setEnvironment(ClientOptions.Builder builder) { + builder.environment(this.environment); + } + + /** + * Override this method to customize authentication. + * This method is called during client options construction to set up authentication headers. + * + * @param builder The ClientOptions.Builder to configure + * + * Example: + * 
{@code
+     * @Override
+     * protected void setAuthentication(ClientOptions.Builder builder) {
+     *     super.setAuthentication(builder); // Keep existing auth
+     *     builder.addHeader("X-API-Key", this.apiKey);
+     * }
+     * }
+ */ + protected void setAuthentication(ClientOptions.Builder builder) { + if (this.token != null) { + builder.addHeader("Authorization", "Bearer " + this.token); + } + } + + /** + * Sets the request timeout configuration. + * Override this method to customize timeout behavior. + * + * @param builder The ClientOptions.Builder to configure + */ + protected void setTimeouts(ClientOptions.Builder builder) { + if (this.timeout.isPresent()) { + builder.timeout(this.timeout.get()); + } + } + + /** + * Sets the retry configuration for failed requests. + * Override this method to implement custom retry strategies. + * + * @param builder The ClientOptions.Builder to configure + */ + protected void setRetries(ClientOptions.Builder builder) { + if (this.maxRetries.isPresent()) { + builder.maxRetries(this.maxRetries.get()); + } + } + + /** + * Sets the OkHttp client configuration. + * Override this method to customize HTTP client behavior (interceptors, connection pools, etc). + * + * @param builder The ClientOptions.Builder to configure + */ + protected void setHttpClient(ClientOptions.Builder builder) { + if (this.httpClient != null) { + builder.httpClient(this.httpClient); + } + } + + /** + * Override this method to add any additional configuration to the client. + * This method is called at the end of the configuration chain, allowing you to add + * custom headers, modify settings, or perform any other client customization. + * + * @param builder The ClientOptions.Builder to configure + * + * Example: + * 
{@code
+     * @Override
+     * protected void setAdditional(ClientOptions.Builder builder) {
+     *     builder.addHeader("X-Request-ID", () -> UUID.randomUUID().toString());
+     *     builder.addHeader("X-Client-Version", "1.0.0");
+     * }
+     * }
+ */ + protected void setAdditional(ClientOptions.Builder builder) {} + + /** + * Override this method to add custom validation logic before the client is built. + * This method is called at the beginning of the build() method to ensure the configuration is valid. + * Throw an exception to prevent client creation if validation fails. + * + * Example: + * 
{@code
+     * @Override
+     * protected void validateConfiguration() {
+     *     super.validateConfiguration(); // Run parent validations
+     *     if (tenantId == null || tenantId.isEmpty()) {
+     *         throw new IllegalStateException("tenantId is required");
+     *     }
+     * }
+     * }
+ */ + protected void validateConfiguration() {} + + public AsyncIntercom build() { + if (token == null) { + throw new RuntimeException("Please provide token or set the INTERCOM_API_KEY environment variable."); + } + validateConfiguration(); + return new AsyncIntercom(buildClientOptions()); + } +} diff --git a/src/main/java/com/intercom/api/Intercom.java b/src/main/java/com/intercom/api/Intercom.java new file mode 100644 index 00000000..78224593 --- /dev/null +++ b/src/main/java/com/intercom/api/Intercom.java @@ -0,0 +1,268 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api; + +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.Suppliers; +import com.intercom.api.resources.admins.AdminsClient; +import com.intercom.api.resources.aicontent.AiContentClient; +import com.intercom.api.resources.articles.ArticlesClient; +import com.intercom.api.resources.awaystatusreasons.AwayStatusReasonsClient; +import com.intercom.api.resources.calls.CallsClient; +import com.intercom.api.resources.companies.CompaniesClient; +import com.intercom.api.resources.contacts.ContactsClient; +import com.intercom.api.resources.conversations.ConversationsClient; +import com.intercom.api.resources.customchannelevents.CustomChannelEventsClient; +import com.intercom.api.resources.customobjectinstances.CustomObjectInstancesClient; +import com.intercom.api.resources.dataattributes.DataAttributesClient; +import com.intercom.api.resources.dataexport.DataExportClient; +import com.intercom.api.resources.events.EventsClient; +import com.intercom.api.resources.export.ExportClient; +import com.intercom.api.resources.helpcenters.HelpCentersClient; +import com.intercom.api.resources.internalarticles.InternalArticlesClient; +import com.intercom.api.resources.ipallowlist.IpAllowlistClient; +import com.intercom.api.resources.jobs.JobsClient; +import com.intercom.api.resources.messages.MessagesClient; +import com.intercom.api.resources.news.NewsClient; +import com.intercom.api.resources.notes.NotesClient; +import com.intercom.api.resources.phonecallredirects.PhoneCallRedirectsClient; +import com.intercom.api.resources.segments.SegmentsClient; +import com.intercom.api.resources.subscriptiontypes.SubscriptionTypesClient; +import com.intercom.api.resources.tags.TagsClient; +import com.intercom.api.resources.teams.TeamsClient; +import com.intercom.api.resources.tickets.TicketsClient; +import com.intercom.api.resources.ticketstates.TicketStatesClient; +import com.intercom.api.resources.tickettypes.TicketTypesClient; +import com.intercom.api.resources.unstable.UnstableClient; +import com.intercom.api.resources.visitors.VisitorsClient; +import java.util.function.Supplier; + +public class Intercom { + protected final ClientOptions clientOptions; + + protected final Supplier adminsClient; + + protected final Supplier aiContentClient; + + protected final Supplier articlesClient; + + protected final Supplier awayStatusReasonsClient; + + protected final Supplier exportClient; + + protected final Supplier dataExportClient; + + protected final Supplier helpCentersClient; + + protected final Supplier internalArticlesClient; + + protected final Supplier ipAllowlistClient; + + protected final Supplier companiesClient; + + protected final Supplier contactsClient; + + protected final Supplier notesClient; + + protected final Supplier tagsClient; + + protected final Supplier conversationsClient; + + protected final Supplier customChannelEventsClient; + + protected final Supplier customObjectInstancesClient; + + protected final Supplier dataAttributesClient; + + protected final Supplier eventsClient; + + protected final Supplier jobsClient; + + protected final Supplier messagesClient; + + protected final Supplier segmentsClient; + + protected final Supplier subscriptionTypesClient; + + protected final Supplier phoneCallRedirectsClient; + + protected final Supplier callsClient; + + protected final Supplier teamsClient; + + protected final Supplier ticketStatesClient; + + protected final Supplier ticketTypesClient; + + protected final Supplier ticketsClient; + + protected final Supplier visitorsClient; + + protected final Supplier newsClient; + + protected final Supplier unstableClient; + + public Intercom(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + this.adminsClient = Suppliers.memoize(() -> new AdminsClient(clientOptions)); + this.aiContentClient = Suppliers.memoize(() -> new AiContentClient(clientOptions)); + this.articlesClient = Suppliers.memoize(() -> new ArticlesClient(clientOptions)); + this.awayStatusReasonsClient = Suppliers.memoize(() -> new AwayStatusReasonsClient(clientOptions)); + this.exportClient = Suppliers.memoize(() -> new ExportClient(clientOptions)); + this.dataExportClient = Suppliers.memoize(() -> new DataExportClient(clientOptions)); + this.helpCentersClient = Suppliers.memoize(() -> new HelpCentersClient(clientOptions)); + this.internalArticlesClient = Suppliers.memoize(() -> new InternalArticlesClient(clientOptions)); + this.ipAllowlistClient = Suppliers.memoize(() -> new IpAllowlistClient(clientOptions)); + this.companiesClient = Suppliers.memoize(() -> new CompaniesClient(clientOptions)); + this.contactsClient = Suppliers.memoize(() -> new ContactsClient(clientOptions)); + this.notesClient = Suppliers.memoize(() -> new NotesClient(clientOptions)); + this.tagsClient = Suppliers.memoize(() -> new TagsClient(clientOptions)); + this.conversationsClient = Suppliers.memoize(() -> new ConversationsClient(clientOptions)); + this.customChannelEventsClient = Suppliers.memoize(() -> new CustomChannelEventsClient(clientOptions)); + this.customObjectInstancesClient = Suppliers.memoize(() -> new CustomObjectInstancesClient(clientOptions)); + this.dataAttributesClient = Suppliers.memoize(() -> new DataAttributesClient(clientOptions)); + this.eventsClient = Suppliers.memoize(() -> new EventsClient(clientOptions)); + this.jobsClient = Suppliers.memoize(() -> new JobsClient(clientOptions)); + this.messagesClient = Suppliers.memoize(() -> new MessagesClient(clientOptions)); + this.segmentsClient = Suppliers.memoize(() -> new SegmentsClient(clientOptions)); + this.subscriptionTypesClient = Suppliers.memoize(() -> new SubscriptionTypesClient(clientOptions)); + this.phoneCallRedirectsClient = Suppliers.memoize(() -> new PhoneCallRedirectsClient(clientOptions)); + this.callsClient = Suppliers.memoize(() -> new CallsClient(clientOptions)); + this.teamsClient = Suppliers.memoize(() -> new TeamsClient(clientOptions)); + this.ticketStatesClient = Suppliers.memoize(() -> new TicketStatesClient(clientOptions)); + this.ticketTypesClient = Suppliers.memoize(() -> new TicketTypesClient(clientOptions)); + this.ticketsClient = Suppliers.memoize(() -> new TicketsClient(clientOptions)); + this.visitorsClient = Suppliers.memoize(() -> new VisitorsClient(clientOptions)); + this.newsClient = Suppliers.memoize(() -> new NewsClient(clientOptions)); + this.unstableClient = Suppliers.memoize(() -> new UnstableClient(clientOptions)); + } + + public AdminsClient admins() { + return this.adminsClient.get(); + } + + public AiContentClient aiContent() { + return this.aiContentClient.get(); + } + + public ArticlesClient articles() { + return this.articlesClient.get(); + } + + public AwayStatusReasonsClient awayStatusReasons() { + return this.awayStatusReasonsClient.get(); + } + + public ExportClient export() { + return this.exportClient.get(); + } + + public DataExportClient dataExport() { + return this.dataExportClient.get(); + } + + public HelpCentersClient helpCenters() { + return this.helpCentersClient.get(); + } + + public InternalArticlesClient internalArticles() { + return this.internalArticlesClient.get(); + } + + public IpAllowlistClient ipAllowlist() { + return this.ipAllowlistClient.get(); + } + + public CompaniesClient companies() { + return this.companiesClient.get(); + } + + public ContactsClient contacts() { + return this.contactsClient.get(); + } + + public NotesClient notes() { + return this.notesClient.get(); + } + + public TagsClient tags() { + return this.tagsClient.get(); + } + + public ConversationsClient conversations() { + return this.conversationsClient.get(); + } + + public CustomChannelEventsClient customChannelEvents() { + return this.customChannelEventsClient.get(); + } + + public CustomObjectInstancesClient customObjectInstances() { + return this.customObjectInstancesClient.get(); + } + + public DataAttributesClient dataAttributes() { + return this.dataAttributesClient.get(); + } + + public EventsClient events() { + return this.eventsClient.get(); + } + + public JobsClient jobs() { + return this.jobsClient.get(); + } + + public MessagesClient messages() { + return this.messagesClient.get(); + } + + public SegmentsClient segments() { + return this.segmentsClient.get(); + } + + public SubscriptionTypesClient subscriptionTypes() { + return this.subscriptionTypesClient.get(); + } + + public PhoneCallRedirectsClient phoneCallRedirects() { + return this.phoneCallRedirectsClient.get(); + } + + public CallsClient calls() { + return this.callsClient.get(); + } + + public TeamsClient teams() { + return this.teamsClient.get(); + } + + public TicketStatesClient ticketStates() { + return this.ticketStatesClient.get(); + } + + public TicketTypesClient ticketTypes() { + return this.ticketTypesClient.get(); + } + + public TicketsClient tickets() { + return this.ticketsClient.get(); + } + + public VisitorsClient visitors() { + return this.visitorsClient.get(); + } + + public NewsClient news() { + return this.newsClient.get(); + } + + public UnstableClient unstable() { + return this.unstableClient.get(); + } + + public static IntercomBuilder builder() { + return new IntercomBuilder(); + } +} diff --git a/src/main/java/com/intercom/api/IntercomBuilder.java b/src/main/java/com/intercom/api/IntercomBuilder.java new file mode 100644 index 00000000..900be36b --- /dev/null +++ b/src/main/java/com/intercom/api/IntercomBuilder.java @@ -0,0 +1,206 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api; + +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.Environment; +import java.util.HashMap; +import java.util.Map; +import java.util.Optional; +import okhttp3.OkHttpClient; + +public class IntercomBuilder { + private Optional timeout = Optional.empty(); + + private Optional maxRetries = Optional.empty(); + + private final Map customHeaders = new HashMap<>(); + + private String token = System.getenv("INTERCOM_API_KEY"); + + private Environment environment = Environment.US_PRODUCTION; + + private OkHttpClient httpClient; + + /** + * Sets token. + * Defaults to the INTERCOM_API_KEY environment variable. + */ + public IntercomBuilder token(String token) { + this.token = token; + return this; + } + + public IntercomBuilder environment(Environment environment) { + this.environment = environment; + return this; + } + + public IntercomBuilder url(String url) { + this.environment = Environment.custom(url); + return this; + } + + /** + * Sets the timeout (in seconds) for the client. Defaults to 60 seconds. + */ + public IntercomBuilder timeout(int timeout) { + this.timeout = Optional.of(timeout); + return this; + } + + /** + * Sets the maximum number of retries for the client. Defaults to 2 retries. + */ + public IntercomBuilder maxRetries(int maxRetries) { + this.maxRetries = Optional.of(maxRetries); + return this; + } + + /** + * Sets the underlying OkHttp client + */ + public IntercomBuilder httpClient(OkHttpClient httpClient) { + this.httpClient = httpClient; + return this; + } + + /** + * Add a custom header to be sent with all requests. + * For headers that need to be computed dynamically or conditionally, use the setAdditional() method override instead. + * + * @param name The header name + * @param value The header value + * @return This builder for method chaining + */ + public IntercomBuilder addHeader(String name, String value) { + this.customHeaders.put(name, value); + return this; + } + + protected ClientOptions buildClientOptions() { + ClientOptions.Builder builder = ClientOptions.builder(); + setEnvironment(builder); + setAuthentication(builder); + setHttpClient(builder); + setTimeouts(builder); + setRetries(builder); + for (Map.Entry header : this.customHeaders.entrySet()) { + builder.addHeader(header.getKey(), header.getValue()); + } + setAdditional(builder); + return builder.build(); + } + + /** + * Sets the environment configuration for the client. + * Override this method to modify URLs or add environment-specific logic. + * + * @param builder The ClientOptions.Builder to configure + */ + protected void setEnvironment(ClientOptions.Builder builder) { + builder.environment(this.environment); + } + + /** + * Override this method to customize authentication. + * This method is called during client options construction to set up authentication headers. + * + * @param builder The ClientOptions.Builder to configure + * + * Example: + * 
{@code
+     * @Override
+     * protected void setAuthentication(ClientOptions.Builder builder) {
+     *     super.setAuthentication(builder); // Keep existing auth
+     *     builder.addHeader("X-API-Key", this.apiKey);
+     * }
+     * }
+ */ + protected void setAuthentication(ClientOptions.Builder builder) { + if (this.token != null) { + builder.addHeader("Authorization", "Bearer " + this.token); + } + } + + /** + * Sets the request timeout configuration. + * Override this method to customize timeout behavior. + * + * @param builder The ClientOptions.Builder to configure + */ + protected void setTimeouts(ClientOptions.Builder builder) { + if (this.timeout.isPresent()) { + builder.timeout(this.timeout.get()); + } + } + + /** + * Sets the retry configuration for failed requests. + * Override this method to implement custom retry strategies. + * + * @param builder The ClientOptions.Builder to configure + */ + protected void setRetries(ClientOptions.Builder builder) { + if (this.maxRetries.isPresent()) { + builder.maxRetries(this.maxRetries.get()); + } + } + + /** + * Sets the OkHttp client configuration. + * Override this method to customize HTTP client behavior (interceptors, connection pools, etc). + * + * @param builder The ClientOptions.Builder to configure + */ + protected void setHttpClient(ClientOptions.Builder builder) { + if (this.httpClient != null) { + builder.httpClient(this.httpClient); + } + } + + /** + * Override this method to add any additional configuration to the client. + * This method is called at the end of the configuration chain, allowing you to add + * custom headers, modify settings, or perform any other client customization. + * + * @param builder The ClientOptions.Builder to configure + * + * Example: + * 
{@code
+     * @Override
+     * protected void setAdditional(ClientOptions.Builder builder) {
+     *     builder.addHeader("X-Request-ID", () -> UUID.randomUUID().toString());
+     *     builder.addHeader("X-Client-Version", "1.0.0");
+     * }
+     * }
+ */ + protected void setAdditional(ClientOptions.Builder builder) {} + + /** + * Override this method to add custom validation logic before the client is built. + * This method is called at the beginning of the build() method to ensure the configuration is valid. + * Throw an exception to prevent client creation if validation fails. + * + * Example: + * 
{@code
+     * @Override
+     * protected void validateConfiguration() {
+     *     super.validateConfiguration(); // Run parent validations
+     *     if (tenantId == null || tenantId.isEmpty()) {
+     *         throw new IllegalStateException("tenantId is required");
+     *     }
+     * }
+     * }
+ */ + protected void validateConfiguration() {} + + public Intercom build() { + if (token == null) { + throw new RuntimeException("Please provide token or set the INTERCOM_API_KEY environment variable."); + } + validateConfiguration(); + return new Intercom(buildClientOptions()); + } +} diff --git a/src/main/java/com/intercom/api/core/ApiVersion.java b/src/main/java/com/intercom/api/core/ApiVersion.java new file mode 100644 index 00000000..86f308c9 --- /dev/null +++ b/src/main/java/com/intercom/api/core/ApiVersion.java @@ -0,0 +1,272 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.core; + +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonValue; + +public final class ApiVersion { + public static final ApiVersion _2_1 = new ApiVersion(Value._2_1, "2.1"); + + public static final ApiVersion _2_14 = new ApiVersion(Value._2_14, "2.14"); + + public static final ApiVersion _2_2 = new ApiVersion(Value._2_2, "2.2"); + + public static final ApiVersion _1_0 = new ApiVersion(Value._1_0, "1.0"); + + public static final ApiVersion _2_3 = new ApiVersion(Value._2_3, "2.3"); + + public static final ApiVersion _1_1 = new ApiVersion(Value._1_1, "1.1"); + + public static final ApiVersion _2_4 = new ApiVersion(Value._2_4, "2.4"); + + public static final ApiVersion _1_2 = new ApiVersion(Value._1_2, "1.2"); + + public static final ApiVersion _2_5 = new ApiVersion(Value._2_5, "2.5"); + + public static final ApiVersion _1_3 = new ApiVersion(Value._1_3, "1.3"); + + public static final ApiVersion _2_6 = new ApiVersion(Value._2_6, "2.6"); + + public static final ApiVersion _1_4 = new ApiVersion(Value._1_4, "1.4"); + + public static final ApiVersion _2_7 = new ApiVersion(Value._2_7, "2.7"); + + public static final ApiVersion _2_8 = new ApiVersion(Value._2_8, "2.8"); + + public static final ApiVersion _2_10 = new ApiVersion(Value._2_10, "2.10"); + + public static final ApiVersion _2_9 = new ApiVersion(Value._2_9, "2.9"); + + public static final ApiVersion _2_11 = new ApiVersion(Value._2_11, "2.11"); + + public static final ApiVersion UNSTABLE = new ApiVersion(Value.UNSTABLE, "Unstable"); + + public static final ApiVersion _2_12 = new ApiVersion(Value._2_12, "2.12"); + + public static final ApiVersion _2_0 = new ApiVersion(Value._2_0, "2.0"); + + public static final ApiVersion _2_13 = new ApiVersion(Value._2_13, "2.13"); + + private final Value value; + + private final String string; + + ApiVersion(Value value, String string) { + this.value = value; + this.string = string; + } + + public Value getEnumValue() { + return value; + } + + @java.lang.Override + @JsonValue + public String toString() { + return this.string; + } + + @java.lang.Override + public boolean equals(Object other) { + return (this == other) || (other instanceof ApiVersion && this.string.equals(((ApiVersion) other).string)); + } + + @java.lang.Override + public int hashCode() { + return this.string.hashCode(); + } + + public T visit(Visitor visitor) { + switch (value) { + case _2_1: + return visitor.visit_21(); + case _2_14: + return visitor.visit_214(); + case _2_2: + return visitor.visit_22(); + case _1_0: + return visitor.visit_10(); + case _2_3: + return visitor.visit_23(); + case _1_1: + return visitor.visit_11(); + case _2_4: + return visitor.visit_24(); + case _1_2: + return visitor.visit_12(); + case _2_5: + return visitor.visit_25(); + case _1_3: + return visitor.visit_13(); + case _2_6: + return visitor.visit_26(); + case _1_4: + return visitor.visit_14(); + case _2_7: + return visitor.visit_27(); + case _2_8: + return visitor.visit_28(); + case _2_10: + return visitor.visit_210(); + case _2_9: + return visitor.visit_29(); + case _2_11: + return visitor.visit_211(); + case UNSTABLE: + return visitor.visitUnstable(); + case _2_12: + return visitor.visit_212(); + case _2_0: + return visitor.visit_20(); + case _2_13: + return visitor.visit_213(); + case UNKNOWN: + default: + return visitor.visitUnknown(string); + } + } + + @JsonCreator(mode = JsonCreator.Mode.DELEGATING) + public static ApiVersion valueOf(String value) { + switch (value) { + case "2.1": + return _2_1; + case "2.14": + return _2_14; + case "2.2": + return _2_2; + case "1.0": + return _1_0; + case "2.3": + return _2_3; + case "1.1": + return _1_1; + case "2.4": + return _2_4; + case "1.2": + return _1_2; + case "2.5": + return _2_5; + case "1.3": + return _1_3; + case "2.6": + return _2_6; + case "1.4": + return _1_4; + case "2.7": + return _2_7; + case "2.8": + return _2_8; + case "2.10": + return _2_10; + case "2.9": + return _2_9; + case "2.11": + return _2_11; + case "Unstable": + return UNSTABLE; + case "2.12": + return _2_12; + case "2.0": + return _2_0; + case "2.13": + return _2_13; + default: + return new ApiVersion(Value.UNKNOWN, value); + } + } + + public enum Value { + _1_0, + + _1_1, + + _1_2, + + _1_3, + + _1_4, + + _2_0, + + _2_1, + + _2_2, + + _2_3, + + _2_4, + + _2_5, + + _2_6, + + _2_7, + + _2_8, + + _2_9, + + _2_10, + + _2_11, + + _2_12, + + _2_13, + + _2_14, + + UNSTABLE, + + UNKNOWN + } + + public interface Visitor { + T visit_10(); + + T visit_11(); + + T visit_12(); + + T visit_13(); + + T visit_14(); + + T visit_20(); + + T visit_21(); + + T visit_22(); + + T visit_23(); + + T visit_24(); + + T visit_25(); + + T visit_26(); + + T visit_27(); + + T visit_28(); + + T visit_29(); + + T visit_210(); + + T visit_211(); + + T visit_212(); + + T visit_213(); + + T visit_214(); + + T visitUnstable(); + + T visitUnknown(String unknownType); + } +} diff --git a/src/main/java/com/intercom/api/core/ClientOptions.java b/src/main/java/com/intercom/api/core/ClientOptions.java new file mode 100644 index 00000000..4d14fa85 --- /dev/null +++ b/src/main/java/com/intercom/api/core/ClientOptions.java @@ -0,0 +1,224 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.core; + +import java.util.HashMap; +import java.util.Map; +import java.util.Optional; +import java.util.concurrent.TimeUnit; +import java.util.function.Supplier; +import okhttp3.OkHttpClient; + +public final class ClientOptions { + private final Environment environment; + + private final Map headers; + + private final Map> headerSuppliers; + + private final OkHttpClient httpClient; + + private final int timeout; + + private final int maxRetries; + + /** + * version.toString() is sent as the "Intercom-Version" header. + */ + private final ApiVersion version; + + /** + * @param version Defaults to "2.14" if empty + */ + private ClientOptions( + Environment environment, + Map headers, + Map> headerSuppliers, + OkHttpClient httpClient, + int timeout, + int maxRetries, + Optional version) { + this.environment = environment; + this.headers = new HashMap<>(); + this.headers.putAll(headers); + this.headers.putAll(new HashMap() { + { + put("User-Agent", "io.intercom:intercom-java/4.0.4"); + put("X-Fern-Language", "JAVA"); + put("X-Fern-SDK-Name", "com.intercom.fern:api-sdk"); + put("X-Fern-SDK-Version", "4.0.4"); + } + }); + this.headerSuppliers = headerSuppliers; + this.httpClient = httpClient; + this.timeout = timeout; + this.maxRetries = maxRetries; + this.version = version.orElse(ApiVersion._2_14); + this.headers.put("Intercom-Version", this.version.toString()); + } + + public Environment environment() { + return this.environment; + } + + public Map headers(RequestOptions requestOptions) { + Map values = new HashMap<>(this.headers); + headerSuppliers.forEach((key, supplier) -> { + values.put(key, supplier.get()); + }); + if (requestOptions != null) { + values.putAll(requestOptions.getHeaders()); + } + return values; + } + + /** + * version.toString() is sent as the "Intercom-Version" header. + */ + public ApiVersion version() { + return this.version; + } + + public int timeout(RequestOptions requestOptions) { + if (requestOptions == null) { + return this.timeout; + } + return requestOptions.getTimeout().orElse(this.timeout); + } + + public OkHttpClient httpClient() { + return this.httpClient; + } + + public OkHttpClient httpClientWithTimeout(RequestOptions requestOptions) { + if (requestOptions == null) { + return this.httpClient; + } + return this.httpClient + .newBuilder() + .callTimeout(requestOptions.getTimeout().get(), requestOptions.getTimeoutTimeUnit()) + .connectTimeout(0, TimeUnit.SECONDS) + .writeTimeout(0, TimeUnit.SECONDS) + .readTimeout(0, TimeUnit.SECONDS) + .build(); + } + + public int maxRetries() { + return this.maxRetries; + } + + public static Builder builder() { + return new Builder(); + } + + public static class Builder { + private Environment environment; + + private final Map headers = new HashMap<>(); + + private final Map> headerSuppliers = new HashMap<>(); + + private int maxRetries = 2; + + private Optional timeout = Optional.empty(); + + private OkHttpClient httpClient = null; + + private Optional version = Optional.empty(); + + public Builder environment(Environment environment) { + this.environment = environment; + return this; + } + + public Builder addHeader(String key, String value) { + this.headers.put(key, value); + return this; + } + + public Builder addHeader(String key, Supplier value) { + this.headerSuppliers.put(key, value); + return this; + } + + /** + * Override the timeout in seconds. Defaults to 60 seconds. + */ + public Builder timeout(int timeout) { + this.timeout = Optional.of(timeout); + return this; + } + + /** + * Override the timeout in seconds. Defaults to 60 seconds. + */ + public Builder timeout(Optional timeout) { + this.timeout = timeout; + return this; + } + + /** + * Override the maximum number of retries. Defaults to 2 retries. + */ + public Builder maxRetries(int maxRetries) { + this.maxRetries = maxRetries; + return this; + } + + public Builder httpClient(OkHttpClient httpClient) { + this.httpClient = httpClient; + return this; + } + + /** + * version.toString() is sent as the "Intercom-Version" header. + */ + public Builder version(ApiVersion version) { + this.version = Optional.ofNullable(version); + return this; + } + + public ClientOptions build() { + OkHttpClient.Builder httpClientBuilder = + this.httpClient != null ? this.httpClient.newBuilder() : new OkHttpClient.Builder(); + + if (this.httpClient != null) { + timeout.ifPresent(timeout -> httpClientBuilder + .callTimeout(timeout, TimeUnit.SECONDS) + .connectTimeout(0, TimeUnit.SECONDS) + .writeTimeout(0, TimeUnit.SECONDS) + .readTimeout(0, TimeUnit.SECONDS)); + } else { + httpClientBuilder + .callTimeout(this.timeout.orElse(60), TimeUnit.SECONDS) + .connectTimeout(0, TimeUnit.SECONDS) + .writeTimeout(0, TimeUnit.SECONDS) + .readTimeout(0, TimeUnit.SECONDS) + .addInterceptor(new RetryInterceptor(this.maxRetries)); + } + + this.httpClient = httpClientBuilder.build(); + this.timeout = Optional.of(httpClient.callTimeoutMillis() / 1000); + + return new ClientOptions( + environment, headers, headerSuppliers, httpClient, this.timeout.get(), this.maxRetries, version); + } + + /** + * Create a new Builder initialized with values from an existing ClientOptions + */ + public static Builder from(ClientOptions clientOptions) { + Builder builder = new Builder(); + builder.environment = clientOptions.environment(); + builder.timeout = Optional.of(clientOptions.timeout(null)); + builder.httpClient = clientOptions.httpClient(); + if (clientOptions.version != null) { + builder.version = Optional.ofNullable(clientOptions.version); + } else { + builder.version = Optional.of(ApiVersion._2_14); + } + return builder; + } + } +} diff --git a/src/main/java/com/intercom/api/core/DateTimeDeserializer.java b/src/main/java/com/intercom/api/core/DateTimeDeserializer.java new file mode 100644 index 00000000..a704433c --- /dev/null +++ b/src/main/java/com/intercom/api/core/DateTimeDeserializer.java @@ -0,0 +1,55 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.core; + +import com.fasterxml.jackson.core.JsonParser; +import com.fasterxml.jackson.core.JsonToken; +import com.fasterxml.jackson.databind.DeserializationContext; +import com.fasterxml.jackson.databind.JsonDeserializer; +import com.fasterxml.jackson.databind.module.SimpleModule; +import java.io.IOException; +import java.time.Instant; +import java.time.LocalDateTime; +import java.time.OffsetDateTime; +import java.time.ZoneOffset; +import java.time.format.DateTimeFormatter; +import java.time.temporal.TemporalAccessor; +import java.time.temporal.TemporalQueries; + +/** + * Custom deserializer that handles converting ISO8601 dates into {@link OffsetDateTime} objects. + */ +class DateTimeDeserializer extends JsonDeserializer { + private static final SimpleModule MODULE; + + static { + MODULE = new SimpleModule().addDeserializer(OffsetDateTime.class, new DateTimeDeserializer()); + } + + /** + * Gets a module wrapping this deserializer as an adapter for the Jackson ObjectMapper. + * + * @return A {@link SimpleModule} to be plugged onto Jackson ObjectMapper. + */ + public static SimpleModule getModule() { + return MODULE; + } + + @Override + public OffsetDateTime deserialize(JsonParser parser, DeserializationContext context) throws IOException { + JsonToken token = parser.currentToken(); + if (token == JsonToken.VALUE_NUMBER_INT) { + return OffsetDateTime.ofInstant(Instant.ofEpochSecond(parser.getValueAsLong()), ZoneOffset.UTC); + } else { + TemporalAccessor temporal = DateTimeFormatter.ISO_DATE_TIME.parseBest( + parser.getValueAsString(), OffsetDateTime::from, LocalDateTime::from); + + if (temporal.query(TemporalQueries.offset()) == null) { + return LocalDateTime.from(temporal).atOffset(ZoneOffset.UTC); + } else { + return OffsetDateTime.from(temporal); + } + } + } +} diff --git a/src/main/java/com/intercom/api/core/Environment.java b/src/main/java/com/intercom/api/core/Environment.java new file mode 100644 index 00000000..47a8b0f8 --- /dev/null +++ b/src/main/java/com/intercom/api/core/Environment.java @@ -0,0 +1,26 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.core; + +public final class Environment { + public static final Environment US_PRODUCTION = new Environment("https://api.intercom.io"); + + public static final Environment EU_PRODUCTION = new Environment("https://api.eu.intercom.io"); + + public static final Environment AU_PRODUCTION = new Environment("https://api.au.intercom.io"); + + private final String url; + + private Environment(String url) { + this.url = url; + } + + public String getUrl() { + return this.url; + } + + public static Environment custom(String url) { + return new Environment(url); + } +} diff --git a/src/main/java/com/intercom/api/core/FileStream.java b/src/main/java/com/intercom/api/core/FileStream.java new file mode 100644 index 00000000..42365187 --- /dev/null +++ b/src/main/java/com/intercom/api/core/FileStream.java @@ -0,0 +1,60 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.core; + +import java.io.InputStream; +import java.util.Objects; +import okhttp3.MediaType; +import okhttp3.RequestBody; +import org.jetbrains.annotations.Nullable; + +/** + * Represents a file stream with associated metadata for file uploads. + */ +public class FileStream { + private final InputStream inputStream; + private final String fileName; + private final MediaType contentType; + + /** + * Constructs a FileStream with the given input stream and optional metadata. + * + * @param inputStream The input stream of the file content. Must not be null. + * @param fileName The name of the file, or null if unknown. + * @param contentType The MIME type of the file content, or null if unknown. + * @throws NullPointerException if inputStream is null + */ + public FileStream(InputStream inputStream, @Nullable String fileName, @Nullable MediaType contentType) { + this.inputStream = Objects.requireNonNull(inputStream, "Input stream cannot be null"); + this.fileName = fileName; + this.contentType = contentType; + } + + public FileStream(InputStream inputStream) { + this(inputStream, null, null); + } + + public InputStream getInputStream() { + return inputStream; + } + + @Nullable + public String getFileName() { + return fileName; + } + + @Nullable + public MediaType getContentType() { + return contentType; + } + + /** + * Creates a RequestBody suitable for use with OkHttp client. + * + * @return A RequestBody instance representing this file stream. + */ + public RequestBody toRequestBody() { + return new InputStreamRequestBody(contentType, inputStream); + } +} diff --git a/src/main/java/com/intercom/api/core/InputStreamRequestBody.java b/src/main/java/com/intercom/api/core/InputStreamRequestBody.java new file mode 100644 index 00000000..e4121354 --- /dev/null +++ b/src/main/java/com/intercom/api/core/InputStreamRequestBody.java @@ -0,0 +1,74 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.core; + +import java.io.IOException; +import java.io.InputStream; +import java.util.Objects; +import okhttp3.MediaType; +import okhttp3.RequestBody; +import okio.BufferedSink; +import okio.Okio; +import okio.Source; +import org.jetbrains.annotations.Nullable; + +/** + * A custom implementation of OkHttp's RequestBody that wraps an InputStream. + * This class allows streaming of data from an InputStream directly to an HTTP request body, + * which is useful for file uploads or sending large amounts of data without loading it all into memory. + */ +public class InputStreamRequestBody extends RequestBody { + private final InputStream inputStream; + private final MediaType contentType; + + /** + * Constructs an InputStreamRequestBody with the specified content type and input stream. + * + * @param contentType the MediaType of the content, or null if not known + * @param inputStream the InputStream containing the data to be sent + * @throws NullPointerException if inputStream is null + */ + public InputStreamRequestBody(@Nullable MediaType contentType, InputStream inputStream) { + this.contentType = contentType; + this.inputStream = Objects.requireNonNull(inputStream, "inputStream == null"); + } + + /** + * Returns the content type of this request body. + * + * @return the MediaType of the content, or null if not specified + */ + @Nullable + @Override + public MediaType contentType() { + return contentType; + } + + /** + * Returns the content length of this request body, if known. + * This method attempts to determine the length using the InputStream's available() method, + * which may not always accurately reflect the total length of the stream. + * + * @return the content length, or -1 if the length is unknown + * @throws IOException if an I/O error occurs + */ + @Override + public long contentLength() throws IOException { + return inputStream.available() == 0 ? -1 : inputStream.available(); + } + + /** + * Writes the content of the InputStream to the given BufferedSink. + * This method is responsible for transferring the data from the InputStream to the network request. + * + * @param sink the BufferedSink to write the content to + * @throws IOException if an I/O error occurs during writing + */ + @Override + public void writeTo(BufferedSink sink) throws IOException { + try (Source source = Okio.source(inputStream)) { + sink.writeAll(source); + } + } +} diff --git a/src/main/java/com/intercom/api/core/IntercomApiException.java b/src/main/java/com/intercom/api/core/IntercomApiException.java new file mode 100644 index 00000000..0694888d --- /dev/null +++ b/src/main/java/com/intercom/api/core/IntercomApiException.java @@ -0,0 +1,73 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.core; + +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import okhttp3.Response; + +/** + * This exception type will be thrown for any non-2XX API responses. + */ +public class IntercomApiException extends IntercomException { + /** + * The error code of the response that triggered the exception. + */ + private final int statusCode; + + /** + * The body of the response that triggered the exception. + */ + private final Object body; + + private final Map> headers; + + public IntercomApiException(String message, int statusCode, Object body) { + super(message); + this.statusCode = statusCode; + this.body = body; + this.headers = new HashMap<>(); + } + + public IntercomApiException(String message, int statusCode, Object body, Response rawResponse) { + super(message); + this.statusCode = statusCode; + this.body = body; + this.headers = new HashMap<>(); + rawResponse.headers().forEach(header -> { + String key = header.component1(); + String value = header.component2(); + this.headers.computeIfAbsent(key, _str -> new ArrayList<>()).add(value); + }); + } + + /** + * @return the statusCode + */ + public int statusCode() { + return this.statusCode; + } + + /** + * @return the body + */ + public Object body() { + return this.body; + } + + /** + * @return the headers + */ + public Map> headers() { + return this.headers; + } + + @Override + public String toString() { + return "IntercomApiException{" + "message: " + getMessage() + ", statusCode: " + statusCode + ", body: " + + ObjectMappers.stringify(body) + "}"; + } +} diff --git a/src/main/java/com/intercom/api/core/IntercomException.java b/src/main/java/com/intercom/api/core/IntercomException.java new file mode 100644 index 00000000..eb7fdc69 --- /dev/null +++ b/src/main/java/com/intercom/api/core/IntercomException.java @@ -0,0 +1,17 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.core; + +/** + * This class serves as the base exception for all errors in the SDK. + */ +public class IntercomException extends RuntimeException { + public IntercomException(String message) { + super(message); + } + + public IntercomException(String message, Exception e) { + super(message, e); + } +} diff --git a/src/main/java/com/intercom/api/core/IntercomHttpResponse.java b/src/main/java/com/intercom/api/core/IntercomHttpResponse.java new file mode 100644 index 00000000..9bf40356 --- /dev/null +++ b/src/main/java/com/intercom/api/core/IntercomHttpResponse.java @@ -0,0 +1,37 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.core; + +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import okhttp3.Response; + +public final class IntercomHttpResponse { + + private final T body; + + private final Map> headers; + + public IntercomHttpResponse(T body, Response rawResponse) { + this.body = body; + + Map> headers = new HashMap<>(); + rawResponse.headers().forEach(header -> { + String key = header.component1(); + String value = header.component2(); + headers.computeIfAbsent(key, _str -> new ArrayList<>()).add(value); + }); + this.headers = headers; + } + + public T body() { + return this.body; + } + + public Map> headers() { + return headers; + } +} diff --git a/src/main/java/com/intercom/api/core/MediaTypes.java b/src/main/java/com/intercom/api/core/MediaTypes.java new file mode 100644 index 00000000..32505033 --- /dev/null +++ b/src/main/java/com/intercom/api/core/MediaTypes.java @@ -0,0 +1,13 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.core; + +import okhttp3.MediaType; + +public final class MediaTypes { + + public static final MediaType APPLICATION_JSON = MediaType.parse("application/json"); + + private MediaTypes() {} +} diff --git a/src/main/java/com/intercom/api/core/Nullable.java b/src/main/java/com/intercom/api/core/Nullable.java new file mode 100644 index 00000000..e788d1fb --- /dev/null +++ b/src/main/java/com/intercom/api/core/Nullable.java @@ -0,0 +1,140 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.core; + +import java.util.Optional; +import java.util.function.Function; + +public final class Nullable { + + private final Either, Null> value; + + private Nullable() { + this.value = Either.left(Optional.empty()); + } + + private Nullable(T value) { + if (value == null) { + this.value = Either.right(Null.INSTANCE); + } else { + this.value = Either.left(Optional.of(value)); + } + } + + public static Nullable ofNull() { + return new Nullable<>(null); + } + + public static Nullable of(T value) { + return new Nullable<>(value); + } + + public static Nullable empty() { + return new Nullable<>(); + } + + public static Nullable ofOptional(Optional value) { + if (value.isPresent()) { + return of(value.get()); + } else { + return empty(); + } + } + + public boolean isNull() { + return this.value.isRight(); + } + + public boolean isEmpty() { + return this.value.isLeft() && !this.value.getLeft().isPresent(); + } + + public T get() { + if (this.isNull()) { + return null; + } + + return this.value.getLeft().get(); + } + + public Nullable map(Function mapper) { + if (this.isNull()) { + return Nullable.ofNull(); + } + + return Nullable.ofOptional(this.value.getLeft().map(mapper)); + } + + @Override + public boolean equals(Object other) { + if (!(other instanceof Nullable)) { + return false; + } + + if (((Nullable) other).isNull() && this.isNull()) { + return true; + } + + return this.value.getLeft().equals(((Nullable) other).value.getLeft()); + } + + private static final class Either { + private L left = null; + private R right = null; + + private Either(L left, R right) { + if (left != null && right != null) { + throw new IllegalArgumentException("Left and right argument cannot both be non-null."); + } + + if (left == null && right == null) { + throw new IllegalArgumentException("Left and right argument cannot both be null."); + } + + if (left != null) { + this.left = left; + } + + if (right != null) { + this.right = right; + } + } + + public static Either left(L left) { + return new Either<>(left, null); + } + + public static Either right(R right) { + return new Either<>(null, right); + } + + public boolean isLeft() { + return this.left != null; + } + + public boolean isRight() { + return this.right != null; + } + + public L getLeft() { + if (!this.isLeft()) { + throw new IllegalArgumentException("Cannot get left from right Either."); + } + return this.left; + } + + public R getRight() { + if (!this.isRight()) { + throw new IllegalArgumentException("Cannot get right from left Either."); + } + return this.right; + } + } + + private static final class Null { + private static final Null INSTANCE = new Null(); + + private Null() {} + } +} diff --git a/src/main/java/com/intercom/api/core/NullableNonemptyFilter.java b/src/main/java/com/intercom/api/core/NullableNonemptyFilter.java new file mode 100644 index 00000000..484db264 --- /dev/null +++ b/src/main/java/com/intercom/api/core/NullableNonemptyFilter.java @@ -0,0 +1,22 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.core; + +import java.util.Optional; + +public final class NullableNonemptyFilter { + @Override + public boolean equals(Object o) { + boolean isOptionalEmpty = isOptionalEmpty(o); + + return isOptionalEmpty; + } + + private boolean isOptionalEmpty(Object o) { + if (o instanceof Optional) { + return !((Optional) o).isPresent(); + } + return false; + } +} diff --git a/src/main/java/com/intercom/api/core/ObjectMappers.java b/src/main/java/com/intercom/api/core/ObjectMappers.java new file mode 100644 index 00000000..e7c4c7a8 --- /dev/null +++ b/src/main/java/com/intercom/api/core/ObjectMappers.java @@ -0,0 +1,45 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.core; + +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.core.JsonProcessingException; +import com.fasterxml.jackson.databind.DeserializationFeature; +import com.fasterxml.jackson.databind.ObjectMapper; +import com.fasterxml.jackson.databind.SerializationFeature; +import com.fasterxml.jackson.databind.json.JsonMapper; +import com.fasterxml.jackson.datatype.jdk8.Jdk8Module; +import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule; +import java.io.IOException; + +public final class ObjectMappers { + public static final ObjectMapper JSON_MAPPER = JsonMapper.builder() + .addModule(new Jdk8Module()) + .addModule(new JavaTimeModule()) + .addModule(DateTimeDeserializer.getModule()) + .disable(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES) + .disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS) + .build(); + + private ObjectMappers() {} + + public static String stringify(Object o) { + try { + return JSON_MAPPER + .setSerializationInclusion(JsonInclude.Include.ALWAYS) + .writerWithDefaultPrettyPrinter() + .writeValueAsString(o); + } catch (IOException e) { + return o.getClass().getName() + "@" + Integer.toHexString(o.hashCode()); + } + } + + public static Object parseErrorBody(String responseBodyString) { + try { + return JSON_MAPPER.readValue(responseBodyString, Object.class); + } catch (JsonProcessingException ignored) { + return responseBodyString; + } + } +} diff --git a/src/main/java/com/intercom/api/core/QueryStringMapper.java b/src/main/java/com/intercom/api/core/QueryStringMapper.java new file mode 100644 index 00000000..e4e32bbe --- /dev/null +++ b/src/main/java/com/intercom/api/core/QueryStringMapper.java @@ -0,0 +1,142 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.core; + +import com.fasterxml.jackson.databind.JsonNode; +import com.fasterxml.jackson.databind.ObjectMapper; +import com.fasterxml.jackson.databind.node.ArrayNode; +import com.fasterxml.jackson.databind.node.ObjectNode; +import java.util.AbstractMap; +import java.util.ArrayList; +import java.util.Iterator; +import java.util.List; +import java.util.Map; +import okhttp3.HttpUrl; +import okhttp3.MultipartBody; + +public class QueryStringMapper { + + private static final ObjectMapper MAPPER = ObjectMappers.JSON_MAPPER; + + public static void addQueryParameter(HttpUrl.Builder httpUrl, String key, Object value, boolean arraysAsRepeats) { + JsonNode valueNode = MAPPER.valueToTree(value); + + List> flat; + if (valueNode.isObject()) { + flat = flattenObject((ObjectNode) valueNode, arraysAsRepeats); + } else if (valueNode.isArray()) { + flat = flattenArray((ArrayNode) valueNode, "", arraysAsRepeats); + } else { + if (valueNode.isTextual()) { + httpUrl.addQueryParameter(key, valueNode.textValue()); + } else { + httpUrl.addQueryParameter(key, valueNode.toString()); + } + return; + } + + for (Map.Entry field : flat) { + if (field.getValue().isTextual()) { + httpUrl.addQueryParameter(key + field.getKey(), field.getValue().textValue()); + } else { + httpUrl.addQueryParameter(key + field.getKey(), field.getValue().toString()); + } + } + } + + public static void addFormDataPart( + MultipartBody.Builder multipartBody, String key, Object value, boolean arraysAsRepeats) { + JsonNode valueNode = MAPPER.valueToTree(value); + + List> flat; + if (valueNode.isObject()) { + flat = flattenObject((ObjectNode) valueNode, arraysAsRepeats); + } else if (valueNode.isArray()) { + flat = flattenArray((ArrayNode) valueNode, "", arraysAsRepeats); + } else { + if (valueNode.isTextual()) { + multipartBody.addFormDataPart(key, valueNode.textValue()); + } else { + multipartBody.addFormDataPart(key, valueNode.toString()); + } + return; + } + + for (Map.Entry field : flat) { + if (field.getValue().isTextual()) { + multipartBody.addFormDataPart( + key + field.getKey(), field.getValue().textValue()); + } else { + multipartBody.addFormDataPart( + key + field.getKey(), field.getValue().toString()); + } + } + } + + public static List> flattenObject(ObjectNode object, boolean arraysAsRepeats) { + List> flat = new ArrayList<>(); + + Iterator> fields = object.fields(); + while (fields.hasNext()) { + Map.Entry field = fields.next(); + + String key = "[" + field.getKey() + "]"; + + if (field.getValue().isObject()) { + List> flatField = + flattenObject((ObjectNode) field.getValue(), arraysAsRepeats); + addAll(flat, flatField, key); + } else if (field.getValue().isArray()) { + List> flatField = + flattenArray((ArrayNode) field.getValue(), key, arraysAsRepeats); + addAll(flat, flatField, ""); + } else { + flat.add(new AbstractMap.SimpleEntry<>(key, field.getValue())); + } + } + + return flat; + } + + private static List> flattenArray( + ArrayNode array, String key, boolean arraysAsRepeats) { + List> flat = new ArrayList<>(); + + Iterator elements = array.elements(); + + int index = 0; + while (elements.hasNext()) { + JsonNode element = elements.next(); + + String indexKey = key + "[" + index + "]"; + + if (arraysAsRepeats) { + indexKey = key; + } + + if (element.isObject()) { + List> flatField = flattenObject((ObjectNode) element, arraysAsRepeats); + addAll(flat, flatField, indexKey); + } else if (element.isArray()) { + List> flatField = flattenArray((ArrayNode) element, "", arraysAsRepeats); + addAll(flat, flatField, indexKey); + } else { + flat.add(new AbstractMap.SimpleEntry<>(indexKey, element)); + } + + index++; + } + + return flat; + } + + private static void addAll( + List> target, List> source, String prefix) { + for (Map.Entry entry : source) { + Map.Entry entryToAdd = + new AbstractMap.SimpleEntry<>(prefix + entry.getKey(), entry.getValue()); + target.add(entryToAdd); + } + } +} diff --git a/src/main/java/com/intercom/api/core/RequestOptions.java b/src/main/java/com/intercom/api/core/RequestOptions.java new file mode 100644 index 00000000..e4e13fee --- /dev/null +++ b/src/main/java/com/intercom/api/core/RequestOptions.java @@ -0,0 +1,128 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.core; + +import java.util.HashMap; +import java.util.Map; +import java.util.Optional; +import java.util.concurrent.TimeUnit; +import java.util.function.Supplier; + +public final class RequestOptions { + private final String token; + + private final Optional timeout; + + private final TimeUnit timeoutTimeUnit; + + /** + * version.get().toString() is sent as the "Intercom-Version" header, overriding client options if present. + */ + private final Optional version; + + private final Map headers; + + private final Map> headerSuppliers; + + private RequestOptions( + String token, + Optional timeout, + TimeUnit timeoutTimeUnit, + Optional version, + Map headers, + Map> headerSuppliers) { + this.token = token; + this.timeout = timeout; + this.timeoutTimeUnit = timeoutTimeUnit; + this.version = version; + this.headers = headers; + this.headerSuppliers = headerSuppliers; + } + + public Optional getTimeout() { + return timeout; + } + + public TimeUnit getTimeoutTimeUnit() { + return timeoutTimeUnit; + } + + /** + * version.get().toString() is sent as the "Intercom-Version" header, overriding client options if present. + */ + public Optional getVersion() { + return version; + } + + public Map getHeaders() { + Map headers = new HashMap<>(); + if (this.version.isPresent()) { + headers.put("Intercom-Version", this.version.get().toString()); + } + if (this.token != null) { + headers.put("Authorization", "Bearer " + this.token); + } + headers.putAll(this.headers); + this.headerSuppliers.forEach((key, supplier) -> { + headers.put(key, supplier.get()); + }); + return headers; + } + + public static Builder builder() { + return new Builder(); + } + + public static class Builder { + private String token = null; + + private Optional timeout = Optional.empty(); + + private TimeUnit timeoutTimeUnit = TimeUnit.SECONDS; + + private Optional version = Optional.empty(); + + private final Map headers = new HashMap<>(); + + private final Map> headerSuppliers = new HashMap<>(); + + public Builder token(String token) { + this.token = token; + return this; + } + + /** + * version.get().toString() is sent as the "Intercom-Version" header, overriding client options if present. + */ + public Builder version(ApiVersion version) { + this.version = Optional.of(version); + return this; + } + + public Builder timeout(Integer timeout) { + this.timeout = Optional.of(timeout); + return this; + } + + public Builder timeout(Integer timeout, TimeUnit timeoutTimeUnit) { + this.timeout = Optional.of(timeout); + this.timeoutTimeUnit = timeoutTimeUnit; + return this; + } + + public Builder addHeader(String key, String value) { + this.headers.put(key, value); + return this; + } + + public Builder addHeader(String key, Supplier value) { + this.headerSuppliers.put(key, value); + return this; + } + + public RequestOptions build() { + return new RequestOptions(token, timeout, timeoutTimeUnit, version, headers, headerSuppliers); + } + } +} diff --git a/src/main/java/com/intercom/api/core/ResponseBodyInputStream.java b/src/main/java/com/intercom/api/core/ResponseBodyInputStream.java new file mode 100644 index 00000000..e72f831d --- /dev/null +++ b/src/main/java/com/intercom/api/core/ResponseBodyInputStream.java @@ -0,0 +1,45 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.core; + +import java.io.FilterInputStream; +import java.io.IOException; +import okhttp3.Response; + +/** + * A custom InputStream that wraps the InputStream from the OkHttp Response and ensures that the + * OkHttp Response object is properly closed when the stream is closed. + * + * This class extends FilterInputStream and takes an OkHttp Response object as a parameter. + * It retrieves the InputStream from the Response and overrides the close method to close + * both the InputStream and the Response object, ensuring proper resource management and preventing + * premature closure of the underlying HTTP connection. + */ +public class ResponseBodyInputStream extends FilterInputStream { + private final Response response; + + /** + * Constructs a ResponseBodyInputStream that wraps the InputStream from the given OkHttp + * Response object. + * + * @param response the OkHttp Response object from which the InputStream is retrieved + * @throws IOException if an I/O error occurs while retrieving the InputStream + */ + public ResponseBodyInputStream(Response response) throws IOException { + super(response.body().byteStream()); + this.response = response; + } + + /** + * Closes the InputStream and the associated OkHttp Response object. This ensures that the + * underlying HTTP connection is properly closed after the stream is no longer needed. + * + * @throws IOException if an I/O error occurs + */ + @Override + public void close() throws IOException { + super.close(); + response.close(); // Ensure the response is closed when the stream is closed + } +} diff --git a/src/main/java/com/intercom/api/core/ResponseBodyReader.java b/src/main/java/com/intercom/api/core/ResponseBodyReader.java new file mode 100644 index 00000000..512c64d8 --- /dev/null +++ b/src/main/java/com/intercom/api/core/ResponseBodyReader.java @@ -0,0 +1,44 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.core; + +import java.io.FilterReader; +import java.io.IOException; +import okhttp3.Response; + +/** + * A custom Reader that wraps the Reader from the OkHttp Response and ensures that the + * OkHttp Response object is properly closed when the reader is closed. + * + * This class extends FilterReader and takes an OkHttp Response object as a parameter. + * It retrieves the Reader from the Response and overrides the close method to close + * both the Reader and the Response object, ensuring proper resource management and preventing + * premature closure of the underlying HTTP connection. + */ +public class ResponseBodyReader extends FilterReader { + private final Response response; + + /** + * Constructs a ResponseBodyReader that wraps the Reader from the given OkHttp Response object. + * + * @param response the OkHttp Response object from which the Reader is retrieved + * @throws IOException if an I/O error occurs while retrieving the Reader + */ + public ResponseBodyReader(Response response) throws IOException { + super(response.body().charStream()); + this.response = response; + } + + /** + * Closes the Reader and the associated OkHttp Response object. This ensures that the + * underlying HTTP connection is properly closed after the reader is no longer needed. + * + * @throws IOException if an I/O error occurs + */ + @Override + public void close() throws IOException { + super.close(); + response.close(); // Ensure the response is closed when the reader is closed + } +} diff --git a/src/main/java/com/intercom/api/core/RetryInterceptor.java b/src/main/java/com/intercom/api/core/RetryInterceptor.java new file mode 100644 index 00000000..399e0178 --- /dev/null +++ b/src/main/java/com/intercom/api/core/RetryInterceptor.java @@ -0,0 +1,180 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.core; + +import java.io.IOException; +import java.time.Duration; +import java.time.ZonedDateTime; +import java.time.format.DateTimeFormatter; +import java.time.format.DateTimeParseException; +import java.util.Optional; +import java.util.Random; +import okhttp3.Interceptor; +import okhttp3.Response; + +public class RetryInterceptor implements Interceptor { + + private static final Duration INITIAL_RETRY_DELAY = Duration.ofMillis(1000); + private static final Duration MAX_RETRY_DELAY = Duration.ofMillis(60000); + private static final double JITTER_FACTOR = 0.2; + + private final ExponentialBackoff backoff; + private final Random random = new Random(); + + public RetryInterceptor(int maxRetries) { + this.backoff = new ExponentialBackoff(maxRetries); + } + + @Override + public Response intercept(Chain chain) throws IOException { + Response response = chain.proceed(chain.request()); + + if (shouldRetry(response.code())) { + return retryChain(response, chain); + } + + return response; + } + + private Response retryChain(Response response, Chain chain) throws IOException { + Optional nextBackoff = this.backoff.nextBackoff(response); + while (nextBackoff.isPresent()) { + try { + Thread.sleep(nextBackoff.get().toMillis()); + } catch (InterruptedException e) { + throw new IOException("Interrupted while trying request", e); + } + response.close(); + response = chain.proceed(chain.request()); + if (shouldRetry(response.code())) { + nextBackoff = this.backoff.nextBackoff(response); + } else { + return response; + } + } + + return response; + } + + /** + * Calculates the retry delay from response headers, with fallback to exponential backoff. + * Priority: Retry-After > X-RateLimit-Reset > Exponential Backoff + */ + private Duration getRetryDelayFromHeaders(Response response, int retryAttempt) { + // Check for Retry-After header first (RFC 7231), with no jitter + String retryAfter = response.header("Retry-After"); + if (retryAfter != null) { + // Parse as number of seconds... + Optional secondsDelay = tryParseLong(retryAfter) + .map(seconds -> seconds * 1000) + .filter(delayMs -> delayMs > 0) + .map(delayMs -> Math.min(delayMs, MAX_RETRY_DELAY.toMillis())) + .map(Duration::ofMillis); + if (secondsDelay.isPresent()) { + return secondsDelay.get(); + } + + // ...or as an HTTP date; both are valid + Optional dateDelay = tryParseHttpDate(retryAfter) + .map(resetTime -> resetTime.toInstant().toEpochMilli() - System.currentTimeMillis()) + .filter(delayMs -> delayMs > 0) + .map(delayMs -> Math.min(delayMs, MAX_RETRY_DELAY.toMillis())) + .map(Duration::ofMillis); + if (dateDelay.isPresent()) { + return dateDelay.get(); + } + } + + // Then check for industry-standard X-RateLimit-Reset header, with positive jitter + String rateLimitReset = response.header("X-RateLimit-Reset"); + if (rateLimitReset != null) { + // Assume Unix timestamp in epoch seconds + Optional rateLimitDelay = tryParseLong(rateLimitReset) + .map(resetTimeSeconds -> (resetTimeSeconds * 1000) - System.currentTimeMillis()) + .filter(delayMs -> delayMs > 0) + .map(delayMs -> Math.min(delayMs, MAX_RETRY_DELAY.toMillis())) + .map(this::addPositiveJitter) + .map(Duration::ofMillis); + if (rateLimitDelay.isPresent()) { + return rateLimitDelay.get(); + } + } + + // Fall back to exponential backoff, with symmetric jitter + long baseDelay = INITIAL_RETRY_DELAY.toMillis() * (1L << retryAttempt); // 2^retryAttempt + long cappedDelay = Math.min(baseDelay, MAX_RETRY_DELAY.toMillis()); + return Duration.ofMillis(addSymmetricJitter(cappedDelay)); + } + + /** + * Attempts to parse a string as a long, returning empty Optional on failure. + */ + private Optional tryParseLong(String value) { + if (value == null) { + return Optional.empty(); + } + try { + return Optional.of(Long.parseLong(value)); + } catch (NumberFormatException e) { + return Optional.empty(); + } + } + + /** + * Attempts to parse a string as an HTTP date (RFC 1123), returning empty Optional on failure. + */ + private Optional tryParseHttpDate(String value) { + if (value == null) { + return Optional.empty(); + } + try { + return Optional.of(ZonedDateTime.parse(value, DateTimeFormatter.RFC_1123_DATE_TIME)); + } catch (DateTimeParseException e) { + return Optional.empty(); + } + } + + /** + * Adds positive jitter (100-120% of original value) to prevent thundering herd. + * Used for X-RateLimit-Reset header delays. + */ + private long addPositiveJitter(long delayMs) { + double jitterMultiplier = 1.0 + (random.nextDouble() * JITTER_FACTOR); + return (long) (delayMs * jitterMultiplier); + } + + /** + * Adds symmetric jitter (90-110% of original value) to prevent thundering herd. + * Used for exponential backoff delays. + */ + private long addSymmetricJitter(long delayMs) { + double jitterMultiplier = 1.0 + ((random.nextDouble() - 0.5) * JITTER_FACTOR); + return (long) (delayMs * jitterMultiplier); + } + + private static boolean shouldRetry(int statusCode) { + return statusCode == 408 || statusCode == 429 || statusCode >= 500; + } + + private final class ExponentialBackoff { + + private final int maxNumRetries; + + private int retryNumber = 0; + + ExponentialBackoff(int maxNumRetries) { + this.maxNumRetries = maxNumRetries; + } + + public Optional nextBackoff(Response response) { + if (retryNumber >= maxNumRetries) { + return Optional.empty(); + } + + Duration delay = getRetryDelayFromHeaders(response, retryNumber); + retryNumber += 1; + return Optional.of(delay); + } + } +} diff --git a/src/main/java/com/intercom/api/core/Stream.java b/src/main/java/com/intercom/api/core/Stream.java new file mode 100644 index 00000000..f8aa1fb4 --- /dev/null +++ b/src/main/java/com/intercom/api/core/Stream.java @@ -0,0 +1,302 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.core; + +import java.io.Closeable; +import java.io.IOException; +import java.io.Reader; +import java.util.Iterator; +import java.util.NoSuchElementException; +import java.util.Scanner; + +/** + * The {@code Stream} class implements {@link Iterable} to provide a simple mechanism for reading and parsing + * objects of a given type from data streamed via a {@link Reader} using a specified delimiter. + *

+ * {@code Stream} assumes that data is being pushed to the provided {@link Reader} asynchronously and utilizes a + * {@code Scanner} to block during iteration if the next object is not available. + * Iterable stream for parsing JSON and Server-Sent Events (SSE) data. + * Supports both newline-delimited JSON and SSE with optional stream termination. + * + * @param The type of objects in the stream. + */ +public final class Stream implements Iterable, Closeable { + + private static final String NEWLINE = "\n"; + private static final String DATA_PREFIX = "data:"; + + public enum StreamType { + JSON, + SSE + } + + private final Class valueType; + private final Scanner scanner; + private final StreamType streamType; + private final String messageTerminator; + private final String streamTerminator; + private final Reader sseReader; + private boolean isClosed = false; + + /** + * Constructs a new {@code Stream} with the specified value type, reader, and delimiter. + * + * @param valueType The class of the objects in the stream. + * @param reader The reader that provides the streamed data. + * @param delimiter The delimiter used to separate elements in the stream. + */ + public Stream(Class valueType, Reader reader, String delimiter) { + this.valueType = valueType; + this.scanner = new Scanner(reader).useDelimiter(delimiter); + this.streamType = StreamType.JSON; + this.messageTerminator = delimiter; + this.streamTerminator = null; + this.sseReader = null; + } + + private Stream(Class valueType, StreamType type, Reader reader, String terminator) { + this.valueType = valueType; + this.streamType = type; + if (type == StreamType.JSON) { + this.scanner = new Scanner(reader).useDelimiter(terminator); + this.messageTerminator = terminator; + this.streamTerminator = null; + this.sseReader = null; + } else { + this.scanner = null; + this.messageTerminator = NEWLINE; + this.streamTerminator = terminator; + this.sseReader = reader; + } + } + + public static Stream fromJson(Class valueType, Reader reader, String delimiter) { + return new Stream<>(valueType, reader, delimiter); + } + + public static Stream fromJson(Class valueType, Reader reader) { + return new Stream<>(valueType, reader, NEWLINE); + } + + public static Stream fromSse(Class valueType, Reader sseReader) { + return new Stream<>(valueType, StreamType.SSE, sseReader, null); + } + + public static Stream fromSse(Class valueType, Reader sseReader, String streamTerminator) { + return new Stream<>(valueType, StreamType.SSE, sseReader, streamTerminator); + } + + @Override + public void close() throws IOException { + if (!isClosed) { + isClosed = true; + if (scanner != null) { + scanner.close(); + } + if (sseReader != null) { + sseReader.close(); + } + } + } + + private boolean isStreamClosed() { + return isClosed; + } + + /** + * Returns an iterator over the elements in this stream that blocks during iteration when the next object is + * not yet available. + * + * @return An iterator that can be used to traverse the elements in the stream. + */ + @Override + public Iterator iterator() { + if (streamType == StreamType.SSE) { + return new SSEIterator(); + } else { + return new JsonIterator(); + } + } + + private final class JsonIterator implements Iterator { + + /** + * Returns {@code true} if there are more elements in the stream. + *

+ * Will block and wait for input if the stream has not ended and the next object is not yet available. + * + * @return {@code true} if there are more elements, {@code false} otherwise. + */ + @Override + public boolean hasNext() { + if (isStreamClosed()) { + return false; + } + return scanner.hasNext(); + } + + /** + * Returns the next element in the stream. + *

+ * Will block and wait for input if the stream has not ended and the next object is not yet available. + * + * @return The next element in the stream. + * @throws NoSuchElementException If there are no more elements in the stream. + */ + @Override + public T next() { + if (isStreamClosed()) { + throw new NoSuchElementException("Stream is closed"); + } + + if (!scanner.hasNext()) { + throw new NoSuchElementException(); + } else { + try { + T parsedResponse = + ObjectMappers.JSON_MAPPER.readValue(scanner.next().trim(), valueType); + return parsedResponse; + } catch (Exception e) { + throw new RuntimeException(e); + } + } + } + + @Override + public void remove() { + throw new UnsupportedOperationException(); + } + } + + private final class SSEIterator implements Iterator { + private Scanner sseScanner; + private T nextItem; + private boolean hasNextItem = false; + private boolean endOfStream = false; + private StringBuilder eventDataBuffer = new StringBuilder(); + private String currentEventType = null; + + private SSEIterator() { + if (sseReader != null && !isStreamClosed()) { + this.sseScanner = new Scanner(sseReader); + } else { + this.endOfStream = true; + } + } + + @Override + public boolean hasNext() { + if (isStreamClosed() || endOfStream) { + return false; + } + + if (hasNextItem) { + return true; + } + + return readNextMessage(); + } + + @Override + public T next() { + if (!hasNext()) { + throw new NoSuchElementException("No more elements in stream"); + } + + T result = nextItem; + nextItem = null; + hasNextItem = false; + return result; + } + + @Override + public void remove() { + throw new UnsupportedOperationException(); + } + + private boolean readNextMessage() { + if (sseScanner == null || isStreamClosed()) { + endOfStream = true; + return false; + } + + try { + while (sseScanner.hasNextLine()) { + String line = sseScanner.nextLine(); + + if (line.trim().isEmpty()) { + if (eventDataBuffer.length() > 0) { + try { + nextItem = ObjectMappers.JSON_MAPPER.readValue(eventDataBuffer.toString(), valueType); + hasNextItem = true; + eventDataBuffer.setLength(0); + currentEventType = null; + return true; + } catch (Exception parseEx) { + System.err.println("Failed to parse SSE event: " + parseEx.getMessage()); + eventDataBuffer.setLength(0); + currentEventType = null; + continue; + } + } + continue; + } + + if (line.startsWith(DATA_PREFIX)) { + String dataContent = line.substring(DATA_PREFIX.length()); + if (dataContent.startsWith(" ")) { + dataContent = dataContent.substring(1); + } + + if (eventDataBuffer.length() == 0 + && streamTerminator != null + && dataContent.trim().equals(streamTerminator)) { + endOfStream = true; + return false; + } + + if (eventDataBuffer.length() > 0) { + eventDataBuffer.append('\n'); + } + eventDataBuffer.append(dataContent); + } else if (line.startsWith("event:")) { + String eventValue = line.length() > 6 ? line.substring(6) : ""; + if (eventValue.startsWith(" ")) { + eventValue = eventValue.substring(1); + } + currentEventType = eventValue; + } else if (line.startsWith("id:")) { + // Event ID field (ignored) + } else if (line.startsWith("retry:")) { + // Retry field (ignored) + } else if (line.startsWith(":")) { + // Comment line (ignored) + } + } + + if (eventDataBuffer.length() > 0) { + try { + nextItem = ObjectMappers.JSON_MAPPER.readValue(eventDataBuffer.toString(), valueType); + hasNextItem = true; + eventDataBuffer.setLength(0); + currentEventType = null; + return true; + } catch (Exception parseEx) { + System.err.println("Failed to parse final SSE event: " + parseEx.getMessage()); + eventDataBuffer.setLength(0); + currentEventType = null; + } + } + + endOfStream = true; + return false; + + } catch (Exception e) { + System.err.println("Failed to parse SSE stream: " + e.getMessage()); + endOfStream = true; + return false; + } + } + } +} diff --git a/src/main/java/com/intercom/api/core/Suppliers.java b/src/main/java/com/intercom/api/core/Suppliers.java new file mode 100644 index 00000000..f7998519 --- /dev/null +++ b/src/main/java/com/intercom/api/core/Suppliers.java @@ -0,0 +1,23 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.core; + +import java.util.Objects; +import java.util.concurrent.atomic.AtomicReference; +import java.util.function.Supplier; + +public final class Suppliers { + private Suppliers() {} + + public static Supplier memoize(Supplier delegate) { + AtomicReference value = new AtomicReference<>(); + return () -> { + T val = value.get(); + if (val == null) { + val = value.updateAndGet(cur -> cur == null ? Objects.requireNonNull(delegate.get()) : cur); + } + return val; + }; + } +} diff --git a/src/main/java/com/intercom/api/core/pagination/AsyncCustomPager.java b/src/main/java/com/intercom/api/core/pagination/AsyncCustomPager.java new file mode 100644 index 00000000..001643f1 --- /dev/null +++ b/src/main/java/com/intercom/api/core/pagination/AsyncCustomPager.java @@ -0,0 +1,164 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.core.pagination; + +import java.io.IOException; +import java.util.List; +import java.util.Optional; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.CompletionStage; + +/** + * Skeleton implementation for custom asynchronous bidirectional pagination. + * + * THIS CLASS MUST BE IMPLEMENTED BY THE USER. + * + * This file is added to .fernignore and will not be regenerated. + * Replace this skeleton implementation with your custom async pagination logic + * that handles your API's specific pagination structure (e.g., HATEOAS links). + * + * Example implementation for HATEOAS-style async pagination: + * 

{@code
+ * public class AsyncCustomPager implements BiDirectionalPage {
+ *     private final List items;
+ *     private final String nextUrl;
+ *     private final String previousUrl;
+ *     private final AsyncHttpClient client;
+ *
+ *     public AsyncCustomPager(Response response, AsyncHttpClient client, ...) {
+ *         this.items = response.getData();
+ *         this.nextUrl = response.getLinks().getNext();
+ *         this.previousUrl = response.getLinks().getPrevious();
+ *         // ... store other needed context
+ *     }
+ *
+ *     @Override
+ *     public boolean hasNext() {
+ *         return nextUrl != null;
+ *     }
+ *
+ *     @Override
+ *     public CompletableFuture> nextPageAsync() {
+ *         if (!hasNext()) {
+ *             CompletableFuture> future = new CompletableFuture<>();
+ *             future.completeExceptionally(new NoSuchElementException("No next page available"));
+ *             return future;
+ *         }
+ *         // Make async HTTP request to nextUrl
+ *         return client.getAsync(nextUrl)
+ *             .thenApply(response -> new AsyncCustomPager<>(response, client, ...));
+ *     }
+ *
+ *     // ... implement other methods
+ * }
+ * }
+ * + * @param The type of items in the page + */ +public class AsyncCustomPager implements BiDirectionalPage { + + /** + * Create an AsyncCustomPager from an initial response. + * + * @param initialResponse The first page response from the API + * @param client The async HTTP client to use for subsequent requests + * @param requestOptions Request options for authentication, headers, etc. + * @return A CompletableFuture containing the new AsyncCustomPager instance + */ + public static CompletableFuture> createAsync( + Object initialResponse, okhttp3.OkHttpClient client, Object requestOptions) { + throw new UnsupportedOperationException("AsyncCustomPager must be implemented. " + + "Please implement this class in core/AsyncCustomPager.java to define your async pagination logic. " + + "This file has been added to .fernignore and will not be overwritten. " + + "See the class documentation for implementation examples."); + } + + @Override + public boolean hasNext() { + throw new UnsupportedOperationException("AsyncCustomPager.hasNext() must be implemented. " + + "This method should return true if a next page is available."); + } + + @Override + public boolean hasPrevious() { + throw new UnsupportedOperationException("AsyncCustomPager.hasPrevious() must be implemented. " + + "This method should return true if a previous page is available."); + } + + /** + * Asynchronously fetch the next page. + * + * @return A CompletableFuture that completes with the next page + * @throws java.util.NoSuchElementException if no next page exists (wrapped in CompletableFuture) + */ + public CompletableFuture> nextPageAsync() { + CompletableFuture> future = new CompletableFuture<>(); + future.completeExceptionally( + new UnsupportedOperationException("AsyncCustomPager.nextPageAsync() must be implemented. " + + "This method should asynchronously fetch and return the next page of results.")); + return future; + } + + /** + * Asynchronously fetch the previous page. + * + * @return A CompletableFuture that completes with the previous page + * @throws java.util.NoSuchElementException if no previous page exists (wrapped in CompletableFuture) + */ + public CompletableFuture> previousPageAsync() { + CompletableFuture> future = new CompletableFuture<>(); + future.completeExceptionally( + new UnsupportedOperationException("AsyncCustomPager.previousPageAsync() must be implemented. " + + "This method should asynchronously fetch and return the previous page of results.")); + return future; + } + + @Override + public BiDirectionalPage nextPage() throws IOException { + throw new UnsupportedOperationException("AsyncCustomPager.nextPage() must be implemented. " + + "Consider using nextPageAsync() for async operations, or implement synchronous blocking version."); + } + + @Override + public BiDirectionalPage previousPage() throws IOException { + throw new UnsupportedOperationException( + "AsyncCustomPager.previousPage() must be implemented. " + + "Consider using previousPageAsync() for async operations, or implement synchronous blocking version."); + } + + @Override + public List getItems() { + throw new UnsupportedOperationException("AsyncCustomPager.getItems() must be implemented. " + + "This method should return the items in the current page."); + } + + @Override + public Optional getResponse() { + throw new UnsupportedOperationException("AsyncCustomPager.getResponse() must be implemented. " + + "This method should return the full response object for accessing pagination metadata."); + } + + /** + * Asynchronously iterate through all pages starting from current. + * Returns a CompletableFuture that completes with all items from all pages. + * + * @return CompletableFuture containing all items across all pages + */ + public CompletableFuture> getAllItemsAsync() { + throw new UnsupportedOperationException("AsyncCustomPager.getAllItemsAsync() must be implemented. " + + "This method should asynchronously fetch all pages and return all items."); + } + + /** + * Process each page asynchronously as it arrives. + * + * @param pageProcessor Function to process each page + * @return CompletableFuture that completes when all pages are processed + */ + public CompletableFuture forEachPageAsync( + java.util.function.Function, CompletionStage> pageProcessor) { + throw new UnsupportedOperationException("AsyncCustomPager.forEachPageAsync() must be implemented. " + + "This method should asynchronously process each page with the given function."); + } +} diff --git a/src/main/java/com/intercom/api/core/pagination/BasePage.java b/src/main/java/com/intercom/api/core/pagination/BasePage.java new file mode 100644 index 00000000..f7118ab2 --- /dev/null +++ b/src/main/java/com/intercom/api/core/pagination/BasePage.java @@ -0,0 +1,38 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.core.pagination; + +import java.util.List; +import java.util.Optional; + +public abstract class BasePage { + private final boolean hasNext; + private final List items; + private final Object response; + + public BasePage(boolean hasNext, List items, Object response) { + this.hasNext = hasNext; + this.items = items; + this.response = response; + } + + public boolean hasNext() { + return !items.isEmpty() && hasNext; + } + + public List getItems() { + return items; + } + + /** + * Returns the full response object for accessing pagination metadata like cursor tokens. + * + * @return Optional containing the response, or empty if unavailable + */ + public Optional getResponse() { + @SuppressWarnings("unchecked") + R typedResponse = (R) response; + return Optional.ofNullable(typedResponse); + } +} diff --git a/src/main/java/com/intercom/api/core/pagination/BiDirectionalPage.java b/src/main/java/com/intercom/api/core/pagination/BiDirectionalPage.java new file mode 100644 index 00000000..8c7fe532 --- /dev/null +++ b/src/main/java/com/intercom/api/core/pagination/BiDirectionalPage.java @@ -0,0 +1,60 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.core.pagination; + +import java.util.List; + +/** + * Interface for pages that support bidirectional pagination (both forward and backward navigation). + * This is used for custom pagination scenarios where the API provides both next and previous page links. + * + * @param The type of items in the page + */ +public interface BiDirectionalPage { + /** + * Returns whether there is a next page available. + * + * @return true if next page exists and can be fetched + */ + boolean hasNext(); + + /** + * Returns whether there is a previous page available. + * + * @return true if previous page exists and can be fetched + */ + boolean hasPrevious(); + + /** + * Fetches and returns the next page. + * + * @return the next page + * @throws java.util.NoSuchElementException if no next page exists + * @throws java.io.IOException if the HTTP request fails + */ + BiDirectionalPage nextPage() throws java.io.IOException; + + /** + * Fetches and returns the previous page. + * + * @return the previous page + * @throws java.util.NoSuchElementException if no previous page exists + * @throws java.io.IOException if the HTTP request fails + */ + BiDirectionalPage previousPage() throws java.io.IOException; + + /** + * Returns the items in the current page. + * + * @return list of items in this page + */ + List getItems(); + + /** + * Returns the full response object for accessing pagination metadata. + * + * @return Optional containing the response, or empty if unavailable + */ + java.util.Optional getResponse(); +} diff --git a/src/main/java/com/intercom/api/core/pagination/CustomPager.java b/src/main/java/com/intercom/api/core/pagination/CustomPager.java new file mode 100644 index 00000000..519d821c --- /dev/null +++ b/src/main/java/com/intercom/api/core/pagination/CustomPager.java @@ -0,0 +1,117 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.core.pagination; + +import java.io.IOException; +import java.util.Iterator; +import java.util.List; +import java.util.Optional; + +/** + * Skeleton implementation for custom bidirectional pagination. + * + * THIS CLASS MUST BE IMPLEMENTED BY THE USER. + * + * This file is added to .fernignore and will not be regenerated. + * Replace this skeleton implementation with your custom pagination logic + * that handles your API's specific pagination structure (e.g., HATEOAS links). + * + * Example implementation for HATEOAS-style pagination: + * 
{@code
+ * public class CustomPager implements BiDirectionalPage, Iterable {
+ *     private final List items;
+ *     private final String nextUrl;
+ *     private final String previousUrl;
+ *     private final OkHttpClient client;
+ *     private final TypeReference> responseType;
+ *
+ *     public CustomPager(Response response, OkHttpClient client, ...) {
+ *         this.items = response.getData();
+ *         this.nextUrl = response.getLinks().getNext();
+ *         this.previousUrl = response.getLinks().getPrevious();
+ *         // ... store other needed context
+ *     }
+ *
+ *     @Override
+ *     public boolean hasNext() {
+ *         return nextUrl != null;
+ *     }
+ *
+ *     @Override
+ *     public CustomPager nextPage() throws IOException {
+ *         if (!hasNext()) {
+ *             throw new NoSuchElementException("No next page available");
+ *         }
+ *         // Make HTTP request to nextUrl
+ *         // Parse response
+ *         // Return new CustomPager instance
+ *     }
+ *
+ *     // ... implement other methods
+ * }
+ * }
+ * + * @param The type of items in the page + */ +public class CustomPager implements BiDirectionalPage, Iterable { + + /** + * Create a CustomPager from an initial response. + * + * @param initialResponse The first page response from the API + * @param client The HTTP client to use for subsequent requests + * @param requestOptions Request options for authentication, headers, etc. + * @return A new CustomPager instance + * @throws IOException if the request fails + */ + public static CustomPager create(Object initialResponse, okhttp3.OkHttpClient client, Object requestOptions) + throws IOException { + throw new UnsupportedOperationException("CustomPager must be implemented. " + + "Please implement this class in core/CustomPager.java to define your pagination logic. " + + "This file has been added to .fernignore and will not be overwritten. " + + "See the class documentation for implementation examples."); + } + + @Override + public boolean hasNext() { + throw new UnsupportedOperationException("CustomPager.hasNext() must be implemented. " + + "This method should return true if a next page is available."); + } + + @Override + public boolean hasPrevious() { + throw new UnsupportedOperationException("CustomPager.hasPrevious() must be implemented. " + + "This method should return true if a previous page is available."); + } + + @Override + public BiDirectionalPage nextPage() throws IOException { + throw new UnsupportedOperationException("CustomPager.nextPage() must be implemented. " + + "This method should fetch and return the next page of results."); + } + + @Override + public BiDirectionalPage previousPage() throws IOException { + throw new UnsupportedOperationException("CustomPager.previousPage() must be implemented. " + + "This method should fetch and return the previous page of results."); + } + + @Override + public List getItems() { + throw new UnsupportedOperationException("CustomPager.getItems() must be implemented. " + + "This method should return the items in the current page."); + } + + @Override + public Optional getResponse() { + throw new UnsupportedOperationException("CustomPager.getResponse() must be implemented. " + + "This method should return the full response object for accessing pagination metadata."); + } + + @Override + public Iterator iterator() { + throw new UnsupportedOperationException("CustomPager.iterator() must be implemented. " + + "This method should return an iterator that traverses all items across all pages."); + } +} diff --git a/src/main/java/com/intercom/api/core/pagination/SyncPage.java b/src/main/java/com/intercom/api/core/pagination/SyncPage.java new file mode 100644 index 00000000..86bb7181 --- /dev/null +++ b/src/main/java/com/intercom/api/core/pagination/SyncPage.java @@ -0,0 +1,24 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.core.pagination; + +import java.util.List; +import java.util.NoSuchElementException; +import java.util.function.Supplier; + +public class SyncPage extends BasePage { + protected final Supplier> nextSupplier; + + public SyncPage(boolean hasNext, List items, Object response, Supplier> nextSupplier) { + super(hasNext, items, response); + this.nextSupplier = nextSupplier; + } + + public SyncPage nextPage() { + if (!hasNext()) { + throw new NoSuchElementException(); + } + return nextSupplier.get(); + } +} diff --git a/src/main/java/com/intercom/api/core/pagination/SyncPagingIterable.java b/src/main/java/com/intercom/api/core/pagination/SyncPagingIterable.java new file mode 100644 index 00000000..ae292622 --- /dev/null +++ b/src/main/java/com/intercom/api/core/pagination/SyncPagingIterable.java @@ -0,0 +1,63 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.core.pagination; + +import java.util.ArrayList; +import java.util.Iterator; +import java.util.List; +import java.util.NoSuchElementException; +import java.util.Optional; +import java.util.function.Supplier; +import java.util.stream.Stream; +import java.util.stream.StreamSupport; + +public class SyncPagingIterable extends SyncPage implements Iterable { + + public SyncPagingIterable( + boolean hasNext, List items, Object response, Supplier> getNext) { + super(hasNext, items, response, getNext); + } + + public SyncPagingIterable( + boolean hasNext, Optional> items, Object response, Supplier> getNext) { + super(hasNext, items.orElse(new ArrayList<>()), response, getNext); + } + + public Stream streamItems() { + return StreamSupport.stream(this.spliterator(), false); + } + + @Override + public Iterator iterator() { + return new Iterator() { + private Iterator itemsIterator = getItems().iterator(); + private SyncPage currentPage = SyncPagingIterable.this; + + @Override + public boolean hasNext() { + if (itemsIterator.hasNext()) { + return true; + } + if (currentPage.hasNext()) { + advancePage(); + return itemsIterator.hasNext(); + } + return false; + } + + @Override + public T next() { + if (!hasNext()) { + throw new NoSuchElementException(); + } + return itemsIterator.next(); + } + + private void advancePage() { + currentPage = currentPage.nextPage(); + itemsIterator = currentPage.getItems().iterator(); + } + }; + } +} diff --git a/src/main/java/com/intercom/api/errors/BadRequestError.java b/src/main/java/com/intercom/api/errors/BadRequestError.java new file mode 100644 index 00000000..ac6cca67 --- /dev/null +++ b/src/main/java/com/intercom/api/errors/BadRequestError.java @@ -0,0 +1,32 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.errors; + +import com.intercom.api.core.IntercomApiException; +import okhttp3.Response; + +public final class BadRequestError extends IntercomApiException { + /** + * The body of the response that triggered the exception. + */ + private final Object body; + + public BadRequestError(Object body) { + super("BadRequestError", 400, body); + this.body = body; + } + + public BadRequestError(Object body, Response rawResponse) { + super("BadRequestError", 400, body, rawResponse); + this.body = body; + } + + /** + * @return the body + */ + @java.lang.Override + public Object body() { + return this.body; + } +} diff --git a/src/main/java/com/intercom/api/errors/ForbiddenError.java b/src/main/java/com/intercom/api/errors/ForbiddenError.java new file mode 100644 index 00000000..42f8a5cb --- /dev/null +++ b/src/main/java/com/intercom/api/errors/ForbiddenError.java @@ -0,0 +1,33 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.errors; + +import com.intercom.api.core.IntercomApiException; +import com.intercom.api.types.Error; +import okhttp3.Response; + +public final class ForbiddenError extends IntercomApiException { + /** + * The body of the response that triggered the exception. + */ + private final Error body; + + public ForbiddenError(Error body) { + super("ForbiddenError", 403, body); + this.body = body; + } + + public ForbiddenError(Error body, Response rawResponse) { + super("ForbiddenError", 403, body, rawResponse); + this.body = body; + } + + /** + * @return the body + */ + @java.lang.Override + public Error body() { + return this.body; + } +} diff --git a/src/main/java/com/intercom/api/errors/NotFoundError.java b/src/main/java/com/intercom/api/errors/NotFoundError.java new file mode 100644 index 00000000..b2f1687a --- /dev/null +++ b/src/main/java/com/intercom/api/errors/NotFoundError.java @@ -0,0 +1,32 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.errors; + +import com.intercom.api.core.IntercomApiException; +import okhttp3.Response; + +public final class NotFoundError extends IntercomApiException { + /** + * The body of the response that triggered the exception. + */ + private final Object body; + + public NotFoundError(Object body) { + super("NotFoundError", 404, body); + this.body = body; + } + + public NotFoundError(Object body, Response rawResponse) { + super("NotFoundError", 404, body, rawResponse); + this.body = body; + } + + /** + * @return the body + */ + @java.lang.Override + public Object body() { + return this.body; + } +} diff --git a/src/main/java/com/intercom/api/errors/TooManyRequestsError.java b/src/main/java/com/intercom/api/errors/TooManyRequestsError.java new file mode 100644 index 00000000..f6dc6588 --- /dev/null +++ b/src/main/java/com/intercom/api/errors/TooManyRequestsError.java @@ -0,0 +1,33 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.errors; + +import com.intercom.api.core.IntercomApiException; +import com.intercom.api.types.Error; +import okhttp3.Response; + +public final class TooManyRequestsError extends IntercomApiException { + /** + * The body of the response that triggered the exception. + */ + private final Error body; + + public TooManyRequestsError(Error body) { + super("TooManyRequestsError", 429, body); + this.body = body; + } + + public TooManyRequestsError(Error body, Response rawResponse) { + super("TooManyRequestsError", 429, body, rawResponse); + this.body = body; + } + + /** + * @return the body + */ + @java.lang.Override + public Error body() { + return this.body; + } +} diff --git a/src/main/java/com/intercom/api/errors/UnauthorizedError.java b/src/main/java/com/intercom/api/errors/UnauthorizedError.java new file mode 100644 index 00000000..d1f571b2 --- /dev/null +++ b/src/main/java/com/intercom/api/errors/UnauthorizedError.java @@ -0,0 +1,33 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.errors; + +import com.intercom.api.core.IntercomApiException; +import com.intercom.api.types.Error; +import okhttp3.Response; + +public final class UnauthorizedError extends IntercomApiException { + /** + * The body of the response that triggered the exception. + */ + private final Error body; + + public UnauthorizedError(Error body) { + super("UnauthorizedError", 401, body); + this.body = body; + } + + public UnauthorizedError(Error body, Response rawResponse) { + super("UnauthorizedError", 401, body, rawResponse); + this.body = body; + } + + /** + * @return the body + */ + @java.lang.Override + public Error body() { + return this.body; + } +} diff --git a/src/main/java/com/intercom/api/errors/UnprocessableEntityError.java b/src/main/java/com/intercom/api/errors/UnprocessableEntityError.java new file mode 100644 index 00000000..fb6e8f55 --- /dev/null +++ b/src/main/java/com/intercom/api/errors/UnprocessableEntityError.java @@ -0,0 +1,32 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.errors; + +import com.intercom.api.core.IntercomApiException; +import okhttp3.Response; + +public final class UnprocessableEntityError extends IntercomApiException { + /** + * The body of the response that triggered the exception. + */ + private final Object body; + + public UnprocessableEntityError(Object body) { + super("UnprocessableEntityError", 422, body); + this.body = body; + } + + public UnprocessableEntityError(Object body, Response rawResponse) { + super("UnprocessableEntityError", 422, body, rawResponse); + this.body = body; + } + + /** + * @return the body + */ + @java.lang.Override + public Object body() { + return this.body; + } +} diff --git a/src/main/java/com/intercom/api/resources/admins/AdminsClient.java b/src/main/java/com/intercom/api/resources/admins/AdminsClient.java new file mode 100644 index 00000000..702eb09c --- /dev/null +++ b/src/main/java/com/intercom/api/resources/admins/AdminsClient.java @@ -0,0 +1,111 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.admins; + +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.resources.admins.requests.ConfigureAwayAdminRequest; +import com.intercom.api.resources.admins.requests.FindAdminRequest; +import com.intercom.api.resources.admins.requests.ListAllActivityLogsRequest; +import com.intercom.api.resources.admins.types.Admin; +import com.intercom.api.types.ActivityLogList; +import com.intercom.api.types.AdminList; +import com.intercom.api.types.AdminWithApp; +import java.util.Optional; + +public class AdminsClient { + protected final ClientOptions clientOptions; + + private final RawAdminsClient rawClient; + + public AdminsClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + this.rawClient = new RawAdminsClient(clientOptions); + } + + /** + * Get responses with HTTP metadata like headers + */ + public RawAdminsClient withRawResponse() { + return this.rawClient; + } + + /** + * You can view the currently authorised admin along with the embedded app object (a "workspace" in legacy terminology). + *
+ *

🚧 Single Sign On

+ *

If you are building a custom "Log in with Intercom" flow for your site, and you call the /me endpoint to identify the logged-in user, you should not accept any sign-ins from users with unverified email addresses as it poses a potential impersonation security risk.

+ *
+ */ + public Optional identify() { + return this.rawClient.identify().body(); + } + + /** + * You can view the currently authorised admin along with the embedded app object (a "workspace" in legacy terminology). + *
+ *

🚧 Single Sign On

+ *

If you are building a custom "Log in with Intercom" flow for your site, and you call the /me endpoint to identify the logged-in user, you should not accept any sign-ins from users with unverified email addresses as it poses a potential impersonation security risk.

+ *
+ */ + public Optional identify(RequestOptions requestOptions) { + return this.rawClient.identify(requestOptions).body(); + } + + /** + * You can set an Admin as away for the Inbox. + */ + public Optional away(ConfigureAwayAdminRequest request) { + return this.rawClient.away(request).body(); + } + + /** + * You can set an Admin as away for the Inbox. + */ + public Optional away(ConfigureAwayAdminRequest request, RequestOptions requestOptions) { + return this.rawClient.away(request, requestOptions).body(); + } + + /** + * You can get a log of activities by all admins in an app. + */ + public ActivityLogList listAllActivityLogs(ListAllActivityLogsRequest request) { + return this.rawClient.listAllActivityLogs(request).body(); + } + + /** + * You can get a log of activities by all admins in an app. + */ + public ActivityLogList listAllActivityLogs(ListAllActivityLogsRequest request, RequestOptions requestOptions) { + return this.rawClient.listAllActivityLogs(request, requestOptions).body(); + } + + /** + * You can fetch a list of admins for a given workspace. + */ + public AdminList list() { + return this.rawClient.list().body(); + } + + /** + * You can fetch a list of admins for a given workspace. + */ + public AdminList list(RequestOptions requestOptions) { + return this.rawClient.list(requestOptions).body(); + } + + /** + * You can retrieve the details of a single admin. + */ + public Optional find(FindAdminRequest request) { + return this.rawClient.find(request).body(); + } + + /** + * You can retrieve the details of a single admin. + */ + public Optional find(FindAdminRequest request, RequestOptions requestOptions) { + return this.rawClient.find(request, requestOptions).body(); + } +} diff --git a/src/main/java/com/intercom/api/resources/admins/AsyncAdminsClient.java b/src/main/java/com/intercom/api/resources/admins/AsyncAdminsClient.java new file mode 100644 index 00000000..f06b0ab2 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/admins/AsyncAdminsClient.java @@ -0,0 +1,113 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.admins; + +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.resources.admins.requests.ConfigureAwayAdminRequest; +import com.intercom.api.resources.admins.requests.FindAdminRequest; +import com.intercom.api.resources.admins.requests.ListAllActivityLogsRequest; +import com.intercom.api.resources.admins.types.Admin; +import com.intercom.api.types.ActivityLogList; +import com.intercom.api.types.AdminList; +import com.intercom.api.types.AdminWithApp; +import java.util.Optional; +import java.util.concurrent.CompletableFuture; + +public class AsyncAdminsClient { + protected final ClientOptions clientOptions; + + private final AsyncRawAdminsClient rawClient; + + public AsyncAdminsClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + this.rawClient = new AsyncRawAdminsClient(clientOptions); + } + + /** + * Get responses with HTTP metadata like headers + */ + public AsyncRawAdminsClient withRawResponse() { + return this.rawClient; + } + + /** + * You can view the currently authorised admin along with the embedded app object (a "workspace" in legacy terminology). + *
+ *

🚧 Single Sign On

+ *

If you are building a custom "Log in with Intercom" flow for your site, and you call the /me endpoint to identify the logged-in user, you should not accept any sign-ins from users with unverified email addresses as it poses a potential impersonation security risk.

+ *
+ */ + public CompletableFuture> identify() { + return this.rawClient.identify().thenApply(response -> response.body()); + } + + /** + * You can view the currently authorised admin along with the embedded app object (a "workspace" in legacy terminology). + *
+ *

🚧 Single Sign On

+ *

If you are building a custom "Log in with Intercom" flow for your site, and you call the /me endpoint to identify the logged-in user, you should not accept any sign-ins from users with unverified email addresses as it poses a potential impersonation security risk.

+ *
+ */ + public CompletableFuture> identify(RequestOptions requestOptions) { + return this.rawClient.identify(requestOptions).thenApply(response -> response.body()); + } + + /** + * You can set an Admin as away for the Inbox. + */ + public CompletableFuture> away(ConfigureAwayAdminRequest request) { + return this.rawClient.away(request).thenApply(response -> response.body()); + } + + /** + * You can set an Admin as away for the Inbox. + */ + public CompletableFuture> away(ConfigureAwayAdminRequest request, RequestOptions requestOptions) { + return this.rawClient.away(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can get a log of activities by all admins in an app. + */ + public CompletableFuture listAllActivityLogs(ListAllActivityLogsRequest request) { + return this.rawClient.listAllActivityLogs(request).thenApply(response -> response.body()); + } + + /** + * You can get a log of activities by all admins in an app. + */ + public CompletableFuture listAllActivityLogs( + ListAllActivityLogsRequest request, RequestOptions requestOptions) { + return this.rawClient.listAllActivityLogs(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can fetch a list of admins for a given workspace. + */ + public CompletableFuture list() { + return this.rawClient.list().thenApply(response -> response.body()); + } + + /** + * You can fetch a list of admins for a given workspace. + */ + public CompletableFuture list(RequestOptions requestOptions) { + return this.rawClient.list(requestOptions).thenApply(response -> response.body()); + } + + /** + * You can retrieve the details of a single admin. + */ + public CompletableFuture> find(FindAdminRequest request) { + return this.rawClient.find(request).thenApply(response -> response.body()); + } + + /** + * You can retrieve the details of a single admin. + */ + public CompletableFuture> find(FindAdminRequest request, RequestOptions requestOptions) { + return this.rawClient.find(request, requestOptions).thenApply(response -> response.body()); + } +} diff --git a/src/main/java/com/intercom/api/resources/admins/AsyncRawAdminsClient.java b/src/main/java/com/intercom/api/resources/admins/AsyncRawAdminsClient.java new file mode 100644 index 00000000..2190adbc --- /dev/null +++ b/src/main/java/com/intercom/api/resources/admins/AsyncRawAdminsClient.java @@ -0,0 +1,401 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.admins; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.fasterxml.jackson.core.type.TypeReference; +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.IntercomApiException; +import com.intercom.api.core.IntercomException; +import com.intercom.api.core.IntercomHttpResponse; +import com.intercom.api.core.MediaTypes; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.core.QueryStringMapper; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.errors.BadRequestError; +import com.intercom.api.errors.NotFoundError; +import com.intercom.api.errors.UnauthorizedError; +import com.intercom.api.resources.admins.requests.ConfigureAwayAdminRequest; +import com.intercom.api.resources.admins.requests.FindAdminRequest; +import com.intercom.api.resources.admins.requests.ListAllActivityLogsRequest; +import com.intercom.api.resources.admins.types.Admin; +import com.intercom.api.types.ActivityLogList; +import com.intercom.api.types.AdminList; +import com.intercom.api.types.AdminWithApp; +import com.intercom.api.types.Error; +import java.io.IOException; +import java.util.Optional; +import java.util.concurrent.CompletableFuture; +import okhttp3.Call; +import okhttp3.Callback; +import okhttp3.Headers; +import okhttp3.HttpUrl; +import okhttp3.OkHttpClient; +import okhttp3.Request; +import okhttp3.RequestBody; +import okhttp3.Response; +import okhttp3.ResponseBody; +import org.jetbrains.annotations.NotNull; + +public class AsyncRawAdminsClient { + protected final ClientOptions clientOptions; + + public AsyncRawAdminsClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + } + + /** + * You can view the currently authorised admin along with the embedded app object (a "workspace" in legacy terminology). + *
+ *

🚧 Single Sign On

+ *

If you are building a custom "Log in with Intercom" flow for your site, and you call the /me endpoint to identify the logged-in user, you should not accept any sign-ins from users with unverified email addresses as it poses a potential impersonation security risk.

+ *
+ */ + public CompletableFuture>> identify() { + return identify(null); + } + + /** + * You can view the currently authorised admin along with the embedded app object (a "workspace" in legacy terminology). + *
+ *

🚧 Single Sign On

+ *

If you are building a custom "Log in with Intercom" flow for your site, and you call the /me endpoint to identify the logged-in user, you should not accept any sign-ins from users with unverified email addresses as it poses a potential impersonation security risk.

+ *
+ */ + public CompletableFuture>> identify(RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("me") + .build(); + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture>> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue( + responseBodyString, new TypeReference>() {}), + response)); + return; + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can set an Admin as away for the Inbox. + */ + public CompletableFuture>> away(ConfigureAwayAdminRequest request) { + return away(request, null); + } + + /** + * You can set an Admin as away for the Inbox. + */ + public CompletableFuture>> away( + ConfigureAwayAdminRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("admins") + .addPathSegment(Integer.toString(request.getAdminId())) + .addPathSegments("away") + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("PUT", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture>> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue( + responseBodyString, new TypeReference>() {}), + response)); + return; + } + try { + switch (response.code()) { + case 400: + future.completeExceptionally(new BadRequestError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 404: + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can get a log of activities by all admins in an app. + */ + public CompletableFuture> listAllActivityLogs( + ListAllActivityLogsRequest request) { + return listAllActivityLogs(request, null); + } + + /** + * You can get a log of activities by all admins in an app. + */ + public CompletableFuture> listAllActivityLogs( + ListAllActivityLogsRequest request, RequestOptions requestOptions) { + HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("admins/activity_logs"); + QueryStringMapper.addQueryParameter(httpUrl, "created_at_after", request.getCreatedAtAfter(), false); + if (request.getCreatedAtBefore().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "created_at_before", request.getCreatedAtBefore().get(), false); + } + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl.build()) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, ActivityLogList.class), + response)); + return; + } + try { + if (response.code() == 401) { + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can fetch a list of admins for a given workspace. + */ + public CompletableFuture> list() { + return list(null); + } + + /** + * You can fetch a list of admins for a given workspace. + */ + public CompletableFuture> list(RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("admins") + .build(); + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, AdminList.class), response)); + return; + } + try { + if (response.code() == 401) { + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can retrieve the details of a single admin. + */ + public CompletableFuture>> find(FindAdminRequest request) { + return find(request, null); + } + + /** + * You can retrieve the details of a single admin. + */ + public CompletableFuture>> find( + FindAdminRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("admins") + .addPathSegment(Integer.toString(request.getAdminId())) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture>> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue( + responseBodyString, new TypeReference>() {}), + response)); + return; + } + try { + switch (response.code()) { + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 404: + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } +} diff --git a/src/main/java/com/intercom/api/resources/admins/RawAdminsClient.java b/src/main/java/com/intercom/api/resources/admins/RawAdminsClient.java new file mode 100644 index 00000000..efee53e4 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/admins/RawAdminsClient.java @@ -0,0 +1,317 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.admins; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.fasterxml.jackson.core.type.TypeReference; +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.IntercomApiException; +import com.intercom.api.core.IntercomException; +import com.intercom.api.core.IntercomHttpResponse; +import com.intercom.api.core.MediaTypes; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.core.QueryStringMapper; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.errors.BadRequestError; +import com.intercom.api.errors.NotFoundError; +import com.intercom.api.errors.UnauthorizedError; +import com.intercom.api.resources.admins.requests.ConfigureAwayAdminRequest; +import com.intercom.api.resources.admins.requests.FindAdminRequest; +import com.intercom.api.resources.admins.requests.ListAllActivityLogsRequest; +import com.intercom.api.resources.admins.types.Admin; +import com.intercom.api.types.ActivityLogList; +import com.intercom.api.types.AdminList; +import com.intercom.api.types.AdminWithApp; +import com.intercom.api.types.Error; +import java.io.IOException; +import java.util.Optional; +import okhttp3.Headers; +import okhttp3.HttpUrl; +import okhttp3.OkHttpClient; +import okhttp3.Request; +import okhttp3.RequestBody; +import okhttp3.Response; +import okhttp3.ResponseBody; + +public class RawAdminsClient { + protected final ClientOptions clientOptions; + + public RawAdminsClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + } + + /** + * You can view the currently authorised admin along with the embedded app object (a "workspace" in legacy terminology). + *
+ *

🚧 Single Sign On

+ *

If you are building a custom "Log in with Intercom" flow for your site, and you call the /me endpoint to identify the logged-in user, you should not accept any sign-ins from users with unverified email addresses as it poses a potential impersonation security risk.

+ *
+ */ + public IntercomHttpResponse> identify() { + return identify(null); + } + + /** + * You can view the currently authorised admin along with the embedded app object (a "workspace" in legacy terminology). + *
+ *

🚧 Single Sign On

+ *

If you are building a custom "Log in with Intercom" flow for your site, and you call the /me endpoint to identify the logged-in user, you should not accept any sign-ins from users with unverified email addresses as it poses a potential impersonation security risk.

+ *
+ */ + public IntercomHttpResponse> identify(RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("me") + .build(); + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue( + responseBodyString, new TypeReference>() {}), + response); + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can set an Admin as away for the Inbox. + */ + public IntercomHttpResponse> away(ConfigureAwayAdminRequest request) { + return away(request, null); + } + + /** + * You can set an Admin as away for the Inbox. + */ + public IntercomHttpResponse> away( + ConfigureAwayAdminRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("admins") + .addPathSegment(Integer.toString(request.getAdminId())) + .addPathSegments("away") + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("PUT", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue( + responseBodyString, new TypeReference>() {}), + response); + } + try { + switch (response.code()) { + case 400: + throw new BadRequestError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 404: + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can get a log of activities by all admins in an app. + */ + public IntercomHttpResponse listAllActivityLogs(ListAllActivityLogsRequest request) { + return listAllActivityLogs(request, null); + } + + /** + * You can get a log of activities by all admins in an app. + */ + public IntercomHttpResponse listAllActivityLogs( + ListAllActivityLogsRequest request, RequestOptions requestOptions) { + HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("admins/activity_logs"); + QueryStringMapper.addQueryParameter(httpUrl, "created_at_after", request.getCreatedAtAfter(), false); + if (request.getCreatedAtBefore().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "created_at_before", request.getCreatedAtBefore().get(), false); + } + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl.build()) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, ActivityLogList.class), response); + } + try { + if (response.code() == 401) { + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can fetch a list of admins for a given workspace. + */ + public IntercomHttpResponse list() { + return list(null); + } + + /** + * You can fetch a list of admins for a given workspace. + */ + public IntercomHttpResponse list(RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("admins") + .build(); + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, AdminList.class), response); + } + try { + if (response.code() == 401) { + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can retrieve the details of a single admin. + */ + public IntercomHttpResponse> find(FindAdminRequest request) { + return find(request, null); + } + + /** + * You can retrieve the details of a single admin. + */ + public IntercomHttpResponse> find(FindAdminRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("admins") + .addPathSegment(Integer.toString(request.getAdminId())) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue( + responseBodyString, new TypeReference>() {}), + response); + } + try { + switch (response.code()) { + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 404: + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/admins/requests/ConfigureAwayAdminRequest.java b/src/main/java/com/intercom/api/resources/admins/requests/ConfigureAwayAdminRequest.java new file mode 100644 index 00000000..b539e820 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/admins/requests/ConfigureAwayAdminRequest.java @@ -0,0 +1,231 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.admins.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = ConfigureAwayAdminRequest.Builder.class) +public final class ConfigureAwayAdminRequest { + private final int adminId; + + private final boolean awayModeEnabled; + + private final boolean awayModeReassign; + + private final Optional awayStatusReasonId; + + private final Map additionalProperties; + + private ConfigureAwayAdminRequest( + int adminId, + boolean awayModeEnabled, + boolean awayModeReassign, + Optional awayStatusReasonId, + Map additionalProperties) { + this.adminId = adminId; + this.awayModeEnabled = awayModeEnabled; + this.awayModeReassign = awayModeReassign; + this.awayStatusReasonId = awayStatusReasonId; + this.additionalProperties = additionalProperties; + } + + /** + * @return The unique identifier of a given admin + */ + @JsonProperty("admin_id") + public int getAdminId() { + return adminId; + } + + /** + * @return Set to "true" to change the status of the admin to away. + */ + @JsonProperty("away_mode_enabled") + public boolean getAwayModeEnabled() { + return awayModeEnabled; + } + + /** + * @return Set to "true" to assign any new conversation replies to your default inbox. + */ + @JsonProperty("away_mode_reassign") + public boolean getAwayModeReassign() { + return awayModeReassign; + } + + /** + * @return The unique identifier of the away status reason + */ + @JsonProperty("away_status_reason_id") + public Optional getAwayStatusReasonId() { + return awayStatusReasonId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof ConfigureAwayAdminRequest && equalTo((ConfigureAwayAdminRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(ConfigureAwayAdminRequest other) { + return adminId == other.adminId + && awayModeEnabled == other.awayModeEnabled + && awayModeReassign == other.awayModeReassign + && awayStatusReasonId.equals(other.awayStatusReasonId); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.adminId, this.awayModeEnabled, this.awayModeReassign, this.awayStatusReasonId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static AdminIdStage builder() { + return new Builder(); + } + + public interface AdminIdStage { + /** + *

The unique identifier of a given admin

+ */ + AwayModeEnabledStage adminId(int adminId); + + Builder from(ConfigureAwayAdminRequest other); + } + + public interface AwayModeEnabledStage { + /** + *

Set to "true" to change the status of the admin to away.

+ */ + AwayModeReassignStage awayModeEnabled(boolean awayModeEnabled); + } + + public interface AwayModeReassignStage { + /** + *

Set to "true" to assign any new conversation replies to your default inbox.

+ */ + _FinalStage awayModeReassign(boolean awayModeReassign); + } + + public interface _FinalStage { + ConfigureAwayAdminRequest build(); + + /** + *

The unique identifier of the away status reason

+ */ + _FinalStage awayStatusReasonId(Optional awayStatusReasonId); + + _FinalStage awayStatusReasonId(Integer awayStatusReasonId); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder + implements AdminIdStage, AwayModeEnabledStage, AwayModeReassignStage, _FinalStage { + private int adminId; + + private boolean awayModeEnabled; + + private boolean awayModeReassign; + + private Optional awayStatusReasonId = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(ConfigureAwayAdminRequest other) { + adminId(other.getAdminId()); + awayModeEnabled(other.getAwayModeEnabled()); + awayModeReassign(other.getAwayModeReassign()); + awayStatusReasonId(other.getAwayStatusReasonId()); + return this; + } + + /** + *

The unique identifier of a given admin

+ *

The unique identifier of a given admin

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("admin_id") + public AwayModeEnabledStage adminId(int adminId) { + this.adminId = adminId; + return this; + } + + /** + *

Set to "true" to change the status of the admin to away.

+ *

Set to "true" to change the status of the admin to away.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("away_mode_enabled") + public AwayModeReassignStage awayModeEnabled(boolean awayModeEnabled) { + this.awayModeEnabled = awayModeEnabled; + return this; + } + + /** + *

Set to "true" to assign any new conversation replies to your default inbox.

+ *

Set to "true" to assign any new conversation replies to your default inbox.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("away_mode_reassign") + public _FinalStage awayModeReassign(boolean awayModeReassign) { + this.awayModeReassign = awayModeReassign; + return this; + } + + /** + *

The unique identifier of the away status reason

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage awayStatusReasonId(Integer awayStatusReasonId) { + this.awayStatusReasonId = Optional.ofNullable(awayStatusReasonId); + return this; + } + + /** + *

The unique identifier of the away status reason

+ */ + @java.lang.Override + @JsonSetter(value = "away_status_reason_id", nulls = Nulls.SKIP) + public _FinalStage awayStatusReasonId(Optional awayStatusReasonId) { + this.awayStatusReasonId = awayStatusReasonId; + return this; + } + + @java.lang.Override + public ConfigureAwayAdminRequest build() { + return new ConfigureAwayAdminRequest( + adminId, awayModeEnabled, awayModeReassign, awayStatusReasonId, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/admins/requests/FindAdminRequest.java b/src/main/java/com/intercom/api/resources/admins/requests/FindAdminRequest.java new file mode 100644 index 00000000..211ec342 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/admins/requests/FindAdminRequest.java @@ -0,0 +1,112 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.admins.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = FindAdminRequest.Builder.class) +public final class FindAdminRequest { + private final int adminId; + + private final Map additionalProperties; + + private FindAdminRequest(int adminId, Map additionalProperties) { + this.adminId = adminId; + this.additionalProperties = additionalProperties; + } + + /** + * @return The unique identifier of a given admin + */ + @JsonProperty("admin_id") + public int getAdminId() { + return adminId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof FindAdminRequest && equalTo((FindAdminRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(FindAdminRequest other) { + return adminId == other.adminId; + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.adminId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static AdminIdStage builder() { + return new Builder(); + } + + public interface AdminIdStage { + /** + *

The unique identifier of a given admin

+ */ + _FinalStage adminId(int adminId); + + Builder from(FindAdminRequest other); + } + + public interface _FinalStage { + FindAdminRequest build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements AdminIdStage, _FinalStage { + private int adminId; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(FindAdminRequest other) { + adminId(other.getAdminId()); + return this; + } + + /** + *

The unique identifier of a given admin

+ *

The unique identifier of a given admin

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("admin_id") + public _FinalStage adminId(int adminId) { + this.adminId = adminId; + return this; + } + + @java.lang.Override + public FindAdminRequest build() { + return new FindAdminRequest(adminId, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/admins/requests/ListAllActivityLogsRequest.java b/src/main/java/com/intercom/api/resources/admins/requests/ListAllActivityLogsRequest.java new file mode 100644 index 00000000..fca340bd --- /dev/null +++ b/src/main/java/com/intercom/api/resources/admins/requests/ListAllActivityLogsRequest.java @@ -0,0 +1,157 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.admins.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = ListAllActivityLogsRequest.Builder.class) +public final class ListAllActivityLogsRequest { + private final String createdAtAfter; + + private final Optional createdAtBefore; + + private final Map additionalProperties; + + private ListAllActivityLogsRequest( + String createdAtAfter, Optional createdAtBefore, Map additionalProperties) { + this.createdAtAfter = createdAtAfter; + this.createdAtBefore = createdAtBefore; + this.additionalProperties = additionalProperties; + } + + /** + * @return The start date that you request data for. It must be formatted as a UNIX timestamp. + */ + @JsonProperty("created_at_after") + public String getCreatedAtAfter() { + return createdAtAfter; + } + + /** + * @return The end date that you request data for. It must be formatted as a UNIX timestamp. + */ + @JsonProperty("created_at_before") + public Optional getCreatedAtBefore() { + return createdAtBefore; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof ListAllActivityLogsRequest && equalTo((ListAllActivityLogsRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(ListAllActivityLogsRequest other) { + return createdAtAfter.equals(other.createdAtAfter) && createdAtBefore.equals(other.createdAtBefore); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.createdAtAfter, this.createdAtBefore); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static CreatedAtAfterStage builder() { + return new Builder(); + } + + public interface CreatedAtAfterStage { + /** + *

The start date that you request data for. It must be formatted as a UNIX timestamp.

+ */ + _FinalStage createdAtAfter(@NotNull String createdAtAfter); + + Builder from(ListAllActivityLogsRequest other); + } + + public interface _FinalStage { + ListAllActivityLogsRequest build(); + + /** + *

The end date that you request data for. It must be formatted as a UNIX timestamp.

+ */ + _FinalStage createdAtBefore(Optional createdAtBefore); + + _FinalStage createdAtBefore(String createdAtBefore); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements CreatedAtAfterStage, _FinalStage { + private String createdAtAfter; + + private Optional createdAtBefore = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(ListAllActivityLogsRequest other) { + createdAtAfter(other.getCreatedAtAfter()); + createdAtBefore(other.getCreatedAtBefore()); + return this; + } + + /** + *

The start date that you request data for. It must be formatted as a UNIX timestamp.

+ *

The start date that you request data for. It must be formatted as a UNIX timestamp.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("created_at_after") + public _FinalStage createdAtAfter(@NotNull String createdAtAfter) { + this.createdAtAfter = Objects.requireNonNull(createdAtAfter, "createdAtAfter must not be null"); + return this; + } + + /** + *

The end date that you request data for. It must be formatted as a UNIX timestamp.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage createdAtBefore(String createdAtBefore) { + this.createdAtBefore = Optional.ofNullable(createdAtBefore); + return this; + } + + /** + *

The end date that you request data for. It must be formatted as a UNIX timestamp.

+ */ + @java.lang.Override + @JsonSetter(value = "created_at_before", nulls = Nulls.SKIP) + public _FinalStage createdAtBefore(Optional createdAtBefore) { + this.createdAtBefore = createdAtBefore; + return this; + } + + @java.lang.Override + public ListAllActivityLogsRequest build() { + return new ListAllActivityLogsRequest(createdAtAfter, createdAtBefore, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/admins/types/Admin.java b/src/main/java/com/intercom/api/resources/admins/types/Admin.java new file mode 100644 index 00000000..ff8727c5 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/admins/types/Admin.java @@ -0,0 +1,685 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.admins.types; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.types.TeamPriorityLevel; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = Admin.Builder.class) +public final class Admin { + private final Optional type; + + private final String id; + + private final String name; + + private final String email; + + private final Optional jobTitle; + + private final boolean awayModeEnabled; + + private final boolean awayModeReassign; + + private final Optional awayStatusReasonId; + + private final boolean hasInboxSeat; + + private final List teamIds; + + private final Optional avatar; + + private final Optional teamPriorityLevel; + + private final Map additionalProperties; + + private Admin( + Optional type, + String id, + String name, + String email, + Optional jobTitle, + boolean awayModeEnabled, + boolean awayModeReassign, + Optional awayStatusReasonId, + boolean hasInboxSeat, + List teamIds, + Optional avatar, + Optional teamPriorityLevel, + Map additionalProperties) { + this.type = type; + this.id = id; + this.name = name; + this.email = email; + this.jobTitle = jobTitle; + this.awayModeEnabled = awayModeEnabled; + this.awayModeReassign = awayModeReassign; + this.awayStatusReasonId = awayStatusReasonId; + this.hasInboxSeat = hasInboxSeat; + this.teamIds = teamIds; + this.avatar = avatar; + this.teamPriorityLevel = teamPriorityLevel; + this.additionalProperties = additionalProperties; + } + + /** + * @return String representing the object's type. Always has the value admin. + */ + @JsonProperty("type") + public Optional getType() { + return type; + } + + /** + * @return The id representing the admin. + */ + @JsonProperty("id") + public String getId() { + return id; + } + + /** + * @return The name of the admin. + */ + @JsonProperty("name") + public String getName() { + return name; + } + + /** + * @return The email of the admin. + */ + @JsonProperty("email") + public String getEmail() { + return email; + } + + /** + * @return The job title of the admin. + */ + @JsonProperty("job_title") + public Optional getJobTitle() { + return jobTitle; + } + + /** + * @return Identifies if this admin is currently set in away mode. + */ + @JsonProperty("away_mode_enabled") + public boolean getAwayModeEnabled() { + return awayModeEnabled; + } + + /** + * @return Identifies if this admin is set to automatically reassign new conversations to the apps default inbox. + */ + @JsonProperty("away_mode_reassign") + public boolean getAwayModeReassign() { + return awayModeReassign; + } + + /** + * @return The unique identifier of the away status reason + */ + @JsonProperty("away_status_reason_id") + public Optional getAwayStatusReasonId() { + return awayStatusReasonId; + } + + /** + * @return Identifies if this admin has a paid inbox seat to restrict/allow features that require them. + */ + @JsonProperty("has_inbox_seat") + public boolean getHasInboxSeat() { + return hasInboxSeat; + } + + /** + * @return This object represents the avatar associated with the admin. + */ + @JsonProperty("team_ids") + public List getTeamIds() { + return teamIds; + } + + /** + * @return The avatar object associated with the admin + */ + @JsonProperty("avatar") + public Optional getAvatar() { + return avatar; + } + + @JsonProperty("team_priority_level") + public Optional getTeamPriorityLevel() { + return teamPriorityLevel; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof Admin && equalTo((Admin) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(Admin other) { + return type.equals(other.type) + && id.equals(other.id) + && name.equals(other.name) + && email.equals(other.email) + && jobTitle.equals(other.jobTitle) + && awayModeEnabled == other.awayModeEnabled + && awayModeReassign == other.awayModeReassign + && awayStatusReasonId.equals(other.awayStatusReasonId) + && hasInboxSeat == other.hasInboxSeat + && teamIds.equals(other.teamIds) + && avatar.equals(other.avatar) + && teamPriorityLevel.equals(other.teamPriorityLevel); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash( + this.type, + this.id, + this.name, + this.email, + this.jobTitle, + this.awayModeEnabled, + this.awayModeReassign, + this.awayStatusReasonId, + this.hasInboxSeat, + this.teamIds, + this.avatar, + this.teamPriorityLevel); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static IdStage builder() { + return new Builder(); + } + + public interface IdStage { + /** + *

The id representing the admin.

+ */ + NameStage id(@NotNull String id); + + Builder from(Admin other); + } + + public interface NameStage { + /** + *

The name of the admin.

+ */ + EmailStage name(@NotNull String name); + } + + public interface EmailStage { + /** + *

The email of the admin.

+ */ + AwayModeEnabledStage email(@NotNull String email); + } + + public interface AwayModeEnabledStage { + /** + *

Identifies if this admin is currently set in away mode.

+ */ + AwayModeReassignStage awayModeEnabled(boolean awayModeEnabled); + } + + public interface AwayModeReassignStage { + /** + *

Identifies if this admin is set to automatically reassign new conversations to the apps default inbox.

+ */ + HasInboxSeatStage awayModeReassign(boolean awayModeReassign); + } + + public interface HasInboxSeatStage { + /** + *

Identifies if this admin has a paid inbox seat to restrict/allow features that require them.

+ */ + _FinalStage hasInboxSeat(boolean hasInboxSeat); + } + + public interface _FinalStage { + Admin build(); + + /** + *

String representing the object's type. Always has the value admin.

+ */ + _FinalStage type(Optional type); + + _FinalStage type(String type); + + /** + *

The job title of the admin.

+ */ + _FinalStage jobTitle(Optional jobTitle); + + _FinalStage jobTitle(String jobTitle); + + /** + *

The unique identifier of the away status reason

+ */ + _FinalStage awayStatusReasonId(Optional awayStatusReasonId); + + _FinalStage awayStatusReasonId(Integer awayStatusReasonId); + + /** + *

This object represents the avatar associated with the admin.

+ */ + _FinalStage teamIds(List teamIds); + + _FinalStage addTeamIds(Integer teamIds); + + _FinalStage addAllTeamIds(List teamIds); + + /** + *

The avatar object associated with the admin

+ */ + _FinalStage avatar(Optional avatar); + + _FinalStage avatar(Avatar avatar); + + _FinalStage teamPriorityLevel(Optional teamPriorityLevel); + + _FinalStage teamPriorityLevel(TeamPriorityLevel teamPriorityLevel); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder + implements IdStage, + NameStage, + EmailStage, + AwayModeEnabledStage, + AwayModeReassignStage, + HasInboxSeatStage, + _FinalStage { + private String id; + + private String name; + + private String email; + + private boolean awayModeEnabled; + + private boolean awayModeReassign; + + private boolean hasInboxSeat; + + private Optional teamPriorityLevel = Optional.empty(); + + private Optional avatar = Optional.empty(); + + private List teamIds = new ArrayList<>(); + + private Optional awayStatusReasonId = Optional.empty(); + + private Optional jobTitle = Optional.empty(); + + private Optional type = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(Admin other) { + type(other.getType()); + id(other.getId()); + name(other.getName()); + email(other.getEmail()); + jobTitle(other.getJobTitle()); + awayModeEnabled(other.getAwayModeEnabled()); + awayModeReassign(other.getAwayModeReassign()); + awayStatusReasonId(other.getAwayStatusReasonId()); + hasInboxSeat(other.getHasInboxSeat()); + teamIds(other.getTeamIds()); + avatar(other.getAvatar()); + teamPriorityLevel(other.getTeamPriorityLevel()); + return this; + } + + /** + *

The id representing the admin.

+ *

The id representing the admin.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("id") + public NameStage id(@NotNull String id) { + this.id = Objects.requireNonNull(id, "id must not be null"); + return this; + } + + /** + *

The name of the admin.

+ *

The name of the admin.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("name") + public EmailStage name(@NotNull String name) { + this.name = Objects.requireNonNull(name, "name must not be null"); + return this; + } + + /** + *

The email of the admin.

+ *

The email of the admin.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("email") + public AwayModeEnabledStage email(@NotNull String email) { + this.email = Objects.requireNonNull(email, "email must not be null"); + return this; + } + + /** + *

Identifies if this admin is currently set in away mode.

+ *

Identifies if this admin is currently set in away mode.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("away_mode_enabled") + public AwayModeReassignStage awayModeEnabled(boolean awayModeEnabled) { + this.awayModeEnabled = awayModeEnabled; + return this; + } + + /** + *

Identifies if this admin is set to automatically reassign new conversations to the apps default inbox.

+ *

Identifies if this admin is set to automatically reassign new conversations to the apps default inbox.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("away_mode_reassign") + public HasInboxSeatStage awayModeReassign(boolean awayModeReassign) { + this.awayModeReassign = awayModeReassign; + return this; + } + + /** + *

Identifies if this admin has a paid inbox seat to restrict/allow features that require them.

+ *

Identifies if this admin has a paid inbox seat to restrict/allow features that require them.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("has_inbox_seat") + public _FinalStage hasInboxSeat(boolean hasInboxSeat) { + this.hasInboxSeat = hasInboxSeat; + return this; + } + + @java.lang.Override + public _FinalStage teamPriorityLevel(TeamPriorityLevel teamPriorityLevel) { + this.teamPriorityLevel = Optional.ofNullable(teamPriorityLevel); + return this; + } + + @java.lang.Override + @JsonSetter(value = "team_priority_level", nulls = Nulls.SKIP) + public _FinalStage teamPriorityLevel(Optional teamPriorityLevel) { + this.teamPriorityLevel = teamPriorityLevel; + return this; + } + + /** + *

The avatar object associated with the admin

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage avatar(Avatar avatar) { + this.avatar = Optional.ofNullable(avatar); + return this; + } + + /** + *

The avatar object associated with the admin

+ */ + @java.lang.Override + @JsonSetter(value = "avatar", nulls = Nulls.SKIP) + public _FinalStage avatar(Optional avatar) { + this.avatar = avatar; + return this; + } + + /** + *

This object represents the avatar associated with the admin.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage addAllTeamIds(List teamIds) { + if (teamIds != null) { + this.teamIds.addAll(teamIds); + } + return this; + } + + /** + *

This object represents the avatar associated with the admin.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage addTeamIds(Integer teamIds) { + this.teamIds.add(teamIds); + return this; + } + + /** + *

This object represents the avatar associated with the admin.

+ */ + @java.lang.Override + @JsonSetter(value = "team_ids", nulls = Nulls.SKIP) + public _FinalStage teamIds(List teamIds) { + this.teamIds.clear(); + if (teamIds != null) { + this.teamIds.addAll(teamIds); + } + return this; + } + + /** + *

The unique identifier of the away status reason

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage awayStatusReasonId(Integer awayStatusReasonId) { + this.awayStatusReasonId = Optional.ofNullable(awayStatusReasonId); + return this; + } + + /** + *

The unique identifier of the away status reason

+ */ + @java.lang.Override + @JsonSetter(value = "away_status_reason_id", nulls = Nulls.SKIP) + public _FinalStage awayStatusReasonId(Optional awayStatusReasonId) { + this.awayStatusReasonId = awayStatusReasonId; + return this; + } + + /** + *

The job title of the admin.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage jobTitle(String jobTitle) { + this.jobTitle = Optional.ofNullable(jobTitle); + return this; + } + + /** + *

The job title of the admin.

+ */ + @java.lang.Override + @JsonSetter(value = "job_title", nulls = Nulls.SKIP) + public _FinalStage jobTitle(Optional jobTitle) { + this.jobTitle = jobTitle; + return this; + } + + /** + *

String representing the object's type. Always has the value admin.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage type(String type) { + this.type = Optional.ofNullable(type); + return this; + } + + /** + *

String representing the object's type. Always has the value admin.

+ */ + @java.lang.Override + @JsonSetter(value = "type", nulls = Nulls.SKIP) + public _FinalStage type(Optional type) { + this.type = type; + return this; + } + + @java.lang.Override + public Admin build() { + return new Admin( + type, + id, + name, + email, + jobTitle, + awayModeEnabled, + awayModeReassign, + awayStatusReasonId, + hasInboxSeat, + teamIds, + avatar, + teamPriorityLevel, + additionalProperties); + } + } + + @JsonInclude(JsonInclude.Include.NON_ABSENT) + @JsonDeserialize(builder = Avatar.Builder.class) + public static final class Avatar { + private final String imageUrl; + + private final Map additionalProperties; + + private Avatar(String imageUrl, Map additionalProperties) { + this.imageUrl = imageUrl; + this.additionalProperties = additionalProperties; + } + + /** + * @return URL of the admin's avatar image + */ + @JsonProperty("image_url") + public String getImageUrl() { + return imageUrl; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof Avatar && equalTo((Avatar) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(Avatar other) { + return imageUrl.equals(other.imageUrl); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.imageUrl); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static ImageUrlStage builder() { + return new Builder(); + } + + public interface ImageUrlStage { + /** + *

URL of the admin's avatar image

+ */ + _FinalStage imageUrl(@NotNull String imageUrl); + + Builder from(Avatar other); + } + + public interface _FinalStage { + Avatar build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements ImageUrlStage, _FinalStage { + private String imageUrl; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(Avatar other) { + imageUrl(other.getImageUrl()); + return this; + } + + /** + *

URL of the admin's avatar image

+ *

URL of the admin's avatar image

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("image_url") + public _FinalStage imageUrl(@NotNull String imageUrl) { + this.imageUrl = Objects.requireNonNull(imageUrl, "imageUrl must not be null"); + return this; + } + + @java.lang.Override + public Avatar build() { + return new Avatar(imageUrl, additionalProperties); + } + } + } +} diff --git a/src/main/java/com/intercom/api/resources/aiagent/types/AiAgent.java b/src/main/java/com/intercom/api/resources/aiagent/types/AiAgent.java new file mode 100644 index 00000000..47dc3513 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/aiagent/types/AiAgent.java @@ -0,0 +1,640 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.aiagent.types; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.JsonValue; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.types.ContentSourcesList; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = AiAgent.Builder.class) +public final class AiAgent { + private final Optional sourceType; + + private final Optional sourceTitle; + + private final Optional lastAnswerType; + + private final Optional resolutionState; + + private final Optional rating; + + private final Optional ratingRemark; + + private final Optional createdAt; + + private final Optional updatedAt; + + private final Optional contentSources; + + private final Map additionalProperties; + + private AiAgent( + Optional sourceType, + Optional sourceTitle, + Optional lastAnswerType, + Optional resolutionState, + Optional rating, + Optional ratingRemark, + Optional createdAt, + Optional updatedAt, + Optional contentSources, + Map additionalProperties) { + this.sourceType = sourceType; + this.sourceTitle = sourceTitle; + this.lastAnswerType = lastAnswerType; + this.resolutionState = resolutionState; + this.rating = rating; + this.ratingRemark = ratingRemark; + this.createdAt = createdAt; + this.updatedAt = updatedAt; + this.contentSources = contentSources; + this.additionalProperties = additionalProperties; + } + + /** + * @return The type of the source that triggered AI Agent involvement in the conversation. + */ + @JsonProperty("source_type") + public Optional getSourceType() { + return sourceType; + } + + /** + * @return The title of the source that triggered AI Agent involvement in the conversation. If this is essentials_plan_setup then it will return null. + */ + @JsonProperty("source_title") + public Optional getSourceTitle() { + return sourceTitle; + } + + /** + * @return The type of the last answer delivered by AI Agent. If no answer was delivered then this will return null + */ + @JsonProperty("last_answer_type") + public Optional getLastAnswerType() { + return lastAnswerType; + } + + /** + * @return The resolution state of AI Agent. If no AI or custom answer has been delivered then this will return null. + */ + @JsonProperty("resolution_state") + public Optional getResolutionState() { + return resolutionState; + } + + /** + * @return The customer satisfaction rating given to AI Agent, from 1-5. + */ + @JsonProperty("rating") + public Optional getRating() { + return rating; + } + + /** + * @return The customer satisfaction rating remark given to AI Agent. + */ + @JsonProperty("rating_remark") + public Optional getRatingRemark() { + return ratingRemark; + } + + /** + * @return The time when the AI agent rating was created. + */ + @JsonProperty("created_at") + public Optional getCreatedAt() { + return createdAt; + } + + /** + * @return The time when the AI agent rating was last updated. + */ + @JsonProperty("updated_at") + public Optional getUpdatedAt() { + return updatedAt; + } + + @JsonProperty("content_sources") + public Optional getContentSources() { + return contentSources; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof AiAgent && equalTo((AiAgent) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(AiAgent other) { + return sourceType.equals(other.sourceType) + && sourceTitle.equals(other.sourceTitle) + && lastAnswerType.equals(other.lastAnswerType) + && resolutionState.equals(other.resolutionState) + && rating.equals(other.rating) + && ratingRemark.equals(other.ratingRemark) + && createdAt.equals(other.createdAt) + && updatedAt.equals(other.updatedAt) + && contentSources.equals(other.contentSources); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash( + this.sourceType, + this.sourceTitle, + this.lastAnswerType, + this.resolutionState, + this.rating, + this.ratingRemark, + this.createdAt, + this.updatedAt, + this.contentSources); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static Builder builder() { + return new Builder(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder { + private Optional sourceType = Optional.empty(); + + private Optional sourceTitle = Optional.empty(); + + private Optional lastAnswerType = Optional.empty(); + + private Optional resolutionState = Optional.empty(); + + private Optional rating = Optional.empty(); + + private Optional ratingRemark = Optional.empty(); + + private Optional createdAt = Optional.empty(); + + private Optional updatedAt = Optional.empty(); + + private Optional contentSources = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + public Builder from(AiAgent other) { + sourceType(other.getSourceType()); + sourceTitle(other.getSourceTitle()); + lastAnswerType(other.getLastAnswerType()); + resolutionState(other.getResolutionState()); + rating(other.getRating()); + ratingRemark(other.getRatingRemark()); + createdAt(other.getCreatedAt()); + updatedAt(other.getUpdatedAt()); + contentSources(other.getContentSources()); + return this; + } + + /** + *

The type of the source that triggered AI Agent involvement in the conversation.

+ */ + @JsonSetter(value = "source_type", nulls = Nulls.SKIP) + public Builder sourceType(Optional sourceType) { + this.sourceType = sourceType; + return this; + } + + public Builder sourceType(SourceType sourceType) { + this.sourceType = Optional.ofNullable(sourceType); + return this; + } + + /** + *

The title of the source that triggered AI Agent involvement in the conversation. If this is essentials_plan_setup then it will return null.

+ */ + @JsonSetter(value = "source_title", nulls = Nulls.SKIP) + public Builder sourceTitle(Optional sourceTitle) { + this.sourceTitle = sourceTitle; + return this; + } + + public Builder sourceTitle(String sourceTitle) { + this.sourceTitle = Optional.ofNullable(sourceTitle); + return this; + } + + /** + *

The type of the last answer delivered by AI Agent. If no answer was delivered then this will return null

+ */ + @JsonSetter(value = "last_answer_type", nulls = Nulls.SKIP) + public Builder lastAnswerType(Optional lastAnswerType) { + this.lastAnswerType = lastAnswerType; + return this; + } + + public Builder lastAnswerType(LastAnswerType lastAnswerType) { + this.lastAnswerType = Optional.ofNullable(lastAnswerType); + return this; + } + + /** + *

The resolution state of AI Agent. If no AI or custom answer has been delivered then this will return null.

+ */ + @JsonSetter(value = "resolution_state", nulls = Nulls.SKIP) + public Builder resolutionState(Optional resolutionState) { + this.resolutionState = resolutionState; + return this; + } + + public Builder resolutionState(ResolutionState resolutionState) { + this.resolutionState = Optional.ofNullable(resolutionState); + return this; + } + + /** + *

The customer satisfaction rating given to AI Agent, from 1-5.

+ */ + @JsonSetter(value = "rating", nulls = Nulls.SKIP) + public Builder rating(Optional rating) { + this.rating = rating; + return this; + } + + public Builder rating(Integer rating) { + this.rating = Optional.ofNullable(rating); + return this; + } + + /** + *

The customer satisfaction rating remark given to AI Agent.

+ */ + @JsonSetter(value = "rating_remark", nulls = Nulls.SKIP) + public Builder ratingRemark(Optional ratingRemark) { + this.ratingRemark = ratingRemark; + return this; + } + + public Builder ratingRemark(String ratingRemark) { + this.ratingRemark = Optional.ofNullable(ratingRemark); + return this; + } + + /** + *

The time when the AI agent rating was created.

+ */ + @JsonSetter(value = "created_at", nulls = Nulls.SKIP) + public Builder createdAt(Optional createdAt) { + this.createdAt = createdAt; + return this; + } + + public Builder createdAt(Integer createdAt) { + this.createdAt = Optional.ofNullable(createdAt); + return this; + } + + /** + *

The time when the AI agent rating was last updated.

+ */ + @JsonSetter(value = "updated_at", nulls = Nulls.SKIP) + public Builder updatedAt(Optional updatedAt) { + this.updatedAt = updatedAt; + return this; + } + + public Builder updatedAt(Integer updatedAt) { + this.updatedAt = Optional.ofNullable(updatedAt); + return this; + } + + @JsonSetter(value = "content_sources", nulls = Nulls.SKIP) + public Builder contentSources(Optional contentSources) { + this.contentSources = contentSources; + return this; + } + + public Builder contentSources(ContentSourcesList contentSources) { + this.contentSources = Optional.ofNullable(contentSources); + return this; + } + + public AiAgent build() { + return new AiAgent( + sourceType, + sourceTitle, + lastAnswerType, + resolutionState, + rating, + ratingRemark, + createdAt, + updatedAt, + contentSources, + additionalProperties); + } + } + + public static final class ResolutionState { + public static final ResolutionState ASSUMED_RESOLUTION = + new ResolutionState(Value.ASSUMED_RESOLUTION, "assumed_resolution"); + + public static final ResolutionState ABANDONED = new ResolutionState(Value.ABANDONED, "abandoned"); + + public static final ResolutionState ROUTED_TO_TEAM = + new ResolutionState(Value.ROUTED_TO_TEAM, "routed_to_team"); + + public static final ResolutionState CONFIRMED_RESOLUTION = + new ResolutionState(Value.CONFIRMED_RESOLUTION, "confirmed_resolution"); + + private final Value value; + + private final String string; + + ResolutionState(Value value, String string) { + this.value = value; + this.string = string; + } + + public Value getEnumValue() { + return value; + } + + @java.lang.Override + @JsonValue + public String toString() { + return this.string; + } + + @java.lang.Override + public boolean equals(Object other) { + return (this == other) + || (other instanceof ResolutionState && this.string.equals(((ResolutionState) other).string)); + } + + @java.lang.Override + public int hashCode() { + return this.string.hashCode(); + } + + public T visit(Visitor visitor) { + switch (value) { + case ASSUMED_RESOLUTION: + return visitor.visitAssumedResolution(); + case ABANDONED: + return visitor.visitAbandoned(); + case ROUTED_TO_TEAM: + return visitor.visitRoutedToTeam(); + case CONFIRMED_RESOLUTION: + return visitor.visitConfirmedResolution(); + case UNKNOWN: + default: + return visitor.visitUnknown(string); + } + } + + @JsonCreator(mode = JsonCreator.Mode.DELEGATING) + public static ResolutionState valueOf(String value) { + switch (value) { + case "assumed_resolution": + return ASSUMED_RESOLUTION; + case "abandoned": + return ABANDONED; + case "routed_to_team": + return ROUTED_TO_TEAM; + case "confirmed_resolution": + return CONFIRMED_RESOLUTION; + default: + return new ResolutionState(Value.UNKNOWN, value); + } + } + + public enum Value { + ASSUMED_RESOLUTION, + + CONFIRMED_RESOLUTION, + + ROUTED_TO_TEAM, + + ABANDONED, + + UNKNOWN + } + + public interface Visitor { + T visitAssumedResolution(); + + T visitConfirmedResolution(); + + T visitRoutedToTeam(); + + T visitAbandoned(); + + T visitUnknown(String unknownType); + } + } + + public static final class SourceType { + public static final SourceType WORKFLOW = new SourceType(Value.WORKFLOW, "workflow"); + + public static final SourceType WORKFLOW_PREVIEW = new SourceType(Value.WORKFLOW_PREVIEW, "workflow_preview"); + + public static final SourceType FIN_PREVIEW = new SourceType(Value.FIN_PREVIEW, "fin_preview"); + + public static final SourceType ESSENTIALS_PLAN_SETUP = + new SourceType(Value.ESSENTIALS_PLAN_SETUP, "essentials_plan_setup"); + + public static final SourceType PROFILE = new SourceType(Value.PROFILE, "profile"); + + private final Value value; + + private final String string; + + SourceType(Value value, String string) { + this.value = value; + this.string = string; + } + + public Value getEnumValue() { + return value; + } + + @java.lang.Override + @JsonValue + public String toString() { + return this.string; + } + + @java.lang.Override + public boolean equals(Object other) { + return (this == other) || (other instanceof SourceType && this.string.equals(((SourceType) other).string)); + } + + @java.lang.Override + public int hashCode() { + return this.string.hashCode(); + } + + public T visit(Visitor visitor) { + switch (value) { + case WORKFLOW: + return visitor.visitWorkflow(); + case WORKFLOW_PREVIEW: + return visitor.visitWorkflowPreview(); + case FIN_PREVIEW: + return visitor.visitFinPreview(); + case ESSENTIALS_PLAN_SETUP: + return visitor.visitEssentialsPlanSetup(); + case PROFILE: + return visitor.visitProfile(); + case UNKNOWN: + default: + return visitor.visitUnknown(string); + } + } + + @JsonCreator(mode = JsonCreator.Mode.DELEGATING) + public static SourceType valueOf(String value) { + switch (value) { + case "workflow": + return WORKFLOW; + case "workflow_preview": + return WORKFLOW_PREVIEW; + case "fin_preview": + return FIN_PREVIEW; + case "essentials_plan_setup": + return ESSENTIALS_PLAN_SETUP; + case "profile": + return PROFILE; + default: + return new SourceType(Value.UNKNOWN, value); + } + } + + public enum Value { + ESSENTIALS_PLAN_SETUP, + + PROFILE, + + WORKFLOW, + + WORKFLOW_PREVIEW, + + FIN_PREVIEW, + + UNKNOWN + } + + public interface Visitor { + T visitEssentialsPlanSetup(); + + T visitProfile(); + + T visitWorkflow(); + + T visitWorkflowPreview(); + + T visitFinPreview(); + + T visitUnknown(String unknownType); + } + } + + public static final class LastAnswerType { + public static final LastAnswerType AI_ANSWER = new LastAnswerType(Value.AI_ANSWER, "ai_answer"); + + public static final LastAnswerType CUSTOM_ANSWER = new LastAnswerType(Value.CUSTOM_ANSWER, "custom_answer"); + + private final Value value; + + private final String string; + + LastAnswerType(Value value, String string) { + this.value = value; + this.string = string; + } + + public Value getEnumValue() { + return value; + } + + @java.lang.Override + @JsonValue + public String toString() { + return this.string; + } + + @java.lang.Override + public boolean equals(Object other) { + return (this == other) + || (other instanceof LastAnswerType && this.string.equals(((LastAnswerType) other).string)); + } + + @java.lang.Override + public int hashCode() { + return this.string.hashCode(); + } + + public T visit(Visitor visitor) { + switch (value) { + case AI_ANSWER: + return visitor.visitAiAnswer(); + case CUSTOM_ANSWER: + return visitor.visitCustomAnswer(); + case UNKNOWN: + default: + return visitor.visitUnknown(string); + } + } + + @JsonCreator(mode = JsonCreator.Mode.DELEGATING) + public static LastAnswerType valueOf(String value) { + switch (value) { + case "ai_answer": + return AI_ANSWER; + case "custom_answer": + return CUSTOM_ANSWER; + default: + return new LastAnswerType(Value.UNKNOWN, value); + } + } + + public enum Value { + AI_ANSWER, + + CUSTOM_ANSWER, + + UNKNOWN + } + + public interface Visitor { + T visitAiAnswer(); + + T visitCustomAnswer(); + + T visitUnknown(String unknownType); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/aicontent/AiContentClient.java b/src/main/java/com/intercom/api/resources/aicontent/AiContentClient.java new file mode 100644 index 00000000..495fbdf8 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/aicontent/AiContentClient.java @@ -0,0 +1,174 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.aicontent; + +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.resources.aicontent.requests.CreateContentImportSourceRequest; +import com.intercom.api.resources.aicontent.requests.CreateExternalPageRequest; +import com.intercom.api.resources.aicontent.requests.DeleteContentImportSourceRequest; +import com.intercom.api.resources.aicontent.requests.DeleteExternalPageRequest; +import com.intercom.api.resources.aicontent.requests.GetContentImportSourceRequest; +import com.intercom.api.resources.aicontent.requests.GetExternalPageRequest; +import com.intercom.api.resources.aicontent.requests.UpdateContentImportSourceRequest; +import com.intercom.api.resources.aicontent.requests.UpdateExternalPageRequest; +import com.intercom.api.resources.aicontent.types.ContentImportSource; +import com.intercom.api.resources.aicontent.types.ContentImportSourcesList; +import com.intercom.api.resources.aicontent.types.ExternalPage; +import com.intercom.api.resources.aicontent.types.ExternalPagesList; + +public class AiContentClient { + protected final ClientOptions clientOptions; + + private final RawAiContentClient rawClient; + + public AiContentClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + this.rawClient = new RawAiContentClient(clientOptions); + } + + /** + * Get responses with HTTP metadata like headers + */ + public RawAiContentClient withRawResponse() { + return this.rawClient; + } + + /** + * You can retrieve a list of all content import sources for a workspace. + */ + public ContentImportSourcesList listContentImportSources() { + return this.rawClient.listContentImportSources().body(); + } + + /** + * You can retrieve a list of all content import sources for a workspace. + */ + public ContentImportSourcesList listContentImportSources(RequestOptions requestOptions) { + return this.rawClient.listContentImportSources(requestOptions).body(); + } + + /** + * You can create a new content import source by sending a POST request to this endpoint. + */ + public ContentImportSource createContentImportSource(CreateContentImportSourceRequest request) { + return this.rawClient.createContentImportSource(request).body(); + } + + /** + * You can create a new content import source by sending a POST request to this endpoint. + */ + public ContentImportSource createContentImportSource( + CreateContentImportSourceRequest request, RequestOptions requestOptions) { + return this.rawClient.createContentImportSource(request, requestOptions).body(); + } + + public ContentImportSource getContentImportSource(GetContentImportSourceRequest request) { + return this.rawClient.getContentImportSource(request).body(); + } + + public ContentImportSource getContentImportSource( + GetContentImportSourceRequest request, RequestOptions requestOptions) { + return this.rawClient.getContentImportSource(request, requestOptions).body(); + } + + /** + * You can update an existing content import source. + */ + public ContentImportSource updateContentImportSource(UpdateContentImportSourceRequest request) { + return this.rawClient.updateContentImportSource(request).body(); + } + + /** + * You can update an existing content import source. + */ + public ContentImportSource updateContentImportSource( + UpdateContentImportSourceRequest request, RequestOptions requestOptions) { + return this.rawClient.updateContentImportSource(request, requestOptions).body(); + } + + /** + * You can delete a content import source by making a DELETE request this endpoint. This will also delete all external pages that were imported from this source. + */ + public void deleteContentImportSource(DeleteContentImportSourceRequest request) { + this.rawClient.deleteContentImportSource(request).body(); + } + + /** + * You can delete a content import source by making a DELETE request this endpoint. This will also delete all external pages that were imported from this source. + */ + public void deleteContentImportSource(DeleteContentImportSourceRequest request, RequestOptions requestOptions) { + this.rawClient.deleteContentImportSource(request, requestOptions).body(); + } + + /** + * You can retrieve a list of all external pages for a workspace. + */ + public ExternalPagesList listExternalPages() { + return this.rawClient.listExternalPages().body(); + } + + /** + * You can retrieve a list of all external pages for a workspace. + */ + public ExternalPagesList listExternalPages(RequestOptions requestOptions) { + return this.rawClient.listExternalPages(requestOptions).body(); + } + + /** + * You can create a new external page by sending a POST request to this endpoint. If an external page already exists with the specified source_id and external_id, it will be updated instead. + */ + public ExternalPage createExternalPage(CreateExternalPageRequest request) { + return this.rawClient.createExternalPage(request).body(); + } + + /** + * You can create a new external page by sending a POST request to this endpoint. If an external page already exists with the specified source_id and external_id, it will be updated instead. + */ + public ExternalPage createExternalPage(CreateExternalPageRequest request, RequestOptions requestOptions) { + return this.rawClient.createExternalPage(request, requestOptions).body(); + } + + /** + * You can retrieve an external page. + */ + public ExternalPage getExternalPage(GetExternalPageRequest request) { + return this.rawClient.getExternalPage(request).body(); + } + + /** + * You can retrieve an external page. + */ + public ExternalPage getExternalPage(GetExternalPageRequest request, RequestOptions requestOptions) { + return this.rawClient.getExternalPage(request, requestOptions).body(); + } + + /** + * You can update an existing external page (if it was created via the API). + */ + public ExternalPage updateExternalPage(UpdateExternalPageRequest request) { + return this.rawClient.updateExternalPage(request).body(); + } + + /** + * You can update an existing external page (if it was created via the API). + */ + public ExternalPage updateExternalPage(UpdateExternalPageRequest request, RequestOptions requestOptions) { + return this.rawClient.updateExternalPage(request, requestOptions).body(); + } + + /** + * Sending a DELETE request for an external page will remove it from the content library UI and from being used for AI answers. + */ + public ExternalPage deleteExternalPage(DeleteExternalPageRequest request) { + return this.rawClient.deleteExternalPage(request).body(); + } + + /** + * Sending a DELETE request for an external page will remove it from the content library UI and from being used for AI answers. + */ + public ExternalPage deleteExternalPage(DeleteExternalPageRequest request, RequestOptions requestOptions) { + return this.rawClient.deleteExternalPage(request, requestOptions).body(); + } +} diff --git a/src/main/java/com/intercom/api/resources/aicontent/AsyncAiContentClient.java b/src/main/java/com/intercom/api/resources/aicontent/AsyncAiContentClient.java new file mode 100644 index 00000000..0043a846 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/aicontent/AsyncAiContentClient.java @@ -0,0 +1,180 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.aicontent; + +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.resources.aicontent.requests.CreateContentImportSourceRequest; +import com.intercom.api.resources.aicontent.requests.CreateExternalPageRequest; +import com.intercom.api.resources.aicontent.requests.DeleteContentImportSourceRequest; +import com.intercom.api.resources.aicontent.requests.DeleteExternalPageRequest; +import com.intercom.api.resources.aicontent.requests.GetContentImportSourceRequest; +import com.intercom.api.resources.aicontent.requests.GetExternalPageRequest; +import com.intercom.api.resources.aicontent.requests.UpdateContentImportSourceRequest; +import com.intercom.api.resources.aicontent.requests.UpdateExternalPageRequest; +import com.intercom.api.resources.aicontent.types.ContentImportSource; +import com.intercom.api.resources.aicontent.types.ContentImportSourcesList; +import com.intercom.api.resources.aicontent.types.ExternalPage; +import com.intercom.api.resources.aicontent.types.ExternalPagesList; +import java.util.concurrent.CompletableFuture; + +public class AsyncAiContentClient { + protected final ClientOptions clientOptions; + + private final AsyncRawAiContentClient rawClient; + + public AsyncAiContentClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + this.rawClient = new AsyncRawAiContentClient(clientOptions); + } + + /** + * Get responses with HTTP metadata like headers + */ + public AsyncRawAiContentClient withRawResponse() { + return this.rawClient; + } + + /** + * You can retrieve a list of all content import sources for a workspace. + */ + public CompletableFuture listContentImportSources() { + return this.rawClient.listContentImportSources().thenApply(response -> response.body()); + } + + /** + * You can retrieve a list of all content import sources for a workspace. + */ + public CompletableFuture listContentImportSources(RequestOptions requestOptions) { + return this.rawClient.listContentImportSources(requestOptions).thenApply(response -> response.body()); + } + + /** + * You can create a new content import source by sending a POST request to this endpoint. + */ + public CompletableFuture createContentImportSource(CreateContentImportSourceRequest request) { + return this.rawClient.createContentImportSource(request).thenApply(response -> response.body()); + } + + /** + * You can create a new content import source by sending a POST request to this endpoint. + */ + public CompletableFuture createContentImportSource( + CreateContentImportSourceRequest request, RequestOptions requestOptions) { + return this.rawClient.createContentImportSource(request, requestOptions).thenApply(response -> response.body()); + } + + public CompletableFuture getContentImportSource(GetContentImportSourceRequest request) { + return this.rawClient.getContentImportSource(request).thenApply(response -> response.body()); + } + + public CompletableFuture getContentImportSource( + GetContentImportSourceRequest request, RequestOptions requestOptions) { + return this.rawClient.getContentImportSource(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can update an existing content import source. + */ + public CompletableFuture updateContentImportSource(UpdateContentImportSourceRequest request) { + return this.rawClient.updateContentImportSource(request).thenApply(response -> response.body()); + } + + /** + * You can update an existing content import source. + */ + public CompletableFuture updateContentImportSource( + UpdateContentImportSourceRequest request, RequestOptions requestOptions) { + return this.rawClient.updateContentImportSource(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can delete a content import source by making a DELETE request this endpoint. This will also delete all external pages that were imported from this source. + */ + public CompletableFuture deleteContentImportSource(DeleteContentImportSourceRequest request) { + return this.rawClient.deleteContentImportSource(request).thenApply(response -> response.body()); + } + + /** + * You can delete a content import source by making a DELETE request this endpoint. This will also delete all external pages that were imported from this source. + */ + public CompletableFuture deleteContentImportSource( + DeleteContentImportSourceRequest request, RequestOptions requestOptions) { + return this.rawClient.deleteContentImportSource(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can retrieve a list of all external pages for a workspace. + */ + public CompletableFuture listExternalPages() { + return this.rawClient.listExternalPages().thenApply(response -> response.body()); + } + + /** + * You can retrieve a list of all external pages for a workspace. + */ + public CompletableFuture listExternalPages(RequestOptions requestOptions) { + return this.rawClient.listExternalPages(requestOptions).thenApply(response -> response.body()); + } + + /** + * You can create a new external page by sending a POST request to this endpoint. If an external page already exists with the specified source_id and external_id, it will be updated instead. + */ + public CompletableFuture createExternalPage(CreateExternalPageRequest request) { + return this.rawClient.createExternalPage(request).thenApply(response -> response.body()); + } + + /** + * You can create a new external page by sending a POST request to this endpoint. If an external page already exists with the specified source_id and external_id, it will be updated instead. + */ + public CompletableFuture createExternalPage( + CreateExternalPageRequest request, RequestOptions requestOptions) { + return this.rawClient.createExternalPage(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can retrieve an external page. + */ + public CompletableFuture getExternalPage(GetExternalPageRequest request) { + return this.rawClient.getExternalPage(request).thenApply(response -> response.body()); + } + + /** + * You can retrieve an external page. + */ + public CompletableFuture getExternalPage( + GetExternalPageRequest request, RequestOptions requestOptions) { + return this.rawClient.getExternalPage(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can update an existing external page (if it was created via the API). + */ + public CompletableFuture updateExternalPage(UpdateExternalPageRequest request) { + return this.rawClient.updateExternalPage(request).thenApply(response -> response.body()); + } + + /** + * You can update an existing external page (if it was created via the API). + */ + public CompletableFuture updateExternalPage( + UpdateExternalPageRequest request, RequestOptions requestOptions) { + return this.rawClient.updateExternalPage(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * Sending a DELETE request for an external page will remove it from the content library UI and from being used for AI answers. + */ + public CompletableFuture deleteExternalPage(DeleteExternalPageRequest request) { + return this.rawClient.deleteExternalPage(request).thenApply(response -> response.body()); + } + + /** + * Sending a DELETE request for an external page will remove it from the content library UI and from being used for AI answers. + */ + public CompletableFuture deleteExternalPage( + DeleteExternalPageRequest request, RequestOptions requestOptions) { + return this.rawClient.deleteExternalPage(request, requestOptions).thenApply(response -> response.body()); + } +} diff --git a/src/main/java/com/intercom/api/resources/aicontent/AsyncRawAiContentClient.java b/src/main/java/com/intercom/api/resources/aicontent/AsyncRawAiContentClient.java new file mode 100644 index 00000000..5ff9023a --- /dev/null +++ b/src/main/java/com/intercom/api/resources/aicontent/AsyncRawAiContentClient.java @@ -0,0 +1,716 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.aicontent; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.IntercomApiException; +import com.intercom.api.core.IntercomException; +import com.intercom.api.core.IntercomHttpResponse; +import com.intercom.api.core.MediaTypes; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.errors.UnauthorizedError; +import com.intercom.api.resources.aicontent.requests.CreateContentImportSourceRequest; +import com.intercom.api.resources.aicontent.requests.CreateExternalPageRequest; +import com.intercom.api.resources.aicontent.requests.DeleteContentImportSourceRequest; +import com.intercom.api.resources.aicontent.requests.DeleteExternalPageRequest; +import com.intercom.api.resources.aicontent.requests.GetContentImportSourceRequest; +import com.intercom.api.resources.aicontent.requests.GetExternalPageRequest; +import com.intercom.api.resources.aicontent.requests.UpdateContentImportSourceRequest; +import com.intercom.api.resources.aicontent.requests.UpdateExternalPageRequest; +import com.intercom.api.resources.aicontent.types.ContentImportSource; +import com.intercom.api.resources.aicontent.types.ContentImportSourcesList; +import com.intercom.api.resources.aicontent.types.ExternalPage; +import com.intercom.api.resources.aicontent.types.ExternalPagesList; +import com.intercom.api.types.Error; +import java.io.IOException; +import java.util.concurrent.CompletableFuture; +import okhttp3.Call; +import okhttp3.Callback; +import okhttp3.Headers; +import okhttp3.HttpUrl; +import okhttp3.OkHttpClient; +import okhttp3.Request; +import okhttp3.RequestBody; +import okhttp3.Response; +import okhttp3.ResponseBody; +import org.jetbrains.annotations.NotNull; + +public class AsyncRawAiContentClient { + protected final ClientOptions clientOptions; + + public AsyncRawAiContentClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + } + + /** + * You can retrieve a list of all content import sources for a workspace. + */ + public CompletableFuture> listContentImportSources() { + return listContentImportSources(null); + } + + /** + * You can retrieve a list of all content import sources for a workspace. + */ + public CompletableFuture> listContentImportSources( + RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("ai/content_import_sources") + .build(); + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, ContentImportSourcesList.class), + response)); + return; + } + try { + if (response.code() == 401) { + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can create a new content import source by sending a POST request to this endpoint. + */ + public CompletableFuture> createContentImportSource( + CreateContentImportSourceRequest request) { + return createContentImportSource(request, null); + } + + /** + * You can create a new content import source by sending a POST request to this endpoint. + */ + public CompletableFuture> createContentImportSource( + CreateContentImportSourceRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("ai/content_import_sources") + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, ContentImportSource.class), + response)); + return; + } + try { + if (response.code() == 401) { + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + public CompletableFuture> getContentImportSource( + GetContentImportSourceRequest request) { + return getContentImportSource(request, null); + } + + public CompletableFuture> getContentImportSource( + GetContentImportSourceRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("ai/content_import_sources") + .addPathSegment(request.getSourceId()) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, ContentImportSource.class), + response)); + return; + } + try { + if (response.code() == 401) { + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can update an existing content import source. + */ + public CompletableFuture> updateContentImportSource( + UpdateContentImportSourceRequest request) { + return updateContentImportSource(request, null); + } + + /** + * You can update an existing content import source. + */ + public CompletableFuture> updateContentImportSource( + UpdateContentImportSourceRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("ai/content_import_sources") + .addPathSegment(request.getSourceId()) + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("PUT", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, ContentImportSource.class), + response)); + return; + } + try { + if (response.code() == 401) { + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can delete a content import source by making a DELETE request this endpoint. This will also delete all external pages that were imported from this source. + */ + public CompletableFuture> deleteContentImportSource( + DeleteContentImportSourceRequest request) { + return deleteContentImportSource(request, null); + } + + /** + * You can delete a content import source by making a DELETE request this endpoint. This will also delete all external pages that were imported from this source. + */ + public CompletableFuture> deleteContentImportSource( + DeleteContentImportSourceRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("ai/content_import_sources") + .addPathSegment(request.getSourceId()) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("DELETE", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>(null, response)); + return; + } + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + try { + if (response.code() == 401) { + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can retrieve a list of all external pages for a workspace. + */ + public CompletableFuture> listExternalPages() { + return listExternalPages(null); + } + + /** + * You can retrieve a list of all external pages for a workspace. + */ + public CompletableFuture> listExternalPages(RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("ai/external_pages") + .build(); + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, ExternalPagesList.class), + response)); + return; + } + try { + if (response.code() == 401) { + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can create a new external page by sending a POST request to this endpoint. If an external page already exists with the specified source_id and external_id, it will be updated instead. + */ + public CompletableFuture> createExternalPage(CreateExternalPageRequest request) { + return createExternalPage(request, null); + } + + /** + * You can create a new external page by sending a POST request to this endpoint. If an external page already exists with the specified source_id and external_id, it will be updated instead. + */ + public CompletableFuture> createExternalPage( + CreateExternalPageRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("ai/external_pages") + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, ExternalPage.class), response)); + return; + } + try { + if (response.code() == 401) { + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can retrieve an external page. + */ + public CompletableFuture> getExternalPage(GetExternalPageRequest request) { + return getExternalPage(request, null); + } + + /** + * You can retrieve an external page. + */ + public CompletableFuture> getExternalPage( + GetExternalPageRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("ai/external_pages") + .addPathSegment(request.getPageId()) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, ExternalPage.class), response)); + return; + } + try { + if (response.code() == 401) { + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can update an existing external page (if it was created via the API). + */ + public CompletableFuture> updateExternalPage(UpdateExternalPageRequest request) { + return updateExternalPage(request, null); + } + + /** + * You can update an existing external page (if it was created via the API). + */ + public CompletableFuture> updateExternalPage( + UpdateExternalPageRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("ai/external_pages") + .addPathSegment(request.getPageId()) + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("PUT", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, ExternalPage.class), response)); + return; + } + try { + if (response.code() == 401) { + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * Sending a DELETE request for an external page will remove it from the content library UI and from being used for AI answers. + */ + public CompletableFuture> deleteExternalPage(DeleteExternalPageRequest request) { + return deleteExternalPage(request, null); + } + + /** + * Sending a DELETE request for an external page will remove it from the content library UI and from being used for AI answers. + */ + public CompletableFuture> deleteExternalPage( + DeleteExternalPageRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("ai/external_pages") + .addPathSegment(request.getPageId()) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("DELETE", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, ExternalPage.class), response)); + return; + } + try { + if (response.code() == 401) { + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } +} diff --git a/src/main/java/com/intercom/api/resources/aicontent/RawAiContentClient.java b/src/main/java/com/intercom/api/resources/aicontent/RawAiContentClient.java new file mode 100644 index 00000000..1aa4e954 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/aicontent/RawAiContentClient.java @@ -0,0 +1,565 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.aicontent; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.IntercomApiException; +import com.intercom.api.core.IntercomException; +import com.intercom.api.core.IntercomHttpResponse; +import com.intercom.api.core.MediaTypes; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.errors.UnauthorizedError; +import com.intercom.api.resources.aicontent.requests.CreateContentImportSourceRequest; +import com.intercom.api.resources.aicontent.requests.CreateExternalPageRequest; +import com.intercom.api.resources.aicontent.requests.DeleteContentImportSourceRequest; +import com.intercom.api.resources.aicontent.requests.DeleteExternalPageRequest; +import com.intercom.api.resources.aicontent.requests.GetContentImportSourceRequest; +import com.intercom.api.resources.aicontent.requests.GetExternalPageRequest; +import com.intercom.api.resources.aicontent.requests.UpdateContentImportSourceRequest; +import com.intercom.api.resources.aicontent.requests.UpdateExternalPageRequest; +import com.intercom.api.resources.aicontent.types.ContentImportSource; +import com.intercom.api.resources.aicontent.types.ContentImportSourcesList; +import com.intercom.api.resources.aicontent.types.ExternalPage; +import com.intercom.api.resources.aicontent.types.ExternalPagesList; +import com.intercom.api.types.Error; +import java.io.IOException; +import okhttp3.Headers; +import okhttp3.HttpUrl; +import okhttp3.OkHttpClient; +import okhttp3.Request; +import okhttp3.RequestBody; +import okhttp3.Response; +import okhttp3.ResponseBody; + +public class RawAiContentClient { + protected final ClientOptions clientOptions; + + public RawAiContentClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + } + + /** + * You can retrieve a list of all content import sources for a workspace. + */ + public IntercomHttpResponse listContentImportSources() { + return listContentImportSources(null); + } + + /** + * You can retrieve a list of all content import sources for a workspace. + */ + public IntercomHttpResponse listContentImportSources(RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("ai/content_import_sources") + .build(); + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, ContentImportSourcesList.class), + response); + } + try { + if (response.code() == 401) { + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can create a new content import source by sending a POST request to this endpoint. + */ + public IntercomHttpResponse createContentImportSource( + CreateContentImportSourceRequest request) { + return createContentImportSource(request, null); + } + + /** + * You can create a new content import source by sending a POST request to this endpoint. + */ + public IntercomHttpResponse createContentImportSource( + CreateContentImportSourceRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("ai/content_import_sources") + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, ContentImportSource.class), response); + } + try { + if (response.code() == 401) { + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + public IntercomHttpResponse getContentImportSource(GetContentImportSourceRequest request) { + return getContentImportSource(request, null); + } + + public IntercomHttpResponse getContentImportSource( + GetContentImportSourceRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("ai/content_import_sources") + .addPathSegment(request.getSourceId()) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, ContentImportSource.class), response); + } + try { + if (response.code() == 401) { + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can update an existing content import source. + */ + public IntercomHttpResponse updateContentImportSource( + UpdateContentImportSourceRequest request) { + return updateContentImportSource(request, null); + } + + /** + * You can update an existing content import source. + */ + public IntercomHttpResponse updateContentImportSource( + UpdateContentImportSourceRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("ai/content_import_sources") + .addPathSegment(request.getSourceId()) + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("PUT", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, ContentImportSource.class), response); + } + try { + if (response.code() == 401) { + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can delete a content import source by making a DELETE request this endpoint. This will also delete all external pages that were imported from this source. + */ + public IntercomHttpResponse deleteContentImportSource(DeleteContentImportSourceRequest request) { + return deleteContentImportSource(request, null); + } + + /** + * You can delete a content import source by making a DELETE request this endpoint. This will also delete all external pages that were imported from this source. + */ + public IntercomHttpResponse deleteContentImportSource( + DeleteContentImportSourceRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("ai/content_import_sources") + .addPathSegment(request.getSourceId()) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("DELETE", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + if (response.isSuccessful()) { + return new IntercomHttpResponse<>(null, response); + } + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + try { + if (response.code() == 401) { + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can retrieve a list of all external pages for a workspace. + */ + public IntercomHttpResponse listExternalPages() { + return listExternalPages(null); + } + + /** + * You can retrieve a list of all external pages for a workspace. + */ + public IntercomHttpResponse listExternalPages(RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("ai/external_pages") + .build(); + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, ExternalPagesList.class), response); + } + try { + if (response.code() == 401) { + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can create a new external page by sending a POST request to this endpoint. If an external page already exists with the specified source_id and external_id, it will be updated instead. + */ + public IntercomHttpResponse createExternalPage(CreateExternalPageRequest request) { + return createExternalPage(request, null); + } + + /** + * You can create a new external page by sending a POST request to this endpoint. If an external page already exists with the specified source_id and external_id, it will be updated instead. + */ + public IntercomHttpResponse createExternalPage( + CreateExternalPageRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("ai/external_pages") + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, ExternalPage.class), response); + } + try { + if (response.code() == 401) { + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can retrieve an external page. + */ + public IntercomHttpResponse getExternalPage(GetExternalPageRequest request) { + return getExternalPage(request, null); + } + + /** + * You can retrieve an external page. + */ + public IntercomHttpResponse getExternalPage( + GetExternalPageRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("ai/external_pages") + .addPathSegment(request.getPageId()) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, ExternalPage.class), response); + } + try { + if (response.code() == 401) { + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can update an existing external page (if it was created via the API). + */ + public IntercomHttpResponse updateExternalPage(UpdateExternalPageRequest request) { + return updateExternalPage(request, null); + } + + /** + * You can update an existing external page (if it was created via the API). + */ + public IntercomHttpResponse updateExternalPage( + UpdateExternalPageRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("ai/external_pages") + .addPathSegment(request.getPageId()) + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("PUT", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, ExternalPage.class), response); + } + try { + if (response.code() == 401) { + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * Sending a DELETE request for an external page will remove it from the content library UI and from being used for AI answers. + */ + public IntercomHttpResponse deleteExternalPage(DeleteExternalPageRequest request) { + return deleteExternalPage(request, null); + } + + /** + * Sending a DELETE request for an external page will remove it from the content library UI and from being used for AI answers. + */ + public IntercomHttpResponse deleteExternalPage( + DeleteExternalPageRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("ai/external_pages") + .addPathSegment(request.getPageId()) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("DELETE", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, ExternalPage.class), response); + } + try { + if (response.code() == 401) { + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/aicontent/requests/CreateContentImportSourceRequest.java b/src/main/java/com/intercom/api/resources/aicontent/requests/CreateContentImportSourceRequest.java new file mode 100644 index 00000000..4dd82e84 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/aicontent/requests/CreateContentImportSourceRequest.java @@ -0,0 +1,242 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.aicontent.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.JsonValue; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = CreateContentImportSourceRequest.Builder.class) +public final class CreateContentImportSourceRequest { + private final Optional status; + + private final String url; + + private final Map additionalProperties; + + private CreateContentImportSourceRequest( + Optional status, String url, Map additionalProperties) { + this.status = status; + this.url = url; + this.additionalProperties = additionalProperties; + } + + /** + * @return If you intend to create or update External Pages via the API, this should be set to api. + */ + @JsonProperty("sync_behavior") + public String getSyncBehavior() { + return "api"; + } + + /** + * @return The status of the content import source. + */ + @JsonProperty("status") + public Optional getStatus() { + return status; + } + + /** + * @return The URL of the content import source. + */ + @JsonProperty("url") + public String getUrl() { + return url; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof CreateContentImportSourceRequest && equalTo((CreateContentImportSourceRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(CreateContentImportSourceRequest other) { + return status.equals(other.status) && url.equals(other.url); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.status, this.url); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static UrlStage builder() { + return new Builder(); + } + + public interface UrlStage { + /** + *

The URL of the content import source.

+ */ + _FinalStage url(@NotNull String url); + + Builder from(CreateContentImportSourceRequest other); + } + + public interface _FinalStage { + CreateContentImportSourceRequest build(); + + /** + *

The status of the content import source.

+ */ + _FinalStage status(Optional status); + + _FinalStage status(Status status); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements UrlStage, _FinalStage { + private String url; + + private Optional status = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(CreateContentImportSourceRequest other) { + status(other.getStatus()); + url(other.getUrl()); + return this; + } + + /** + *

The URL of the content import source.

+ *

The URL of the content import source.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("url") + public _FinalStage url(@NotNull String url) { + this.url = Objects.requireNonNull(url, "url must not be null"); + return this; + } + + /** + *

The status of the content import source.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage status(Status status) { + this.status = Optional.ofNullable(status); + return this; + } + + /** + *

The status of the content import source.

+ */ + @java.lang.Override + @JsonSetter(value = "status", nulls = Nulls.SKIP) + public _FinalStage status(Optional status) { + this.status = status; + return this; + } + + @java.lang.Override + public CreateContentImportSourceRequest build() { + return new CreateContentImportSourceRequest(status, url, additionalProperties); + } + } + + public static final class Status { + public static final Status DEACTIVATED = new Status(Value.DEACTIVATED, "deactivated"); + + public static final Status ACTIVE = new Status(Value.ACTIVE, "active"); + + private final Value value; + + private final String string; + + Status(Value value, String string) { + this.value = value; + this.string = string; + } + + public Value getEnumValue() { + return value; + } + + @java.lang.Override + @JsonValue + public String toString() { + return this.string; + } + + @java.lang.Override + public boolean equals(Object other) { + return (this == other) || (other instanceof Status && this.string.equals(((Status) other).string)); + } + + @java.lang.Override + public int hashCode() { + return this.string.hashCode(); + } + + public T visit(Visitor visitor) { + switch (value) { + case DEACTIVATED: + return visitor.visitDeactivated(); + case ACTIVE: + return visitor.visitActive(); + case UNKNOWN: + default: + return visitor.visitUnknown(string); + } + } + + @JsonCreator(mode = JsonCreator.Mode.DELEGATING) + public static Status valueOf(String value) { + switch (value) { + case "deactivated": + return DEACTIVATED; + case "active": + return ACTIVE; + default: + return new Status(Value.UNKNOWN, value); + } + } + + public enum Value { + ACTIVE, + + DEACTIVATED, + + UNKNOWN + } + + public interface Visitor { + T visitActive(); + + T visitDeactivated(); + + T visitUnknown(String unknownType); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/aicontent/requests/CreateExternalPageRequest.java b/src/main/java/com/intercom/api/resources/aicontent/requests/CreateExternalPageRequest.java new file mode 100644 index 00000000..7b6470d5 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/aicontent/requests/CreateExternalPageRequest.java @@ -0,0 +1,374 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.aicontent.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = CreateExternalPageRequest.Builder.class) +public final class CreateExternalPageRequest { + private final String title; + + private final String html; + + private final Optional url; + + private final Optional aiAgentAvailability; + + private final Optional aiCopilotAvailability; + + private final int sourceId; + + private final String externalId; + + private final Map additionalProperties; + + private CreateExternalPageRequest( + String title, + String html, + Optional url, + Optional aiAgentAvailability, + Optional aiCopilotAvailability, + int sourceId, + String externalId, + Map additionalProperties) { + this.title = title; + this.html = html; + this.url = url; + this.aiAgentAvailability = aiAgentAvailability; + this.aiCopilotAvailability = aiCopilotAvailability; + this.sourceId = sourceId; + this.externalId = externalId; + this.additionalProperties = additionalProperties; + } + + /** + * @return The title of the external page. + */ + @JsonProperty("title") + public String getTitle() { + return title; + } + + /** + * @return The body of the external page in HTML. + */ + @JsonProperty("html") + public String getHtml() { + return html; + } + + /** + * @return The URL of the external page. This will be used by Fin to link end users to the page it based its answer on. When a URL is not present, Fin will not reference the source. + */ + @JsonProperty("url") + public Optional getUrl() { + return url; + } + + /** + * @return Whether the external page should be used to answer questions by AI Agent. Will not default when updating an existing external page. + */ + @JsonProperty("ai_agent_availability") + public Optional getAiAgentAvailability() { + return aiAgentAvailability; + } + + /** + * @return Whether the external page should be used to answer questions by AI Copilot. Will not default when updating an existing external page. + */ + @JsonProperty("ai_copilot_availability") + public Optional getAiCopilotAvailability() { + return aiCopilotAvailability; + } + + /** + * @return Always en + */ + @JsonProperty("locale") + public String getLocale() { + return "en"; + } + + /** + * @return The unique identifier for the source of the external page which was given by Intercom. Every external page must be associated with a Content Import Source which represents the place it comes from and from which it inherits a default audience (configured in the UI). For a new source, make a POST request to the Content Import Source endpoint and an ID for the source will be returned in the response. + */ + @JsonProperty("source_id") + public int getSourceId() { + return sourceId; + } + + /** + * @return The identifier for the external page which was given by the source. Must be unique for the source. + */ + @JsonProperty("external_id") + public String getExternalId() { + return externalId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof CreateExternalPageRequest && equalTo((CreateExternalPageRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(CreateExternalPageRequest other) { + return title.equals(other.title) + && html.equals(other.html) + && url.equals(other.url) + && aiAgentAvailability.equals(other.aiAgentAvailability) + && aiCopilotAvailability.equals(other.aiCopilotAvailability) + && sourceId == other.sourceId + && externalId.equals(other.externalId); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash( + this.title, + this.html, + this.url, + this.aiAgentAvailability, + this.aiCopilotAvailability, + this.sourceId, + this.externalId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static TitleStage builder() { + return new Builder(); + } + + public interface TitleStage { + /** + *

The title of the external page.

+ */ + HtmlStage title(@NotNull String title); + + Builder from(CreateExternalPageRequest other); + } + + public interface HtmlStage { + /** + *

The body of the external page in HTML.

+ */ + SourceIdStage html(@NotNull String html); + } + + public interface SourceIdStage { + /** + *

The unique identifier for the source of the external page which was given by Intercom. Every external page must be associated with a Content Import Source which represents the place it comes from and from which it inherits a default audience (configured in the UI). For a new source, make a POST request to the Content Import Source endpoint and an ID for the source will be returned in the response.

+ */ + ExternalIdStage sourceId(int sourceId); + } + + public interface ExternalIdStage { + /** + *

The identifier for the external page which was given by the source. Must be unique for the source.

+ */ + _FinalStage externalId(@NotNull String externalId); + } + + public interface _FinalStage { + CreateExternalPageRequest build(); + + /** + *

The URL of the external page. This will be used by Fin to link end users to the page it based its answer on. When a URL is not present, Fin will not reference the source.

+ */ + _FinalStage url(Optional url); + + _FinalStage url(String url); + + /** + *

Whether the external page should be used to answer questions by AI Agent. Will not default when updating an existing external page.

+ */ + _FinalStage aiAgentAvailability(Optional aiAgentAvailability); + + _FinalStage aiAgentAvailability(Boolean aiAgentAvailability); + + /** + *

Whether the external page should be used to answer questions by AI Copilot. Will not default when updating an existing external page.

+ */ + _FinalStage aiCopilotAvailability(Optional aiCopilotAvailability); + + _FinalStage aiCopilotAvailability(Boolean aiCopilotAvailability); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements TitleStage, HtmlStage, SourceIdStage, ExternalIdStage, _FinalStage { + private String title; + + private String html; + + private int sourceId; + + private String externalId; + + private Optional aiCopilotAvailability = Optional.empty(); + + private Optional aiAgentAvailability = Optional.empty(); + + private Optional url = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(CreateExternalPageRequest other) { + title(other.getTitle()); + html(other.getHtml()); + url(other.getUrl()); + aiAgentAvailability(other.getAiAgentAvailability()); + aiCopilotAvailability(other.getAiCopilotAvailability()); + sourceId(other.getSourceId()); + externalId(other.getExternalId()); + return this; + } + + /** + *

The title of the external page.

+ *

The title of the external page.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("title") + public HtmlStage title(@NotNull String title) { + this.title = Objects.requireNonNull(title, "title must not be null"); + return this; + } + + /** + *

The body of the external page in HTML.

+ *

The body of the external page in HTML.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("html") + public SourceIdStage html(@NotNull String html) { + this.html = Objects.requireNonNull(html, "html must not be null"); + return this; + } + + /** + *

The unique identifier for the source of the external page which was given by Intercom. Every external page must be associated with a Content Import Source which represents the place it comes from and from which it inherits a default audience (configured in the UI). For a new source, make a POST request to the Content Import Source endpoint and an ID for the source will be returned in the response.

+ *

The unique identifier for the source of the external page which was given by Intercom. Every external page must be associated with a Content Import Source which represents the place it comes from and from which it inherits a default audience (configured in the UI). For a new source, make a POST request to the Content Import Source endpoint and an ID for the source will be returned in the response.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("source_id") + public ExternalIdStage sourceId(int sourceId) { + this.sourceId = sourceId; + return this; + } + + /** + *

The identifier for the external page which was given by the source. Must be unique for the source.

+ *

The identifier for the external page which was given by the source. Must be unique for the source.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("external_id") + public _FinalStage externalId(@NotNull String externalId) { + this.externalId = Objects.requireNonNull(externalId, "externalId must not be null"); + return this; + } + + /** + *

Whether the external page should be used to answer questions by AI Copilot. Will not default when updating an existing external page.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage aiCopilotAvailability(Boolean aiCopilotAvailability) { + this.aiCopilotAvailability = Optional.ofNullable(aiCopilotAvailability); + return this; + } + + /** + *

Whether the external page should be used to answer questions by AI Copilot. Will not default when updating an existing external page.

+ */ + @java.lang.Override + @JsonSetter(value = "ai_copilot_availability", nulls = Nulls.SKIP) + public _FinalStage aiCopilotAvailability(Optional aiCopilotAvailability) { + this.aiCopilotAvailability = aiCopilotAvailability; + return this; + } + + /** + *

Whether the external page should be used to answer questions by AI Agent. Will not default when updating an existing external page.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage aiAgentAvailability(Boolean aiAgentAvailability) { + this.aiAgentAvailability = Optional.ofNullable(aiAgentAvailability); + return this; + } + + /** + *

Whether the external page should be used to answer questions by AI Agent. Will not default when updating an existing external page.

+ */ + @java.lang.Override + @JsonSetter(value = "ai_agent_availability", nulls = Nulls.SKIP) + public _FinalStage aiAgentAvailability(Optional aiAgentAvailability) { + this.aiAgentAvailability = aiAgentAvailability; + return this; + } + + /** + *

The URL of the external page. This will be used by Fin to link end users to the page it based its answer on. When a URL is not present, Fin will not reference the source.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage url(String url) { + this.url = Optional.ofNullable(url); + return this; + } + + /** + *

The URL of the external page. This will be used by Fin to link end users to the page it based its answer on. When a URL is not present, Fin will not reference the source.

+ */ + @java.lang.Override + @JsonSetter(value = "url", nulls = Nulls.SKIP) + public _FinalStage url(Optional url) { + this.url = url; + return this; + } + + @java.lang.Override + public CreateExternalPageRequest build() { + return new CreateExternalPageRequest( + title, + html, + url, + aiAgentAvailability, + aiCopilotAvailability, + sourceId, + externalId, + additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/aicontent/requests/DeleteContentImportSourceRequest.java b/src/main/java/com/intercom/api/resources/aicontent/requests/DeleteContentImportSourceRequest.java new file mode 100644 index 00000000..ce2ca3b1 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/aicontent/requests/DeleteContentImportSourceRequest.java @@ -0,0 +1,113 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.aicontent.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = DeleteContentImportSourceRequest.Builder.class) +public final class DeleteContentImportSourceRequest { + private final String sourceId; + + private final Map additionalProperties; + + private DeleteContentImportSourceRequest(String sourceId, Map additionalProperties) { + this.sourceId = sourceId; + this.additionalProperties = additionalProperties; + } + + /** + * @return The unique identifier for the content import source which is given by Intercom. + */ + @JsonProperty("source_id") + public String getSourceId() { + return sourceId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof DeleteContentImportSourceRequest && equalTo((DeleteContentImportSourceRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(DeleteContentImportSourceRequest other) { + return sourceId.equals(other.sourceId); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.sourceId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static SourceIdStage builder() { + return new Builder(); + } + + public interface SourceIdStage { + /** + *

The unique identifier for the content import source which is given by Intercom.

+ */ + _FinalStage sourceId(@NotNull String sourceId); + + Builder from(DeleteContentImportSourceRequest other); + } + + public interface _FinalStage { + DeleteContentImportSourceRequest build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements SourceIdStage, _FinalStage { + private String sourceId; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(DeleteContentImportSourceRequest other) { + sourceId(other.getSourceId()); + return this; + } + + /** + *

The unique identifier for the content import source which is given by Intercom.

+ *

The unique identifier for the content import source which is given by Intercom.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("source_id") + public _FinalStage sourceId(@NotNull String sourceId) { + this.sourceId = Objects.requireNonNull(sourceId, "sourceId must not be null"); + return this; + } + + @java.lang.Override + public DeleteContentImportSourceRequest build() { + return new DeleteContentImportSourceRequest(sourceId, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/aicontent/requests/DeleteExternalPageRequest.java b/src/main/java/com/intercom/api/resources/aicontent/requests/DeleteExternalPageRequest.java new file mode 100644 index 00000000..103728c6 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/aicontent/requests/DeleteExternalPageRequest.java @@ -0,0 +1,113 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.aicontent.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = DeleteExternalPageRequest.Builder.class) +public final class DeleteExternalPageRequest { + private final String pageId; + + private final Map additionalProperties; + + private DeleteExternalPageRequest(String pageId, Map additionalProperties) { + this.pageId = pageId; + this.additionalProperties = additionalProperties; + } + + /** + * @return The unique identifier for the external page which is given by Intercom. + */ + @JsonProperty("page_id") + public String getPageId() { + return pageId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof DeleteExternalPageRequest && equalTo((DeleteExternalPageRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(DeleteExternalPageRequest other) { + return pageId.equals(other.pageId); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.pageId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static PageIdStage builder() { + return new Builder(); + } + + public interface PageIdStage { + /** + *

The unique identifier for the external page which is given by Intercom.

+ */ + _FinalStage pageId(@NotNull String pageId); + + Builder from(DeleteExternalPageRequest other); + } + + public interface _FinalStage { + DeleteExternalPageRequest build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements PageIdStage, _FinalStage { + private String pageId; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(DeleteExternalPageRequest other) { + pageId(other.getPageId()); + return this; + } + + /** + *

The unique identifier for the external page which is given by Intercom.

+ *

The unique identifier for the external page which is given by Intercom.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("page_id") + public _FinalStage pageId(@NotNull String pageId) { + this.pageId = Objects.requireNonNull(pageId, "pageId must not be null"); + return this; + } + + @java.lang.Override + public DeleteExternalPageRequest build() { + return new DeleteExternalPageRequest(pageId, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/aicontent/requests/GetContentImportSourceRequest.java b/src/main/java/com/intercom/api/resources/aicontent/requests/GetContentImportSourceRequest.java new file mode 100644 index 00000000..888f2cee --- /dev/null +++ b/src/main/java/com/intercom/api/resources/aicontent/requests/GetContentImportSourceRequest.java @@ -0,0 +1,113 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.aicontent.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = GetContentImportSourceRequest.Builder.class) +public final class GetContentImportSourceRequest { + private final String sourceId; + + private final Map additionalProperties; + + private GetContentImportSourceRequest(String sourceId, Map additionalProperties) { + this.sourceId = sourceId; + this.additionalProperties = additionalProperties; + } + + /** + * @return The unique identifier for the content import source which is given by Intercom. + */ + @JsonProperty("source_id") + public String getSourceId() { + return sourceId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof GetContentImportSourceRequest && equalTo((GetContentImportSourceRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(GetContentImportSourceRequest other) { + return sourceId.equals(other.sourceId); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.sourceId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static SourceIdStage builder() { + return new Builder(); + } + + public interface SourceIdStage { + /** + *

The unique identifier for the content import source which is given by Intercom.

+ */ + _FinalStage sourceId(@NotNull String sourceId); + + Builder from(GetContentImportSourceRequest other); + } + + public interface _FinalStage { + GetContentImportSourceRequest build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements SourceIdStage, _FinalStage { + private String sourceId; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(GetContentImportSourceRequest other) { + sourceId(other.getSourceId()); + return this; + } + + /** + *

The unique identifier for the content import source which is given by Intercom.

+ *

The unique identifier for the content import source which is given by Intercom.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("source_id") + public _FinalStage sourceId(@NotNull String sourceId) { + this.sourceId = Objects.requireNonNull(sourceId, "sourceId must not be null"); + return this; + } + + @java.lang.Override + public GetContentImportSourceRequest build() { + return new GetContentImportSourceRequest(sourceId, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/aicontent/requests/GetExternalPageRequest.java b/src/main/java/com/intercom/api/resources/aicontent/requests/GetExternalPageRequest.java new file mode 100644 index 00000000..c281ba2d --- /dev/null +++ b/src/main/java/com/intercom/api/resources/aicontent/requests/GetExternalPageRequest.java @@ -0,0 +1,113 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.aicontent.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = GetExternalPageRequest.Builder.class) +public final class GetExternalPageRequest { + private final String pageId; + + private final Map additionalProperties; + + private GetExternalPageRequest(String pageId, Map additionalProperties) { + this.pageId = pageId; + this.additionalProperties = additionalProperties; + } + + /** + * @return The unique identifier for the external page which is given by Intercom. + */ + @JsonProperty("page_id") + public String getPageId() { + return pageId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof GetExternalPageRequest && equalTo((GetExternalPageRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(GetExternalPageRequest other) { + return pageId.equals(other.pageId); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.pageId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static PageIdStage builder() { + return new Builder(); + } + + public interface PageIdStage { + /** + *

The unique identifier for the external page which is given by Intercom.

+ */ + _FinalStage pageId(@NotNull String pageId); + + Builder from(GetExternalPageRequest other); + } + + public interface _FinalStage { + GetExternalPageRequest build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements PageIdStage, _FinalStage { + private String pageId; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(GetExternalPageRequest other) { + pageId(other.getPageId()); + return this; + } + + /** + *

The unique identifier for the external page which is given by Intercom.

+ *

The unique identifier for the external page which is given by Intercom.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("page_id") + public _FinalStage pageId(@NotNull String pageId) { + this.pageId = Objects.requireNonNull(pageId, "pageId must not be null"); + return this; + } + + @java.lang.Override + public GetExternalPageRequest build() { + return new GetExternalPageRequest(pageId, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/aicontent/requests/UpdateContentImportSourceRequest.java b/src/main/java/com/intercom/api/resources/aicontent/requests/UpdateContentImportSourceRequest.java new file mode 100644 index 00000000..3d48656b --- /dev/null +++ b/src/main/java/com/intercom/api/resources/aicontent/requests/UpdateContentImportSourceRequest.java @@ -0,0 +1,393 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.aicontent.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.JsonValue; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = UpdateContentImportSourceRequest.Builder.class) +public final class UpdateContentImportSourceRequest { + private final String sourceId; + + private final SyncBehavior syncBehavior; + + private final Optional status; + + private final String url; + + private final Map additionalProperties; + + private UpdateContentImportSourceRequest( + String sourceId, + SyncBehavior syncBehavior, + Optional status, + String url, + Map additionalProperties) { + this.sourceId = sourceId; + this.syncBehavior = syncBehavior; + this.status = status; + this.url = url; + this.additionalProperties = additionalProperties; + } + + /** + * @return The unique identifier for the content import source which is given by Intercom. + */ + @JsonProperty("source_id") + public String getSourceId() { + return sourceId; + } + + /** + * @return If you intend to create or update External Pages via the API, this should be set to api. You can not change the value to or from api. + */ + @JsonProperty("sync_behavior") + public SyncBehavior getSyncBehavior() { + return syncBehavior; + } + + /** + * @return The status of the content import source. + */ + @JsonProperty("status") + public Optional getStatus() { + return status; + } + + /** + * @return The URL of the content import source. This may only be different from the existing value if the sync behavior is API. + */ + @JsonProperty("url") + public String getUrl() { + return url; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof UpdateContentImportSourceRequest && equalTo((UpdateContentImportSourceRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(UpdateContentImportSourceRequest other) { + return sourceId.equals(other.sourceId) + && syncBehavior.equals(other.syncBehavior) + && status.equals(other.status) + && url.equals(other.url); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.sourceId, this.syncBehavior, this.status, this.url); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static SourceIdStage builder() { + return new Builder(); + } + + public interface SourceIdStage { + /** + *

The unique identifier for the content import source which is given by Intercom.

+ */ + SyncBehaviorStage sourceId(@NotNull String sourceId); + + Builder from(UpdateContentImportSourceRequest other); + } + + public interface SyncBehaviorStage { + /** + *

If you intend to create or update External Pages via the API, this should be set to api. You can not change the value to or from api.

+ */ + UrlStage syncBehavior(@NotNull SyncBehavior syncBehavior); + } + + public interface UrlStage { + /** + *

The URL of the content import source. This may only be different from the existing value if the sync behavior is API.

+ */ + _FinalStage url(@NotNull String url); + } + + public interface _FinalStage { + UpdateContentImportSourceRequest build(); + + /** + *

The status of the content import source.

+ */ + _FinalStage status(Optional status); + + _FinalStage status(Status status); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements SourceIdStage, SyncBehaviorStage, UrlStage, _FinalStage { + private String sourceId; + + private SyncBehavior syncBehavior; + + private String url; + + private Optional status = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(UpdateContentImportSourceRequest other) { + sourceId(other.getSourceId()); + syncBehavior(other.getSyncBehavior()); + status(other.getStatus()); + url(other.getUrl()); + return this; + } + + /** + *

The unique identifier for the content import source which is given by Intercom.

+ *

The unique identifier for the content import source which is given by Intercom.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("source_id") + public SyncBehaviorStage sourceId(@NotNull String sourceId) { + this.sourceId = Objects.requireNonNull(sourceId, "sourceId must not be null"); + return this; + } + + /** + *

If you intend to create or update External Pages via the API, this should be set to api. You can not change the value to or from api.

+ *

If you intend to create or update External Pages via the API, this should be set to api. You can not change the value to or from api.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("sync_behavior") + public UrlStage syncBehavior(@NotNull SyncBehavior syncBehavior) { + this.syncBehavior = Objects.requireNonNull(syncBehavior, "syncBehavior must not be null"); + return this; + } + + /** + *

The URL of the content import source. This may only be different from the existing value if the sync behavior is API.

+ *

The URL of the content import source. This may only be different from the existing value if the sync behavior is API.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("url") + public _FinalStage url(@NotNull String url) { + this.url = Objects.requireNonNull(url, "url must not be null"); + return this; + } + + /** + *

The status of the content import source.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage status(Status status) { + this.status = Optional.ofNullable(status); + return this; + } + + /** + *

The status of the content import source.

+ */ + @java.lang.Override + @JsonSetter(value = "status", nulls = Nulls.SKIP) + public _FinalStage status(Optional status) { + this.status = status; + return this; + } + + @java.lang.Override + public UpdateContentImportSourceRequest build() { + return new UpdateContentImportSourceRequest(sourceId, syncBehavior, status, url, additionalProperties); + } + } + + public static final class SyncBehavior { + public static final SyncBehavior AUTOMATED = new SyncBehavior(Value.AUTOMATED, "automated"); + + public static final SyncBehavior MANUAL = new SyncBehavior(Value.MANUAL, "manual"); + + public static final SyncBehavior API = new SyncBehavior(Value.API, "api"); + + private final Value value; + + private final String string; + + SyncBehavior(Value value, String string) { + this.value = value; + this.string = string; + } + + public Value getEnumValue() { + return value; + } + + @java.lang.Override + @JsonValue + public String toString() { + return this.string; + } + + @java.lang.Override + public boolean equals(Object other) { + return (this == other) + || (other instanceof SyncBehavior && this.string.equals(((SyncBehavior) other).string)); + } + + @java.lang.Override + public int hashCode() { + return this.string.hashCode(); + } + + public T visit(Visitor visitor) { + switch (value) { + case AUTOMATED: + return visitor.visitAutomated(); + case MANUAL: + return visitor.visitManual(); + case API: + return visitor.visitApi(); + case UNKNOWN: + default: + return visitor.visitUnknown(string); + } + } + + @JsonCreator(mode = JsonCreator.Mode.DELEGATING) + public static SyncBehavior valueOf(String value) { + switch (value) { + case "automated": + return AUTOMATED; + case "manual": + return MANUAL; + case "api": + return API; + default: + return new SyncBehavior(Value.UNKNOWN, value); + } + } + + public enum Value { + API, + + AUTOMATED, + + MANUAL, + + UNKNOWN + } + + public interface Visitor { + T visitApi(); + + T visitAutomated(); + + T visitManual(); + + T visitUnknown(String unknownType); + } + } + + public static final class Status { + public static final Status DEACTIVATED = new Status(Value.DEACTIVATED, "deactivated"); + + public static final Status ACTIVE = new Status(Value.ACTIVE, "active"); + + private final Value value; + + private final String string; + + Status(Value value, String string) { + this.value = value; + this.string = string; + } + + public Value getEnumValue() { + return value; + } + + @java.lang.Override + @JsonValue + public String toString() { + return this.string; + } + + @java.lang.Override + public boolean equals(Object other) { + return (this == other) || (other instanceof Status && this.string.equals(((Status) other).string)); + } + + @java.lang.Override + public int hashCode() { + return this.string.hashCode(); + } + + public T visit(Visitor visitor) { + switch (value) { + case DEACTIVATED: + return visitor.visitDeactivated(); + case ACTIVE: + return visitor.visitActive(); + case UNKNOWN: + default: + return visitor.visitUnknown(string); + } + } + + @JsonCreator(mode = JsonCreator.Mode.DELEGATING) + public static Status valueOf(String value) { + switch (value) { + case "deactivated": + return DEACTIVATED; + case "active": + return ACTIVE; + default: + return new Status(Value.UNKNOWN, value); + } + } + + public enum Value { + ACTIVE, + + DEACTIVATED, + + UNKNOWN + } + + public interface Visitor { + T visitActive(); + + T visitDeactivated(); + + T visitUnknown(String unknownType); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/aicontent/requests/UpdateExternalPageRequest.java b/src/main/java/com/intercom/api/resources/aicontent/requests/UpdateExternalPageRequest.java new file mode 100644 index 00000000..70c6df70 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/aicontent/requests/UpdateExternalPageRequest.java @@ -0,0 +1,354 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.aicontent.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = UpdateExternalPageRequest.Builder.class) +public final class UpdateExternalPageRequest { + private final String pageId; + + private final String title; + + private final String html; + + private final String url; + + private final Optional finAvailability; + + private final int sourceId; + + private final Optional externalId; + + private final Map additionalProperties; + + private UpdateExternalPageRequest( + String pageId, + String title, + String html, + String url, + Optional finAvailability, + int sourceId, + Optional externalId, + Map additionalProperties) { + this.pageId = pageId; + this.title = title; + this.html = html; + this.url = url; + this.finAvailability = finAvailability; + this.sourceId = sourceId; + this.externalId = externalId; + this.additionalProperties = additionalProperties; + } + + /** + * @return The unique identifier for the external page which is given by Intercom. + */ + @JsonProperty("page_id") + public String getPageId() { + return pageId; + } + + /** + * @return The title of the external page. + */ + @JsonProperty("title") + public String getTitle() { + return title; + } + + /** + * @return The body of the external page in HTML. + */ + @JsonProperty("html") + public String getHtml() { + return html; + } + + /** + * @return The URL of the external page. This will be used by Fin to link end users to the page it based its answer on. + */ + @JsonProperty("url") + public String getUrl() { + return url; + } + + /** + * @return Whether the external page should be used to answer questions by Fin. + */ + @JsonProperty("fin_availability") + public Optional getFinAvailability() { + return finAvailability; + } + + /** + * @return Always en + */ + @JsonProperty("locale") + public String getLocale() { + return "en"; + } + + /** + * @return The unique identifier for the source of the external page which was given by Intercom. Every external page must be associated with a Content Import Source which represents the place it comes from and from which it inherits a default audience (configured in the UI). For a new source, make a POST request to the Content Import Source endpoint and an ID for the source will be returned in the response. + */ + @JsonProperty("source_id") + public int getSourceId() { + return sourceId; + } + + /** + * @return The identifier for the external page which was given by the source. Must be unique for the source. + */ + @JsonProperty("external_id") + public Optional getExternalId() { + return externalId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof UpdateExternalPageRequest && equalTo((UpdateExternalPageRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(UpdateExternalPageRequest other) { + return pageId.equals(other.pageId) + && title.equals(other.title) + && html.equals(other.html) + && url.equals(other.url) + && finAvailability.equals(other.finAvailability) + && sourceId == other.sourceId + && externalId.equals(other.externalId); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash( + this.pageId, this.title, this.html, this.url, this.finAvailability, this.sourceId, this.externalId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static PageIdStage builder() { + return new Builder(); + } + + public interface PageIdStage { + /** + *

The unique identifier for the external page which is given by Intercom.

+ */ + TitleStage pageId(@NotNull String pageId); + + Builder from(UpdateExternalPageRequest other); + } + + public interface TitleStage { + /** + *

The title of the external page.

+ */ + HtmlStage title(@NotNull String title); + } + + public interface HtmlStage { + /** + *

The body of the external page in HTML.

+ */ + UrlStage html(@NotNull String html); + } + + public interface UrlStage { + /** + *

The URL of the external page. This will be used by Fin to link end users to the page it based its answer on.

+ */ + SourceIdStage url(@NotNull String url); + } + + public interface SourceIdStage { + /** + *

The unique identifier for the source of the external page which was given by Intercom. Every external page must be associated with a Content Import Source which represents the place it comes from and from which it inherits a default audience (configured in the UI). For a new source, make a POST request to the Content Import Source endpoint and an ID for the source will be returned in the response.

+ */ + _FinalStage sourceId(int sourceId); + } + + public interface _FinalStage { + UpdateExternalPageRequest build(); + + /** + *

Whether the external page should be used to answer questions by Fin.

+ */ + _FinalStage finAvailability(Optional finAvailability); + + _FinalStage finAvailability(Boolean finAvailability); + + /** + *

The identifier for the external page which was given by the source. Must be unique for the source.

+ */ + _FinalStage externalId(Optional externalId); + + _FinalStage externalId(String externalId); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder + implements PageIdStage, TitleStage, HtmlStage, UrlStage, SourceIdStage, _FinalStage { + private String pageId; + + private String title; + + private String html; + + private String url; + + private int sourceId; + + private Optional externalId = Optional.empty(); + + private Optional finAvailability = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(UpdateExternalPageRequest other) { + pageId(other.getPageId()); + title(other.getTitle()); + html(other.getHtml()); + url(other.getUrl()); + finAvailability(other.getFinAvailability()); + sourceId(other.getSourceId()); + externalId(other.getExternalId()); + return this; + } + + /** + *

The unique identifier for the external page which is given by Intercom.

+ *

The unique identifier for the external page which is given by Intercom.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("page_id") + public TitleStage pageId(@NotNull String pageId) { + this.pageId = Objects.requireNonNull(pageId, "pageId must not be null"); + return this; + } + + /** + *

The title of the external page.

+ *

The title of the external page.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("title") + public HtmlStage title(@NotNull String title) { + this.title = Objects.requireNonNull(title, "title must not be null"); + return this; + } + + /** + *

The body of the external page in HTML.

+ *

The body of the external page in HTML.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("html") + public UrlStage html(@NotNull String html) { + this.html = Objects.requireNonNull(html, "html must not be null"); + return this; + } + + /** + *

The URL of the external page. This will be used by Fin to link end users to the page it based its answer on.

+ *

The URL of the external page. This will be used by Fin to link end users to the page it based its answer on.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("url") + public SourceIdStage url(@NotNull String url) { + this.url = Objects.requireNonNull(url, "url must not be null"); + return this; + } + + /** + *

The unique identifier for the source of the external page which was given by Intercom. Every external page must be associated with a Content Import Source which represents the place it comes from and from which it inherits a default audience (configured in the UI). For a new source, make a POST request to the Content Import Source endpoint and an ID for the source will be returned in the response.

+ *

The unique identifier for the source of the external page which was given by Intercom. Every external page must be associated with a Content Import Source which represents the place it comes from and from which it inherits a default audience (configured in the UI). For a new source, make a POST request to the Content Import Source endpoint and an ID for the source will be returned in the response.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("source_id") + public _FinalStage sourceId(int sourceId) { + this.sourceId = sourceId; + return this; + } + + /** + *

The identifier for the external page which was given by the source. Must be unique for the source.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage externalId(String externalId) { + this.externalId = Optional.ofNullable(externalId); + return this; + } + + /** + *

The identifier for the external page which was given by the source. Must be unique for the source.

+ */ + @java.lang.Override + @JsonSetter(value = "external_id", nulls = Nulls.SKIP) + public _FinalStage externalId(Optional externalId) { + this.externalId = externalId; + return this; + } + + /** + *

Whether the external page should be used to answer questions by Fin.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage finAvailability(Boolean finAvailability) { + this.finAvailability = Optional.ofNullable(finAvailability); + return this; + } + + /** + *

Whether the external page should be used to answer questions by Fin.

+ */ + @java.lang.Override + @JsonSetter(value = "fin_availability", nulls = Nulls.SKIP) + public _FinalStage finAvailability(Optional finAvailability) { + this.finAvailability = finAvailability; + return this; + } + + @java.lang.Override + public UpdateExternalPageRequest build() { + return new UpdateExternalPageRequest( + pageId, title, html, url, finAvailability, sourceId, externalId, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/aicontent/types/ContentImportSource.java b/src/main/java/com/intercom/api/resources/aicontent/types/ContentImportSource.java new file mode 100644 index 00000000..50f5a6bd --- /dev/null +++ b/src/main/java/com/intercom/api/resources/aicontent/types/ContentImportSource.java @@ -0,0 +1,506 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.aicontent.types; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.JsonValue; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = ContentImportSource.Builder.class) +public final class ContentImportSource { + private final int id; + + private final int lastSyncedAt; + + private final SyncBehavior syncBehavior; + + private final Status status; + + private final String url; + + private final int createdAt; + + private final int updatedAt; + + private final Map additionalProperties; + + private ContentImportSource( + int id, + int lastSyncedAt, + SyncBehavior syncBehavior, + Status status, + String url, + int createdAt, + int updatedAt, + Map additionalProperties) { + this.id = id; + this.lastSyncedAt = lastSyncedAt; + this.syncBehavior = syncBehavior; + this.status = status; + this.url = url; + this.createdAt = createdAt; + this.updatedAt = updatedAt; + this.additionalProperties = additionalProperties; + } + + /** + * @return Always external_page + */ + @JsonProperty("type") + public String getType() { + return "content_import_source"; + } + + /** + * @return The unique identifier for the content import source which is given by Intercom. + */ + @JsonProperty("id") + public int getId() { + return id; + } + + /** + * @return The time when the content import source was last synced. + */ + @JsonProperty("last_synced_at") + public int getLastSyncedAt() { + return lastSyncedAt; + } + + /** + * @return If you intend to create or update External Pages via the API, this should be set to api. + */ + @JsonProperty("sync_behavior") + public SyncBehavior getSyncBehavior() { + return syncBehavior; + } + + /** + * @return The status of the content import source. + */ + @JsonProperty("status") + public Status getStatus() { + return status; + } + + /** + * @return The URL of the root of the external source. + */ + @JsonProperty("url") + public String getUrl() { + return url; + } + + /** + * @return The time when the content import source was created. + */ + @JsonProperty("created_at") + public int getCreatedAt() { + return createdAt; + } + + /** + * @return The time when the content import source was last updated. + */ + @JsonProperty("updated_at") + public int getUpdatedAt() { + return updatedAt; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof ContentImportSource && equalTo((ContentImportSource) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(ContentImportSource other) { + return id == other.id + && lastSyncedAt == other.lastSyncedAt + && syncBehavior.equals(other.syncBehavior) + && status.equals(other.status) + && url.equals(other.url) + && createdAt == other.createdAt + && updatedAt == other.updatedAt; + } + + @java.lang.Override + public int hashCode() { + return Objects.hash( + this.id, this.lastSyncedAt, this.syncBehavior, this.status, this.url, this.createdAt, this.updatedAt); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static IdStage builder() { + return new Builder(); + } + + public interface IdStage { + /** + *

The unique identifier for the content import source which is given by Intercom.

+ */ + LastSyncedAtStage id(int id); + + Builder from(ContentImportSource other); + } + + public interface LastSyncedAtStage { + /** + *

The time when the content import source was last synced.

+ */ + SyncBehaviorStage lastSyncedAt(int lastSyncedAt); + } + + public interface SyncBehaviorStage { + /** + *

If you intend to create or update External Pages via the API, this should be set to api.

+ */ + StatusStage syncBehavior(@NotNull SyncBehavior syncBehavior); + } + + public interface StatusStage { + /** + *

The status of the content import source.

+ */ + UrlStage status(@NotNull Status status); + } + + public interface UrlStage { + /** + *

The URL of the root of the external source.

+ */ + CreatedAtStage url(@NotNull String url); + } + + public interface CreatedAtStage { + /** + *

The time when the content import source was created.

+ */ + UpdatedAtStage createdAt(int createdAt); + } + + public interface UpdatedAtStage { + /** + *

The time when the content import source was last updated.

+ */ + _FinalStage updatedAt(int updatedAt); + } + + public interface _FinalStage { + ContentImportSource build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder + implements IdStage, + LastSyncedAtStage, + SyncBehaviorStage, + StatusStage, + UrlStage, + CreatedAtStage, + UpdatedAtStage, + _FinalStage { + private int id; + + private int lastSyncedAt; + + private SyncBehavior syncBehavior; + + private Status status; + + private String url; + + private int createdAt; + + private int updatedAt; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(ContentImportSource other) { + id(other.getId()); + lastSyncedAt(other.getLastSyncedAt()); + syncBehavior(other.getSyncBehavior()); + status(other.getStatus()); + url(other.getUrl()); + createdAt(other.getCreatedAt()); + updatedAt(other.getUpdatedAt()); + return this; + } + + /** + *

The unique identifier for the content import source which is given by Intercom.

+ *

The unique identifier for the content import source which is given by Intercom.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("id") + public LastSyncedAtStage id(int id) { + this.id = id; + return this; + } + + /** + *

The time when the content import source was last synced.

+ *

The time when the content import source was last synced.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("last_synced_at") + public SyncBehaviorStage lastSyncedAt(int lastSyncedAt) { + this.lastSyncedAt = lastSyncedAt; + return this; + } + + /** + *

If you intend to create or update External Pages via the API, this should be set to api.

+ *

If you intend to create or update External Pages via the API, this should be set to api.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("sync_behavior") + public StatusStage syncBehavior(@NotNull SyncBehavior syncBehavior) { + this.syncBehavior = Objects.requireNonNull(syncBehavior, "syncBehavior must not be null"); + return this; + } + + /** + *

The status of the content import source.

+ *

The status of the content import source.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("status") + public UrlStage status(@NotNull Status status) { + this.status = Objects.requireNonNull(status, "status must not be null"); + return this; + } + + /** + *

The URL of the root of the external source.

+ *

The URL of the root of the external source.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("url") + public CreatedAtStage url(@NotNull String url) { + this.url = Objects.requireNonNull(url, "url must not be null"); + return this; + } + + /** + *

The time when the content import source was created.

+ *

The time when the content import source was created.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("created_at") + public UpdatedAtStage createdAt(int createdAt) { + this.createdAt = createdAt; + return this; + } + + /** + *

The time when the content import source was last updated.

+ *

The time when the content import source was last updated.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("updated_at") + public _FinalStage updatedAt(int updatedAt) { + this.updatedAt = updatedAt; + return this; + } + + @java.lang.Override + public ContentImportSource build() { + return new ContentImportSource( + id, lastSyncedAt, syncBehavior, status, url, createdAt, updatedAt, additionalProperties); + } + } + + public static final class Status { + public static final Status DEACTIVATED = new Status(Value.DEACTIVATED, "deactivated"); + + public static final Status ACTIVE = new Status(Value.ACTIVE, "active"); + + private final Value value; + + private final String string; + + Status(Value value, String string) { + this.value = value; + this.string = string; + } + + public Value getEnumValue() { + return value; + } + + @java.lang.Override + @JsonValue + public String toString() { + return this.string; + } + + @java.lang.Override + public boolean equals(Object other) { + return (this == other) || (other instanceof Status && this.string.equals(((Status) other).string)); + } + + @java.lang.Override + public int hashCode() { + return this.string.hashCode(); + } + + public T visit(Visitor visitor) { + switch (value) { + case DEACTIVATED: + return visitor.visitDeactivated(); + case ACTIVE: + return visitor.visitActive(); + case UNKNOWN: + default: + return visitor.visitUnknown(string); + } + } + + @JsonCreator(mode = JsonCreator.Mode.DELEGATING) + public static Status valueOf(String value) { + switch (value) { + case "deactivated": + return DEACTIVATED; + case "active": + return ACTIVE; + default: + return new Status(Value.UNKNOWN, value); + } + } + + public enum Value { + ACTIVE, + + DEACTIVATED, + + UNKNOWN + } + + public interface Visitor { + T visitActive(); + + T visitDeactivated(); + + T visitUnknown(String unknownType); + } + } + + public static final class SyncBehavior { + public static final SyncBehavior MANUAL = new SyncBehavior(Value.MANUAL, "manual"); + + public static final SyncBehavior API = new SyncBehavior(Value.API, "api"); + + public static final SyncBehavior AUTOMATIC = new SyncBehavior(Value.AUTOMATIC, "automatic"); + + private final Value value; + + private final String string; + + SyncBehavior(Value value, String string) { + this.value = value; + this.string = string; + } + + public Value getEnumValue() { + return value; + } + + @java.lang.Override + @JsonValue + public String toString() { + return this.string; + } + + @java.lang.Override + public boolean equals(Object other) { + return (this == other) + || (other instanceof SyncBehavior && this.string.equals(((SyncBehavior) other).string)); + } + + @java.lang.Override + public int hashCode() { + return this.string.hashCode(); + } + + public T visit(Visitor visitor) { + switch (value) { + case MANUAL: + return visitor.visitManual(); + case API: + return visitor.visitApi(); + case AUTOMATIC: + return visitor.visitAutomatic(); + case UNKNOWN: + default: + return visitor.visitUnknown(string); + } + } + + @JsonCreator(mode = JsonCreator.Mode.DELEGATING) + public static SyncBehavior valueOf(String value) { + switch (value) { + case "manual": + return MANUAL; + case "api": + return API; + case "automatic": + return AUTOMATIC; + default: + return new SyncBehavior(Value.UNKNOWN, value); + } + } + + public enum Value { + API, + + AUTOMATIC, + + MANUAL, + + UNKNOWN + } + + public interface Visitor { + T visitApi(); + + T visitAutomatic(); + + T visitManual(); + + T visitUnknown(String unknownType); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/aicontent/types/ContentImportSourcesList.java b/src/main/java/com/intercom/api/resources/aicontent/types/ContentImportSourcesList.java new file mode 100644 index 00000000..2828601b --- /dev/null +++ b/src/main/java/com/intercom/api/resources/aicontent/types/ContentImportSourcesList.java @@ -0,0 +1,189 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.aicontent.types; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.types.PagesLink; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = ContentImportSourcesList.Builder.class) +public final class ContentImportSourcesList { + private final Optional type; + + private final Optional pages; + + private final Optional totalCount; + + private final Optional> data; + + private final Map additionalProperties; + + private ContentImportSourcesList( + Optional type, + Optional pages, + Optional totalCount, + Optional> data, + Map additionalProperties) { + this.type = type; + this.pages = pages; + this.totalCount = totalCount; + this.data = data; + this.additionalProperties = additionalProperties; + } + + /** + * @return The type of the object - list. + */ + @JsonProperty("type") + public Optional getType() { + return type; + } + + @JsonProperty("pages") + public Optional getPages() { + return pages; + } + + /** + * @return A count of the total number of content import sources. + */ + @JsonProperty("total_count") + public Optional getTotalCount() { + return totalCount; + } + + /** + * @return An array of Content Import Source objects + */ + @JsonProperty("data") + public Optional> getData() { + return data; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof ContentImportSourcesList && equalTo((ContentImportSourcesList) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(ContentImportSourcesList other) { + return type.equals(other.type) + && pages.equals(other.pages) + && totalCount.equals(other.totalCount) + && data.equals(other.data); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.type, this.pages, this.totalCount, this.data); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static Builder builder() { + return new Builder(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder { + private Optional type = Optional.empty(); + + private Optional pages = Optional.empty(); + + private Optional totalCount = Optional.empty(); + + private Optional> data = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + public Builder from(ContentImportSourcesList other) { + type(other.getType()); + pages(other.getPages()); + totalCount(other.getTotalCount()); + data(other.getData()); + return this; + } + + /** + *

The type of the object - list.

+ */ + @JsonSetter(value = "type", nulls = Nulls.SKIP) + public Builder type(Optional type) { + this.type = type; + return this; + } + + public Builder type(String type) { + this.type = Optional.ofNullable(type); + return this; + } + + @JsonSetter(value = "pages", nulls = Nulls.SKIP) + public Builder pages(Optional pages) { + this.pages = pages; + return this; + } + + public Builder pages(PagesLink pages) { + this.pages = Optional.ofNullable(pages); + return this; + } + + /** + *

A count of the total number of content import sources.

+ */ + @JsonSetter(value = "total_count", nulls = Nulls.SKIP) + public Builder totalCount(Optional totalCount) { + this.totalCount = totalCount; + return this; + } + + public Builder totalCount(Integer totalCount) { + this.totalCount = Optional.ofNullable(totalCount); + return this; + } + + /** + *

An array of Content Import Source objects

+ */ + @JsonSetter(value = "data", nulls = Nulls.SKIP) + public Builder data(Optional> data) { + this.data = data; + return this; + } + + public Builder data(List data) { + this.data = Optional.ofNullable(data); + return this; + } + + public ContentImportSourcesList build() { + return new ContentImportSourcesList(type, pages, totalCount, data, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/aicontent/types/ExternalPage.java b/src/main/java/com/intercom/api/resources/aicontent/types/ExternalPage.java new file mode 100644 index 00000000..ed1ae2b9 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/aicontent/types/ExternalPage.java @@ -0,0 +1,570 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.aicontent.types; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = ExternalPage.Builder.class) +public final class ExternalPage { + private final String id; + + private final String title; + + private final String html; + + private final Optional url; + + private final boolean aiAgentAvailability; + + private final boolean aiCopilotAvailability; + + private final Optional finAvailability; + + private final int sourceId; + + private final String externalId; + + private final int createdAt; + + private final int updatedAt; + + private final int lastIngestedAt; + + private final Map additionalProperties; + + private ExternalPage( + String id, + String title, + String html, + Optional url, + boolean aiAgentAvailability, + boolean aiCopilotAvailability, + Optional finAvailability, + int sourceId, + String externalId, + int createdAt, + int updatedAt, + int lastIngestedAt, + Map additionalProperties) { + this.id = id; + this.title = title; + this.html = html; + this.url = url; + this.aiAgentAvailability = aiAgentAvailability; + this.aiCopilotAvailability = aiCopilotAvailability; + this.finAvailability = finAvailability; + this.sourceId = sourceId; + this.externalId = externalId; + this.createdAt = createdAt; + this.updatedAt = updatedAt; + this.lastIngestedAt = lastIngestedAt; + this.additionalProperties = additionalProperties; + } + + /** + * @return Always external_page + */ + @JsonProperty("type") + public String getType() { + return "external_page"; + } + + /** + * @return The unique identifier for the external page which is given by Intercom. + */ + @JsonProperty("id") + public String getId() { + return id; + } + + /** + * @return The title of the external page. + */ + @JsonProperty("title") + public String getTitle() { + return title; + } + + /** + * @return The body of the external page in HTML. + */ + @JsonProperty("html") + public String getHtml() { + return html; + } + + /** + * @return The URL of the external page. This will be used by Fin to link end users to the page it based its answer on. + */ + @JsonProperty("url") + public Optional getUrl() { + return url; + } + + /** + * @return Whether the external page should be used to answer questions by AI Agent. + */ + @JsonProperty("ai_agent_availability") + public boolean getAiAgentAvailability() { + return aiAgentAvailability; + } + + /** + * @return Whether the external page should be used to answer questions by AI Copilot. + */ + @JsonProperty("ai_copilot_availability") + public boolean getAiCopilotAvailability() { + return aiCopilotAvailability; + } + + /** + * @return Deprecated. Use ai_agent_availability and ai_copilot_availability instead. + */ + @JsonProperty("fin_availability") + public Optional getFinAvailability() { + return finAvailability; + } + + /** + * @return Always en + */ + @JsonProperty("locale") + public String getLocale() { + return "en"; + } + + /** + * @return The unique identifier for the source of the external page which was given by Intercom. Every external page must be associated with a Content Import Source which represents the place it comes from and from which it inherits a default audience (configured in the UI). For a new source, make a POST request to the Content Import Source endpoint and an ID for the source will be returned in the response. + */ + @JsonProperty("source_id") + public int getSourceId() { + return sourceId; + } + + /** + * @return The identifier for the external page which was given by the source. Must be unique for the source. + */ + @JsonProperty("external_id") + public String getExternalId() { + return externalId; + } + + /** + * @return The time when the external page was created. + */ + @JsonProperty("created_at") + public int getCreatedAt() { + return createdAt; + } + + /** + * @return The time when the external page was last updated. + */ + @JsonProperty("updated_at") + public int getUpdatedAt() { + return updatedAt; + } + + /** + * @return The time when the external page was last ingested. + */ + @JsonProperty("last_ingested_at") + public int getLastIngestedAt() { + return lastIngestedAt; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof ExternalPage && equalTo((ExternalPage) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(ExternalPage other) { + return id.equals(other.id) + && title.equals(other.title) + && html.equals(other.html) + && url.equals(other.url) + && aiAgentAvailability == other.aiAgentAvailability + && aiCopilotAvailability == other.aiCopilotAvailability + && finAvailability.equals(other.finAvailability) + && sourceId == other.sourceId + && externalId.equals(other.externalId) + && createdAt == other.createdAt + && updatedAt == other.updatedAt + && lastIngestedAt == other.lastIngestedAt; + } + + @java.lang.Override + public int hashCode() { + return Objects.hash( + this.id, + this.title, + this.html, + this.url, + this.aiAgentAvailability, + this.aiCopilotAvailability, + this.finAvailability, + this.sourceId, + this.externalId, + this.createdAt, + this.updatedAt, + this.lastIngestedAt); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static IdStage builder() { + return new Builder(); + } + + public interface IdStage { + /** + *

The unique identifier for the external page which is given by Intercom.

+ */ + TitleStage id(@NotNull String id); + + Builder from(ExternalPage other); + } + + public interface TitleStage { + /** + *

The title of the external page.

+ */ + HtmlStage title(@NotNull String title); + } + + public interface HtmlStage { + /** + *

The body of the external page in HTML.

+ */ + AiAgentAvailabilityStage html(@NotNull String html); + } + + public interface AiAgentAvailabilityStage { + /** + *

Whether the external page should be used to answer questions by AI Agent.

+ */ + AiCopilotAvailabilityStage aiAgentAvailability(boolean aiAgentAvailability); + } + + public interface AiCopilotAvailabilityStage { + /** + *

Whether the external page should be used to answer questions by AI Copilot.

+ */ + SourceIdStage aiCopilotAvailability(boolean aiCopilotAvailability); + } + + public interface SourceIdStage { + /** + *

The unique identifier for the source of the external page which was given by Intercom. Every external page must be associated with a Content Import Source which represents the place it comes from and from which it inherits a default audience (configured in the UI). For a new source, make a POST request to the Content Import Source endpoint and an ID for the source will be returned in the response.

+ */ + ExternalIdStage sourceId(int sourceId); + } + + public interface ExternalIdStage { + /** + *

The identifier for the external page which was given by the source. Must be unique for the source.

+ */ + CreatedAtStage externalId(@NotNull String externalId); + } + + public interface CreatedAtStage { + /** + *

The time when the external page was created.

+ */ + UpdatedAtStage createdAt(int createdAt); + } + + public interface UpdatedAtStage { + /** + *

The time when the external page was last updated.

+ */ + LastIngestedAtStage updatedAt(int updatedAt); + } + + public interface LastIngestedAtStage { + /** + *

The time when the external page was last ingested.

+ */ + _FinalStage lastIngestedAt(int lastIngestedAt); + } + + public interface _FinalStage { + ExternalPage build(); + + /** + *

The URL of the external page. This will be used by Fin to link end users to the page it based its answer on.

+ */ + _FinalStage url(Optional url); + + _FinalStage url(String url); + + /** + *

Deprecated. Use ai_agent_availability and ai_copilot_availability instead.

+ */ + _FinalStage finAvailability(Optional finAvailability); + + _FinalStage finAvailability(Boolean finAvailability); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder + implements IdStage, + TitleStage, + HtmlStage, + AiAgentAvailabilityStage, + AiCopilotAvailabilityStage, + SourceIdStage, + ExternalIdStage, + CreatedAtStage, + UpdatedAtStage, + LastIngestedAtStage, + _FinalStage { + private String id; + + private String title; + + private String html; + + private boolean aiAgentAvailability; + + private boolean aiCopilotAvailability; + + private int sourceId; + + private String externalId; + + private int createdAt; + + private int updatedAt; + + private int lastIngestedAt; + + private Optional finAvailability = Optional.empty(); + + private Optional url = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(ExternalPage other) { + id(other.getId()); + title(other.getTitle()); + html(other.getHtml()); + url(other.getUrl()); + aiAgentAvailability(other.getAiAgentAvailability()); + aiCopilotAvailability(other.getAiCopilotAvailability()); + finAvailability(other.getFinAvailability()); + sourceId(other.getSourceId()); + externalId(other.getExternalId()); + createdAt(other.getCreatedAt()); + updatedAt(other.getUpdatedAt()); + lastIngestedAt(other.getLastIngestedAt()); + return this; + } + + /** + *

The unique identifier for the external page which is given by Intercom.

+ *

The unique identifier for the external page which is given by Intercom.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("id") + public TitleStage id(@NotNull String id) { + this.id = Objects.requireNonNull(id, "id must not be null"); + return this; + } + + /** + *

The title of the external page.

+ *

The title of the external page.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("title") + public HtmlStage title(@NotNull String title) { + this.title = Objects.requireNonNull(title, "title must not be null"); + return this; + } + + /** + *

The body of the external page in HTML.

+ *

The body of the external page in HTML.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("html") + public AiAgentAvailabilityStage html(@NotNull String html) { + this.html = Objects.requireNonNull(html, "html must not be null"); + return this; + } + + /** + *

Whether the external page should be used to answer questions by AI Agent.

+ *

Whether the external page should be used to answer questions by AI Agent.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("ai_agent_availability") + public AiCopilotAvailabilityStage aiAgentAvailability(boolean aiAgentAvailability) { + this.aiAgentAvailability = aiAgentAvailability; + return this; + } + + /** + *

Whether the external page should be used to answer questions by AI Copilot.

+ *

Whether the external page should be used to answer questions by AI Copilot.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("ai_copilot_availability") + public SourceIdStage aiCopilotAvailability(boolean aiCopilotAvailability) { + this.aiCopilotAvailability = aiCopilotAvailability; + return this; + } + + /** + *

The unique identifier for the source of the external page which was given by Intercom. Every external page must be associated with a Content Import Source which represents the place it comes from and from which it inherits a default audience (configured in the UI). For a new source, make a POST request to the Content Import Source endpoint and an ID for the source will be returned in the response.

+ *

The unique identifier for the source of the external page which was given by Intercom. Every external page must be associated with a Content Import Source which represents the place it comes from and from which it inherits a default audience (configured in the UI). For a new source, make a POST request to the Content Import Source endpoint and an ID for the source will be returned in the response.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("source_id") + public ExternalIdStage sourceId(int sourceId) { + this.sourceId = sourceId; + return this; + } + + /** + *

The identifier for the external page which was given by the source. Must be unique for the source.

+ *

The identifier for the external page which was given by the source. Must be unique for the source.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("external_id") + public CreatedAtStage externalId(@NotNull String externalId) { + this.externalId = Objects.requireNonNull(externalId, "externalId must not be null"); + return this; + } + + /** + *

The time when the external page was created.

+ *

The time when the external page was created.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("created_at") + public UpdatedAtStage createdAt(int createdAt) { + this.createdAt = createdAt; + return this; + } + + /** + *

The time when the external page was last updated.

+ *

The time when the external page was last updated.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("updated_at") + public LastIngestedAtStage updatedAt(int updatedAt) { + this.updatedAt = updatedAt; + return this; + } + + /** + *

The time when the external page was last ingested.

+ *

The time when the external page was last ingested.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("last_ingested_at") + public _FinalStage lastIngestedAt(int lastIngestedAt) { + this.lastIngestedAt = lastIngestedAt; + return this; + } + + /** + *

Deprecated. Use ai_agent_availability and ai_copilot_availability instead.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage finAvailability(Boolean finAvailability) { + this.finAvailability = Optional.ofNullable(finAvailability); + return this; + } + + /** + *

Deprecated. Use ai_agent_availability and ai_copilot_availability instead.

+ */ + @java.lang.Override + @JsonSetter(value = "fin_availability", nulls = Nulls.SKIP) + public _FinalStage finAvailability(Optional finAvailability) { + this.finAvailability = finAvailability; + return this; + } + + /** + *

The URL of the external page. This will be used by Fin to link end users to the page it based its answer on.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage url(String url) { + this.url = Optional.ofNullable(url); + return this; + } + + /** + *

The URL of the external page. This will be used by Fin to link end users to the page it based its answer on.

+ */ + @java.lang.Override + @JsonSetter(value = "url", nulls = Nulls.SKIP) + public _FinalStage url(Optional url) { + this.url = url; + return this; + } + + @java.lang.Override + public ExternalPage build() { + return new ExternalPage( + id, + title, + html, + url, + aiAgentAvailability, + aiCopilotAvailability, + finAvailability, + sourceId, + externalId, + createdAt, + updatedAt, + lastIngestedAt, + additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/aicontent/types/ExternalPagesList.java b/src/main/java/com/intercom/api/resources/aicontent/types/ExternalPagesList.java new file mode 100644 index 00000000..fbeef336 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/aicontent/types/ExternalPagesList.java @@ -0,0 +1,189 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.aicontent.types; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.types.PagesLink; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = ExternalPagesList.Builder.class) +public final class ExternalPagesList { + private final Optional type; + + private final Optional pages; + + private final Optional totalCount; + + private final Optional> data; + + private final Map additionalProperties; + + private ExternalPagesList( + Optional type, + Optional pages, + Optional totalCount, + Optional> data, + Map additionalProperties) { + this.type = type; + this.pages = pages; + this.totalCount = totalCount; + this.data = data; + this.additionalProperties = additionalProperties; + } + + /** + * @return The type of the object - list. + */ + @JsonProperty("type") + public Optional getType() { + return type; + } + + @JsonProperty("pages") + public Optional getPages() { + return pages; + } + + /** + * @return A count of the total number of external pages. + */ + @JsonProperty("total_count") + public Optional getTotalCount() { + return totalCount; + } + + /** + * @return An array of External Page objects + */ + @JsonProperty("data") + public Optional> getData() { + return data; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof ExternalPagesList && equalTo((ExternalPagesList) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(ExternalPagesList other) { + return type.equals(other.type) + && pages.equals(other.pages) + && totalCount.equals(other.totalCount) + && data.equals(other.data); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.type, this.pages, this.totalCount, this.data); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static Builder builder() { + return new Builder(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder { + private Optional type = Optional.empty(); + + private Optional pages = Optional.empty(); + + private Optional totalCount = Optional.empty(); + + private Optional> data = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + public Builder from(ExternalPagesList other) { + type(other.getType()); + pages(other.getPages()); + totalCount(other.getTotalCount()); + data(other.getData()); + return this; + } + + /** + *

The type of the object - list.

+ */ + @JsonSetter(value = "type", nulls = Nulls.SKIP) + public Builder type(Optional type) { + this.type = type; + return this; + } + + public Builder type(String type) { + this.type = Optional.ofNullable(type); + return this; + } + + @JsonSetter(value = "pages", nulls = Nulls.SKIP) + public Builder pages(Optional pages) { + this.pages = pages; + return this; + } + + public Builder pages(PagesLink pages) { + this.pages = Optional.ofNullable(pages); + return this; + } + + /** + *

A count of the total number of external pages.

+ */ + @JsonSetter(value = "total_count", nulls = Nulls.SKIP) + public Builder totalCount(Optional totalCount) { + this.totalCount = totalCount; + return this; + } + + public Builder totalCount(Integer totalCount) { + this.totalCount = Optional.ofNullable(totalCount); + return this; + } + + /** + *

An array of External Page objects

+ */ + @JsonSetter(value = "data", nulls = Nulls.SKIP) + public Builder data(Optional> data) { + this.data = data; + return this; + } + + public Builder data(List data) { + this.data = Optional.ofNullable(data); + return this; + } + + public ExternalPagesList build() { + return new ExternalPagesList(type, pages, totalCount, data, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/aicontentsource/types/ContentSource.java b/src/main/java/com/intercom/api/resources/aicontentsource/types/ContentSource.java new file mode 100644 index 00000000..db9483c8 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/aicontentsource/types/ContentSource.java @@ -0,0 +1,193 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.aicontentsource.types; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = ContentSource.Builder.class) +public final class ContentSource { + private final Optional contentType; + + private final Optional url; + + private final Optional title; + + private final Optional locale; + + private final Map additionalProperties; + + private ContentSource( + Optional contentType, + Optional url, + Optional title, + Optional locale, + Map additionalProperties) { + this.contentType = contentType; + this.url = url; + this.title = title; + this.locale = locale; + this.additionalProperties = additionalProperties; + } + + /** + * @return The type of the content source. + */ + @JsonProperty("content_type") + public Optional getContentType() { + return contentType; + } + + /** + * @return The internal URL linking to the content source for teammates. + */ + @JsonProperty("url") + public Optional getUrl() { + return url; + } + + /** + * @return The title of the content source. + */ + @JsonProperty("title") + public Optional getTitle() { + return title; + } + + /** + * @return The ISO 639 language code of the content source. + */ + @JsonProperty("locale") + public Optional getLocale() { + return locale; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof ContentSource && equalTo((ContentSource) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(ContentSource other) { + return contentType.equals(other.contentType) + && url.equals(other.url) + && title.equals(other.title) + && locale.equals(other.locale); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.contentType, this.url, this.title, this.locale); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static Builder builder() { + return new Builder(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder { + private Optional contentType = Optional.empty(); + + private Optional url = Optional.empty(); + + private Optional title = Optional.empty(); + + private Optional locale = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + public Builder from(ContentSource other) { + contentType(other.getContentType()); + url(other.getUrl()); + title(other.getTitle()); + locale(other.getLocale()); + return this; + } + + /** + *

The type of the content source.

+ */ + @JsonSetter(value = "content_type", nulls = Nulls.SKIP) + public Builder contentType(Optional contentType) { + this.contentType = contentType; + return this; + } + + public Builder contentType(String contentType) { + this.contentType = Optional.ofNullable(contentType); + return this; + } + + /** + *

The internal URL linking to the content source for teammates.

+ */ + @JsonSetter(value = "url", nulls = Nulls.SKIP) + public Builder url(Optional url) { + this.url = url; + return this; + } + + public Builder url(String url) { + this.url = Optional.ofNullable(url); + return this; + } + + /** + *

The title of the content source.

+ */ + @JsonSetter(value = "title", nulls = Nulls.SKIP) + public Builder title(Optional title) { + this.title = title; + return this; + } + + public Builder title(String title) { + this.title = Optional.ofNullable(title); + return this; + } + + /** + *

The ISO 639 language code of the content source.

+ */ + @JsonSetter(value = "locale", nulls = Nulls.SKIP) + public Builder locale(Optional locale) { + this.locale = locale; + return this; + } + + public Builder locale(String locale) { + this.locale = Optional.ofNullable(locale); + return this; + } + + public ContentSource build() { + return new ContentSource(contentType, url, title, locale, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/articles/ArticlesClient.java b/src/main/java/com/intercom/api/resources/articles/ArticlesClient.java new file mode 100644 index 00000000..0feb90fd --- /dev/null +++ b/src/main/java/com/intercom/api/resources/articles/ArticlesClient.java @@ -0,0 +1,154 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.articles; + +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.core.pagination.SyncPagingIterable; +import com.intercom.api.resources.articles.requests.DeleteArticleRequest; +import com.intercom.api.resources.articles.requests.FindArticleRequest; +import com.intercom.api.resources.articles.requests.ListArticlesRequest; +import com.intercom.api.resources.articles.requests.SearchArticlesRequest; +import com.intercom.api.resources.articles.requests.UpdateArticleRequest; +import com.intercom.api.resources.articles.types.Article; +import com.intercom.api.resources.articles.types.ArticleListItem; +import com.intercom.api.resources.articles.types.ArticleSearchResponse; +import com.intercom.api.types.CreateArticleRequest; +import com.intercom.api.types.DeletedArticleObject; +import java.util.Optional; + +public class ArticlesClient { + protected final ClientOptions clientOptions; + + private final RawArticlesClient rawClient; + + public ArticlesClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + this.rawClient = new RawArticlesClient(clientOptions); + } + + /** + * Get responses with HTTP metadata like headers + */ + public RawArticlesClient withRawResponse() { + return this.rawClient; + } + + /** + * You can fetch a list of all articles by making a GET request to https://api.intercom.io/articles. + *
+ *

📘 How are the articles sorted and ordered?

+ *

Articles will be returned in descending order on the updated_at attribute. This means if you need to iterate through results then we'll show the most recently updated articles first.

+ *
+ */ + public SyncPagingIterable list() { + return this.rawClient.list().body(); + } + + /** + * You can fetch a list of all articles by making a GET request to https://api.intercom.io/articles. + *
+ *

📘 How are the articles sorted and ordered?

+ *

Articles will be returned in descending order on the updated_at attribute. This means if you need to iterate through results then we'll show the most recently updated articles first.

+ *
+ */ + public SyncPagingIterable list(ListArticlesRequest request) { + return this.rawClient.list(request).body(); + } + + /** + * You can fetch a list of all articles by making a GET request to https://api.intercom.io/articles. + *
+ *

📘 How are the articles sorted and ordered?

+ *

Articles will be returned in descending order on the updated_at attribute. This means if you need to iterate through results then we'll show the most recently updated articles first.

+ *
+ */ + public SyncPagingIterable list(ListArticlesRequest request, RequestOptions requestOptions) { + return this.rawClient.list(request, requestOptions).body(); + } + + /** + * You can create a new article by making a POST request to https://api.intercom.io/articles. + */ + public Article create() { + return this.rawClient.create().body(); + } + + /** + * You can create a new article by making a POST request to https://api.intercom.io/articles. + */ + public Article create(Optional request) { + return this.rawClient.create(request).body(); + } + + /** + * You can create a new article by making a POST request to https://api.intercom.io/articles. + */ + public Article create(Optional request, RequestOptions requestOptions) { + return this.rawClient.create(request, requestOptions).body(); + } + + /** + * You can fetch the details of a single article by making a GET request to https://api.intercom.io/articles/<id>. + */ + public Article find(FindArticleRequest request) { + return this.rawClient.find(request).body(); + } + + /** + * You can fetch the details of a single article by making a GET request to https://api.intercom.io/articles/<id>. + */ + public Article find(FindArticleRequest request, RequestOptions requestOptions) { + return this.rawClient.find(request, requestOptions).body(); + } + + /** + * You can update the details of a single article by making a PUT request to https://api.intercom.io/articles/<id>. + */ + public Article update(UpdateArticleRequest request) { + return this.rawClient.update(request).body(); + } + + /** + * You can update the details of a single article by making a PUT request to https://api.intercom.io/articles/<id>. + */ + public Article update(UpdateArticleRequest request, RequestOptions requestOptions) { + return this.rawClient.update(request, requestOptions).body(); + } + + /** + * You can delete a single article by making a DELETE request to https://api.intercom.io/articles/<id>. + */ + public DeletedArticleObject delete(DeleteArticleRequest request) { + return this.rawClient.delete(request).body(); + } + + /** + * You can delete a single article by making a DELETE request to https://api.intercom.io/articles/<id>. + */ + public DeletedArticleObject delete(DeleteArticleRequest request, RequestOptions requestOptions) { + return this.rawClient.delete(request, requestOptions).body(); + } + + /** + * You can search for articles by making a GET request to https://api.intercom.io/articles/search. + */ + public ArticleSearchResponse search() { + return this.rawClient.search().body(); + } + + /** + * You can search for articles by making a GET request to https://api.intercom.io/articles/search. + */ + public ArticleSearchResponse search(SearchArticlesRequest request) { + return this.rawClient.search(request).body(); + } + + /** + * You can search for articles by making a GET request to https://api.intercom.io/articles/search. + */ + public ArticleSearchResponse search(SearchArticlesRequest request, RequestOptions requestOptions) { + return this.rawClient.search(request, requestOptions).body(); + } +} diff --git a/src/main/java/com/intercom/api/resources/articles/AsyncArticlesClient.java b/src/main/java/com/intercom/api/resources/articles/AsyncArticlesClient.java new file mode 100644 index 00000000..ddafa895 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/articles/AsyncArticlesClient.java @@ -0,0 +1,157 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.articles; + +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.core.pagination.SyncPagingIterable; +import com.intercom.api.resources.articles.requests.DeleteArticleRequest; +import com.intercom.api.resources.articles.requests.FindArticleRequest; +import com.intercom.api.resources.articles.requests.ListArticlesRequest; +import com.intercom.api.resources.articles.requests.SearchArticlesRequest; +import com.intercom.api.resources.articles.requests.UpdateArticleRequest; +import com.intercom.api.resources.articles.types.Article; +import com.intercom.api.resources.articles.types.ArticleListItem; +import com.intercom.api.resources.articles.types.ArticleSearchResponse; +import com.intercom.api.types.CreateArticleRequest; +import com.intercom.api.types.DeletedArticleObject; +import java.util.Optional; +import java.util.concurrent.CompletableFuture; + +public class AsyncArticlesClient { + protected final ClientOptions clientOptions; + + private final AsyncRawArticlesClient rawClient; + + public AsyncArticlesClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + this.rawClient = new AsyncRawArticlesClient(clientOptions); + } + + /** + * Get responses with HTTP metadata like headers + */ + public AsyncRawArticlesClient withRawResponse() { + return this.rawClient; + } + + /** + * You can fetch a list of all articles by making a GET request to https://api.intercom.io/articles. + *
+ *

📘 How are the articles sorted and ordered?

+ *

Articles will be returned in descending order on the updated_at attribute. This means if you need to iterate through results then we'll show the most recently updated articles first.

+ *
+ */ + public CompletableFuture> list() { + return this.rawClient.list().thenApply(response -> response.body()); + } + + /** + * You can fetch a list of all articles by making a GET request to https://api.intercom.io/articles. + *
+ *

📘 How are the articles sorted and ordered?

+ *

Articles will be returned in descending order on the updated_at attribute. This means if you need to iterate through results then we'll show the most recently updated articles first.

+ *
+ */ + public CompletableFuture> list(ListArticlesRequest request) { + return this.rawClient.list(request).thenApply(response -> response.body()); + } + + /** + * You can fetch a list of all articles by making a GET request to https://api.intercom.io/articles. + *
+ *

📘 How are the articles sorted and ordered?

+ *

Articles will be returned in descending order on the updated_at attribute. This means if you need to iterate through results then we'll show the most recently updated articles first.

+ *
+ */ + public CompletableFuture> list( + ListArticlesRequest request, RequestOptions requestOptions) { + return this.rawClient.list(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can create a new article by making a POST request to https://api.intercom.io/articles. + */ + public CompletableFuture
create() { + return this.rawClient.create().thenApply(response -> response.body()); + } + + /** + * You can create a new article by making a POST request to https://api.intercom.io/articles. + */ + public CompletableFuture
create(Optional request) { + return this.rawClient.create(request).thenApply(response -> response.body()); + } + + /** + * You can create a new article by making a POST request to https://api.intercom.io/articles. + */ + public CompletableFuture
create(Optional request, RequestOptions requestOptions) { + return this.rawClient.create(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can fetch the details of a single article by making a GET request to https://api.intercom.io/articles/<id>. + */ + public CompletableFuture
find(FindArticleRequest request) { + return this.rawClient.find(request).thenApply(response -> response.body()); + } + + /** + * You can fetch the details of a single article by making a GET request to https://api.intercom.io/articles/<id>. + */ + public CompletableFuture
find(FindArticleRequest request, RequestOptions requestOptions) { + return this.rawClient.find(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can update the details of a single article by making a PUT request to https://api.intercom.io/articles/<id>. + */ + public CompletableFuture
update(UpdateArticleRequest request) { + return this.rawClient.update(request).thenApply(response -> response.body()); + } + + /** + * You can update the details of a single article by making a PUT request to https://api.intercom.io/articles/<id>. + */ + public CompletableFuture
update(UpdateArticleRequest request, RequestOptions requestOptions) { + return this.rawClient.update(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can delete a single article by making a DELETE request to https://api.intercom.io/articles/<id>. + */ + public CompletableFuture delete(DeleteArticleRequest request) { + return this.rawClient.delete(request).thenApply(response -> response.body()); + } + + /** + * You can delete a single article by making a DELETE request to https://api.intercom.io/articles/<id>. + */ + public CompletableFuture delete(DeleteArticleRequest request, RequestOptions requestOptions) { + return this.rawClient.delete(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can search for articles by making a GET request to https://api.intercom.io/articles/search. + */ + public CompletableFuture search() { + return this.rawClient.search().thenApply(response -> response.body()); + } + + /** + * You can search for articles by making a GET request to https://api.intercom.io/articles/search. + */ + public CompletableFuture search(SearchArticlesRequest request) { + return this.rawClient.search(request).thenApply(response -> response.body()); + } + + /** + * You can search for articles by making a GET request to https://api.intercom.io/articles/search. + */ + public CompletableFuture search( + SearchArticlesRequest request, RequestOptions requestOptions) { + return this.rawClient.search(request, requestOptions).thenApply(response -> response.body()); + } +} diff --git a/src/main/java/com/intercom/api/resources/articles/AsyncRawArticlesClient.java b/src/main/java/com/intercom/api/resources/articles/AsyncRawArticlesClient.java new file mode 100644 index 00000000..38e74622 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/articles/AsyncRawArticlesClient.java @@ -0,0 +1,559 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.articles; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.IntercomApiException; +import com.intercom.api.core.IntercomException; +import com.intercom.api.core.IntercomHttpResponse; +import com.intercom.api.core.MediaTypes; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.core.QueryStringMapper; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.core.pagination.SyncPagingIterable; +import com.intercom.api.errors.BadRequestError; +import com.intercom.api.errors.NotFoundError; +import com.intercom.api.errors.UnauthorizedError; +import com.intercom.api.resources.articles.requests.DeleteArticleRequest; +import com.intercom.api.resources.articles.requests.FindArticleRequest; +import com.intercom.api.resources.articles.requests.ListArticlesRequest; +import com.intercom.api.resources.articles.requests.SearchArticlesRequest; +import com.intercom.api.resources.articles.requests.UpdateArticleRequest; +import com.intercom.api.resources.articles.types.Article; +import com.intercom.api.resources.articles.types.ArticleListItem; +import com.intercom.api.resources.articles.types.ArticleSearchResponse; +import com.intercom.api.types.ArticleList; +import com.intercom.api.types.CreateArticleRequest; +import com.intercom.api.types.DeletedArticleObject; +import com.intercom.api.types.Error; +import java.io.IOException; +import java.util.Collections; +import java.util.List; +import java.util.Optional; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.ExecutionException; +import okhttp3.Call; +import okhttp3.Callback; +import okhttp3.Headers; +import okhttp3.HttpUrl; +import okhttp3.OkHttpClient; +import okhttp3.Request; +import okhttp3.RequestBody; +import okhttp3.Response; +import okhttp3.ResponseBody; +import org.jetbrains.annotations.NotNull; + +public class AsyncRawArticlesClient { + protected final ClientOptions clientOptions; + + public AsyncRawArticlesClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + } + + /** + * You can fetch a list of all articles by making a GET request to https://api.intercom.io/articles. + *
+ *

📘 How are the articles sorted and ordered?

+ *

Articles will be returned in descending order on the updated_at attribute. This means if you need to iterate through results then we'll show the most recently updated articles first.

+ *
+ */ + public CompletableFuture>> list() { + return list(ListArticlesRequest.builder().build()); + } + + /** + * You can fetch a list of all articles by making a GET request to https://api.intercom.io/articles. + *
+ *

📘 How are the articles sorted and ordered?

+ *

Articles will be returned in descending order on the updated_at attribute. This means if you need to iterate through results then we'll show the most recently updated articles first.

+ *
+ */ + public CompletableFuture>> list( + ListArticlesRequest request) { + return list(request, null); + } + + /** + * You can fetch a list of all articles by making a GET request to https://api.intercom.io/articles. + *
+ *

📘 How are the articles sorted and ordered?

+ *

Articles will be returned in descending order on the updated_at attribute. This means if you need to iterate through results then we'll show the most recently updated articles first.

+ *
+ */ + public CompletableFuture>> list( + ListArticlesRequest request, RequestOptions requestOptions) { + HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("articles"); + if (request.getPage().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "page", request.getPage().get(), false); + } + if (request.getPerPage().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "per_page", request.getPerPage().get(), false); + } + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl.build()) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture>> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + ArticleList parsedResponse = + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, ArticleList.class); + int newPageNumber = request.getPage() + .map((Integer page) -> page + 1) + .orElse(1); + ListArticlesRequest nextRequest = ListArticlesRequest.builder() + .from(request) + .page(newPageNumber) + .build(); + List result = parsedResponse.getData().orElse(Collections.emptyList()); + future.complete(new IntercomHttpResponse<>( + new SyncPagingIterable(true, result, parsedResponse, () -> { + try { + return list(nextRequest, requestOptions) + .get() + .body(); + } catch (InterruptedException | ExecutionException e) { + throw new RuntimeException(e); + } + }), + response)); + return; + } + try { + if (response.code() == 401) { + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can create a new article by making a POST request to https://api.intercom.io/articles. + */ + public CompletableFuture> create() { + return create(Optional.empty()); + } + + /** + * You can create a new article by making a POST request to https://api.intercom.io/articles. + */ + public CompletableFuture> create(Optional request) { + return create(request, null); + } + + /** + * You can create a new article by making a POST request to https://api.intercom.io/articles. + */ + public CompletableFuture> create( + Optional request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("articles") + .build(); + RequestBody body; + try { + body = RequestBody.create("", null); + if (request.isPresent()) { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Article.class), response)); + return; + } + try { + switch (response.code()) { + case 400: + future.completeExceptionally(new BadRequestError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can fetch the details of a single article by making a GET request to https://api.intercom.io/articles/<id>. + */ + public CompletableFuture> find(FindArticleRequest request) { + return find(request, null); + } + + /** + * You can fetch the details of a single article by making a GET request to https://api.intercom.io/articles/<id>. + */ + public CompletableFuture> find( + FindArticleRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("articles") + .addPathSegment(Integer.toString(request.getArticleId())) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Article.class), response)); + return; + } + try { + switch (response.code()) { + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 404: + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can update the details of a single article by making a PUT request to https://api.intercom.io/articles/<id>. + */ + public CompletableFuture> update(UpdateArticleRequest request) { + return update(request, null); + } + + /** + * You can update the details of a single article by making a PUT request to https://api.intercom.io/articles/<id>. + */ + public CompletableFuture> update( + UpdateArticleRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("articles") + .addPathSegment(Integer.toString(request.getArticleId())) + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("PUT", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Article.class), response)); + return; + } + try { + switch (response.code()) { + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 404: + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can delete a single article by making a DELETE request to https://api.intercom.io/articles/<id>. + */ + public CompletableFuture> delete(DeleteArticleRequest request) { + return delete(request, null); + } + + /** + * You can delete a single article by making a DELETE request to https://api.intercom.io/articles/<id>. + */ + public CompletableFuture> delete( + DeleteArticleRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("articles") + .addPathSegment(Integer.toString(request.getArticleId())) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("DELETE", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, DeletedArticleObject.class), + response)); + return; + } + try { + switch (response.code()) { + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 404: + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can search for articles by making a GET request to https://api.intercom.io/articles/search. + */ + public CompletableFuture> search() { + return search(SearchArticlesRequest.builder().build()); + } + + /** + * You can search for articles by making a GET request to https://api.intercom.io/articles/search. + */ + public CompletableFuture> search(SearchArticlesRequest request) { + return search(request, null); + } + + /** + * You can search for articles by making a GET request to https://api.intercom.io/articles/search. + */ + public CompletableFuture> search( + SearchArticlesRequest request, RequestOptions requestOptions) { + HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("articles/search"); + if (request.getPhrase().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "phrase", request.getPhrase().get(), false); + } + if (request.getState().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "state", request.getState().get(), false); + } + if (request.getHelpCenterId().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "help_center_id", request.getHelpCenterId().get(), false); + } + if (request.getHighlight().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "highlight", request.getHighlight().get(), false); + } + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl.build()) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, ArticleSearchResponse.class), + response)); + return; + } + try { + if (response.code() == 401) { + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } +} diff --git a/src/main/java/com/intercom/api/resources/articles/RawArticlesClient.java b/src/main/java/com/intercom/api/resources/articles/RawArticlesClient.java new file mode 100644 index 00000000..f21c6ac0 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/articles/RawArticlesClient.java @@ -0,0 +1,444 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.articles; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.IntercomApiException; +import com.intercom.api.core.IntercomException; +import com.intercom.api.core.IntercomHttpResponse; +import com.intercom.api.core.MediaTypes; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.core.QueryStringMapper; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.core.pagination.SyncPagingIterable; +import com.intercom.api.errors.BadRequestError; +import com.intercom.api.errors.NotFoundError; +import com.intercom.api.errors.UnauthorizedError; +import com.intercom.api.resources.articles.requests.DeleteArticleRequest; +import com.intercom.api.resources.articles.requests.FindArticleRequest; +import com.intercom.api.resources.articles.requests.ListArticlesRequest; +import com.intercom.api.resources.articles.requests.SearchArticlesRequest; +import com.intercom.api.resources.articles.requests.UpdateArticleRequest; +import com.intercom.api.resources.articles.types.Article; +import com.intercom.api.resources.articles.types.ArticleListItem; +import com.intercom.api.resources.articles.types.ArticleSearchResponse; +import com.intercom.api.types.ArticleList; +import com.intercom.api.types.CreateArticleRequest; +import com.intercom.api.types.DeletedArticleObject; +import com.intercom.api.types.Error; +import java.io.IOException; +import java.util.Collections; +import java.util.List; +import java.util.Optional; +import okhttp3.Headers; +import okhttp3.HttpUrl; +import okhttp3.OkHttpClient; +import okhttp3.Request; +import okhttp3.RequestBody; +import okhttp3.Response; +import okhttp3.ResponseBody; + +public class RawArticlesClient { + protected final ClientOptions clientOptions; + + public RawArticlesClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + } + + /** + * You can fetch a list of all articles by making a GET request to https://api.intercom.io/articles. + *
+ *

📘 How are the articles sorted and ordered?

+ *

Articles will be returned in descending order on the updated_at attribute. This means if you need to iterate through results then we'll show the most recently updated articles first.

+ *
+ */ + public IntercomHttpResponse> list() { + return list(ListArticlesRequest.builder().build()); + } + + /** + * You can fetch a list of all articles by making a GET request to https://api.intercom.io/articles. + *
+ *

📘 How are the articles sorted and ordered?

+ *

Articles will be returned in descending order on the updated_at attribute. This means if you need to iterate through results then we'll show the most recently updated articles first.

+ *
+ */ + public IntercomHttpResponse> list(ListArticlesRequest request) { + return list(request, null); + } + + /** + * You can fetch a list of all articles by making a GET request to https://api.intercom.io/articles. + *
+ *

📘 How are the articles sorted and ordered?

+ *

Articles will be returned in descending order on the updated_at attribute. This means if you need to iterate through results then we'll show the most recently updated articles first.

+ *
+ */ + public IntercomHttpResponse> list( + ListArticlesRequest request, RequestOptions requestOptions) { + HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("articles"); + if (request.getPage().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "page", request.getPage().get(), false); + } + if (request.getPerPage().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "per_page", request.getPerPage().get(), false); + } + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl.build()) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + ArticleList parsedResponse = ObjectMappers.JSON_MAPPER.readValue(responseBodyString, ArticleList.class); + int newPageNumber = + request.getPage().map((Integer page) -> page + 1).orElse(1); + ListArticlesRequest nextRequest = ListArticlesRequest.builder() + .from(request) + .page(newPageNumber) + .build(); + List result = parsedResponse.getData().orElse(Collections.emptyList()); + return new IntercomHttpResponse<>( + new SyncPagingIterable( + true, result, parsedResponse, () -> list(nextRequest, requestOptions) + .body()), + response); + } + try { + if (response.code() == 401) { + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can create a new article by making a POST request to https://api.intercom.io/articles. + */ + public IntercomHttpResponse
create() { + return create(Optional.empty()); + } + + /** + * You can create a new article by making a POST request to https://api.intercom.io/articles. + */ + public IntercomHttpResponse
create(Optional request) { + return create(request, null); + } + + /** + * You can create a new article by making a POST request to https://api.intercom.io/articles. + */ + public IntercomHttpResponse
create(Optional request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("articles") + .build(); + RequestBody body; + try { + body = RequestBody.create("", null); + if (request.isPresent()) { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Article.class), response); + } + try { + switch (response.code()) { + case 400: + throw new BadRequestError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can fetch the details of a single article by making a GET request to https://api.intercom.io/articles/<id>. + */ + public IntercomHttpResponse
find(FindArticleRequest request) { + return find(request, null); + } + + /** + * You can fetch the details of a single article by making a GET request to https://api.intercom.io/articles/<id>. + */ + public IntercomHttpResponse
find(FindArticleRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("articles") + .addPathSegment(Integer.toString(request.getArticleId())) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Article.class), response); + } + try { + switch (response.code()) { + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 404: + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can update the details of a single article by making a PUT request to https://api.intercom.io/articles/<id>. + */ + public IntercomHttpResponse
update(UpdateArticleRequest request) { + return update(request, null); + } + + /** + * You can update the details of a single article by making a PUT request to https://api.intercom.io/articles/<id>. + */ + public IntercomHttpResponse
update(UpdateArticleRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("articles") + .addPathSegment(Integer.toString(request.getArticleId())) + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("PUT", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Article.class), response); + } + try { + switch (response.code()) { + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 404: + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can delete a single article by making a DELETE request to https://api.intercom.io/articles/<id>. + */ + public IntercomHttpResponse delete(DeleteArticleRequest request) { + return delete(request, null); + } + + /** + * You can delete a single article by making a DELETE request to https://api.intercom.io/articles/<id>. + */ + public IntercomHttpResponse delete( + DeleteArticleRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("articles") + .addPathSegment(Integer.toString(request.getArticleId())) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("DELETE", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, DeletedArticleObject.class), response); + } + try { + switch (response.code()) { + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 404: + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can search for articles by making a GET request to https://api.intercom.io/articles/search. + */ + public IntercomHttpResponse search() { + return search(SearchArticlesRequest.builder().build()); + } + + /** + * You can search for articles by making a GET request to https://api.intercom.io/articles/search. + */ + public IntercomHttpResponse search(SearchArticlesRequest request) { + return search(request, null); + } + + /** + * You can search for articles by making a GET request to https://api.intercom.io/articles/search. + */ + public IntercomHttpResponse search( + SearchArticlesRequest request, RequestOptions requestOptions) { + HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("articles/search"); + if (request.getPhrase().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "phrase", request.getPhrase().get(), false); + } + if (request.getState().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "state", request.getState().get(), false); + } + if (request.getHelpCenterId().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "help_center_id", request.getHelpCenterId().get(), false); + } + if (request.getHighlight().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "highlight", request.getHighlight().get(), false); + } + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl.build()) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, ArticleSearchResponse.class), response); + } + try { + if (response.code() == 401) { + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/articles/requests/DeleteArticleRequest.java b/src/main/java/com/intercom/api/resources/articles/requests/DeleteArticleRequest.java new file mode 100644 index 00000000..1f748e3a --- /dev/null +++ b/src/main/java/com/intercom/api/resources/articles/requests/DeleteArticleRequest.java @@ -0,0 +1,112 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.articles.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = DeleteArticleRequest.Builder.class) +public final class DeleteArticleRequest { + private final int articleId; + + private final Map additionalProperties; + + private DeleteArticleRequest(int articleId, Map additionalProperties) { + this.articleId = articleId; + this.additionalProperties = additionalProperties; + } + + /** + * @return The unique identifier for the article which is given by Intercom. + */ + @JsonProperty("article_id") + public int getArticleId() { + return articleId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof DeleteArticleRequest && equalTo((DeleteArticleRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(DeleteArticleRequest other) { + return articleId == other.articleId; + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.articleId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static ArticleIdStage builder() { + return new Builder(); + } + + public interface ArticleIdStage { + /** + *

The unique identifier for the article which is given by Intercom.

+ */ + _FinalStage articleId(int articleId); + + Builder from(DeleteArticleRequest other); + } + + public interface _FinalStage { + DeleteArticleRequest build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements ArticleIdStage, _FinalStage { + private int articleId; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(DeleteArticleRequest other) { + articleId(other.getArticleId()); + return this; + } + + /** + *

The unique identifier for the article which is given by Intercom.

+ *

The unique identifier for the article which is given by Intercom.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("article_id") + public _FinalStage articleId(int articleId) { + this.articleId = articleId; + return this; + } + + @java.lang.Override + public DeleteArticleRequest build() { + return new DeleteArticleRequest(articleId, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/articles/requests/FindArticleRequest.java b/src/main/java/com/intercom/api/resources/articles/requests/FindArticleRequest.java new file mode 100644 index 00000000..dd30adb3 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/articles/requests/FindArticleRequest.java @@ -0,0 +1,112 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.articles.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = FindArticleRequest.Builder.class) +public final class FindArticleRequest { + private final int articleId; + + private final Map additionalProperties; + + private FindArticleRequest(int articleId, Map additionalProperties) { + this.articleId = articleId; + this.additionalProperties = additionalProperties; + } + + /** + * @return The unique identifier for the article which is given by Intercom. + */ + @JsonProperty("article_id") + public int getArticleId() { + return articleId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof FindArticleRequest && equalTo((FindArticleRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(FindArticleRequest other) { + return articleId == other.articleId; + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.articleId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static ArticleIdStage builder() { + return new Builder(); + } + + public interface ArticleIdStage { + /** + *

The unique identifier for the article which is given by Intercom.

+ */ + _FinalStage articleId(int articleId); + + Builder from(FindArticleRequest other); + } + + public interface _FinalStage { + FindArticleRequest build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements ArticleIdStage, _FinalStage { + private int articleId; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(FindArticleRequest other) { + articleId(other.getArticleId()); + return this; + } + + /** + *

The unique identifier for the article which is given by Intercom.

+ *

The unique identifier for the article which is given by Intercom.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("article_id") + public _FinalStage articleId(int articleId) { + this.articleId = articleId; + return this; + } + + @java.lang.Override + public FindArticleRequest build() { + return new FindArticleRequest(articleId, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/articles/requests/ListArticlesRequest.java b/src/main/java/com/intercom/api/resources/articles/requests/ListArticlesRequest.java new file mode 100644 index 00000000..6165a066 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/articles/requests/ListArticlesRequest.java @@ -0,0 +1,130 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.articles.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = ListArticlesRequest.Builder.class) +public final class ListArticlesRequest { + private final Optional page; + + private final Optional perPage; + + private final Map additionalProperties; + + private ListArticlesRequest( + Optional page, Optional perPage, Map additionalProperties) { + this.page = page; + this.perPage = perPage; + this.additionalProperties = additionalProperties; + } + + /** + * @return The page of results to fetch. Defaults to first page + */ + @JsonProperty("page") + public Optional getPage() { + return page; + } + + /** + * @return How many results to display per page. Defaults to 15 + */ + @JsonProperty("per_page") + public Optional getPerPage() { + return perPage; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof ListArticlesRequest && equalTo((ListArticlesRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(ListArticlesRequest other) { + return page.equals(other.page) && perPage.equals(other.perPage); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.page, this.perPage); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static Builder builder() { + return new Builder(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder { + private Optional page = Optional.empty(); + + private Optional perPage = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + public Builder from(ListArticlesRequest other) { + page(other.getPage()); + perPage(other.getPerPage()); + return this; + } + + /** + *

The page of results to fetch. Defaults to first page

+ */ + @JsonSetter(value = "page", nulls = Nulls.SKIP) + public Builder page(Optional page) { + this.page = page; + return this; + } + + public Builder page(Integer page) { + this.page = Optional.ofNullable(page); + return this; + } + + /** + *

How many results to display per page. Defaults to 15

+ */ + @JsonSetter(value = "per_page", nulls = Nulls.SKIP) + public Builder perPage(Optional perPage) { + this.perPage = perPage; + return this; + } + + public Builder perPage(Integer perPage) { + this.perPage = Optional.ofNullable(perPage); + return this; + } + + public ListArticlesRequest build() { + return new ListArticlesRequest(page, perPage, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/articles/requests/SearchArticlesRequest.java b/src/main/java/com/intercom/api/resources/articles/requests/SearchArticlesRequest.java new file mode 100644 index 00000000..f0209f03 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/articles/requests/SearchArticlesRequest.java @@ -0,0 +1,193 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.articles.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = SearchArticlesRequest.Builder.class) +public final class SearchArticlesRequest { + private final Optional phrase; + + private final Optional state; + + private final Optional helpCenterId; + + private final Optional highlight; + + private final Map additionalProperties; + + private SearchArticlesRequest( + Optional phrase, + Optional state, + Optional helpCenterId, + Optional highlight, + Map additionalProperties) { + this.phrase = phrase; + this.state = state; + this.helpCenterId = helpCenterId; + this.highlight = highlight; + this.additionalProperties = additionalProperties; + } + + /** + * @return The phrase within your articles to search for. + */ + @JsonProperty("phrase") + public Optional getPhrase() { + return phrase; + } + + /** + * @return The state of the Articles returned. One of published, draft or all. + */ + @JsonProperty("state") + public Optional getState() { + return state; + } + + /** + * @return The ID of the Help Center to search in. + */ + @JsonProperty("help_center_id") + public Optional getHelpCenterId() { + return helpCenterId; + } + + /** + * @return Return a highlighted version of the matching content within your articles. Refer to the response schema for more details. + */ + @JsonProperty("highlight") + public Optional getHighlight() { + return highlight; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof SearchArticlesRequest && equalTo((SearchArticlesRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(SearchArticlesRequest other) { + return phrase.equals(other.phrase) + && state.equals(other.state) + && helpCenterId.equals(other.helpCenterId) + && highlight.equals(other.highlight); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.phrase, this.state, this.helpCenterId, this.highlight); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static Builder builder() { + return new Builder(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder { + private Optional phrase = Optional.empty(); + + private Optional state = Optional.empty(); + + private Optional helpCenterId = Optional.empty(); + + private Optional highlight = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + public Builder from(SearchArticlesRequest other) { + phrase(other.getPhrase()); + state(other.getState()); + helpCenterId(other.getHelpCenterId()); + highlight(other.getHighlight()); + return this; + } + + /** + *

The phrase within your articles to search for.

+ */ + @JsonSetter(value = "phrase", nulls = Nulls.SKIP) + public Builder phrase(Optional phrase) { + this.phrase = phrase; + return this; + } + + public Builder phrase(String phrase) { + this.phrase = Optional.ofNullable(phrase); + return this; + } + + /** + *

The state of the Articles returned. One of published, draft or all.

+ */ + @JsonSetter(value = "state", nulls = Nulls.SKIP) + public Builder state(Optional state) { + this.state = state; + return this; + } + + public Builder state(String state) { + this.state = Optional.ofNullable(state); + return this; + } + + /** + *

The ID of the Help Center to search in.

+ */ + @JsonSetter(value = "help_center_id", nulls = Nulls.SKIP) + public Builder helpCenterId(Optional helpCenterId) { + this.helpCenterId = helpCenterId; + return this; + } + + public Builder helpCenterId(Integer helpCenterId) { + this.helpCenterId = Optional.ofNullable(helpCenterId); + return this; + } + + /** + *

Return a highlighted version of the matching content within your articles. Refer to the response schema for more details.

+ */ + @JsonSetter(value = "highlight", nulls = Nulls.SKIP) + public Builder highlight(Optional highlight) { + this.highlight = highlight; + return this; + } + + public Builder highlight(Boolean highlight) { + this.highlight = Optional.ofNullable(highlight); + return this; + } + + public SearchArticlesRequest build() { + return new SearchArticlesRequest(phrase, state, helpCenterId, highlight, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/articles/requests/UpdateArticleRequest.java b/src/main/java/com/intercom/api/resources/articles/requests/UpdateArticleRequest.java new file mode 100644 index 00000000..613c0641 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/articles/requests/UpdateArticleRequest.java @@ -0,0 +1,544 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.articles.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.JsonValue; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.types.ArticleTranslatedContent; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = UpdateArticleRequest.Builder.class) +public final class UpdateArticleRequest { + private final int articleId; + + private final Optional title; + + private final Optional description; + + private final Optional body; + + private final Optional authorId; + + private final Optional state; + + private final Optional parentId; + + private final Optional parentType; + + private final Optional translatedContent; + + private final Map additionalProperties; + + private UpdateArticleRequest( + int articleId, + Optional title, + Optional description, + Optional body, + Optional authorId, + Optional state, + Optional parentId, + Optional parentType, + Optional translatedContent, + Map additionalProperties) { + this.articleId = articleId; + this.title = title; + this.description = description; + this.body = body; + this.authorId = authorId; + this.state = state; + this.parentId = parentId; + this.parentType = parentType; + this.translatedContent = translatedContent; + this.additionalProperties = additionalProperties; + } + + /** + * @return The unique identifier for the article which is given by Intercom. + */ + @JsonProperty("article_id") + public int getArticleId() { + return articleId; + } + + /** + * @return The title of the article.For multilingual articles, this will be the title of the default language's content. + */ + @JsonProperty("title") + public Optional getTitle() { + return title; + } + + /** + * @return The description of the article. For multilingual articles, this will be the description of the default language's content. + */ + @JsonProperty("description") + public Optional getDescription() { + return description; + } + + /** + * @return The content of the article. For multilingual articles, this will be the body of the default language's content. + */ + @JsonProperty("body") + public Optional getBody() { + return body; + } + + /** + * @return The id of the author of the article. For multilingual articles, this will be the id of the author of the default language's content. Must be a teammate on the help center's workspace. + */ + @JsonProperty("author_id") + public Optional getAuthorId() { + return authorId; + } + + /** + * @return Whether the article will be published or will be a draft. Defaults to draft. For multilingual articles, this will be the state of the default language's content. + */ + @JsonProperty("state") + public Optional getState() { + return state; + } + + /** + * @return The id of the article's parent collection or section. An article without this field stands alone. + */ + @JsonProperty("parent_id") + public Optional getParentId() { + return parentId; + } + + /** + * @return The type of parent, which can either be a collection or section. + */ + @JsonProperty("parent_type") + public Optional getParentType() { + return parentType; + } + + @JsonProperty("translated_content") + public Optional getTranslatedContent() { + return translatedContent; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof UpdateArticleRequest && equalTo((UpdateArticleRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(UpdateArticleRequest other) { + return articleId == other.articleId + && title.equals(other.title) + && description.equals(other.description) + && body.equals(other.body) + && authorId.equals(other.authorId) + && state.equals(other.state) + && parentId.equals(other.parentId) + && parentType.equals(other.parentType) + && translatedContent.equals(other.translatedContent); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash( + this.articleId, + this.title, + this.description, + this.body, + this.authorId, + this.state, + this.parentId, + this.parentType, + this.translatedContent); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static ArticleIdStage builder() { + return new Builder(); + } + + public interface ArticleIdStage { + /** + *

The unique identifier for the article which is given by Intercom.

+ */ + _FinalStage articleId(int articleId); + + Builder from(UpdateArticleRequest other); + } + + public interface _FinalStage { + UpdateArticleRequest build(); + + /** + *

The title of the article.For multilingual articles, this will be the title of the default language's content.

+ */ + _FinalStage title(Optional title); + + _FinalStage title(String title); + + /** + *

The description of the article. For multilingual articles, this will be the description of the default language's content.

+ */ + _FinalStage description(Optional description); + + _FinalStage description(String description); + + /** + *

The content of the article. For multilingual articles, this will be the body of the default language's content.

+ */ + _FinalStage body(Optional body); + + _FinalStage body(String body); + + /** + *

The id of the author of the article. For multilingual articles, this will be the id of the author of the default language's content. Must be a teammate on the help center's workspace.

+ */ + _FinalStage authorId(Optional authorId); + + _FinalStage authorId(Integer authorId); + + /** + *

Whether the article will be published or will be a draft. Defaults to draft. For multilingual articles, this will be the state of the default language's content.

+ */ + _FinalStage state(Optional state); + + _FinalStage state(State state); + + /** + *

The id of the article's parent collection or section. An article without this field stands alone.

+ */ + _FinalStage parentId(Optional parentId); + + _FinalStage parentId(String parentId); + + /** + *

The type of parent, which can either be a collection or section.

+ */ + _FinalStage parentType(Optional parentType); + + _FinalStage parentType(String parentType); + + _FinalStage translatedContent(Optional translatedContent); + + _FinalStage translatedContent(ArticleTranslatedContent translatedContent); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements ArticleIdStage, _FinalStage { + private int articleId; + + private Optional translatedContent = Optional.empty(); + + private Optional parentType = Optional.empty(); + + private Optional parentId = Optional.empty(); + + private Optional state = Optional.empty(); + + private Optional authorId = Optional.empty(); + + private Optional body = Optional.empty(); + + private Optional description = Optional.empty(); + + private Optional title = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(UpdateArticleRequest other) { + articleId(other.getArticleId()); + title(other.getTitle()); + description(other.getDescription()); + body(other.getBody()); + authorId(other.getAuthorId()); + state(other.getState()); + parentId(other.getParentId()); + parentType(other.getParentType()); + translatedContent(other.getTranslatedContent()); + return this; + } + + /** + *

The unique identifier for the article which is given by Intercom.

+ *

The unique identifier for the article which is given by Intercom.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("article_id") + public _FinalStage articleId(int articleId) { + this.articleId = articleId; + return this; + } + + @java.lang.Override + public _FinalStage translatedContent(ArticleTranslatedContent translatedContent) { + this.translatedContent = Optional.ofNullable(translatedContent); + return this; + } + + @java.lang.Override + @JsonSetter(value = "translated_content", nulls = Nulls.SKIP) + public _FinalStage translatedContent(Optional translatedContent) { + this.translatedContent = translatedContent; + return this; + } + + /** + *

The type of parent, which can either be a collection or section.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage parentType(String parentType) { + this.parentType = Optional.ofNullable(parentType); + return this; + } + + /** + *

The type of parent, which can either be a collection or section.

+ */ + @java.lang.Override + @JsonSetter(value = "parent_type", nulls = Nulls.SKIP) + public _FinalStage parentType(Optional parentType) { + this.parentType = parentType; + return this; + } + + /** + *

The id of the article's parent collection or section. An article without this field stands alone.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage parentId(String parentId) { + this.parentId = Optional.ofNullable(parentId); + return this; + } + + /** + *

The id of the article's parent collection or section. An article without this field stands alone.

+ */ + @java.lang.Override + @JsonSetter(value = "parent_id", nulls = Nulls.SKIP) + public _FinalStage parentId(Optional parentId) { + this.parentId = parentId; + return this; + } + + /** + *

Whether the article will be published or will be a draft. Defaults to draft. For multilingual articles, this will be the state of the default language's content.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage state(State state) { + this.state = Optional.ofNullable(state); + return this; + } + + /** + *

Whether the article will be published or will be a draft. Defaults to draft. For multilingual articles, this will be the state of the default language's content.

+ */ + @java.lang.Override + @JsonSetter(value = "state", nulls = Nulls.SKIP) + public _FinalStage state(Optional state) { + this.state = state; + return this; + } + + /** + *

The id of the author of the article. For multilingual articles, this will be the id of the author of the default language's content. Must be a teammate on the help center's workspace.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage authorId(Integer authorId) { + this.authorId = Optional.ofNullable(authorId); + return this; + } + + /** + *

The id of the author of the article. For multilingual articles, this will be the id of the author of the default language's content. Must be a teammate on the help center's workspace.

+ */ + @java.lang.Override + @JsonSetter(value = "author_id", nulls = Nulls.SKIP) + public _FinalStage authorId(Optional authorId) { + this.authorId = authorId; + return this; + } + + /** + *

The content of the article. For multilingual articles, this will be the body of the default language's content.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage body(String body) { + this.body = Optional.ofNullable(body); + return this; + } + + /** + *

The content of the article. For multilingual articles, this will be the body of the default language's content.

+ */ + @java.lang.Override + @JsonSetter(value = "body", nulls = Nulls.SKIP) + public _FinalStage body(Optional body) { + this.body = body; + return this; + } + + /** + *

The description of the article. For multilingual articles, this will be the description of the default language's content.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage description(String description) { + this.description = Optional.ofNullable(description); + return this; + } + + /** + *

The description of the article. For multilingual articles, this will be the description of the default language's content.

+ */ + @java.lang.Override + @JsonSetter(value = "description", nulls = Nulls.SKIP) + public _FinalStage description(Optional description) { + this.description = description; + return this; + } + + /** + *

The title of the article.For multilingual articles, this will be the title of the default language's content.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage title(String title) { + this.title = Optional.ofNullable(title); + return this; + } + + /** + *

The title of the article.For multilingual articles, this will be the title of the default language's content.

+ */ + @java.lang.Override + @JsonSetter(value = "title", nulls = Nulls.SKIP) + public _FinalStage title(Optional title) { + this.title = title; + return this; + } + + @java.lang.Override + public UpdateArticleRequest build() { + return new UpdateArticleRequest( + articleId, + title, + description, + body, + authorId, + state, + parentId, + parentType, + translatedContent, + additionalProperties); + } + } + + public static final class State { + public static final State PUBLISHED = new State(Value.PUBLISHED, "published"); + + public static final State DRAFT = new State(Value.DRAFT, "draft"); + + private final Value value; + + private final String string; + + State(Value value, String string) { + this.value = value; + this.string = string; + } + + public Value getEnumValue() { + return value; + } + + @java.lang.Override + @JsonValue + public String toString() { + return this.string; + } + + @java.lang.Override + public boolean equals(Object other) { + return (this == other) || (other instanceof State && this.string.equals(((State) other).string)); + } + + @java.lang.Override + public int hashCode() { + return this.string.hashCode(); + } + + public T visit(Visitor visitor) { + switch (value) { + case PUBLISHED: + return visitor.visitPublished(); + case DRAFT: + return visitor.visitDraft(); + case UNKNOWN: + default: + return visitor.visitUnknown(string); + } + } + + @JsonCreator(mode = JsonCreator.Mode.DELEGATING) + public static State valueOf(String value) { + switch (value) { + case "published": + return PUBLISHED; + case "draft": + return DRAFT; + default: + return new State(Value.UNKNOWN, value); + } + } + + public enum Value { + PUBLISHED, + + DRAFT, + + UNKNOWN + } + + public interface Visitor { + T visitPublished(); + + T visitDraft(); + + T visitUnknown(String unknownType); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/articles/types/Article.java b/src/main/java/com/intercom/api/resources/articles/types/Article.java new file mode 100644 index 00000000..ce4691d9 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/articles/types/Article.java @@ -0,0 +1,854 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.articles.types; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.JsonValue; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.types.ArticleStatistics; +import com.intercom.api.types.ArticleTranslatedContent; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = Article.Builder.class) +public final class Article implements IArticleListItem { + private final Optional type; + + private final String id; + + private final String workspaceId; + + private final String title; + + private final Optional description; + + private final Optional body; + + private final int authorId; + + private final State state; + + private final int createdAt; + + private final int updatedAt; + + private final Optional url; + + private final Optional parentId; + + private final Optional> parentIds; + + private final Optional parentType; + + private final Optional defaultLocale; + + private final Optional translatedContent; + + private final Optional statistics; + + private final Map additionalProperties; + + private Article( + Optional type, + String id, + String workspaceId, + String title, + Optional description, + Optional body, + int authorId, + State state, + int createdAt, + int updatedAt, + Optional url, + Optional parentId, + Optional> parentIds, + Optional parentType, + Optional defaultLocale, + Optional translatedContent, + Optional statistics, + Map additionalProperties) { + this.type = type; + this.id = id; + this.workspaceId = workspaceId; + this.title = title; + this.description = description; + this.body = body; + this.authorId = authorId; + this.state = state; + this.createdAt = createdAt; + this.updatedAt = updatedAt; + this.url = url; + this.parentId = parentId; + this.parentIds = parentIds; + this.parentType = parentType; + this.defaultLocale = defaultLocale; + this.translatedContent = translatedContent; + this.statistics = statistics; + this.additionalProperties = additionalProperties; + } + + /** + * @return The type of object - article. + */ + @JsonProperty("type") + public Optional getType() { + return type; + } + + /** + * @return The unique identifier for the article which is given by Intercom. + */ + @JsonProperty("id") + public String getId() { + return id; + } + + /** + * @return The id of the workspace which the article belongs to. + */ + @JsonProperty("workspace_id") + public String getWorkspaceId() { + return workspaceId; + } + + /** + * @return The title of the article. For multilingual articles, this will be the title of the default language's content. + */ + @JsonProperty("title") + public String getTitle() { + return title; + } + + /** + * @return The description of the article. For multilingual articles, this will be the description of the default language's content. + */ + @JsonProperty("description") + public Optional getDescription() { + return description; + } + + /** + * @return The body of the article in HTML. For multilingual articles, this will be the body of the default language's content. + */ + @JsonProperty("body") + public Optional getBody() { + return body; + } + + /** + * @return The id of the author of the article. For multilingual articles, this will be the id of the author of the default language's content. Must be a teammate on the help center's workspace. + */ + @JsonProperty("author_id") + public int getAuthorId() { + return authorId; + } + + /** + * @return Whether the article is published or is a draft. For multilingual articles, this will be the state of the default language's content. + */ + @JsonProperty("state") + public State getState() { + return state; + } + + /** + * @return The time when the article was created. For multilingual articles, this will be the timestamp of creation of the default language's content in seconds. + */ + @JsonProperty("created_at") + public int getCreatedAt() { + return createdAt; + } + + /** + * @return The time when the article was last updated. For multilingual articles, this will be the timestamp of last update of the default language's content in seconds. + */ + @JsonProperty("updated_at") + public int getUpdatedAt() { + return updatedAt; + } + + /** + * @return The URL of the article. For multilingual articles, this will be the URL of the default language's content. + */ + @JsonProperty("url") + public Optional getUrl() { + return url; + } + + /** + * @return The id of the article's parent collection or section. An article without this field stands alone. + */ + @JsonProperty("parent_id") + public Optional getParentId() { + return parentId; + } + + /** + * @return The ids of the article's parent collections or sections. An article without this field stands alone. + */ + @JsonProperty("parent_ids") + public Optional> getParentIds() { + return parentIds; + } + + /** + * @return The type of parent, which can either be a collection or section. + */ + @JsonProperty("parent_type") + public Optional getParentType() { + return parentType; + } + + /** + * @return The default locale of the help center. This field is only returned for multilingual help centers. + */ + @JsonProperty("default_locale") + public Optional getDefaultLocale() { + return defaultLocale; + } + + @JsonProperty("translated_content") + public Optional getTranslatedContent() { + return translatedContent; + } + + @JsonProperty("statistics") + public Optional getStatistics() { + return statistics; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof Article && equalTo((Article) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(Article other) { + return type.equals(other.type) + && id.equals(other.id) + && workspaceId.equals(other.workspaceId) + && title.equals(other.title) + && description.equals(other.description) + && body.equals(other.body) + && authorId == other.authorId + && state.equals(other.state) + && createdAt == other.createdAt + && updatedAt == other.updatedAt + && url.equals(other.url) + && parentId.equals(other.parentId) + && parentIds.equals(other.parentIds) + && parentType.equals(other.parentType) + && defaultLocale.equals(other.defaultLocale) + && translatedContent.equals(other.translatedContent) + && statistics.equals(other.statistics); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash( + this.type, + this.id, + this.workspaceId, + this.title, + this.description, + this.body, + this.authorId, + this.state, + this.createdAt, + this.updatedAt, + this.url, + this.parentId, + this.parentIds, + this.parentType, + this.defaultLocale, + this.translatedContent, + this.statistics); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static IdStage builder() { + return new Builder(); + } + + public interface IdStage { + /** + *

The unique identifier for the article which is given by Intercom.

+ */ + WorkspaceIdStage id(@NotNull String id); + + Builder from(Article other); + } + + public interface WorkspaceIdStage { + /** + *

The id of the workspace which the article belongs to.

+ */ + TitleStage workspaceId(@NotNull String workspaceId); + } + + public interface TitleStage { + /** + *

The title of the article. For multilingual articles, this will be the title of the default language's content.

+ */ + AuthorIdStage title(@NotNull String title); + } + + public interface AuthorIdStage { + /** + *

The id of the author of the article. For multilingual articles, this will be the id of the author of the default language's content. Must be a teammate on the help center's workspace.

+ */ + StateStage authorId(int authorId); + } + + public interface StateStage { + /** + *

Whether the article is published or is a draft. For multilingual articles, this will be the state of the default language's content.

+ */ + CreatedAtStage state(@NotNull State state); + } + + public interface CreatedAtStage { + /** + *

The time when the article was created. For multilingual articles, this will be the timestamp of creation of the default language's content in seconds.

+ */ + UpdatedAtStage createdAt(int createdAt); + } + + public interface UpdatedAtStage { + /** + *

The time when the article was last updated. For multilingual articles, this will be the timestamp of last update of the default language's content in seconds.

+ */ + _FinalStage updatedAt(int updatedAt); + } + + public interface _FinalStage { + Article build(); + + /** + *

The type of object - article.

+ */ + _FinalStage type(Optional type); + + _FinalStage type(String type); + + /** + *

The description of the article. For multilingual articles, this will be the description of the default language's content.

+ */ + _FinalStage description(Optional description); + + _FinalStage description(String description); + + /** + *

The body of the article in HTML. For multilingual articles, this will be the body of the default language's content.

+ */ + _FinalStage body(Optional body); + + _FinalStage body(String body); + + /** + *

The URL of the article. For multilingual articles, this will be the URL of the default language's content.

+ */ + _FinalStage url(Optional url); + + _FinalStage url(String url); + + /** + *

The id of the article's parent collection or section. An article without this field stands alone.

+ */ + _FinalStage parentId(Optional parentId); + + _FinalStage parentId(Integer parentId); + + /** + *

The ids of the article's parent collections or sections. An article without this field stands alone.

+ */ + _FinalStage parentIds(Optional> parentIds); + + _FinalStage parentIds(List parentIds); + + /** + *

The type of parent, which can either be a collection or section.

+ */ + _FinalStage parentType(Optional parentType); + + _FinalStage parentType(String parentType); + + /** + *

The default locale of the help center. This field is only returned for multilingual help centers.

+ */ + _FinalStage defaultLocale(Optional defaultLocale); + + _FinalStage defaultLocale(String defaultLocale); + + _FinalStage translatedContent(Optional translatedContent); + + _FinalStage translatedContent(ArticleTranslatedContent translatedContent); + + _FinalStage statistics(Optional statistics); + + _FinalStage statistics(ArticleStatistics statistics); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder + implements IdStage, + WorkspaceIdStage, + TitleStage, + AuthorIdStage, + StateStage, + CreatedAtStage, + UpdatedAtStage, + _FinalStage { + private String id; + + private String workspaceId; + + private String title; + + private int authorId; + + private State state; + + private int createdAt; + + private int updatedAt; + + private Optional statistics = Optional.empty(); + + private Optional translatedContent = Optional.empty(); + + private Optional defaultLocale = Optional.empty(); + + private Optional parentType = Optional.empty(); + + private Optional> parentIds = Optional.empty(); + + private Optional parentId = Optional.empty(); + + private Optional url = Optional.empty(); + + private Optional body = Optional.empty(); + + private Optional description = Optional.empty(); + + private Optional type = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(Article other) { + type(other.getType()); + id(other.getId()); + workspaceId(other.getWorkspaceId()); + title(other.getTitle()); + description(other.getDescription()); + body(other.getBody()); + authorId(other.getAuthorId()); + state(other.getState()); + createdAt(other.getCreatedAt()); + updatedAt(other.getUpdatedAt()); + url(other.getUrl()); + parentId(other.getParentId()); + parentIds(other.getParentIds()); + parentType(other.getParentType()); + defaultLocale(other.getDefaultLocale()); + translatedContent(other.getTranslatedContent()); + statistics(other.getStatistics()); + return this; + } + + /** + *

The unique identifier for the article which is given by Intercom.

+ *

The unique identifier for the article which is given by Intercom.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("id") + public WorkspaceIdStage id(@NotNull String id) { + this.id = Objects.requireNonNull(id, "id must not be null"); + return this; + } + + /** + *

The id of the workspace which the article belongs to.

+ *

The id of the workspace which the article belongs to.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("workspace_id") + public TitleStage workspaceId(@NotNull String workspaceId) { + this.workspaceId = Objects.requireNonNull(workspaceId, "workspaceId must not be null"); + return this; + } + + /** + *

The title of the article. For multilingual articles, this will be the title of the default language's content.

+ *

The title of the article. For multilingual articles, this will be the title of the default language's content.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("title") + public AuthorIdStage title(@NotNull String title) { + this.title = Objects.requireNonNull(title, "title must not be null"); + return this; + } + + /** + *

The id of the author of the article. For multilingual articles, this will be the id of the author of the default language's content. Must be a teammate on the help center's workspace.

+ *

The id of the author of the article. For multilingual articles, this will be the id of the author of the default language's content. Must be a teammate on the help center's workspace.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("author_id") + public StateStage authorId(int authorId) { + this.authorId = authorId; + return this; + } + + /** + *

Whether the article is published or is a draft. For multilingual articles, this will be the state of the default language's content.

+ *

Whether the article is published or is a draft. For multilingual articles, this will be the state of the default language's content.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("state") + public CreatedAtStage state(@NotNull State state) { + this.state = Objects.requireNonNull(state, "state must not be null"); + return this; + } + + /** + *

The time when the article was created. For multilingual articles, this will be the timestamp of creation of the default language's content in seconds.

+ *

The time when the article was created. For multilingual articles, this will be the timestamp of creation of the default language's content in seconds.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("created_at") + public UpdatedAtStage createdAt(int createdAt) { + this.createdAt = createdAt; + return this; + } + + /** + *

The time when the article was last updated. For multilingual articles, this will be the timestamp of last update of the default language's content in seconds.

+ *

The time when the article was last updated. For multilingual articles, this will be the timestamp of last update of the default language's content in seconds.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("updated_at") + public _FinalStage updatedAt(int updatedAt) { + this.updatedAt = updatedAt; + return this; + } + + @java.lang.Override + public _FinalStage statistics(ArticleStatistics statistics) { + this.statistics = Optional.ofNullable(statistics); + return this; + } + + @java.lang.Override + @JsonSetter(value = "statistics", nulls = Nulls.SKIP) + public _FinalStage statistics(Optional statistics) { + this.statistics = statistics; + return this; + } + + @java.lang.Override + public _FinalStage translatedContent(ArticleTranslatedContent translatedContent) { + this.translatedContent = Optional.ofNullable(translatedContent); + return this; + } + + @java.lang.Override + @JsonSetter(value = "translated_content", nulls = Nulls.SKIP) + public _FinalStage translatedContent(Optional translatedContent) { + this.translatedContent = translatedContent; + return this; + } + + /** + *

The default locale of the help center. This field is only returned for multilingual help centers.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage defaultLocale(String defaultLocale) { + this.defaultLocale = Optional.ofNullable(defaultLocale); + return this; + } + + /** + *

The default locale of the help center. This field is only returned for multilingual help centers.

+ */ + @java.lang.Override + @JsonSetter(value = "default_locale", nulls = Nulls.SKIP) + public _FinalStage defaultLocale(Optional defaultLocale) { + this.defaultLocale = defaultLocale; + return this; + } + + /** + *

The type of parent, which can either be a collection or section.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage parentType(String parentType) { + this.parentType = Optional.ofNullable(parentType); + return this; + } + + /** + *

The type of parent, which can either be a collection or section.

+ */ + @java.lang.Override + @JsonSetter(value = "parent_type", nulls = Nulls.SKIP) + public _FinalStage parentType(Optional parentType) { + this.parentType = parentType; + return this; + } + + /** + *

The ids of the article's parent collections or sections. An article without this field stands alone.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage parentIds(List parentIds) { + this.parentIds = Optional.ofNullable(parentIds); + return this; + } + + /** + *

The ids of the article's parent collections or sections. An article without this field stands alone.

+ */ + @java.lang.Override + @JsonSetter(value = "parent_ids", nulls = Nulls.SKIP) + public _FinalStage parentIds(Optional> parentIds) { + this.parentIds = parentIds; + return this; + } + + /** + *

The id of the article's parent collection or section. An article without this field stands alone.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage parentId(Integer parentId) { + this.parentId = Optional.ofNullable(parentId); + return this; + } + + /** + *

The id of the article's parent collection or section. An article without this field stands alone.

+ */ + @java.lang.Override + @JsonSetter(value = "parent_id", nulls = Nulls.SKIP) + public _FinalStage parentId(Optional parentId) { + this.parentId = parentId; + return this; + } + + /** + *

The URL of the article. For multilingual articles, this will be the URL of the default language's content.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage url(String url) { + this.url = Optional.ofNullable(url); + return this; + } + + /** + *

The URL of the article. For multilingual articles, this will be the URL of the default language's content.

+ */ + @java.lang.Override + @JsonSetter(value = "url", nulls = Nulls.SKIP) + public _FinalStage url(Optional url) { + this.url = url; + return this; + } + + /** + *

The body of the article in HTML. For multilingual articles, this will be the body of the default language's content.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage body(String body) { + this.body = Optional.ofNullable(body); + return this; + } + + /** + *

The body of the article in HTML. For multilingual articles, this will be the body of the default language's content.

+ */ + @java.lang.Override + @JsonSetter(value = "body", nulls = Nulls.SKIP) + public _FinalStage body(Optional body) { + this.body = body; + return this; + } + + /** + *

The description of the article. For multilingual articles, this will be the description of the default language's content.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage description(String description) { + this.description = Optional.ofNullable(description); + return this; + } + + /** + *

The description of the article. For multilingual articles, this will be the description of the default language's content.

+ */ + @java.lang.Override + @JsonSetter(value = "description", nulls = Nulls.SKIP) + public _FinalStage description(Optional description) { + this.description = description; + return this; + } + + /** + *

The type of object - article.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage type(String type) { + this.type = Optional.ofNullable(type); + return this; + } + + /** + *

The type of object - article.

+ */ + @java.lang.Override + @JsonSetter(value = "type", nulls = Nulls.SKIP) + public _FinalStage type(Optional type) { + this.type = type; + return this; + } + + @java.lang.Override + public Article build() { + return new Article( + type, + id, + workspaceId, + title, + description, + body, + authorId, + state, + createdAt, + updatedAt, + url, + parentId, + parentIds, + parentType, + defaultLocale, + translatedContent, + statistics, + additionalProperties); + } + } + + public static final class State { + public static final State PUBLISHED = new State(Value.PUBLISHED, "published"); + + public static final State DRAFT = new State(Value.DRAFT, "draft"); + + private final Value value; + + private final String string; + + State(Value value, String string) { + this.value = value; + this.string = string; + } + + public Value getEnumValue() { + return value; + } + + @java.lang.Override + @JsonValue + public String toString() { + return this.string; + } + + @java.lang.Override + public boolean equals(Object other) { + return (this == other) || (other instanceof State && this.string.equals(((State) other).string)); + } + + @java.lang.Override + public int hashCode() { + return this.string.hashCode(); + } + + public T visit(Visitor visitor) { + switch (value) { + case PUBLISHED: + return visitor.visitPublished(); + case DRAFT: + return visitor.visitDraft(); + case UNKNOWN: + default: + return visitor.visitUnknown(string); + } + } + + @JsonCreator(mode = JsonCreator.Mode.DELEGATING) + public static State valueOf(String value) { + switch (value) { + case "published": + return PUBLISHED; + case "draft": + return DRAFT; + default: + return new State(Value.UNKNOWN, value); + } + } + + public enum Value { + PUBLISHED, + + DRAFT, + + UNKNOWN + } + + public interface Visitor { + T visitPublished(); + + T visitDraft(); + + T visitUnknown(String unknownType); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/articles/types/ArticleListItem.java b/src/main/java/com/intercom/api/resources/articles/types/ArticleListItem.java new file mode 100644 index 00000000..ffbfa9fc --- /dev/null +++ b/src/main/java/com/intercom/api/resources/articles/types/ArticleListItem.java @@ -0,0 +1,821 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.articles.types; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.JsonValue; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.types.ArticleTranslatedContent; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = ArticleListItem.Builder.class) +public final class ArticleListItem implements IArticleListItem { + private final Optional type; + + private final String id; + + private final String workspaceId; + + private final String title; + + private final Optional description; + + private final Optional body; + + private final int authorId; + + private final State state; + + private final int createdAt; + + private final int updatedAt; + + private final Optional url; + + private final Optional parentId; + + private final Optional> parentIds; + + private final Optional parentType; + + private final Optional defaultLocale; + + private final Optional translatedContent; + + private final Map additionalProperties; + + private ArticleListItem( + Optional type, + String id, + String workspaceId, + String title, + Optional description, + Optional body, + int authorId, + State state, + int createdAt, + int updatedAt, + Optional url, + Optional parentId, + Optional> parentIds, + Optional parentType, + Optional defaultLocale, + Optional translatedContent, + Map additionalProperties) { + this.type = type; + this.id = id; + this.workspaceId = workspaceId; + this.title = title; + this.description = description; + this.body = body; + this.authorId = authorId; + this.state = state; + this.createdAt = createdAt; + this.updatedAt = updatedAt; + this.url = url; + this.parentId = parentId; + this.parentIds = parentIds; + this.parentType = parentType; + this.defaultLocale = defaultLocale; + this.translatedContent = translatedContent; + this.additionalProperties = additionalProperties; + } + + /** + * @return The type of object - article. + */ + @JsonProperty("type") + public Optional getType() { + return type; + } + + /** + * @return The unique identifier for the article which is given by Intercom. + */ + @JsonProperty("id") + public String getId() { + return id; + } + + /** + * @return The id of the workspace which the article belongs to. + */ + @JsonProperty("workspace_id") + public String getWorkspaceId() { + return workspaceId; + } + + /** + * @return The title of the article. For multilingual articles, this will be the title of the default language's content. + */ + @JsonProperty("title") + public String getTitle() { + return title; + } + + /** + * @return The description of the article. For multilingual articles, this will be the description of the default language's content. + */ + @JsonProperty("description") + public Optional getDescription() { + return description; + } + + /** + * @return The body of the article in HTML. For multilingual articles, this will be the body of the default language's content. + */ + @JsonProperty("body") + public Optional getBody() { + return body; + } + + /** + * @return The id of the author of the article. For multilingual articles, this will be the id of the author of the default language's content. Must be a teammate on the help center's workspace. + */ + @JsonProperty("author_id") + public int getAuthorId() { + return authorId; + } + + /** + * @return Whether the article is published or is a draft. For multilingual articles, this will be the state of the default language's content. + */ + @JsonProperty("state") + public State getState() { + return state; + } + + /** + * @return The time when the article was created. For multilingual articles, this will be the timestamp of creation of the default language's content in seconds. + */ + @JsonProperty("created_at") + public int getCreatedAt() { + return createdAt; + } + + /** + * @return The time when the article was last updated. For multilingual articles, this will be the timestamp of last update of the default language's content in seconds. + */ + @JsonProperty("updated_at") + public int getUpdatedAt() { + return updatedAt; + } + + /** + * @return The URL of the article. For multilingual articles, this will be the URL of the default language's content. + */ + @JsonProperty("url") + public Optional getUrl() { + return url; + } + + /** + * @return The id of the article's parent collection or section. An article without this field stands alone. + */ + @JsonProperty("parent_id") + public Optional getParentId() { + return parentId; + } + + /** + * @return The ids of the article's parent collections or sections. An article without this field stands alone. + */ + @JsonProperty("parent_ids") + public Optional> getParentIds() { + return parentIds; + } + + /** + * @return The type of parent, which can either be a collection or section. + */ + @JsonProperty("parent_type") + public Optional getParentType() { + return parentType; + } + + /** + * @return The default locale of the help center. This field is only returned for multilingual help centers. + */ + @JsonProperty("default_locale") + public Optional getDefaultLocale() { + return defaultLocale; + } + + @JsonProperty("translated_content") + public Optional getTranslatedContent() { + return translatedContent; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof ArticleListItem && equalTo((ArticleListItem) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(ArticleListItem other) { + return type.equals(other.type) + && id.equals(other.id) + && workspaceId.equals(other.workspaceId) + && title.equals(other.title) + && description.equals(other.description) + && body.equals(other.body) + && authorId == other.authorId + && state.equals(other.state) + && createdAt == other.createdAt + && updatedAt == other.updatedAt + && url.equals(other.url) + && parentId.equals(other.parentId) + && parentIds.equals(other.parentIds) + && parentType.equals(other.parentType) + && defaultLocale.equals(other.defaultLocale) + && translatedContent.equals(other.translatedContent); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash( + this.type, + this.id, + this.workspaceId, + this.title, + this.description, + this.body, + this.authorId, + this.state, + this.createdAt, + this.updatedAt, + this.url, + this.parentId, + this.parentIds, + this.parentType, + this.defaultLocale, + this.translatedContent); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static IdStage builder() { + return new Builder(); + } + + public interface IdStage { + /** + *

The unique identifier for the article which is given by Intercom.

+ */ + WorkspaceIdStage id(@NotNull String id); + + Builder from(ArticleListItem other); + } + + public interface WorkspaceIdStage { + /** + *

The id of the workspace which the article belongs to.

+ */ + TitleStage workspaceId(@NotNull String workspaceId); + } + + public interface TitleStage { + /** + *

The title of the article. For multilingual articles, this will be the title of the default language's content.

+ */ + AuthorIdStage title(@NotNull String title); + } + + public interface AuthorIdStage { + /** + *

The id of the author of the article. For multilingual articles, this will be the id of the author of the default language's content. Must be a teammate on the help center's workspace.

+ */ + StateStage authorId(int authorId); + } + + public interface StateStage { + /** + *

Whether the article is published or is a draft. For multilingual articles, this will be the state of the default language's content.

+ */ + CreatedAtStage state(@NotNull State state); + } + + public interface CreatedAtStage { + /** + *

The time when the article was created. For multilingual articles, this will be the timestamp of creation of the default language's content in seconds.

+ */ + UpdatedAtStage createdAt(int createdAt); + } + + public interface UpdatedAtStage { + /** + *

The time when the article was last updated. For multilingual articles, this will be the timestamp of last update of the default language's content in seconds.

+ */ + _FinalStage updatedAt(int updatedAt); + } + + public interface _FinalStage { + ArticleListItem build(); + + /** + *

The type of object - article.

+ */ + _FinalStage type(Optional type); + + _FinalStage type(String type); + + /** + *

The description of the article. For multilingual articles, this will be the description of the default language's content.

+ */ + _FinalStage description(Optional description); + + _FinalStage description(String description); + + /** + *

The body of the article in HTML. For multilingual articles, this will be the body of the default language's content.

+ */ + _FinalStage body(Optional body); + + _FinalStage body(String body); + + /** + *

The URL of the article. For multilingual articles, this will be the URL of the default language's content.

+ */ + _FinalStage url(Optional url); + + _FinalStage url(String url); + + /** + *

The id of the article's parent collection or section. An article without this field stands alone.

+ */ + _FinalStage parentId(Optional parentId); + + _FinalStage parentId(Integer parentId); + + /** + *

The ids of the article's parent collections or sections. An article without this field stands alone.

+ */ + _FinalStage parentIds(Optional> parentIds); + + _FinalStage parentIds(List parentIds); + + /** + *

The type of parent, which can either be a collection or section.

+ */ + _FinalStage parentType(Optional parentType); + + _FinalStage parentType(String parentType); + + /** + *

The default locale of the help center. This field is only returned for multilingual help centers.

+ */ + _FinalStage defaultLocale(Optional defaultLocale); + + _FinalStage defaultLocale(String defaultLocale); + + _FinalStage translatedContent(Optional translatedContent); + + _FinalStage translatedContent(ArticleTranslatedContent translatedContent); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder + implements IdStage, + WorkspaceIdStage, + TitleStage, + AuthorIdStage, + StateStage, + CreatedAtStage, + UpdatedAtStage, + _FinalStage { + private String id; + + private String workspaceId; + + private String title; + + private int authorId; + + private State state; + + private int createdAt; + + private int updatedAt; + + private Optional translatedContent = Optional.empty(); + + private Optional defaultLocale = Optional.empty(); + + private Optional parentType = Optional.empty(); + + private Optional> parentIds = Optional.empty(); + + private Optional parentId = Optional.empty(); + + private Optional url = Optional.empty(); + + private Optional body = Optional.empty(); + + private Optional description = Optional.empty(); + + private Optional type = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(ArticleListItem other) { + type(other.getType()); + id(other.getId()); + workspaceId(other.getWorkspaceId()); + title(other.getTitle()); + description(other.getDescription()); + body(other.getBody()); + authorId(other.getAuthorId()); + state(other.getState()); + createdAt(other.getCreatedAt()); + updatedAt(other.getUpdatedAt()); + url(other.getUrl()); + parentId(other.getParentId()); + parentIds(other.getParentIds()); + parentType(other.getParentType()); + defaultLocale(other.getDefaultLocale()); + translatedContent(other.getTranslatedContent()); + return this; + } + + /** + *

The unique identifier for the article which is given by Intercom.

+ *

The unique identifier for the article which is given by Intercom.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("id") + public WorkspaceIdStage id(@NotNull String id) { + this.id = Objects.requireNonNull(id, "id must not be null"); + return this; + } + + /** + *

The id of the workspace which the article belongs to.

+ *

The id of the workspace which the article belongs to.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("workspace_id") + public TitleStage workspaceId(@NotNull String workspaceId) { + this.workspaceId = Objects.requireNonNull(workspaceId, "workspaceId must not be null"); + return this; + } + + /** + *

The title of the article. For multilingual articles, this will be the title of the default language's content.

+ *

The title of the article. For multilingual articles, this will be the title of the default language's content.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("title") + public AuthorIdStage title(@NotNull String title) { + this.title = Objects.requireNonNull(title, "title must not be null"); + return this; + } + + /** + *

The id of the author of the article. For multilingual articles, this will be the id of the author of the default language's content. Must be a teammate on the help center's workspace.

+ *

The id of the author of the article. For multilingual articles, this will be the id of the author of the default language's content. Must be a teammate on the help center's workspace.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("author_id") + public StateStage authorId(int authorId) { + this.authorId = authorId; + return this; + } + + /** + *

Whether the article is published or is a draft. For multilingual articles, this will be the state of the default language's content.

+ *

Whether the article is published or is a draft. For multilingual articles, this will be the state of the default language's content.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("state") + public CreatedAtStage state(@NotNull State state) { + this.state = Objects.requireNonNull(state, "state must not be null"); + return this; + } + + /** + *

The time when the article was created. For multilingual articles, this will be the timestamp of creation of the default language's content in seconds.

+ *

The time when the article was created. For multilingual articles, this will be the timestamp of creation of the default language's content in seconds.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("created_at") + public UpdatedAtStage createdAt(int createdAt) { + this.createdAt = createdAt; + return this; + } + + /** + *

The time when the article was last updated. For multilingual articles, this will be the timestamp of last update of the default language's content in seconds.

+ *

The time when the article was last updated. For multilingual articles, this will be the timestamp of last update of the default language's content in seconds.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("updated_at") + public _FinalStage updatedAt(int updatedAt) { + this.updatedAt = updatedAt; + return this; + } + + @java.lang.Override + public _FinalStage translatedContent(ArticleTranslatedContent translatedContent) { + this.translatedContent = Optional.ofNullable(translatedContent); + return this; + } + + @java.lang.Override + @JsonSetter(value = "translated_content", nulls = Nulls.SKIP) + public _FinalStage translatedContent(Optional translatedContent) { + this.translatedContent = translatedContent; + return this; + } + + /** + *

The default locale of the help center. This field is only returned for multilingual help centers.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage defaultLocale(String defaultLocale) { + this.defaultLocale = Optional.ofNullable(defaultLocale); + return this; + } + + /** + *

The default locale of the help center. This field is only returned for multilingual help centers.

+ */ + @java.lang.Override + @JsonSetter(value = "default_locale", nulls = Nulls.SKIP) + public _FinalStage defaultLocale(Optional defaultLocale) { + this.defaultLocale = defaultLocale; + return this; + } + + /** + *

The type of parent, which can either be a collection or section.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage parentType(String parentType) { + this.parentType = Optional.ofNullable(parentType); + return this; + } + + /** + *

The type of parent, which can either be a collection or section.

+ */ + @java.lang.Override + @JsonSetter(value = "parent_type", nulls = Nulls.SKIP) + public _FinalStage parentType(Optional parentType) { + this.parentType = parentType; + return this; + } + + /** + *

The ids of the article's parent collections or sections. An article without this field stands alone.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage parentIds(List parentIds) { + this.parentIds = Optional.ofNullable(parentIds); + return this; + } + + /** + *

The ids of the article's parent collections or sections. An article without this field stands alone.

+ */ + @java.lang.Override + @JsonSetter(value = "parent_ids", nulls = Nulls.SKIP) + public _FinalStage parentIds(Optional> parentIds) { + this.parentIds = parentIds; + return this; + } + + /** + *

The id of the article's parent collection or section. An article without this field stands alone.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage parentId(Integer parentId) { + this.parentId = Optional.ofNullable(parentId); + return this; + } + + /** + *

The id of the article's parent collection or section. An article without this field stands alone.

+ */ + @java.lang.Override + @JsonSetter(value = "parent_id", nulls = Nulls.SKIP) + public _FinalStage parentId(Optional parentId) { + this.parentId = parentId; + return this; + } + + /** + *

The URL of the article. For multilingual articles, this will be the URL of the default language's content.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage url(String url) { + this.url = Optional.ofNullable(url); + return this; + } + + /** + *

The URL of the article. For multilingual articles, this will be the URL of the default language's content.

+ */ + @java.lang.Override + @JsonSetter(value = "url", nulls = Nulls.SKIP) + public _FinalStage url(Optional url) { + this.url = url; + return this; + } + + /** + *

The body of the article in HTML. For multilingual articles, this will be the body of the default language's content.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage body(String body) { + this.body = Optional.ofNullable(body); + return this; + } + + /** + *

The body of the article in HTML. For multilingual articles, this will be the body of the default language's content.

+ */ + @java.lang.Override + @JsonSetter(value = "body", nulls = Nulls.SKIP) + public _FinalStage body(Optional body) { + this.body = body; + return this; + } + + /** + *

The description of the article. For multilingual articles, this will be the description of the default language's content.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage description(String description) { + this.description = Optional.ofNullable(description); + return this; + } + + /** + *

The description of the article. For multilingual articles, this will be the description of the default language's content.

+ */ + @java.lang.Override + @JsonSetter(value = "description", nulls = Nulls.SKIP) + public _FinalStage description(Optional description) { + this.description = description; + return this; + } + + /** + *

The type of object - article.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage type(String type) { + this.type = Optional.ofNullable(type); + return this; + } + + /** + *

The type of object - article.

+ */ + @java.lang.Override + @JsonSetter(value = "type", nulls = Nulls.SKIP) + public _FinalStage type(Optional type) { + this.type = type; + return this; + } + + @java.lang.Override + public ArticleListItem build() { + return new ArticleListItem( + type, + id, + workspaceId, + title, + description, + body, + authorId, + state, + createdAt, + updatedAt, + url, + parentId, + parentIds, + parentType, + defaultLocale, + translatedContent, + additionalProperties); + } + } + + public static final class State { + public static final State PUBLISHED = new State(Value.PUBLISHED, "published"); + + public static final State DRAFT = new State(Value.DRAFT, "draft"); + + private final Value value; + + private final String string; + + State(Value value, String string) { + this.value = value; + this.string = string; + } + + public Value getEnumValue() { + return value; + } + + @java.lang.Override + @JsonValue + public String toString() { + return this.string; + } + + @java.lang.Override + public boolean equals(Object other) { + return (this == other) || (other instanceof State && this.string.equals(((State) other).string)); + } + + @java.lang.Override + public int hashCode() { + return this.string.hashCode(); + } + + public T visit(Visitor visitor) { + switch (value) { + case PUBLISHED: + return visitor.visitPublished(); + case DRAFT: + return visitor.visitDraft(); + case UNKNOWN: + default: + return visitor.visitUnknown(string); + } + } + + @JsonCreator(mode = JsonCreator.Mode.DELEGATING) + public static State valueOf(String value) { + switch (value) { + case "published": + return PUBLISHED; + case "draft": + return DRAFT; + default: + return new State(Value.UNKNOWN, value); + } + } + + public enum Value { + PUBLISHED, + + DRAFT, + + UNKNOWN + } + + public interface Visitor { + T visitPublished(); + + T visitDraft(); + + T visitUnknown(String unknownType); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/articles/types/ArticleSearchHighlights.java b/src/main/java/com/intercom/api/resources/articles/types/ArticleSearchHighlights.java new file mode 100644 index 00000000..c4297419 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/articles/types/ArticleSearchHighlights.java @@ -0,0 +1,540 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.articles.types; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.JsonValue; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = ArticleSearchHighlights.Builder.class) +public final class ArticleSearchHighlights { + private final Optional articleId; + + private final Optional> highlightedTitle; + + private final Optional>> highlightedSummary; + + private final Map additionalProperties; + + private ArticleSearchHighlights( + Optional articleId, + Optional> highlightedTitle, + Optional>> highlightedSummary, + Map additionalProperties) { + this.articleId = articleId; + this.highlightedTitle = highlightedTitle; + this.highlightedSummary = highlightedSummary; + this.additionalProperties = additionalProperties; + } + + /** + * @return The ID of the corresponding article. + */ + @JsonProperty("article_id") + public Optional getArticleId() { + return articleId; + } + + /** + * @return An Article title highlighted. + */ + @JsonProperty("highlighted_title") + public Optional> getHighlightedTitle() { + return highlightedTitle; + } + + /** + * @return An Article description and body text highlighted. + */ + @JsonProperty("highlighted_summary") + public Optional>> getHighlightedSummary() { + return highlightedSummary; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof ArticleSearchHighlights && equalTo((ArticleSearchHighlights) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(ArticleSearchHighlights other) { + return articleId.equals(other.articleId) + && highlightedTitle.equals(other.highlightedTitle) + && highlightedSummary.equals(other.highlightedSummary); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.articleId, this.highlightedTitle, this.highlightedSummary); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static Builder builder() { + return new Builder(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder { + private Optional articleId = Optional.empty(); + + private Optional> highlightedTitle = Optional.empty(); + + private Optional>> highlightedSummary = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + public Builder from(ArticleSearchHighlights other) { + articleId(other.getArticleId()); + highlightedTitle(other.getHighlightedTitle()); + highlightedSummary(other.getHighlightedSummary()); + return this; + } + + /** + *

The ID of the corresponding article.

+ */ + @JsonSetter(value = "article_id", nulls = Nulls.SKIP) + public Builder articleId(Optional articleId) { + this.articleId = articleId; + return this; + } + + public Builder articleId(String articleId) { + this.articleId = Optional.ofNullable(articleId); + return this; + } + + /** + *

An Article title highlighted.

+ */ + @JsonSetter(value = "highlighted_title", nulls = Nulls.SKIP) + public Builder highlightedTitle(Optional> highlightedTitle) { + this.highlightedTitle = highlightedTitle; + return this; + } + + public Builder highlightedTitle(List highlightedTitle) { + this.highlightedTitle = Optional.ofNullable(highlightedTitle); + return this; + } + + /** + *

An Article description and body text highlighted.

+ */ + @JsonSetter(value = "highlighted_summary", nulls = Nulls.SKIP) + public Builder highlightedSummary(Optional>> highlightedSummary) { + this.highlightedSummary = highlightedSummary; + return this; + } + + public Builder highlightedSummary(List> highlightedSummary) { + this.highlightedSummary = Optional.ofNullable(highlightedSummary); + return this; + } + + public ArticleSearchHighlights build() { + return new ArticleSearchHighlights(articleId, highlightedTitle, highlightedSummary, additionalProperties); + } + } + + @JsonInclude(JsonInclude.Include.NON_ABSENT) + @JsonDeserialize(builder = HighlightedTitleItem.Builder.class) + public static final class HighlightedTitleItem { + private final Optional type; + + private final Optional text; + + private final Map additionalProperties; + + private HighlightedTitleItem( + Optional type, Optional text, Map additionalProperties) { + this.type = type; + this.text = text; + this.additionalProperties = additionalProperties; + } + + /** + * @return The type of text - highlight or plain. + */ + @JsonProperty("type") + public Optional getType() { + return type; + } + + /** + * @return The text of the title. + */ + @JsonProperty("text") + public Optional getText() { + return text; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof HighlightedTitleItem && equalTo((HighlightedTitleItem) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(HighlightedTitleItem other) { + return type.equals(other.type) && text.equals(other.text); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.type, this.text); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static Builder builder() { + return new Builder(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder { + private Optional type = Optional.empty(); + + private Optional text = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + public Builder from(HighlightedTitleItem other) { + type(other.getType()); + text(other.getText()); + return this; + } + + /** + *

The type of text - highlight or plain.

+ */ + @JsonSetter(value = "type", nulls = Nulls.SKIP) + public Builder type(Optional type) { + this.type = type; + return this; + } + + public Builder type(Type type) { + this.type = Optional.ofNullable(type); + return this; + } + + /** + *

The text of the title.

+ */ + @JsonSetter(value = "text", nulls = Nulls.SKIP) + public Builder text(Optional text) { + this.text = text; + return this; + } + + public Builder text(String text) { + this.text = Optional.ofNullable(text); + return this; + } + + public HighlightedTitleItem build() { + return new HighlightedTitleItem(type, text, additionalProperties); + } + } + + public static final class Type { + public static final Type PLAIN = new Type(Value.PLAIN, "plain"); + + public static final Type HIGHLIGHT = new Type(Value.HIGHLIGHT, "highlight"); + + private final Value value; + + private final String string; + + Type(Value value, String string) { + this.value = value; + this.string = string; + } + + public Value getEnumValue() { + return value; + } + + @java.lang.Override + @JsonValue + public String toString() { + return this.string; + } + + @java.lang.Override + public boolean equals(Object other) { + return (this == other) || (other instanceof Type && this.string.equals(((Type) other).string)); + } + + @java.lang.Override + public int hashCode() { + return this.string.hashCode(); + } + + public T visit(Visitor visitor) { + switch (value) { + case PLAIN: + return visitor.visitPlain(); + case HIGHLIGHT: + return visitor.visitHighlight(); + case UNKNOWN: + default: + return visitor.visitUnknown(string); + } + } + + @JsonCreator(mode = JsonCreator.Mode.DELEGATING) + public static Type valueOf(String value) { + switch (value) { + case "plain": + return PLAIN; + case "highlight": + return HIGHLIGHT; + default: + return new Type(Value.UNKNOWN, value); + } + } + + public enum Value { + HIGHLIGHT, + + PLAIN, + + UNKNOWN + } + + public interface Visitor { + T visitHighlight(); + + T visitPlain(); + + T visitUnknown(String unknownType); + } + } + } + + @JsonInclude(JsonInclude.Include.NON_ABSENT) + @JsonDeserialize(builder = HighlightedSummaryItemItem.Builder.class) + public static final class HighlightedSummaryItemItem { + private final Optional type; + + private final Optional text; + + private final Map additionalProperties; + + private HighlightedSummaryItemItem( + Optional type, Optional text, Map additionalProperties) { + this.type = type; + this.text = text; + this.additionalProperties = additionalProperties; + } + + /** + * @return The type of text - highlight or plain. + */ + @JsonProperty("type") + public Optional getType() { + return type; + } + + /** + * @return The text of the title. + */ + @JsonProperty("text") + public Optional getText() { + return text; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof HighlightedSummaryItemItem && equalTo((HighlightedSummaryItemItem) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(HighlightedSummaryItemItem other) { + return type.equals(other.type) && text.equals(other.text); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.type, this.text); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static Builder builder() { + return new Builder(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder { + private Optional type = Optional.empty(); + + private Optional text = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + public Builder from(HighlightedSummaryItemItem other) { + type(other.getType()); + text(other.getText()); + return this; + } + + /** + *

The type of text - highlight or plain.

+ */ + @JsonSetter(value = "type", nulls = Nulls.SKIP) + public Builder type(Optional type) { + this.type = type; + return this; + } + + public Builder type(Type type) { + this.type = Optional.ofNullable(type); + return this; + } + + /** + *

The text of the title.

+ */ + @JsonSetter(value = "text", nulls = Nulls.SKIP) + public Builder text(Optional text) { + this.text = text; + return this; + } + + public Builder text(String text) { + this.text = Optional.ofNullable(text); + return this; + } + + public HighlightedSummaryItemItem build() { + return new HighlightedSummaryItemItem(type, text, additionalProperties); + } + } + + public static final class Type { + public static final Type PLAIN = new Type(Value.PLAIN, "plain"); + + public static final Type HIGHLIGHT = new Type(Value.HIGHLIGHT, "highlight"); + + private final Value value; + + private final String string; + + Type(Value value, String string) { + this.value = value; + this.string = string; + } + + public Value getEnumValue() { + return value; + } + + @java.lang.Override + @JsonValue + public String toString() { + return this.string; + } + + @java.lang.Override + public boolean equals(Object other) { + return (this == other) || (other instanceof Type && this.string.equals(((Type) other).string)); + } + + @java.lang.Override + public int hashCode() { + return this.string.hashCode(); + } + + public T visit(Visitor visitor) { + switch (value) { + case PLAIN: + return visitor.visitPlain(); + case HIGHLIGHT: + return visitor.visitHighlight(); + case UNKNOWN: + default: + return visitor.visitUnknown(string); + } + } + + @JsonCreator(mode = JsonCreator.Mode.DELEGATING) + public static Type valueOf(String value) { + switch (value) { + case "plain": + return PLAIN; + case "highlight": + return HIGHLIGHT; + default: + return new Type(Value.UNKNOWN, value); + } + } + + public enum Value { + HIGHLIGHT, + + PLAIN, + + UNKNOWN + } + + public interface Visitor { + T visitHighlight(); + + T visitPlain(); + + T visitUnknown(String unknownType); + } + } + } +} diff --git a/src/main/java/com/intercom/api/resources/articles/types/ArticleSearchResponse.java b/src/main/java/com/intercom/api/resources/articles/types/ArticleSearchResponse.java new file mode 100644 index 00000000..c1885968 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/articles/types/ArticleSearchResponse.java @@ -0,0 +1,303 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.articles.types; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.types.CursorPages; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = ArticleSearchResponse.Builder.class) +public final class ArticleSearchResponse { + private final Optional type; + + private final Optional totalCount; + + private final Optional data; + + private final Optional pages; + + private final Map additionalProperties; + + private ArticleSearchResponse( + Optional type, + Optional totalCount, + Optional data, + Optional pages, + Map additionalProperties) { + this.type = type; + this.totalCount = totalCount; + this.data = data; + this.pages = pages; + this.additionalProperties = additionalProperties; + } + + /** + * @return The type of the object - list. + */ + @JsonProperty("type") + public Optional getType() { + return type; + } + + /** + * @return The total number of Articles matching the search query + */ + @JsonProperty("total_count") + public Optional getTotalCount() { + return totalCount; + } + + /** + * @return An object containing the results of the search. + */ + @JsonProperty("data") + public Optional getData() { + return data; + } + + @JsonProperty("pages") + public Optional getPages() { + return pages; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof ArticleSearchResponse && equalTo((ArticleSearchResponse) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(ArticleSearchResponse other) { + return type.equals(other.type) + && totalCount.equals(other.totalCount) + && data.equals(other.data) + && pages.equals(other.pages); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.type, this.totalCount, this.data, this.pages); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static Builder builder() { + return new Builder(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder { + private Optional type = Optional.empty(); + + private Optional totalCount = Optional.empty(); + + private Optional data = Optional.empty(); + + private Optional pages = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + public Builder from(ArticleSearchResponse other) { + type(other.getType()); + totalCount(other.getTotalCount()); + data(other.getData()); + pages(other.getPages()); + return this; + } + + /** + *

The type of the object - list.

+ */ + @JsonSetter(value = "type", nulls = Nulls.SKIP) + public Builder type(Optional type) { + this.type = type; + return this; + } + + public Builder type(String type) { + this.type = Optional.ofNullable(type); + return this; + } + + /** + *

The total number of Articles matching the search query

+ */ + @JsonSetter(value = "total_count", nulls = Nulls.SKIP) + public Builder totalCount(Optional totalCount) { + this.totalCount = totalCount; + return this; + } + + public Builder totalCount(Integer totalCount) { + this.totalCount = Optional.ofNullable(totalCount); + return this; + } + + /** + *

An object containing the results of the search.

+ */ + @JsonSetter(value = "data", nulls = Nulls.SKIP) + public Builder data(Optional data) { + this.data = data; + return this; + } + + public Builder data(Data data) { + this.data = Optional.ofNullable(data); + return this; + } + + @JsonSetter(value = "pages", nulls = Nulls.SKIP) + public Builder pages(Optional pages) { + this.pages = pages; + return this; + } + + public Builder pages(CursorPages pages) { + this.pages = Optional.ofNullable(pages); + return this; + } + + public ArticleSearchResponse build() { + return new ArticleSearchResponse(type, totalCount, data, pages, additionalProperties); + } + } + + @JsonInclude(JsonInclude.Include.NON_ABSENT) + @JsonDeserialize(builder = Data.Builder.class) + public static final class Data { + private final Optional> articles; + + private final Optional> highlights; + + private final Map additionalProperties; + + private Data( + Optional> articles, + Optional> highlights, + Map additionalProperties) { + this.articles = articles; + this.highlights = highlights; + this.additionalProperties = additionalProperties; + } + + /** + * @return An array of Article objects + */ + @JsonProperty("articles") + public Optional> getArticles() { + return articles; + } + + /** + * @return A corresponding array of highlighted Article content + */ + @JsonProperty("highlights") + public Optional> getHighlights() { + return highlights; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof Data && equalTo((Data) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(Data other) { + return articles.equals(other.articles) && highlights.equals(other.highlights); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.articles, this.highlights); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static Builder builder() { + return new Builder(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder { + private Optional> articles = Optional.empty(); + + private Optional> highlights = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + public Builder from(Data other) { + articles(other.getArticles()); + highlights(other.getHighlights()); + return this; + } + + /** + *

An array of Article objects

+ */ + @JsonSetter(value = "articles", nulls = Nulls.SKIP) + public Builder articles(Optional> articles) { + this.articles = articles; + return this; + } + + public Builder articles(List
articles) { + this.articles = Optional.ofNullable(articles); + return this; + } + + /** + *

A corresponding array of highlighted Article content

+ */ + @JsonSetter(value = "highlights", nulls = Nulls.SKIP) + public Builder highlights(Optional> highlights) { + this.highlights = highlights; + return this; + } + + public Builder highlights(List highlights) { + this.highlights = Optional.ofNullable(highlights); + return this; + } + + public Data build() { + return new Data(articles, highlights, additionalProperties); + } + } + } +} diff --git a/src/main/java/com/intercom/api/resources/articles/types/IArticleListItem.java b/src/main/java/com/intercom/api/resources/articles/types/IArticleListItem.java new file mode 100644 index 00000000..f43a4be7 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/articles/types/IArticleListItem.java @@ -0,0 +1,40 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.articles.types; + +import com.intercom.api.types.ArticleTranslatedContent; +import java.util.List; +import java.util.Optional; + +public interface IArticleListItem { + Optional getType(); + + String getId(); + + String getWorkspaceId(); + + String getTitle(); + + Optional getDescription(); + + Optional getBody(); + + int getAuthorId(); + + int getCreatedAt(); + + int getUpdatedAt(); + + Optional getUrl(); + + Optional getParentId(); + + Optional> getParentIds(); + + Optional getParentType(); + + Optional getDefaultLocale(); + + Optional getTranslatedContent(); +} diff --git a/src/main/java/com/intercom/api/resources/awaystatusreasons/AsyncAwayStatusReasonsClient.java b/src/main/java/com/intercom/api/resources/awaystatusreasons/AsyncAwayStatusReasonsClient.java new file mode 100644 index 00000000..bc2b8393 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/awaystatusreasons/AsyncAwayStatusReasonsClient.java @@ -0,0 +1,42 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.awaystatusreasons; + +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.types.AwayStatusReason; +import java.util.List; +import java.util.concurrent.CompletableFuture; + +public class AsyncAwayStatusReasonsClient { + protected final ClientOptions clientOptions; + + private final AsyncRawAwayStatusReasonsClient rawClient; + + public AsyncAwayStatusReasonsClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + this.rawClient = new AsyncRawAwayStatusReasonsClient(clientOptions); + } + + /** + * Get responses with HTTP metadata like headers + */ + public AsyncRawAwayStatusReasonsClient withRawResponse() { + return this.rawClient; + } + + /** + * Returns a list of all away status reasons configured for the workspace, including deleted ones. + */ + public CompletableFuture> listAwayStatusReasons() { + return this.rawClient.listAwayStatusReasons().thenApply(response -> response.body()); + } + + /** + * Returns a list of all away status reasons configured for the workspace, including deleted ones. + */ + public CompletableFuture> listAwayStatusReasons(RequestOptions requestOptions) { + return this.rawClient.listAwayStatusReasons(requestOptions).thenApply(response -> response.body()); + } +} diff --git a/src/main/java/com/intercom/api/resources/awaystatusreasons/AsyncRawAwayStatusReasonsClient.java b/src/main/java/com/intercom/api/resources/awaystatusreasons/AsyncRawAwayStatusReasonsClient.java new file mode 100644 index 00000000..1e6efe01 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/awaystatusreasons/AsyncRawAwayStatusReasonsClient.java @@ -0,0 +1,101 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.awaystatusreasons; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.fasterxml.jackson.core.type.TypeReference; +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.IntercomApiException; +import com.intercom.api.core.IntercomException; +import com.intercom.api.core.IntercomHttpResponse; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.errors.UnauthorizedError; +import com.intercom.api.types.AwayStatusReason; +import com.intercom.api.types.Error; +import java.io.IOException; +import java.util.List; +import java.util.concurrent.CompletableFuture; +import okhttp3.Call; +import okhttp3.Callback; +import okhttp3.Headers; +import okhttp3.HttpUrl; +import okhttp3.OkHttpClient; +import okhttp3.Request; +import okhttp3.Response; +import okhttp3.ResponseBody; +import org.jetbrains.annotations.NotNull; + +public class AsyncRawAwayStatusReasonsClient { + protected final ClientOptions clientOptions; + + public AsyncRawAwayStatusReasonsClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + } + + /** + * Returns a list of all away status reasons configured for the workspace, including deleted ones. + */ + public CompletableFuture>> listAwayStatusReasons() { + return listAwayStatusReasons(null); + } + + /** + * Returns a list of all away status reasons configured for the workspace, including deleted ones. + */ + public CompletableFuture>> listAwayStatusReasons( + RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("away_status_reasons") + .build(); + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture>> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue( + responseBodyString, new TypeReference>() {}), + response)); + return; + } + try { + if (response.code() == 401) { + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } +} diff --git a/src/main/java/com/intercom/api/resources/awaystatusreasons/AwayStatusReasonsClient.java b/src/main/java/com/intercom/api/resources/awaystatusreasons/AwayStatusReasonsClient.java new file mode 100644 index 00000000..5aef2c56 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/awaystatusreasons/AwayStatusReasonsClient.java @@ -0,0 +1,41 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.awaystatusreasons; + +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.types.AwayStatusReason; +import java.util.List; + +public class AwayStatusReasonsClient { + protected final ClientOptions clientOptions; + + private final RawAwayStatusReasonsClient rawClient; + + public AwayStatusReasonsClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + this.rawClient = new RawAwayStatusReasonsClient(clientOptions); + } + + /** + * Get responses with HTTP metadata like headers + */ + public RawAwayStatusReasonsClient withRawResponse() { + return this.rawClient; + } + + /** + * Returns a list of all away status reasons configured for the workspace, including deleted ones. + */ + public List listAwayStatusReasons() { + return this.rawClient.listAwayStatusReasons().body(); + } + + /** + * Returns a list of all away status reasons configured for the workspace, including deleted ones. + */ + public List listAwayStatusReasons(RequestOptions requestOptions) { + return this.rawClient.listAwayStatusReasons(requestOptions).body(); + } +} diff --git a/src/main/java/com/intercom/api/resources/awaystatusreasons/RawAwayStatusReasonsClient.java b/src/main/java/com/intercom/api/resources/awaystatusreasons/RawAwayStatusReasonsClient.java new file mode 100644 index 00000000..83ef2da5 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/awaystatusreasons/RawAwayStatusReasonsClient.java @@ -0,0 +1,82 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.awaystatusreasons; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.fasterxml.jackson.core.type.TypeReference; +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.IntercomApiException; +import com.intercom.api.core.IntercomException; +import com.intercom.api.core.IntercomHttpResponse; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.errors.UnauthorizedError; +import com.intercom.api.types.AwayStatusReason; +import com.intercom.api.types.Error; +import java.io.IOException; +import java.util.List; +import okhttp3.Headers; +import okhttp3.HttpUrl; +import okhttp3.OkHttpClient; +import okhttp3.Request; +import okhttp3.Response; +import okhttp3.ResponseBody; + +public class RawAwayStatusReasonsClient { + protected final ClientOptions clientOptions; + + public RawAwayStatusReasonsClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + } + + /** + * Returns a list of all away status reasons configured for the workspace, including deleted ones. + */ + public IntercomHttpResponse> listAwayStatusReasons() { + return listAwayStatusReasons(null); + } + + /** + * Returns a list of all away status reasons configured for the workspace, including deleted ones. + */ + public IntercomHttpResponse> listAwayStatusReasons(RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("away_status_reasons") + .build(); + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue( + responseBodyString, new TypeReference>() {}), + response); + } + try { + if (response.code() == 401) { + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/calls/AsyncCallsClient.java b/src/main/java/com/intercom/api/resources/calls/AsyncCallsClient.java new file mode 100644 index 00000000..3158eee0 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/calls/AsyncCallsClient.java @@ -0,0 +1,116 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.calls; + +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.resources.calls.requests.ListCallsRequest; +import com.intercom.api.resources.calls.requests.ListCallsWithTranscriptsRequest; +import com.intercom.api.resources.calls.requests.ShowCallRecordingRequest; +import com.intercom.api.resources.calls.requests.ShowCallRequest; +import com.intercom.api.resources.calls.requests.ShowCallTranscriptRequest; +import com.intercom.api.resources.calls.types.Call; +import com.intercom.api.resources.calls.types.ListCallsWithTranscriptsResponse; +import com.intercom.api.types.CallList; +import java.util.concurrent.CompletableFuture; + +public class AsyncCallsClient { + protected final ClientOptions clientOptions; + + private final AsyncRawCallsClient rawClient; + + public AsyncCallsClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + this.rawClient = new AsyncRawCallsClient(clientOptions); + } + + /** + * Get responses with HTTP metadata like headers + */ + public AsyncRawCallsClient withRawResponse() { + return this.rawClient; + } + + /** + * Retrieve a paginated list of calls. + */ + public CompletableFuture listCalls() { + return this.rawClient.listCalls().thenApply(response -> response.body()); + } + + /** + * Retrieve a paginated list of calls. + */ + public CompletableFuture listCalls(ListCallsRequest request) { + return this.rawClient.listCalls(request).thenApply(response -> response.body()); + } + + /** + * Retrieve a paginated list of calls. + */ + public CompletableFuture listCalls(ListCallsRequest request, RequestOptions requestOptions) { + return this.rawClient.listCalls(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * Retrieve a single call by id. + */ + public CompletableFuture showCall(ShowCallRequest request) { + return this.rawClient.showCall(request).thenApply(response -> response.body()); + } + + /** + * Retrieve a single call by id. + */ + public CompletableFuture showCall(ShowCallRequest request, RequestOptions requestOptions) { + return this.rawClient.showCall(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * Redirects to a signed URL for the call's recording if it exists. + */ + public CompletableFuture showCallRecording(ShowCallRecordingRequest request) { + return this.rawClient.showCallRecording(request).thenApply(response -> response.body()); + } + + /** + * Redirects to a signed URL for the call's recording if it exists. + */ + public CompletableFuture showCallRecording(ShowCallRecordingRequest request, RequestOptions requestOptions) { + return this.rawClient.showCallRecording(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * Returns the transcript for the specified call as a downloadable text file. + */ + public CompletableFuture showCallTranscript(ShowCallTranscriptRequest request) { + return this.rawClient.showCallTranscript(request).thenApply(response -> response.body()); + } + + /** + * Returns the transcript for the specified call as a downloadable text file. + */ + public CompletableFuture showCallTranscript( + ShowCallTranscriptRequest request, RequestOptions requestOptions) { + return this.rawClient.showCallTranscript(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * Retrieve calls by a list of conversation ids and include transcripts when available. + * A maximum of 20 conversation_ids can be provided. If none are provided or more than 20 are provided, a 400 error is returned. + */ + public CompletableFuture listCallsWithTranscripts( + ListCallsWithTranscriptsRequest request) { + return this.rawClient.listCallsWithTranscripts(request).thenApply(response -> response.body()); + } + + /** + * Retrieve calls by a list of conversation ids and include transcripts when available. + * A maximum of 20 conversation_ids can be provided. If none are provided or more than 20 are provided, a 400 error is returned. + */ + public CompletableFuture listCallsWithTranscripts( + ListCallsWithTranscriptsRequest request, RequestOptions requestOptions) { + return this.rawClient.listCallsWithTranscripts(request, requestOptions).thenApply(response -> response.body()); + } +} diff --git a/src/main/java/com/intercom/api/resources/calls/AsyncRawCallsClient.java b/src/main/java/com/intercom/api/resources/calls/AsyncRawCallsClient.java new file mode 100644 index 00000000..af964d35 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/calls/AsyncRawCallsClient.java @@ -0,0 +1,415 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.calls; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.IntercomApiException; +import com.intercom.api.core.IntercomException; +import com.intercom.api.core.IntercomHttpResponse; +import com.intercom.api.core.MediaTypes; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.core.QueryStringMapper; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.errors.BadRequestError; +import com.intercom.api.errors.NotFoundError; +import com.intercom.api.errors.UnauthorizedError; +import com.intercom.api.resources.calls.requests.ListCallsRequest; +import com.intercom.api.resources.calls.requests.ListCallsWithTranscriptsRequest; +import com.intercom.api.resources.calls.requests.ShowCallRecordingRequest; +import com.intercom.api.resources.calls.requests.ShowCallRequest; +import com.intercom.api.resources.calls.requests.ShowCallTranscriptRequest; +import com.intercom.api.resources.calls.types.ListCallsWithTranscriptsResponse; +import com.intercom.api.types.CallList; +import com.intercom.api.types.Error; +import java.io.IOException; +import java.util.concurrent.CompletableFuture; +import okhttp3.Call; +import okhttp3.Callback; +import okhttp3.Headers; +import okhttp3.HttpUrl; +import okhttp3.OkHttpClient; +import okhttp3.Request; +import okhttp3.RequestBody; +import okhttp3.Response; +import okhttp3.ResponseBody; +import org.jetbrains.annotations.NotNull; + +public class AsyncRawCallsClient { + protected final ClientOptions clientOptions; + + public AsyncRawCallsClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + } + + /** + * Retrieve a paginated list of calls. + */ + public CompletableFuture> listCalls() { + return listCalls(ListCallsRequest.builder().build()); + } + + /** + * Retrieve a paginated list of calls. + */ + public CompletableFuture> listCalls(ListCallsRequest request) { + return listCalls(request, null); + } + + /** + * Retrieve a paginated list of calls. + */ + public CompletableFuture> listCalls( + ListCallsRequest request, RequestOptions requestOptions) { + HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("calls"); + if (request.getPage().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "page", request.getPage().get(), false); + } + if (request.getPerPage().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "per_page", request.getPerPage().get(), false); + } + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl.build()) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, CallList.class), response)); + return; + } + try { + if (response.code() == 401) { + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * Retrieve a single call by id. + */ + public CompletableFuture> showCall( + ShowCallRequest request) { + return showCall(request, null); + } + + /** + * Retrieve a single call by id. + */ + public CompletableFuture> showCall( + ShowCallRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("calls") + .addPathSegment(request.getCallId()) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = + new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue( + responseBodyString, com.intercom.api.resources.calls.types.Call.class), + response)); + return; + } + try { + switch (response.code()) { + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 404: + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * Redirects to a signed URL for the call's recording if it exists. + */ + public CompletableFuture> showCallRecording(ShowCallRecordingRequest request) { + return showCallRecording(request, null); + } + + /** + * Redirects to a signed URL for the call's recording if it exists. + */ + public CompletableFuture> showCallRecording( + ShowCallRecordingRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("calls") + .addPathSegment(request.getCallId()) + .addPathSegments("recording") + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>(null, response)); + return; + } + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + try { + switch (response.code()) { + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 404: + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * Returns the transcript for the specified call as a downloadable text file. + */ + public CompletableFuture> showCallTranscript(ShowCallTranscriptRequest request) { + return showCallTranscript(request, null); + } + + /** + * Returns the transcript for the specified call as a downloadable text file. + */ + public CompletableFuture> showCallTranscript( + ShowCallTranscriptRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("calls") + .addPathSegment(request.getCallId()) + .addPathSegments("transcript") + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>(responseBodyString, response)); + return; + } + try { + if (response.code() == 404) { + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * Retrieve calls by a list of conversation ids and include transcripts when available. + * A maximum of 20 conversation_ids can be provided. If none are provided or more than 20 are provided, a 400 error is returned. + */ + public CompletableFuture> listCallsWithTranscripts( + ListCallsWithTranscriptsRequest request) { + return listCallsWithTranscripts(request, null); + } + + /** + * Retrieve calls by a list of conversation ids and include transcripts when available. + * A maximum of 20 conversation_ids can be provided. If none are provided or more than 20 are provided, a 400 error is returned. + */ + public CompletableFuture> listCallsWithTranscripts( + ListCallsWithTranscriptsRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("calls/search") + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue( + responseBodyString, ListCallsWithTranscriptsResponse.class), + response)); + return; + } + try { + switch (response.code()) { + case 400: + future.completeExceptionally(new BadRequestError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } +} diff --git a/src/main/java/com/intercom/api/resources/calls/CallsClient.java b/src/main/java/com/intercom/api/resources/calls/CallsClient.java new file mode 100644 index 00000000..3375eb4e --- /dev/null +++ b/src/main/java/com/intercom/api/resources/calls/CallsClient.java @@ -0,0 +1,113 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.calls; + +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.resources.calls.requests.ListCallsRequest; +import com.intercom.api.resources.calls.requests.ListCallsWithTranscriptsRequest; +import com.intercom.api.resources.calls.requests.ShowCallRecordingRequest; +import com.intercom.api.resources.calls.requests.ShowCallRequest; +import com.intercom.api.resources.calls.requests.ShowCallTranscriptRequest; +import com.intercom.api.resources.calls.types.Call; +import com.intercom.api.resources.calls.types.ListCallsWithTranscriptsResponse; +import com.intercom.api.types.CallList; + +public class CallsClient { + protected final ClientOptions clientOptions; + + private final RawCallsClient rawClient; + + public CallsClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + this.rawClient = new RawCallsClient(clientOptions); + } + + /** + * Get responses with HTTP metadata like headers + */ + public RawCallsClient withRawResponse() { + return this.rawClient; + } + + /** + * Retrieve a paginated list of calls. + */ + public CallList listCalls() { + return this.rawClient.listCalls().body(); + } + + /** + * Retrieve a paginated list of calls. + */ + public CallList listCalls(ListCallsRequest request) { + return this.rawClient.listCalls(request).body(); + } + + /** + * Retrieve a paginated list of calls. + */ + public CallList listCalls(ListCallsRequest request, RequestOptions requestOptions) { + return this.rawClient.listCalls(request, requestOptions).body(); + } + + /** + * Retrieve a single call by id. + */ + public Call showCall(ShowCallRequest request) { + return this.rawClient.showCall(request).body(); + } + + /** + * Retrieve a single call by id. + */ + public Call showCall(ShowCallRequest request, RequestOptions requestOptions) { + return this.rawClient.showCall(request, requestOptions).body(); + } + + /** + * Redirects to a signed URL for the call's recording if it exists. + */ + public void showCallRecording(ShowCallRecordingRequest request) { + this.rawClient.showCallRecording(request).body(); + } + + /** + * Redirects to a signed URL for the call's recording if it exists. + */ + public void showCallRecording(ShowCallRecordingRequest request, RequestOptions requestOptions) { + this.rawClient.showCallRecording(request, requestOptions).body(); + } + + /** + * Returns the transcript for the specified call as a downloadable text file. + */ + public String showCallTranscript(ShowCallTranscriptRequest request) { + return this.rawClient.showCallTranscript(request).body(); + } + + /** + * Returns the transcript for the specified call as a downloadable text file. + */ + public String showCallTranscript(ShowCallTranscriptRequest request, RequestOptions requestOptions) { + return this.rawClient.showCallTranscript(request, requestOptions).body(); + } + + /** + * Retrieve calls by a list of conversation ids and include transcripts when available. + * A maximum of 20 conversation_ids can be provided. If none are provided or more than 20 are provided, a 400 error is returned. + */ + public ListCallsWithTranscriptsResponse listCallsWithTranscripts(ListCallsWithTranscriptsRequest request) { + return this.rawClient.listCallsWithTranscripts(request).body(); + } + + /** + * Retrieve calls by a list of conversation ids and include transcripts when available. + * A maximum of 20 conversation_ids can be provided. If none are provided or more than 20 are provided, a 400 error is returned. + */ + public ListCallsWithTranscriptsResponse listCallsWithTranscripts( + ListCallsWithTranscriptsRequest request, RequestOptions requestOptions) { + return this.rawClient.listCallsWithTranscripts(request, requestOptions).body(); + } +} diff --git a/src/main/java/com/intercom/api/resources/calls/RawCallsClient.java b/src/main/java/com/intercom/api/resources/calls/RawCallsClient.java new file mode 100644 index 00000000..97bc0ed0 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/calls/RawCallsClient.java @@ -0,0 +1,326 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.calls; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.IntercomApiException; +import com.intercom.api.core.IntercomException; +import com.intercom.api.core.IntercomHttpResponse; +import com.intercom.api.core.MediaTypes; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.core.QueryStringMapper; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.errors.BadRequestError; +import com.intercom.api.errors.NotFoundError; +import com.intercom.api.errors.UnauthorizedError; +import com.intercom.api.resources.calls.requests.ListCallsRequest; +import com.intercom.api.resources.calls.requests.ListCallsWithTranscriptsRequest; +import com.intercom.api.resources.calls.requests.ShowCallRecordingRequest; +import com.intercom.api.resources.calls.requests.ShowCallRequest; +import com.intercom.api.resources.calls.requests.ShowCallTranscriptRequest; +import com.intercom.api.resources.calls.types.Call; +import com.intercom.api.resources.calls.types.ListCallsWithTranscriptsResponse; +import com.intercom.api.types.CallList; +import com.intercom.api.types.Error; +import java.io.IOException; +import okhttp3.Headers; +import okhttp3.HttpUrl; +import okhttp3.OkHttpClient; +import okhttp3.Request; +import okhttp3.RequestBody; +import okhttp3.Response; +import okhttp3.ResponseBody; + +public class RawCallsClient { + protected final ClientOptions clientOptions; + + public RawCallsClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + } + + /** + * Retrieve a paginated list of calls. + */ + public IntercomHttpResponse listCalls() { + return listCalls(ListCallsRequest.builder().build()); + } + + /** + * Retrieve a paginated list of calls. + */ + public IntercomHttpResponse listCalls(ListCallsRequest request) { + return listCalls(request, null); + } + + /** + * Retrieve a paginated list of calls. + */ + public IntercomHttpResponse listCalls(ListCallsRequest request, RequestOptions requestOptions) { + HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("calls"); + if (request.getPage().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "page", request.getPage().get(), false); + } + if (request.getPerPage().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "per_page", request.getPerPage().get(), false); + } + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl.build()) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, CallList.class), response); + } + try { + if (response.code() == 401) { + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * Retrieve a single call by id. + */ + public IntercomHttpResponse showCall(ShowCallRequest request) { + return showCall(request, null); + } + + /** + * Retrieve a single call by id. + */ + public IntercomHttpResponse showCall(ShowCallRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("calls") + .addPathSegment(request.getCallId()) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Call.class), response); + } + try { + switch (response.code()) { + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 404: + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * Redirects to a signed URL for the call's recording if it exists. + */ + public IntercomHttpResponse showCallRecording(ShowCallRecordingRequest request) { + return showCallRecording(request, null); + } + + /** + * Redirects to a signed URL for the call's recording if it exists. + */ + public IntercomHttpResponse showCallRecording( + ShowCallRecordingRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("calls") + .addPathSegment(request.getCallId()) + .addPathSegments("recording") + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + if (response.isSuccessful()) { + return new IntercomHttpResponse<>(null, response); + } + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + try { + switch (response.code()) { + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 404: + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * Returns the transcript for the specified call as a downloadable text file. + */ + public IntercomHttpResponse showCallTranscript(ShowCallTranscriptRequest request) { + return showCallTranscript(request, null); + } + + /** + * Returns the transcript for the specified call as a downloadable text file. + */ + public IntercomHttpResponse showCallTranscript( + ShowCallTranscriptRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("calls") + .addPathSegment(request.getCallId()) + .addPathSegments("transcript") + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>(responseBodyString, response); + } + try { + if (response.code() == 404) { + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * Retrieve calls by a list of conversation ids and include transcripts when available. + * A maximum of 20 conversation_ids can be provided. If none are provided or more than 20 are provided, a 400 error is returned. + */ + public IntercomHttpResponse listCallsWithTranscripts( + ListCallsWithTranscriptsRequest request) { + return listCallsWithTranscripts(request, null); + } + + /** + * Retrieve calls by a list of conversation ids and include transcripts when available. + * A maximum of 20 conversation_ids can be provided. If none are provided or more than 20 are provided, a 400 error is returned. + */ + public IntercomHttpResponse listCallsWithTranscripts( + ListCallsWithTranscriptsRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("calls/search") + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, ListCallsWithTranscriptsResponse.class), + response); + } + try { + switch (response.code()) { + case 400: + throw new BadRequestError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/calls/requests/ListCallsRequest.java b/src/main/java/com/intercom/api/resources/calls/requests/ListCallsRequest.java new file mode 100644 index 00000000..06d43b42 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/calls/requests/ListCallsRequest.java @@ -0,0 +1,130 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.calls.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = ListCallsRequest.Builder.class) +public final class ListCallsRequest { + private final Optional page; + + private final Optional perPage; + + private final Map additionalProperties; + + private ListCallsRequest( + Optional page, Optional perPage, Map additionalProperties) { + this.page = page; + this.perPage = perPage; + this.additionalProperties = additionalProperties; + } + + /** + * @return The page of results to fetch. Defaults to first page + */ + @JsonProperty("page") + public Optional getPage() { + return page; + } + + /** + * @return How many results to display per page. Defaults to 25. Max 25. + */ + @JsonProperty("per_page") + public Optional getPerPage() { + return perPage; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof ListCallsRequest && equalTo((ListCallsRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(ListCallsRequest other) { + return page.equals(other.page) && perPage.equals(other.perPage); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.page, this.perPage); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static Builder builder() { + return new Builder(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder { + private Optional page = Optional.empty(); + + private Optional perPage = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + public Builder from(ListCallsRequest other) { + page(other.getPage()); + perPage(other.getPerPage()); + return this; + } + + /** + *

The page of results to fetch. Defaults to first page

+ */ + @JsonSetter(value = "page", nulls = Nulls.SKIP) + public Builder page(Optional page) { + this.page = page; + return this; + } + + public Builder page(Integer page) { + this.page = Optional.ofNullable(page); + return this; + } + + /** + *

How many results to display per page. Defaults to 25. Max 25.

+ */ + @JsonSetter(value = "per_page", nulls = Nulls.SKIP) + public Builder perPage(Optional perPage) { + this.perPage = perPage; + return this; + } + + public Builder perPage(Integer perPage) { + this.perPage = Optional.ofNullable(perPage); + return this; + } + + public ListCallsRequest build() { + return new ListCallsRequest(page, perPage, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/calls/requests/ListCallsWithTranscriptsRequest.java b/src/main/java/com/intercom/api/resources/calls/requests/ListCallsWithTranscriptsRequest.java new file mode 100644 index 00000000..c16ced50 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/calls/requests/ListCallsWithTranscriptsRequest.java @@ -0,0 +1,112 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.calls.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.Objects; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = ListCallsWithTranscriptsRequest.Builder.class) +public final class ListCallsWithTranscriptsRequest { + private final List conversationIds; + + private final Map additionalProperties; + + private ListCallsWithTranscriptsRequest(List conversationIds, Map additionalProperties) { + this.conversationIds = conversationIds; + this.additionalProperties = additionalProperties; + } + + /** + * @return A list of conversation ids to fetch calls for. Maximum 20. + */ + @JsonProperty("conversation_ids") + public List getConversationIds() { + return conversationIds; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof ListCallsWithTranscriptsRequest && equalTo((ListCallsWithTranscriptsRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(ListCallsWithTranscriptsRequest other) { + return conversationIds.equals(other.conversationIds); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.conversationIds); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static Builder builder() { + return new Builder(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder { + private List conversationIds = new ArrayList<>(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + public Builder from(ListCallsWithTranscriptsRequest other) { + conversationIds(other.getConversationIds()); + return this; + } + + /** + *

A list of conversation ids to fetch calls for. Maximum 20.

+ */ + @JsonSetter(value = "conversation_ids", nulls = Nulls.SKIP) + public Builder conversationIds(List conversationIds) { + this.conversationIds.clear(); + if (conversationIds != null) { + this.conversationIds.addAll(conversationIds); + } + return this; + } + + public Builder addConversationIds(String conversationIds) { + this.conversationIds.add(conversationIds); + return this; + } + + public Builder addAllConversationIds(List conversationIds) { + if (conversationIds != null) { + this.conversationIds.addAll(conversationIds); + } + return this; + } + + public ListCallsWithTranscriptsRequest build() { + return new ListCallsWithTranscriptsRequest(conversationIds, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/calls/requests/ShowCallRecordingRequest.java b/src/main/java/com/intercom/api/resources/calls/requests/ShowCallRecordingRequest.java new file mode 100644 index 00000000..349261ff --- /dev/null +++ b/src/main/java/com/intercom/api/resources/calls/requests/ShowCallRecordingRequest.java @@ -0,0 +1,113 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.calls.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = ShowCallRecordingRequest.Builder.class) +public final class ShowCallRecordingRequest { + private final String callId; + + private final Map additionalProperties; + + private ShowCallRecordingRequest(String callId, Map additionalProperties) { + this.callId = callId; + this.additionalProperties = additionalProperties; + } + + /** + * @return The id of the call + */ + @JsonProperty("call_id") + public String getCallId() { + return callId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof ShowCallRecordingRequest && equalTo((ShowCallRecordingRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(ShowCallRecordingRequest other) { + return callId.equals(other.callId); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.callId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static CallIdStage builder() { + return new Builder(); + } + + public interface CallIdStage { + /** + *

The id of the call

+ */ + _FinalStage callId(@NotNull String callId); + + Builder from(ShowCallRecordingRequest other); + } + + public interface _FinalStage { + ShowCallRecordingRequest build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements CallIdStage, _FinalStage { + private String callId; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(ShowCallRecordingRequest other) { + callId(other.getCallId()); + return this; + } + + /** + *

The id of the call

+ *

The id of the call

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("call_id") + public _FinalStage callId(@NotNull String callId) { + this.callId = Objects.requireNonNull(callId, "callId must not be null"); + return this; + } + + @java.lang.Override + public ShowCallRecordingRequest build() { + return new ShowCallRecordingRequest(callId, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/calls/requests/ShowCallRequest.java b/src/main/java/com/intercom/api/resources/calls/requests/ShowCallRequest.java new file mode 100644 index 00000000..676f6cc7 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/calls/requests/ShowCallRequest.java @@ -0,0 +1,113 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.calls.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = ShowCallRequest.Builder.class) +public final class ShowCallRequest { + private final String callId; + + private final Map additionalProperties; + + private ShowCallRequest(String callId, Map additionalProperties) { + this.callId = callId; + this.additionalProperties = additionalProperties; + } + + /** + * @return The id of the call to retrieve + */ + @JsonProperty("call_id") + public String getCallId() { + return callId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof ShowCallRequest && equalTo((ShowCallRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(ShowCallRequest other) { + return callId.equals(other.callId); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.callId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static CallIdStage builder() { + return new Builder(); + } + + public interface CallIdStage { + /** + *

The id of the call to retrieve

+ */ + _FinalStage callId(@NotNull String callId); + + Builder from(ShowCallRequest other); + } + + public interface _FinalStage { + ShowCallRequest build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements CallIdStage, _FinalStage { + private String callId; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(ShowCallRequest other) { + callId(other.getCallId()); + return this; + } + + /** + *

The id of the call to retrieve

+ *

The id of the call to retrieve

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("call_id") + public _FinalStage callId(@NotNull String callId) { + this.callId = Objects.requireNonNull(callId, "callId must not be null"); + return this; + } + + @java.lang.Override + public ShowCallRequest build() { + return new ShowCallRequest(callId, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/calls/requests/ShowCallTranscriptRequest.java b/src/main/java/com/intercom/api/resources/calls/requests/ShowCallTranscriptRequest.java new file mode 100644 index 00000000..c9ed20e9 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/calls/requests/ShowCallTranscriptRequest.java @@ -0,0 +1,113 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.calls.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = ShowCallTranscriptRequest.Builder.class) +public final class ShowCallTranscriptRequest { + private final String callId; + + private final Map additionalProperties; + + private ShowCallTranscriptRequest(String callId, Map additionalProperties) { + this.callId = callId; + this.additionalProperties = additionalProperties; + } + + /** + * @return The id of the call + */ + @JsonProperty("call_id") + public String getCallId() { + return callId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof ShowCallTranscriptRequest && equalTo((ShowCallTranscriptRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(ShowCallTranscriptRequest other) { + return callId.equals(other.callId); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.callId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static CallIdStage builder() { + return new Builder(); + } + + public interface CallIdStage { + /** + *

The id of the call

+ */ + _FinalStage callId(@NotNull String callId); + + Builder from(ShowCallTranscriptRequest other); + } + + public interface _FinalStage { + ShowCallTranscriptRequest build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements CallIdStage, _FinalStage { + private String callId; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(ShowCallTranscriptRequest other) { + callId(other.getCallId()); + return this; + } + + /** + *

The id of the call

+ *

The id of the call

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("call_id") + public _FinalStage callId(@NotNull String callId) { + this.callId = Objects.requireNonNull(callId, "callId must not be null"); + return this; + } + + @java.lang.Override + public ShowCallTranscriptRequest build() { + return new ShowCallTranscriptRequest(callId, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/calls/types/Call.java b/src/main/java/com/intercom/api/resources/calls/types/Call.java new file mode 100644 index 00000000..fa2b8cda --- /dev/null +++ b/src/main/java/com/intercom/api/resources/calls/types/Call.java @@ -0,0 +1,653 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.calls.types; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.types.Datetime; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = Call.Builder.class) +public final class Call implements ICall { + private final Optional type; + + private final Optional id; + + private final Optional conversationId; + + private final Optional adminId; + + private final Optional contactId; + + private final Optional state; + + private final Optional initiatedAt; + + private final Optional answeredAt; + + private final Optional endedAt; + + private final Optional createdAt; + + private final Optional updatedAt; + + private final Optional recordingUrl; + + private final Optional transcriptionUrl; + + private final Optional callType; + + private final Optional direction; + + private final Optional endedReason; + + private final Optional phone; + + private final Optional finRecordingUrl; + + private final Optional finTranscriptionUrl; + + private final Map additionalProperties; + + private Call( + Optional type, + Optional id, + Optional conversationId, + Optional adminId, + Optional contactId, + Optional state, + Optional initiatedAt, + Optional answeredAt, + Optional endedAt, + Optional createdAt, + Optional updatedAt, + Optional recordingUrl, + Optional transcriptionUrl, + Optional callType, + Optional direction, + Optional endedReason, + Optional phone, + Optional finRecordingUrl, + Optional finTranscriptionUrl, + Map additionalProperties) { + this.type = type; + this.id = id; + this.conversationId = conversationId; + this.adminId = adminId; + this.contactId = contactId; + this.state = state; + this.initiatedAt = initiatedAt; + this.answeredAt = answeredAt; + this.endedAt = endedAt; + this.createdAt = createdAt; + this.updatedAt = updatedAt; + this.recordingUrl = recordingUrl; + this.transcriptionUrl = transcriptionUrl; + this.callType = callType; + this.direction = direction; + this.endedReason = endedReason; + this.phone = phone; + this.finRecordingUrl = finRecordingUrl; + this.finTranscriptionUrl = finTranscriptionUrl; + this.additionalProperties = additionalProperties; + } + + /** + * @return String representing the object's type. Always has the value call. + */ + @JsonProperty("type") + public Optional getType() { + return type; + } + + /** + * @return The id of the call. + */ + @JsonProperty("id") + public Optional getId() { + return id; + } + + /** + * @return The id of the conversation associated with the call, if any. + */ + @JsonProperty("conversation_id") + public Optional getConversationId() { + return conversationId; + } + + /** + * @return The id of the admin associated with the call, if any. + */ + @JsonProperty("admin_id") + public Optional getAdminId() { + return adminId; + } + + /** + * @return The id of the contact associated with the call, if any. + */ + @JsonProperty("contact_id") + public Optional getContactId() { + return contactId; + } + + /** + * @return The current state of the call. + */ + @JsonProperty("state") + public Optional getState() { + return state; + } + + @JsonProperty("initiated_at") + public Optional getInitiatedAt() { + return initiatedAt; + } + + @JsonProperty("answered_at") + public Optional getAnsweredAt() { + return answeredAt; + } + + @JsonProperty("ended_at") + public Optional getEndedAt() { + return endedAt; + } + + @JsonProperty("created_at") + public Optional getCreatedAt() { + return createdAt; + } + + @JsonProperty("updated_at") + public Optional getUpdatedAt() { + return updatedAt; + } + + /** + * @return API URL to download or redirect to the call recording if available. + */ + @JsonProperty("recording_url") + public Optional getRecordingUrl() { + return recordingUrl; + } + + /** + * @return API URL to download or redirect to the call transcript if available. + */ + @JsonProperty("transcription_url") + public Optional getTranscriptionUrl() { + return transcriptionUrl; + } + + /** + * @return The type of call. + */ + @JsonProperty("call_type") + public Optional getCallType() { + return callType; + } + + /** + * @return The direction of the call. + */ + @JsonProperty("direction") + public Optional getDirection() { + return direction; + } + + /** + * @return The reason for the call end, if applicable. + */ + @JsonProperty("ended_reason") + public Optional getEndedReason() { + return endedReason; + } + + /** + * @return The phone number involved in the call, in E.164 format. + */ + @JsonProperty("phone") + public Optional getPhone() { + return phone; + } + + /** + * @return API URL to the AI Agent (Fin) call recording if available. + */ + @JsonProperty("fin_recording_url") + public Optional getFinRecordingUrl() { + return finRecordingUrl; + } + + /** + * @return API URL to the AI Agent (Fin) call transcript if available. + */ + @JsonProperty("fin_transcription_url") + public Optional getFinTranscriptionUrl() { + return finTranscriptionUrl; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof Call && equalTo((Call) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(Call other) { + return type.equals(other.type) + && id.equals(other.id) + && conversationId.equals(other.conversationId) + && adminId.equals(other.adminId) + && contactId.equals(other.contactId) + && state.equals(other.state) + && initiatedAt.equals(other.initiatedAt) + && answeredAt.equals(other.answeredAt) + && endedAt.equals(other.endedAt) + && createdAt.equals(other.createdAt) + && updatedAt.equals(other.updatedAt) + && recordingUrl.equals(other.recordingUrl) + && transcriptionUrl.equals(other.transcriptionUrl) + && callType.equals(other.callType) + && direction.equals(other.direction) + && endedReason.equals(other.endedReason) + && phone.equals(other.phone) + && finRecordingUrl.equals(other.finRecordingUrl) + && finTranscriptionUrl.equals(other.finTranscriptionUrl); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash( + this.type, + this.id, + this.conversationId, + this.adminId, + this.contactId, + this.state, + this.initiatedAt, + this.answeredAt, + this.endedAt, + this.createdAt, + this.updatedAt, + this.recordingUrl, + this.transcriptionUrl, + this.callType, + this.direction, + this.endedReason, + this.phone, + this.finRecordingUrl, + this.finTranscriptionUrl); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static Builder builder() { + return new Builder(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder { + private Optional type = Optional.empty(); + + private Optional id = Optional.empty(); + + private Optional conversationId = Optional.empty(); + + private Optional adminId = Optional.empty(); + + private Optional contactId = Optional.empty(); + + private Optional state = Optional.empty(); + + private Optional initiatedAt = Optional.empty(); + + private Optional answeredAt = Optional.empty(); + + private Optional endedAt = Optional.empty(); + + private Optional createdAt = Optional.empty(); + + private Optional updatedAt = Optional.empty(); + + private Optional recordingUrl = Optional.empty(); + + private Optional transcriptionUrl = Optional.empty(); + + private Optional callType = Optional.empty(); + + private Optional direction = Optional.empty(); + + private Optional endedReason = Optional.empty(); + + private Optional phone = Optional.empty(); + + private Optional finRecordingUrl = Optional.empty(); + + private Optional finTranscriptionUrl = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + public Builder from(Call other) { + type(other.getType()); + id(other.getId()); + conversationId(other.getConversationId()); + adminId(other.getAdminId()); + contactId(other.getContactId()); + state(other.getState()); + initiatedAt(other.getInitiatedAt()); + answeredAt(other.getAnsweredAt()); + endedAt(other.getEndedAt()); + createdAt(other.getCreatedAt()); + updatedAt(other.getUpdatedAt()); + recordingUrl(other.getRecordingUrl()); + transcriptionUrl(other.getTranscriptionUrl()); + callType(other.getCallType()); + direction(other.getDirection()); + endedReason(other.getEndedReason()); + phone(other.getPhone()); + finRecordingUrl(other.getFinRecordingUrl()); + finTranscriptionUrl(other.getFinTranscriptionUrl()); + return this; + } + + /** + *

String representing the object's type. Always has the value call.

+ */ + @JsonSetter(value = "type", nulls = Nulls.SKIP) + public Builder type(Optional type) { + this.type = type; + return this; + } + + public Builder type(String type) { + this.type = Optional.ofNullable(type); + return this; + } + + /** + *

The id of the call.

+ */ + @JsonSetter(value = "id", nulls = Nulls.SKIP) + public Builder id(Optional id) { + this.id = id; + return this; + } + + public Builder id(String id) { + this.id = Optional.ofNullable(id); + return this; + } + + /** + *

The id of the conversation associated with the call, if any.

+ */ + @JsonSetter(value = "conversation_id", nulls = Nulls.SKIP) + public Builder conversationId(Optional conversationId) { + this.conversationId = conversationId; + return this; + } + + public Builder conversationId(String conversationId) { + this.conversationId = Optional.ofNullable(conversationId); + return this; + } + + /** + *

The id of the admin associated with the call, if any.

+ */ + @JsonSetter(value = "admin_id", nulls = Nulls.SKIP) + public Builder adminId(Optional adminId) { + this.adminId = adminId; + return this; + } + + public Builder adminId(String adminId) { + this.adminId = Optional.ofNullable(adminId); + return this; + } + + /** + *

The id of the contact associated with the call, if any.

+ */ + @JsonSetter(value = "contact_id", nulls = Nulls.SKIP) + public Builder contactId(Optional contactId) { + this.contactId = contactId; + return this; + } + + public Builder contactId(String contactId) { + this.contactId = Optional.ofNullable(contactId); + return this; + } + + /** + *

The current state of the call.

+ */ + @JsonSetter(value = "state", nulls = Nulls.SKIP) + public Builder state(Optional state) { + this.state = state; + return this; + } + + public Builder state(String state) { + this.state = Optional.ofNullable(state); + return this; + } + + @JsonSetter(value = "initiated_at", nulls = Nulls.SKIP) + public Builder initiatedAt(Optional initiatedAt) { + this.initiatedAt = initiatedAt; + return this; + } + + public Builder initiatedAt(Datetime initiatedAt) { + this.initiatedAt = Optional.ofNullable(initiatedAt); + return this; + } + + @JsonSetter(value = "answered_at", nulls = Nulls.SKIP) + public Builder answeredAt(Optional answeredAt) { + this.answeredAt = answeredAt; + return this; + } + + public Builder answeredAt(Datetime answeredAt) { + this.answeredAt = Optional.ofNullable(answeredAt); + return this; + } + + @JsonSetter(value = "ended_at", nulls = Nulls.SKIP) + public Builder endedAt(Optional endedAt) { + this.endedAt = endedAt; + return this; + } + + public Builder endedAt(Datetime endedAt) { + this.endedAt = Optional.ofNullable(endedAt); + return this; + } + + @JsonSetter(value = "created_at", nulls = Nulls.SKIP) + public Builder createdAt(Optional createdAt) { + this.createdAt = createdAt; + return this; + } + + public Builder createdAt(Datetime createdAt) { + this.createdAt = Optional.ofNullable(createdAt); + return this; + } + + @JsonSetter(value = "updated_at", nulls = Nulls.SKIP) + public Builder updatedAt(Optional updatedAt) { + this.updatedAt = updatedAt; + return this; + } + + public Builder updatedAt(Datetime updatedAt) { + this.updatedAt = Optional.ofNullable(updatedAt); + return this; + } + + /** + *

API URL to download or redirect to the call recording if available.

+ */ + @JsonSetter(value = "recording_url", nulls = Nulls.SKIP) + public Builder recordingUrl(Optional recordingUrl) { + this.recordingUrl = recordingUrl; + return this; + } + + public Builder recordingUrl(String recordingUrl) { + this.recordingUrl = Optional.ofNullable(recordingUrl); + return this; + } + + /** + *

API URL to download or redirect to the call transcript if available.

+ */ + @JsonSetter(value = "transcription_url", nulls = Nulls.SKIP) + public Builder transcriptionUrl(Optional transcriptionUrl) { + this.transcriptionUrl = transcriptionUrl; + return this; + } + + public Builder transcriptionUrl(String transcriptionUrl) { + this.transcriptionUrl = Optional.ofNullable(transcriptionUrl); + return this; + } + + /** + *

The type of call.

+ */ + @JsonSetter(value = "call_type", nulls = Nulls.SKIP) + public Builder callType(Optional callType) { + this.callType = callType; + return this; + } + + public Builder callType(String callType) { + this.callType = Optional.ofNullable(callType); + return this; + } + + /** + *

The direction of the call.

+ */ + @JsonSetter(value = "direction", nulls = Nulls.SKIP) + public Builder direction(Optional direction) { + this.direction = direction; + return this; + } + + public Builder direction(String direction) { + this.direction = Optional.ofNullable(direction); + return this; + } + + /** + *

The reason for the call end, if applicable.

+ */ + @JsonSetter(value = "ended_reason", nulls = Nulls.SKIP) + public Builder endedReason(Optional endedReason) { + this.endedReason = endedReason; + return this; + } + + public Builder endedReason(String endedReason) { + this.endedReason = Optional.ofNullable(endedReason); + return this; + } + + /** + *

The phone number involved in the call, in E.164 format.

+ */ + @JsonSetter(value = "phone", nulls = Nulls.SKIP) + public Builder phone(Optional phone) { + this.phone = phone; + return this; + } + + public Builder phone(String phone) { + this.phone = Optional.ofNullable(phone); + return this; + } + + /** + *

API URL to the AI Agent (Fin) call recording if available.

+ */ + @JsonSetter(value = "fin_recording_url", nulls = Nulls.SKIP) + public Builder finRecordingUrl(Optional finRecordingUrl) { + this.finRecordingUrl = finRecordingUrl; + return this; + } + + public Builder finRecordingUrl(String finRecordingUrl) { + this.finRecordingUrl = Optional.ofNullable(finRecordingUrl); + return this; + } + + /** + *

API URL to the AI Agent (Fin) call transcript if available.

+ */ + @JsonSetter(value = "fin_transcription_url", nulls = Nulls.SKIP) + public Builder finTranscriptionUrl(Optional finTranscriptionUrl) { + this.finTranscriptionUrl = finTranscriptionUrl; + return this; + } + + public Builder finTranscriptionUrl(String finTranscriptionUrl) { + this.finTranscriptionUrl = Optional.ofNullable(finTranscriptionUrl); + return this; + } + + public Call build() { + return new Call( + type, + id, + conversationId, + adminId, + contactId, + state, + initiatedAt, + answeredAt, + endedAt, + createdAt, + updatedAt, + recordingUrl, + transcriptionUrl, + callType, + direction, + endedReason, + phone, + finRecordingUrl, + finTranscriptionUrl, + additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/calls/types/ICall.java b/src/main/java/com/intercom/api/resources/calls/types/ICall.java new file mode 100644 index 00000000..d6bbf5f5 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/calls/types/ICall.java @@ -0,0 +1,47 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.calls.types; + +import com.intercom.api.types.Datetime; +import java.util.Optional; + +public interface ICall { + Optional getType(); + + Optional getId(); + + Optional getConversationId(); + + Optional getAdminId(); + + Optional getContactId(); + + Optional getState(); + + Optional getInitiatedAt(); + + Optional getAnsweredAt(); + + Optional getEndedAt(); + + Optional getCreatedAt(); + + Optional getUpdatedAt(); + + Optional getRecordingUrl(); + + Optional getTranscriptionUrl(); + + Optional getCallType(); + + Optional getDirection(); + + Optional getEndedReason(); + + Optional getPhone(); + + Optional getFinRecordingUrl(); + + Optional getFinTranscriptionUrl(); +} diff --git a/src/main/java/com/intercom/api/resources/calls/types/ListCallsWithTranscriptsResponse.java b/src/main/java/com/intercom/api/resources/calls/types/ListCallsWithTranscriptsResponse.java new file mode 100644 index 00000000..36e30c56 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/calls/types/ListCallsWithTranscriptsResponse.java @@ -0,0 +1,818 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.calls.types; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.types.Datetime; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = ListCallsWithTranscriptsResponse.Builder.class) +public final class ListCallsWithTranscriptsResponse { + private final Optional type; + + private final Optional> data; + + private final Map additionalProperties; + + private ListCallsWithTranscriptsResponse( + Optional type, Optional> data, Map additionalProperties) { + this.type = type; + this.data = data; + this.additionalProperties = additionalProperties; + } + + @JsonProperty("type") + public Optional getType() { + return type; + } + + @JsonProperty("data") + public Optional> getData() { + return data; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof ListCallsWithTranscriptsResponse && equalTo((ListCallsWithTranscriptsResponse) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(ListCallsWithTranscriptsResponse other) { + return type.equals(other.type) && data.equals(other.data); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.type, this.data); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static Builder builder() { + return new Builder(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder { + private Optional type = Optional.empty(); + + private Optional> data = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + public Builder from(ListCallsWithTranscriptsResponse other) { + type(other.getType()); + data(other.getData()); + return this; + } + + @JsonSetter(value = "type", nulls = Nulls.SKIP) + public Builder type(Optional type) { + this.type = type; + return this; + } + + public Builder type(String type) { + this.type = Optional.ofNullable(type); + return this; + } + + @JsonSetter(value = "data", nulls = Nulls.SKIP) + public Builder data(Optional> data) { + this.data = data; + return this; + } + + public Builder data(List data) { + this.data = Optional.ofNullable(data); + return this; + } + + public ListCallsWithTranscriptsResponse build() { + return new ListCallsWithTranscriptsResponse(type, data, additionalProperties); + } + } + + @JsonInclude(JsonInclude.Include.NON_ABSENT) + @JsonDeserialize(builder = DataItem.Builder.class) + public static final class DataItem implements ICall { + private final Optional type; + + private final Optional id; + + private final Optional conversationId; + + private final Optional adminId; + + private final Optional contactId; + + private final Optional state; + + private final Optional initiatedAt; + + private final Optional answeredAt; + + private final Optional endedAt; + + private final Optional createdAt; + + private final Optional updatedAt; + + private final Optional recordingUrl; + + private final Optional transcriptionUrl; + + private final Optional callType; + + private final Optional direction; + + private final Optional endedReason; + + private final Optional phone; + + private final Optional finRecordingUrl; + + private final Optional finTranscriptionUrl; + + private final Optional>> transcript; + + private final Optional transcriptStatus; + + private final Map additionalProperties; + + private DataItem( + Optional type, + Optional id, + Optional conversationId, + Optional adminId, + Optional contactId, + Optional state, + Optional initiatedAt, + Optional answeredAt, + Optional endedAt, + Optional createdAt, + Optional updatedAt, + Optional recordingUrl, + Optional transcriptionUrl, + Optional callType, + Optional direction, + Optional endedReason, + Optional phone, + Optional finRecordingUrl, + Optional finTranscriptionUrl, + Optional>> transcript, + Optional transcriptStatus, + Map additionalProperties) { + this.type = type; + this.id = id; + this.conversationId = conversationId; + this.adminId = adminId; + this.contactId = contactId; + this.state = state; + this.initiatedAt = initiatedAt; + this.answeredAt = answeredAt; + this.endedAt = endedAt; + this.createdAt = createdAt; + this.updatedAt = updatedAt; + this.recordingUrl = recordingUrl; + this.transcriptionUrl = transcriptionUrl; + this.callType = callType; + this.direction = direction; + this.endedReason = endedReason; + this.phone = phone; + this.finRecordingUrl = finRecordingUrl; + this.finTranscriptionUrl = finTranscriptionUrl; + this.transcript = transcript; + this.transcriptStatus = transcriptStatus; + this.additionalProperties = additionalProperties; + } + + /** + * @return String representing the object's type. Always has the value call. + */ + @JsonProperty("type") + public Optional getType() { + return type; + } + + /** + * @return The id of the call. + */ + @JsonProperty("id") + public Optional getId() { + return id; + } + + /** + * @return The id of the conversation associated with the call, if any. + */ + @JsonProperty("conversation_id") + public Optional getConversationId() { + return conversationId; + } + + /** + * @return The id of the admin associated with the call, if any. + */ + @JsonProperty("admin_id") + public Optional getAdminId() { + return adminId; + } + + /** + * @return The id of the contact associated with the call, if any. + */ + @JsonProperty("contact_id") + public Optional getContactId() { + return contactId; + } + + /** + * @return The current state of the call. + */ + @JsonProperty("state") + public Optional getState() { + return state; + } + + @JsonProperty("initiated_at") + public Optional getInitiatedAt() { + return initiatedAt; + } + + @JsonProperty("answered_at") + public Optional getAnsweredAt() { + return answeredAt; + } + + @JsonProperty("ended_at") + public Optional getEndedAt() { + return endedAt; + } + + @JsonProperty("created_at") + public Optional getCreatedAt() { + return createdAt; + } + + @JsonProperty("updated_at") + public Optional getUpdatedAt() { + return updatedAt; + } + + /** + * @return API URL to download or redirect to the call recording if available. + */ + @JsonProperty("recording_url") + public Optional getRecordingUrl() { + return recordingUrl; + } + + /** + * @return API URL to download or redirect to the call transcript if available. + */ + @JsonProperty("transcription_url") + public Optional getTranscriptionUrl() { + return transcriptionUrl; + } + + /** + * @return The type of call. + */ + @JsonProperty("call_type") + public Optional getCallType() { + return callType; + } + + /** + * @return The direction of the call. + */ + @JsonProperty("direction") + public Optional getDirection() { + return direction; + } + + /** + * @return The reason for the call end, if applicable. + */ + @JsonProperty("ended_reason") + public Optional getEndedReason() { + return endedReason; + } + + /** + * @return The phone number involved in the call, in E.164 format. + */ + @JsonProperty("phone") + public Optional getPhone() { + return phone; + } + + /** + * @return API URL to the AI Agent (Fin) call recording if available. + */ + @JsonProperty("fin_recording_url") + public Optional getFinRecordingUrl() { + return finRecordingUrl; + } + + /** + * @return API URL to the AI Agent (Fin) call transcript if available. + */ + @JsonProperty("fin_transcription_url") + public Optional getFinTranscriptionUrl() { + return finTranscriptionUrl; + } + + /** + * @return The call transcript if available, otherwise an empty array. + */ + @JsonProperty("transcript") + public Optional>> getTranscript() { + return transcript; + } + + /** + * @return The status of the transcript if available. + */ + @JsonProperty("transcript_status") + public Optional getTranscriptStatus() { + return transcriptStatus; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof DataItem && equalTo((DataItem) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(DataItem other) { + return type.equals(other.type) + && id.equals(other.id) + && conversationId.equals(other.conversationId) + && adminId.equals(other.adminId) + && contactId.equals(other.contactId) + && state.equals(other.state) + && initiatedAt.equals(other.initiatedAt) + && answeredAt.equals(other.answeredAt) + && endedAt.equals(other.endedAt) + && createdAt.equals(other.createdAt) + && updatedAt.equals(other.updatedAt) + && recordingUrl.equals(other.recordingUrl) + && transcriptionUrl.equals(other.transcriptionUrl) + && callType.equals(other.callType) + && direction.equals(other.direction) + && endedReason.equals(other.endedReason) + && phone.equals(other.phone) + && finRecordingUrl.equals(other.finRecordingUrl) + && finTranscriptionUrl.equals(other.finTranscriptionUrl) + && transcript.equals(other.transcript) + && transcriptStatus.equals(other.transcriptStatus); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash( + this.type, + this.id, + this.conversationId, + this.adminId, + this.contactId, + this.state, + this.initiatedAt, + this.answeredAt, + this.endedAt, + this.createdAt, + this.updatedAt, + this.recordingUrl, + this.transcriptionUrl, + this.callType, + this.direction, + this.endedReason, + this.phone, + this.finRecordingUrl, + this.finTranscriptionUrl, + this.transcript, + this.transcriptStatus); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static Builder builder() { + return new Builder(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder { + private Optional type = Optional.empty(); + + private Optional id = Optional.empty(); + + private Optional conversationId = Optional.empty(); + + private Optional adminId = Optional.empty(); + + private Optional contactId = Optional.empty(); + + private Optional state = Optional.empty(); + + private Optional initiatedAt = Optional.empty(); + + private Optional answeredAt = Optional.empty(); + + private Optional endedAt = Optional.empty(); + + private Optional createdAt = Optional.empty(); + + private Optional updatedAt = Optional.empty(); + + private Optional recordingUrl = Optional.empty(); + + private Optional transcriptionUrl = Optional.empty(); + + private Optional callType = Optional.empty(); + + private Optional direction = Optional.empty(); + + private Optional endedReason = Optional.empty(); + + private Optional phone = Optional.empty(); + + private Optional finRecordingUrl = Optional.empty(); + + private Optional finTranscriptionUrl = Optional.empty(); + + private Optional>> transcript = Optional.empty(); + + private Optional transcriptStatus = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + public Builder from(DataItem other) { + type(other.getType()); + id(other.getId()); + conversationId(other.getConversationId()); + adminId(other.getAdminId()); + contactId(other.getContactId()); + state(other.getState()); + initiatedAt(other.getInitiatedAt()); + answeredAt(other.getAnsweredAt()); + endedAt(other.getEndedAt()); + createdAt(other.getCreatedAt()); + updatedAt(other.getUpdatedAt()); + recordingUrl(other.getRecordingUrl()); + transcriptionUrl(other.getTranscriptionUrl()); + callType(other.getCallType()); + direction(other.getDirection()); + endedReason(other.getEndedReason()); + phone(other.getPhone()); + finRecordingUrl(other.getFinRecordingUrl()); + finTranscriptionUrl(other.getFinTranscriptionUrl()); + transcript(other.getTranscript()); + transcriptStatus(other.getTranscriptStatus()); + return this; + } + + /** + *

String representing the object's type. Always has the value call.

+ */ + @JsonSetter(value = "type", nulls = Nulls.SKIP) + public Builder type(Optional type) { + this.type = type; + return this; + } + + public Builder type(String type) { + this.type = Optional.ofNullable(type); + return this; + } + + /** + *

The id of the call.

+ */ + @JsonSetter(value = "id", nulls = Nulls.SKIP) + public Builder id(Optional id) { + this.id = id; + return this; + } + + public Builder id(String id) { + this.id = Optional.ofNullable(id); + return this; + } + + /** + *

The id of the conversation associated with the call, if any.

+ */ + @JsonSetter(value = "conversation_id", nulls = Nulls.SKIP) + public Builder conversationId(Optional conversationId) { + this.conversationId = conversationId; + return this; + } + + public Builder conversationId(String conversationId) { + this.conversationId = Optional.ofNullable(conversationId); + return this; + } + + /** + *

The id of the admin associated with the call, if any.

+ */ + @JsonSetter(value = "admin_id", nulls = Nulls.SKIP) + public Builder adminId(Optional adminId) { + this.adminId = adminId; + return this; + } + + public Builder adminId(String adminId) { + this.adminId = Optional.ofNullable(adminId); + return this; + } + + /** + *

The id of the contact associated with the call, if any.

+ */ + @JsonSetter(value = "contact_id", nulls = Nulls.SKIP) + public Builder contactId(Optional contactId) { + this.contactId = contactId; + return this; + } + + public Builder contactId(String contactId) { + this.contactId = Optional.ofNullable(contactId); + return this; + } + + /** + *

The current state of the call.

+ */ + @JsonSetter(value = "state", nulls = Nulls.SKIP) + public Builder state(Optional state) { + this.state = state; + return this; + } + + public Builder state(String state) { + this.state = Optional.ofNullable(state); + return this; + } + + @JsonSetter(value = "initiated_at", nulls = Nulls.SKIP) + public Builder initiatedAt(Optional initiatedAt) { + this.initiatedAt = initiatedAt; + return this; + } + + public Builder initiatedAt(Datetime initiatedAt) { + this.initiatedAt = Optional.ofNullable(initiatedAt); + return this; + } + + @JsonSetter(value = "answered_at", nulls = Nulls.SKIP) + public Builder answeredAt(Optional answeredAt) { + this.answeredAt = answeredAt; + return this; + } + + public Builder answeredAt(Datetime answeredAt) { + this.answeredAt = Optional.ofNullable(answeredAt); + return this; + } + + @JsonSetter(value = "ended_at", nulls = Nulls.SKIP) + public Builder endedAt(Optional endedAt) { + this.endedAt = endedAt; + return this; + } + + public Builder endedAt(Datetime endedAt) { + this.endedAt = Optional.ofNullable(endedAt); + return this; + } + + @JsonSetter(value = "created_at", nulls = Nulls.SKIP) + public Builder createdAt(Optional createdAt) { + this.createdAt = createdAt; + return this; + } + + public Builder createdAt(Datetime createdAt) { + this.createdAt = Optional.ofNullable(createdAt); + return this; + } + + @JsonSetter(value = "updated_at", nulls = Nulls.SKIP) + public Builder updatedAt(Optional updatedAt) { + this.updatedAt = updatedAt; + return this; + } + + public Builder updatedAt(Datetime updatedAt) { + this.updatedAt = Optional.ofNullable(updatedAt); + return this; + } + + /** + *

API URL to download or redirect to the call recording if available.

+ */ + @JsonSetter(value = "recording_url", nulls = Nulls.SKIP) + public Builder recordingUrl(Optional recordingUrl) { + this.recordingUrl = recordingUrl; + return this; + } + + public Builder recordingUrl(String recordingUrl) { + this.recordingUrl = Optional.ofNullable(recordingUrl); + return this; + } + + /** + *

API URL to download or redirect to the call transcript if available.

+ */ + @JsonSetter(value = "transcription_url", nulls = Nulls.SKIP) + public Builder transcriptionUrl(Optional transcriptionUrl) { + this.transcriptionUrl = transcriptionUrl; + return this; + } + + public Builder transcriptionUrl(String transcriptionUrl) { + this.transcriptionUrl = Optional.ofNullable(transcriptionUrl); + return this; + } + + /** + *

The type of call.

+ */ + @JsonSetter(value = "call_type", nulls = Nulls.SKIP) + public Builder callType(Optional callType) { + this.callType = callType; + return this; + } + + public Builder callType(String callType) { + this.callType = Optional.ofNullable(callType); + return this; + } + + /** + *

The direction of the call.

+ */ + @JsonSetter(value = "direction", nulls = Nulls.SKIP) + public Builder direction(Optional direction) { + this.direction = direction; + return this; + } + + public Builder direction(String direction) { + this.direction = Optional.ofNullable(direction); + return this; + } + + /** + *

The reason for the call end, if applicable.

+ */ + @JsonSetter(value = "ended_reason", nulls = Nulls.SKIP) + public Builder endedReason(Optional endedReason) { + this.endedReason = endedReason; + return this; + } + + public Builder endedReason(String endedReason) { + this.endedReason = Optional.ofNullable(endedReason); + return this; + } + + /** + *

The phone number involved in the call, in E.164 format.

+ */ + @JsonSetter(value = "phone", nulls = Nulls.SKIP) + public Builder phone(Optional phone) { + this.phone = phone; + return this; + } + + public Builder phone(String phone) { + this.phone = Optional.ofNullable(phone); + return this; + } + + /** + *

API URL to the AI Agent (Fin) call recording if available.

+ */ + @JsonSetter(value = "fin_recording_url", nulls = Nulls.SKIP) + public Builder finRecordingUrl(Optional finRecordingUrl) { + this.finRecordingUrl = finRecordingUrl; + return this; + } + + public Builder finRecordingUrl(String finRecordingUrl) { + this.finRecordingUrl = Optional.ofNullable(finRecordingUrl); + return this; + } + + /** + *

API URL to the AI Agent (Fin) call transcript if available.

+ */ + @JsonSetter(value = "fin_transcription_url", nulls = Nulls.SKIP) + public Builder finTranscriptionUrl(Optional finTranscriptionUrl) { + this.finTranscriptionUrl = finTranscriptionUrl; + return this; + } + + public Builder finTranscriptionUrl(String finTranscriptionUrl) { + this.finTranscriptionUrl = Optional.ofNullable(finTranscriptionUrl); + return this; + } + + /** + *

The call transcript if available, otherwise an empty array.

+ */ + @JsonSetter(value = "transcript", nulls = Nulls.SKIP) + public Builder transcript(Optional>> transcript) { + this.transcript = transcript; + return this; + } + + public Builder transcript(List> transcript) { + this.transcript = Optional.ofNullable(transcript); + return this; + } + + /** + *

The status of the transcript if available.

+ */ + @JsonSetter(value = "transcript_status", nulls = Nulls.SKIP) + public Builder transcriptStatus(Optional transcriptStatus) { + this.transcriptStatus = transcriptStatus; + return this; + } + + public Builder transcriptStatus(String transcriptStatus) { + this.transcriptStatus = Optional.ofNullable(transcriptStatus); + return this; + } + + public DataItem build() { + return new DataItem( + type, + id, + conversationId, + adminId, + contactId, + state, + initiatedAt, + answeredAt, + endedAt, + createdAt, + updatedAt, + recordingUrl, + transcriptionUrl, + callType, + direction, + endedReason, + phone, + finRecordingUrl, + finTranscriptionUrl, + transcript, + transcriptStatus, + additionalProperties); + } + } + } +} diff --git a/src/main/java/com/intercom/api/resources/companies/AsyncCompaniesClient.java b/src/main/java/com/intercom/api/resources/companies/AsyncCompaniesClient.java new file mode 100644 index 00000000..a7167dc3 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/companies/AsyncCompaniesClient.java @@ -0,0 +1,331 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.companies; + +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.core.pagination.SyncPagingIterable; +import com.intercom.api.resources.companies.requests.AttachContactToCompanyRequest; +import com.intercom.api.resources.companies.requests.DeleteCompanyRequest; +import com.intercom.api.resources.companies.requests.DetachContactFromCompanyRequest; +import com.intercom.api.resources.companies.requests.FindCompanyRequest; +import com.intercom.api.resources.companies.requests.ListAttachedContactsRequest; +import com.intercom.api.resources.companies.requests.ListCompaniesRequest; +import com.intercom.api.resources.companies.requests.ListSegmentsAttachedToCompanyRequest; +import com.intercom.api.resources.companies.requests.RetrieveCompanyRequest; +import com.intercom.api.resources.companies.requests.ScrollCompaniesRequest; +import com.intercom.api.resources.companies.requests.UpdateCompanyRequest; +import com.intercom.api.resources.companies.types.CompaniesRetrieveResponse; +import com.intercom.api.resources.companies.types.Company; +import com.intercom.api.types.CompanyAttachedContacts; +import com.intercom.api.types.CompanyAttachedSegments; +import com.intercom.api.types.CreateOrUpdateCompanyRequest; +import com.intercom.api.types.DeletedCompanyObject; +import java.util.Optional; +import java.util.concurrent.CompletableFuture; + +public class AsyncCompaniesClient { + protected final ClientOptions clientOptions; + + private final AsyncRawCompaniesClient rawClient; + + public AsyncCompaniesClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + this.rawClient = new AsyncRawCompaniesClient(clientOptions); + } + + /** + * Get responses with HTTP metadata like headers + */ + public AsyncRawCompaniesClient withRawResponse() { + return this.rawClient; + } + + /** + * You can fetch a single company by passing in company_id or name. + *

https://api.intercom.io/companies?name={name}

+ *

https://api.intercom.io/companies?company_id={company_id}

+ *

You can fetch all companies and filter by segment_id or tag_id as a query parameter.

+ *

https://api.intercom.io/companies?tag_id={tag_id}

+ *

https://api.intercom.io/companies?segment_id={segment_id}

+ */ + public CompletableFuture retrieve() { + return this.rawClient.retrieve().thenApply(response -> response.body()); + } + + /** + * You can fetch a single company by passing in company_id or name. + *

https://api.intercom.io/companies?name={name}

+ *

https://api.intercom.io/companies?company_id={company_id}

+ *

You can fetch all companies and filter by segment_id or tag_id as a query parameter.

+ *

https://api.intercom.io/companies?tag_id={tag_id}

+ *

https://api.intercom.io/companies?segment_id={segment_id}

+ */ + public CompletableFuture retrieve(RetrieveCompanyRequest request) { + return this.rawClient.retrieve(request).thenApply(response -> response.body()); + } + + /** + * You can fetch a single company by passing in company_id or name. + *

https://api.intercom.io/companies?name={name}

+ *

https://api.intercom.io/companies?company_id={company_id}

+ *

You can fetch all companies and filter by segment_id or tag_id as a query parameter.

+ *

https://api.intercom.io/companies?tag_id={tag_id}

+ *

https://api.intercom.io/companies?segment_id={segment_id}

+ */ + public CompletableFuture retrieve( + RetrieveCompanyRequest request, RequestOptions requestOptions) { + return this.rawClient.retrieve(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can create or update a company. + *

Companies will be only visible in Intercom when there is at least one associated user.

+ *

Companies are looked up via company_id in a POST request, if not found via company_id, the new company will be created, if found, that company will be updated.

+ *

{% admonition type="warning" name="Using company_id" %} + * You can set a unique company_id value when creating a company. However, it is not possible to update company_id. Be sure to set a unique value once upon creation of the company. + * {% /admonition %}

+ */ + public CompletableFuture createOrUpdate() { + return this.rawClient.createOrUpdate().thenApply(response -> response.body()); + } + + /** + * You can create or update a company. + *

Companies will be only visible in Intercom when there is at least one associated user.

+ *

Companies are looked up via company_id in a POST request, if not found via company_id, the new company will be created, if found, that company will be updated.

+ *

{% admonition type="warning" name="Using company_id" %} + * You can set a unique company_id value when creating a company. However, it is not possible to update company_id. Be sure to set a unique value once upon creation of the company. + * {% /admonition %}

+ */ + public CompletableFuture createOrUpdate(Optional request) { + return this.rawClient.createOrUpdate(request).thenApply(response -> response.body()); + } + + /** + * You can create or update a company. + *

Companies will be only visible in Intercom when there is at least one associated user.

+ *

Companies are looked up via company_id in a POST request, if not found via company_id, the new company will be created, if found, that company will be updated.

+ *

{% admonition type="warning" name="Using company_id" %} + * You can set a unique company_id value when creating a company. However, it is not possible to update company_id. Be sure to set a unique value once upon creation of the company. + * {% /admonition %}

+ */ + public CompletableFuture createOrUpdate( + Optional request, RequestOptions requestOptions) { + return this.rawClient.createOrUpdate(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can fetch a single company. + */ + public CompletableFuture find(FindCompanyRequest request) { + return this.rawClient.find(request).thenApply(response -> response.body()); + } + + /** + * You can fetch a single company. + */ + public CompletableFuture find(FindCompanyRequest request, RequestOptions requestOptions) { + return this.rawClient.find(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can update a single company using the Intercom provisioned id. + *

{% admonition type="warning" name="Using company_id" %} + * When updating a company it is not possible to update company_id. This can only be set once upon creation of the company. + * {% /admonition %}

+ */ + public CompletableFuture update(UpdateCompanyRequest request) { + return this.rawClient.update(request).thenApply(response -> response.body()); + } + + /** + * You can update a single company using the Intercom provisioned id. + *

{% admonition type="warning" name="Using company_id" %} + * When updating a company it is not possible to update company_id. This can only be set once upon creation of the company. + * {% /admonition %}

+ */ + public CompletableFuture update(UpdateCompanyRequest request, RequestOptions requestOptions) { + return this.rawClient.update(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can delete a single company. + */ + public CompletableFuture delete(DeleteCompanyRequest request) { + return this.rawClient.delete(request).thenApply(response -> response.body()); + } + + /** + * You can delete a single company. + */ + public CompletableFuture delete(DeleteCompanyRequest request, RequestOptions requestOptions) { + return this.rawClient.delete(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can fetch a list of all contacts that belong to a company. + */ + public CompletableFuture listAttachedContacts(ListAttachedContactsRequest request) { + return this.rawClient.listAttachedContacts(request).thenApply(response -> response.body()); + } + + /** + * You can fetch a list of all contacts that belong to a company. + */ + public CompletableFuture listAttachedContacts( + ListAttachedContactsRequest request, RequestOptions requestOptions) { + return this.rawClient.listAttachedContacts(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can fetch a list of all segments that belong to a company. + */ + public CompletableFuture listAttachedSegments( + ListSegmentsAttachedToCompanyRequest request) { + return this.rawClient.listAttachedSegments(request).thenApply(response -> response.body()); + } + + /** + * You can fetch a list of all segments that belong to a company. + */ + public CompletableFuture listAttachedSegments( + ListSegmentsAttachedToCompanyRequest request, RequestOptions requestOptions) { + return this.rawClient.listAttachedSegments(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can list companies. The company list is sorted by the last_request_at field and by default is ordered descending, most recently requested first. + *

Note that the API does not include companies who have no associated users in list responses.

+ *

When using the Companies endpoint and the pages object to iterate through the returned companies, there is a limit of 10,000 Companies that can be returned. If you need to list or iterate on more than 10,000 Companies, please use the Scroll API. + * {% admonition type="warning" name="Pagination" %} + * You can use pagination to limit the number of results returned. The default is 20 results per page. + * See the pagination section for more details on how to use the starting_after param. + * {% /admonition %}

+ */ + public CompletableFuture> list() { + return this.rawClient.list().thenApply(response -> response.body()); + } + + /** + * You can list companies. The company list is sorted by the last_request_at field and by default is ordered descending, most recently requested first. + *

Note that the API does not include companies who have no associated users in list responses.

+ *

When using the Companies endpoint and the pages object to iterate through the returned companies, there is a limit of 10,000 Companies that can be returned. If you need to list or iterate on more than 10,000 Companies, please use the Scroll API. + * {% admonition type="warning" name="Pagination" %} + * You can use pagination to limit the number of results returned. The default is 20 results per page. + * See the pagination section for more details on how to use the starting_after param. + * {% /admonition %}

+ */ + public CompletableFuture> list(ListCompaniesRequest request) { + return this.rawClient.list(request).thenApply(response -> response.body()); + } + + /** + * You can list companies. The company list is sorted by the last_request_at field and by default is ordered descending, most recently requested first. + *

Note that the API does not include companies who have no associated users in list responses.

+ *

When using the Companies endpoint and the pages object to iterate through the returned companies, there is a limit of 10,000 Companies that can be returned. If you need to list or iterate on more than 10,000 Companies, please use the Scroll API. + * {% admonition type="warning" name="Pagination" %} + * You can use pagination to limit the number of results returned. The default is 20 results per page. + * See the pagination section for more details on how to use the starting_after param. + * {% /admonition %}

+ */ + public CompletableFuture> list( + ListCompaniesRequest request, RequestOptions requestOptions) { + return this.rawClient.list(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * The list all companies functionality does not work well for huge datasets, and can result in errors and performance problems when paging deeply. The Scroll API provides an efficient mechanism for iterating over all companies in a dataset. + *
    + *
  • Each app can only have 1 scroll open at a time. You'll get an error message if you try to have more than one open per app.
    • + *
  • If the scroll isn't used for 1 minute, it expires and calls with that scroll param will fail
    • + *
  • If the end of the scroll is reached, "companies" will be empty and the scroll parameter will expire
    • + *
+ *

{% admonition type="info" name="Scroll Parameter" %} + * You can get the first page of companies by simply sending a GET request to the scroll endpoint. + * For subsequent requests you will need to use the scroll parameter from the response. + * {% /admonition %} + * {% admonition type="danger" name="Scroll network timeouts" %} + * Since scroll is often used on large datasets network errors such as timeouts can be encountered. When this occurs you will see a HTTP 500 error with the following message: + * "Request failed due to an internal network error. Please restart the scroll operation." + * If this happens, you will need to restart your scroll query: It is not possible to continue from a specific point when using scroll. + * {% /admonition %}

+ */ + public CompletableFuture> scroll() { + return this.rawClient.scroll().thenApply(response -> response.body()); + } + + /** + * The list all companies functionality does not work well for huge datasets, and can result in errors and performance problems when paging deeply. The Scroll API provides an efficient mechanism for iterating over all companies in a dataset. + *
    + *
  • Each app can only have 1 scroll open at a time. You'll get an error message if you try to have more than one open per app.
    • + *
  • If the scroll isn't used for 1 minute, it expires and calls with that scroll param will fail
    • + *
  • If the end of the scroll is reached, "companies" will be empty and the scroll parameter will expire
    • + *
+ *

{% admonition type="info" name="Scroll Parameter" %} + * You can get the first page of companies by simply sending a GET request to the scroll endpoint. + * For subsequent requests you will need to use the scroll parameter from the response. + * {% /admonition %} + * {% admonition type="danger" name="Scroll network timeouts" %} + * Since scroll is often used on large datasets network errors such as timeouts can be encountered. When this occurs you will see a HTTP 500 error with the following message: + * "Request failed due to an internal network error. Please restart the scroll operation." + * If this happens, you will need to restart your scroll query: It is not possible to continue from a specific point when using scroll. + * {% /admonition %}

+ */ + public CompletableFuture> scroll(ScrollCompaniesRequest request) { + return this.rawClient.scroll(request).thenApply(response -> response.body()); + } + + /** + * The list all companies functionality does not work well for huge datasets, and can result in errors and performance problems when paging deeply. The Scroll API provides an efficient mechanism for iterating over all companies in a dataset. + *
    + *
  • Each app can only have 1 scroll open at a time. You'll get an error message if you try to have more than one open per app.
    • + *
  • If the scroll isn't used for 1 minute, it expires and calls with that scroll param will fail
    • + *
  • If the end of the scroll is reached, "companies" will be empty and the scroll parameter will expire
    • + *
+ *

{% admonition type="info" name="Scroll Parameter" %} + * You can get the first page of companies by simply sending a GET request to the scroll endpoint. + * For subsequent requests you will need to use the scroll parameter from the response. + * {% /admonition %} + * {% admonition type="danger" name="Scroll network timeouts" %} + * Since scroll is often used on large datasets network errors such as timeouts can be encountered. When this occurs you will see a HTTP 500 error with the following message: + * "Request failed due to an internal network error. Please restart the scroll operation." + * If this happens, you will need to restart your scroll query: It is not possible to continue from a specific point when using scroll. + * {% /admonition %}

+ */ + public CompletableFuture> scroll( + ScrollCompaniesRequest request, RequestOptions requestOptions) { + return this.rawClient.scroll(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can attach a company to a single contact. + */ + public CompletableFuture attachContact(AttachContactToCompanyRequest request) { + return this.rawClient.attachContact(request).thenApply(response -> response.body()); + } + + /** + * You can attach a company to a single contact. + */ + public CompletableFuture attachContact( + AttachContactToCompanyRequest request, RequestOptions requestOptions) { + return this.rawClient.attachContact(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can detach a company from a single contact. + */ + public CompletableFuture detachContact(DetachContactFromCompanyRequest request) { + return this.rawClient.detachContact(request).thenApply(response -> response.body()); + } + + /** + * You can detach a company from a single contact. + */ + public CompletableFuture detachContact( + DetachContactFromCompanyRequest request, RequestOptions requestOptions) { + return this.rawClient.detachContact(request, requestOptions).thenApply(response -> response.body()); + } +} diff --git a/src/main/java/com/intercom/api/resources/companies/AsyncRawCompaniesClient.java b/src/main/java/com/intercom/api/resources/companies/AsyncRawCompaniesClient.java new file mode 100644 index 00000000..bebb228b --- /dev/null +++ b/src/main/java/com/intercom/api/resources/companies/AsyncRawCompaniesClient.java @@ -0,0 +1,1074 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.companies; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.fasterxml.jackson.core.type.TypeReference; +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.IntercomApiException; +import com.intercom.api.core.IntercomException; +import com.intercom.api.core.IntercomHttpResponse; +import com.intercom.api.core.MediaTypes; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.core.QueryStringMapper; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.core.pagination.SyncPagingIterable; +import com.intercom.api.errors.BadRequestError; +import com.intercom.api.errors.NotFoundError; +import com.intercom.api.errors.UnauthorizedError; +import com.intercom.api.resources.companies.requests.AttachContactToCompanyRequest; +import com.intercom.api.resources.companies.requests.DeleteCompanyRequest; +import com.intercom.api.resources.companies.requests.DetachContactFromCompanyRequest; +import com.intercom.api.resources.companies.requests.FindCompanyRequest; +import com.intercom.api.resources.companies.requests.ListAttachedContactsRequest; +import com.intercom.api.resources.companies.requests.ListCompaniesRequest; +import com.intercom.api.resources.companies.requests.ListSegmentsAttachedToCompanyRequest; +import com.intercom.api.resources.companies.requests.RetrieveCompanyRequest; +import com.intercom.api.resources.companies.requests.ScrollCompaniesRequest; +import com.intercom.api.resources.companies.requests.UpdateCompanyRequest; +import com.intercom.api.resources.companies.types.CompaniesRetrieveResponse; +import com.intercom.api.resources.companies.types.Company; +import com.intercom.api.types.CompanyAttachedContacts; +import com.intercom.api.types.CompanyAttachedSegments; +import com.intercom.api.types.CompanyList; +import com.intercom.api.types.CompanyScroll; +import com.intercom.api.types.CreateOrUpdateCompanyRequest; +import com.intercom.api.types.DeletedCompanyObject; +import com.intercom.api.types.Error; +import java.io.IOException; +import java.util.Collections; +import java.util.List; +import java.util.Optional; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.ExecutionException; +import okhttp3.Call; +import okhttp3.Callback; +import okhttp3.Headers; +import okhttp3.HttpUrl; +import okhttp3.OkHttpClient; +import okhttp3.Request; +import okhttp3.RequestBody; +import okhttp3.Response; +import okhttp3.ResponseBody; +import org.jetbrains.annotations.NotNull; + +public class AsyncRawCompaniesClient { + protected final ClientOptions clientOptions; + + public AsyncRawCompaniesClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + } + + /** + * You can fetch a single company by passing in company_id or name. + *

https://api.intercom.io/companies?name={name}

+ *

https://api.intercom.io/companies?company_id={company_id}

+ *

You can fetch all companies and filter by segment_id or tag_id as a query parameter.

+ *

https://api.intercom.io/companies?tag_id={tag_id}

+ *

https://api.intercom.io/companies?segment_id={segment_id}

+ */ + public CompletableFuture> retrieve() { + return retrieve(RetrieveCompanyRequest.builder().build()); + } + + /** + * You can fetch a single company by passing in company_id or name. + *

https://api.intercom.io/companies?name={name}

+ *

https://api.intercom.io/companies?company_id={company_id}

+ *

You can fetch all companies and filter by segment_id or tag_id as a query parameter.

+ *

https://api.intercom.io/companies?tag_id={tag_id}

+ *

https://api.intercom.io/companies?segment_id={segment_id}

+ */ + public CompletableFuture> retrieve(RetrieveCompanyRequest request) { + return retrieve(request, null); + } + + /** + * You can fetch a single company by passing in company_id or name. + *

https://api.intercom.io/companies?name={name}

+ *

https://api.intercom.io/companies?company_id={company_id}

+ *

You can fetch all companies and filter by segment_id or tag_id as a query parameter.

+ *

https://api.intercom.io/companies?tag_id={tag_id}

+ *

https://api.intercom.io/companies?segment_id={segment_id}

+ */ + public CompletableFuture> retrieve( + RetrieveCompanyRequest request, RequestOptions requestOptions) { + HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("companies"); + if (request.getName().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "name", request.getName().get(), false); + } + if (request.getCompanyId().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "company_id", request.getCompanyId().get(), false); + } + if (request.getTagId().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "tag_id", request.getTagId().get(), false); + } + if (request.getSegmentId().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "segment_id", request.getSegmentId().get(), false); + } + if (request.getPage().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "page", request.getPage().get(), false); + } + if (request.getPerPage().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "per_page", request.getPerPage().get(), false); + } + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl.build()) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue( + responseBodyString, CompaniesRetrieveResponse.class), + response)); + return; + } + try { + switch (response.code()) { + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 404: + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can create or update a company. + *

Companies will be only visible in Intercom when there is at least one associated user.

+ *

Companies are looked up via company_id in a POST request, if not found via company_id, the new company will be created, if found, that company will be updated.

+ *

{% admonition type="warning" name="Using company_id" %} + * You can set a unique company_id value when creating a company. However, it is not possible to update company_id. Be sure to set a unique value once upon creation of the company. + * {% /admonition %}

+ */ + public CompletableFuture> createOrUpdate() { + return createOrUpdate(Optional.empty()); + } + + /** + * You can create or update a company. + *

Companies will be only visible in Intercom when there is at least one associated user.

+ *

Companies are looked up via company_id in a POST request, if not found via company_id, the new company will be created, if found, that company will be updated.

+ *

{% admonition type="warning" name="Using company_id" %} + * You can set a unique company_id value when creating a company. However, it is not possible to update company_id. Be sure to set a unique value once upon creation of the company. + * {% /admonition %}

+ */ + public CompletableFuture> createOrUpdate( + Optional request) { + return createOrUpdate(request, null); + } + + /** + * You can create or update a company. + *

Companies will be only visible in Intercom when there is at least one associated user.

+ *

Companies are looked up via company_id in a POST request, if not found via company_id, the new company will be created, if found, that company will be updated.

+ *

{% admonition type="warning" name="Using company_id" %} + * You can set a unique company_id value when creating a company. However, it is not possible to update company_id. Be sure to set a unique value once upon creation of the company. + * {% /admonition %}

+ */ + public CompletableFuture> createOrUpdate( + Optional request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("companies") + .build(); + RequestBody body; + try { + body = RequestBody.create("", null); + if (request.isPresent()) { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Company.class), response)); + return; + } + try { + switch (response.code()) { + case 400: + future.completeExceptionally(new BadRequestError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can fetch a single company. + */ + public CompletableFuture> find(FindCompanyRequest request) { + return find(request, null); + } + + /** + * You can fetch a single company. + */ + public CompletableFuture> find( + FindCompanyRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("companies") + .addPathSegment(request.getCompanyId()) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Company.class), response)); + return; + } + try { + switch (response.code()) { + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 404: + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can update a single company using the Intercom provisioned id. + *

{% admonition type="warning" name="Using company_id" %} + * When updating a company it is not possible to update company_id. This can only be set once upon creation of the company. + * {% /admonition %}

+ */ + public CompletableFuture> update(UpdateCompanyRequest request) { + return update(request, null); + } + + /** + * You can update a single company using the Intercom provisioned id. + *

{% admonition type="warning" name="Using company_id" %} + * When updating a company it is not possible to update company_id. This can only be set once upon creation of the company. + * {% /admonition %}

+ */ + public CompletableFuture> update( + UpdateCompanyRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("companies") + .addPathSegment(request.getCompanyId()) + .build(); + RequestBody body; + try { + body = RequestBody.create("", null); + if (request.getBody().isPresent()) { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes( + request.getBody().get()), + MediaTypes.APPLICATION_JSON); + } + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("PUT", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Company.class), response)); + return; + } + try { + switch (response.code()) { + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 404: + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can delete a single company. + */ + public CompletableFuture> delete(DeleteCompanyRequest request) { + return delete(request, null); + } + + /** + * You can delete a single company. + */ + public CompletableFuture> delete( + DeleteCompanyRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("companies") + .addPathSegment(request.getCompanyId()) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("DELETE", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, DeletedCompanyObject.class), + response)); + return; + } + try { + switch (response.code()) { + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 404: + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can fetch a list of all contacts that belong to a company. + */ + public CompletableFuture> listAttachedContacts( + ListAttachedContactsRequest request) { + return listAttachedContacts(request, null); + } + + /** + * You can fetch a list of all contacts that belong to a company. + */ + public CompletableFuture> listAttachedContacts( + ListAttachedContactsRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("companies") + .addPathSegment(request.getCompanyId()) + .addPathSegments("contacts") + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, CompanyAttachedContacts.class), + response)); + return; + } + try { + switch (response.code()) { + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 404: + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can fetch a list of all segments that belong to a company. + */ + public CompletableFuture> listAttachedSegments( + ListSegmentsAttachedToCompanyRequest request) { + return listAttachedSegments(request, null); + } + + /** + * You can fetch a list of all segments that belong to a company. + */ + public CompletableFuture> listAttachedSegments( + ListSegmentsAttachedToCompanyRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("companies") + .addPathSegment(request.getCompanyId()) + .addPathSegments("segments") + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, CompanyAttachedSegments.class), + response)); + return; + } + try { + switch (response.code()) { + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 404: + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can list companies. The company list is sorted by the last_request_at field and by default is ordered descending, most recently requested first. + *

Note that the API does not include companies who have no associated users in list responses.

+ *

When using the Companies endpoint and the pages object to iterate through the returned companies, there is a limit of 10,000 Companies that can be returned. If you need to list or iterate on more than 10,000 Companies, please use the Scroll API. + * {% admonition type="warning" name="Pagination" %} + * You can use pagination to limit the number of results returned. The default is 20 results per page. + * See the pagination section for more details on how to use the starting_after param. + * {% /admonition %}

+ */ + public CompletableFuture>> list() { + return list(ListCompaniesRequest.builder().build()); + } + + /** + * You can list companies. The company list is sorted by the last_request_at field and by default is ordered descending, most recently requested first. + *

Note that the API does not include companies who have no associated users in list responses.

+ *

When using the Companies endpoint and the pages object to iterate through the returned companies, there is a limit of 10,000 Companies that can be returned. If you need to list or iterate on more than 10,000 Companies, please use the Scroll API. + * {% admonition type="warning" name="Pagination" %} + * You can use pagination to limit the number of results returned. The default is 20 results per page. + * See the pagination section for more details on how to use the starting_after param. + * {% /admonition %}

+ */ + public CompletableFuture>> list(ListCompaniesRequest request) { + return list(request, null); + } + + /** + * You can list companies. The company list is sorted by the last_request_at field and by default is ordered descending, most recently requested first. + *

Note that the API does not include companies who have no associated users in list responses.

+ *

When using the Companies endpoint and the pages object to iterate through the returned companies, there is a limit of 10,000 Companies that can be returned. If you need to list or iterate on more than 10,000 Companies, please use the Scroll API. + * {% admonition type="warning" name="Pagination" %} + * You can use pagination to limit the number of results returned. The default is 20 results per page. + * See the pagination section for more details on how to use the starting_after param. + * {% /admonition %}

+ */ + public CompletableFuture>> list( + ListCompaniesRequest request, RequestOptions requestOptions) { + HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("companies/list"); + if (request.getPage().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "page", request.getPage().get(), false); + } + if (request.getPerPage().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "per_page", request.getPerPage().get(), false); + } + if (request.getOrder().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "order", request.getOrder().get(), false); + } + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl.build()) + .method("POST", RequestBody.create("", null)) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture>> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + CompanyList parsedResponse = + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, CompanyList.class); + int newPageNumber = request.getPage() + .map((Integer page) -> page + 1) + .orElse(1); + ListCompaniesRequest nextRequest = ListCompaniesRequest.builder() + .from(request) + .page(newPageNumber) + .build(); + List result = parsedResponse.getData().orElse(Collections.emptyList()); + future.complete(new IntercomHttpResponse<>( + new SyncPagingIterable(true, result, parsedResponse, () -> { + try { + return list(nextRequest, requestOptions) + .get() + .body(); + } catch (InterruptedException | ExecutionException e) { + throw new RuntimeException(e); + } + }), + response)); + return; + } + try { + if (response.code() == 401) { + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * The list all companies functionality does not work well for huge datasets, and can result in errors and performance problems when paging deeply. The Scroll API provides an efficient mechanism for iterating over all companies in a dataset. + *
    + *
  • Each app can only have 1 scroll open at a time. You'll get an error message if you try to have more than one open per app.
    • + *
  • If the scroll isn't used for 1 minute, it expires and calls with that scroll param will fail
    • + *
  • If the end of the scroll is reached, "companies" will be empty and the scroll parameter will expire
    • + *
+ *

{% admonition type="info" name="Scroll Parameter" %} + * You can get the first page of companies by simply sending a GET request to the scroll endpoint. + * For subsequent requests you will need to use the scroll parameter from the response. + * {% /admonition %} + * {% admonition type="danger" name="Scroll network timeouts" %} + * Since scroll is often used on large datasets network errors such as timeouts can be encountered. When this occurs you will see a HTTP 500 error with the following message: + * "Request failed due to an internal network error. Please restart the scroll operation." + * If this happens, you will need to restart your scroll query: It is not possible to continue from a specific point when using scroll. + * {% /admonition %}

+ */ + public CompletableFuture>> scroll() { + return scroll(ScrollCompaniesRequest.builder().build()); + } + + /** + * The list all companies functionality does not work well for huge datasets, and can result in errors and performance problems when paging deeply. The Scroll API provides an efficient mechanism for iterating over all companies in a dataset. + *
    + *
  • Each app can only have 1 scroll open at a time. You'll get an error message if you try to have more than one open per app.
    • + *
  • If the scroll isn't used for 1 minute, it expires and calls with that scroll param will fail
    • + *
  • If the end of the scroll is reached, "companies" will be empty and the scroll parameter will expire
    • + *
+ *

{% admonition type="info" name="Scroll Parameter" %} + * You can get the first page of companies by simply sending a GET request to the scroll endpoint. + * For subsequent requests you will need to use the scroll parameter from the response. + * {% /admonition %} + * {% admonition type="danger" name="Scroll network timeouts" %} + * Since scroll is often used on large datasets network errors such as timeouts can be encountered. When this occurs you will see a HTTP 500 error with the following message: + * "Request failed due to an internal network error. Please restart the scroll operation." + * If this happens, you will need to restart your scroll query: It is not possible to continue from a specific point when using scroll. + * {% /admonition %}

+ */ + public CompletableFuture>> scroll(ScrollCompaniesRequest request) { + return scroll(request, null); + } + + /** + * The list all companies functionality does not work well for huge datasets, and can result in errors and performance problems when paging deeply. The Scroll API provides an efficient mechanism for iterating over all companies in a dataset. + *
    + *
  • Each app can only have 1 scroll open at a time. You'll get an error message if you try to have more than one open per app.
    • + *
  • If the scroll isn't used for 1 minute, it expires and calls with that scroll param will fail
    • + *
  • If the end of the scroll is reached, "companies" will be empty and the scroll parameter will expire
    • + *
+ *

{% admonition type="info" name="Scroll Parameter" %} + * You can get the first page of companies by simply sending a GET request to the scroll endpoint. + * For subsequent requests you will need to use the scroll parameter from the response. + * {% /admonition %} + * {% admonition type="danger" name="Scroll network timeouts" %} + * Since scroll is often used on large datasets network errors such as timeouts can be encountered. When this occurs you will see a HTTP 500 error with the following message: + * "Request failed due to an internal network error. Please restart the scroll operation." + * If this happens, you will need to restart your scroll query: It is not possible to continue from a specific point when using scroll. + * {% /admonition %}

+ */ + public CompletableFuture>> scroll( + ScrollCompaniesRequest request, RequestOptions requestOptions) { + HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("companies/scroll"); + if (request.getScrollParam().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "scroll_param", request.getScrollParam().get(), false); + } + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl.build()) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture>> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + Optional parsedResponse = ObjectMappers.JSON_MAPPER.readValue( + responseBodyString, new TypeReference>() {}); + Optional startingAfter = parsedResponse.flatMap(CompanyScroll::getScrollParam); + ScrollCompaniesRequest nextRequest = ScrollCompaniesRequest.builder() + .from(request) + .scrollParam(startingAfter) + .build(); + List result = + parsedResponse.flatMap(CompanyScroll::getData).orElse(Collections.emptyList()); + future.complete(new IntercomHttpResponse<>( + new SyncPagingIterable( + startingAfter.isPresent(), result, parsedResponse, () -> { + try { + return scroll(nextRequest, requestOptions) + .get() + .body(); + } catch (InterruptedException | ExecutionException e) { + throw new RuntimeException(e); + } + }), + response)); + return; + } + try { + if (response.code() == 401) { + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can attach a company to a single contact. + */ + public CompletableFuture> attachContact(AttachContactToCompanyRequest request) { + return attachContact(request, null); + } + + /** + * You can attach a company to a single contact. + */ + public CompletableFuture> attachContact( + AttachContactToCompanyRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("contacts") + .addPathSegment(request.getContactId()) + .addPathSegments("companies") + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Company.class), response)); + return; + } + try { + switch (response.code()) { + case 400: + future.completeExceptionally(new BadRequestError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 404: + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can detach a company from a single contact. + */ + public CompletableFuture> detachContact(DetachContactFromCompanyRequest request) { + return detachContact(request, null); + } + + /** + * You can detach a company from a single contact. + */ + public CompletableFuture> detachContact( + DetachContactFromCompanyRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("contacts") + .addPathSegment(request.getContactId()) + .addPathSegments("companies") + .addPathSegment(request.getCompanyId()) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("DELETE", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Company.class), response)); + return; + } + try { + switch (response.code()) { + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 404: + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } +} diff --git a/src/main/java/com/intercom/api/resources/companies/CompaniesClient.java b/src/main/java/com/intercom/api/resources/companies/CompaniesClient.java new file mode 100644 index 00000000..d187543c --- /dev/null +++ b/src/main/java/com/intercom/api/resources/companies/CompaniesClient.java @@ -0,0 +1,323 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.companies; + +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.core.pagination.SyncPagingIterable; +import com.intercom.api.resources.companies.requests.AttachContactToCompanyRequest; +import com.intercom.api.resources.companies.requests.DeleteCompanyRequest; +import com.intercom.api.resources.companies.requests.DetachContactFromCompanyRequest; +import com.intercom.api.resources.companies.requests.FindCompanyRequest; +import com.intercom.api.resources.companies.requests.ListAttachedContactsRequest; +import com.intercom.api.resources.companies.requests.ListCompaniesRequest; +import com.intercom.api.resources.companies.requests.ListSegmentsAttachedToCompanyRequest; +import com.intercom.api.resources.companies.requests.RetrieveCompanyRequest; +import com.intercom.api.resources.companies.requests.ScrollCompaniesRequest; +import com.intercom.api.resources.companies.requests.UpdateCompanyRequest; +import com.intercom.api.resources.companies.types.CompaniesRetrieveResponse; +import com.intercom.api.resources.companies.types.Company; +import com.intercom.api.types.CompanyAttachedContacts; +import com.intercom.api.types.CompanyAttachedSegments; +import com.intercom.api.types.CreateOrUpdateCompanyRequest; +import com.intercom.api.types.DeletedCompanyObject; +import java.util.Optional; + +public class CompaniesClient { + protected final ClientOptions clientOptions; + + private final RawCompaniesClient rawClient; + + public CompaniesClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + this.rawClient = new RawCompaniesClient(clientOptions); + } + + /** + * Get responses with HTTP metadata like headers + */ + public RawCompaniesClient withRawResponse() { + return this.rawClient; + } + + /** + * You can fetch a single company by passing in company_id or name. + *

https://api.intercom.io/companies?name={name}

+ *

https://api.intercom.io/companies?company_id={company_id}

+ *

You can fetch all companies and filter by segment_id or tag_id as a query parameter.

+ *

https://api.intercom.io/companies?tag_id={tag_id}

+ *

https://api.intercom.io/companies?segment_id={segment_id}

+ */ + public CompaniesRetrieveResponse retrieve() { + return this.rawClient.retrieve().body(); + } + + /** + * You can fetch a single company by passing in company_id or name. + *

https://api.intercom.io/companies?name={name}

+ *

https://api.intercom.io/companies?company_id={company_id}

+ *

You can fetch all companies and filter by segment_id or tag_id as a query parameter.

+ *

https://api.intercom.io/companies?tag_id={tag_id}

+ *

https://api.intercom.io/companies?segment_id={segment_id}

+ */ + public CompaniesRetrieveResponse retrieve(RetrieveCompanyRequest request) { + return this.rawClient.retrieve(request).body(); + } + + /** + * You can fetch a single company by passing in company_id or name. + *

https://api.intercom.io/companies?name={name}

+ *

https://api.intercom.io/companies?company_id={company_id}

+ *

You can fetch all companies and filter by segment_id or tag_id as a query parameter.

+ *

https://api.intercom.io/companies?tag_id={tag_id}

+ *

https://api.intercom.io/companies?segment_id={segment_id}

+ */ + public CompaniesRetrieveResponse retrieve(RetrieveCompanyRequest request, RequestOptions requestOptions) { + return this.rawClient.retrieve(request, requestOptions).body(); + } + + /** + * You can create or update a company. + *

Companies will be only visible in Intercom when there is at least one associated user.

+ *

Companies are looked up via company_id in a POST request, if not found via company_id, the new company will be created, if found, that company will be updated.

+ *

{% admonition type="warning" name="Using company_id" %} + * You can set a unique company_id value when creating a company. However, it is not possible to update company_id. Be sure to set a unique value once upon creation of the company. + * {% /admonition %}

+ */ + public Company createOrUpdate() { + return this.rawClient.createOrUpdate().body(); + } + + /** + * You can create or update a company. + *

Companies will be only visible in Intercom when there is at least one associated user.

+ *

Companies are looked up via company_id in a POST request, if not found via company_id, the new company will be created, if found, that company will be updated.

+ *

{% admonition type="warning" name="Using company_id" %} + * You can set a unique company_id value when creating a company. However, it is not possible to update company_id. Be sure to set a unique value once upon creation of the company. + * {% /admonition %}

+ */ + public Company createOrUpdate(Optional request) { + return this.rawClient.createOrUpdate(request).body(); + } + + /** + * You can create or update a company. + *

Companies will be only visible in Intercom when there is at least one associated user.

+ *

Companies are looked up via company_id in a POST request, if not found via company_id, the new company will be created, if found, that company will be updated.

+ *

{% admonition type="warning" name="Using company_id" %} + * You can set a unique company_id value when creating a company. However, it is not possible to update company_id. Be sure to set a unique value once upon creation of the company. + * {% /admonition %}

+ */ + public Company createOrUpdate(Optional request, RequestOptions requestOptions) { + return this.rawClient.createOrUpdate(request, requestOptions).body(); + } + + /** + * You can fetch a single company. + */ + public Company find(FindCompanyRequest request) { + return this.rawClient.find(request).body(); + } + + /** + * You can fetch a single company. + */ + public Company find(FindCompanyRequest request, RequestOptions requestOptions) { + return this.rawClient.find(request, requestOptions).body(); + } + + /** + * You can update a single company using the Intercom provisioned id. + *

{% admonition type="warning" name="Using company_id" %} + * When updating a company it is not possible to update company_id. This can only be set once upon creation of the company. + * {% /admonition %}

+ */ + public Company update(UpdateCompanyRequest request) { + return this.rawClient.update(request).body(); + } + + /** + * You can update a single company using the Intercom provisioned id. + *

{% admonition type="warning" name="Using company_id" %} + * When updating a company it is not possible to update company_id. This can only be set once upon creation of the company. + * {% /admonition %}

+ */ + public Company update(UpdateCompanyRequest request, RequestOptions requestOptions) { + return this.rawClient.update(request, requestOptions).body(); + } + + /** + * You can delete a single company. + */ + public DeletedCompanyObject delete(DeleteCompanyRequest request) { + return this.rawClient.delete(request).body(); + } + + /** + * You can delete a single company. + */ + public DeletedCompanyObject delete(DeleteCompanyRequest request, RequestOptions requestOptions) { + return this.rawClient.delete(request, requestOptions).body(); + } + + /** + * You can fetch a list of all contacts that belong to a company. + */ + public CompanyAttachedContacts listAttachedContacts(ListAttachedContactsRequest request) { + return this.rawClient.listAttachedContacts(request).body(); + } + + /** + * You can fetch a list of all contacts that belong to a company. + */ + public CompanyAttachedContacts listAttachedContacts( + ListAttachedContactsRequest request, RequestOptions requestOptions) { + return this.rawClient.listAttachedContacts(request, requestOptions).body(); + } + + /** + * You can fetch a list of all segments that belong to a company. + */ + public CompanyAttachedSegments listAttachedSegments(ListSegmentsAttachedToCompanyRequest request) { + return this.rawClient.listAttachedSegments(request).body(); + } + + /** + * You can fetch a list of all segments that belong to a company. + */ + public CompanyAttachedSegments listAttachedSegments( + ListSegmentsAttachedToCompanyRequest request, RequestOptions requestOptions) { + return this.rawClient.listAttachedSegments(request, requestOptions).body(); + } + + /** + * You can list companies. The company list is sorted by the last_request_at field and by default is ordered descending, most recently requested first. + *

Note that the API does not include companies who have no associated users in list responses.

+ *

When using the Companies endpoint and the pages object to iterate through the returned companies, there is a limit of 10,000 Companies that can be returned. If you need to list or iterate on more than 10,000 Companies, please use the Scroll API. + * {% admonition type="warning" name="Pagination" %} + * You can use pagination to limit the number of results returned. The default is 20 results per page. + * See the pagination section for more details on how to use the starting_after param. + * {% /admonition %}

+ */ + public SyncPagingIterable list() { + return this.rawClient.list().body(); + } + + /** + * You can list companies. The company list is sorted by the last_request_at field and by default is ordered descending, most recently requested first. + *

Note that the API does not include companies who have no associated users in list responses.

+ *

When using the Companies endpoint and the pages object to iterate through the returned companies, there is a limit of 10,000 Companies that can be returned. If you need to list or iterate on more than 10,000 Companies, please use the Scroll API. + * {% admonition type="warning" name="Pagination" %} + * You can use pagination to limit the number of results returned. The default is 20 results per page. + * See the pagination section for more details on how to use the starting_after param. + * {% /admonition %}

+ */ + public SyncPagingIterable list(ListCompaniesRequest request) { + return this.rawClient.list(request).body(); + } + + /** + * You can list companies. The company list is sorted by the last_request_at field and by default is ordered descending, most recently requested first. + *

Note that the API does not include companies who have no associated users in list responses.

+ *

When using the Companies endpoint and the pages object to iterate through the returned companies, there is a limit of 10,000 Companies that can be returned. If you need to list or iterate on more than 10,000 Companies, please use the Scroll API. + * {% admonition type="warning" name="Pagination" %} + * You can use pagination to limit the number of results returned. The default is 20 results per page. + * See the pagination section for more details on how to use the starting_after param. + * {% /admonition %}

+ */ + public SyncPagingIterable list(ListCompaniesRequest request, RequestOptions requestOptions) { + return this.rawClient.list(request, requestOptions).body(); + } + + /** + * The list all companies functionality does not work well for huge datasets, and can result in errors and performance problems when paging deeply. The Scroll API provides an efficient mechanism for iterating over all companies in a dataset. + *
    + *
  • Each app can only have 1 scroll open at a time. You'll get an error message if you try to have more than one open per app.
    • + *
  • If the scroll isn't used for 1 minute, it expires and calls with that scroll param will fail
    • + *
  • If the end of the scroll is reached, "companies" will be empty and the scroll parameter will expire
    • + *
+ *

{% admonition type="info" name="Scroll Parameter" %} + * You can get the first page of companies by simply sending a GET request to the scroll endpoint. + * For subsequent requests you will need to use the scroll parameter from the response. + * {% /admonition %} + * {% admonition type="danger" name="Scroll network timeouts" %} + * Since scroll is often used on large datasets network errors such as timeouts can be encountered. When this occurs you will see a HTTP 500 error with the following message: + * "Request failed due to an internal network error. Please restart the scroll operation." + * If this happens, you will need to restart your scroll query: It is not possible to continue from a specific point when using scroll. + * {% /admonition %}

+ */ + public SyncPagingIterable scroll() { + return this.rawClient.scroll().body(); + } + + /** + * The list all companies functionality does not work well for huge datasets, and can result in errors and performance problems when paging deeply. The Scroll API provides an efficient mechanism for iterating over all companies in a dataset. + *
    + *
  • Each app can only have 1 scroll open at a time. You'll get an error message if you try to have more than one open per app.
    • + *
  • If the scroll isn't used for 1 minute, it expires and calls with that scroll param will fail
    • + *
  • If the end of the scroll is reached, "companies" will be empty and the scroll parameter will expire
    • + *
+ *

{% admonition type="info" name="Scroll Parameter" %} + * You can get the first page of companies by simply sending a GET request to the scroll endpoint. + * For subsequent requests you will need to use the scroll parameter from the response. + * {% /admonition %} + * {% admonition type="danger" name="Scroll network timeouts" %} + * Since scroll is often used on large datasets network errors such as timeouts can be encountered. When this occurs you will see a HTTP 500 error with the following message: + * "Request failed due to an internal network error. Please restart the scroll operation." + * If this happens, you will need to restart your scroll query: It is not possible to continue from a specific point when using scroll. + * {% /admonition %}

+ */ + public SyncPagingIterable scroll(ScrollCompaniesRequest request) { + return this.rawClient.scroll(request).body(); + } + + /** + * The list all companies functionality does not work well for huge datasets, and can result in errors and performance problems when paging deeply. The Scroll API provides an efficient mechanism for iterating over all companies in a dataset. + *
    + *
  • Each app can only have 1 scroll open at a time. You'll get an error message if you try to have more than one open per app.
    • + *
  • If the scroll isn't used for 1 minute, it expires and calls with that scroll param will fail
    • + *
  • If the end of the scroll is reached, "companies" will be empty and the scroll parameter will expire
    • + *
+ *

{% admonition type="info" name="Scroll Parameter" %} + * You can get the first page of companies by simply sending a GET request to the scroll endpoint. + * For subsequent requests you will need to use the scroll parameter from the response. + * {% /admonition %} + * {% admonition type="danger" name="Scroll network timeouts" %} + * Since scroll is often used on large datasets network errors such as timeouts can be encountered. When this occurs you will see a HTTP 500 error with the following message: + * "Request failed due to an internal network error. Please restart the scroll operation." + * If this happens, you will need to restart your scroll query: It is not possible to continue from a specific point when using scroll. + * {% /admonition %}

+ */ + public SyncPagingIterable scroll(ScrollCompaniesRequest request, RequestOptions requestOptions) { + return this.rawClient.scroll(request, requestOptions).body(); + } + + /** + * You can attach a company to a single contact. + */ + public Company attachContact(AttachContactToCompanyRequest request) { + return this.rawClient.attachContact(request).body(); + } + + /** + * You can attach a company to a single contact. + */ + public Company attachContact(AttachContactToCompanyRequest request, RequestOptions requestOptions) { + return this.rawClient.attachContact(request, requestOptions).body(); + } + + /** + * You can detach a company from a single contact. + */ + public Company detachContact(DetachContactFromCompanyRequest request) { + return this.rawClient.detachContact(request).body(); + } + + /** + * You can detach a company from a single contact. + */ + public Company detachContact(DetachContactFromCompanyRequest request, RequestOptions requestOptions) { + return this.rawClient.detachContact(request, requestOptions).body(); + } +} diff --git a/src/main/java/com/intercom/api/resources/companies/RawCompaniesClient.java b/src/main/java/com/intercom/api/resources/companies/RawCompaniesClient.java new file mode 100644 index 00000000..91a4f905 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/companies/RawCompaniesClient.java @@ -0,0 +1,865 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.companies; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.fasterxml.jackson.core.type.TypeReference; +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.IntercomApiException; +import com.intercom.api.core.IntercomException; +import com.intercom.api.core.IntercomHttpResponse; +import com.intercom.api.core.MediaTypes; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.core.QueryStringMapper; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.core.pagination.SyncPagingIterable; +import com.intercom.api.errors.BadRequestError; +import com.intercom.api.errors.NotFoundError; +import com.intercom.api.errors.UnauthorizedError; +import com.intercom.api.resources.companies.requests.AttachContactToCompanyRequest; +import com.intercom.api.resources.companies.requests.DeleteCompanyRequest; +import com.intercom.api.resources.companies.requests.DetachContactFromCompanyRequest; +import com.intercom.api.resources.companies.requests.FindCompanyRequest; +import com.intercom.api.resources.companies.requests.ListAttachedContactsRequest; +import com.intercom.api.resources.companies.requests.ListCompaniesRequest; +import com.intercom.api.resources.companies.requests.ListSegmentsAttachedToCompanyRequest; +import com.intercom.api.resources.companies.requests.RetrieveCompanyRequest; +import com.intercom.api.resources.companies.requests.ScrollCompaniesRequest; +import com.intercom.api.resources.companies.requests.UpdateCompanyRequest; +import com.intercom.api.resources.companies.types.CompaniesRetrieveResponse; +import com.intercom.api.resources.companies.types.Company; +import com.intercom.api.types.CompanyAttachedContacts; +import com.intercom.api.types.CompanyAttachedSegments; +import com.intercom.api.types.CompanyList; +import com.intercom.api.types.CompanyScroll; +import com.intercom.api.types.CreateOrUpdateCompanyRequest; +import com.intercom.api.types.DeletedCompanyObject; +import com.intercom.api.types.Error; +import java.io.IOException; +import java.util.Collections; +import java.util.List; +import java.util.Optional; +import okhttp3.Headers; +import okhttp3.HttpUrl; +import okhttp3.OkHttpClient; +import okhttp3.Request; +import okhttp3.RequestBody; +import okhttp3.Response; +import okhttp3.ResponseBody; + +public class RawCompaniesClient { + protected final ClientOptions clientOptions; + + public RawCompaniesClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + } + + /** + * You can fetch a single company by passing in company_id or name. + *

https://api.intercom.io/companies?name={name}

+ *

https://api.intercom.io/companies?company_id={company_id}

+ *

You can fetch all companies and filter by segment_id or tag_id as a query parameter.

+ *

https://api.intercom.io/companies?tag_id={tag_id}

+ *

https://api.intercom.io/companies?segment_id={segment_id}

+ */ + public IntercomHttpResponse retrieve() { + return retrieve(RetrieveCompanyRequest.builder().build()); + } + + /** + * You can fetch a single company by passing in company_id or name. + *

https://api.intercom.io/companies?name={name}

+ *

https://api.intercom.io/companies?company_id={company_id}

+ *

You can fetch all companies and filter by segment_id or tag_id as a query parameter.

+ *

https://api.intercom.io/companies?tag_id={tag_id}

+ *

https://api.intercom.io/companies?segment_id={segment_id}

+ */ + public IntercomHttpResponse retrieve(RetrieveCompanyRequest request) { + return retrieve(request, null); + } + + /** + * You can fetch a single company by passing in company_id or name. + *

https://api.intercom.io/companies?name={name}

+ *

https://api.intercom.io/companies?company_id={company_id}

+ *

You can fetch all companies and filter by segment_id or tag_id as a query parameter.

+ *

https://api.intercom.io/companies?tag_id={tag_id}

+ *

https://api.intercom.io/companies?segment_id={segment_id}

+ */ + public IntercomHttpResponse retrieve( + RetrieveCompanyRequest request, RequestOptions requestOptions) { + HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("companies"); + if (request.getName().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "name", request.getName().get(), false); + } + if (request.getCompanyId().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "company_id", request.getCompanyId().get(), false); + } + if (request.getTagId().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "tag_id", request.getTagId().get(), false); + } + if (request.getSegmentId().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "segment_id", request.getSegmentId().get(), false); + } + if (request.getPage().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "page", request.getPage().get(), false); + } + if (request.getPerPage().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "per_page", request.getPerPage().get(), false); + } + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl.build()) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, CompaniesRetrieveResponse.class), + response); + } + try { + switch (response.code()) { + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 404: + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can create or update a company. + *

Companies will be only visible in Intercom when there is at least one associated user.

+ *

Companies are looked up via company_id in a POST request, if not found via company_id, the new company will be created, if found, that company will be updated.

+ *

{% admonition type="warning" name="Using company_id" %} + * You can set a unique company_id value when creating a company. However, it is not possible to update company_id. Be sure to set a unique value once upon creation of the company. + * {% /admonition %}

+ */ + public IntercomHttpResponse createOrUpdate() { + return createOrUpdate(Optional.empty()); + } + + /** + * You can create or update a company. + *

Companies will be only visible in Intercom when there is at least one associated user.

+ *

Companies are looked up via company_id in a POST request, if not found via company_id, the new company will be created, if found, that company will be updated.

+ *

{% admonition type="warning" name="Using company_id" %} + * You can set a unique company_id value when creating a company. However, it is not possible to update company_id. Be sure to set a unique value once upon creation of the company. + * {% /admonition %}

+ */ + public IntercomHttpResponse createOrUpdate(Optional request) { + return createOrUpdate(request, null); + } + + /** + * You can create or update a company. + *

Companies will be only visible in Intercom when there is at least one associated user.

+ *

Companies are looked up via company_id in a POST request, if not found via company_id, the new company will be created, if found, that company will be updated.

+ *

{% admonition type="warning" name="Using company_id" %} + * You can set a unique company_id value when creating a company. However, it is not possible to update company_id. Be sure to set a unique value once upon creation of the company. + * {% /admonition %}

+ */ + public IntercomHttpResponse createOrUpdate( + Optional request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("companies") + .build(); + RequestBody body; + try { + body = RequestBody.create("", null); + if (request.isPresent()) { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Company.class), response); + } + try { + switch (response.code()) { + case 400: + throw new BadRequestError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can fetch a single company. + */ + public IntercomHttpResponse find(FindCompanyRequest request) { + return find(request, null); + } + + /** + * You can fetch a single company. + */ + public IntercomHttpResponse find(FindCompanyRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("companies") + .addPathSegment(request.getCompanyId()) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Company.class), response); + } + try { + switch (response.code()) { + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 404: + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can update a single company using the Intercom provisioned id. + *

{% admonition type="warning" name="Using company_id" %} + * When updating a company it is not possible to update company_id. This can only be set once upon creation of the company. + * {% /admonition %}

+ */ + public IntercomHttpResponse update(UpdateCompanyRequest request) { + return update(request, null); + } + + /** + * You can update a single company using the Intercom provisioned id. + *

{% admonition type="warning" name="Using company_id" %} + * When updating a company it is not possible to update company_id. This can only be set once upon creation of the company. + * {% /admonition %}

+ */ + public IntercomHttpResponse update(UpdateCompanyRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("companies") + .addPathSegment(request.getCompanyId()) + .build(); + RequestBody body; + try { + body = RequestBody.create("", null); + if (request.getBody().isPresent()) { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes( + request.getBody().get()), + MediaTypes.APPLICATION_JSON); + } + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("PUT", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Company.class), response); + } + try { + switch (response.code()) { + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 404: + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can delete a single company. + */ + public IntercomHttpResponse delete(DeleteCompanyRequest request) { + return delete(request, null); + } + + /** + * You can delete a single company. + */ + public IntercomHttpResponse delete( + DeleteCompanyRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("companies") + .addPathSegment(request.getCompanyId()) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("DELETE", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, DeletedCompanyObject.class), response); + } + try { + switch (response.code()) { + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 404: + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can fetch a list of all contacts that belong to a company. + */ + public IntercomHttpResponse listAttachedContacts(ListAttachedContactsRequest request) { + return listAttachedContacts(request, null); + } + + /** + * You can fetch a list of all contacts that belong to a company. + */ + public IntercomHttpResponse listAttachedContacts( + ListAttachedContactsRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("companies") + .addPathSegment(request.getCompanyId()) + .addPathSegments("contacts") + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, CompanyAttachedContacts.class), + response); + } + try { + switch (response.code()) { + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 404: + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can fetch a list of all segments that belong to a company. + */ + public IntercomHttpResponse listAttachedSegments( + ListSegmentsAttachedToCompanyRequest request) { + return listAttachedSegments(request, null); + } + + /** + * You can fetch a list of all segments that belong to a company. + */ + public IntercomHttpResponse listAttachedSegments( + ListSegmentsAttachedToCompanyRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("companies") + .addPathSegment(request.getCompanyId()) + .addPathSegments("segments") + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, CompanyAttachedSegments.class), + response); + } + try { + switch (response.code()) { + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 404: + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can list companies. The company list is sorted by the last_request_at field and by default is ordered descending, most recently requested first. + *

Note that the API does not include companies who have no associated users in list responses.

+ *

When using the Companies endpoint and the pages object to iterate through the returned companies, there is a limit of 10,000 Companies that can be returned. If you need to list or iterate on more than 10,000 Companies, please use the Scroll API. + * {% admonition type="warning" name="Pagination" %} + * You can use pagination to limit the number of results returned. The default is 20 results per page. + * See the pagination section for more details on how to use the starting_after param. + * {% /admonition %}

+ */ + public IntercomHttpResponse> list() { + return list(ListCompaniesRequest.builder().build()); + } + + /** + * You can list companies. The company list is sorted by the last_request_at field and by default is ordered descending, most recently requested first. + *

Note that the API does not include companies who have no associated users in list responses.

+ *

When using the Companies endpoint and the pages object to iterate through the returned companies, there is a limit of 10,000 Companies that can be returned. If you need to list or iterate on more than 10,000 Companies, please use the Scroll API. + * {% admonition type="warning" name="Pagination" %} + * You can use pagination to limit the number of results returned. The default is 20 results per page. + * See the pagination section for more details on how to use the starting_after param. + * {% /admonition %}

+ */ + public IntercomHttpResponse> list(ListCompaniesRequest request) { + return list(request, null); + } + + /** + * You can list companies. The company list is sorted by the last_request_at field and by default is ordered descending, most recently requested first. + *

Note that the API does not include companies who have no associated users in list responses.

+ *

When using the Companies endpoint and the pages object to iterate through the returned companies, there is a limit of 10,000 Companies that can be returned. If you need to list or iterate on more than 10,000 Companies, please use the Scroll API. + * {% admonition type="warning" name="Pagination" %} + * You can use pagination to limit the number of results returned. The default is 20 results per page. + * See the pagination section for more details on how to use the starting_after param. + * {% /admonition %}

+ */ + public IntercomHttpResponse> list( + ListCompaniesRequest request, RequestOptions requestOptions) { + HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("companies/list"); + if (request.getPage().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "page", request.getPage().get(), false); + } + if (request.getPerPage().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "per_page", request.getPerPage().get(), false); + } + if (request.getOrder().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "order", request.getOrder().get(), false); + } + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl.build()) + .method("POST", RequestBody.create("", null)) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + CompanyList parsedResponse = ObjectMappers.JSON_MAPPER.readValue(responseBodyString, CompanyList.class); + int newPageNumber = + request.getPage().map((Integer page) -> page + 1).orElse(1); + ListCompaniesRequest nextRequest = ListCompaniesRequest.builder() + .from(request) + .page(newPageNumber) + .build(); + List result = parsedResponse.getData().orElse(Collections.emptyList()); + return new IntercomHttpResponse<>( + new SyncPagingIterable( + true, result, parsedResponse, () -> list(nextRequest, requestOptions) + .body()), + response); + } + try { + if (response.code() == 401) { + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * The list all companies functionality does not work well for huge datasets, and can result in errors and performance problems when paging deeply. The Scroll API provides an efficient mechanism for iterating over all companies in a dataset. + *
    + *
  • Each app can only have 1 scroll open at a time. You'll get an error message if you try to have more than one open per app.
    • + *
  • If the scroll isn't used for 1 minute, it expires and calls with that scroll param will fail
    • + *
  • If the end of the scroll is reached, "companies" will be empty and the scroll parameter will expire
    • + *
+ *

{% admonition type="info" name="Scroll Parameter" %} + * You can get the first page of companies by simply sending a GET request to the scroll endpoint. + * For subsequent requests you will need to use the scroll parameter from the response. + * {% /admonition %} + * {% admonition type="danger" name="Scroll network timeouts" %} + * Since scroll is often used on large datasets network errors such as timeouts can be encountered. When this occurs you will see a HTTP 500 error with the following message: + * "Request failed due to an internal network error. Please restart the scroll operation." + * If this happens, you will need to restart your scroll query: It is not possible to continue from a specific point when using scroll. + * {% /admonition %}

+ */ + public IntercomHttpResponse> scroll() { + return scroll(ScrollCompaniesRequest.builder().build()); + } + + /** + * The list all companies functionality does not work well for huge datasets, and can result in errors and performance problems when paging deeply. The Scroll API provides an efficient mechanism for iterating over all companies in a dataset. + *
    + *
  • Each app can only have 1 scroll open at a time. You'll get an error message if you try to have more than one open per app.
    • + *
  • If the scroll isn't used for 1 minute, it expires and calls with that scroll param will fail
    • + *
  • If the end of the scroll is reached, "companies" will be empty and the scroll parameter will expire
    • + *
+ *

{% admonition type="info" name="Scroll Parameter" %} + * You can get the first page of companies by simply sending a GET request to the scroll endpoint. + * For subsequent requests you will need to use the scroll parameter from the response. + * {% /admonition %} + * {% admonition type="danger" name="Scroll network timeouts" %} + * Since scroll is often used on large datasets network errors such as timeouts can be encountered. When this occurs you will see a HTTP 500 error with the following message: + * "Request failed due to an internal network error. Please restart the scroll operation." + * If this happens, you will need to restart your scroll query: It is not possible to continue from a specific point when using scroll. + * {% /admonition %}

+ */ + public IntercomHttpResponse> scroll(ScrollCompaniesRequest request) { + return scroll(request, null); + } + + /** + * The list all companies functionality does not work well for huge datasets, and can result in errors and performance problems when paging deeply. The Scroll API provides an efficient mechanism for iterating over all companies in a dataset. + *
    + *
  • Each app can only have 1 scroll open at a time. You'll get an error message if you try to have more than one open per app.
    • + *
  • If the scroll isn't used for 1 minute, it expires and calls with that scroll param will fail
    • + *
  • If the end of the scroll is reached, "companies" will be empty and the scroll parameter will expire
    • + *
+ *

{% admonition type="info" name="Scroll Parameter" %} + * You can get the first page of companies by simply sending a GET request to the scroll endpoint. + * For subsequent requests you will need to use the scroll parameter from the response. + * {% /admonition %} + * {% admonition type="danger" name="Scroll network timeouts" %} + * Since scroll is often used on large datasets network errors such as timeouts can be encountered. When this occurs you will see a HTTP 500 error with the following message: + * "Request failed due to an internal network error. Please restart the scroll operation." + * If this happens, you will need to restart your scroll query: It is not possible to continue from a specific point when using scroll. + * {% /admonition %}

+ */ + public IntercomHttpResponse> scroll( + ScrollCompaniesRequest request, RequestOptions requestOptions) { + HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("companies/scroll"); + if (request.getScrollParam().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "scroll_param", request.getScrollParam().get(), false); + } + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl.build()) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + Optional parsedResponse = ObjectMappers.JSON_MAPPER.readValue( + responseBodyString, new TypeReference>() {}); + Optional startingAfter = parsedResponse.flatMap(CompanyScroll::getScrollParam); + ScrollCompaniesRequest nextRequest = ScrollCompaniesRequest.builder() + .from(request) + .scrollParam(startingAfter) + .build(); + List result = + parsedResponse.flatMap(CompanyScroll::getData).orElse(Collections.emptyList()); + return new IntercomHttpResponse<>( + new SyncPagingIterable(startingAfter.isPresent(), result, parsedResponse, () -> scroll( + nextRequest, requestOptions) + .body()), + response); + } + try { + if (response.code() == 401) { + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can attach a company to a single contact. + */ + public IntercomHttpResponse attachContact(AttachContactToCompanyRequest request) { + return attachContact(request, null); + } + + /** + * You can attach a company to a single contact. + */ + public IntercomHttpResponse attachContact( + AttachContactToCompanyRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("contacts") + .addPathSegment(request.getContactId()) + .addPathSegments("companies") + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Company.class), response); + } + try { + switch (response.code()) { + case 400: + throw new BadRequestError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 404: + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can detach a company from a single contact. + */ + public IntercomHttpResponse detachContact(DetachContactFromCompanyRequest request) { + return detachContact(request, null); + } + + /** + * You can detach a company from a single contact. + */ + public IntercomHttpResponse detachContact( + DetachContactFromCompanyRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("contacts") + .addPathSegment(request.getContactId()) + .addPathSegments("companies") + .addPathSegment(request.getCompanyId()) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("DELETE", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Company.class), response); + } + try { + switch (response.code()) { + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 404: + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/companies/requests/AttachContactToCompanyRequest.java b/src/main/java/com/intercom/api/resources/companies/requests/AttachContactToCompanyRequest.java new file mode 100644 index 00000000..caa57557 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/companies/requests/AttachContactToCompanyRequest.java @@ -0,0 +1,147 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.companies.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = AttachContactToCompanyRequest.Builder.class) +public final class AttachContactToCompanyRequest { + private final String contactId; + + private final String companyId; + + private final Map additionalProperties; + + private AttachContactToCompanyRequest( + String contactId, String companyId, Map additionalProperties) { + this.contactId = contactId; + this.companyId = companyId; + this.additionalProperties = additionalProperties; + } + + /** + * @return The unique identifier for the contact which is given by Intercom + */ + @JsonProperty("contact_id") + public String getContactId() { + return contactId; + } + + /** + * @return The unique identifier for the company which is given by Intercom + */ + @JsonProperty("id") + public String getCompanyId() { + return companyId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof AttachContactToCompanyRequest && equalTo((AttachContactToCompanyRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(AttachContactToCompanyRequest other) { + return contactId.equals(other.contactId) && companyId.equals(other.companyId); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.contactId, this.companyId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static ContactIdStage builder() { + return new Builder(); + } + + public interface ContactIdStage { + /** + *

The unique identifier for the contact which is given by Intercom

+ */ + CompanyIdStage contactId(@NotNull String contactId); + + Builder from(AttachContactToCompanyRequest other); + } + + public interface CompanyIdStage { + /** + *

The unique identifier for the company which is given by Intercom

+ */ + _FinalStage companyId(@NotNull String companyId); + } + + public interface _FinalStage { + AttachContactToCompanyRequest build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements ContactIdStage, CompanyIdStage, _FinalStage { + private String contactId; + + private String companyId; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(AttachContactToCompanyRequest other) { + contactId(other.getContactId()); + companyId(other.getCompanyId()); + return this; + } + + /** + *

The unique identifier for the contact which is given by Intercom

+ *

The unique identifier for the contact which is given by Intercom

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("contact_id") + public CompanyIdStage contactId(@NotNull String contactId) { + this.contactId = Objects.requireNonNull(contactId, "contactId must not be null"); + return this; + } + + /** + *

The unique identifier for the company which is given by Intercom

+ *

The unique identifier for the company which is given by Intercom

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("id") + public _FinalStage companyId(@NotNull String companyId) { + this.companyId = Objects.requireNonNull(companyId, "companyId must not be null"); + return this; + } + + @java.lang.Override + public AttachContactToCompanyRequest build() { + return new AttachContactToCompanyRequest(contactId, companyId, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/companies/requests/DeleteCompanyRequest.java b/src/main/java/com/intercom/api/resources/companies/requests/DeleteCompanyRequest.java new file mode 100644 index 00000000..1a833e43 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/companies/requests/DeleteCompanyRequest.java @@ -0,0 +1,113 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.companies.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = DeleteCompanyRequest.Builder.class) +public final class DeleteCompanyRequest { + private final String companyId; + + private final Map additionalProperties; + + private DeleteCompanyRequest(String companyId, Map additionalProperties) { + this.companyId = companyId; + this.additionalProperties = additionalProperties; + } + + /** + * @return The unique identifier for the company which is given by Intercom + */ + @JsonProperty("company_id") + public String getCompanyId() { + return companyId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof DeleteCompanyRequest && equalTo((DeleteCompanyRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(DeleteCompanyRequest other) { + return companyId.equals(other.companyId); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.companyId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static CompanyIdStage builder() { + return new Builder(); + } + + public interface CompanyIdStage { + /** + *

The unique identifier for the company which is given by Intercom

+ */ + _FinalStage companyId(@NotNull String companyId); + + Builder from(DeleteCompanyRequest other); + } + + public interface _FinalStage { + DeleteCompanyRequest build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements CompanyIdStage, _FinalStage { + private String companyId; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(DeleteCompanyRequest other) { + companyId(other.getCompanyId()); + return this; + } + + /** + *

The unique identifier for the company which is given by Intercom

+ *

The unique identifier for the company which is given by Intercom

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("company_id") + public _FinalStage companyId(@NotNull String companyId) { + this.companyId = Objects.requireNonNull(companyId, "companyId must not be null"); + return this; + } + + @java.lang.Override + public DeleteCompanyRequest build() { + return new DeleteCompanyRequest(companyId, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/companies/requests/DetachContactFromCompanyRequest.java b/src/main/java/com/intercom/api/resources/companies/requests/DetachContactFromCompanyRequest.java new file mode 100644 index 00000000..46c5530b --- /dev/null +++ b/src/main/java/com/intercom/api/resources/companies/requests/DetachContactFromCompanyRequest.java @@ -0,0 +1,147 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.companies.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = DetachContactFromCompanyRequest.Builder.class) +public final class DetachContactFromCompanyRequest { + private final String contactId; + + private final String companyId; + + private final Map additionalProperties; + + private DetachContactFromCompanyRequest( + String contactId, String companyId, Map additionalProperties) { + this.contactId = contactId; + this.companyId = companyId; + this.additionalProperties = additionalProperties; + } + + /** + * @return The unique identifier for the contact which is given by Intercom + */ + @JsonProperty("contact_id") + public String getContactId() { + return contactId; + } + + /** + * @return The unique identifier for the company which is given by Intercom + */ + @JsonProperty("company_id") + public String getCompanyId() { + return companyId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof DetachContactFromCompanyRequest && equalTo((DetachContactFromCompanyRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(DetachContactFromCompanyRequest other) { + return contactId.equals(other.contactId) && companyId.equals(other.companyId); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.contactId, this.companyId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static ContactIdStage builder() { + return new Builder(); + } + + public interface ContactIdStage { + /** + *

The unique identifier for the contact which is given by Intercom

+ */ + CompanyIdStage contactId(@NotNull String contactId); + + Builder from(DetachContactFromCompanyRequest other); + } + + public interface CompanyIdStage { + /** + *

The unique identifier for the company which is given by Intercom

+ */ + _FinalStage companyId(@NotNull String companyId); + } + + public interface _FinalStage { + DetachContactFromCompanyRequest build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements ContactIdStage, CompanyIdStage, _FinalStage { + private String contactId; + + private String companyId; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(DetachContactFromCompanyRequest other) { + contactId(other.getContactId()); + companyId(other.getCompanyId()); + return this; + } + + /** + *

The unique identifier for the contact which is given by Intercom

+ *

The unique identifier for the contact which is given by Intercom

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("contact_id") + public CompanyIdStage contactId(@NotNull String contactId) { + this.contactId = Objects.requireNonNull(contactId, "contactId must not be null"); + return this; + } + + /** + *

The unique identifier for the company which is given by Intercom

+ *

The unique identifier for the company which is given by Intercom

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("company_id") + public _FinalStage companyId(@NotNull String companyId) { + this.companyId = Objects.requireNonNull(companyId, "companyId must not be null"); + return this; + } + + @java.lang.Override + public DetachContactFromCompanyRequest build() { + return new DetachContactFromCompanyRequest(contactId, companyId, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/companies/requests/FindCompanyRequest.java b/src/main/java/com/intercom/api/resources/companies/requests/FindCompanyRequest.java new file mode 100644 index 00000000..08408af8 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/companies/requests/FindCompanyRequest.java @@ -0,0 +1,113 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.companies.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = FindCompanyRequest.Builder.class) +public final class FindCompanyRequest { + private final String companyId; + + private final Map additionalProperties; + + private FindCompanyRequest(String companyId, Map additionalProperties) { + this.companyId = companyId; + this.additionalProperties = additionalProperties; + } + + /** + * @return The unique identifier for the company which is given by Intercom + */ + @JsonProperty("company_id") + public String getCompanyId() { + return companyId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof FindCompanyRequest && equalTo((FindCompanyRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(FindCompanyRequest other) { + return companyId.equals(other.companyId); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.companyId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static CompanyIdStage builder() { + return new Builder(); + } + + public interface CompanyIdStage { + /** + *

The unique identifier for the company which is given by Intercom

+ */ + _FinalStage companyId(@NotNull String companyId); + + Builder from(FindCompanyRequest other); + } + + public interface _FinalStage { + FindCompanyRequest build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements CompanyIdStage, _FinalStage { + private String companyId; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(FindCompanyRequest other) { + companyId(other.getCompanyId()); + return this; + } + + /** + *

The unique identifier for the company which is given by Intercom

+ *

The unique identifier for the company which is given by Intercom

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("company_id") + public _FinalStage companyId(@NotNull String companyId) { + this.companyId = Objects.requireNonNull(companyId, "companyId must not be null"); + return this; + } + + @java.lang.Override + public FindCompanyRequest build() { + return new FindCompanyRequest(companyId, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/companies/requests/ListAttachedContactsRequest.java b/src/main/java/com/intercom/api/resources/companies/requests/ListAttachedContactsRequest.java new file mode 100644 index 00000000..1dcb9e66 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/companies/requests/ListAttachedContactsRequest.java @@ -0,0 +1,113 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.companies.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = ListAttachedContactsRequest.Builder.class) +public final class ListAttachedContactsRequest { + private final String companyId; + + private final Map additionalProperties; + + private ListAttachedContactsRequest(String companyId, Map additionalProperties) { + this.companyId = companyId; + this.additionalProperties = additionalProperties; + } + + /** + * @return The unique identifier for the company which is given by Intercom + */ + @JsonProperty("company_id") + public String getCompanyId() { + return companyId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof ListAttachedContactsRequest && equalTo((ListAttachedContactsRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(ListAttachedContactsRequest other) { + return companyId.equals(other.companyId); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.companyId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static CompanyIdStage builder() { + return new Builder(); + } + + public interface CompanyIdStage { + /** + *

The unique identifier for the company which is given by Intercom

+ */ + _FinalStage companyId(@NotNull String companyId); + + Builder from(ListAttachedContactsRequest other); + } + + public interface _FinalStage { + ListAttachedContactsRequest build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements CompanyIdStage, _FinalStage { + private String companyId; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(ListAttachedContactsRequest other) { + companyId(other.getCompanyId()); + return this; + } + + /** + *

The unique identifier for the company which is given by Intercom

+ *

The unique identifier for the company which is given by Intercom

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("company_id") + public _FinalStage companyId(@NotNull String companyId) { + this.companyId = Objects.requireNonNull(companyId, "companyId must not be null"); + return this; + } + + @java.lang.Override + public ListAttachedContactsRequest build() { + return new ListAttachedContactsRequest(companyId, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/companies/requests/ListCompaniesRequest.java b/src/main/java/com/intercom/api/resources/companies/requests/ListCompaniesRequest.java new file mode 100644 index 00000000..bbb6b4c8 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/companies/requests/ListCompaniesRequest.java @@ -0,0 +1,161 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.companies.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = ListCompaniesRequest.Builder.class) +public final class ListCompaniesRequest { + private final Optional page; + + private final Optional perPage; + + private final Optional order; + + private final Map additionalProperties; + + private ListCompaniesRequest( + Optional page, + Optional perPage, + Optional order, + Map additionalProperties) { + this.page = page; + this.perPage = perPage; + this.order = order; + this.additionalProperties = additionalProperties; + } + + /** + * @return The page of results to fetch. Defaults to first page + */ + @JsonProperty("page") + public Optional getPage() { + return page; + } + + /** + * @return How many results to return per page. Defaults to 15 + */ + @JsonProperty("per_page") + public Optional getPerPage() { + return perPage; + } + + /** + * @return asc or desc. Return the companies in ascending or descending order. Defaults to desc + */ + @JsonProperty("order") + public Optional getOrder() { + return order; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof ListCompaniesRequest && equalTo((ListCompaniesRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(ListCompaniesRequest other) { + return page.equals(other.page) && perPage.equals(other.perPage) && order.equals(other.order); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.page, this.perPage, this.order); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static Builder builder() { + return new Builder(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder { + private Optional page = Optional.empty(); + + private Optional perPage = Optional.empty(); + + private Optional order = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + public Builder from(ListCompaniesRequest other) { + page(other.getPage()); + perPage(other.getPerPage()); + order(other.getOrder()); + return this; + } + + /** + *

The page of results to fetch. Defaults to first page

+ */ + @JsonSetter(value = "page", nulls = Nulls.SKIP) + public Builder page(Optional page) { + this.page = page; + return this; + } + + public Builder page(Integer page) { + this.page = Optional.ofNullable(page); + return this; + } + + /** + *

How many results to return per page. Defaults to 15

+ */ + @JsonSetter(value = "per_page", nulls = Nulls.SKIP) + public Builder perPage(Optional perPage) { + this.perPage = perPage; + return this; + } + + public Builder perPage(Integer perPage) { + this.perPage = Optional.ofNullable(perPage); + return this; + } + + /** + *

asc or desc. Return the companies in ascending or descending order. Defaults to desc

+ */ + @JsonSetter(value = "order", nulls = Nulls.SKIP) + public Builder order(Optional order) { + this.order = order; + return this; + } + + public Builder order(String order) { + this.order = Optional.ofNullable(order); + return this; + } + + public ListCompaniesRequest build() { + return new ListCompaniesRequest(page, perPage, order, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/companies/requests/ListSegmentsAttachedToCompanyRequest.java b/src/main/java/com/intercom/api/resources/companies/requests/ListSegmentsAttachedToCompanyRequest.java new file mode 100644 index 00000000..37ea0c1b --- /dev/null +++ b/src/main/java/com/intercom/api/resources/companies/requests/ListSegmentsAttachedToCompanyRequest.java @@ -0,0 +1,114 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.companies.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = ListSegmentsAttachedToCompanyRequest.Builder.class) +public final class ListSegmentsAttachedToCompanyRequest { + private final String companyId; + + private final Map additionalProperties; + + private ListSegmentsAttachedToCompanyRequest(String companyId, Map additionalProperties) { + this.companyId = companyId; + this.additionalProperties = additionalProperties; + } + + /** + * @return The unique identifier for the company which is given by Intercom + */ + @JsonProperty("company_id") + public String getCompanyId() { + return companyId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof ListSegmentsAttachedToCompanyRequest + && equalTo((ListSegmentsAttachedToCompanyRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(ListSegmentsAttachedToCompanyRequest other) { + return companyId.equals(other.companyId); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.companyId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static CompanyIdStage builder() { + return new Builder(); + } + + public interface CompanyIdStage { + /** + *

The unique identifier for the company which is given by Intercom

+ */ + _FinalStage companyId(@NotNull String companyId); + + Builder from(ListSegmentsAttachedToCompanyRequest other); + } + + public interface _FinalStage { + ListSegmentsAttachedToCompanyRequest build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements CompanyIdStage, _FinalStage { + private String companyId; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(ListSegmentsAttachedToCompanyRequest other) { + companyId(other.getCompanyId()); + return this; + } + + /** + *

The unique identifier for the company which is given by Intercom

+ *

The unique identifier for the company which is given by Intercom

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("company_id") + public _FinalStage companyId(@NotNull String companyId) { + this.companyId = Objects.requireNonNull(companyId, "companyId must not be null"); + return this; + } + + @java.lang.Override + public ListSegmentsAttachedToCompanyRequest build() { + return new ListSegmentsAttachedToCompanyRequest(companyId, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/companies/requests/RetrieveCompanyRequest.java b/src/main/java/com/intercom/api/resources/companies/requests/RetrieveCompanyRequest.java new file mode 100644 index 00000000..ce0fc364 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/companies/requests/RetrieveCompanyRequest.java @@ -0,0 +1,253 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.companies.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = RetrieveCompanyRequest.Builder.class) +public final class RetrieveCompanyRequest { + private final Optional name; + + private final Optional companyId; + + private final Optional tagId; + + private final Optional segmentId; + + private final Optional page; + + private final Optional perPage; + + private final Map additionalProperties; + + private RetrieveCompanyRequest( + Optional name, + Optional companyId, + Optional tagId, + Optional segmentId, + Optional page, + Optional perPage, + Map additionalProperties) { + this.name = name; + this.companyId = companyId; + this.tagId = tagId; + this.segmentId = segmentId; + this.page = page; + this.perPage = perPage; + this.additionalProperties = additionalProperties; + } + + /** + * @return The name of the company to filter by. + */ + @JsonProperty("name") + public Optional getName() { + return name; + } + + /** + * @return The company_id of the company to filter by. + */ + @JsonProperty("company_id") + public Optional getCompanyId() { + return companyId; + } + + /** + * @return The tag_id of the company to filter by. + */ + @JsonProperty("tag_id") + public Optional getTagId() { + return tagId; + } + + /** + * @return The segment_id of the company to filter by. + */ + @JsonProperty("segment_id") + public Optional getSegmentId() { + return segmentId; + } + + /** + * @return The page of results to fetch. Defaults to first page + */ + @JsonProperty("page") + public Optional getPage() { + return page; + } + + /** + * @return How many results to display per page. Defaults to 15 + */ + @JsonProperty("per_page") + public Optional getPerPage() { + return perPage; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof RetrieveCompanyRequest && equalTo((RetrieveCompanyRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(RetrieveCompanyRequest other) { + return name.equals(other.name) + && companyId.equals(other.companyId) + && tagId.equals(other.tagId) + && segmentId.equals(other.segmentId) + && page.equals(other.page) + && perPage.equals(other.perPage); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.name, this.companyId, this.tagId, this.segmentId, this.page, this.perPage); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static Builder builder() { + return new Builder(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder { + private Optional name = Optional.empty(); + + private Optional companyId = Optional.empty(); + + private Optional tagId = Optional.empty(); + + private Optional segmentId = Optional.empty(); + + private Optional page = Optional.empty(); + + private Optional perPage = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + public Builder from(RetrieveCompanyRequest other) { + name(other.getName()); + companyId(other.getCompanyId()); + tagId(other.getTagId()); + segmentId(other.getSegmentId()); + page(other.getPage()); + perPage(other.getPerPage()); + return this; + } + + /** + *

The name of the company to filter by.

+ */ + @JsonSetter(value = "name", nulls = Nulls.SKIP) + public Builder name(Optional name) { + this.name = name; + return this; + } + + public Builder name(String name) { + this.name = Optional.ofNullable(name); + return this; + } + + /** + *

The company_id of the company to filter by.

+ */ + @JsonSetter(value = "company_id", nulls = Nulls.SKIP) + public Builder companyId(Optional companyId) { + this.companyId = companyId; + return this; + } + + public Builder companyId(String companyId) { + this.companyId = Optional.ofNullable(companyId); + return this; + } + + /** + *

The tag_id of the company to filter by.

+ */ + @JsonSetter(value = "tag_id", nulls = Nulls.SKIP) + public Builder tagId(Optional tagId) { + this.tagId = tagId; + return this; + } + + public Builder tagId(String tagId) { + this.tagId = Optional.ofNullable(tagId); + return this; + } + + /** + *

The segment_id of the company to filter by.

+ */ + @JsonSetter(value = "segment_id", nulls = Nulls.SKIP) + public Builder segmentId(Optional segmentId) { + this.segmentId = segmentId; + return this; + } + + public Builder segmentId(String segmentId) { + this.segmentId = Optional.ofNullable(segmentId); + return this; + } + + /** + *

The page of results to fetch. Defaults to first page

+ */ + @JsonSetter(value = "page", nulls = Nulls.SKIP) + public Builder page(Optional page) { + this.page = page; + return this; + } + + public Builder page(Integer page) { + this.page = Optional.ofNullable(page); + return this; + } + + /** + *

How many results to display per page. Defaults to 15

+ */ + @JsonSetter(value = "per_page", nulls = Nulls.SKIP) + public Builder perPage(Optional perPage) { + this.perPage = perPage; + return this; + } + + public Builder perPage(Integer perPage) { + this.perPage = Optional.ofNullable(perPage); + return this; + } + + public RetrieveCompanyRequest build() { + return new RetrieveCompanyRequest(name, companyId, tagId, segmentId, page, perPage, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/companies/requests/ScrollCompaniesRequest.java b/src/main/java/com/intercom/api/resources/companies/requests/ScrollCompaniesRequest.java new file mode 100644 index 00000000..3a5af942 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/companies/requests/ScrollCompaniesRequest.java @@ -0,0 +1,98 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.companies.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = ScrollCompaniesRequest.Builder.class) +public final class ScrollCompaniesRequest { + private final Optional scrollParam; + + private final Map additionalProperties; + + private ScrollCompaniesRequest(Optional scrollParam, Map additionalProperties) { + this.scrollParam = scrollParam; + this.additionalProperties = additionalProperties; + } + + /** + * @return + */ + @JsonProperty("scroll_param") + public Optional getScrollParam() { + return scrollParam; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof ScrollCompaniesRequest && equalTo((ScrollCompaniesRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(ScrollCompaniesRequest other) { + return scrollParam.equals(other.scrollParam); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.scrollParam); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static Builder builder() { + return new Builder(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder { + private Optional scrollParam = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + public Builder from(ScrollCompaniesRequest other) { + scrollParam(other.getScrollParam()); + return this; + } + + @JsonSetter(value = "scroll_param", nulls = Nulls.SKIP) + public Builder scrollParam(Optional scrollParam) { + this.scrollParam = scrollParam; + return this; + } + + public Builder scrollParam(String scrollParam) { + this.scrollParam = Optional.ofNullable(scrollParam); + return this; + } + + public ScrollCompaniesRequest build() { + return new ScrollCompaniesRequest(scrollParam, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/companies/requests/UpdateCompanyRequest.java b/src/main/java/com/intercom/api/resources/companies/requests/UpdateCompanyRequest.java new file mode 100644 index 00000000..ad679865 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/companies/requests/UpdateCompanyRequest.java @@ -0,0 +1,145 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.companies.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.types.UpdateCompanyRequestBody; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = UpdateCompanyRequest.Builder.class) +public final class UpdateCompanyRequest { + private final String companyId; + + private final Optional body; + + private final Map additionalProperties; + + private UpdateCompanyRequest( + String companyId, Optional body, Map additionalProperties) { + this.companyId = companyId; + this.body = body; + this.additionalProperties = additionalProperties; + } + + /** + * @return The unique identifier for the company which is given by Intercom + */ + @JsonProperty("company_id") + public String getCompanyId() { + return companyId; + } + + @JsonProperty("body") + public Optional getBody() { + return body; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof UpdateCompanyRequest && equalTo((UpdateCompanyRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(UpdateCompanyRequest other) { + return companyId.equals(other.companyId) && body.equals(other.body); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.companyId, this.body); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static CompanyIdStage builder() { + return new Builder(); + } + + public interface CompanyIdStage { + /** + *

The unique identifier for the company which is given by Intercom

+ */ + _FinalStage companyId(@NotNull String companyId); + + Builder from(UpdateCompanyRequest other); + } + + public interface _FinalStage { + UpdateCompanyRequest build(); + + _FinalStage body(Optional body); + + _FinalStage body(UpdateCompanyRequestBody body); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements CompanyIdStage, _FinalStage { + private String companyId; + + private Optional body = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(UpdateCompanyRequest other) { + companyId(other.getCompanyId()); + body(other.getBody()); + return this; + } + + /** + *

The unique identifier for the company which is given by Intercom

+ *

The unique identifier for the company which is given by Intercom

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("company_id") + public _FinalStage companyId(@NotNull String companyId) { + this.companyId = Objects.requireNonNull(companyId, "companyId must not be null"); + return this; + } + + @java.lang.Override + public _FinalStage body(UpdateCompanyRequestBody body) { + this.body = Optional.ofNullable(body); + return this; + } + + @java.lang.Override + @JsonSetter(value = "body", nulls = Nulls.SKIP) + public _FinalStage body(Optional body) { + this.body = body; + return this; + } + + @java.lang.Override + public UpdateCompanyRequest build() { + return new UpdateCompanyRequest(companyId, body, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/companies/types/CompaniesRetrieveResponse.java b/src/main/java/com/intercom/api/resources/companies/types/CompaniesRetrieveResponse.java new file mode 100644 index 00000000..80242a39 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/companies/types/CompaniesRetrieveResponse.java @@ -0,0 +1,204 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.companies.types; + +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSubTypes; +import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonUnwrapped; +import com.fasterxml.jackson.annotation.JsonValue; +import com.intercom.api.types.CompanyList; +import java.util.Objects; +import java.util.Optional; + +public final class CompaniesRetrieveResponse { + private final Value value; + + @JsonCreator(mode = JsonCreator.Mode.DELEGATING) + private CompaniesRetrieveResponse(Value value) { + this.value = value; + } + + public T visit(Visitor visitor) { + return value.visit(visitor); + } + + public static CompaniesRetrieveResponse company(Company value) { + return new CompaniesRetrieveResponse(new CompanyValue(value)); + } + + public static CompaniesRetrieveResponse list(CompanyList value) { + return new CompaniesRetrieveResponse(new ListValue(value)); + } + + public boolean isCompany() { + return value instanceof CompanyValue; + } + + public boolean isList() { + return value instanceof ListValue; + } + + public boolean _isUnknown() { + return value instanceof _UnknownValue; + } + + public Optional getCompany() { + if (isCompany()) { + return Optional.of(((CompanyValue) value).value); + } + return Optional.empty(); + } + + public Optional getList() { + if (isList()) { + return Optional.of(((ListValue) value).value); + } + return Optional.empty(); + } + + public Optional _getUnknown() { + if (_isUnknown()) { + return Optional.of(((_UnknownValue) value).value); + } + return Optional.empty(); + } + + @JsonValue + private Value getValue() { + return this.value; + } + + public interface Visitor { + T visitCompany(Company company); + + T visitList(CompanyList list); + + T _visitUnknown(Object unknownType); + } + + @JsonTypeInfo(use = JsonTypeInfo.Id.NAME, property = "type", visible = true, defaultImpl = _UnknownValue.class) + @JsonSubTypes({@JsonSubTypes.Type(CompanyValue.class), @JsonSubTypes.Type(ListValue.class)}) + @JsonIgnoreProperties(ignoreUnknown = true) + private interface Value { + T visit(Visitor visitor); + } + + @JsonTypeName("company") + @JsonIgnoreProperties("type") + private static final class CompanyValue implements Value { + @JsonUnwrapped + private Company value; + + @JsonCreator(mode = JsonCreator.Mode.PROPERTIES) + private CompanyValue() {} + + private CompanyValue(Company value) { + this.value = value; + } + + @java.lang.Override + public T visit(Visitor visitor) { + return visitor.visitCompany(value); + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof CompanyValue && equalTo((CompanyValue) other); + } + + private boolean equalTo(CompanyValue other) { + return value.equals(other.value); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.value); + } + + @java.lang.Override + public String toString() { + return "CompaniesRetrieveResponse{" + "value: " + value + "}"; + } + } + + @JsonTypeName("list") + @JsonIgnoreProperties("type") + private static final class ListValue implements Value { + @JsonUnwrapped + private CompanyList value; + + @JsonCreator(mode = JsonCreator.Mode.PROPERTIES) + private ListValue() {} + + private ListValue(CompanyList value) { + this.value = value; + } + + @java.lang.Override + public T visit(Visitor visitor) { + return visitor.visitList(value); + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof ListValue && equalTo((ListValue) other); + } + + private boolean equalTo(ListValue other) { + return value.equals(other.value); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.value); + } + + @java.lang.Override + public String toString() { + return "CompaniesRetrieveResponse{" + "value: " + value + "}"; + } + } + + @JsonIgnoreProperties("type") + private static final class _UnknownValue implements Value { + private String type; + + @JsonValue + private Object value; + + @JsonCreator(mode = JsonCreator.Mode.PROPERTIES) + private _UnknownValue(@JsonProperty("value") Object value) {} + + @java.lang.Override + public T visit(Visitor visitor) { + return visitor._visitUnknown(value); + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof _UnknownValue && equalTo((_UnknownValue) other); + } + + private boolean equalTo(_UnknownValue other) { + return type.equals(other.type) && value.equals(other.value); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.type, this.value); + } + + @java.lang.Override + public String toString() { + return "CompaniesRetrieveResponse{" + "type: " + type + ", value: " + value + "}"; + } + } +} diff --git a/src/main/java/com/intercom/api/resources/companies/types/Company.java b/src/main/java/com/intercom/api/resources/companies/types/Company.java new file mode 100644 index 00000000..d600dc0d --- /dev/null +++ b/src/main/java/com/intercom/api/resources/companies/types/Company.java @@ -0,0 +1,1219 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.companies.types; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.resources.segments.types.Segment; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = Company.Builder.class) +public final class Company { + private final Optional type; + + private final String id; + + private final String name; + + private final String appId; + + private final Optional plan; + + private final String companyId; + + private final Optional remoteCreatedAt; + + private final int createdAt; + + private final int updatedAt; + + private final Optional lastRequestAt; + + private final Optional size; + + private final Optional website; + + private final Optional industry; + + private final int monthlySpend; + + private final int sessionCount; + + private final int userCount; + + private final Optional> customAttributes; + + private final Optional tags; + + private final Optional segments; + + private final Map additionalProperties; + + private Company( + Optional type, + String id, + String name, + String appId, + Optional plan, + String companyId, + Optional remoteCreatedAt, + int createdAt, + int updatedAt, + Optional lastRequestAt, + Optional size, + Optional website, + Optional industry, + int monthlySpend, + int sessionCount, + int userCount, + Optional> customAttributes, + Optional tags, + Optional segments, + Map additionalProperties) { + this.type = type; + this.id = id; + this.name = name; + this.appId = appId; + this.plan = plan; + this.companyId = companyId; + this.remoteCreatedAt = remoteCreatedAt; + this.createdAt = createdAt; + this.updatedAt = updatedAt; + this.lastRequestAt = lastRequestAt; + this.size = size; + this.website = website; + this.industry = industry; + this.monthlySpend = monthlySpend; + this.sessionCount = sessionCount; + this.userCount = userCount; + this.customAttributes = customAttributes; + this.tags = tags; + this.segments = segments; + this.additionalProperties = additionalProperties; + } + + /** + * @return Value is company + */ + @JsonProperty("type") + public Optional getType() { + return type; + } + + /** + * @return The Intercom defined id representing the company. + */ + @JsonProperty("id") + public String getId() { + return id; + } + + /** + * @return The name of the company. + */ + @JsonProperty("name") + public String getName() { + return name; + } + + /** + * @return The Intercom defined code of the workspace the company is associated to. + */ + @JsonProperty("app_id") + public String getAppId() { + return appId; + } + + @JsonProperty("plan") + public Optional getPlan() { + return plan; + } + + /** + * @return The company id you have defined for the company. + */ + @JsonProperty("company_id") + public String getCompanyId() { + return companyId; + } + + /** + * @return The time the company was created by you. + */ + @JsonProperty("remote_created_at") + public Optional getRemoteCreatedAt() { + return remoteCreatedAt; + } + + /** + * @return The time the company was added in Intercom. + */ + @JsonProperty("created_at") + public int getCreatedAt() { + return createdAt; + } + + /** + * @return The last time the company was updated. + */ + @JsonProperty("updated_at") + public int getUpdatedAt() { + return updatedAt; + } + + /** + * @return The time the company last recorded making a request. + */ + @JsonProperty("last_request_at") + public Optional getLastRequestAt() { + return lastRequestAt; + } + + /** + * @return The number of employees in the company. + */ + @JsonProperty("size") + public Optional getSize() { + return size; + } + + /** + * @return The URL for the company website. + */ + @JsonProperty("website") + public Optional getWebsite() { + return website; + } + + /** + * @return The industry that the company operates in. + */ + @JsonProperty("industry") + public Optional getIndustry() { + return industry; + } + + /** + * @return How much revenue the company generates for your business. + */ + @JsonProperty("monthly_spend") + public int getMonthlySpend() { + return monthlySpend; + } + + /** + * @return How many sessions the company has recorded. + */ + @JsonProperty("session_count") + public int getSessionCount() { + return sessionCount; + } + + /** + * @return The number of users in the company. + */ + @JsonProperty("user_count") + public int getUserCount() { + return userCount; + } + + /** + * @return The custom attributes you have set on the company. + */ + @JsonProperty("custom_attributes") + public Optional> getCustomAttributes() { + return customAttributes; + } + + /** + * @return The list of tags associated with the company + */ + @JsonProperty("tags") + public Optional getTags() { + return tags; + } + + /** + * @return The list of segments associated with the company + */ + @JsonProperty("segments") + public Optional getSegments() { + return segments; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof Company && equalTo((Company) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(Company other) { + return type.equals(other.type) + && id.equals(other.id) + && name.equals(other.name) + && appId.equals(other.appId) + && plan.equals(other.plan) + && companyId.equals(other.companyId) + && remoteCreatedAt.equals(other.remoteCreatedAt) + && createdAt == other.createdAt + && updatedAt == other.updatedAt + && lastRequestAt.equals(other.lastRequestAt) + && size.equals(other.size) + && website.equals(other.website) + && industry.equals(other.industry) + && monthlySpend == other.monthlySpend + && sessionCount == other.sessionCount + && userCount == other.userCount + && customAttributes.equals(other.customAttributes) + && tags.equals(other.tags) + && segments.equals(other.segments); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash( + this.type, + this.id, + this.name, + this.appId, + this.plan, + this.companyId, + this.remoteCreatedAt, + this.createdAt, + this.updatedAt, + this.lastRequestAt, + this.size, + this.website, + this.industry, + this.monthlySpend, + this.sessionCount, + this.userCount, + this.customAttributes, + this.tags, + this.segments); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static IdStage builder() { + return new Builder(); + } + + public interface IdStage { + /** + *

The Intercom defined id representing the company.

+ */ + NameStage id(@NotNull String id); + + Builder from(Company other); + } + + public interface NameStage { + /** + *

The name of the company.

+ */ + AppIdStage name(@NotNull String name); + } + + public interface AppIdStage { + /** + *

The Intercom defined code of the workspace the company is associated to.

+ */ + CompanyIdStage appId(@NotNull String appId); + } + + public interface CompanyIdStage { + /** + *

The company id you have defined for the company.

+ */ + CreatedAtStage companyId(@NotNull String companyId); + } + + public interface CreatedAtStage { + /** + *

The time the company was added in Intercom.

+ */ + UpdatedAtStage createdAt(int createdAt); + } + + public interface UpdatedAtStage { + /** + *

The last time the company was updated.

+ */ + MonthlySpendStage updatedAt(int updatedAt); + } + + public interface MonthlySpendStage { + /** + *

How much revenue the company generates for your business.

+ */ + SessionCountStage monthlySpend(int monthlySpend); + } + + public interface SessionCountStage { + /** + *

How many sessions the company has recorded.

+ */ + UserCountStage sessionCount(int sessionCount); + } + + public interface UserCountStage { + /** + *

The number of users in the company.

+ */ + _FinalStage userCount(int userCount); + } + + public interface _FinalStage { + Company build(); + + /** + *

Value is company

+ */ + _FinalStage type(Optional type); + + _FinalStage type(String type); + + _FinalStage plan(Optional plan); + + _FinalStage plan(Plan plan); + + /** + *

The time the company was created by you.

+ */ + _FinalStage remoteCreatedAt(Optional remoteCreatedAt); + + _FinalStage remoteCreatedAt(Integer remoteCreatedAt); + + /** + *

The time the company last recorded making a request.

+ */ + _FinalStage lastRequestAt(Optional lastRequestAt); + + _FinalStage lastRequestAt(Integer lastRequestAt); + + /** + *

The number of employees in the company.

+ */ + _FinalStage size(Optional size); + + _FinalStage size(Integer size); + + /** + *

The URL for the company website.

+ */ + _FinalStage website(Optional website); + + _FinalStage website(String website); + + /** + *

The industry that the company operates in.

+ */ + _FinalStage industry(Optional industry); + + _FinalStage industry(String industry); + + /** + *

The custom attributes you have set on the company.

+ */ + _FinalStage customAttributes(Optional> customAttributes); + + _FinalStage customAttributes(Map customAttributes); + + /** + *

The list of tags associated with the company

+ */ + _FinalStage tags(Optional tags); + + _FinalStage tags(Tags tags); + + /** + *

The list of segments associated with the company

+ */ + _FinalStage segments(Optional segments); + + _FinalStage segments(Segments segments); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder + implements IdStage, + NameStage, + AppIdStage, + CompanyIdStage, + CreatedAtStage, + UpdatedAtStage, + MonthlySpendStage, + SessionCountStage, + UserCountStage, + _FinalStage { + private String id; + + private String name; + + private String appId; + + private String companyId; + + private int createdAt; + + private int updatedAt; + + private int monthlySpend; + + private int sessionCount; + + private int userCount; + + private Optional segments = Optional.empty(); + + private Optional tags = Optional.empty(); + + private Optional> customAttributes = Optional.empty(); + + private Optional industry = Optional.empty(); + + private Optional website = Optional.empty(); + + private Optional size = Optional.empty(); + + private Optional lastRequestAt = Optional.empty(); + + private Optional remoteCreatedAt = Optional.empty(); + + private Optional plan = Optional.empty(); + + private Optional type = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(Company other) { + type(other.getType()); + id(other.getId()); + name(other.getName()); + appId(other.getAppId()); + plan(other.getPlan()); + companyId(other.getCompanyId()); + remoteCreatedAt(other.getRemoteCreatedAt()); + createdAt(other.getCreatedAt()); + updatedAt(other.getUpdatedAt()); + lastRequestAt(other.getLastRequestAt()); + size(other.getSize()); + website(other.getWebsite()); + industry(other.getIndustry()); + monthlySpend(other.getMonthlySpend()); + sessionCount(other.getSessionCount()); + userCount(other.getUserCount()); + customAttributes(other.getCustomAttributes()); + tags(other.getTags()); + segments(other.getSegments()); + return this; + } + + /** + *

The Intercom defined id representing the company.

+ *

The Intercom defined id representing the company.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("id") + public NameStage id(@NotNull String id) { + this.id = Objects.requireNonNull(id, "id must not be null"); + return this; + } + + /** + *

The name of the company.

+ *

The name of the company.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("name") + public AppIdStage name(@NotNull String name) { + this.name = Objects.requireNonNull(name, "name must not be null"); + return this; + } + + /** + *

The Intercom defined code of the workspace the company is associated to.

+ *

The Intercom defined code of the workspace the company is associated to.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("app_id") + public CompanyIdStage appId(@NotNull String appId) { + this.appId = Objects.requireNonNull(appId, "appId must not be null"); + return this; + } + + /** + *

The company id you have defined for the company.

+ *

The company id you have defined for the company.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("company_id") + public CreatedAtStage companyId(@NotNull String companyId) { + this.companyId = Objects.requireNonNull(companyId, "companyId must not be null"); + return this; + } + + /** + *

The time the company was added in Intercom.

+ *

The time the company was added in Intercom.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("created_at") + public UpdatedAtStage createdAt(int createdAt) { + this.createdAt = createdAt; + return this; + } + + /** + *

The last time the company was updated.

+ *

The last time the company was updated.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("updated_at") + public MonthlySpendStage updatedAt(int updatedAt) { + this.updatedAt = updatedAt; + return this; + } + + /** + *

How much revenue the company generates for your business.

+ *

How much revenue the company generates for your business.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("monthly_spend") + public SessionCountStage monthlySpend(int monthlySpend) { + this.monthlySpend = monthlySpend; + return this; + } + + /** + *

How many sessions the company has recorded.

+ *

How many sessions the company has recorded.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("session_count") + public UserCountStage sessionCount(int sessionCount) { + this.sessionCount = sessionCount; + return this; + } + + /** + *

The number of users in the company.

+ *

The number of users in the company.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("user_count") + public _FinalStage userCount(int userCount) { + this.userCount = userCount; + return this; + } + + /** + *

The list of segments associated with the company

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage segments(Segments segments) { + this.segments = Optional.ofNullable(segments); + return this; + } + + /** + *

The list of segments associated with the company

+ */ + @java.lang.Override + @JsonSetter(value = "segments", nulls = Nulls.SKIP) + public _FinalStage segments(Optional segments) { + this.segments = segments; + return this; + } + + /** + *

The list of tags associated with the company

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage tags(Tags tags) { + this.tags = Optional.ofNullable(tags); + return this; + } + + /** + *

The list of tags associated with the company

+ */ + @java.lang.Override + @JsonSetter(value = "tags", nulls = Nulls.SKIP) + public _FinalStage tags(Optional tags) { + this.tags = tags; + return this; + } + + /** + *

The custom attributes you have set on the company.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage customAttributes(Map customAttributes) { + this.customAttributes = Optional.ofNullable(customAttributes); + return this; + } + + /** + *

The custom attributes you have set on the company.

+ */ + @java.lang.Override + @JsonSetter(value = "custom_attributes", nulls = Nulls.SKIP) + public _FinalStage customAttributes(Optional> customAttributes) { + this.customAttributes = customAttributes; + return this; + } + + /** + *

The industry that the company operates in.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage industry(String industry) { + this.industry = Optional.ofNullable(industry); + return this; + } + + /** + *

The industry that the company operates in.

+ */ + @java.lang.Override + @JsonSetter(value = "industry", nulls = Nulls.SKIP) + public _FinalStage industry(Optional industry) { + this.industry = industry; + return this; + } + + /** + *

The URL for the company website.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage website(String website) { + this.website = Optional.ofNullable(website); + return this; + } + + /** + *

The URL for the company website.

+ */ + @java.lang.Override + @JsonSetter(value = "website", nulls = Nulls.SKIP) + public _FinalStage website(Optional website) { + this.website = website; + return this; + } + + /** + *

The number of employees in the company.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage size(Integer size) { + this.size = Optional.ofNullable(size); + return this; + } + + /** + *

The number of employees in the company.

+ */ + @java.lang.Override + @JsonSetter(value = "size", nulls = Nulls.SKIP) + public _FinalStage size(Optional size) { + this.size = size; + return this; + } + + /** + *

The time the company last recorded making a request.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage lastRequestAt(Integer lastRequestAt) { + this.lastRequestAt = Optional.ofNullable(lastRequestAt); + return this; + } + + /** + *

The time the company last recorded making a request.

+ */ + @java.lang.Override + @JsonSetter(value = "last_request_at", nulls = Nulls.SKIP) + public _FinalStage lastRequestAt(Optional lastRequestAt) { + this.lastRequestAt = lastRequestAt; + return this; + } + + /** + *

The time the company was created by you.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage remoteCreatedAt(Integer remoteCreatedAt) { + this.remoteCreatedAt = Optional.ofNullable(remoteCreatedAt); + return this; + } + + /** + *

The time the company was created by you.

+ */ + @java.lang.Override + @JsonSetter(value = "remote_created_at", nulls = Nulls.SKIP) + public _FinalStage remoteCreatedAt(Optional remoteCreatedAt) { + this.remoteCreatedAt = remoteCreatedAt; + return this; + } + + @java.lang.Override + public _FinalStage plan(Plan plan) { + this.plan = Optional.ofNullable(plan); + return this; + } + + @java.lang.Override + @JsonSetter(value = "plan", nulls = Nulls.SKIP) + public _FinalStage plan(Optional plan) { + this.plan = plan; + return this; + } + + /** + *

Value is company

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage type(String type) { + this.type = Optional.ofNullable(type); + return this; + } + + /** + *

Value is company

+ */ + @java.lang.Override + @JsonSetter(value = "type", nulls = Nulls.SKIP) + public _FinalStage type(Optional type) { + this.type = type; + return this; + } + + @java.lang.Override + public Company build() { + return new Company( + type, + id, + name, + appId, + plan, + companyId, + remoteCreatedAt, + createdAt, + updatedAt, + lastRequestAt, + size, + website, + industry, + monthlySpend, + sessionCount, + userCount, + customAttributes, + tags, + segments, + additionalProperties); + } + } + + @JsonInclude(JsonInclude.Include.NON_ABSENT) + @JsonDeserialize(builder = Tags.Builder.class) + public static final class Tags { + private final Optional type; + + private final Optional> tags; + + private final Map additionalProperties; + + private Tags(Optional type, Optional> tags, Map additionalProperties) { + this.type = type; + this.tags = tags; + this.additionalProperties = additionalProperties; + } + + /** + * @return The type of the object + */ + @JsonProperty("type") + public Optional getType() { + return type; + } + + @JsonProperty("tags") + public Optional> getTags() { + return tags; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof Tags && equalTo((Tags) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(Tags other) { + return type.equals(other.type) && tags.equals(other.tags); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.type, this.tags); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static Builder builder() { + return new Builder(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder { + private Optional type = Optional.empty(); + + private Optional> tags = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + public Builder from(Tags other) { + type(other.getType()); + tags(other.getTags()); + return this; + } + + /** + *

The type of the object

+ */ + @JsonSetter(value = "type", nulls = Nulls.SKIP) + public Builder type(Optional type) { + this.type = type; + return this; + } + + public Builder type(String type) { + this.type = Optional.ofNullable(type); + return this; + } + + @JsonSetter(value = "tags", nulls = Nulls.SKIP) + public Builder tags(Optional> tags) { + this.tags = tags; + return this; + } + + public Builder tags(List tags) { + this.tags = Optional.ofNullable(tags); + return this; + } + + public Tags build() { + return new Tags(type, tags, additionalProperties); + } + } + } + + @JsonInclude(JsonInclude.Include.NON_ABSENT) + @JsonDeserialize(builder = Segments.Builder.class) + public static final class Segments { + private final Optional type; + + private final Optional> segments; + + private final Map additionalProperties; + + private Segments( + Optional type, Optional> segments, Map additionalProperties) { + this.type = type; + this.segments = segments; + this.additionalProperties = additionalProperties; + } + + /** + * @return The type of the object + */ + @JsonProperty("type") + public Optional getType() { + return type; + } + + @JsonProperty("segments") + public Optional> getSegments() { + return segments; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof Segments && equalTo((Segments) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(Segments other) { + return type.equals(other.type) && segments.equals(other.segments); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.type, this.segments); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static Builder builder() { + return new Builder(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder { + private Optional type = Optional.empty(); + + private Optional> segments = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + public Builder from(Segments other) { + type(other.getType()); + segments(other.getSegments()); + return this; + } + + /** + *

The type of the object

+ */ + @JsonSetter(value = "type", nulls = Nulls.SKIP) + public Builder type(Optional type) { + this.type = type; + return this; + } + + public Builder type(String type) { + this.type = Optional.ofNullable(type); + return this; + } + + @JsonSetter(value = "segments", nulls = Nulls.SKIP) + public Builder segments(Optional> segments) { + this.segments = segments; + return this; + } + + public Builder segments(List segments) { + this.segments = Optional.ofNullable(segments); + return this; + } + + public Segments build() { + return new Segments(type, segments, additionalProperties); + } + } + } + + @JsonInclude(JsonInclude.Include.NON_ABSENT) + @JsonDeserialize(builder = Plan.Builder.class) + public static final class Plan { + private final Optional type; + + private final Optional id; + + private final Optional name; + + private final Map additionalProperties; + + private Plan( + Optional type, + Optional id, + Optional name, + Map additionalProperties) { + this.type = type; + this.id = id; + this.name = name; + this.additionalProperties = additionalProperties; + } + + /** + * @return Value is always "plan" + */ + @JsonProperty("type") + public Optional getType() { + return type; + } + + /** + * @return The id of the plan + */ + @JsonProperty("id") + public Optional getId() { + return id; + } + + /** + * @return The name of the plan + */ + @JsonProperty("name") + public Optional getName() { + return name; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof Plan && equalTo((Plan) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(Plan other) { + return type.equals(other.type) && id.equals(other.id) && name.equals(other.name); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.type, this.id, this.name); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static Builder builder() { + return new Builder(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder { + private Optional type = Optional.empty(); + + private Optional id = Optional.empty(); + + private Optional name = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + public Builder from(Plan other) { + type(other.getType()); + id(other.getId()); + name(other.getName()); + return this; + } + + /** + *

Value is always "plan"

+ */ + @JsonSetter(value = "type", nulls = Nulls.SKIP) + public Builder type(Optional type) { + this.type = type; + return this; + } + + public Builder type(String type) { + this.type = Optional.ofNullable(type); + return this; + } + + /** + *

The id of the plan

+ */ + @JsonSetter(value = "id", nulls = Nulls.SKIP) + public Builder id(Optional id) { + this.id = id; + return this; + } + + public Builder id(String id) { + this.id = Optional.ofNullable(id); + return this; + } + + /** + *

The name of the plan

+ */ + @JsonSetter(value = "name", nulls = Nulls.SKIP) + public Builder name(Optional name) { + this.name = name; + return this; + } + + public Builder name(String name) { + this.name = Optional.ofNullable(name); + return this; + } + + public Plan build() { + return new Plan(type, id, name, additionalProperties); + } + } + } +} diff --git a/src/main/java/com/intercom/api/resources/contacts/AsyncContactsClient.java b/src/main/java/com/intercom/api/resources/contacts/AsyncContactsClient.java new file mode 100644 index 00000000..c9a28804 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/contacts/AsyncContactsClient.java @@ -0,0 +1,528 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.contacts; + +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.core.pagination.SyncPagingIterable; +import com.intercom.api.resources.companies.types.Company; +import com.intercom.api.resources.contacts.requests.ArchiveContactRequest; +import com.intercom.api.resources.contacts.requests.AttachSubscriptionToContactRequest; +import com.intercom.api.resources.contacts.requests.BlockContactRequest; +import com.intercom.api.resources.contacts.requests.DeleteContactRequest; +import com.intercom.api.resources.contacts.requests.DetachSubscriptionFromContactRequest; +import com.intercom.api.resources.contacts.requests.FindContactRequest; +import com.intercom.api.resources.contacts.requests.ListAttachedCompaniesRequest; +import com.intercom.api.resources.contacts.requests.ListAttachedSubscriptionsRequest; +import com.intercom.api.resources.contacts.requests.ListContactsRequest; +import com.intercom.api.resources.contacts.requests.ListSegmentsAttachedToContactRequest; +import com.intercom.api.resources.contacts.requests.ListTagsAttachedToContactRequest; +import com.intercom.api.resources.contacts.requests.MergeContactsRequest; +import com.intercom.api.resources.contacts.requests.ShowContactByExternalIdRequest; +import com.intercom.api.resources.contacts.requests.UnarchiveContactRequest; +import com.intercom.api.resources.contacts.requests.UpdateContactRequest; +import com.intercom.api.resources.contacts.types.Contact; +import com.intercom.api.resources.contacts.types.ContactsCreateResponse; +import com.intercom.api.resources.contacts.types.ContactsFindResponse; +import com.intercom.api.resources.contacts.types.ContactsMergeLeadInUserResponse; +import com.intercom.api.resources.contacts.types.ContactsUpdateResponse; +import com.intercom.api.resources.contacts.types.ShowContactByExternalIdResponse; +import com.intercom.api.resources.subscriptiontypes.types.SubscriptionType; +import com.intercom.api.types.ContactArchived; +import com.intercom.api.types.ContactBlocked; +import com.intercom.api.types.ContactDeleted; +import com.intercom.api.types.ContactSegments; +import com.intercom.api.types.ContactUnarchived; +import com.intercom.api.types.CreateContactRequest; +import com.intercom.api.types.SearchRequest; +import com.intercom.api.types.SubscriptionTypeList; +import com.intercom.api.types.TagList; +import java.util.concurrent.CompletableFuture; + +public class AsyncContactsClient { + protected final ClientOptions clientOptions; + + private final AsyncRawContactsClient rawClient; + + public AsyncContactsClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + this.rawClient = new AsyncRawContactsClient(clientOptions); + } + + /** + * Get responses with HTTP metadata like headers + */ + public AsyncRawContactsClient withRawResponse() { + return this.rawClient; + } + + /** + * You can fetch a list of companies that are associated to a contact. + */ + public CompletableFuture> listAttachedCompanies(ListAttachedCompaniesRequest request) { + return this.rawClient.listAttachedCompanies(request).thenApply(response -> response.body()); + } + + /** + * You can fetch a list of companies that are associated to a contact. + */ + public CompletableFuture> listAttachedCompanies( + ListAttachedCompaniesRequest request, RequestOptions requestOptions) { + return this.rawClient.listAttachedCompanies(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can fetch a list of segments that are associated to a contact. + */ + public CompletableFuture listAttachedSegments(ListSegmentsAttachedToContactRequest request) { + return this.rawClient.listAttachedSegments(request).thenApply(response -> response.body()); + } + + /** + * You can fetch a list of segments that are associated to a contact. + */ + public CompletableFuture listAttachedSegments( + ListSegmentsAttachedToContactRequest request, RequestOptions requestOptions) { + return this.rawClient.listAttachedSegments(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can fetch a list of subscription types that are attached to a contact. These can be subscriptions that a user has 'opted-in' to or has 'opted-out' from, depending on the subscription type. + * This will return a list of Subscription Type objects that the contact is associated with. + *

The data property will show a combined list of:

+ *

1.Opt-out subscription types that the user has opted-out from. + * 2.Opt-in subscription types that the user has opted-in to receiving.

+ */ + public CompletableFuture listAttachedSubscriptions(ListAttachedSubscriptionsRequest request) { + return this.rawClient.listAttachedSubscriptions(request).thenApply(response -> response.body()); + } + + /** + * You can fetch a list of subscription types that are attached to a contact. These can be subscriptions that a user has 'opted-in' to or has 'opted-out' from, depending on the subscription type. + * This will return a list of Subscription Type objects that the contact is associated with. + *

The data property will show a combined list of:

+ *

1.Opt-out subscription types that the user has opted-out from. + * 2.Opt-in subscription types that the user has opted-in to receiving.

+ */ + public CompletableFuture listAttachedSubscriptions( + ListAttachedSubscriptionsRequest request, RequestOptions requestOptions) { + return this.rawClient.listAttachedSubscriptions(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can add a specific subscription to a contact. In Intercom, we have two different subscription types based on user consent - opt-out and opt-in: + *

1.Attaching a contact to an opt-out subscription type will opt that user out from receiving messages related to that subscription type.

+ *

2.Attaching a contact to an opt-in subscription type will opt that user in to receiving messages related to that subscription type.

+ *

This will return a subscription type model for the subscription type that was added to the contact.

+ */ + public CompletableFuture attachSubscription(AttachSubscriptionToContactRequest request) { + return this.rawClient.attachSubscription(request).thenApply(response -> response.body()); + } + + /** + * You can add a specific subscription to a contact. In Intercom, we have two different subscription types based on user consent - opt-out and opt-in: + *

1.Attaching a contact to an opt-out subscription type will opt that user out from receiving messages related to that subscription type.

+ *

2.Attaching a contact to an opt-in subscription type will opt that user in to receiving messages related to that subscription type.

+ *

This will return a subscription type model for the subscription type that was added to the contact.

+ */ + public CompletableFuture attachSubscription( + AttachSubscriptionToContactRequest request, RequestOptions requestOptions) { + return this.rawClient.attachSubscription(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can remove a specific subscription from a contact. This will return a subscription type model for the subscription type that was removed from the contact. + */ + public CompletableFuture detachSubscription(DetachSubscriptionFromContactRequest request) { + return this.rawClient.detachSubscription(request).thenApply(response -> response.body()); + } + + /** + * You can remove a specific subscription from a contact. This will return a subscription type model for the subscription type that was removed from the contact. + */ + public CompletableFuture detachSubscription( + DetachSubscriptionFromContactRequest request, RequestOptions requestOptions) { + return this.rawClient.detachSubscription(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can fetch a list of all tags that are attached to a specific contact. + */ + public CompletableFuture listAttachedTags(ListTagsAttachedToContactRequest request) { + return this.rawClient.listAttachedTags(request).thenApply(response -> response.body()); + } + + /** + * You can fetch a list of all tags that are attached to a specific contact. + */ + public CompletableFuture listAttachedTags( + ListTagsAttachedToContactRequest request, RequestOptions requestOptions) { + return this.rawClient.listAttachedTags(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can fetch the details of a single contact. + */ + public CompletableFuture find(FindContactRequest request) { + return this.rawClient.find(request).thenApply(response -> response.body()); + } + + /** + * You can fetch the details of a single contact. + */ + public CompletableFuture find(FindContactRequest request, RequestOptions requestOptions) { + return this.rawClient.find(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can update an existing contact (ie. user or lead). + *

{% admonition type="info" %} + * This endpoint handles both contact updates and custom object associations.

+ *

See update a contact with an association to a custom object instance in the request/response examples to see the custom object association format. + * {% /admonition %}

+ */ + public CompletableFuture update(UpdateContactRequest request) { + return this.rawClient.update(request).thenApply(response -> response.body()); + } + + /** + * You can update an existing contact (ie. user or lead). + *

{% admonition type="info" %} + * This endpoint handles both contact updates and custom object associations.

+ *

See update a contact with an association to a custom object instance in the request/response examples to see the custom object association format. + * {% /admonition %}

+ */ + public CompletableFuture update( + UpdateContactRequest request, RequestOptions requestOptions) { + return this.rawClient.update(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can delete a single contact. + */ + public CompletableFuture delete(DeleteContactRequest request) { + return this.rawClient.delete(request).thenApply(response -> response.body()); + } + + /** + * You can delete a single contact. + */ + public CompletableFuture delete(DeleteContactRequest request, RequestOptions requestOptions) { + return this.rawClient.delete(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can merge a contact with a role of lead into a contact with a role of user. + */ + public CompletableFuture mergeLeadInUser() { + return this.rawClient.mergeLeadInUser().thenApply(response -> response.body()); + } + + /** + * You can merge a contact with a role of lead into a contact with a role of user. + */ + public CompletableFuture mergeLeadInUser(MergeContactsRequest request) { + return this.rawClient.mergeLeadInUser(request).thenApply(response -> response.body()); + } + + /** + * You can merge a contact with a role of lead into a contact with a role of user. + */ + public CompletableFuture mergeLeadInUser( + MergeContactsRequest request, RequestOptions requestOptions) { + return this.rawClient.mergeLeadInUser(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can search for multiple contacts by the value of their attributes in order to fetch exactly who you want. + *

To search for contacts, you need to send a POST request to https://api.intercom.io/contacts/search.

+ *

This will accept a query object in the body which will define your filters in order to search for contacts.

+ *

{% admonition type="warning" name="Optimizing search queries" %} + * Search queries can be complex, so optimizing them can help the performance of your search. + * Use the AND and OR operators to combine multiple filters to get the exact results you need and utilize + * pagination to limit the number of results returned. The default is 50 results per page. + * See the pagination section for more details on how to use the starting_after param. + * {% /admonition %}

+ *

Contact Creation Delay

+ *

If a contact has recently been created, there is a possibility that it will not yet be available when searching. This means that it may not appear in the response. This delay can take a few minutes. If you need to be instantly notified it is recommended to use webhooks and iterate to see if they match your search filters.

+ *

Nesting & Limitations

+ *

You can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4). + * There are some limitations to the amount of multiple's there can be:

+ *
    + *
  • There's a limit of max 2 nested filters
    • + *
  • There's a limit of max 15 filters for each AND or OR group
    • + *
+ *

Searching for Timestamp Fields

+ *

All timestamp fields (created_at, updated_at etc.) are indexed as Dates for Contact Search queries; Datetime queries are not currently supported. This means you can only query for timestamp fields by day - not hour, minute or second. + * For example, if you search for all Contacts with a created_at value greater (>) than 1577869200 (the UNIX timestamp for January 1st, 2020 9:00 AM), that will be interpreted as 1577836800 (January 1st, 2020 12:00 AM). The search results will then include Contacts created from January 2nd, 2020 12:00 AM onwards. + * If you'd like to get contacts created on January 1st, 2020 you should search with a created_at value equal (=) to 1577836800 (January 1st, 2020 12:00 AM). + * This behaviour applies only to timestamps used in search queries. The search results will still contain the full UNIX timestamp and be sorted accordingly.

+ *

Accepted Fields

+ *

Most key listed as part of the Contacts Model are searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as created_at accepts a date, the value cannot be a string such as "foorbar").

+ *

| Field | Type | + * | ---------------------------------- | ------------------------------ | + * | id | String | + * | role | String<br>Accepts user or lead | + * | name | String | + * | avatar | String | + * | owner_id | Integer | + * | email | String | + * | email_domain | String | + * | phone | String | + * | external_id | String | + * | created_at | Date (UNIX Timestamp) | + * | signed_up_at | Date (UNIX Timestamp) | + * | updated_at | Date (UNIX Timestamp) | + * | last_seen_at | Date (UNIX Timestamp) | + * | last_contacted_at | Date (UNIX Timestamp) | + * | last_replied_at | Date (UNIX Timestamp) | + * | last_email_opened_at | Date (UNIX Timestamp) | + * | last_email_clicked_at | Date (UNIX Timestamp) | + * | language_override | String | + * | browser | String | + * | browser_language | String | + * | os | String | + * | location.country | String | + * | location.region | String | + * | location.city | String | + * | unsubscribed_from_emails | Boolean | + * | marked_email_as_spam | Boolean | + * | has_hard_bounced | Boolean | + * | ios_last_seen_at | Date (UNIX Timestamp) | + * | ios_app_version | String | + * | ios_device | String | + * | ios_app_device | String | + * | ios_os_version | String | + * | ios_app_name | String | + * | ios_sdk_version | String | + * | android_last_seen_at | Date (UNIX Timestamp) | + * | android_app_version | String | + * | android_device | String | + * | android_app_name | String | + * | andoid_sdk_version | String | + * | segment_id | String | + * | tag_id | String | + * | custom_attributes.{attribute_name} | String |

+ *

Accepted Operators

+ *

{% admonition type="warning" name="Searching based on created_at" %} + * You cannot use the <= or >= operators to search by created_at. + * {% /admonition %}

+ *

The table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string ("="). The operator has to be compatible with the field's type (eg. you cannot search with > for a given string value as it's only compatible for integer's and dates).

+ *

| Operator | Valid Types | Description | + * | :------- | :------------------------------- | :--------------------------------------------------------------- | + * | = | All | Equals | + * | != | All | Doesn't Equal | + * | IN | All | In<br>Shortcut for OR queries<br>Values must be in Array | + * | NIN | All | Not In<br>Shortcut for OR ! queries<br>Values must be in Array | + * | > | Integer<br>Date (UNIX Timestamp) | Greater than | + * | < | Integer<br>Date (UNIX Timestamp) | Lower than | + * | ~ | String | Contains | + * | !~ | String | Doesn't Contain | + * | ^ | String | Starts With | + * | $ | String | Ends With |

+ */ + public CompletableFuture> search(SearchRequest request) { + return this.rawClient.search(request).thenApply(response -> response.body()); + } + + /** + * You can search for multiple contacts by the value of their attributes in order to fetch exactly who you want. + *

To search for contacts, you need to send a POST request to https://api.intercom.io/contacts/search.

+ *

This will accept a query object in the body which will define your filters in order to search for contacts.

+ *

{% admonition type="warning" name="Optimizing search queries" %} + * Search queries can be complex, so optimizing them can help the performance of your search. + * Use the AND and OR operators to combine multiple filters to get the exact results you need and utilize + * pagination to limit the number of results returned. The default is 50 results per page. + * See the pagination section for more details on how to use the starting_after param. + * {% /admonition %}

+ *

Contact Creation Delay

+ *

If a contact has recently been created, there is a possibility that it will not yet be available when searching. This means that it may not appear in the response. This delay can take a few minutes. If you need to be instantly notified it is recommended to use webhooks and iterate to see if they match your search filters.

+ *

Nesting & Limitations

+ *

You can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4). + * There are some limitations to the amount of multiple's there can be:

+ *
    + *
  • There's a limit of max 2 nested filters
    • + *
  • There's a limit of max 15 filters for each AND or OR group
    • + *
+ *

Searching for Timestamp Fields

+ *

All timestamp fields (created_at, updated_at etc.) are indexed as Dates for Contact Search queries; Datetime queries are not currently supported. This means you can only query for timestamp fields by day - not hour, minute or second. + * For example, if you search for all Contacts with a created_at value greater (>) than 1577869200 (the UNIX timestamp for January 1st, 2020 9:00 AM), that will be interpreted as 1577836800 (January 1st, 2020 12:00 AM). The search results will then include Contacts created from January 2nd, 2020 12:00 AM onwards. + * If you'd like to get contacts created on January 1st, 2020 you should search with a created_at value equal (=) to 1577836800 (January 1st, 2020 12:00 AM). + * This behaviour applies only to timestamps used in search queries. The search results will still contain the full UNIX timestamp and be sorted accordingly.

+ *

Accepted Fields

+ *

Most key listed as part of the Contacts Model are searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as created_at accepts a date, the value cannot be a string such as "foorbar").

+ *

| Field | Type | + * | ---------------------------------- | ------------------------------ | + * | id | String | + * | role | String<br>Accepts user or lead | + * | name | String | + * | avatar | String | + * | owner_id | Integer | + * | email | String | + * | email_domain | String | + * | phone | String | + * | external_id | String | + * | created_at | Date (UNIX Timestamp) | + * | signed_up_at | Date (UNIX Timestamp) | + * | updated_at | Date (UNIX Timestamp) | + * | last_seen_at | Date (UNIX Timestamp) | + * | last_contacted_at | Date (UNIX Timestamp) | + * | last_replied_at | Date (UNIX Timestamp) | + * | last_email_opened_at | Date (UNIX Timestamp) | + * | last_email_clicked_at | Date (UNIX Timestamp) | + * | language_override | String | + * | browser | String | + * | browser_language | String | + * | os | String | + * | location.country | String | + * | location.region | String | + * | location.city | String | + * | unsubscribed_from_emails | Boolean | + * | marked_email_as_spam | Boolean | + * | has_hard_bounced | Boolean | + * | ios_last_seen_at | Date (UNIX Timestamp) | + * | ios_app_version | String | + * | ios_device | String | + * | ios_app_device | String | + * | ios_os_version | String | + * | ios_app_name | String | + * | ios_sdk_version | String | + * | android_last_seen_at | Date (UNIX Timestamp) | + * | android_app_version | String | + * | android_device | String | + * | android_app_name | String | + * | andoid_sdk_version | String | + * | segment_id | String | + * | tag_id | String | + * | custom_attributes.{attribute_name} | String |

+ *

Accepted Operators

+ *

{% admonition type="warning" name="Searching based on created_at" %} + * You cannot use the <= or >= operators to search by created_at. + * {% /admonition %}

+ *

The table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string ("="). The operator has to be compatible with the field's type (eg. you cannot search with > for a given string value as it's only compatible for integer's and dates).

+ *

| Operator | Valid Types | Description | + * | :------- | :------------------------------- | :--------------------------------------------------------------- | + * | = | All | Equals | + * | != | All | Doesn't Equal | + * | IN | All | In<br>Shortcut for OR queries<br>Values must be in Array | + * | NIN | All | Not In<br>Shortcut for OR ! queries<br>Values must be in Array | + * | > | Integer<br>Date (UNIX Timestamp) | Greater than | + * | < | Integer<br>Date (UNIX Timestamp) | Lower than | + * | ~ | String | Contains | + * | !~ | String | Doesn't Contain | + * | ^ | String | Starts With | + * | $ | String | Ends With |

+ */ + public CompletableFuture> search(SearchRequest request, RequestOptions requestOptions) { + return this.rawClient.search(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can fetch a list of all contacts (ie. users or leads) in your workspace. + * {% admonition type="warning" name="Pagination" %} + * You can use pagination to limit the number of results returned. The default is 50 results per page. + * See the pagination section for more details on how to use the starting_after param. + * {% /admonition %} + */ + public CompletableFuture> list() { + return this.rawClient.list().thenApply(response -> response.body()); + } + + /** + * You can fetch a list of all contacts (ie. users or leads) in your workspace. + * {% admonition type="warning" name="Pagination" %} + * You can use pagination to limit the number of results returned. The default is 50 results per page. + * See the pagination section for more details on how to use the starting_after param. + * {% /admonition %} + */ + public CompletableFuture> list(ListContactsRequest request) { + return this.rawClient.list(request).thenApply(response -> response.body()); + } + + /** + * You can fetch a list of all contacts (ie. users or leads) in your workspace. + * {% admonition type="warning" name="Pagination" %} + * You can use pagination to limit the number of results returned. The default is 50 results per page. + * See the pagination section for more details on how to use the starting_after param. + * {% /admonition %} + */ + public CompletableFuture> list( + ListContactsRequest request, RequestOptions requestOptions) { + return this.rawClient.list(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can create a new contact (ie. user or lead). + */ + public CompletableFuture create(CreateContactRequest request) { + return this.rawClient.create(request).thenApply(response -> response.body()); + } + + /** + * You can create a new contact (ie. user or lead). + */ + public CompletableFuture create( + CreateContactRequest request, RequestOptions requestOptions) { + return this.rawClient.create(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can fetch the details of a single contact by external ID. Note that this endpoint only supports users and not leads. + */ + public CompletableFuture showContactByExternalId( + ShowContactByExternalIdRequest request) { + return this.rawClient.showContactByExternalId(request).thenApply(response -> response.body()); + } + + /** + * You can fetch the details of a single contact by external ID. Note that this endpoint only supports users and not leads. + */ + public CompletableFuture showContactByExternalId( + ShowContactByExternalIdRequest request, RequestOptions requestOptions) { + return this.rawClient.showContactByExternalId(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can archive a single contact. + */ + public CompletableFuture archive(ArchiveContactRequest request) { + return this.rawClient.archive(request).thenApply(response -> response.body()); + } + + /** + * You can archive a single contact. + */ + public CompletableFuture archive(ArchiveContactRequest request, RequestOptions requestOptions) { + return this.rawClient.archive(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can unarchive a single contact. + */ + public CompletableFuture unarchive(UnarchiveContactRequest request) { + return this.rawClient.unarchive(request).thenApply(response -> response.body()); + } + + /** + * You can unarchive a single contact. + */ + public CompletableFuture unarchive( + UnarchiveContactRequest request, RequestOptions requestOptions) { + return this.rawClient.unarchive(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * Block a single contact.<br>Note: conversations of the contact will also be archived during the process.<br>More details in FAQ How do I block Inbox spam? + */ + public CompletableFuture blockContact(BlockContactRequest request) { + return this.rawClient.blockContact(request).thenApply(response -> response.body()); + } + + /** + * Block a single contact.<br>Note: conversations of the contact will also be archived during the process.<br>More details in FAQ How do I block Inbox spam? + */ + public CompletableFuture blockContact(BlockContactRequest request, RequestOptions requestOptions) { + return this.rawClient.blockContact(request, requestOptions).thenApply(response -> response.body()); + } +} diff --git a/src/main/java/com/intercom/api/resources/contacts/AsyncRawContactsClient.java b/src/main/java/com/intercom/api/resources/contacts/AsyncRawContactsClient.java new file mode 100644 index 00000000..9a766257 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/contacts/AsyncRawContactsClient.java @@ -0,0 +1,1551 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.contacts; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.IntercomApiException; +import com.intercom.api.core.IntercomException; +import com.intercom.api.core.IntercomHttpResponse; +import com.intercom.api.core.MediaTypes; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.core.QueryStringMapper; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.core.pagination.SyncPagingIterable; +import com.intercom.api.errors.NotFoundError; +import com.intercom.api.errors.UnauthorizedError; +import com.intercom.api.resources.companies.types.Company; +import com.intercom.api.resources.contacts.requests.ArchiveContactRequest; +import com.intercom.api.resources.contacts.requests.AttachSubscriptionToContactRequest; +import com.intercom.api.resources.contacts.requests.BlockContactRequest; +import com.intercom.api.resources.contacts.requests.DeleteContactRequest; +import com.intercom.api.resources.contacts.requests.DetachSubscriptionFromContactRequest; +import com.intercom.api.resources.contacts.requests.FindContactRequest; +import com.intercom.api.resources.contacts.requests.ListAttachedCompaniesRequest; +import com.intercom.api.resources.contacts.requests.ListAttachedSubscriptionsRequest; +import com.intercom.api.resources.contacts.requests.ListContactsRequest; +import com.intercom.api.resources.contacts.requests.ListSegmentsAttachedToContactRequest; +import com.intercom.api.resources.contacts.requests.ListTagsAttachedToContactRequest; +import com.intercom.api.resources.contacts.requests.MergeContactsRequest; +import com.intercom.api.resources.contacts.requests.ShowContactByExternalIdRequest; +import com.intercom.api.resources.contacts.requests.UnarchiveContactRequest; +import com.intercom.api.resources.contacts.requests.UpdateContactRequest; +import com.intercom.api.resources.contacts.types.Contact; +import com.intercom.api.resources.contacts.types.ContactsCreateResponse; +import com.intercom.api.resources.contacts.types.ContactsFindResponse; +import com.intercom.api.resources.contacts.types.ContactsMergeLeadInUserResponse; +import com.intercom.api.resources.contacts.types.ContactsUpdateResponse; +import com.intercom.api.resources.contacts.types.ShowContactByExternalIdResponse; +import com.intercom.api.resources.subscriptiontypes.types.SubscriptionType; +import com.intercom.api.types.ContactArchived; +import com.intercom.api.types.ContactAttachedCompanies; +import com.intercom.api.types.ContactBlocked; +import com.intercom.api.types.ContactDeleted; +import com.intercom.api.types.ContactList; +import com.intercom.api.types.ContactSegments; +import com.intercom.api.types.ContactUnarchived; +import com.intercom.api.types.CreateContactRequest; +import com.intercom.api.types.CursorPages; +import com.intercom.api.types.Error; +import com.intercom.api.types.SearchRequest; +import com.intercom.api.types.StartingAfterPaging; +import com.intercom.api.types.SubscriptionTypeList; +import com.intercom.api.types.TagList; +import java.io.IOException; +import java.util.Collections; +import java.util.List; +import java.util.Optional; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.ExecutionException; +import okhttp3.Call; +import okhttp3.Callback; +import okhttp3.Headers; +import okhttp3.HttpUrl; +import okhttp3.OkHttpClient; +import okhttp3.Request; +import okhttp3.RequestBody; +import okhttp3.Response; +import okhttp3.ResponseBody; +import org.jetbrains.annotations.NotNull; + +public class AsyncRawContactsClient { + protected final ClientOptions clientOptions; + + public AsyncRawContactsClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + } + + /** + * You can fetch a list of companies that are associated to a contact. + */ + public CompletableFuture>> listAttachedCompanies( + ListAttachedCompaniesRequest request) { + return listAttachedCompanies(request, null); + } + + /** + * You can fetch a list of companies that are associated to a contact. + */ + public CompletableFuture>> listAttachedCompanies( + ListAttachedCompaniesRequest request, RequestOptions requestOptions) { + HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("contacts") + .addPathSegment(request.getContactId()) + .addPathSegments("companies"); + if (request.getPage().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "page", request.getPage().get(), false); + } + if (request.getPerPage().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "per_page", request.getPerPage().get(), false); + } + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl.build()) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture>> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + ContactAttachedCompanies parsedResponse = + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, ContactAttachedCompanies.class); + int newPageNumber = request.getPage() + .map((Integer page) -> page + 1) + .orElse(1); + ListAttachedCompaniesRequest nextRequest = ListAttachedCompaniesRequest.builder() + .from(request) + .page(newPageNumber) + .build(); + List result = parsedResponse.getCompanies().orElse(Collections.emptyList()); + future.complete(new IntercomHttpResponse<>( + new SyncPagingIterable(true, result, parsedResponse, () -> { + try { + return listAttachedCompanies(nextRequest, requestOptions) + .get() + .body(); + } catch (InterruptedException | ExecutionException e) { + throw new RuntimeException(e); + } + }), + response)); + return; + } + try { + switch (response.code()) { + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 404: + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can fetch a list of segments that are associated to a contact. + */ + public CompletableFuture> listAttachedSegments( + ListSegmentsAttachedToContactRequest request) { + return listAttachedSegments(request, null); + } + + /** + * You can fetch a list of segments that are associated to a contact. + */ + public CompletableFuture> listAttachedSegments( + ListSegmentsAttachedToContactRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("contacts") + .addPathSegment(request.getContactId()) + .addPathSegments("segments") + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, ContactSegments.class), + response)); + return; + } + try { + switch (response.code()) { + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 404: + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can fetch a list of subscription types that are attached to a contact. These can be subscriptions that a user has 'opted-in' to or has 'opted-out' from, depending on the subscription type. + * This will return a list of Subscription Type objects that the contact is associated with. + *

The data property will show a combined list of:

+ *

1.Opt-out subscription types that the user has opted-out from. + * 2.Opt-in subscription types that the user has opted-in to receiving.

+ */ + public CompletableFuture> listAttachedSubscriptions( + ListAttachedSubscriptionsRequest request) { + return listAttachedSubscriptions(request, null); + } + + /** + * You can fetch a list of subscription types that are attached to a contact. These can be subscriptions that a user has 'opted-in' to or has 'opted-out' from, depending on the subscription type. + * This will return a list of Subscription Type objects that the contact is associated with. + *

The data property will show a combined list of:

+ *

1.Opt-out subscription types that the user has opted-out from. + * 2.Opt-in subscription types that the user has opted-in to receiving.

+ */ + public CompletableFuture> listAttachedSubscriptions( + ListAttachedSubscriptionsRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("contacts") + .addPathSegment(request.getContactId()) + .addPathSegments("subscriptions") + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, SubscriptionTypeList.class), + response)); + return; + } + try { + switch (response.code()) { + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 404: + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can add a specific subscription to a contact. In Intercom, we have two different subscription types based on user consent - opt-out and opt-in: + *

1.Attaching a contact to an opt-out subscription type will opt that user out from receiving messages related to that subscription type.

+ *

2.Attaching a contact to an opt-in subscription type will opt that user in to receiving messages related to that subscription type.

+ *

This will return a subscription type model for the subscription type that was added to the contact.

+ */ + public CompletableFuture> attachSubscription( + AttachSubscriptionToContactRequest request) { + return attachSubscription(request, null); + } + + /** + * You can add a specific subscription to a contact. In Intercom, we have two different subscription types based on user consent - opt-out and opt-in: + *

1.Attaching a contact to an opt-out subscription type will opt that user out from receiving messages related to that subscription type.

+ *

2.Attaching a contact to an opt-in subscription type will opt that user in to receiving messages related to that subscription type.

+ *

This will return a subscription type model for the subscription type that was added to the contact.

+ */ + public CompletableFuture> attachSubscription( + AttachSubscriptionToContactRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("contacts") + .addPathSegment(request.getContactId()) + .addPathSegments("subscriptions") + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, SubscriptionType.class), + response)); + return; + } + try { + switch (response.code()) { + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 404: + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can remove a specific subscription from a contact. This will return a subscription type model for the subscription type that was removed from the contact. + */ + public CompletableFuture> detachSubscription( + DetachSubscriptionFromContactRequest request) { + return detachSubscription(request, null); + } + + /** + * You can remove a specific subscription from a contact. This will return a subscription type model for the subscription type that was removed from the contact. + */ + public CompletableFuture> detachSubscription( + DetachSubscriptionFromContactRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("contacts") + .addPathSegment(request.getContactId()) + .addPathSegments("subscriptions") + .addPathSegment(request.getSubscriptionId()) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("DELETE", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, SubscriptionType.class), + response)); + return; + } + try { + switch (response.code()) { + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 404: + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can fetch a list of all tags that are attached to a specific contact. + */ + public CompletableFuture> listAttachedTags(ListTagsAttachedToContactRequest request) { + return listAttachedTags(request, null); + } + + /** + * You can fetch a list of all tags that are attached to a specific contact. + */ + public CompletableFuture> listAttachedTags( + ListTagsAttachedToContactRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("contacts") + .addPathSegment(request.getContactId()) + .addPathSegments("tags") + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, TagList.class), response)); + return; + } + try { + switch (response.code()) { + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 404: + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can fetch the details of a single contact. + */ + public CompletableFuture> find(FindContactRequest request) { + return find(request, null); + } + + /** + * You can fetch the details of a single contact. + */ + public CompletableFuture> find( + FindContactRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("contacts") + .addPathSegment(request.getContactId()) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, ContactsFindResponse.class), + response)); + return; + } + try { + if (response.code() == 401) { + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can update an existing contact (ie. user or lead). + *

{% admonition type="info" %} + * This endpoint handles both contact updates and custom object associations.

+ *

See update a contact with an association to a custom object instance in the request/response examples to see the custom object association format. + * {% /admonition %}

+ */ + public CompletableFuture> update(UpdateContactRequest request) { + return update(request, null); + } + + /** + * You can update an existing contact (ie. user or lead). + *

{% admonition type="info" %} + * This endpoint handles both contact updates and custom object associations.

+ *

See update a contact with an association to a custom object instance in the request/response examples to see the custom object association format. + * {% /admonition %}

+ */ + public CompletableFuture> update( + UpdateContactRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("contacts") + .addPathSegment(request.getContactId()) + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("PUT", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, ContactsUpdateResponse.class), + response)); + return; + } + try { + if (response.code() == 401) { + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can delete a single contact. + */ + public CompletableFuture> delete(DeleteContactRequest request) { + return delete(request, null); + } + + /** + * You can delete a single contact. + */ + public CompletableFuture> delete( + DeleteContactRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("contacts") + .addPathSegment(request.getContactId()) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("DELETE", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, ContactDeleted.class), + response)); + return; + } + try { + if (response.code() == 401) { + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can merge a contact with a role of lead into a contact with a role of user. + */ + public CompletableFuture> mergeLeadInUser() { + return mergeLeadInUser(MergeContactsRequest.builder().build()); + } + + /** + * You can merge a contact with a role of lead into a contact with a role of user. + */ + public CompletableFuture> mergeLeadInUser( + MergeContactsRequest request) { + return mergeLeadInUser(request, null); + } + + /** + * You can merge a contact with a role of lead into a contact with a role of user. + */ + public CompletableFuture> mergeLeadInUser( + MergeContactsRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("contacts/merge") + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue( + responseBodyString, ContactsMergeLeadInUserResponse.class), + response)); + return; + } + try { + if (response.code() == 401) { + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can search for multiple contacts by the value of their attributes in order to fetch exactly who you want. + *

To search for contacts, you need to send a POST request to https://api.intercom.io/contacts/search.

+ *

This will accept a query object in the body which will define your filters in order to search for contacts.

+ *

{% admonition type="warning" name="Optimizing search queries" %} + * Search queries can be complex, so optimizing them can help the performance of your search. + * Use the AND and OR operators to combine multiple filters to get the exact results you need and utilize + * pagination to limit the number of results returned. The default is 50 results per page. + * See the pagination section for more details on how to use the starting_after param. + * {% /admonition %}

+ *

Contact Creation Delay

+ *

If a contact has recently been created, there is a possibility that it will not yet be available when searching. This means that it may not appear in the response. This delay can take a few minutes. If you need to be instantly notified it is recommended to use webhooks and iterate to see if they match your search filters.

+ *

Nesting & Limitations

+ *

You can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4). + * There are some limitations to the amount of multiple's there can be:

+ *
    + *
  • There's a limit of max 2 nested filters
    • + *
  • There's a limit of max 15 filters for each AND or OR group
    • + *
+ *

Searching for Timestamp Fields

+ *

All timestamp fields (created_at, updated_at etc.) are indexed as Dates for Contact Search queries; Datetime queries are not currently supported. This means you can only query for timestamp fields by day - not hour, minute or second. + * For example, if you search for all Contacts with a created_at value greater (>) than 1577869200 (the UNIX timestamp for January 1st, 2020 9:00 AM), that will be interpreted as 1577836800 (January 1st, 2020 12:00 AM). The search results will then include Contacts created from January 2nd, 2020 12:00 AM onwards. + * If you'd like to get contacts created on January 1st, 2020 you should search with a created_at value equal (=) to 1577836800 (January 1st, 2020 12:00 AM). + * This behaviour applies only to timestamps used in search queries. The search results will still contain the full UNIX timestamp and be sorted accordingly.

+ *

Accepted Fields

+ *

Most key listed as part of the Contacts Model are searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as created_at accepts a date, the value cannot be a string such as "foorbar").

+ *

| Field | Type | + * | ---------------------------------- | ------------------------------ | + * | id | String | + * | role | String<br>Accepts user or lead | + * | name | String | + * | avatar | String | + * | owner_id | Integer | + * | email | String | + * | email_domain | String | + * | phone | String | + * | external_id | String | + * | created_at | Date (UNIX Timestamp) | + * | signed_up_at | Date (UNIX Timestamp) | + * | updated_at | Date (UNIX Timestamp) | + * | last_seen_at | Date (UNIX Timestamp) | + * | last_contacted_at | Date (UNIX Timestamp) | + * | last_replied_at | Date (UNIX Timestamp) | + * | last_email_opened_at | Date (UNIX Timestamp) | + * | last_email_clicked_at | Date (UNIX Timestamp) | + * | language_override | String | + * | browser | String | + * | browser_language | String | + * | os | String | + * | location.country | String | + * | location.region | String | + * | location.city | String | + * | unsubscribed_from_emails | Boolean | + * | marked_email_as_spam | Boolean | + * | has_hard_bounced | Boolean | + * | ios_last_seen_at | Date (UNIX Timestamp) | + * | ios_app_version | String | + * | ios_device | String | + * | ios_app_device | String | + * | ios_os_version | String | + * | ios_app_name | String | + * | ios_sdk_version | String | + * | android_last_seen_at | Date (UNIX Timestamp) | + * | android_app_version | String | + * | android_device | String | + * | android_app_name | String | + * | andoid_sdk_version | String | + * | segment_id | String | + * | tag_id | String | + * | custom_attributes.{attribute_name} | String |

+ *

Accepted Operators

+ *

{% admonition type="warning" name="Searching based on created_at" %} + * You cannot use the <= or >= operators to search by created_at. + * {% /admonition %}

+ *

The table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string ("="). The operator has to be compatible with the field's type (eg. you cannot search with > for a given string value as it's only compatible for integer's and dates).

+ *

| Operator | Valid Types | Description | + * | :------- | :------------------------------- | :--------------------------------------------------------------- | + * | = | All | Equals | + * | != | All | Doesn't Equal | + * | IN | All | In<br>Shortcut for OR queries<br>Values must be in Array | + * | NIN | All | Not In<br>Shortcut for OR ! queries<br>Values must be in Array | + * | > | Integer<br>Date (UNIX Timestamp) | Greater than | + * | < | Integer<br>Date (UNIX Timestamp) | Lower than | + * | ~ | String | Contains | + * | !~ | String | Doesn't Contain | + * | ^ | String | Starts With | + * | $ | String | Ends With |

+ */ + public CompletableFuture>> search(SearchRequest request) { + return search(request, null); + } + + /** + * You can search for multiple contacts by the value of their attributes in order to fetch exactly who you want. + *

To search for contacts, you need to send a POST request to https://api.intercom.io/contacts/search.

+ *

This will accept a query object in the body which will define your filters in order to search for contacts.

+ *

{% admonition type="warning" name="Optimizing search queries" %} + * Search queries can be complex, so optimizing them can help the performance of your search. + * Use the AND and OR operators to combine multiple filters to get the exact results you need and utilize + * pagination to limit the number of results returned. The default is 50 results per page. + * See the pagination section for more details on how to use the starting_after param. + * {% /admonition %}

+ *

Contact Creation Delay

+ *

If a contact has recently been created, there is a possibility that it will not yet be available when searching. This means that it may not appear in the response. This delay can take a few minutes. If you need to be instantly notified it is recommended to use webhooks and iterate to see if they match your search filters.

+ *

Nesting & Limitations

+ *

You can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4). + * There are some limitations to the amount of multiple's there can be:

+ *
    + *
  • There's a limit of max 2 nested filters
    • + *
  • There's a limit of max 15 filters for each AND or OR group
    • + *
+ *

Searching for Timestamp Fields

+ *

All timestamp fields (created_at, updated_at etc.) are indexed as Dates for Contact Search queries; Datetime queries are not currently supported. This means you can only query for timestamp fields by day - not hour, minute or second. + * For example, if you search for all Contacts with a created_at value greater (>) than 1577869200 (the UNIX timestamp for January 1st, 2020 9:00 AM), that will be interpreted as 1577836800 (January 1st, 2020 12:00 AM). The search results will then include Contacts created from January 2nd, 2020 12:00 AM onwards. + * If you'd like to get contacts created on January 1st, 2020 you should search with a created_at value equal (=) to 1577836800 (January 1st, 2020 12:00 AM). + * This behaviour applies only to timestamps used in search queries. The search results will still contain the full UNIX timestamp and be sorted accordingly.

+ *

Accepted Fields

+ *

Most key listed as part of the Contacts Model are searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as created_at accepts a date, the value cannot be a string such as "foorbar").

+ *

| Field | Type | + * | ---------------------------------- | ------------------------------ | + * | id | String | + * | role | String<br>Accepts user or lead | + * | name | String | + * | avatar | String | + * | owner_id | Integer | + * | email | String | + * | email_domain | String | + * | phone | String | + * | external_id | String | + * | created_at | Date (UNIX Timestamp) | + * | signed_up_at | Date (UNIX Timestamp) | + * | updated_at | Date (UNIX Timestamp) | + * | last_seen_at | Date (UNIX Timestamp) | + * | last_contacted_at | Date (UNIX Timestamp) | + * | last_replied_at | Date (UNIX Timestamp) | + * | last_email_opened_at | Date (UNIX Timestamp) | + * | last_email_clicked_at | Date (UNIX Timestamp) | + * | language_override | String | + * | browser | String | + * | browser_language | String | + * | os | String | + * | location.country | String | + * | location.region | String | + * | location.city | String | + * | unsubscribed_from_emails | Boolean | + * | marked_email_as_spam | Boolean | + * | has_hard_bounced | Boolean | + * | ios_last_seen_at | Date (UNIX Timestamp) | + * | ios_app_version | String | + * | ios_device | String | + * | ios_app_device | String | + * | ios_os_version | String | + * | ios_app_name | String | + * | ios_sdk_version | String | + * | android_last_seen_at | Date (UNIX Timestamp) | + * | android_app_version | String | + * | android_device | String | + * | android_app_name | String | + * | andoid_sdk_version | String | + * | segment_id | String | + * | tag_id | String | + * | custom_attributes.{attribute_name} | String |

+ *

Accepted Operators

+ *

{% admonition type="warning" name="Searching based on created_at" %} + * You cannot use the <= or >= operators to search by created_at. + * {% /admonition %}

+ *

The table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string ("="). The operator has to be compatible with the field's type (eg. you cannot search with > for a given string value as it's only compatible for integer's and dates).

+ *

| Operator | Valid Types | Description | + * | :------- | :------------------------------- | :--------------------------------------------------------------- | + * | = | All | Equals | + * | != | All | Doesn't Equal | + * | IN | All | In<br>Shortcut for OR queries<br>Values must be in Array | + * | NIN | All | Not In<br>Shortcut for OR ! queries<br>Values must be in Array | + * | > | Integer<br>Date (UNIX Timestamp) | Greater than | + * | < | Integer<br>Date (UNIX Timestamp) | Lower than | + * | ~ | String | Contains | + * | !~ | String | Doesn't Contain | + * | ^ | String | Starts With | + * | $ | String | Ends With |

+ */ + public CompletableFuture>> search( + SearchRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("contacts/search") + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture>> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + ContactList parsedResponse = + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, ContactList.class); + Optional startingAfter = parsedResponse + .getPages() + .flatMap(CursorPages::getNext) + .flatMap(StartingAfterPaging::getStartingAfter); + Optional pagination = request.getPagination() + .map((StartingAfterPaging pagination_) -> StartingAfterPaging.builder() + .from(pagination_) + .startingAfter(startingAfter) + .build()); + SearchRequest nextRequest = SearchRequest.builder() + .from(request) + .pagination(pagination) + .build(); + List result = parsedResponse.getData().orElse(Collections.emptyList()); + future.complete(new IntercomHttpResponse<>( + new SyncPagingIterable( + startingAfter.isPresent(), result, parsedResponse, () -> { + try { + return search(nextRequest, requestOptions) + .get() + .body(); + } catch (InterruptedException | ExecutionException e) { + throw new RuntimeException(e); + } + }), + response)); + return; + } + try { + if (response.code() == 401) { + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can fetch a list of all contacts (ie. users or leads) in your workspace. + * {% admonition type="warning" name="Pagination" %} + * You can use pagination to limit the number of results returned. The default is 50 results per page. + * See the pagination section for more details on how to use the starting_after param. + * {% /admonition %} + */ + public CompletableFuture>> list() { + return list(ListContactsRequest.builder().build()); + } + + /** + * You can fetch a list of all contacts (ie. users or leads) in your workspace. + * {% admonition type="warning" name="Pagination" %} + * You can use pagination to limit the number of results returned. The default is 50 results per page. + * See the pagination section for more details on how to use the starting_after param. + * {% /admonition %} + */ + public CompletableFuture>> list(ListContactsRequest request) { + return list(request, null); + } + + /** + * You can fetch a list of all contacts (ie. users or leads) in your workspace. + * {% admonition type="warning" name="Pagination" %} + * You can use pagination to limit the number of results returned. The default is 50 results per page. + * See the pagination section for more details on how to use the starting_after param. + * {% /admonition %} + */ + public CompletableFuture>> list( + ListContactsRequest request, RequestOptions requestOptions) { + HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("contacts"); + if (request.getPage().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "page", request.getPage().get(), false); + } + if (request.getPerPage().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "per_page", request.getPerPage().get(), false); + } + if (request.getStartingAfter().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "starting_after", request.getStartingAfter().get(), false); + } + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl.build()) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture>> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + ContactList parsedResponse = + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, ContactList.class); + Optional startingAfter = parsedResponse + .getPages() + .flatMap(CursorPages::getNext) + .flatMap(StartingAfterPaging::getStartingAfter); + ListContactsRequest nextRequest = ListContactsRequest.builder() + .from(request) + .startingAfter(startingAfter) + .build(); + List result = parsedResponse.getData().orElse(Collections.emptyList()); + future.complete(new IntercomHttpResponse<>( + new SyncPagingIterable( + startingAfter.isPresent(), result, parsedResponse, () -> { + try { + return list(nextRequest, requestOptions) + .get() + .body(); + } catch (InterruptedException | ExecutionException e) { + throw new RuntimeException(e); + } + }), + response)); + return; + } + try { + if (response.code() == 401) { + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can create a new contact (ie. user or lead). + */ + public CompletableFuture> create(CreateContactRequest request) { + return create(request, null); + } + + /** + * You can create a new contact (ie. user or lead). + */ + public CompletableFuture> create( + CreateContactRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("contacts") + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, ContactsCreateResponse.class), + response)); + return; + } + try { + if (response.code() == 401) { + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can fetch the details of a single contact by external ID. Note that this endpoint only supports users and not leads. + */ + public CompletableFuture> showContactByExternalId( + ShowContactByExternalIdRequest request) { + return showContactByExternalId(request, null); + } + + /** + * You can fetch the details of a single contact by external ID. Note that this endpoint only supports users and not leads. + */ + public CompletableFuture> showContactByExternalId( + ShowContactByExternalIdRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("contacts/find_by_external_id") + .addPathSegment(request.getExternalId()) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue( + responseBodyString, ShowContactByExternalIdResponse.class), + response)); + return; + } + try { + if (response.code() == 401) { + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can archive a single contact. + */ + public CompletableFuture> archive(ArchiveContactRequest request) { + return archive(request, null); + } + + /** + * You can archive a single contact. + */ + public CompletableFuture> archive( + ArchiveContactRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("contacts") + .addPathSegment(request.getContactId()) + .addPathSegments("archive") + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("POST", RequestBody.create("", null)) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, ContactArchived.class), + response)); + return; + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can unarchive a single contact. + */ + public CompletableFuture> unarchive(UnarchiveContactRequest request) { + return unarchive(request, null); + } + + /** + * You can unarchive a single contact. + */ + public CompletableFuture> unarchive( + UnarchiveContactRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("contacts") + .addPathSegment(request.getContactId()) + .addPathSegments("unarchive") + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("POST", RequestBody.create("", null)) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, ContactUnarchived.class), + response)); + return; + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * Block a single contact.<br>Note: conversations of the contact will also be archived during the process.<br>More details in FAQ How do I block Inbox spam? + */ + public CompletableFuture> blockContact(BlockContactRequest request) { + return blockContact(request, null); + } + + /** + * Block a single contact.<br>Note: conversations of the contact will also be archived during the process.<br>More details in FAQ How do I block Inbox spam? + */ + public CompletableFuture> blockContact( + BlockContactRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("contacts") + .addPathSegment(request.getContactId()) + .addPathSegments("block") + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("POST", RequestBody.create("", null)) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, ContactBlocked.class), + response)); + return; + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } +} diff --git a/src/main/java/com/intercom/api/resources/contacts/ContactsClient.java b/src/main/java/com/intercom/api/resources/contacts/ContactsClient.java new file mode 100644 index 00000000..3c5cbf77 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/contacts/ContactsClient.java @@ -0,0 +1,521 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.contacts; + +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.core.pagination.SyncPagingIterable; +import com.intercom.api.resources.companies.types.Company; +import com.intercom.api.resources.contacts.requests.ArchiveContactRequest; +import com.intercom.api.resources.contacts.requests.AttachSubscriptionToContactRequest; +import com.intercom.api.resources.contacts.requests.BlockContactRequest; +import com.intercom.api.resources.contacts.requests.DeleteContactRequest; +import com.intercom.api.resources.contacts.requests.DetachSubscriptionFromContactRequest; +import com.intercom.api.resources.contacts.requests.FindContactRequest; +import com.intercom.api.resources.contacts.requests.ListAttachedCompaniesRequest; +import com.intercom.api.resources.contacts.requests.ListAttachedSubscriptionsRequest; +import com.intercom.api.resources.contacts.requests.ListContactsRequest; +import com.intercom.api.resources.contacts.requests.ListSegmentsAttachedToContactRequest; +import com.intercom.api.resources.contacts.requests.ListTagsAttachedToContactRequest; +import com.intercom.api.resources.contacts.requests.MergeContactsRequest; +import com.intercom.api.resources.contacts.requests.ShowContactByExternalIdRequest; +import com.intercom.api.resources.contacts.requests.UnarchiveContactRequest; +import com.intercom.api.resources.contacts.requests.UpdateContactRequest; +import com.intercom.api.resources.contacts.types.Contact; +import com.intercom.api.resources.contacts.types.ContactsCreateResponse; +import com.intercom.api.resources.contacts.types.ContactsFindResponse; +import com.intercom.api.resources.contacts.types.ContactsMergeLeadInUserResponse; +import com.intercom.api.resources.contacts.types.ContactsUpdateResponse; +import com.intercom.api.resources.contacts.types.ShowContactByExternalIdResponse; +import com.intercom.api.resources.subscriptiontypes.types.SubscriptionType; +import com.intercom.api.types.ContactArchived; +import com.intercom.api.types.ContactBlocked; +import com.intercom.api.types.ContactDeleted; +import com.intercom.api.types.ContactSegments; +import com.intercom.api.types.ContactUnarchived; +import com.intercom.api.types.CreateContactRequest; +import com.intercom.api.types.SearchRequest; +import com.intercom.api.types.SubscriptionTypeList; +import com.intercom.api.types.TagList; + +public class ContactsClient { + protected final ClientOptions clientOptions; + + private final RawContactsClient rawClient; + + public ContactsClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + this.rawClient = new RawContactsClient(clientOptions); + } + + /** + * Get responses with HTTP metadata like headers + */ + public RawContactsClient withRawResponse() { + return this.rawClient; + } + + /** + * You can fetch a list of companies that are associated to a contact. + */ + public SyncPagingIterable listAttachedCompanies(ListAttachedCompaniesRequest request) { + return this.rawClient.listAttachedCompanies(request).body(); + } + + /** + * You can fetch a list of companies that are associated to a contact. + */ + public SyncPagingIterable listAttachedCompanies( + ListAttachedCompaniesRequest request, RequestOptions requestOptions) { + return this.rawClient.listAttachedCompanies(request, requestOptions).body(); + } + + /** + * You can fetch a list of segments that are associated to a contact. + */ + public ContactSegments listAttachedSegments(ListSegmentsAttachedToContactRequest request) { + return this.rawClient.listAttachedSegments(request).body(); + } + + /** + * You can fetch a list of segments that are associated to a contact. + */ + public ContactSegments listAttachedSegments( + ListSegmentsAttachedToContactRequest request, RequestOptions requestOptions) { + return this.rawClient.listAttachedSegments(request, requestOptions).body(); + } + + /** + * You can fetch a list of subscription types that are attached to a contact. These can be subscriptions that a user has 'opted-in' to or has 'opted-out' from, depending on the subscription type. + * This will return a list of Subscription Type objects that the contact is associated with. + *

The data property will show a combined list of:

+ *

1.Opt-out subscription types that the user has opted-out from. + * 2.Opt-in subscription types that the user has opted-in to receiving.

+ */ + public SubscriptionTypeList listAttachedSubscriptions(ListAttachedSubscriptionsRequest request) { + return this.rawClient.listAttachedSubscriptions(request).body(); + } + + /** + * You can fetch a list of subscription types that are attached to a contact. These can be subscriptions that a user has 'opted-in' to or has 'opted-out' from, depending on the subscription type. + * This will return a list of Subscription Type objects that the contact is associated with. + *

The data property will show a combined list of:

+ *

1.Opt-out subscription types that the user has opted-out from. + * 2.Opt-in subscription types that the user has opted-in to receiving.

+ */ + public SubscriptionTypeList listAttachedSubscriptions( + ListAttachedSubscriptionsRequest request, RequestOptions requestOptions) { + return this.rawClient.listAttachedSubscriptions(request, requestOptions).body(); + } + + /** + * You can add a specific subscription to a contact. In Intercom, we have two different subscription types based on user consent - opt-out and opt-in: + *

1.Attaching a contact to an opt-out subscription type will opt that user out from receiving messages related to that subscription type.

+ *

2.Attaching a contact to an opt-in subscription type will opt that user in to receiving messages related to that subscription type.

+ *

This will return a subscription type model for the subscription type that was added to the contact.

+ */ + public SubscriptionType attachSubscription(AttachSubscriptionToContactRequest request) { + return this.rawClient.attachSubscription(request).body(); + } + + /** + * You can add a specific subscription to a contact. In Intercom, we have two different subscription types based on user consent - opt-out and opt-in: + *

1.Attaching a contact to an opt-out subscription type will opt that user out from receiving messages related to that subscription type.

+ *

2.Attaching a contact to an opt-in subscription type will opt that user in to receiving messages related to that subscription type.

+ *

This will return a subscription type model for the subscription type that was added to the contact.

+ */ + public SubscriptionType attachSubscription( + AttachSubscriptionToContactRequest request, RequestOptions requestOptions) { + return this.rawClient.attachSubscription(request, requestOptions).body(); + } + + /** + * You can remove a specific subscription from a contact. This will return a subscription type model for the subscription type that was removed from the contact. + */ + public SubscriptionType detachSubscription(DetachSubscriptionFromContactRequest request) { + return this.rawClient.detachSubscription(request).body(); + } + + /** + * You can remove a specific subscription from a contact. This will return a subscription type model for the subscription type that was removed from the contact. + */ + public SubscriptionType detachSubscription( + DetachSubscriptionFromContactRequest request, RequestOptions requestOptions) { + return this.rawClient.detachSubscription(request, requestOptions).body(); + } + + /** + * You can fetch a list of all tags that are attached to a specific contact. + */ + public TagList listAttachedTags(ListTagsAttachedToContactRequest request) { + return this.rawClient.listAttachedTags(request).body(); + } + + /** + * You can fetch a list of all tags that are attached to a specific contact. + */ + public TagList listAttachedTags(ListTagsAttachedToContactRequest request, RequestOptions requestOptions) { + return this.rawClient.listAttachedTags(request, requestOptions).body(); + } + + /** + * You can fetch the details of a single contact. + */ + public ContactsFindResponse find(FindContactRequest request) { + return this.rawClient.find(request).body(); + } + + /** + * You can fetch the details of a single contact. + */ + public ContactsFindResponse find(FindContactRequest request, RequestOptions requestOptions) { + return this.rawClient.find(request, requestOptions).body(); + } + + /** + * You can update an existing contact (ie. user or lead). + *

{% admonition type="info" %} + * This endpoint handles both contact updates and custom object associations.

+ *

See update a contact with an association to a custom object instance in the request/response examples to see the custom object association format. + * {% /admonition %}

+ */ + public ContactsUpdateResponse update(UpdateContactRequest request) { + return this.rawClient.update(request).body(); + } + + /** + * You can update an existing contact (ie. user or lead). + *

{% admonition type="info" %} + * This endpoint handles both contact updates and custom object associations.

+ *

See update a contact with an association to a custom object instance in the request/response examples to see the custom object association format. + * {% /admonition %}

+ */ + public ContactsUpdateResponse update(UpdateContactRequest request, RequestOptions requestOptions) { + return this.rawClient.update(request, requestOptions).body(); + } + + /** + * You can delete a single contact. + */ + public ContactDeleted delete(DeleteContactRequest request) { + return this.rawClient.delete(request).body(); + } + + /** + * You can delete a single contact. + */ + public ContactDeleted delete(DeleteContactRequest request, RequestOptions requestOptions) { + return this.rawClient.delete(request, requestOptions).body(); + } + + /** + * You can merge a contact with a role of lead into a contact with a role of user. + */ + public ContactsMergeLeadInUserResponse mergeLeadInUser() { + return this.rawClient.mergeLeadInUser().body(); + } + + /** + * You can merge a contact with a role of lead into a contact with a role of user. + */ + public ContactsMergeLeadInUserResponse mergeLeadInUser(MergeContactsRequest request) { + return this.rawClient.mergeLeadInUser(request).body(); + } + + /** + * You can merge a contact with a role of lead into a contact with a role of user. + */ + public ContactsMergeLeadInUserResponse mergeLeadInUser( + MergeContactsRequest request, RequestOptions requestOptions) { + return this.rawClient.mergeLeadInUser(request, requestOptions).body(); + } + + /** + * You can search for multiple contacts by the value of their attributes in order to fetch exactly who you want. + *

To search for contacts, you need to send a POST request to https://api.intercom.io/contacts/search.

+ *

This will accept a query object in the body which will define your filters in order to search for contacts.

+ *

{% admonition type="warning" name="Optimizing search queries" %} + * Search queries can be complex, so optimizing them can help the performance of your search. + * Use the AND and OR operators to combine multiple filters to get the exact results you need and utilize + * pagination to limit the number of results returned. The default is 50 results per page. + * See the pagination section for more details on how to use the starting_after param. + * {% /admonition %}

+ *

Contact Creation Delay

+ *

If a contact has recently been created, there is a possibility that it will not yet be available when searching. This means that it may not appear in the response. This delay can take a few minutes. If you need to be instantly notified it is recommended to use webhooks and iterate to see if they match your search filters.

+ *

Nesting & Limitations

+ *

You can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4). + * There are some limitations to the amount of multiple's there can be:

+ *
    + *
  • There's a limit of max 2 nested filters
    • + *
  • There's a limit of max 15 filters for each AND or OR group
    • + *
+ *

Searching for Timestamp Fields

+ *

All timestamp fields (created_at, updated_at etc.) are indexed as Dates for Contact Search queries; Datetime queries are not currently supported. This means you can only query for timestamp fields by day - not hour, minute or second. + * For example, if you search for all Contacts with a created_at value greater (>) than 1577869200 (the UNIX timestamp for January 1st, 2020 9:00 AM), that will be interpreted as 1577836800 (January 1st, 2020 12:00 AM). The search results will then include Contacts created from January 2nd, 2020 12:00 AM onwards. + * If you'd like to get contacts created on January 1st, 2020 you should search with a created_at value equal (=) to 1577836800 (January 1st, 2020 12:00 AM). + * This behaviour applies only to timestamps used in search queries. The search results will still contain the full UNIX timestamp and be sorted accordingly.

+ *

Accepted Fields

+ *

Most key listed as part of the Contacts Model are searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as created_at accepts a date, the value cannot be a string such as "foorbar").

+ *

| Field | Type | + * | ---------------------------------- | ------------------------------ | + * | id | String | + * | role | String<br>Accepts user or lead | + * | name | String | + * | avatar | String | + * | owner_id | Integer | + * | email | String | + * | email_domain | String | + * | phone | String | + * | external_id | String | + * | created_at | Date (UNIX Timestamp) | + * | signed_up_at | Date (UNIX Timestamp) | + * | updated_at | Date (UNIX Timestamp) | + * | last_seen_at | Date (UNIX Timestamp) | + * | last_contacted_at | Date (UNIX Timestamp) | + * | last_replied_at | Date (UNIX Timestamp) | + * | last_email_opened_at | Date (UNIX Timestamp) | + * | last_email_clicked_at | Date (UNIX Timestamp) | + * | language_override | String | + * | browser | String | + * | browser_language | String | + * | os | String | + * | location.country | String | + * | location.region | String | + * | location.city | String | + * | unsubscribed_from_emails | Boolean | + * | marked_email_as_spam | Boolean | + * | has_hard_bounced | Boolean | + * | ios_last_seen_at | Date (UNIX Timestamp) | + * | ios_app_version | String | + * | ios_device | String | + * | ios_app_device | String | + * | ios_os_version | String | + * | ios_app_name | String | + * | ios_sdk_version | String | + * | android_last_seen_at | Date (UNIX Timestamp) | + * | android_app_version | String | + * | android_device | String | + * | android_app_name | String | + * | andoid_sdk_version | String | + * | segment_id | String | + * | tag_id | String | + * | custom_attributes.{attribute_name} | String |

+ *

Accepted Operators

+ *

{% admonition type="warning" name="Searching based on created_at" %} + * You cannot use the <= or >= operators to search by created_at. + * {% /admonition %}

+ *

The table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string ("="). The operator has to be compatible with the field's type (eg. you cannot search with > for a given string value as it's only compatible for integer's and dates).

+ *

| Operator | Valid Types | Description | + * | :------- | :------------------------------- | :--------------------------------------------------------------- | + * | = | All | Equals | + * | != | All | Doesn't Equal | + * | IN | All | In<br>Shortcut for OR queries<br>Values must be in Array | + * | NIN | All | Not In<br>Shortcut for OR ! queries<br>Values must be in Array | + * | > | Integer<br>Date (UNIX Timestamp) | Greater than | + * | < | Integer<br>Date (UNIX Timestamp) | Lower than | + * | ~ | String | Contains | + * | !~ | String | Doesn't Contain | + * | ^ | String | Starts With | + * | $ | String | Ends With |

+ */ + public SyncPagingIterable search(SearchRequest request) { + return this.rawClient.search(request).body(); + } + + /** + * You can search for multiple contacts by the value of their attributes in order to fetch exactly who you want. + *

To search for contacts, you need to send a POST request to https://api.intercom.io/contacts/search.

+ *

This will accept a query object in the body which will define your filters in order to search for contacts.

+ *

{% admonition type="warning" name="Optimizing search queries" %} + * Search queries can be complex, so optimizing them can help the performance of your search. + * Use the AND and OR operators to combine multiple filters to get the exact results you need and utilize + * pagination to limit the number of results returned. The default is 50 results per page. + * See the pagination section for more details on how to use the starting_after param. + * {% /admonition %}

+ *

Contact Creation Delay

+ *

If a contact has recently been created, there is a possibility that it will not yet be available when searching. This means that it may not appear in the response. This delay can take a few minutes. If you need to be instantly notified it is recommended to use webhooks and iterate to see if they match your search filters.

+ *

Nesting & Limitations

+ *

You can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4). + * There are some limitations to the amount of multiple's there can be:

+ *
    + *
  • There's a limit of max 2 nested filters
    • + *
  • There's a limit of max 15 filters for each AND or OR group
    • + *
+ *

Searching for Timestamp Fields

+ *

All timestamp fields (created_at, updated_at etc.) are indexed as Dates for Contact Search queries; Datetime queries are not currently supported. This means you can only query for timestamp fields by day - not hour, minute or second. + * For example, if you search for all Contacts with a created_at value greater (>) than 1577869200 (the UNIX timestamp for January 1st, 2020 9:00 AM), that will be interpreted as 1577836800 (January 1st, 2020 12:00 AM). The search results will then include Contacts created from January 2nd, 2020 12:00 AM onwards. + * If you'd like to get contacts created on January 1st, 2020 you should search with a created_at value equal (=) to 1577836800 (January 1st, 2020 12:00 AM). + * This behaviour applies only to timestamps used in search queries. The search results will still contain the full UNIX timestamp and be sorted accordingly.

+ *

Accepted Fields

+ *

Most key listed as part of the Contacts Model are searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as created_at accepts a date, the value cannot be a string such as "foorbar").

+ *

| Field | Type | + * | ---------------------------------- | ------------------------------ | + * | id | String | + * | role | String<br>Accepts user or lead | + * | name | String | + * | avatar | String | + * | owner_id | Integer | + * | email | String | + * | email_domain | String | + * | phone | String | + * | external_id | String | + * | created_at | Date (UNIX Timestamp) | + * | signed_up_at | Date (UNIX Timestamp) | + * | updated_at | Date (UNIX Timestamp) | + * | last_seen_at | Date (UNIX Timestamp) | + * | last_contacted_at | Date (UNIX Timestamp) | + * | last_replied_at | Date (UNIX Timestamp) | + * | last_email_opened_at | Date (UNIX Timestamp) | + * | last_email_clicked_at | Date (UNIX Timestamp) | + * | language_override | String | + * | browser | String | + * | browser_language | String | + * | os | String | + * | location.country | String | + * | location.region | String | + * | location.city | String | + * | unsubscribed_from_emails | Boolean | + * | marked_email_as_spam | Boolean | + * | has_hard_bounced | Boolean | + * | ios_last_seen_at | Date (UNIX Timestamp) | + * | ios_app_version | String | + * | ios_device | String | + * | ios_app_device | String | + * | ios_os_version | String | + * | ios_app_name | String | + * | ios_sdk_version | String | + * | android_last_seen_at | Date (UNIX Timestamp) | + * | android_app_version | String | + * | android_device | String | + * | android_app_name | String | + * | andoid_sdk_version | String | + * | segment_id | String | + * | tag_id | String | + * | custom_attributes.{attribute_name} | String |

+ *

Accepted Operators

+ *

{% admonition type="warning" name="Searching based on created_at" %} + * You cannot use the <= or >= operators to search by created_at. + * {% /admonition %}

+ *

The table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string ("="). The operator has to be compatible with the field's type (eg. you cannot search with > for a given string value as it's only compatible for integer's and dates).

+ *

| Operator | Valid Types | Description | + * | :------- | :------------------------------- | :--------------------------------------------------------------- | + * | = | All | Equals | + * | != | All | Doesn't Equal | + * | IN | All | In<br>Shortcut for OR queries<br>Values must be in Array | + * | NIN | All | Not In<br>Shortcut for OR ! queries<br>Values must be in Array | + * | > | Integer<br>Date (UNIX Timestamp) | Greater than | + * | < | Integer<br>Date (UNIX Timestamp) | Lower than | + * | ~ | String | Contains | + * | !~ | String | Doesn't Contain | + * | ^ | String | Starts With | + * | $ | String | Ends With |

+ */ + public SyncPagingIterable search(SearchRequest request, RequestOptions requestOptions) { + return this.rawClient.search(request, requestOptions).body(); + } + + /** + * You can fetch a list of all contacts (ie. users or leads) in your workspace. + * {% admonition type="warning" name="Pagination" %} + * You can use pagination to limit the number of results returned. The default is 50 results per page. + * See the pagination section for more details on how to use the starting_after param. + * {% /admonition %} + */ + public SyncPagingIterable list() { + return this.rawClient.list().body(); + } + + /** + * You can fetch a list of all contacts (ie. users or leads) in your workspace. + * {% admonition type="warning" name="Pagination" %} + * You can use pagination to limit the number of results returned. The default is 50 results per page. + * See the pagination section for more details on how to use the starting_after param. + * {% /admonition %} + */ + public SyncPagingIterable list(ListContactsRequest request) { + return this.rawClient.list(request).body(); + } + + /** + * You can fetch a list of all contacts (ie. users or leads) in your workspace. + * {% admonition type="warning" name="Pagination" %} + * You can use pagination to limit the number of results returned. The default is 50 results per page. + * See the pagination section for more details on how to use the starting_after param. + * {% /admonition %} + */ + public SyncPagingIterable list(ListContactsRequest request, RequestOptions requestOptions) { + return this.rawClient.list(request, requestOptions).body(); + } + + /** + * You can create a new contact (ie. user or lead). + */ + public ContactsCreateResponse create(CreateContactRequest request) { + return this.rawClient.create(request).body(); + } + + /** + * You can create a new contact (ie. user or lead). + */ + public ContactsCreateResponse create(CreateContactRequest request, RequestOptions requestOptions) { + return this.rawClient.create(request, requestOptions).body(); + } + + /** + * You can fetch the details of a single contact by external ID. Note that this endpoint only supports users and not leads. + */ + public ShowContactByExternalIdResponse showContactByExternalId(ShowContactByExternalIdRequest request) { + return this.rawClient.showContactByExternalId(request).body(); + } + + /** + * You can fetch the details of a single contact by external ID. Note that this endpoint only supports users and not leads. + */ + public ShowContactByExternalIdResponse showContactByExternalId( + ShowContactByExternalIdRequest request, RequestOptions requestOptions) { + return this.rawClient.showContactByExternalId(request, requestOptions).body(); + } + + /** + * You can archive a single contact. + */ + public ContactArchived archive(ArchiveContactRequest request) { + return this.rawClient.archive(request).body(); + } + + /** + * You can archive a single contact. + */ + public ContactArchived archive(ArchiveContactRequest request, RequestOptions requestOptions) { + return this.rawClient.archive(request, requestOptions).body(); + } + + /** + * You can unarchive a single contact. + */ + public ContactUnarchived unarchive(UnarchiveContactRequest request) { + return this.rawClient.unarchive(request).body(); + } + + /** + * You can unarchive a single contact. + */ + public ContactUnarchived unarchive(UnarchiveContactRequest request, RequestOptions requestOptions) { + return this.rawClient.unarchive(request, requestOptions).body(); + } + + /** + * Block a single contact.<br>Note: conversations of the contact will also be archived during the process.<br>More details in FAQ How do I block Inbox spam? + */ + public ContactBlocked blockContact(BlockContactRequest request) { + return this.rawClient.blockContact(request).body(); + } + + /** + * Block a single contact.<br>Note: conversations of the contact will also be archived during the process.<br>More details in FAQ How do I block Inbox spam? + */ + public ContactBlocked blockContact(BlockContactRequest request, RequestOptions requestOptions) { + return this.rawClient.blockContact(request, requestOptions).body(); + } +} diff --git a/src/main/java/com/intercom/api/resources/contacts/RawContactsClient.java b/src/main/java/com/intercom/api/resources/contacts/RawContactsClient.java new file mode 100644 index 00000000..6b5cfe93 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/contacts/RawContactsClient.java @@ -0,0 +1,1252 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.contacts; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.IntercomApiException; +import com.intercom.api.core.IntercomException; +import com.intercom.api.core.IntercomHttpResponse; +import com.intercom.api.core.MediaTypes; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.core.QueryStringMapper; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.core.pagination.SyncPagingIterable; +import com.intercom.api.errors.NotFoundError; +import com.intercom.api.errors.UnauthorizedError; +import com.intercom.api.resources.companies.types.Company; +import com.intercom.api.resources.contacts.requests.ArchiveContactRequest; +import com.intercom.api.resources.contacts.requests.AttachSubscriptionToContactRequest; +import com.intercom.api.resources.contacts.requests.BlockContactRequest; +import com.intercom.api.resources.contacts.requests.DeleteContactRequest; +import com.intercom.api.resources.contacts.requests.DetachSubscriptionFromContactRequest; +import com.intercom.api.resources.contacts.requests.FindContactRequest; +import com.intercom.api.resources.contacts.requests.ListAttachedCompaniesRequest; +import com.intercom.api.resources.contacts.requests.ListAttachedSubscriptionsRequest; +import com.intercom.api.resources.contacts.requests.ListContactsRequest; +import com.intercom.api.resources.contacts.requests.ListSegmentsAttachedToContactRequest; +import com.intercom.api.resources.contacts.requests.ListTagsAttachedToContactRequest; +import com.intercom.api.resources.contacts.requests.MergeContactsRequest; +import com.intercom.api.resources.contacts.requests.ShowContactByExternalIdRequest; +import com.intercom.api.resources.contacts.requests.UnarchiveContactRequest; +import com.intercom.api.resources.contacts.requests.UpdateContactRequest; +import com.intercom.api.resources.contacts.types.Contact; +import com.intercom.api.resources.contacts.types.ContactsCreateResponse; +import com.intercom.api.resources.contacts.types.ContactsFindResponse; +import com.intercom.api.resources.contacts.types.ContactsMergeLeadInUserResponse; +import com.intercom.api.resources.contacts.types.ContactsUpdateResponse; +import com.intercom.api.resources.contacts.types.ShowContactByExternalIdResponse; +import com.intercom.api.resources.subscriptiontypes.types.SubscriptionType; +import com.intercom.api.types.ContactArchived; +import com.intercom.api.types.ContactAttachedCompanies; +import com.intercom.api.types.ContactBlocked; +import com.intercom.api.types.ContactDeleted; +import com.intercom.api.types.ContactList; +import com.intercom.api.types.ContactSegments; +import com.intercom.api.types.ContactUnarchived; +import com.intercom.api.types.CreateContactRequest; +import com.intercom.api.types.CursorPages; +import com.intercom.api.types.Error; +import com.intercom.api.types.SearchRequest; +import com.intercom.api.types.StartingAfterPaging; +import com.intercom.api.types.SubscriptionTypeList; +import com.intercom.api.types.TagList; +import java.io.IOException; +import java.util.Collections; +import java.util.List; +import java.util.Optional; +import okhttp3.Headers; +import okhttp3.HttpUrl; +import okhttp3.OkHttpClient; +import okhttp3.Request; +import okhttp3.RequestBody; +import okhttp3.Response; +import okhttp3.ResponseBody; + +public class RawContactsClient { + protected final ClientOptions clientOptions; + + public RawContactsClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + } + + /** + * You can fetch a list of companies that are associated to a contact. + */ + public IntercomHttpResponse> listAttachedCompanies( + ListAttachedCompaniesRequest request) { + return listAttachedCompanies(request, null); + } + + /** + * You can fetch a list of companies that are associated to a contact. + */ + public IntercomHttpResponse> listAttachedCompanies( + ListAttachedCompaniesRequest request, RequestOptions requestOptions) { + HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("contacts") + .addPathSegment(request.getContactId()) + .addPathSegments("companies"); + if (request.getPage().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "page", request.getPage().get(), false); + } + if (request.getPerPage().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "per_page", request.getPerPage().get(), false); + } + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl.build()) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + ContactAttachedCompanies parsedResponse = + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, ContactAttachedCompanies.class); + int newPageNumber = + request.getPage().map((Integer page) -> page + 1).orElse(1); + ListAttachedCompaniesRequest nextRequest = ListAttachedCompaniesRequest.builder() + .from(request) + .page(newPageNumber) + .build(); + List result = parsedResponse.getCompanies().orElse(Collections.emptyList()); + return new IntercomHttpResponse<>( + new SyncPagingIterable( + true, result, parsedResponse, () -> listAttachedCompanies(nextRequest, requestOptions) + .body()), + response); + } + try { + switch (response.code()) { + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 404: + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can fetch a list of segments that are associated to a contact. + */ + public IntercomHttpResponse listAttachedSegments(ListSegmentsAttachedToContactRequest request) { + return listAttachedSegments(request, null); + } + + /** + * You can fetch a list of segments that are associated to a contact. + */ + public IntercomHttpResponse listAttachedSegments( + ListSegmentsAttachedToContactRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("contacts") + .addPathSegment(request.getContactId()) + .addPathSegments("segments") + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, ContactSegments.class), response); + } + try { + switch (response.code()) { + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 404: + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can fetch a list of subscription types that are attached to a contact. These can be subscriptions that a user has 'opted-in' to or has 'opted-out' from, depending on the subscription type. + * This will return a list of Subscription Type objects that the contact is associated with. + *

The data property will show a combined list of:

+ *

1.Opt-out subscription types that the user has opted-out from. + * 2.Opt-in subscription types that the user has opted-in to receiving.

+ */ + public IntercomHttpResponse listAttachedSubscriptions( + ListAttachedSubscriptionsRequest request) { + return listAttachedSubscriptions(request, null); + } + + /** + * You can fetch a list of subscription types that are attached to a contact. These can be subscriptions that a user has 'opted-in' to or has 'opted-out' from, depending on the subscription type. + * This will return a list of Subscription Type objects that the contact is associated with. + *

The data property will show a combined list of:

+ *

1.Opt-out subscription types that the user has opted-out from. + * 2.Opt-in subscription types that the user has opted-in to receiving.

+ */ + public IntercomHttpResponse listAttachedSubscriptions( + ListAttachedSubscriptionsRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("contacts") + .addPathSegment(request.getContactId()) + .addPathSegments("subscriptions") + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, SubscriptionTypeList.class), response); + } + try { + switch (response.code()) { + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 404: + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can add a specific subscription to a contact. In Intercom, we have two different subscription types based on user consent - opt-out and opt-in: + *

1.Attaching a contact to an opt-out subscription type will opt that user out from receiving messages related to that subscription type.

+ *

2.Attaching a contact to an opt-in subscription type will opt that user in to receiving messages related to that subscription type.

+ *

This will return a subscription type model for the subscription type that was added to the contact.

+ */ + public IntercomHttpResponse attachSubscription(AttachSubscriptionToContactRequest request) { + return attachSubscription(request, null); + } + + /** + * You can add a specific subscription to a contact. In Intercom, we have two different subscription types based on user consent - opt-out and opt-in: + *

1.Attaching a contact to an opt-out subscription type will opt that user out from receiving messages related to that subscription type.

+ *

2.Attaching a contact to an opt-in subscription type will opt that user in to receiving messages related to that subscription type.

+ *

This will return a subscription type model for the subscription type that was added to the contact.

+ */ + public IntercomHttpResponse attachSubscription( + AttachSubscriptionToContactRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("contacts") + .addPathSegment(request.getContactId()) + .addPathSegments("subscriptions") + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, SubscriptionType.class), response); + } + try { + switch (response.code()) { + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 404: + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can remove a specific subscription from a contact. This will return a subscription type model for the subscription type that was removed from the contact. + */ + public IntercomHttpResponse detachSubscription(DetachSubscriptionFromContactRequest request) { + return detachSubscription(request, null); + } + + /** + * You can remove a specific subscription from a contact. This will return a subscription type model for the subscription type that was removed from the contact. + */ + public IntercomHttpResponse detachSubscription( + DetachSubscriptionFromContactRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("contacts") + .addPathSegment(request.getContactId()) + .addPathSegments("subscriptions") + .addPathSegment(request.getSubscriptionId()) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("DELETE", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, SubscriptionType.class), response); + } + try { + switch (response.code()) { + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 404: + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can fetch a list of all tags that are attached to a specific contact. + */ + public IntercomHttpResponse listAttachedTags(ListTagsAttachedToContactRequest request) { + return listAttachedTags(request, null); + } + + /** + * You can fetch a list of all tags that are attached to a specific contact. + */ + public IntercomHttpResponse listAttachedTags( + ListTagsAttachedToContactRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("contacts") + .addPathSegment(request.getContactId()) + .addPathSegments("tags") + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, TagList.class), response); + } + try { + switch (response.code()) { + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 404: + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can fetch the details of a single contact. + */ + public IntercomHttpResponse find(FindContactRequest request) { + return find(request, null); + } + + /** + * You can fetch the details of a single contact. + */ + public IntercomHttpResponse find(FindContactRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("contacts") + .addPathSegment(request.getContactId()) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, ContactsFindResponse.class), response); + } + try { + if (response.code() == 401) { + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can update an existing contact (ie. user or lead). + *

{% admonition type="info" %} + * This endpoint handles both contact updates and custom object associations.

+ *

See update a contact with an association to a custom object instance in the request/response examples to see the custom object association format. + * {% /admonition %}

+ */ + public IntercomHttpResponse update(UpdateContactRequest request) { + return update(request, null); + } + + /** + * You can update an existing contact (ie. user or lead). + *

{% admonition type="info" %} + * This endpoint handles both contact updates and custom object associations.

+ *

See update a contact with an association to a custom object instance in the request/response examples to see the custom object association format. + * {% /admonition %}

+ */ + public IntercomHttpResponse update( + UpdateContactRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("contacts") + .addPathSegment(request.getContactId()) + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("PUT", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, ContactsUpdateResponse.class), + response); + } + try { + if (response.code() == 401) { + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can delete a single contact. + */ + public IntercomHttpResponse delete(DeleteContactRequest request) { + return delete(request, null); + } + + /** + * You can delete a single contact. + */ + public IntercomHttpResponse delete(DeleteContactRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("contacts") + .addPathSegment(request.getContactId()) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("DELETE", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, ContactDeleted.class), response); + } + try { + if (response.code() == 401) { + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can merge a contact with a role of lead into a contact with a role of user. + */ + public IntercomHttpResponse mergeLeadInUser() { + return mergeLeadInUser(MergeContactsRequest.builder().build()); + } + + /** + * You can merge a contact with a role of lead into a contact with a role of user. + */ + public IntercomHttpResponse mergeLeadInUser(MergeContactsRequest request) { + return mergeLeadInUser(request, null); + } + + /** + * You can merge a contact with a role of lead into a contact with a role of user. + */ + public IntercomHttpResponse mergeLeadInUser( + MergeContactsRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("contacts/merge") + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, ContactsMergeLeadInUserResponse.class), + response); + } + try { + if (response.code() == 401) { + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can search for multiple contacts by the value of their attributes in order to fetch exactly who you want. + *

To search for contacts, you need to send a POST request to https://api.intercom.io/contacts/search.

+ *

This will accept a query object in the body which will define your filters in order to search for contacts.

+ *

{% admonition type="warning" name="Optimizing search queries" %} + * Search queries can be complex, so optimizing them can help the performance of your search. + * Use the AND and OR operators to combine multiple filters to get the exact results you need and utilize + * pagination to limit the number of results returned. The default is 50 results per page. + * See the pagination section for more details on how to use the starting_after param. + * {% /admonition %}

+ *

Contact Creation Delay

+ *

If a contact has recently been created, there is a possibility that it will not yet be available when searching. This means that it may not appear in the response. This delay can take a few minutes. If you need to be instantly notified it is recommended to use webhooks and iterate to see if they match your search filters.

+ *

Nesting & Limitations

+ *

You can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4). + * There are some limitations to the amount of multiple's there can be:

+ *
    + *
  • There's a limit of max 2 nested filters
    • + *
  • There's a limit of max 15 filters for each AND or OR group
    • + *
+ *

Searching for Timestamp Fields

+ *

All timestamp fields (created_at, updated_at etc.) are indexed as Dates for Contact Search queries; Datetime queries are not currently supported. This means you can only query for timestamp fields by day - not hour, minute or second. + * For example, if you search for all Contacts with a created_at value greater (>) than 1577869200 (the UNIX timestamp for January 1st, 2020 9:00 AM), that will be interpreted as 1577836800 (January 1st, 2020 12:00 AM). The search results will then include Contacts created from January 2nd, 2020 12:00 AM onwards. + * If you'd like to get contacts created on January 1st, 2020 you should search with a created_at value equal (=) to 1577836800 (January 1st, 2020 12:00 AM). + * This behaviour applies only to timestamps used in search queries. The search results will still contain the full UNIX timestamp and be sorted accordingly.

+ *

Accepted Fields

+ *

Most key listed as part of the Contacts Model are searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as created_at accepts a date, the value cannot be a string such as "foorbar").

+ *

| Field | Type | + * | ---------------------------------- | ------------------------------ | + * | id | String | + * | role | String<br>Accepts user or lead | + * | name | String | + * | avatar | String | + * | owner_id | Integer | + * | email | String | + * | email_domain | String | + * | phone | String | + * | external_id | String | + * | created_at | Date (UNIX Timestamp) | + * | signed_up_at | Date (UNIX Timestamp) | + * | updated_at | Date (UNIX Timestamp) | + * | last_seen_at | Date (UNIX Timestamp) | + * | last_contacted_at | Date (UNIX Timestamp) | + * | last_replied_at | Date (UNIX Timestamp) | + * | last_email_opened_at | Date (UNIX Timestamp) | + * | last_email_clicked_at | Date (UNIX Timestamp) | + * | language_override | String | + * | browser | String | + * | browser_language | String | + * | os | String | + * | location.country | String | + * | location.region | String | + * | location.city | String | + * | unsubscribed_from_emails | Boolean | + * | marked_email_as_spam | Boolean | + * | has_hard_bounced | Boolean | + * | ios_last_seen_at | Date (UNIX Timestamp) | + * | ios_app_version | String | + * | ios_device | String | + * | ios_app_device | String | + * | ios_os_version | String | + * | ios_app_name | String | + * | ios_sdk_version | String | + * | android_last_seen_at | Date (UNIX Timestamp) | + * | android_app_version | String | + * | android_device | String | + * | android_app_name | String | + * | andoid_sdk_version | String | + * | segment_id | String | + * | tag_id | String | + * | custom_attributes.{attribute_name} | String |

+ *

Accepted Operators

+ *

{% admonition type="warning" name="Searching based on created_at" %} + * You cannot use the <= or >= operators to search by created_at. + * {% /admonition %}

+ *

The table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string ("="). The operator has to be compatible with the field's type (eg. you cannot search with > for a given string value as it's only compatible for integer's and dates).

+ *

| Operator | Valid Types | Description | + * | :------- | :------------------------------- | :--------------------------------------------------------------- | + * | = | All | Equals | + * | != | All | Doesn't Equal | + * | IN | All | In<br>Shortcut for OR queries<br>Values must be in Array | + * | NIN | All | Not In<br>Shortcut for OR ! queries<br>Values must be in Array | + * | > | Integer<br>Date (UNIX Timestamp) | Greater than | + * | < | Integer<br>Date (UNIX Timestamp) | Lower than | + * | ~ | String | Contains | + * | !~ | String | Doesn't Contain | + * | ^ | String | Starts With | + * | $ | String | Ends With |

+ */ + public IntercomHttpResponse> search(SearchRequest request) { + return search(request, null); + } + + /** + * You can search for multiple contacts by the value of their attributes in order to fetch exactly who you want. + *

To search for contacts, you need to send a POST request to https://api.intercom.io/contacts/search.

+ *

This will accept a query object in the body which will define your filters in order to search for contacts.

+ *

{% admonition type="warning" name="Optimizing search queries" %} + * Search queries can be complex, so optimizing them can help the performance of your search. + * Use the AND and OR operators to combine multiple filters to get the exact results you need and utilize + * pagination to limit the number of results returned. The default is 50 results per page. + * See the pagination section for more details on how to use the starting_after param. + * {% /admonition %}

+ *

Contact Creation Delay

+ *

If a contact has recently been created, there is a possibility that it will not yet be available when searching. This means that it may not appear in the response. This delay can take a few minutes. If you need to be instantly notified it is recommended to use webhooks and iterate to see if they match your search filters.

+ *

Nesting & Limitations

+ *

You can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4). + * There are some limitations to the amount of multiple's there can be:

+ *
    + *
  • There's a limit of max 2 nested filters
    • + *
  • There's a limit of max 15 filters for each AND or OR group
    • + *
+ *

Searching for Timestamp Fields

+ *

All timestamp fields (created_at, updated_at etc.) are indexed as Dates for Contact Search queries; Datetime queries are not currently supported. This means you can only query for timestamp fields by day - not hour, minute or second. + * For example, if you search for all Contacts with a created_at value greater (>) than 1577869200 (the UNIX timestamp for January 1st, 2020 9:00 AM), that will be interpreted as 1577836800 (January 1st, 2020 12:00 AM). The search results will then include Contacts created from January 2nd, 2020 12:00 AM onwards. + * If you'd like to get contacts created on January 1st, 2020 you should search with a created_at value equal (=) to 1577836800 (January 1st, 2020 12:00 AM). + * This behaviour applies only to timestamps used in search queries. The search results will still contain the full UNIX timestamp and be sorted accordingly.

+ *

Accepted Fields

+ *

Most key listed as part of the Contacts Model are searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as created_at accepts a date, the value cannot be a string such as "foorbar").

+ *

| Field | Type | + * | ---------------------------------- | ------------------------------ | + * | id | String | + * | role | String<br>Accepts user or lead | + * | name | String | + * | avatar | String | + * | owner_id | Integer | + * | email | String | + * | email_domain | String | + * | phone | String | + * | external_id | String | + * | created_at | Date (UNIX Timestamp) | + * | signed_up_at | Date (UNIX Timestamp) | + * | updated_at | Date (UNIX Timestamp) | + * | last_seen_at | Date (UNIX Timestamp) | + * | last_contacted_at | Date (UNIX Timestamp) | + * | last_replied_at | Date (UNIX Timestamp) | + * | last_email_opened_at | Date (UNIX Timestamp) | + * | last_email_clicked_at | Date (UNIX Timestamp) | + * | language_override | String | + * | browser | String | + * | browser_language | String | + * | os | String | + * | location.country | String | + * | location.region | String | + * | location.city | String | + * | unsubscribed_from_emails | Boolean | + * | marked_email_as_spam | Boolean | + * | has_hard_bounced | Boolean | + * | ios_last_seen_at | Date (UNIX Timestamp) | + * | ios_app_version | String | + * | ios_device | String | + * | ios_app_device | String | + * | ios_os_version | String | + * | ios_app_name | String | + * | ios_sdk_version | String | + * | android_last_seen_at | Date (UNIX Timestamp) | + * | android_app_version | String | + * | android_device | String | + * | android_app_name | String | + * | andoid_sdk_version | String | + * | segment_id | String | + * | tag_id | String | + * | custom_attributes.{attribute_name} | String |

+ *

Accepted Operators

+ *

{% admonition type="warning" name="Searching based on created_at" %} + * You cannot use the <= or >= operators to search by created_at. + * {% /admonition %}

+ *

The table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string ("="). The operator has to be compatible with the field's type (eg. you cannot search with > for a given string value as it's only compatible for integer's and dates).

+ *

| Operator | Valid Types | Description | + * | :------- | :------------------------------- | :--------------------------------------------------------------- | + * | = | All | Equals | + * | != | All | Doesn't Equal | + * | IN | All | In<br>Shortcut for OR queries<br>Values must be in Array | + * | NIN | All | Not In<br>Shortcut for OR ! queries<br>Values must be in Array | + * | > | Integer<br>Date (UNIX Timestamp) | Greater than | + * | < | Integer<br>Date (UNIX Timestamp) | Lower than | + * | ~ | String | Contains | + * | !~ | String | Doesn't Contain | + * | ^ | String | Starts With | + * | $ | String | Ends With |

+ */ + public IntercomHttpResponse> search( + SearchRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("contacts/search") + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + ContactList parsedResponse = ObjectMappers.JSON_MAPPER.readValue(responseBodyString, ContactList.class); + Optional startingAfter = parsedResponse + .getPages() + .flatMap(CursorPages::getNext) + .flatMap(StartingAfterPaging::getStartingAfter); + Optional pagination = request.getPagination() + .map((StartingAfterPaging pagination_) -> StartingAfterPaging.builder() + .from(pagination_) + .startingAfter(startingAfter) + .build()); + SearchRequest nextRequest = SearchRequest.builder() + .from(request) + .pagination(pagination) + .build(); + List result = parsedResponse.getData().orElse(Collections.emptyList()); + return new IntercomHttpResponse<>( + new SyncPagingIterable(startingAfter.isPresent(), result, parsedResponse, () -> search( + nextRequest, requestOptions) + .body()), + response); + } + try { + if (response.code() == 401) { + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can fetch a list of all contacts (ie. users or leads) in your workspace. + * {% admonition type="warning" name="Pagination" %} + * You can use pagination to limit the number of results returned. The default is 50 results per page. + * See the pagination section for more details on how to use the starting_after param. + * {% /admonition %} + */ + public IntercomHttpResponse> list() { + return list(ListContactsRequest.builder().build()); + } + + /** + * You can fetch a list of all contacts (ie. users or leads) in your workspace. + * {% admonition type="warning" name="Pagination" %} + * You can use pagination to limit the number of results returned. The default is 50 results per page. + * See the pagination section for more details on how to use the starting_after param. + * {% /admonition %} + */ + public IntercomHttpResponse> list(ListContactsRequest request) { + return list(request, null); + } + + /** + * You can fetch a list of all contacts (ie. users or leads) in your workspace. + * {% admonition type="warning" name="Pagination" %} + * You can use pagination to limit the number of results returned. The default is 50 results per page. + * See the pagination section for more details on how to use the starting_after param. + * {% /admonition %} + */ + public IntercomHttpResponse> list( + ListContactsRequest request, RequestOptions requestOptions) { + HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("contacts"); + if (request.getPage().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "page", request.getPage().get(), false); + } + if (request.getPerPage().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "per_page", request.getPerPage().get(), false); + } + if (request.getStartingAfter().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "starting_after", request.getStartingAfter().get(), false); + } + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl.build()) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + ContactList parsedResponse = ObjectMappers.JSON_MAPPER.readValue(responseBodyString, ContactList.class); + Optional startingAfter = parsedResponse + .getPages() + .flatMap(CursorPages::getNext) + .flatMap(StartingAfterPaging::getStartingAfter); + ListContactsRequest nextRequest = ListContactsRequest.builder() + .from(request) + .startingAfter(startingAfter) + .build(); + List result = parsedResponse.getData().orElse(Collections.emptyList()); + return new IntercomHttpResponse<>( + new SyncPagingIterable(startingAfter.isPresent(), result, parsedResponse, () -> list( + nextRequest, requestOptions) + .body()), + response); + } + try { + if (response.code() == 401) { + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can create a new contact (ie. user or lead). + */ + public IntercomHttpResponse create(CreateContactRequest request) { + return create(request, null); + } + + /** + * You can create a new contact (ie. user or lead). + */ + public IntercomHttpResponse create( + CreateContactRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("contacts") + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, ContactsCreateResponse.class), + response); + } + try { + if (response.code() == 401) { + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can fetch the details of a single contact by external ID. Note that this endpoint only supports users and not leads. + */ + public IntercomHttpResponse showContactByExternalId( + ShowContactByExternalIdRequest request) { + return showContactByExternalId(request, null); + } + + /** + * You can fetch the details of a single contact by external ID. Note that this endpoint only supports users and not leads. + */ + public IntercomHttpResponse showContactByExternalId( + ShowContactByExternalIdRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("contacts/find_by_external_id") + .addPathSegment(request.getExternalId()) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, ShowContactByExternalIdResponse.class), + response); + } + try { + if (response.code() == 401) { + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can archive a single contact. + */ + public IntercomHttpResponse archive(ArchiveContactRequest request) { + return archive(request, null); + } + + /** + * You can archive a single contact. + */ + public IntercomHttpResponse archive(ArchiveContactRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("contacts") + .addPathSegment(request.getContactId()) + .addPathSegments("archive") + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("POST", RequestBody.create("", null)) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, ContactArchived.class), response); + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can unarchive a single contact. + */ + public IntercomHttpResponse unarchive(UnarchiveContactRequest request) { + return unarchive(request, null); + } + + /** + * You can unarchive a single contact. + */ + public IntercomHttpResponse unarchive( + UnarchiveContactRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("contacts") + .addPathSegment(request.getContactId()) + .addPathSegments("unarchive") + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("POST", RequestBody.create("", null)) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, ContactUnarchived.class), response); + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * Block a single contact.<br>Note: conversations of the contact will also be archived during the process.<br>More details in FAQ How do I block Inbox spam? + */ + public IntercomHttpResponse blockContact(BlockContactRequest request) { + return blockContact(request, null); + } + + /** + * Block a single contact.<br>Note: conversations of the contact will also be archived during the process.<br>More details in FAQ How do I block Inbox spam? + */ + public IntercomHttpResponse blockContact( + BlockContactRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("contacts") + .addPathSegment(request.getContactId()) + .addPathSegments("block") + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("POST", RequestBody.create("", null)) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, ContactBlocked.class), response); + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/contacts/requests/ArchiveContactRequest.java b/src/main/java/com/intercom/api/resources/contacts/requests/ArchiveContactRequest.java new file mode 100644 index 00000000..70861a41 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/contacts/requests/ArchiveContactRequest.java @@ -0,0 +1,113 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.contacts.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = ArchiveContactRequest.Builder.class) +public final class ArchiveContactRequest { + private final String contactId; + + private final Map additionalProperties; + + private ArchiveContactRequest(String contactId, Map additionalProperties) { + this.contactId = contactId; + this.additionalProperties = additionalProperties; + } + + /** + * @return contact_id + */ + @JsonProperty("contact_id") + public String getContactId() { + return contactId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof ArchiveContactRequest && equalTo((ArchiveContactRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(ArchiveContactRequest other) { + return contactId.equals(other.contactId); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.contactId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static ContactIdStage builder() { + return new Builder(); + } + + public interface ContactIdStage { + /** + *

contact_id

+ */ + _FinalStage contactId(@NotNull String contactId); + + Builder from(ArchiveContactRequest other); + } + + public interface _FinalStage { + ArchiveContactRequest build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements ContactIdStage, _FinalStage { + private String contactId; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(ArchiveContactRequest other) { + contactId(other.getContactId()); + return this; + } + + /** + *

contact_id

+ *

contact_id

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("contact_id") + public _FinalStage contactId(@NotNull String contactId) { + this.contactId = Objects.requireNonNull(contactId, "contactId must not be null"); + return this; + } + + @java.lang.Override + public ArchiveContactRequest build() { + return new ArchiveContactRequest(contactId, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/contacts/requests/AttachSubscriptionToContactRequest.java b/src/main/java/com/intercom/api/resources/contacts/requests/AttachSubscriptionToContactRequest.java new file mode 100644 index 00000000..808e9322 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/contacts/requests/AttachSubscriptionToContactRequest.java @@ -0,0 +1,183 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.contacts.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = AttachSubscriptionToContactRequest.Builder.class) +public final class AttachSubscriptionToContactRequest { + private final String contactId; + + private final String subscriptionId; + + private final String consentType; + + private final Map additionalProperties; + + private AttachSubscriptionToContactRequest( + String contactId, String subscriptionId, String consentType, Map additionalProperties) { + this.contactId = contactId; + this.subscriptionId = subscriptionId; + this.consentType = consentType; + this.additionalProperties = additionalProperties; + } + + /** + * @return The unique identifier for the contact which is given by Intercom + */ + @JsonProperty("contact_id") + public String getContactId() { + return contactId; + } + + /** + * @return The unique identifier for the subscription which is given by Intercom + */ + @JsonProperty("id") + public String getSubscriptionId() { + return subscriptionId; + } + + /** + * @return The consent_type of a subscription, opt_out or opt_in. + */ + @JsonProperty("consent_type") + public String getConsentType() { + return consentType; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof AttachSubscriptionToContactRequest + && equalTo((AttachSubscriptionToContactRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(AttachSubscriptionToContactRequest other) { + return contactId.equals(other.contactId) + && subscriptionId.equals(other.subscriptionId) + && consentType.equals(other.consentType); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.contactId, this.subscriptionId, this.consentType); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static ContactIdStage builder() { + return new Builder(); + } + + public interface ContactIdStage { + /** + *

The unique identifier for the contact which is given by Intercom

+ */ + SubscriptionIdStage contactId(@NotNull String contactId); + + Builder from(AttachSubscriptionToContactRequest other); + } + + public interface SubscriptionIdStage { + /** + *

The unique identifier for the subscription which is given by Intercom

+ */ + ConsentTypeStage subscriptionId(@NotNull String subscriptionId); + } + + public interface ConsentTypeStage { + /** + *

The consent_type of a subscription, opt_out or opt_in.

+ */ + _FinalStage consentType(@NotNull String consentType); + } + + public interface _FinalStage { + AttachSubscriptionToContactRequest build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements ContactIdStage, SubscriptionIdStage, ConsentTypeStage, _FinalStage { + private String contactId; + + private String subscriptionId; + + private String consentType; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(AttachSubscriptionToContactRequest other) { + contactId(other.getContactId()); + subscriptionId(other.getSubscriptionId()); + consentType(other.getConsentType()); + return this; + } + + /** + *

The unique identifier for the contact which is given by Intercom

+ *

The unique identifier for the contact which is given by Intercom

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("contact_id") + public SubscriptionIdStage contactId(@NotNull String contactId) { + this.contactId = Objects.requireNonNull(contactId, "contactId must not be null"); + return this; + } + + /** + *

The unique identifier for the subscription which is given by Intercom

+ *

The unique identifier for the subscription which is given by Intercom

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("id") + public ConsentTypeStage subscriptionId(@NotNull String subscriptionId) { + this.subscriptionId = Objects.requireNonNull(subscriptionId, "subscriptionId must not be null"); + return this; + } + + /** + *

The consent_type of a subscription, opt_out or opt_in.

+ *

The consent_type of a subscription, opt_out or opt_in.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("consent_type") + public _FinalStage consentType(@NotNull String consentType) { + this.consentType = Objects.requireNonNull(consentType, "consentType must not be null"); + return this; + } + + @java.lang.Override + public AttachSubscriptionToContactRequest build() { + return new AttachSubscriptionToContactRequest(contactId, subscriptionId, consentType, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/contacts/requests/BlockContactRequest.java b/src/main/java/com/intercom/api/resources/contacts/requests/BlockContactRequest.java new file mode 100644 index 00000000..3d3c0edf --- /dev/null +++ b/src/main/java/com/intercom/api/resources/contacts/requests/BlockContactRequest.java @@ -0,0 +1,113 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.contacts.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = BlockContactRequest.Builder.class) +public final class BlockContactRequest { + private final String contactId; + + private final Map additionalProperties; + + private BlockContactRequest(String contactId, Map additionalProperties) { + this.contactId = contactId; + this.additionalProperties = additionalProperties; + } + + /** + * @return contact_id + */ + @JsonProperty("contact_id") + public String getContactId() { + return contactId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof BlockContactRequest && equalTo((BlockContactRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(BlockContactRequest other) { + return contactId.equals(other.contactId); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.contactId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static ContactIdStage builder() { + return new Builder(); + } + + public interface ContactIdStage { + /** + *

contact_id

+ */ + _FinalStage contactId(@NotNull String contactId); + + Builder from(BlockContactRequest other); + } + + public interface _FinalStage { + BlockContactRequest build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements ContactIdStage, _FinalStage { + private String contactId; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(BlockContactRequest other) { + contactId(other.getContactId()); + return this; + } + + /** + *

contact_id

+ *

contact_id

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("contact_id") + public _FinalStage contactId(@NotNull String contactId) { + this.contactId = Objects.requireNonNull(contactId, "contactId must not be null"); + return this; + } + + @java.lang.Override + public BlockContactRequest build() { + return new BlockContactRequest(contactId, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/contacts/requests/DeleteContactRequest.java b/src/main/java/com/intercom/api/resources/contacts/requests/DeleteContactRequest.java new file mode 100644 index 00000000..354b9cbc --- /dev/null +++ b/src/main/java/com/intercom/api/resources/contacts/requests/DeleteContactRequest.java @@ -0,0 +1,113 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.contacts.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = DeleteContactRequest.Builder.class) +public final class DeleteContactRequest { + private final String contactId; + + private final Map additionalProperties; + + private DeleteContactRequest(String contactId, Map additionalProperties) { + this.contactId = contactId; + this.additionalProperties = additionalProperties; + } + + /** + * @return contact_id + */ + @JsonProperty("contact_id") + public String getContactId() { + return contactId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof DeleteContactRequest && equalTo((DeleteContactRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(DeleteContactRequest other) { + return contactId.equals(other.contactId); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.contactId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static ContactIdStage builder() { + return new Builder(); + } + + public interface ContactIdStage { + /** + *

contact_id

+ */ + _FinalStage contactId(@NotNull String contactId); + + Builder from(DeleteContactRequest other); + } + + public interface _FinalStage { + DeleteContactRequest build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements ContactIdStage, _FinalStage { + private String contactId; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(DeleteContactRequest other) { + contactId(other.getContactId()); + return this; + } + + /** + *

contact_id

+ *

contact_id

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("contact_id") + public _FinalStage contactId(@NotNull String contactId) { + this.contactId = Objects.requireNonNull(contactId, "contactId must not be null"); + return this; + } + + @java.lang.Override + public DeleteContactRequest build() { + return new DeleteContactRequest(contactId, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/contacts/requests/DetachSubscriptionFromContactRequest.java b/src/main/java/com/intercom/api/resources/contacts/requests/DetachSubscriptionFromContactRequest.java new file mode 100644 index 00000000..145d9162 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/contacts/requests/DetachSubscriptionFromContactRequest.java @@ -0,0 +1,148 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.contacts.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = DetachSubscriptionFromContactRequest.Builder.class) +public final class DetachSubscriptionFromContactRequest { + private final String contactId; + + private final String subscriptionId; + + private final Map additionalProperties; + + private DetachSubscriptionFromContactRequest( + String contactId, String subscriptionId, Map additionalProperties) { + this.contactId = contactId; + this.subscriptionId = subscriptionId; + this.additionalProperties = additionalProperties; + } + + /** + * @return The unique identifier for the contact which is given by Intercom + */ + @JsonProperty("contact_id") + public String getContactId() { + return contactId; + } + + /** + * @return The unique identifier for the subscription type which is given by Intercom + */ + @JsonProperty("subscription_id") + public String getSubscriptionId() { + return subscriptionId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof DetachSubscriptionFromContactRequest + && equalTo((DetachSubscriptionFromContactRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(DetachSubscriptionFromContactRequest other) { + return contactId.equals(other.contactId) && subscriptionId.equals(other.subscriptionId); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.contactId, this.subscriptionId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static ContactIdStage builder() { + return new Builder(); + } + + public interface ContactIdStage { + /** + *

The unique identifier for the contact which is given by Intercom

+ */ + SubscriptionIdStage contactId(@NotNull String contactId); + + Builder from(DetachSubscriptionFromContactRequest other); + } + + public interface SubscriptionIdStage { + /** + *

The unique identifier for the subscription type which is given by Intercom

+ */ + _FinalStage subscriptionId(@NotNull String subscriptionId); + } + + public interface _FinalStage { + DetachSubscriptionFromContactRequest build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements ContactIdStage, SubscriptionIdStage, _FinalStage { + private String contactId; + + private String subscriptionId; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(DetachSubscriptionFromContactRequest other) { + contactId(other.getContactId()); + subscriptionId(other.getSubscriptionId()); + return this; + } + + /** + *

The unique identifier for the contact which is given by Intercom

+ *

The unique identifier for the contact which is given by Intercom

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("contact_id") + public SubscriptionIdStage contactId(@NotNull String contactId) { + this.contactId = Objects.requireNonNull(contactId, "contactId must not be null"); + return this; + } + + /** + *

The unique identifier for the subscription type which is given by Intercom

+ *

The unique identifier for the subscription type which is given by Intercom

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("subscription_id") + public _FinalStage subscriptionId(@NotNull String subscriptionId) { + this.subscriptionId = Objects.requireNonNull(subscriptionId, "subscriptionId must not be null"); + return this; + } + + @java.lang.Override + public DetachSubscriptionFromContactRequest build() { + return new DetachSubscriptionFromContactRequest(contactId, subscriptionId, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/contacts/requests/FindContactRequest.java b/src/main/java/com/intercom/api/resources/contacts/requests/FindContactRequest.java new file mode 100644 index 00000000..762c74f7 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/contacts/requests/FindContactRequest.java @@ -0,0 +1,113 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.contacts.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = FindContactRequest.Builder.class) +public final class FindContactRequest { + private final String contactId; + + private final Map additionalProperties; + + private FindContactRequest(String contactId, Map additionalProperties) { + this.contactId = contactId; + this.additionalProperties = additionalProperties; + } + + /** + * @return contact_id + */ + @JsonProperty("contact_id") + public String getContactId() { + return contactId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof FindContactRequest && equalTo((FindContactRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(FindContactRequest other) { + return contactId.equals(other.contactId); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.contactId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static ContactIdStage builder() { + return new Builder(); + } + + public interface ContactIdStage { + /** + *

contact_id

+ */ + _FinalStage contactId(@NotNull String contactId); + + Builder from(FindContactRequest other); + } + + public interface _FinalStage { + FindContactRequest build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements ContactIdStage, _FinalStage { + private String contactId; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(FindContactRequest other) { + contactId(other.getContactId()); + return this; + } + + /** + *

contact_id

+ *

contact_id

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("contact_id") + public _FinalStage contactId(@NotNull String contactId) { + this.contactId = Objects.requireNonNull(contactId, "contactId must not be null"); + return this; + } + + @java.lang.Override + public FindContactRequest build() { + return new FindContactRequest(contactId, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/contacts/requests/ListAttachedCompaniesRequest.java b/src/main/java/com/intercom/api/resources/contacts/requests/ListAttachedCompaniesRequest.java new file mode 100644 index 00000000..259bfd2d --- /dev/null +++ b/src/main/java/com/intercom/api/resources/contacts/requests/ListAttachedCompaniesRequest.java @@ -0,0 +1,201 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.contacts.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = ListAttachedCompaniesRequest.Builder.class) +public final class ListAttachedCompaniesRequest { + private final String contactId; + + private final Optional page; + + private final Optional perPage; + + private final Map additionalProperties; + + private ListAttachedCompaniesRequest( + String contactId, + Optional page, + Optional perPage, + Map additionalProperties) { + this.contactId = contactId; + this.page = page; + this.perPage = perPage; + this.additionalProperties = additionalProperties; + } + + /** + * @return The unique identifier for the contact which is given by Intercom + */ + @JsonProperty("contact_id") + public String getContactId() { + return contactId; + } + + /** + * @return The page of results to fetch. Defaults to first page + */ + @JsonProperty("page") + public Optional getPage() { + return page; + } + + /** + * @return How many results to display per page. Defaults to 15 + */ + @JsonProperty("per_page") + public Optional getPerPage() { + return perPage; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof ListAttachedCompaniesRequest && equalTo((ListAttachedCompaniesRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(ListAttachedCompaniesRequest other) { + return contactId.equals(other.contactId) && page.equals(other.page) && perPage.equals(other.perPage); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.contactId, this.page, this.perPage); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static ContactIdStage builder() { + return new Builder(); + } + + public interface ContactIdStage { + /** + *

The unique identifier for the contact which is given by Intercom

+ */ + _FinalStage contactId(@NotNull String contactId); + + Builder from(ListAttachedCompaniesRequest other); + } + + public interface _FinalStage { + ListAttachedCompaniesRequest build(); + + /** + *

The page of results to fetch. Defaults to first page

+ */ + _FinalStage page(Optional page); + + _FinalStage page(Integer page); + + /** + *

How many results to display per page. Defaults to 15

+ */ + _FinalStage perPage(Optional perPage); + + _FinalStage perPage(Integer perPage); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements ContactIdStage, _FinalStage { + private String contactId; + + private Optional perPage = Optional.empty(); + + private Optional page = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(ListAttachedCompaniesRequest other) { + contactId(other.getContactId()); + page(other.getPage()); + perPage(other.getPerPage()); + return this; + } + + /** + *

The unique identifier for the contact which is given by Intercom

+ *

The unique identifier for the contact which is given by Intercom

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("contact_id") + public _FinalStage contactId(@NotNull String contactId) { + this.contactId = Objects.requireNonNull(contactId, "contactId must not be null"); + return this; + } + + /** + *

How many results to display per page. Defaults to 15

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage perPage(Integer perPage) { + this.perPage = Optional.ofNullable(perPage); + return this; + } + + /** + *

How many results to display per page. Defaults to 15

+ */ + @java.lang.Override + @JsonSetter(value = "per_page", nulls = Nulls.SKIP) + public _FinalStage perPage(Optional perPage) { + this.perPage = perPage; + return this; + } + + /** + *

The page of results to fetch. Defaults to first page

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage page(Integer page) { + this.page = Optional.ofNullable(page); + return this; + } + + /** + *

The page of results to fetch. Defaults to first page

+ */ + @java.lang.Override + @JsonSetter(value = "page", nulls = Nulls.SKIP) + public _FinalStage page(Optional page) { + this.page = page; + return this; + } + + @java.lang.Override + public ListAttachedCompaniesRequest build() { + return new ListAttachedCompaniesRequest(contactId, page, perPage, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/contacts/requests/ListAttachedSubscriptionsRequest.java b/src/main/java/com/intercom/api/resources/contacts/requests/ListAttachedSubscriptionsRequest.java new file mode 100644 index 00000000..db91f2df --- /dev/null +++ b/src/main/java/com/intercom/api/resources/contacts/requests/ListAttachedSubscriptionsRequest.java @@ -0,0 +1,113 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.contacts.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = ListAttachedSubscriptionsRequest.Builder.class) +public final class ListAttachedSubscriptionsRequest { + private final String contactId; + + private final Map additionalProperties; + + private ListAttachedSubscriptionsRequest(String contactId, Map additionalProperties) { + this.contactId = contactId; + this.additionalProperties = additionalProperties; + } + + /** + * @return The unique identifier for the contact which is given by Intercom + */ + @JsonProperty("contact_id") + public String getContactId() { + return contactId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof ListAttachedSubscriptionsRequest && equalTo((ListAttachedSubscriptionsRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(ListAttachedSubscriptionsRequest other) { + return contactId.equals(other.contactId); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.contactId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static ContactIdStage builder() { + return new Builder(); + } + + public interface ContactIdStage { + /** + *

The unique identifier for the contact which is given by Intercom

+ */ + _FinalStage contactId(@NotNull String contactId); + + Builder from(ListAttachedSubscriptionsRequest other); + } + + public interface _FinalStage { + ListAttachedSubscriptionsRequest build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements ContactIdStage, _FinalStage { + private String contactId; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(ListAttachedSubscriptionsRequest other) { + contactId(other.getContactId()); + return this; + } + + /** + *

The unique identifier for the contact which is given by Intercom

+ *

The unique identifier for the contact which is given by Intercom

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("contact_id") + public _FinalStage contactId(@NotNull String contactId) { + this.contactId = Objects.requireNonNull(contactId, "contactId must not be null"); + return this; + } + + @java.lang.Override + public ListAttachedSubscriptionsRequest build() { + return new ListAttachedSubscriptionsRequest(contactId, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/contacts/requests/ListContactsRequest.java b/src/main/java/com/intercom/api/resources/contacts/requests/ListContactsRequest.java new file mode 100644 index 00000000..af15c208 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/contacts/requests/ListContactsRequest.java @@ -0,0 +1,161 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.contacts.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = ListContactsRequest.Builder.class) +public final class ListContactsRequest { + private final Optional page; + + private final Optional perPage; + + private final Optional startingAfter; + + private final Map additionalProperties; + + private ListContactsRequest( + Optional page, + Optional perPage, + Optional startingAfter, + Map additionalProperties) { + this.page = page; + this.perPage = perPage; + this.startingAfter = startingAfter; + this.additionalProperties = additionalProperties; + } + + /** + * @return The page of results to fetch. Defaults to first page + */ + @JsonProperty("page") + public Optional getPage() { + return page; + } + + /** + * @return How many results to display per page. Defaults to 15 + */ + @JsonProperty("per_page") + public Optional getPerPage() { + return perPage; + } + + /** + * @return String used to get the next page of conversations. + */ + @JsonProperty("starting_after") + public Optional getStartingAfter() { + return startingAfter; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof ListContactsRequest && equalTo((ListContactsRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(ListContactsRequest other) { + return page.equals(other.page) && perPage.equals(other.perPage) && startingAfter.equals(other.startingAfter); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.page, this.perPage, this.startingAfter); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static Builder builder() { + return new Builder(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder { + private Optional page = Optional.empty(); + + private Optional perPage = Optional.empty(); + + private Optional startingAfter = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + public Builder from(ListContactsRequest other) { + page(other.getPage()); + perPage(other.getPerPage()); + startingAfter(other.getStartingAfter()); + return this; + } + + /** + *

The page of results to fetch. Defaults to first page

+ */ + @JsonSetter(value = "page", nulls = Nulls.SKIP) + public Builder page(Optional page) { + this.page = page; + return this; + } + + public Builder page(Integer page) { + this.page = Optional.ofNullable(page); + return this; + } + + /** + *

How many results to display per page. Defaults to 15

+ */ + @JsonSetter(value = "per_page", nulls = Nulls.SKIP) + public Builder perPage(Optional perPage) { + this.perPage = perPage; + return this; + } + + public Builder perPage(Integer perPage) { + this.perPage = Optional.ofNullable(perPage); + return this; + } + + /** + *

String used to get the next page of conversations.

+ */ + @JsonSetter(value = "starting_after", nulls = Nulls.SKIP) + public Builder startingAfter(Optional startingAfter) { + this.startingAfter = startingAfter; + return this; + } + + public Builder startingAfter(String startingAfter) { + this.startingAfter = Optional.ofNullable(startingAfter); + return this; + } + + public ListContactsRequest build() { + return new ListContactsRequest(page, perPage, startingAfter, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/contacts/requests/ListSegmentsAttachedToContactRequest.java b/src/main/java/com/intercom/api/resources/contacts/requests/ListSegmentsAttachedToContactRequest.java new file mode 100644 index 00000000..9cb06af1 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/contacts/requests/ListSegmentsAttachedToContactRequest.java @@ -0,0 +1,114 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.contacts.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = ListSegmentsAttachedToContactRequest.Builder.class) +public final class ListSegmentsAttachedToContactRequest { + private final String contactId; + + private final Map additionalProperties; + + private ListSegmentsAttachedToContactRequest(String contactId, Map additionalProperties) { + this.contactId = contactId; + this.additionalProperties = additionalProperties; + } + + /** + * @return The unique identifier for the contact which is given by Intercom + */ + @JsonProperty("contact_id") + public String getContactId() { + return contactId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof ListSegmentsAttachedToContactRequest + && equalTo((ListSegmentsAttachedToContactRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(ListSegmentsAttachedToContactRequest other) { + return contactId.equals(other.contactId); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.contactId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static ContactIdStage builder() { + return new Builder(); + } + + public interface ContactIdStage { + /** + *

The unique identifier for the contact which is given by Intercom

+ */ + _FinalStage contactId(@NotNull String contactId); + + Builder from(ListSegmentsAttachedToContactRequest other); + } + + public interface _FinalStage { + ListSegmentsAttachedToContactRequest build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements ContactIdStage, _FinalStage { + private String contactId; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(ListSegmentsAttachedToContactRequest other) { + contactId(other.getContactId()); + return this; + } + + /** + *

The unique identifier for the contact which is given by Intercom

+ *

The unique identifier for the contact which is given by Intercom

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("contact_id") + public _FinalStage contactId(@NotNull String contactId) { + this.contactId = Objects.requireNonNull(contactId, "contactId must not be null"); + return this; + } + + @java.lang.Override + public ListSegmentsAttachedToContactRequest build() { + return new ListSegmentsAttachedToContactRequest(contactId, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/contacts/requests/ListTagsAttachedToContactRequest.java b/src/main/java/com/intercom/api/resources/contacts/requests/ListTagsAttachedToContactRequest.java new file mode 100644 index 00000000..e3f35bdc --- /dev/null +++ b/src/main/java/com/intercom/api/resources/contacts/requests/ListTagsAttachedToContactRequest.java @@ -0,0 +1,113 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.contacts.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = ListTagsAttachedToContactRequest.Builder.class) +public final class ListTagsAttachedToContactRequest { + private final String contactId; + + private final Map additionalProperties; + + private ListTagsAttachedToContactRequest(String contactId, Map additionalProperties) { + this.contactId = contactId; + this.additionalProperties = additionalProperties; + } + + /** + * @return The unique identifier for the contact which is given by Intercom + */ + @JsonProperty("contact_id") + public String getContactId() { + return contactId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof ListTagsAttachedToContactRequest && equalTo((ListTagsAttachedToContactRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(ListTagsAttachedToContactRequest other) { + return contactId.equals(other.contactId); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.contactId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static ContactIdStage builder() { + return new Builder(); + } + + public interface ContactIdStage { + /** + *

The unique identifier for the contact which is given by Intercom

+ */ + _FinalStage contactId(@NotNull String contactId); + + Builder from(ListTagsAttachedToContactRequest other); + } + + public interface _FinalStage { + ListTagsAttachedToContactRequest build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements ContactIdStage, _FinalStage { + private String contactId; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(ListTagsAttachedToContactRequest other) { + contactId(other.getContactId()); + return this; + } + + /** + *

The unique identifier for the contact which is given by Intercom

+ *

The unique identifier for the contact which is given by Intercom

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("contact_id") + public _FinalStage contactId(@NotNull String contactId) { + this.contactId = Objects.requireNonNull(contactId, "contactId must not be null"); + return this; + } + + @java.lang.Override + public ListTagsAttachedToContactRequest build() { + return new ListTagsAttachedToContactRequest(contactId, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/contacts/requests/MergeContactsRequest.java b/src/main/java/com/intercom/api/resources/contacts/requests/MergeContactsRequest.java new file mode 100644 index 00000000..987743b5 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/contacts/requests/MergeContactsRequest.java @@ -0,0 +1,130 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.contacts.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = MergeContactsRequest.Builder.class) +public final class MergeContactsRequest { + private final Optional leadId; + + private final Optional contactId; + + private final Map additionalProperties; + + private MergeContactsRequest( + Optional leadId, Optional contactId, Map additionalProperties) { + this.leadId = leadId; + this.contactId = contactId; + this.additionalProperties = additionalProperties; + } + + /** + * @return The unique identifier for the contact to merge away from. Must be a lead. + */ + @JsonProperty("from") + public Optional getLeadId() { + return leadId; + } + + /** + * @return The unique identifier for the contact to merge into. Must be a user. + */ + @JsonProperty("into") + public Optional getContactId() { + return contactId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof MergeContactsRequest && equalTo((MergeContactsRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(MergeContactsRequest other) { + return leadId.equals(other.leadId) && contactId.equals(other.contactId); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.leadId, this.contactId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static Builder builder() { + return new Builder(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder { + private Optional leadId = Optional.empty(); + + private Optional contactId = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + public Builder from(MergeContactsRequest other) { + leadId(other.getLeadId()); + contactId(other.getContactId()); + return this; + } + + /** + *

The unique identifier for the contact to merge away from. Must be a lead.

+ */ + @JsonSetter(value = "from", nulls = Nulls.SKIP) + public Builder leadId(Optional leadId) { + this.leadId = leadId; + return this; + } + + public Builder leadId(String leadId) { + this.leadId = Optional.ofNullable(leadId); + return this; + } + + /** + *

The unique identifier for the contact to merge into. Must be a user.

+ */ + @JsonSetter(value = "into", nulls = Nulls.SKIP) + public Builder contactId(Optional contactId) { + this.contactId = contactId; + return this; + } + + public Builder contactId(String contactId) { + this.contactId = Optional.ofNullable(contactId); + return this; + } + + public MergeContactsRequest build() { + return new MergeContactsRequest(leadId, contactId, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/contacts/requests/ShowContactByExternalIdRequest.java b/src/main/java/com/intercom/api/resources/contacts/requests/ShowContactByExternalIdRequest.java new file mode 100644 index 00000000..1be7dd7c --- /dev/null +++ b/src/main/java/com/intercom/api/resources/contacts/requests/ShowContactByExternalIdRequest.java @@ -0,0 +1,113 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.contacts.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = ShowContactByExternalIdRequest.Builder.class) +public final class ShowContactByExternalIdRequest { + private final String externalId; + + private final Map additionalProperties; + + private ShowContactByExternalIdRequest(String externalId, Map additionalProperties) { + this.externalId = externalId; + this.additionalProperties = additionalProperties; + } + + /** + * @return The external ID of the user that you want to retrieve + */ + @JsonProperty("external_id") + public String getExternalId() { + return externalId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof ShowContactByExternalIdRequest && equalTo((ShowContactByExternalIdRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(ShowContactByExternalIdRequest other) { + return externalId.equals(other.externalId); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.externalId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static ExternalIdStage builder() { + return new Builder(); + } + + public interface ExternalIdStage { + /** + *

The external ID of the user that you want to retrieve

+ */ + _FinalStage externalId(@NotNull String externalId); + + Builder from(ShowContactByExternalIdRequest other); + } + + public interface _FinalStage { + ShowContactByExternalIdRequest build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements ExternalIdStage, _FinalStage { + private String externalId; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(ShowContactByExternalIdRequest other) { + externalId(other.getExternalId()); + return this; + } + + /** + *

The external ID of the user that you want to retrieve

+ *

The external ID of the user that you want to retrieve

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("external_id") + public _FinalStage externalId(@NotNull String externalId) { + this.externalId = Objects.requireNonNull(externalId, "externalId must not be null"); + return this; + } + + @java.lang.Override + public ShowContactByExternalIdRequest build() { + return new ShowContactByExternalIdRequest(externalId, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/contacts/requests/UnarchiveContactRequest.java b/src/main/java/com/intercom/api/resources/contacts/requests/UnarchiveContactRequest.java new file mode 100644 index 00000000..2148e8ee --- /dev/null +++ b/src/main/java/com/intercom/api/resources/contacts/requests/UnarchiveContactRequest.java @@ -0,0 +1,113 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.contacts.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = UnarchiveContactRequest.Builder.class) +public final class UnarchiveContactRequest { + private final String contactId; + + private final Map additionalProperties; + + private UnarchiveContactRequest(String contactId, Map additionalProperties) { + this.contactId = contactId; + this.additionalProperties = additionalProperties; + } + + /** + * @return contact_id + */ + @JsonProperty("contact_id") + public String getContactId() { + return contactId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof UnarchiveContactRequest && equalTo((UnarchiveContactRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(UnarchiveContactRequest other) { + return contactId.equals(other.contactId); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.contactId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static ContactIdStage builder() { + return new Builder(); + } + + public interface ContactIdStage { + /** + *

contact_id

+ */ + _FinalStage contactId(@NotNull String contactId); + + Builder from(UnarchiveContactRequest other); + } + + public interface _FinalStage { + UnarchiveContactRequest build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements ContactIdStage, _FinalStage { + private String contactId; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(UnarchiveContactRequest other) { + contactId(other.getContactId()); + return this; + } + + /** + *

contact_id

+ *

contact_id

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("contact_id") + public _FinalStage contactId(@NotNull String contactId) { + this.contactId = Objects.requireNonNull(contactId, "contactId must not be null"); + return this; + } + + @java.lang.Override + public UnarchiveContactRequest build() { + return new UnarchiveContactRequest(contactId, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/contacts/requests/UpdateContactRequest.java b/src/main/java/com/intercom/api/resources/contacts/requests/UpdateContactRequest.java new file mode 100644 index 00000000..64666723 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/contacts/requests/UpdateContactRequest.java @@ -0,0 +1,615 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.contacts.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = UpdateContactRequest.Builder.class) +public final class UpdateContactRequest { + private final String contactId; + + private final Optional role; + + private final Optional externalId; + + private final Optional email; + + private final Optional phone; + + private final Optional name; + + private final Optional avatar; + + private final Optional signedUpAt; + + private final Optional lastSeenAt; + + private final Optional ownerId; + + private final Optional unsubscribedFromEmails; + + private final Optional> customAttributes; + + private final Map additionalProperties; + + private UpdateContactRequest( + String contactId, + Optional role, + Optional externalId, + Optional email, + Optional phone, + Optional name, + Optional avatar, + Optional signedUpAt, + Optional lastSeenAt, + Optional ownerId, + Optional unsubscribedFromEmails, + Optional> customAttributes, + Map additionalProperties) { + this.contactId = contactId; + this.role = role; + this.externalId = externalId; + this.email = email; + this.phone = phone; + this.name = name; + this.avatar = avatar; + this.signedUpAt = signedUpAt; + this.lastSeenAt = lastSeenAt; + this.ownerId = ownerId; + this.unsubscribedFromEmails = unsubscribedFromEmails; + this.customAttributes = customAttributes; + this.additionalProperties = additionalProperties; + } + + /** + * @return id + */ + @JsonProperty("contact_id") + public String getContactId() { + return contactId; + } + + /** + * @return The role of the contact. + */ + @JsonProperty("role") + public Optional getRole() { + return role; + } + + /** + * @return A unique identifier for the contact which is given to Intercom + */ + @JsonProperty("external_id") + public Optional getExternalId() { + return externalId; + } + + /** + * @return The contacts email + */ + @JsonProperty("email") + public Optional getEmail() { + return email; + } + + /** + * @return The contacts phone + */ + @JsonProperty("phone") + public Optional getPhone() { + return phone; + } + + /** + * @return The contacts name + */ + @JsonProperty("name") + public Optional getName() { + return name; + } + + /** + * @return An image URL containing the avatar of a contact + */ + @JsonProperty("avatar") + public Optional getAvatar() { + return avatar; + } + + /** + * @return The time specified for when a contact signed up + */ + @JsonProperty("signed_up_at") + public Optional getSignedUpAt() { + return signedUpAt; + } + + /** + * @return The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually) + */ + @JsonProperty("last_seen_at") + public Optional getLastSeenAt() { + return lastSeenAt; + } + + /** + * @return The id of an admin that has been assigned account ownership of the contact + */ + @JsonProperty("owner_id") + public Optional getOwnerId() { + return ownerId; + } + + /** + * @return Whether the contact is unsubscribed from emails + */ + @JsonProperty("unsubscribed_from_emails") + public Optional getUnsubscribedFromEmails() { + return unsubscribedFromEmails; + } + + /** + * @return The custom attributes which are set for the contact + */ + @JsonProperty("custom_attributes") + public Optional> getCustomAttributes() { + return customAttributes; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof UpdateContactRequest && equalTo((UpdateContactRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(UpdateContactRequest other) { + return contactId.equals(other.contactId) + && role.equals(other.role) + && externalId.equals(other.externalId) + && email.equals(other.email) + && phone.equals(other.phone) + && name.equals(other.name) + && avatar.equals(other.avatar) + && signedUpAt.equals(other.signedUpAt) + && lastSeenAt.equals(other.lastSeenAt) + && ownerId.equals(other.ownerId) + && unsubscribedFromEmails.equals(other.unsubscribedFromEmails) + && customAttributes.equals(other.customAttributes); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash( + this.contactId, + this.role, + this.externalId, + this.email, + this.phone, + this.name, + this.avatar, + this.signedUpAt, + this.lastSeenAt, + this.ownerId, + this.unsubscribedFromEmails, + this.customAttributes); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static ContactIdStage builder() { + return new Builder(); + } + + public interface ContactIdStage { + /** + *

id

+ */ + _FinalStage contactId(@NotNull String contactId); + + Builder from(UpdateContactRequest other); + } + + public interface _FinalStage { + UpdateContactRequest build(); + + /** + *

The role of the contact.

+ */ + _FinalStage role(Optional role); + + _FinalStage role(String role); + + /** + *

A unique identifier for the contact which is given to Intercom

+ */ + _FinalStage externalId(Optional externalId); + + _FinalStage externalId(String externalId); + + /** + *

The contacts email

+ */ + _FinalStage email(Optional email); + + _FinalStage email(String email); + + /** + *

The contacts phone

+ */ + _FinalStage phone(Optional phone); + + _FinalStage phone(String phone); + + /** + *

The contacts name

+ */ + _FinalStage name(Optional name); + + _FinalStage name(String name); + + /** + *

An image URL containing the avatar of a contact

+ */ + _FinalStage avatar(Optional avatar); + + _FinalStage avatar(String avatar); + + /** + *

The time specified for when a contact signed up

+ */ + _FinalStage signedUpAt(Optional signedUpAt); + + _FinalStage signedUpAt(Integer signedUpAt); + + /** + *

The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually)

+ */ + _FinalStage lastSeenAt(Optional lastSeenAt); + + _FinalStage lastSeenAt(Integer lastSeenAt); + + /** + *

The id of an admin that has been assigned account ownership of the contact

+ */ + _FinalStage ownerId(Optional ownerId); + + _FinalStage ownerId(Integer ownerId); + + /** + *

Whether the contact is unsubscribed from emails

+ */ + _FinalStage unsubscribedFromEmails(Optional unsubscribedFromEmails); + + _FinalStage unsubscribedFromEmails(Boolean unsubscribedFromEmails); + + /** + *

The custom attributes which are set for the contact

+ */ + _FinalStage customAttributes(Optional> customAttributes); + + _FinalStage customAttributes(Map customAttributes); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements ContactIdStage, _FinalStage { + private String contactId; + + private Optional> customAttributes = Optional.empty(); + + private Optional unsubscribedFromEmails = Optional.empty(); + + private Optional ownerId = Optional.empty(); + + private Optional lastSeenAt = Optional.empty(); + + private Optional signedUpAt = Optional.empty(); + + private Optional avatar = Optional.empty(); + + private Optional name = Optional.empty(); + + private Optional phone = Optional.empty(); + + private Optional email = Optional.empty(); + + private Optional externalId = Optional.empty(); + + private Optional role = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(UpdateContactRequest other) { + contactId(other.getContactId()); + role(other.getRole()); + externalId(other.getExternalId()); + email(other.getEmail()); + phone(other.getPhone()); + name(other.getName()); + avatar(other.getAvatar()); + signedUpAt(other.getSignedUpAt()); + lastSeenAt(other.getLastSeenAt()); + ownerId(other.getOwnerId()); + unsubscribedFromEmails(other.getUnsubscribedFromEmails()); + customAttributes(other.getCustomAttributes()); + return this; + } + + /** + *

id

+ *

id

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("contact_id") + public _FinalStage contactId(@NotNull String contactId) { + this.contactId = Objects.requireNonNull(contactId, "contactId must not be null"); + return this; + } + + /** + *

The custom attributes which are set for the contact

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage customAttributes(Map customAttributes) { + this.customAttributes = Optional.ofNullable(customAttributes); + return this; + } + + /** + *

The custom attributes which are set for the contact

+ */ + @java.lang.Override + @JsonSetter(value = "custom_attributes", nulls = Nulls.SKIP) + public _FinalStage customAttributes(Optional> customAttributes) { + this.customAttributes = customAttributes; + return this; + } + + /** + *

Whether the contact is unsubscribed from emails

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage unsubscribedFromEmails(Boolean unsubscribedFromEmails) { + this.unsubscribedFromEmails = Optional.ofNullable(unsubscribedFromEmails); + return this; + } + + /** + *

Whether the contact is unsubscribed from emails

+ */ + @java.lang.Override + @JsonSetter(value = "unsubscribed_from_emails", nulls = Nulls.SKIP) + public _FinalStage unsubscribedFromEmails(Optional unsubscribedFromEmails) { + this.unsubscribedFromEmails = unsubscribedFromEmails; + return this; + } + + /** + *

The id of an admin that has been assigned account ownership of the contact

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage ownerId(Integer ownerId) { + this.ownerId = Optional.ofNullable(ownerId); + return this; + } + + /** + *

The id of an admin that has been assigned account ownership of the contact

+ */ + @java.lang.Override + @JsonSetter(value = "owner_id", nulls = Nulls.SKIP) + public _FinalStage ownerId(Optional ownerId) { + this.ownerId = ownerId; + return this; + } + + /** + *

The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually)

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage lastSeenAt(Integer lastSeenAt) { + this.lastSeenAt = Optional.ofNullable(lastSeenAt); + return this; + } + + /** + *

The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually)

+ */ + @java.lang.Override + @JsonSetter(value = "last_seen_at", nulls = Nulls.SKIP) + public _FinalStage lastSeenAt(Optional lastSeenAt) { + this.lastSeenAt = lastSeenAt; + return this; + } + + /** + *

The time specified for when a contact signed up

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage signedUpAt(Integer signedUpAt) { + this.signedUpAt = Optional.ofNullable(signedUpAt); + return this; + } + + /** + *

The time specified for when a contact signed up

+ */ + @java.lang.Override + @JsonSetter(value = "signed_up_at", nulls = Nulls.SKIP) + public _FinalStage signedUpAt(Optional signedUpAt) { + this.signedUpAt = signedUpAt; + return this; + } + + /** + *

An image URL containing the avatar of a contact

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage avatar(String avatar) { + this.avatar = Optional.ofNullable(avatar); + return this; + } + + /** + *

An image URL containing the avatar of a contact

+ */ + @java.lang.Override + @JsonSetter(value = "avatar", nulls = Nulls.SKIP) + public _FinalStage avatar(Optional avatar) { + this.avatar = avatar; + return this; + } + + /** + *

The contacts name

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage name(String name) { + this.name = Optional.ofNullable(name); + return this; + } + + /** + *

The contacts name

+ */ + @java.lang.Override + @JsonSetter(value = "name", nulls = Nulls.SKIP) + public _FinalStage name(Optional name) { + this.name = name; + return this; + } + + /** + *

The contacts phone

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage phone(String phone) { + this.phone = Optional.ofNullable(phone); + return this; + } + + /** + *

The contacts phone

+ */ + @java.lang.Override + @JsonSetter(value = "phone", nulls = Nulls.SKIP) + public _FinalStage phone(Optional phone) { + this.phone = phone; + return this; + } + + /** + *

The contacts email

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage email(String email) { + this.email = Optional.ofNullable(email); + return this; + } + + /** + *

The contacts email

+ */ + @java.lang.Override + @JsonSetter(value = "email", nulls = Nulls.SKIP) + public _FinalStage email(Optional email) { + this.email = email; + return this; + } + + /** + *

A unique identifier for the contact which is given to Intercom

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage externalId(String externalId) { + this.externalId = Optional.ofNullable(externalId); + return this; + } + + /** + *

A unique identifier for the contact which is given to Intercom

+ */ + @java.lang.Override + @JsonSetter(value = "external_id", nulls = Nulls.SKIP) + public _FinalStage externalId(Optional externalId) { + this.externalId = externalId; + return this; + } + + /** + *

The role of the contact.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage role(String role) { + this.role = Optional.ofNullable(role); + return this; + } + + /** + *

The role of the contact.

+ */ + @java.lang.Override + @JsonSetter(value = "role", nulls = Nulls.SKIP) + public _FinalStage role(Optional role) { + this.role = role; + return this; + } + + @java.lang.Override + public UpdateContactRequest build() { + return new UpdateContactRequest( + contactId, + role, + externalId, + email, + phone, + name, + avatar, + signedUpAt, + lastSeenAt, + ownerId, + unsubscribedFromEmails, + customAttributes, + additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/contacts/types/Contact.java b/src/main/java/com/intercom/api/resources/contacts/types/Contact.java new file mode 100644 index 00000000..502988a6 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/contacts/types/Contact.java @@ -0,0 +1,1956 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.contacts.types; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.types.ContactCompanies; +import com.intercom.api.types.ContactLocation; +import com.intercom.api.types.ContactNotes; +import com.intercom.api.types.ContactSocialProfiles; +import com.intercom.api.types.ContactTags; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = Contact.Builder.class) +public final class Contact implements IContact { + private final String id; + + private final Optional externalId; + + private final String workspaceId; + + private final String role; + + private final Optional email; + + private final Optional emailDomain; + + private final Optional phone; + + private final Optional name; + + private final Optional ownerId; + + private final boolean hasHardBounced; + + private final boolean markedEmailAsSpam; + + private final boolean unsubscribedFromEmails; + + private final int createdAt; + + private final int updatedAt; + + private final Optional signedUpAt; + + private final Optional lastSeenAt; + + private final Optional lastRepliedAt; + + private final Optional lastContactedAt; + + private final Optional lastEmailOpenedAt; + + private final Optional lastEmailClickedAt; + + private final Optional languageOverride; + + private final Optional browser; + + private final Optional browserVersion; + + private final Optional browserLanguage; + + private final Optional os; + + private final Optional androidAppName; + + private final Optional androidAppVersion; + + private final Optional androidDevice; + + private final Optional androidOsVersion; + + private final Optional androidSdkVersion; + + private final Optional androidLastSeenAt; + + private final Optional iosAppName; + + private final Optional iosAppVersion; + + private final Optional iosDevice; + + private final Optional iosOsVersion; + + private final Optional iosSdkVersion; + + private final Optional iosLastSeenAt; + + private final Optional> customAttributes; + + private final Optional avatar; + + private final Optional tags; + + private final Optional notes; + + private final Optional companies; + + private final Optional location; + + private final Optional socialProfiles; + + private final Map additionalProperties; + + private Contact( + String id, + Optional externalId, + String workspaceId, + String role, + Optional email, + Optional emailDomain, + Optional phone, + Optional name, + Optional ownerId, + boolean hasHardBounced, + boolean markedEmailAsSpam, + boolean unsubscribedFromEmails, + int createdAt, + int updatedAt, + Optional signedUpAt, + Optional lastSeenAt, + Optional lastRepliedAt, + Optional lastContactedAt, + Optional lastEmailOpenedAt, + Optional lastEmailClickedAt, + Optional languageOverride, + Optional browser, + Optional browserVersion, + Optional browserLanguage, + Optional os, + Optional androidAppName, + Optional androidAppVersion, + Optional androidDevice, + Optional androidOsVersion, + Optional androidSdkVersion, + Optional androidLastSeenAt, + Optional iosAppName, + Optional iosAppVersion, + Optional iosDevice, + Optional iosOsVersion, + Optional iosSdkVersion, + Optional iosLastSeenAt, + Optional> customAttributes, + Optional avatar, + Optional tags, + Optional notes, + Optional companies, + Optional location, + Optional socialProfiles, + Map additionalProperties) { + this.id = id; + this.externalId = externalId; + this.workspaceId = workspaceId; + this.role = role; + this.email = email; + this.emailDomain = emailDomain; + this.phone = phone; + this.name = name; + this.ownerId = ownerId; + this.hasHardBounced = hasHardBounced; + this.markedEmailAsSpam = markedEmailAsSpam; + this.unsubscribedFromEmails = unsubscribedFromEmails; + this.createdAt = createdAt; + this.updatedAt = updatedAt; + this.signedUpAt = signedUpAt; + this.lastSeenAt = lastSeenAt; + this.lastRepliedAt = lastRepliedAt; + this.lastContactedAt = lastContactedAt; + this.lastEmailOpenedAt = lastEmailOpenedAt; + this.lastEmailClickedAt = lastEmailClickedAt; + this.languageOverride = languageOverride; + this.browser = browser; + this.browserVersion = browserVersion; + this.browserLanguage = browserLanguage; + this.os = os; + this.androidAppName = androidAppName; + this.androidAppVersion = androidAppVersion; + this.androidDevice = androidDevice; + this.androidOsVersion = androidOsVersion; + this.androidSdkVersion = androidSdkVersion; + this.androidLastSeenAt = androidLastSeenAt; + this.iosAppName = iosAppName; + this.iosAppVersion = iosAppVersion; + this.iosDevice = iosDevice; + this.iosOsVersion = iosOsVersion; + this.iosSdkVersion = iosSdkVersion; + this.iosLastSeenAt = iosLastSeenAt; + this.customAttributes = customAttributes; + this.avatar = avatar; + this.tags = tags; + this.notes = notes; + this.companies = companies; + this.location = location; + this.socialProfiles = socialProfiles; + this.additionalProperties = additionalProperties; + } + + /** + * @return The type of object. + */ + @JsonProperty("type") + public String getType() { + return "contact"; + } + + /** + * @return The unique identifier for the contact which is given by Intercom. + */ + @JsonProperty("id") + public String getId() { + return id; + } + + /** + * @return The unique identifier for the contact which is provided by the Client. + */ + @JsonProperty("external_id") + public Optional getExternalId() { + return externalId; + } + + /** + * @return The id of the workspace which the contact belongs to. + */ + @JsonProperty("workspace_id") + public String getWorkspaceId() { + return workspaceId; + } + + /** + * @return The role of the contact. + */ + @JsonProperty("role") + public String getRole() { + return role; + } + + /** + * @return The contact's email. + */ + @JsonProperty("email") + public Optional getEmail() { + return email; + } + + /** + * @return The contact's email domain. + */ + @JsonProperty("email_domain") + public Optional getEmailDomain() { + return emailDomain; + } + + /** + * @return The contacts phone. + */ + @JsonProperty("phone") + public Optional getPhone() { + return phone; + } + + /** + * @return The contacts name. + */ + @JsonProperty("name") + public Optional getName() { + return name; + } + + /** + * @return The id of an admin that has been assigned account ownership of the contact. + */ + @JsonProperty("owner_id") + public Optional getOwnerId() { + return ownerId; + } + + /** + * @return Whether the contact has had an email sent to them hard bounce. + */ + @JsonProperty("has_hard_bounced") + public boolean getHasHardBounced() { + return hasHardBounced; + } + + /** + * @return Whether the contact has marked an email sent to them as spam. + */ + @JsonProperty("marked_email_as_spam") + public boolean getMarkedEmailAsSpam() { + return markedEmailAsSpam; + } + + /** + * @return Whether the contact is unsubscribed from emails. + */ + @JsonProperty("unsubscribed_from_emails") + public boolean getUnsubscribedFromEmails() { + return unsubscribedFromEmails; + } + + /** + * @return (UNIX timestamp) The time when the contact was created. + */ + @JsonProperty("created_at") + public int getCreatedAt() { + return createdAt; + } + + /** + * @return (UNIX timestamp) The time when the contact was last updated. + */ + @JsonProperty("updated_at") + public int getUpdatedAt() { + return updatedAt; + } + + /** + * @return (UNIX timestamp) The time specified for when a contact signed up. + */ + @JsonProperty("signed_up_at") + public Optional getSignedUpAt() { + return signedUpAt; + } + + /** + * @return (UNIX timestamp) The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually). + */ + @JsonProperty("last_seen_at") + public Optional getLastSeenAt() { + return lastSeenAt; + } + + /** + * @return (UNIX timestamp) The time when the contact last messaged in. + */ + @JsonProperty("last_replied_at") + public Optional getLastRepliedAt() { + return lastRepliedAt; + } + + /** + * @return (UNIX timestamp) The time when the contact was last messaged. + */ + @JsonProperty("last_contacted_at") + public Optional getLastContactedAt() { + return lastContactedAt; + } + + /** + * @return (UNIX timestamp) The time when the contact last opened an email. + */ + @JsonProperty("last_email_opened_at") + public Optional getLastEmailOpenedAt() { + return lastEmailOpenedAt; + } + + /** + * @return (UNIX timestamp) The time when the contact last clicked a link in an email. + */ + @JsonProperty("last_email_clicked_at") + public Optional getLastEmailClickedAt() { + return lastEmailClickedAt; + } + + /** + * @return A preferred language setting for the contact, used by the Intercom Messenger even if their browser settings change. + */ + @JsonProperty("language_override") + public Optional getLanguageOverride() { + return languageOverride; + } + + /** + * @return The name of the browser which the contact is using. + */ + @JsonProperty("browser") + public Optional getBrowser() { + return browser; + } + + /** + * @return The version of the browser which the contact is using. + */ + @JsonProperty("browser_version") + public Optional getBrowserVersion() { + return browserVersion; + } + + /** + * @return The language set by the browser which the contact is using. + */ + @JsonProperty("browser_language") + public Optional getBrowserLanguage() { + return browserLanguage; + } + + /** + * @return The operating system which the contact is using. + */ + @JsonProperty("os") + public Optional getOs() { + return os; + } + + /** + * @return The name of the Android app which the contact is using. + */ + @JsonProperty("android_app_name") + public Optional getAndroidAppName() { + return androidAppName; + } + + /** + * @return The version of the Android app which the contact is using. + */ + @JsonProperty("android_app_version") + public Optional getAndroidAppVersion() { + return androidAppVersion; + } + + /** + * @return The Android device which the contact is using. + */ + @JsonProperty("android_device") + public Optional getAndroidDevice() { + return androidDevice; + } + + /** + * @return The version of the Android OS which the contact is using. + */ + @JsonProperty("android_os_version") + public Optional getAndroidOsVersion() { + return androidOsVersion; + } + + /** + * @return The version of the Android SDK which the contact is using. + */ + @JsonProperty("android_sdk_version") + public Optional getAndroidSdkVersion() { + return androidSdkVersion; + } + + /** + * @return (UNIX timestamp) The time when the contact was last seen on an Android device. + */ + @JsonProperty("android_last_seen_at") + public Optional getAndroidLastSeenAt() { + return androidLastSeenAt; + } + + /** + * @return The name of the iOS app which the contact is using. + */ + @JsonProperty("ios_app_name") + public Optional getIosAppName() { + return iosAppName; + } + + /** + * @return The version of the iOS app which the contact is using. + */ + @JsonProperty("ios_app_version") + public Optional getIosAppVersion() { + return iosAppVersion; + } + + /** + * @return The iOS device which the contact is using. + */ + @JsonProperty("ios_device") + public Optional getIosDevice() { + return iosDevice; + } + + /** + * @return The version of iOS which the contact is using. + */ + @JsonProperty("ios_os_version") + public Optional getIosOsVersion() { + return iosOsVersion; + } + + /** + * @return The version of the iOS SDK which the contact is using. + */ + @JsonProperty("ios_sdk_version") + public Optional getIosSdkVersion() { + return iosSdkVersion; + } + + /** + * @return (UNIX timestamp) The last time the contact used the iOS app. + */ + @JsonProperty("ios_last_seen_at") + public Optional getIosLastSeenAt() { + return iosLastSeenAt; + } + + /** + * @return The custom attributes which are set for the contact. + */ + @JsonProperty("custom_attributes") + public Optional> getCustomAttributes() { + return customAttributes; + } + + /** + * @return An image URL containing the avatar of a contact. + */ + @JsonProperty("avatar") + public Optional getAvatar() { + return avatar; + } + + @JsonProperty("tags") + public Optional getTags() { + return tags; + } + + @JsonProperty("notes") + public Optional getNotes() { + return notes; + } + + @JsonProperty("companies") + public Optional getCompanies() { + return companies; + } + + @JsonProperty("location") + public Optional getLocation() { + return location; + } + + @JsonProperty("social_profiles") + public Optional getSocialProfiles() { + return socialProfiles; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof Contact && equalTo((Contact) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(Contact other) { + return id.equals(other.id) + && externalId.equals(other.externalId) + && workspaceId.equals(other.workspaceId) + && role.equals(other.role) + && email.equals(other.email) + && emailDomain.equals(other.emailDomain) + && phone.equals(other.phone) + && name.equals(other.name) + && ownerId.equals(other.ownerId) + && hasHardBounced == other.hasHardBounced + && markedEmailAsSpam == other.markedEmailAsSpam + && unsubscribedFromEmails == other.unsubscribedFromEmails + && createdAt == other.createdAt + && updatedAt == other.updatedAt + && signedUpAt.equals(other.signedUpAt) + && lastSeenAt.equals(other.lastSeenAt) + && lastRepliedAt.equals(other.lastRepliedAt) + && lastContactedAt.equals(other.lastContactedAt) + && lastEmailOpenedAt.equals(other.lastEmailOpenedAt) + && lastEmailClickedAt.equals(other.lastEmailClickedAt) + && languageOverride.equals(other.languageOverride) + && browser.equals(other.browser) + && browserVersion.equals(other.browserVersion) + && browserLanguage.equals(other.browserLanguage) + && os.equals(other.os) + && androidAppName.equals(other.androidAppName) + && androidAppVersion.equals(other.androidAppVersion) + && androidDevice.equals(other.androidDevice) + && androidOsVersion.equals(other.androidOsVersion) + && androidSdkVersion.equals(other.androidSdkVersion) + && androidLastSeenAt.equals(other.androidLastSeenAt) + && iosAppName.equals(other.iosAppName) + && iosAppVersion.equals(other.iosAppVersion) + && iosDevice.equals(other.iosDevice) + && iosOsVersion.equals(other.iosOsVersion) + && iosSdkVersion.equals(other.iosSdkVersion) + && iosLastSeenAt.equals(other.iosLastSeenAt) + && customAttributes.equals(other.customAttributes) + && avatar.equals(other.avatar) + && tags.equals(other.tags) + && notes.equals(other.notes) + && companies.equals(other.companies) + && location.equals(other.location) + && socialProfiles.equals(other.socialProfiles); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash( + this.id, + this.externalId, + this.workspaceId, + this.role, + this.email, + this.emailDomain, + this.phone, + this.name, + this.ownerId, + this.hasHardBounced, + this.markedEmailAsSpam, + this.unsubscribedFromEmails, + this.createdAt, + this.updatedAt, + this.signedUpAt, + this.lastSeenAt, + this.lastRepliedAt, + this.lastContactedAt, + this.lastEmailOpenedAt, + this.lastEmailClickedAt, + this.languageOverride, + this.browser, + this.browserVersion, + this.browserLanguage, + this.os, + this.androidAppName, + this.androidAppVersion, + this.androidDevice, + this.androidOsVersion, + this.androidSdkVersion, + this.androidLastSeenAt, + this.iosAppName, + this.iosAppVersion, + this.iosDevice, + this.iosOsVersion, + this.iosSdkVersion, + this.iosLastSeenAt, + this.customAttributes, + this.avatar, + this.tags, + this.notes, + this.companies, + this.location, + this.socialProfiles); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static IdStage builder() { + return new Builder(); + } + + public interface IdStage { + /** + *

The unique identifier for the contact which is given by Intercom.

+ */ + WorkspaceIdStage id(@NotNull String id); + + Builder from(Contact other); + } + + public interface WorkspaceIdStage { + /** + *

The id of the workspace which the contact belongs to.

+ */ + RoleStage workspaceId(@NotNull String workspaceId); + } + + public interface RoleStage { + /** + *

The role of the contact.

+ */ + HasHardBouncedStage role(@NotNull String role); + } + + public interface HasHardBouncedStage { + /** + *

Whether the contact has had an email sent to them hard bounce.

+ */ + MarkedEmailAsSpamStage hasHardBounced(boolean hasHardBounced); + } + + public interface MarkedEmailAsSpamStage { + /** + *

Whether the contact has marked an email sent to them as spam.

+ */ + UnsubscribedFromEmailsStage markedEmailAsSpam(boolean markedEmailAsSpam); + } + + public interface UnsubscribedFromEmailsStage { + /** + *

Whether the contact is unsubscribed from emails.

+ */ + CreatedAtStage unsubscribedFromEmails(boolean unsubscribedFromEmails); + } + + public interface CreatedAtStage { + /** + *

(UNIX timestamp) The time when the contact was created.

+ */ + UpdatedAtStage createdAt(int createdAt); + } + + public interface UpdatedAtStage { + /** + *

(UNIX timestamp) The time when the contact was last updated.

+ */ + _FinalStage updatedAt(int updatedAt); + } + + public interface _FinalStage { + Contact build(); + + /** + *

The unique identifier for the contact which is provided by the Client.

+ */ + _FinalStage externalId(Optional externalId); + + _FinalStage externalId(String externalId); + + /** + *

The contact's email.

+ */ + _FinalStage email(Optional email); + + _FinalStage email(String email); + + /** + *

The contact's email domain.

+ */ + _FinalStage emailDomain(Optional emailDomain); + + _FinalStage emailDomain(String emailDomain); + + /** + *

The contacts phone.

+ */ + _FinalStage phone(Optional phone); + + _FinalStage phone(String phone); + + /** + *

The contacts name.

+ */ + _FinalStage name(Optional name); + + _FinalStage name(String name); + + /** + *

The id of an admin that has been assigned account ownership of the contact.

+ */ + _FinalStage ownerId(Optional ownerId); + + _FinalStage ownerId(Integer ownerId); + + /** + *

(UNIX timestamp) The time specified for when a contact signed up.

+ */ + _FinalStage signedUpAt(Optional signedUpAt); + + _FinalStage signedUpAt(Integer signedUpAt); + + /** + *

(UNIX timestamp) The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually).

+ */ + _FinalStage lastSeenAt(Optional lastSeenAt); + + _FinalStage lastSeenAt(Integer lastSeenAt); + + /** + *

(UNIX timestamp) The time when the contact last messaged in.

+ */ + _FinalStage lastRepliedAt(Optional lastRepliedAt); + + _FinalStage lastRepliedAt(Integer lastRepliedAt); + + /** + *

(UNIX timestamp) The time when the contact was last messaged.

+ */ + _FinalStage lastContactedAt(Optional lastContactedAt); + + _FinalStage lastContactedAt(Integer lastContactedAt); + + /** + *

(UNIX timestamp) The time when the contact last opened an email.

+ */ + _FinalStage lastEmailOpenedAt(Optional lastEmailOpenedAt); + + _FinalStage lastEmailOpenedAt(Integer lastEmailOpenedAt); + + /** + *

(UNIX timestamp) The time when the contact last clicked a link in an email.

+ */ + _FinalStage lastEmailClickedAt(Optional lastEmailClickedAt); + + _FinalStage lastEmailClickedAt(Integer lastEmailClickedAt); + + /** + *

A preferred language setting for the contact, used by the Intercom Messenger even if their browser settings change.

+ */ + _FinalStage languageOverride(Optional languageOverride); + + _FinalStage languageOverride(String languageOverride); + + /** + *

The name of the browser which the contact is using.

+ */ + _FinalStage browser(Optional browser); + + _FinalStage browser(String browser); + + /** + *

The version of the browser which the contact is using.

+ */ + _FinalStage browserVersion(Optional browserVersion); + + _FinalStage browserVersion(String browserVersion); + + /** + *

The language set by the browser which the contact is using.

+ */ + _FinalStage browserLanguage(Optional browserLanguage); + + _FinalStage browserLanguage(String browserLanguage); + + /** + *

The operating system which the contact is using.

+ */ + _FinalStage os(Optional os); + + _FinalStage os(String os); + + /** + *

The name of the Android app which the contact is using.

+ */ + _FinalStage androidAppName(Optional androidAppName); + + _FinalStage androidAppName(String androidAppName); + + /** + *

The version of the Android app which the contact is using.

+ */ + _FinalStage androidAppVersion(Optional androidAppVersion); + + _FinalStage androidAppVersion(String androidAppVersion); + + /** + *

The Android device which the contact is using.

+ */ + _FinalStage androidDevice(Optional androidDevice); + + _FinalStage androidDevice(String androidDevice); + + /** + *

The version of the Android OS which the contact is using.

+ */ + _FinalStage androidOsVersion(Optional androidOsVersion); + + _FinalStage androidOsVersion(String androidOsVersion); + + /** + *

The version of the Android SDK which the contact is using.

+ */ + _FinalStage androidSdkVersion(Optional androidSdkVersion); + + _FinalStage androidSdkVersion(String androidSdkVersion); + + /** + *

(UNIX timestamp) The time when the contact was last seen on an Android device.

+ */ + _FinalStage androidLastSeenAt(Optional androidLastSeenAt); + + _FinalStage androidLastSeenAt(Integer androidLastSeenAt); + + /** + *

The name of the iOS app which the contact is using.

+ */ + _FinalStage iosAppName(Optional iosAppName); + + _FinalStage iosAppName(String iosAppName); + + /** + *

The version of the iOS app which the contact is using.

+ */ + _FinalStage iosAppVersion(Optional iosAppVersion); + + _FinalStage iosAppVersion(String iosAppVersion); + + /** + *

The iOS device which the contact is using.

+ */ + _FinalStage iosDevice(Optional iosDevice); + + _FinalStage iosDevice(String iosDevice); + + /** + *

The version of iOS which the contact is using.

+ */ + _FinalStage iosOsVersion(Optional iosOsVersion); + + _FinalStage iosOsVersion(String iosOsVersion); + + /** + *

The version of the iOS SDK which the contact is using.

+ */ + _FinalStage iosSdkVersion(Optional iosSdkVersion); + + _FinalStage iosSdkVersion(String iosSdkVersion); + + /** + *

(UNIX timestamp) The last time the contact used the iOS app.

+ */ + _FinalStage iosLastSeenAt(Optional iosLastSeenAt); + + _FinalStage iosLastSeenAt(Integer iosLastSeenAt); + + /** + *

The custom attributes which are set for the contact.

+ */ + _FinalStage customAttributes(Optional> customAttributes); + + _FinalStage customAttributes(Map customAttributes); + + /** + *

An image URL containing the avatar of a contact.

+ */ + _FinalStage avatar(Optional avatar); + + _FinalStage avatar(String avatar); + + _FinalStage tags(Optional tags); + + _FinalStage tags(ContactTags tags); + + _FinalStage notes(Optional notes); + + _FinalStage notes(ContactNotes notes); + + _FinalStage companies(Optional companies); + + _FinalStage companies(ContactCompanies companies); + + _FinalStage location(Optional location); + + _FinalStage location(ContactLocation location); + + _FinalStage socialProfiles(Optional socialProfiles); + + _FinalStage socialProfiles(ContactSocialProfiles socialProfiles); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder + implements IdStage, + WorkspaceIdStage, + RoleStage, + HasHardBouncedStage, + MarkedEmailAsSpamStage, + UnsubscribedFromEmailsStage, + CreatedAtStage, + UpdatedAtStage, + _FinalStage { + private String id; + + private String workspaceId; + + private String role; + + private boolean hasHardBounced; + + private boolean markedEmailAsSpam; + + private boolean unsubscribedFromEmails; + + private int createdAt; + + private int updatedAt; + + private Optional socialProfiles = Optional.empty(); + + private Optional location = Optional.empty(); + + private Optional companies = Optional.empty(); + + private Optional notes = Optional.empty(); + + private Optional tags = Optional.empty(); + + private Optional avatar = Optional.empty(); + + private Optional> customAttributes = Optional.empty(); + + private Optional iosLastSeenAt = Optional.empty(); + + private Optional iosSdkVersion = Optional.empty(); + + private Optional iosOsVersion = Optional.empty(); + + private Optional iosDevice = Optional.empty(); + + private Optional iosAppVersion = Optional.empty(); + + private Optional iosAppName = Optional.empty(); + + private Optional androidLastSeenAt = Optional.empty(); + + private Optional androidSdkVersion = Optional.empty(); + + private Optional androidOsVersion = Optional.empty(); + + private Optional androidDevice = Optional.empty(); + + private Optional androidAppVersion = Optional.empty(); + + private Optional androidAppName = Optional.empty(); + + private Optional os = Optional.empty(); + + private Optional browserLanguage = Optional.empty(); + + private Optional browserVersion = Optional.empty(); + + private Optional browser = Optional.empty(); + + private Optional languageOverride = Optional.empty(); + + private Optional lastEmailClickedAt = Optional.empty(); + + private Optional lastEmailOpenedAt = Optional.empty(); + + private Optional lastContactedAt = Optional.empty(); + + private Optional lastRepliedAt = Optional.empty(); + + private Optional lastSeenAt = Optional.empty(); + + private Optional signedUpAt = Optional.empty(); + + private Optional ownerId = Optional.empty(); + + private Optional name = Optional.empty(); + + private Optional phone = Optional.empty(); + + private Optional emailDomain = Optional.empty(); + + private Optional email = Optional.empty(); + + private Optional externalId = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(Contact other) { + id(other.getId()); + externalId(other.getExternalId()); + workspaceId(other.getWorkspaceId()); + role(other.getRole()); + email(other.getEmail()); + emailDomain(other.getEmailDomain()); + phone(other.getPhone()); + name(other.getName()); + ownerId(other.getOwnerId()); + hasHardBounced(other.getHasHardBounced()); + markedEmailAsSpam(other.getMarkedEmailAsSpam()); + unsubscribedFromEmails(other.getUnsubscribedFromEmails()); + createdAt(other.getCreatedAt()); + updatedAt(other.getUpdatedAt()); + signedUpAt(other.getSignedUpAt()); + lastSeenAt(other.getLastSeenAt()); + lastRepliedAt(other.getLastRepliedAt()); + lastContactedAt(other.getLastContactedAt()); + lastEmailOpenedAt(other.getLastEmailOpenedAt()); + lastEmailClickedAt(other.getLastEmailClickedAt()); + languageOverride(other.getLanguageOverride()); + browser(other.getBrowser()); + browserVersion(other.getBrowserVersion()); + browserLanguage(other.getBrowserLanguage()); + os(other.getOs()); + androidAppName(other.getAndroidAppName()); + androidAppVersion(other.getAndroidAppVersion()); + androidDevice(other.getAndroidDevice()); + androidOsVersion(other.getAndroidOsVersion()); + androidSdkVersion(other.getAndroidSdkVersion()); + androidLastSeenAt(other.getAndroidLastSeenAt()); + iosAppName(other.getIosAppName()); + iosAppVersion(other.getIosAppVersion()); + iosDevice(other.getIosDevice()); + iosOsVersion(other.getIosOsVersion()); + iosSdkVersion(other.getIosSdkVersion()); + iosLastSeenAt(other.getIosLastSeenAt()); + customAttributes(other.getCustomAttributes()); + avatar(other.getAvatar()); + tags(other.getTags()); + notes(other.getNotes()); + companies(other.getCompanies()); + location(other.getLocation()); + socialProfiles(other.getSocialProfiles()); + return this; + } + + /** + *

The unique identifier for the contact which is given by Intercom.

+ *

The unique identifier for the contact which is given by Intercom.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("id") + public WorkspaceIdStage id(@NotNull String id) { + this.id = Objects.requireNonNull(id, "id must not be null"); + return this; + } + + /** + *

The id of the workspace which the contact belongs to.

+ *

The id of the workspace which the contact belongs to.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("workspace_id") + public RoleStage workspaceId(@NotNull String workspaceId) { + this.workspaceId = Objects.requireNonNull(workspaceId, "workspaceId must not be null"); + return this; + } + + /** + *

The role of the contact.

+ *

The role of the contact.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("role") + public HasHardBouncedStage role(@NotNull String role) { + this.role = Objects.requireNonNull(role, "role must not be null"); + return this; + } + + /** + *

Whether the contact has had an email sent to them hard bounce.

+ *

Whether the contact has had an email sent to them hard bounce.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("has_hard_bounced") + public MarkedEmailAsSpamStage hasHardBounced(boolean hasHardBounced) { + this.hasHardBounced = hasHardBounced; + return this; + } + + /** + *

Whether the contact has marked an email sent to them as spam.

+ *

Whether the contact has marked an email sent to them as spam.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("marked_email_as_spam") + public UnsubscribedFromEmailsStage markedEmailAsSpam(boolean markedEmailAsSpam) { + this.markedEmailAsSpam = markedEmailAsSpam; + return this; + } + + /** + *

Whether the contact is unsubscribed from emails.

+ *

Whether the contact is unsubscribed from emails.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("unsubscribed_from_emails") + public CreatedAtStage unsubscribedFromEmails(boolean unsubscribedFromEmails) { + this.unsubscribedFromEmails = unsubscribedFromEmails; + return this; + } + + /** + *

(UNIX timestamp) The time when the contact was created.

+ *

(UNIX timestamp) The time when the contact was created.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("created_at") + public UpdatedAtStage createdAt(int createdAt) { + this.createdAt = createdAt; + return this; + } + + /** + *

(UNIX timestamp) The time when the contact was last updated.

+ *

(UNIX timestamp) The time when the contact was last updated.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("updated_at") + public _FinalStage updatedAt(int updatedAt) { + this.updatedAt = updatedAt; + return this; + } + + @java.lang.Override + public _FinalStage socialProfiles(ContactSocialProfiles socialProfiles) { + this.socialProfiles = Optional.ofNullable(socialProfiles); + return this; + } + + @java.lang.Override + @JsonSetter(value = "social_profiles", nulls = Nulls.SKIP) + public _FinalStage socialProfiles(Optional socialProfiles) { + this.socialProfiles = socialProfiles; + return this; + } + + @java.lang.Override + public _FinalStage location(ContactLocation location) { + this.location = Optional.ofNullable(location); + return this; + } + + @java.lang.Override + @JsonSetter(value = "location", nulls = Nulls.SKIP) + public _FinalStage location(Optional location) { + this.location = location; + return this; + } + + @java.lang.Override + public _FinalStage companies(ContactCompanies companies) { + this.companies = Optional.ofNullable(companies); + return this; + } + + @java.lang.Override + @JsonSetter(value = "companies", nulls = Nulls.SKIP) + public _FinalStage companies(Optional companies) { + this.companies = companies; + return this; + } + + @java.lang.Override + public _FinalStage notes(ContactNotes notes) { + this.notes = Optional.ofNullable(notes); + return this; + } + + @java.lang.Override + @JsonSetter(value = "notes", nulls = Nulls.SKIP) + public _FinalStage notes(Optional notes) { + this.notes = notes; + return this; + } + + @java.lang.Override + public _FinalStage tags(ContactTags tags) { + this.tags = Optional.ofNullable(tags); + return this; + } + + @java.lang.Override + @JsonSetter(value = "tags", nulls = Nulls.SKIP) + public _FinalStage tags(Optional tags) { + this.tags = tags; + return this; + } + + /** + *

An image URL containing the avatar of a contact.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage avatar(String avatar) { + this.avatar = Optional.ofNullable(avatar); + return this; + } + + /** + *

An image URL containing the avatar of a contact.

+ */ + @java.lang.Override + @JsonSetter(value = "avatar", nulls = Nulls.SKIP) + public _FinalStage avatar(Optional avatar) { + this.avatar = avatar; + return this; + } + + /** + *

The custom attributes which are set for the contact.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage customAttributes(Map customAttributes) { + this.customAttributes = Optional.ofNullable(customAttributes); + return this; + } + + /** + *

The custom attributes which are set for the contact.

+ */ + @java.lang.Override + @JsonSetter(value = "custom_attributes", nulls = Nulls.SKIP) + public _FinalStage customAttributes(Optional> customAttributes) { + this.customAttributes = customAttributes; + return this; + } + + /** + *

(UNIX timestamp) The last time the contact used the iOS app.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage iosLastSeenAt(Integer iosLastSeenAt) { + this.iosLastSeenAt = Optional.ofNullable(iosLastSeenAt); + return this; + } + + /** + *

(UNIX timestamp) The last time the contact used the iOS app.

+ */ + @java.lang.Override + @JsonSetter(value = "ios_last_seen_at", nulls = Nulls.SKIP) + public _FinalStage iosLastSeenAt(Optional iosLastSeenAt) { + this.iosLastSeenAt = iosLastSeenAt; + return this; + } + + /** + *

The version of the iOS SDK which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage iosSdkVersion(String iosSdkVersion) { + this.iosSdkVersion = Optional.ofNullable(iosSdkVersion); + return this; + } + + /** + *

The version of the iOS SDK which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "ios_sdk_version", nulls = Nulls.SKIP) + public _FinalStage iosSdkVersion(Optional iosSdkVersion) { + this.iosSdkVersion = iosSdkVersion; + return this; + } + + /** + *

The version of iOS which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage iosOsVersion(String iosOsVersion) { + this.iosOsVersion = Optional.ofNullable(iosOsVersion); + return this; + } + + /** + *

The version of iOS which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "ios_os_version", nulls = Nulls.SKIP) + public _FinalStage iosOsVersion(Optional iosOsVersion) { + this.iosOsVersion = iosOsVersion; + return this; + } + + /** + *

The iOS device which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage iosDevice(String iosDevice) { + this.iosDevice = Optional.ofNullable(iosDevice); + return this; + } + + /** + *

The iOS device which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "ios_device", nulls = Nulls.SKIP) + public _FinalStage iosDevice(Optional iosDevice) { + this.iosDevice = iosDevice; + return this; + } + + /** + *

The version of the iOS app which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage iosAppVersion(String iosAppVersion) { + this.iosAppVersion = Optional.ofNullable(iosAppVersion); + return this; + } + + /** + *

The version of the iOS app which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "ios_app_version", nulls = Nulls.SKIP) + public _FinalStage iosAppVersion(Optional iosAppVersion) { + this.iosAppVersion = iosAppVersion; + return this; + } + + /** + *

The name of the iOS app which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage iosAppName(String iosAppName) { + this.iosAppName = Optional.ofNullable(iosAppName); + return this; + } + + /** + *

The name of the iOS app which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "ios_app_name", nulls = Nulls.SKIP) + public _FinalStage iosAppName(Optional iosAppName) { + this.iosAppName = iosAppName; + return this; + } + + /** + *

(UNIX timestamp) The time when the contact was last seen on an Android device.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage androidLastSeenAt(Integer androidLastSeenAt) { + this.androidLastSeenAt = Optional.ofNullable(androidLastSeenAt); + return this; + } + + /** + *

(UNIX timestamp) The time when the contact was last seen on an Android device.

+ */ + @java.lang.Override + @JsonSetter(value = "android_last_seen_at", nulls = Nulls.SKIP) + public _FinalStage androidLastSeenAt(Optional androidLastSeenAt) { + this.androidLastSeenAt = androidLastSeenAt; + return this; + } + + /** + *

The version of the Android SDK which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage androidSdkVersion(String androidSdkVersion) { + this.androidSdkVersion = Optional.ofNullable(androidSdkVersion); + return this; + } + + /** + *

The version of the Android SDK which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "android_sdk_version", nulls = Nulls.SKIP) + public _FinalStage androidSdkVersion(Optional androidSdkVersion) { + this.androidSdkVersion = androidSdkVersion; + return this; + } + + /** + *

The version of the Android OS which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage androidOsVersion(String androidOsVersion) { + this.androidOsVersion = Optional.ofNullable(androidOsVersion); + return this; + } + + /** + *

The version of the Android OS which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "android_os_version", nulls = Nulls.SKIP) + public _FinalStage androidOsVersion(Optional androidOsVersion) { + this.androidOsVersion = androidOsVersion; + return this; + } + + /** + *

The Android device which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage androidDevice(String androidDevice) { + this.androidDevice = Optional.ofNullable(androidDevice); + return this; + } + + /** + *

The Android device which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "android_device", nulls = Nulls.SKIP) + public _FinalStage androidDevice(Optional androidDevice) { + this.androidDevice = androidDevice; + return this; + } + + /** + *

The version of the Android app which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage androidAppVersion(String androidAppVersion) { + this.androidAppVersion = Optional.ofNullable(androidAppVersion); + return this; + } + + /** + *

The version of the Android app which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "android_app_version", nulls = Nulls.SKIP) + public _FinalStage androidAppVersion(Optional androidAppVersion) { + this.androidAppVersion = androidAppVersion; + return this; + } + + /** + *

The name of the Android app which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage androidAppName(String androidAppName) { + this.androidAppName = Optional.ofNullable(androidAppName); + return this; + } + + /** + *

The name of the Android app which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "android_app_name", nulls = Nulls.SKIP) + public _FinalStage androidAppName(Optional androidAppName) { + this.androidAppName = androidAppName; + return this; + } + + /** + *

The operating system which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage os(String os) { + this.os = Optional.ofNullable(os); + return this; + } + + /** + *

The operating system which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "os", nulls = Nulls.SKIP) + public _FinalStage os(Optional os) { + this.os = os; + return this; + } + + /** + *

The language set by the browser which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage browserLanguage(String browserLanguage) { + this.browserLanguage = Optional.ofNullable(browserLanguage); + return this; + } + + /** + *

The language set by the browser which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "browser_language", nulls = Nulls.SKIP) + public _FinalStage browserLanguage(Optional browserLanguage) { + this.browserLanguage = browserLanguage; + return this; + } + + /** + *

The version of the browser which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage browserVersion(String browserVersion) { + this.browserVersion = Optional.ofNullable(browserVersion); + return this; + } + + /** + *

The version of the browser which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "browser_version", nulls = Nulls.SKIP) + public _FinalStage browserVersion(Optional browserVersion) { + this.browserVersion = browserVersion; + return this; + } + + /** + *

The name of the browser which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage browser(String browser) { + this.browser = Optional.ofNullable(browser); + return this; + } + + /** + *

The name of the browser which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "browser", nulls = Nulls.SKIP) + public _FinalStage browser(Optional browser) { + this.browser = browser; + return this; + } + + /** + *

A preferred language setting for the contact, used by the Intercom Messenger even if their browser settings change.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage languageOverride(String languageOverride) { + this.languageOverride = Optional.ofNullable(languageOverride); + return this; + } + + /** + *

A preferred language setting for the contact, used by the Intercom Messenger even if their browser settings change.

+ */ + @java.lang.Override + @JsonSetter(value = "language_override", nulls = Nulls.SKIP) + public _FinalStage languageOverride(Optional languageOverride) { + this.languageOverride = languageOverride; + return this; + } + + /** + *

(UNIX timestamp) The time when the contact last clicked a link in an email.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage lastEmailClickedAt(Integer lastEmailClickedAt) { + this.lastEmailClickedAt = Optional.ofNullable(lastEmailClickedAt); + return this; + } + + /** + *

(UNIX timestamp) The time when the contact last clicked a link in an email.

+ */ + @java.lang.Override + @JsonSetter(value = "last_email_clicked_at", nulls = Nulls.SKIP) + public _FinalStage lastEmailClickedAt(Optional lastEmailClickedAt) { + this.lastEmailClickedAt = lastEmailClickedAt; + return this; + } + + /** + *

(UNIX timestamp) The time when the contact last opened an email.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage lastEmailOpenedAt(Integer lastEmailOpenedAt) { + this.lastEmailOpenedAt = Optional.ofNullable(lastEmailOpenedAt); + return this; + } + + /** + *

(UNIX timestamp) The time when the contact last opened an email.

+ */ + @java.lang.Override + @JsonSetter(value = "last_email_opened_at", nulls = Nulls.SKIP) + public _FinalStage lastEmailOpenedAt(Optional lastEmailOpenedAt) { + this.lastEmailOpenedAt = lastEmailOpenedAt; + return this; + } + + /** + *

(UNIX timestamp) The time when the contact was last messaged.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage lastContactedAt(Integer lastContactedAt) { + this.lastContactedAt = Optional.ofNullable(lastContactedAt); + return this; + } + + /** + *

(UNIX timestamp) The time when the contact was last messaged.

+ */ + @java.lang.Override + @JsonSetter(value = "last_contacted_at", nulls = Nulls.SKIP) + public _FinalStage lastContactedAt(Optional lastContactedAt) { + this.lastContactedAt = lastContactedAt; + return this; + } + + /** + *

(UNIX timestamp) The time when the contact last messaged in.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage lastRepliedAt(Integer lastRepliedAt) { + this.lastRepliedAt = Optional.ofNullable(lastRepliedAt); + return this; + } + + /** + *

(UNIX timestamp) The time when the contact last messaged in.

+ */ + @java.lang.Override + @JsonSetter(value = "last_replied_at", nulls = Nulls.SKIP) + public _FinalStage lastRepliedAt(Optional lastRepliedAt) { + this.lastRepliedAt = lastRepliedAt; + return this; + } + + /** + *

(UNIX timestamp) The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually).

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage lastSeenAt(Integer lastSeenAt) { + this.lastSeenAt = Optional.ofNullable(lastSeenAt); + return this; + } + + /** + *

(UNIX timestamp) The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually).

+ */ + @java.lang.Override + @JsonSetter(value = "last_seen_at", nulls = Nulls.SKIP) + public _FinalStage lastSeenAt(Optional lastSeenAt) { + this.lastSeenAt = lastSeenAt; + return this; + } + + /** + *

(UNIX timestamp) The time specified for when a contact signed up.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage signedUpAt(Integer signedUpAt) { + this.signedUpAt = Optional.ofNullable(signedUpAt); + return this; + } + + /** + *

(UNIX timestamp) The time specified for when a contact signed up.

+ */ + @java.lang.Override + @JsonSetter(value = "signed_up_at", nulls = Nulls.SKIP) + public _FinalStage signedUpAt(Optional signedUpAt) { + this.signedUpAt = signedUpAt; + return this; + } + + /** + *

The id of an admin that has been assigned account ownership of the contact.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage ownerId(Integer ownerId) { + this.ownerId = Optional.ofNullable(ownerId); + return this; + } + + /** + *

The id of an admin that has been assigned account ownership of the contact.

+ */ + @java.lang.Override + @JsonSetter(value = "owner_id", nulls = Nulls.SKIP) + public _FinalStage ownerId(Optional ownerId) { + this.ownerId = ownerId; + return this; + } + + /** + *

The contacts name.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage name(String name) { + this.name = Optional.ofNullable(name); + return this; + } + + /** + *

The contacts name.

+ */ + @java.lang.Override + @JsonSetter(value = "name", nulls = Nulls.SKIP) + public _FinalStage name(Optional name) { + this.name = name; + return this; + } + + /** + *

The contacts phone.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage phone(String phone) { + this.phone = Optional.ofNullable(phone); + return this; + } + + /** + *

The contacts phone.

+ */ + @java.lang.Override + @JsonSetter(value = "phone", nulls = Nulls.SKIP) + public _FinalStage phone(Optional phone) { + this.phone = phone; + return this; + } + + /** + *

The contact's email domain.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage emailDomain(String emailDomain) { + this.emailDomain = Optional.ofNullable(emailDomain); + return this; + } + + /** + *

The contact's email domain.

+ */ + @java.lang.Override + @JsonSetter(value = "email_domain", nulls = Nulls.SKIP) + public _FinalStage emailDomain(Optional emailDomain) { + this.emailDomain = emailDomain; + return this; + } + + /** + *

The contact's email.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage email(String email) { + this.email = Optional.ofNullable(email); + return this; + } + + /** + *

The contact's email.

+ */ + @java.lang.Override + @JsonSetter(value = "email", nulls = Nulls.SKIP) + public _FinalStage email(Optional email) { + this.email = email; + return this; + } + + /** + *

The unique identifier for the contact which is provided by the Client.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage externalId(String externalId) { + this.externalId = Optional.ofNullable(externalId); + return this; + } + + /** + *

The unique identifier for the contact which is provided by the Client.

+ */ + @java.lang.Override + @JsonSetter(value = "external_id", nulls = Nulls.SKIP) + public _FinalStage externalId(Optional externalId) { + this.externalId = externalId; + return this; + } + + @java.lang.Override + public Contact build() { + return new Contact( + id, + externalId, + workspaceId, + role, + email, + emailDomain, + phone, + name, + ownerId, + hasHardBounced, + markedEmailAsSpam, + unsubscribedFromEmails, + createdAt, + updatedAt, + signedUpAt, + lastSeenAt, + lastRepliedAt, + lastContactedAt, + lastEmailOpenedAt, + lastEmailClickedAt, + languageOverride, + browser, + browserVersion, + browserLanguage, + os, + androidAppName, + androidAppVersion, + androidDevice, + androidOsVersion, + androidSdkVersion, + androidLastSeenAt, + iosAppName, + iosAppVersion, + iosDevice, + iosOsVersion, + iosSdkVersion, + iosLastSeenAt, + customAttributes, + avatar, + tags, + notes, + companies, + location, + socialProfiles, + additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/contacts/types/ContactsCreateResponse.java b/src/main/java/com/intercom/api/resources/contacts/types/ContactsCreateResponse.java new file mode 100644 index 00000000..a85fc480 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/contacts/types/ContactsCreateResponse.java @@ -0,0 +1,2001 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.contacts.types; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.types.ContactCompanies; +import com.intercom.api.types.ContactLocation; +import com.intercom.api.types.ContactNotes; +import com.intercom.api.types.ContactSocialProfiles; +import com.intercom.api.types.ContactTags; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = ContactsCreateResponse.Builder.class) +public final class ContactsCreateResponse implements IContact { + private final String id; + + private final Optional externalId; + + private final String workspaceId; + + private final String role; + + private final Optional email; + + private final Optional emailDomain; + + private final Optional phone; + + private final Optional name; + + private final Optional ownerId; + + private final boolean hasHardBounced; + + private final boolean markedEmailAsSpam; + + private final boolean unsubscribedFromEmails; + + private final int createdAt; + + private final int updatedAt; + + private final Optional signedUpAt; + + private final Optional lastSeenAt; + + private final Optional lastRepliedAt; + + private final Optional lastContactedAt; + + private final Optional lastEmailOpenedAt; + + private final Optional lastEmailClickedAt; + + private final Optional languageOverride; + + private final Optional browser; + + private final Optional browserVersion; + + private final Optional browserLanguage; + + private final Optional os; + + private final Optional androidAppName; + + private final Optional androidAppVersion; + + private final Optional androidDevice; + + private final Optional androidOsVersion; + + private final Optional androidSdkVersion; + + private final Optional androidLastSeenAt; + + private final Optional iosAppName; + + private final Optional iosAppVersion; + + private final Optional iosDevice; + + private final Optional iosOsVersion; + + private final Optional iosSdkVersion; + + private final Optional iosLastSeenAt; + + private final Optional> customAttributes; + + private final Optional avatar; + + private final Optional tags; + + private final Optional notes; + + private final Optional companies; + + private final Optional location; + + private final Optional socialProfiles; + + private final Optional enabledPushMessaging; + + private final Map additionalProperties; + + private ContactsCreateResponse( + String id, + Optional externalId, + String workspaceId, + String role, + Optional email, + Optional emailDomain, + Optional phone, + Optional name, + Optional ownerId, + boolean hasHardBounced, + boolean markedEmailAsSpam, + boolean unsubscribedFromEmails, + int createdAt, + int updatedAt, + Optional signedUpAt, + Optional lastSeenAt, + Optional lastRepliedAt, + Optional lastContactedAt, + Optional lastEmailOpenedAt, + Optional lastEmailClickedAt, + Optional languageOverride, + Optional browser, + Optional browserVersion, + Optional browserLanguage, + Optional os, + Optional androidAppName, + Optional androidAppVersion, + Optional androidDevice, + Optional androidOsVersion, + Optional androidSdkVersion, + Optional androidLastSeenAt, + Optional iosAppName, + Optional iosAppVersion, + Optional iosDevice, + Optional iosOsVersion, + Optional iosSdkVersion, + Optional iosLastSeenAt, + Optional> customAttributes, + Optional avatar, + Optional tags, + Optional notes, + Optional companies, + Optional location, + Optional socialProfiles, + Optional enabledPushMessaging, + Map additionalProperties) { + this.id = id; + this.externalId = externalId; + this.workspaceId = workspaceId; + this.role = role; + this.email = email; + this.emailDomain = emailDomain; + this.phone = phone; + this.name = name; + this.ownerId = ownerId; + this.hasHardBounced = hasHardBounced; + this.markedEmailAsSpam = markedEmailAsSpam; + this.unsubscribedFromEmails = unsubscribedFromEmails; + this.createdAt = createdAt; + this.updatedAt = updatedAt; + this.signedUpAt = signedUpAt; + this.lastSeenAt = lastSeenAt; + this.lastRepliedAt = lastRepliedAt; + this.lastContactedAt = lastContactedAt; + this.lastEmailOpenedAt = lastEmailOpenedAt; + this.lastEmailClickedAt = lastEmailClickedAt; + this.languageOverride = languageOverride; + this.browser = browser; + this.browserVersion = browserVersion; + this.browserLanguage = browserLanguage; + this.os = os; + this.androidAppName = androidAppName; + this.androidAppVersion = androidAppVersion; + this.androidDevice = androidDevice; + this.androidOsVersion = androidOsVersion; + this.androidSdkVersion = androidSdkVersion; + this.androidLastSeenAt = androidLastSeenAt; + this.iosAppName = iosAppName; + this.iosAppVersion = iosAppVersion; + this.iosDevice = iosDevice; + this.iosOsVersion = iosOsVersion; + this.iosSdkVersion = iosSdkVersion; + this.iosLastSeenAt = iosLastSeenAt; + this.customAttributes = customAttributes; + this.avatar = avatar; + this.tags = tags; + this.notes = notes; + this.companies = companies; + this.location = location; + this.socialProfiles = socialProfiles; + this.enabledPushMessaging = enabledPushMessaging; + this.additionalProperties = additionalProperties; + } + + /** + * @return The type of object. + */ + @JsonProperty("type") + public String getType() { + return "contact"; + } + + /** + * @return The unique identifier for the contact which is given by Intercom. + */ + @JsonProperty("id") + public String getId() { + return id; + } + + /** + * @return The unique identifier for the contact which is provided by the Client. + */ + @JsonProperty("external_id") + public Optional getExternalId() { + return externalId; + } + + /** + * @return The id of the workspace which the contact belongs to. + */ + @JsonProperty("workspace_id") + public String getWorkspaceId() { + return workspaceId; + } + + /** + * @return The role of the contact. + */ + @JsonProperty("role") + public String getRole() { + return role; + } + + /** + * @return The contact's email. + */ + @JsonProperty("email") + public Optional getEmail() { + return email; + } + + /** + * @return The contact's email domain. + */ + @JsonProperty("email_domain") + public Optional getEmailDomain() { + return emailDomain; + } + + /** + * @return The contacts phone. + */ + @JsonProperty("phone") + public Optional getPhone() { + return phone; + } + + /** + * @return The contacts name. + */ + @JsonProperty("name") + public Optional getName() { + return name; + } + + /** + * @return The id of an admin that has been assigned account ownership of the contact. + */ + @JsonProperty("owner_id") + public Optional getOwnerId() { + return ownerId; + } + + /** + * @return Whether the contact has had an email sent to them hard bounce. + */ + @JsonProperty("has_hard_bounced") + public boolean getHasHardBounced() { + return hasHardBounced; + } + + /** + * @return Whether the contact has marked an email sent to them as spam. + */ + @JsonProperty("marked_email_as_spam") + public boolean getMarkedEmailAsSpam() { + return markedEmailAsSpam; + } + + /** + * @return Whether the contact is unsubscribed from emails. + */ + @JsonProperty("unsubscribed_from_emails") + public boolean getUnsubscribedFromEmails() { + return unsubscribedFromEmails; + } + + /** + * @return (UNIX timestamp) The time when the contact was created. + */ + @JsonProperty("created_at") + public int getCreatedAt() { + return createdAt; + } + + /** + * @return (UNIX timestamp) The time when the contact was last updated. + */ + @JsonProperty("updated_at") + public int getUpdatedAt() { + return updatedAt; + } + + /** + * @return (UNIX timestamp) The time specified for when a contact signed up. + */ + @JsonProperty("signed_up_at") + public Optional getSignedUpAt() { + return signedUpAt; + } + + /** + * @return (UNIX timestamp) The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually). + */ + @JsonProperty("last_seen_at") + public Optional getLastSeenAt() { + return lastSeenAt; + } + + /** + * @return (UNIX timestamp) The time when the contact last messaged in. + */ + @JsonProperty("last_replied_at") + public Optional getLastRepliedAt() { + return lastRepliedAt; + } + + /** + * @return (UNIX timestamp) The time when the contact was last messaged. + */ + @JsonProperty("last_contacted_at") + public Optional getLastContactedAt() { + return lastContactedAt; + } + + /** + * @return (UNIX timestamp) The time when the contact last opened an email. + */ + @JsonProperty("last_email_opened_at") + public Optional getLastEmailOpenedAt() { + return lastEmailOpenedAt; + } + + /** + * @return (UNIX timestamp) The time when the contact last clicked a link in an email. + */ + @JsonProperty("last_email_clicked_at") + public Optional getLastEmailClickedAt() { + return lastEmailClickedAt; + } + + /** + * @return A preferred language setting for the contact, used by the Intercom Messenger even if their browser settings change. + */ + @JsonProperty("language_override") + public Optional getLanguageOverride() { + return languageOverride; + } + + /** + * @return The name of the browser which the contact is using. + */ + @JsonProperty("browser") + public Optional getBrowser() { + return browser; + } + + /** + * @return The version of the browser which the contact is using. + */ + @JsonProperty("browser_version") + public Optional getBrowserVersion() { + return browserVersion; + } + + /** + * @return The language set by the browser which the contact is using. + */ + @JsonProperty("browser_language") + public Optional getBrowserLanguage() { + return browserLanguage; + } + + /** + * @return The operating system which the contact is using. + */ + @JsonProperty("os") + public Optional getOs() { + return os; + } + + /** + * @return The name of the Android app which the contact is using. + */ + @JsonProperty("android_app_name") + public Optional getAndroidAppName() { + return androidAppName; + } + + /** + * @return The version of the Android app which the contact is using. + */ + @JsonProperty("android_app_version") + public Optional getAndroidAppVersion() { + return androidAppVersion; + } + + /** + * @return The Android device which the contact is using. + */ + @JsonProperty("android_device") + public Optional getAndroidDevice() { + return androidDevice; + } + + /** + * @return The version of the Android OS which the contact is using. + */ + @JsonProperty("android_os_version") + public Optional getAndroidOsVersion() { + return androidOsVersion; + } + + /** + * @return The version of the Android SDK which the contact is using. + */ + @JsonProperty("android_sdk_version") + public Optional getAndroidSdkVersion() { + return androidSdkVersion; + } + + /** + * @return (UNIX timestamp) The time when the contact was last seen on an Android device. + */ + @JsonProperty("android_last_seen_at") + public Optional getAndroidLastSeenAt() { + return androidLastSeenAt; + } + + /** + * @return The name of the iOS app which the contact is using. + */ + @JsonProperty("ios_app_name") + public Optional getIosAppName() { + return iosAppName; + } + + /** + * @return The version of the iOS app which the contact is using. + */ + @JsonProperty("ios_app_version") + public Optional getIosAppVersion() { + return iosAppVersion; + } + + /** + * @return The iOS device which the contact is using. + */ + @JsonProperty("ios_device") + public Optional getIosDevice() { + return iosDevice; + } + + /** + * @return The version of iOS which the contact is using. + */ + @JsonProperty("ios_os_version") + public Optional getIosOsVersion() { + return iosOsVersion; + } + + /** + * @return The version of the iOS SDK which the contact is using. + */ + @JsonProperty("ios_sdk_version") + public Optional getIosSdkVersion() { + return iosSdkVersion; + } + + /** + * @return (UNIX timestamp) The last time the contact used the iOS app. + */ + @JsonProperty("ios_last_seen_at") + public Optional getIosLastSeenAt() { + return iosLastSeenAt; + } + + /** + * @return The custom attributes which are set for the contact. + */ + @JsonProperty("custom_attributes") + public Optional> getCustomAttributes() { + return customAttributes; + } + + /** + * @return An image URL containing the avatar of a contact. + */ + @JsonProperty("avatar") + public Optional getAvatar() { + return avatar; + } + + @JsonProperty("tags") + public Optional getTags() { + return tags; + } + + @JsonProperty("notes") + public Optional getNotes() { + return notes; + } + + @JsonProperty("companies") + public Optional getCompanies() { + return companies; + } + + @JsonProperty("location") + public Optional getLocation() { + return location; + } + + @JsonProperty("social_profiles") + public Optional getSocialProfiles() { + return socialProfiles; + } + + /** + * @return If the user has enabled push messaging. + */ + @JsonProperty("enabled_push_messaging") + public Optional getEnabledPushMessaging() { + return enabledPushMessaging; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof ContactsCreateResponse && equalTo((ContactsCreateResponse) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(ContactsCreateResponse other) { + return id.equals(other.id) + && externalId.equals(other.externalId) + && workspaceId.equals(other.workspaceId) + && role.equals(other.role) + && email.equals(other.email) + && emailDomain.equals(other.emailDomain) + && phone.equals(other.phone) + && name.equals(other.name) + && ownerId.equals(other.ownerId) + && hasHardBounced == other.hasHardBounced + && markedEmailAsSpam == other.markedEmailAsSpam + && unsubscribedFromEmails == other.unsubscribedFromEmails + && createdAt == other.createdAt + && updatedAt == other.updatedAt + && signedUpAt.equals(other.signedUpAt) + && lastSeenAt.equals(other.lastSeenAt) + && lastRepliedAt.equals(other.lastRepliedAt) + && lastContactedAt.equals(other.lastContactedAt) + && lastEmailOpenedAt.equals(other.lastEmailOpenedAt) + && lastEmailClickedAt.equals(other.lastEmailClickedAt) + && languageOverride.equals(other.languageOverride) + && browser.equals(other.browser) + && browserVersion.equals(other.browserVersion) + && browserLanguage.equals(other.browserLanguage) + && os.equals(other.os) + && androidAppName.equals(other.androidAppName) + && androidAppVersion.equals(other.androidAppVersion) + && androidDevice.equals(other.androidDevice) + && androidOsVersion.equals(other.androidOsVersion) + && androidSdkVersion.equals(other.androidSdkVersion) + && androidLastSeenAt.equals(other.androidLastSeenAt) + && iosAppName.equals(other.iosAppName) + && iosAppVersion.equals(other.iosAppVersion) + && iosDevice.equals(other.iosDevice) + && iosOsVersion.equals(other.iosOsVersion) + && iosSdkVersion.equals(other.iosSdkVersion) + && iosLastSeenAt.equals(other.iosLastSeenAt) + && customAttributes.equals(other.customAttributes) + && avatar.equals(other.avatar) + && tags.equals(other.tags) + && notes.equals(other.notes) + && companies.equals(other.companies) + && location.equals(other.location) + && socialProfiles.equals(other.socialProfiles) + && enabledPushMessaging.equals(other.enabledPushMessaging); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash( + this.id, + this.externalId, + this.workspaceId, + this.role, + this.email, + this.emailDomain, + this.phone, + this.name, + this.ownerId, + this.hasHardBounced, + this.markedEmailAsSpam, + this.unsubscribedFromEmails, + this.createdAt, + this.updatedAt, + this.signedUpAt, + this.lastSeenAt, + this.lastRepliedAt, + this.lastContactedAt, + this.lastEmailOpenedAt, + this.lastEmailClickedAt, + this.languageOverride, + this.browser, + this.browserVersion, + this.browserLanguage, + this.os, + this.androidAppName, + this.androidAppVersion, + this.androidDevice, + this.androidOsVersion, + this.androidSdkVersion, + this.androidLastSeenAt, + this.iosAppName, + this.iosAppVersion, + this.iosDevice, + this.iosOsVersion, + this.iosSdkVersion, + this.iosLastSeenAt, + this.customAttributes, + this.avatar, + this.tags, + this.notes, + this.companies, + this.location, + this.socialProfiles, + this.enabledPushMessaging); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static IdStage builder() { + return new Builder(); + } + + public interface IdStage { + /** + *

The unique identifier for the contact which is given by Intercom.

+ */ + WorkspaceIdStage id(@NotNull String id); + + Builder from(ContactsCreateResponse other); + } + + public interface WorkspaceIdStage { + /** + *

The id of the workspace which the contact belongs to.

+ */ + RoleStage workspaceId(@NotNull String workspaceId); + } + + public interface RoleStage { + /** + *

The role of the contact.

+ */ + HasHardBouncedStage role(@NotNull String role); + } + + public interface HasHardBouncedStage { + /** + *

Whether the contact has had an email sent to them hard bounce.

+ */ + MarkedEmailAsSpamStage hasHardBounced(boolean hasHardBounced); + } + + public interface MarkedEmailAsSpamStage { + /** + *

Whether the contact has marked an email sent to them as spam.

+ */ + UnsubscribedFromEmailsStage markedEmailAsSpam(boolean markedEmailAsSpam); + } + + public interface UnsubscribedFromEmailsStage { + /** + *

Whether the contact is unsubscribed from emails.

+ */ + CreatedAtStage unsubscribedFromEmails(boolean unsubscribedFromEmails); + } + + public interface CreatedAtStage { + /** + *

(UNIX timestamp) The time when the contact was created.

+ */ + UpdatedAtStage createdAt(int createdAt); + } + + public interface UpdatedAtStage { + /** + *

(UNIX timestamp) The time when the contact was last updated.

+ */ + _FinalStage updatedAt(int updatedAt); + } + + public interface _FinalStage { + ContactsCreateResponse build(); + + /** + *

The unique identifier for the contact which is provided by the Client.

+ */ + _FinalStage externalId(Optional externalId); + + _FinalStage externalId(String externalId); + + /** + *

The contact's email.

+ */ + _FinalStage email(Optional email); + + _FinalStage email(String email); + + /** + *

The contact's email domain.

+ */ + _FinalStage emailDomain(Optional emailDomain); + + _FinalStage emailDomain(String emailDomain); + + /** + *

The contacts phone.

+ */ + _FinalStage phone(Optional phone); + + _FinalStage phone(String phone); + + /** + *

The contacts name.

+ */ + _FinalStage name(Optional name); + + _FinalStage name(String name); + + /** + *

The id of an admin that has been assigned account ownership of the contact.

+ */ + _FinalStage ownerId(Optional ownerId); + + _FinalStage ownerId(Integer ownerId); + + /** + *

(UNIX timestamp) The time specified for when a contact signed up.

+ */ + _FinalStage signedUpAt(Optional signedUpAt); + + _FinalStage signedUpAt(Integer signedUpAt); + + /** + *

(UNIX timestamp) The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually).

+ */ + _FinalStage lastSeenAt(Optional lastSeenAt); + + _FinalStage lastSeenAt(Integer lastSeenAt); + + /** + *

(UNIX timestamp) The time when the contact last messaged in.

+ */ + _FinalStage lastRepliedAt(Optional lastRepliedAt); + + _FinalStage lastRepliedAt(Integer lastRepliedAt); + + /** + *

(UNIX timestamp) The time when the contact was last messaged.

+ */ + _FinalStage lastContactedAt(Optional lastContactedAt); + + _FinalStage lastContactedAt(Integer lastContactedAt); + + /** + *

(UNIX timestamp) The time when the contact last opened an email.

+ */ + _FinalStage lastEmailOpenedAt(Optional lastEmailOpenedAt); + + _FinalStage lastEmailOpenedAt(Integer lastEmailOpenedAt); + + /** + *

(UNIX timestamp) The time when the contact last clicked a link in an email.

+ */ + _FinalStage lastEmailClickedAt(Optional lastEmailClickedAt); + + _FinalStage lastEmailClickedAt(Integer lastEmailClickedAt); + + /** + *

A preferred language setting for the contact, used by the Intercom Messenger even if their browser settings change.

+ */ + _FinalStage languageOverride(Optional languageOverride); + + _FinalStage languageOverride(String languageOverride); + + /** + *

The name of the browser which the contact is using.

+ */ + _FinalStage browser(Optional browser); + + _FinalStage browser(String browser); + + /** + *

The version of the browser which the contact is using.

+ */ + _FinalStage browserVersion(Optional browserVersion); + + _FinalStage browserVersion(String browserVersion); + + /** + *

The language set by the browser which the contact is using.

+ */ + _FinalStage browserLanguage(Optional browserLanguage); + + _FinalStage browserLanguage(String browserLanguage); + + /** + *

The operating system which the contact is using.

+ */ + _FinalStage os(Optional os); + + _FinalStage os(String os); + + /** + *

The name of the Android app which the contact is using.

+ */ + _FinalStage androidAppName(Optional androidAppName); + + _FinalStage androidAppName(String androidAppName); + + /** + *

The version of the Android app which the contact is using.

+ */ + _FinalStage androidAppVersion(Optional androidAppVersion); + + _FinalStage androidAppVersion(String androidAppVersion); + + /** + *

The Android device which the contact is using.

+ */ + _FinalStage androidDevice(Optional androidDevice); + + _FinalStage androidDevice(String androidDevice); + + /** + *

The version of the Android OS which the contact is using.

+ */ + _FinalStage androidOsVersion(Optional androidOsVersion); + + _FinalStage androidOsVersion(String androidOsVersion); + + /** + *

The version of the Android SDK which the contact is using.

+ */ + _FinalStage androidSdkVersion(Optional androidSdkVersion); + + _FinalStage androidSdkVersion(String androidSdkVersion); + + /** + *

(UNIX timestamp) The time when the contact was last seen on an Android device.

+ */ + _FinalStage androidLastSeenAt(Optional androidLastSeenAt); + + _FinalStage androidLastSeenAt(Integer androidLastSeenAt); + + /** + *

The name of the iOS app which the contact is using.

+ */ + _FinalStage iosAppName(Optional iosAppName); + + _FinalStage iosAppName(String iosAppName); + + /** + *

The version of the iOS app which the contact is using.

+ */ + _FinalStage iosAppVersion(Optional iosAppVersion); + + _FinalStage iosAppVersion(String iosAppVersion); + + /** + *

The iOS device which the contact is using.

+ */ + _FinalStage iosDevice(Optional iosDevice); + + _FinalStage iosDevice(String iosDevice); + + /** + *

The version of iOS which the contact is using.

+ */ + _FinalStage iosOsVersion(Optional iosOsVersion); + + _FinalStage iosOsVersion(String iosOsVersion); + + /** + *

The version of the iOS SDK which the contact is using.

+ */ + _FinalStage iosSdkVersion(Optional iosSdkVersion); + + _FinalStage iosSdkVersion(String iosSdkVersion); + + /** + *

(UNIX timestamp) The last time the contact used the iOS app.

+ */ + _FinalStage iosLastSeenAt(Optional iosLastSeenAt); + + _FinalStage iosLastSeenAt(Integer iosLastSeenAt); + + /** + *

The custom attributes which are set for the contact.

+ */ + _FinalStage customAttributes(Optional> customAttributes); + + _FinalStage customAttributes(Map customAttributes); + + /** + *

An image URL containing the avatar of a contact.

+ */ + _FinalStage avatar(Optional avatar); + + _FinalStage avatar(String avatar); + + _FinalStage tags(Optional tags); + + _FinalStage tags(ContactTags tags); + + _FinalStage notes(Optional notes); + + _FinalStage notes(ContactNotes notes); + + _FinalStage companies(Optional companies); + + _FinalStage companies(ContactCompanies companies); + + _FinalStage location(Optional location); + + _FinalStage location(ContactLocation location); + + _FinalStage socialProfiles(Optional socialProfiles); + + _FinalStage socialProfiles(ContactSocialProfiles socialProfiles); + + /** + *

If the user has enabled push messaging.

+ */ + _FinalStage enabledPushMessaging(Optional enabledPushMessaging); + + _FinalStage enabledPushMessaging(Boolean enabledPushMessaging); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder + implements IdStage, + WorkspaceIdStage, + RoleStage, + HasHardBouncedStage, + MarkedEmailAsSpamStage, + UnsubscribedFromEmailsStage, + CreatedAtStage, + UpdatedAtStage, + _FinalStage { + private String id; + + private String workspaceId; + + private String role; + + private boolean hasHardBounced; + + private boolean markedEmailAsSpam; + + private boolean unsubscribedFromEmails; + + private int createdAt; + + private int updatedAt; + + private Optional enabledPushMessaging = Optional.empty(); + + private Optional socialProfiles = Optional.empty(); + + private Optional location = Optional.empty(); + + private Optional companies = Optional.empty(); + + private Optional notes = Optional.empty(); + + private Optional tags = Optional.empty(); + + private Optional avatar = Optional.empty(); + + private Optional> customAttributes = Optional.empty(); + + private Optional iosLastSeenAt = Optional.empty(); + + private Optional iosSdkVersion = Optional.empty(); + + private Optional iosOsVersion = Optional.empty(); + + private Optional iosDevice = Optional.empty(); + + private Optional iosAppVersion = Optional.empty(); + + private Optional iosAppName = Optional.empty(); + + private Optional androidLastSeenAt = Optional.empty(); + + private Optional androidSdkVersion = Optional.empty(); + + private Optional androidOsVersion = Optional.empty(); + + private Optional androidDevice = Optional.empty(); + + private Optional androidAppVersion = Optional.empty(); + + private Optional androidAppName = Optional.empty(); + + private Optional os = Optional.empty(); + + private Optional browserLanguage = Optional.empty(); + + private Optional browserVersion = Optional.empty(); + + private Optional browser = Optional.empty(); + + private Optional languageOverride = Optional.empty(); + + private Optional lastEmailClickedAt = Optional.empty(); + + private Optional lastEmailOpenedAt = Optional.empty(); + + private Optional lastContactedAt = Optional.empty(); + + private Optional lastRepliedAt = Optional.empty(); + + private Optional lastSeenAt = Optional.empty(); + + private Optional signedUpAt = Optional.empty(); + + private Optional ownerId = Optional.empty(); + + private Optional name = Optional.empty(); + + private Optional phone = Optional.empty(); + + private Optional emailDomain = Optional.empty(); + + private Optional email = Optional.empty(); + + private Optional externalId = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(ContactsCreateResponse other) { + id(other.getId()); + externalId(other.getExternalId()); + workspaceId(other.getWorkspaceId()); + role(other.getRole()); + email(other.getEmail()); + emailDomain(other.getEmailDomain()); + phone(other.getPhone()); + name(other.getName()); + ownerId(other.getOwnerId()); + hasHardBounced(other.getHasHardBounced()); + markedEmailAsSpam(other.getMarkedEmailAsSpam()); + unsubscribedFromEmails(other.getUnsubscribedFromEmails()); + createdAt(other.getCreatedAt()); + updatedAt(other.getUpdatedAt()); + signedUpAt(other.getSignedUpAt()); + lastSeenAt(other.getLastSeenAt()); + lastRepliedAt(other.getLastRepliedAt()); + lastContactedAt(other.getLastContactedAt()); + lastEmailOpenedAt(other.getLastEmailOpenedAt()); + lastEmailClickedAt(other.getLastEmailClickedAt()); + languageOverride(other.getLanguageOverride()); + browser(other.getBrowser()); + browserVersion(other.getBrowserVersion()); + browserLanguage(other.getBrowserLanguage()); + os(other.getOs()); + androidAppName(other.getAndroidAppName()); + androidAppVersion(other.getAndroidAppVersion()); + androidDevice(other.getAndroidDevice()); + androidOsVersion(other.getAndroidOsVersion()); + androidSdkVersion(other.getAndroidSdkVersion()); + androidLastSeenAt(other.getAndroidLastSeenAt()); + iosAppName(other.getIosAppName()); + iosAppVersion(other.getIosAppVersion()); + iosDevice(other.getIosDevice()); + iosOsVersion(other.getIosOsVersion()); + iosSdkVersion(other.getIosSdkVersion()); + iosLastSeenAt(other.getIosLastSeenAt()); + customAttributes(other.getCustomAttributes()); + avatar(other.getAvatar()); + tags(other.getTags()); + notes(other.getNotes()); + companies(other.getCompanies()); + location(other.getLocation()); + socialProfiles(other.getSocialProfiles()); + enabledPushMessaging(other.getEnabledPushMessaging()); + return this; + } + + /** + *

The unique identifier for the contact which is given by Intercom.

+ *

The unique identifier for the contact which is given by Intercom.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("id") + public WorkspaceIdStage id(@NotNull String id) { + this.id = Objects.requireNonNull(id, "id must not be null"); + return this; + } + + /** + *

The id of the workspace which the contact belongs to.

+ *

The id of the workspace which the contact belongs to.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("workspace_id") + public RoleStage workspaceId(@NotNull String workspaceId) { + this.workspaceId = Objects.requireNonNull(workspaceId, "workspaceId must not be null"); + return this; + } + + /** + *

The role of the contact.

+ *

The role of the contact.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("role") + public HasHardBouncedStage role(@NotNull String role) { + this.role = Objects.requireNonNull(role, "role must not be null"); + return this; + } + + /** + *

Whether the contact has had an email sent to them hard bounce.

+ *

Whether the contact has had an email sent to them hard bounce.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("has_hard_bounced") + public MarkedEmailAsSpamStage hasHardBounced(boolean hasHardBounced) { + this.hasHardBounced = hasHardBounced; + return this; + } + + /** + *

Whether the contact has marked an email sent to them as spam.

+ *

Whether the contact has marked an email sent to them as spam.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("marked_email_as_spam") + public UnsubscribedFromEmailsStage markedEmailAsSpam(boolean markedEmailAsSpam) { + this.markedEmailAsSpam = markedEmailAsSpam; + return this; + } + + /** + *

Whether the contact is unsubscribed from emails.

+ *

Whether the contact is unsubscribed from emails.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("unsubscribed_from_emails") + public CreatedAtStage unsubscribedFromEmails(boolean unsubscribedFromEmails) { + this.unsubscribedFromEmails = unsubscribedFromEmails; + return this; + } + + /** + *

(UNIX timestamp) The time when the contact was created.

+ *

(UNIX timestamp) The time when the contact was created.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("created_at") + public UpdatedAtStage createdAt(int createdAt) { + this.createdAt = createdAt; + return this; + } + + /** + *

(UNIX timestamp) The time when the contact was last updated.

+ *

(UNIX timestamp) The time when the contact was last updated.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("updated_at") + public _FinalStage updatedAt(int updatedAt) { + this.updatedAt = updatedAt; + return this; + } + + /** + *

If the user has enabled push messaging.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage enabledPushMessaging(Boolean enabledPushMessaging) { + this.enabledPushMessaging = Optional.ofNullable(enabledPushMessaging); + return this; + } + + /** + *

If the user has enabled push messaging.

+ */ + @java.lang.Override + @JsonSetter(value = "enabled_push_messaging", nulls = Nulls.SKIP) + public _FinalStage enabledPushMessaging(Optional enabledPushMessaging) { + this.enabledPushMessaging = enabledPushMessaging; + return this; + } + + @java.lang.Override + public _FinalStage socialProfiles(ContactSocialProfiles socialProfiles) { + this.socialProfiles = Optional.ofNullable(socialProfiles); + return this; + } + + @java.lang.Override + @JsonSetter(value = "social_profiles", nulls = Nulls.SKIP) + public _FinalStage socialProfiles(Optional socialProfiles) { + this.socialProfiles = socialProfiles; + return this; + } + + @java.lang.Override + public _FinalStage location(ContactLocation location) { + this.location = Optional.ofNullable(location); + return this; + } + + @java.lang.Override + @JsonSetter(value = "location", nulls = Nulls.SKIP) + public _FinalStage location(Optional location) { + this.location = location; + return this; + } + + @java.lang.Override + public _FinalStage companies(ContactCompanies companies) { + this.companies = Optional.ofNullable(companies); + return this; + } + + @java.lang.Override + @JsonSetter(value = "companies", nulls = Nulls.SKIP) + public _FinalStage companies(Optional companies) { + this.companies = companies; + return this; + } + + @java.lang.Override + public _FinalStage notes(ContactNotes notes) { + this.notes = Optional.ofNullable(notes); + return this; + } + + @java.lang.Override + @JsonSetter(value = "notes", nulls = Nulls.SKIP) + public _FinalStage notes(Optional notes) { + this.notes = notes; + return this; + } + + @java.lang.Override + public _FinalStage tags(ContactTags tags) { + this.tags = Optional.ofNullable(tags); + return this; + } + + @java.lang.Override + @JsonSetter(value = "tags", nulls = Nulls.SKIP) + public _FinalStage tags(Optional tags) { + this.tags = tags; + return this; + } + + /** + *

An image URL containing the avatar of a contact.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage avatar(String avatar) { + this.avatar = Optional.ofNullable(avatar); + return this; + } + + /** + *

An image URL containing the avatar of a contact.

+ */ + @java.lang.Override + @JsonSetter(value = "avatar", nulls = Nulls.SKIP) + public _FinalStage avatar(Optional avatar) { + this.avatar = avatar; + return this; + } + + /** + *

The custom attributes which are set for the contact.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage customAttributes(Map customAttributes) { + this.customAttributes = Optional.ofNullable(customAttributes); + return this; + } + + /** + *

The custom attributes which are set for the contact.

+ */ + @java.lang.Override + @JsonSetter(value = "custom_attributes", nulls = Nulls.SKIP) + public _FinalStage customAttributes(Optional> customAttributes) { + this.customAttributes = customAttributes; + return this; + } + + /** + *

(UNIX timestamp) The last time the contact used the iOS app.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage iosLastSeenAt(Integer iosLastSeenAt) { + this.iosLastSeenAt = Optional.ofNullable(iosLastSeenAt); + return this; + } + + /** + *

(UNIX timestamp) The last time the contact used the iOS app.

+ */ + @java.lang.Override + @JsonSetter(value = "ios_last_seen_at", nulls = Nulls.SKIP) + public _FinalStage iosLastSeenAt(Optional iosLastSeenAt) { + this.iosLastSeenAt = iosLastSeenAt; + return this; + } + + /** + *

The version of the iOS SDK which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage iosSdkVersion(String iosSdkVersion) { + this.iosSdkVersion = Optional.ofNullable(iosSdkVersion); + return this; + } + + /** + *

The version of the iOS SDK which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "ios_sdk_version", nulls = Nulls.SKIP) + public _FinalStage iosSdkVersion(Optional iosSdkVersion) { + this.iosSdkVersion = iosSdkVersion; + return this; + } + + /** + *

The version of iOS which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage iosOsVersion(String iosOsVersion) { + this.iosOsVersion = Optional.ofNullable(iosOsVersion); + return this; + } + + /** + *

The version of iOS which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "ios_os_version", nulls = Nulls.SKIP) + public _FinalStage iosOsVersion(Optional iosOsVersion) { + this.iosOsVersion = iosOsVersion; + return this; + } + + /** + *

The iOS device which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage iosDevice(String iosDevice) { + this.iosDevice = Optional.ofNullable(iosDevice); + return this; + } + + /** + *

The iOS device which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "ios_device", nulls = Nulls.SKIP) + public _FinalStage iosDevice(Optional iosDevice) { + this.iosDevice = iosDevice; + return this; + } + + /** + *

The version of the iOS app which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage iosAppVersion(String iosAppVersion) { + this.iosAppVersion = Optional.ofNullable(iosAppVersion); + return this; + } + + /** + *

The version of the iOS app which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "ios_app_version", nulls = Nulls.SKIP) + public _FinalStage iosAppVersion(Optional iosAppVersion) { + this.iosAppVersion = iosAppVersion; + return this; + } + + /** + *

The name of the iOS app which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage iosAppName(String iosAppName) { + this.iosAppName = Optional.ofNullable(iosAppName); + return this; + } + + /** + *

The name of the iOS app which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "ios_app_name", nulls = Nulls.SKIP) + public _FinalStage iosAppName(Optional iosAppName) { + this.iosAppName = iosAppName; + return this; + } + + /** + *

(UNIX timestamp) The time when the contact was last seen on an Android device.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage androidLastSeenAt(Integer androidLastSeenAt) { + this.androidLastSeenAt = Optional.ofNullable(androidLastSeenAt); + return this; + } + + /** + *

(UNIX timestamp) The time when the contact was last seen on an Android device.

+ */ + @java.lang.Override + @JsonSetter(value = "android_last_seen_at", nulls = Nulls.SKIP) + public _FinalStage androidLastSeenAt(Optional androidLastSeenAt) { + this.androidLastSeenAt = androidLastSeenAt; + return this; + } + + /** + *

The version of the Android SDK which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage androidSdkVersion(String androidSdkVersion) { + this.androidSdkVersion = Optional.ofNullable(androidSdkVersion); + return this; + } + + /** + *

The version of the Android SDK which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "android_sdk_version", nulls = Nulls.SKIP) + public _FinalStage androidSdkVersion(Optional androidSdkVersion) { + this.androidSdkVersion = androidSdkVersion; + return this; + } + + /** + *

The version of the Android OS which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage androidOsVersion(String androidOsVersion) { + this.androidOsVersion = Optional.ofNullable(androidOsVersion); + return this; + } + + /** + *

The version of the Android OS which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "android_os_version", nulls = Nulls.SKIP) + public _FinalStage androidOsVersion(Optional androidOsVersion) { + this.androidOsVersion = androidOsVersion; + return this; + } + + /** + *

The Android device which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage androidDevice(String androidDevice) { + this.androidDevice = Optional.ofNullable(androidDevice); + return this; + } + + /** + *

The Android device which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "android_device", nulls = Nulls.SKIP) + public _FinalStage androidDevice(Optional androidDevice) { + this.androidDevice = androidDevice; + return this; + } + + /** + *

The version of the Android app which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage androidAppVersion(String androidAppVersion) { + this.androidAppVersion = Optional.ofNullable(androidAppVersion); + return this; + } + + /** + *

The version of the Android app which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "android_app_version", nulls = Nulls.SKIP) + public _FinalStage androidAppVersion(Optional androidAppVersion) { + this.androidAppVersion = androidAppVersion; + return this; + } + + /** + *

The name of the Android app which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage androidAppName(String androidAppName) { + this.androidAppName = Optional.ofNullable(androidAppName); + return this; + } + + /** + *

The name of the Android app which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "android_app_name", nulls = Nulls.SKIP) + public _FinalStage androidAppName(Optional androidAppName) { + this.androidAppName = androidAppName; + return this; + } + + /** + *

The operating system which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage os(String os) { + this.os = Optional.ofNullable(os); + return this; + } + + /** + *

The operating system which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "os", nulls = Nulls.SKIP) + public _FinalStage os(Optional os) { + this.os = os; + return this; + } + + /** + *

The language set by the browser which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage browserLanguage(String browserLanguage) { + this.browserLanguage = Optional.ofNullable(browserLanguage); + return this; + } + + /** + *

The language set by the browser which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "browser_language", nulls = Nulls.SKIP) + public _FinalStage browserLanguage(Optional browserLanguage) { + this.browserLanguage = browserLanguage; + return this; + } + + /** + *

The version of the browser which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage browserVersion(String browserVersion) { + this.browserVersion = Optional.ofNullable(browserVersion); + return this; + } + + /** + *

The version of the browser which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "browser_version", nulls = Nulls.SKIP) + public _FinalStage browserVersion(Optional browserVersion) { + this.browserVersion = browserVersion; + return this; + } + + /** + *

The name of the browser which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage browser(String browser) { + this.browser = Optional.ofNullable(browser); + return this; + } + + /** + *

The name of the browser which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "browser", nulls = Nulls.SKIP) + public _FinalStage browser(Optional browser) { + this.browser = browser; + return this; + } + + /** + *

A preferred language setting for the contact, used by the Intercom Messenger even if their browser settings change.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage languageOverride(String languageOverride) { + this.languageOverride = Optional.ofNullable(languageOverride); + return this; + } + + /** + *

A preferred language setting for the contact, used by the Intercom Messenger even if their browser settings change.

+ */ + @java.lang.Override + @JsonSetter(value = "language_override", nulls = Nulls.SKIP) + public _FinalStage languageOverride(Optional languageOverride) { + this.languageOverride = languageOverride; + return this; + } + + /** + *

(UNIX timestamp) The time when the contact last clicked a link in an email.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage lastEmailClickedAt(Integer lastEmailClickedAt) { + this.lastEmailClickedAt = Optional.ofNullable(lastEmailClickedAt); + return this; + } + + /** + *

(UNIX timestamp) The time when the contact last clicked a link in an email.

+ */ + @java.lang.Override + @JsonSetter(value = "last_email_clicked_at", nulls = Nulls.SKIP) + public _FinalStage lastEmailClickedAt(Optional lastEmailClickedAt) { + this.lastEmailClickedAt = lastEmailClickedAt; + return this; + } + + /** + *

(UNIX timestamp) The time when the contact last opened an email.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage lastEmailOpenedAt(Integer lastEmailOpenedAt) { + this.lastEmailOpenedAt = Optional.ofNullable(lastEmailOpenedAt); + return this; + } + + /** + *

(UNIX timestamp) The time when the contact last opened an email.

+ */ + @java.lang.Override + @JsonSetter(value = "last_email_opened_at", nulls = Nulls.SKIP) + public _FinalStage lastEmailOpenedAt(Optional lastEmailOpenedAt) { + this.lastEmailOpenedAt = lastEmailOpenedAt; + return this; + } + + /** + *

(UNIX timestamp) The time when the contact was last messaged.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage lastContactedAt(Integer lastContactedAt) { + this.lastContactedAt = Optional.ofNullable(lastContactedAt); + return this; + } + + /** + *

(UNIX timestamp) The time when the contact was last messaged.

+ */ + @java.lang.Override + @JsonSetter(value = "last_contacted_at", nulls = Nulls.SKIP) + public _FinalStage lastContactedAt(Optional lastContactedAt) { + this.lastContactedAt = lastContactedAt; + return this; + } + + /** + *

(UNIX timestamp) The time when the contact last messaged in.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage lastRepliedAt(Integer lastRepliedAt) { + this.lastRepliedAt = Optional.ofNullable(lastRepliedAt); + return this; + } + + /** + *

(UNIX timestamp) The time when the contact last messaged in.

+ */ + @java.lang.Override + @JsonSetter(value = "last_replied_at", nulls = Nulls.SKIP) + public _FinalStage lastRepliedAt(Optional lastRepliedAt) { + this.lastRepliedAt = lastRepliedAt; + return this; + } + + /** + *

(UNIX timestamp) The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually).

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage lastSeenAt(Integer lastSeenAt) { + this.lastSeenAt = Optional.ofNullable(lastSeenAt); + return this; + } + + /** + *

(UNIX timestamp) The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually).

+ */ + @java.lang.Override + @JsonSetter(value = "last_seen_at", nulls = Nulls.SKIP) + public _FinalStage lastSeenAt(Optional lastSeenAt) { + this.lastSeenAt = lastSeenAt; + return this; + } + + /** + *

(UNIX timestamp) The time specified for when a contact signed up.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage signedUpAt(Integer signedUpAt) { + this.signedUpAt = Optional.ofNullable(signedUpAt); + return this; + } + + /** + *

(UNIX timestamp) The time specified for when a contact signed up.

+ */ + @java.lang.Override + @JsonSetter(value = "signed_up_at", nulls = Nulls.SKIP) + public _FinalStage signedUpAt(Optional signedUpAt) { + this.signedUpAt = signedUpAt; + return this; + } + + /** + *

The id of an admin that has been assigned account ownership of the contact.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage ownerId(Integer ownerId) { + this.ownerId = Optional.ofNullable(ownerId); + return this; + } + + /** + *

The id of an admin that has been assigned account ownership of the contact.

+ */ + @java.lang.Override + @JsonSetter(value = "owner_id", nulls = Nulls.SKIP) + public _FinalStage ownerId(Optional ownerId) { + this.ownerId = ownerId; + return this; + } + + /** + *

The contacts name.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage name(String name) { + this.name = Optional.ofNullable(name); + return this; + } + + /** + *

The contacts name.

+ */ + @java.lang.Override + @JsonSetter(value = "name", nulls = Nulls.SKIP) + public _FinalStage name(Optional name) { + this.name = name; + return this; + } + + /** + *

The contacts phone.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage phone(String phone) { + this.phone = Optional.ofNullable(phone); + return this; + } + + /** + *

The contacts phone.

+ */ + @java.lang.Override + @JsonSetter(value = "phone", nulls = Nulls.SKIP) + public _FinalStage phone(Optional phone) { + this.phone = phone; + return this; + } + + /** + *

The contact's email domain.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage emailDomain(String emailDomain) { + this.emailDomain = Optional.ofNullable(emailDomain); + return this; + } + + /** + *

The contact's email domain.

+ */ + @java.lang.Override + @JsonSetter(value = "email_domain", nulls = Nulls.SKIP) + public _FinalStage emailDomain(Optional emailDomain) { + this.emailDomain = emailDomain; + return this; + } + + /** + *

The contact's email.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage email(String email) { + this.email = Optional.ofNullable(email); + return this; + } + + /** + *

The contact's email.

+ */ + @java.lang.Override + @JsonSetter(value = "email", nulls = Nulls.SKIP) + public _FinalStage email(Optional email) { + this.email = email; + return this; + } + + /** + *

The unique identifier for the contact which is provided by the Client.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage externalId(String externalId) { + this.externalId = Optional.ofNullable(externalId); + return this; + } + + /** + *

The unique identifier for the contact which is provided by the Client.

+ */ + @java.lang.Override + @JsonSetter(value = "external_id", nulls = Nulls.SKIP) + public _FinalStage externalId(Optional externalId) { + this.externalId = externalId; + return this; + } + + @java.lang.Override + public ContactsCreateResponse build() { + return new ContactsCreateResponse( + id, + externalId, + workspaceId, + role, + email, + emailDomain, + phone, + name, + ownerId, + hasHardBounced, + markedEmailAsSpam, + unsubscribedFromEmails, + createdAt, + updatedAt, + signedUpAt, + lastSeenAt, + lastRepliedAt, + lastContactedAt, + lastEmailOpenedAt, + lastEmailClickedAt, + languageOverride, + browser, + browserVersion, + browserLanguage, + os, + androidAppName, + androidAppVersion, + androidDevice, + androidOsVersion, + androidSdkVersion, + androidLastSeenAt, + iosAppName, + iosAppVersion, + iosDevice, + iosOsVersion, + iosSdkVersion, + iosLastSeenAt, + customAttributes, + avatar, + tags, + notes, + companies, + location, + socialProfiles, + enabledPushMessaging, + additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/contacts/types/ContactsFindResponse.java b/src/main/java/com/intercom/api/resources/contacts/types/ContactsFindResponse.java new file mode 100644 index 00000000..6e702b06 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/contacts/types/ContactsFindResponse.java @@ -0,0 +1,2001 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.contacts.types; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.types.ContactCompanies; +import com.intercom.api.types.ContactLocation; +import com.intercom.api.types.ContactNotes; +import com.intercom.api.types.ContactSocialProfiles; +import com.intercom.api.types.ContactTags; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = ContactsFindResponse.Builder.class) +public final class ContactsFindResponse implements IContact { + private final String id; + + private final Optional externalId; + + private final String workspaceId; + + private final String role; + + private final Optional email; + + private final Optional emailDomain; + + private final Optional phone; + + private final Optional name; + + private final Optional ownerId; + + private final boolean hasHardBounced; + + private final boolean markedEmailAsSpam; + + private final boolean unsubscribedFromEmails; + + private final int createdAt; + + private final int updatedAt; + + private final Optional signedUpAt; + + private final Optional lastSeenAt; + + private final Optional lastRepliedAt; + + private final Optional lastContactedAt; + + private final Optional lastEmailOpenedAt; + + private final Optional lastEmailClickedAt; + + private final Optional languageOverride; + + private final Optional browser; + + private final Optional browserVersion; + + private final Optional browserLanguage; + + private final Optional os; + + private final Optional androidAppName; + + private final Optional androidAppVersion; + + private final Optional androidDevice; + + private final Optional androidOsVersion; + + private final Optional androidSdkVersion; + + private final Optional androidLastSeenAt; + + private final Optional iosAppName; + + private final Optional iosAppVersion; + + private final Optional iosDevice; + + private final Optional iosOsVersion; + + private final Optional iosSdkVersion; + + private final Optional iosLastSeenAt; + + private final Optional> customAttributes; + + private final Optional avatar; + + private final Optional tags; + + private final Optional notes; + + private final Optional companies; + + private final Optional location; + + private final Optional socialProfiles; + + private final Optional enabledPushMessaging; + + private final Map additionalProperties; + + private ContactsFindResponse( + String id, + Optional externalId, + String workspaceId, + String role, + Optional email, + Optional emailDomain, + Optional phone, + Optional name, + Optional ownerId, + boolean hasHardBounced, + boolean markedEmailAsSpam, + boolean unsubscribedFromEmails, + int createdAt, + int updatedAt, + Optional signedUpAt, + Optional lastSeenAt, + Optional lastRepliedAt, + Optional lastContactedAt, + Optional lastEmailOpenedAt, + Optional lastEmailClickedAt, + Optional languageOverride, + Optional browser, + Optional browserVersion, + Optional browserLanguage, + Optional os, + Optional androidAppName, + Optional androidAppVersion, + Optional androidDevice, + Optional androidOsVersion, + Optional androidSdkVersion, + Optional androidLastSeenAt, + Optional iosAppName, + Optional iosAppVersion, + Optional iosDevice, + Optional iosOsVersion, + Optional iosSdkVersion, + Optional iosLastSeenAt, + Optional> customAttributes, + Optional avatar, + Optional tags, + Optional notes, + Optional companies, + Optional location, + Optional socialProfiles, + Optional enabledPushMessaging, + Map additionalProperties) { + this.id = id; + this.externalId = externalId; + this.workspaceId = workspaceId; + this.role = role; + this.email = email; + this.emailDomain = emailDomain; + this.phone = phone; + this.name = name; + this.ownerId = ownerId; + this.hasHardBounced = hasHardBounced; + this.markedEmailAsSpam = markedEmailAsSpam; + this.unsubscribedFromEmails = unsubscribedFromEmails; + this.createdAt = createdAt; + this.updatedAt = updatedAt; + this.signedUpAt = signedUpAt; + this.lastSeenAt = lastSeenAt; + this.lastRepliedAt = lastRepliedAt; + this.lastContactedAt = lastContactedAt; + this.lastEmailOpenedAt = lastEmailOpenedAt; + this.lastEmailClickedAt = lastEmailClickedAt; + this.languageOverride = languageOverride; + this.browser = browser; + this.browserVersion = browserVersion; + this.browserLanguage = browserLanguage; + this.os = os; + this.androidAppName = androidAppName; + this.androidAppVersion = androidAppVersion; + this.androidDevice = androidDevice; + this.androidOsVersion = androidOsVersion; + this.androidSdkVersion = androidSdkVersion; + this.androidLastSeenAt = androidLastSeenAt; + this.iosAppName = iosAppName; + this.iosAppVersion = iosAppVersion; + this.iosDevice = iosDevice; + this.iosOsVersion = iosOsVersion; + this.iosSdkVersion = iosSdkVersion; + this.iosLastSeenAt = iosLastSeenAt; + this.customAttributes = customAttributes; + this.avatar = avatar; + this.tags = tags; + this.notes = notes; + this.companies = companies; + this.location = location; + this.socialProfiles = socialProfiles; + this.enabledPushMessaging = enabledPushMessaging; + this.additionalProperties = additionalProperties; + } + + /** + * @return The type of object. + */ + @JsonProperty("type") + public String getType() { + return "contact"; + } + + /** + * @return The unique identifier for the contact which is given by Intercom. + */ + @JsonProperty("id") + public String getId() { + return id; + } + + /** + * @return The unique identifier for the contact which is provided by the Client. + */ + @JsonProperty("external_id") + public Optional getExternalId() { + return externalId; + } + + /** + * @return The id of the workspace which the contact belongs to. + */ + @JsonProperty("workspace_id") + public String getWorkspaceId() { + return workspaceId; + } + + /** + * @return The role of the contact. + */ + @JsonProperty("role") + public String getRole() { + return role; + } + + /** + * @return The contact's email. + */ + @JsonProperty("email") + public Optional getEmail() { + return email; + } + + /** + * @return The contact's email domain. + */ + @JsonProperty("email_domain") + public Optional getEmailDomain() { + return emailDomain; + } + + /** + * @return The contacts phone. + */ + @JsonProperty("phone") + public Optional getPhone() { + return phone; + } + + /** + * @return The contacts name. + */ + @JsonProperty("name") + public Optional getName() { + return name; + } + + /** + * @return The id of an admin that has been assigned account ownership of the contact. + */ + @JsonProperty("owner_id") + public Optional getOwnerId() { + return ownerId; + } + + /** + * @return Whether the contact has had an email sent to them hard bounce. + */ + @JsonProperty("has_hard_bounced") + public boolean getHasHardBounced() { + return hasHardBounced; + } + + /** + * @return Whether the contact has marked an email sent to them as spam. + */ + @JsonProperty("marked_email_as_spam") + public boolean getMarkedEmailAsSpam() { + return markedEmailAsSpam; + } + + /** + * @return Whether the contact is unsubscribed from emails. + */ + @JsonProperty("unsubscribed_from_emails") + public boolean getUnsubscribedFromEmails() { + return unsubscribedFromEmails; + } + + /** + * @return (UNIX timestamp) The time when the contact was created. + */ + @JsonProperty("created_at") + public int getCreatedAt() { + return createdAt; + } + + /** + * @return (UNIX timestamp) The time when the contact was last updated. + */ + @JsonProperty("updated_at") + public int getUpdatedAt() { + return updatedAt; + } + + /** + * @return (UNIX timestamp) The time specified for when a contact signed up. + */ + @JsonProperty("signed_up_at") + public Optional getSignedUpAt() { + return signedUpAt; + } + + /** + * @return (UNIX timestamp) The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually). + */ + @JsonProperty("last_seen_at") + public Optional getLastSeenAt() { + return lastSeenAt; + } + + /** + * @return (UNIX timestamp) The time when the contact last messaged in. + */ + @JsonProperty("last_replied_at") + public Optional getLastRepliedAt() { + return lastRepliedAt; + } + + /** + * @return (UNIX timestamp) The time when the contact was last messaged. + */ + @JsonProperty("last_contacted_at") + public Optional getLastContactedAt() { + return lastContactedAt; + } + + /** + * @return (UNIX timestamp) The time when the contact last opened an email. + */ + @JsonProperty("last_email_opened_at") + public Optional getLastEmailOpenedAt() { + return lastEmailOpenedAt; + } + + /** + * @return (UNIX timestamp) The time when the contact last clicked a link in an email. + */ + @JsonProperty("last_email_clicked_at") + public Optional getLastEmailClickedAt() { + return lastEmailClickedAt; + } + + /** + * @return A preferred language setting for the contact, used by the Intercom Messenger even if their browser settings change. + */ + @JsonProperty("language_override") + public Optional getLanguageOverride() { + return languageOverride; + } + + /** + * @return The name of the browser which the contact is using. + */ + @JsonProperty("browser") + public Optional getBrowser() { + return browser; + } + + /** + * @return The version of the browser which the contact is using. + */ + @JsonProperty("browser_version") + public Optional getBrowserVersion() { + return browserVersion; + } + + /** + * @return The language set by the browser which the contact is using. + */ + @JsonProperty("browser_language") + public Optional getBrowserLanguage() { + return browserLanguage; + } + + /** + * @return The operating system which the contact is using. + */ + @JsonProperty("os") + public Optional getOs() { + return os; + } + + /** + * @return The name of the Android app which the contact is using. + */ + @JsonProperty("android_app_name") + public Optional getAndroidAppName() { + return androidAppName; + } + + /** + * @return The version of the Android app which the contact is using. + */ + @JsonProperty("android_app_version") + public Optional getAndroidAppVersion() { + return androidAppVersion; + } + + /** + * @return The Android device which the contact is using. + */ + @JsonProperty("android_device") + public Optional getAndroidDevice() { + return androidDevice; + } + + /** + * @return The version of the Android OS which the contact is using. + */ + @JsonProperty("android_os_version") + public Optional getAndroidOsVersion() { + return androidOsVersion; + } + + /** + * @return The version of the Android SDK which the contact is using. + */ + @JsonProperty("android_sdk_version") + public Optional getAndroidSdkVersion() { + return androidSdkVersion; + } + + /** + * @return (UNIX timestamp) The time when the contact was last seen on an Android device. + */ + @JsonProperty("android_last_seen_at") + public Optional getAndroidLastSeenAt() { + return androidLastSeenAt; + } + + /** + * @return The name of the iOS app which the contact is using. + */ + @JsonProperty("ios_app_name") + public Optional getIosAppName() { + return iosAppName; + } + + /** + * @return The version of the iOS app which the contact is using. + */ + @JsonProperty("ios_app_version") + public Optional getIosAppVersion() { + return iosAppVersion; + } + + /** + * @return The iOS device which the contact is using. + */ + @JsonProperty("ios_device") + public Optional getIosDevice() { + return iosDevice; + } + + /** + * @return The version of iOS which the contact is using. + */ + @JsonProperty("ios_os_version") + public Optional getIosOsVersion() { + return iosOsVersion; + } + + /** + * @return The version of the iOS SDK which the contact is using. + */ + @JsonProperty("ios_sdk_version") + public Optional getIosSdkVersion() { + return iosSdkVersion; + } + + /** + * @return (UNIX timestamp) The last time the contact used the iOS app. + */ + @JsonProperty("ios_last_seen_at") + public Optional getIosLastSeenAt() { + return iosLastSeenAt; + } + + /** + * @return The custom attributes which are set for the contact. + */ + @JsonProperty("custom_attributes") + public Optional> getCustomAttributes() { + return customAttributes; + } + + /** + * @return An image URL containing the avatar of a contact. + */ + @JsonProperty("avatar") + public Optional getAvatar() { + return avatar; + } + + @JsonProperty("tags") + public Optional getTags() { + return tags; + } + + @JsonProperty("notes") + public Optional getNotes() { + return notes; + } + + @JsonProperty("companies") + public Optional getCompanies() { + return companies; + } + + @JsonProperty("location") + public Optional getLocation() { + return location; + } + + @JsonProperty("social_profiles") + public Optional getSocialProfiles() { + return socialProfiles; + } + + /** + * @return If the user has enabled push messaging. + */ + @JsonProperty("enabled_push_messaging") + public Optional getEnabledPushMessaging() { + return enabledPushMessaging; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof ContactsFindResponse && equalTo((ContactsFindResponse) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(ContactsFindResponse other) { + return id.equals(other.id) + && externalId.equals(other.externalId) + && workspaceId.equals(other.workspaceId) + && role.equals(other.role) + && email.equals(other.email) + && emailDomain.equals(other.emailDomain) + && phone.equals(other.phone) + && name.equals(other.name) + && ownerId.equals(other.ownerId) + && hasHardBounced == other.hasHardBounced + && markedEmailAsSpam == other.markedEmailAsSpam + && unsubscribedFromEmails == other.unsubscribedFromEmails + && createdAt == other.createdAt + && updatedAt == other.updatedAt + && signedUpAt.equals(other.signedUpAt) + && lastSeenAt.equals(other.lastSeenAt) + && lastRepliedAt.equals(other.lastRepliedAt) + && lastContactedAt.equals(other.lastContactedAt) + && lastEmailOpenedAt.equals(other.lastEmailOpenedAt) + && lastEmailClickedAt.equals(other.lastEmailClickedAt) + && languageOverride.equals(other.languageOverride) + && browser.equals(other.browser) + && browserVersion.equals(other.browserVersion) + && browserLanguage.equals(other.browserLanguage) + && os.equals(other.os) + && androidAppName.equals(other.androidAppName) + && androidAppVersion.equals(other.androidAppVersion) + && androidDevice.equals(other.androidDevice) + && androidOsVersion.equals(other.androidOsVersion) + && androidSdkVersion.equals(other.androidSdkVersion) + && androidLastSeenAt.equals(other.androidLastSeenAt) + && iosAppName.equals(other.iosAppName) + && iosAppVersion.equals(other.iosAppVersion) + && iosDevice.equals(other.iosDevice) + && iosOsVersion.equals(other.iosOsVersion) + && iosSdkVersion.equals(other.iosSdkVersion) + && iosLastSeenAt.equals(other.iosLastSeenAt) + && customAttributes.equals(other.customAttributes) + && avatar.equals(other.avatar) + && tags.equals(other.tags) + && notes.equals(other.notes) + && companies.equals(other.companies) + && location.equals(other.location) + && socialProfiles.equals(other.socialProfiles) + && enabledPushMessaging.equals(other.enabledPushMessaging); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash( + this.id, + this.externalId, + this.workspaceId, + this.role, + this.email, + this.emailDomain, + this.phone, + this.name, + this.ownerId, + this.hasHardBounced, + this.markedEmailAsSpam, + this.unsubscribedFromEmails, + this.createdAt, + this.updatedAt, + this.signedUpAt, + this.lastSeenAt, + this.lastRepliedAt, + this.lastContactedAt, + this.lastEmailOpenedAt, + this.lastEmailClickedAt, + this.languageOverride, + this.browser, + this.browserVersion, + this.browserLanguage, + this.os, + this.androidAppName, + this.androidAppVersion, + this.androidDevice, + this.androidOsVersion, + this.androidSdkVersion, + this.androidLastSeenAt, + this.iosAppName, + this.iosAppVersion, + this.iosDevice, + this.iosOsVersion, + this.iosSdkVersion, + this.iosLastSeenAt, + this.customAttributes, + this.avatar, + this.tags, + this.notes, + this.companies, + this.location, + this.socialProfiles, + this.enabledPushMessaging); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static IdStage builder() { + return new Builder(); + } + + public interface IdStage { + /** + *

The unique identifier for the contact which is given by Intercom.

+ */ + WorkspaceIdStage id(@NotNull String id); + + Builder from(ContactsFindResponse other); + } + + public interface WorkspaceIdStage { + /** + *

The id of the workspace which the contact belongs to.

+ */ + RoleStage workspaceId(@NotNull String workspaceId); + } + + public interface RoleStage { + /** + *

The role of the contact.

+ */ + HasHardBouncedStage role(@NotNull String role); + } + + public interface HasHardBouncedStage { + /** + *

Whether the contact has had an email sent to them hard bounce.

+ */ + MarkedEmailAsSpamStage hasHardBounced(boolean hasHardBounced); + } + + public interface MarkedEmailAsSpamStage { + /** + *

Whether the contact has marked an email sent to them as spam.

+ */ + UnsubscribedFromEmailsStage markedEmailAsSpam(boolean markedEmailAsSpam); + } + + public interface UnsubscribedFromEmailsStage { + /** + *

Whether the contact is unsubscribed from emails.

+ */ + CreatedAtStage unsubscribedFromEmails(boolean unsubscribedFromEmails); + } + + public interface CreatedAtStage { + /** + *

(UNIX timestamp) The time when the contact was created.

+ */ + UpdatedAtStage createdAt(int createdAt); + } + + public interface UpdatedAtStage { + /** + *

(UNIX timestamp) The time when the contact was last updated.

+ */ + _FinalStage updatedAt(int updatedAt); + } + + public interface _FinalStage { + ContactsFindResponse build(); + + /** + *

The unique identifier for the contact which is provided by the Client.

+ */ + _FinalStage externalId(Optional externalId); + + _FinalStage externalId(String externalId); + + /** + *

The contact's email.

+ */ + _FinalStage email(Optional email); + + _FinalStage email(String email); + + /** + *

The contact's email domain.

+ */ + _FinalStage emailDomain(Optional emailDomain); + + _FinalStage emailDomain(String emailDomain); + + /** + *

The contacts phone.

+ */ + _FinalStage phone(Optional phone); + + _FinalStage phone(String phone); + + /** + *

The contacts name.

+ */ + _FinalStage name(Optional name); + + _FinalStage name(String name); + + /** + *

The id of an admin that has been assigned account ownership of the contact.

+ */ + _FinalStage ownerId(Optional ownerId); + + _FinalStage ownerId(Integer ownerId); + + /** + *

(UNIX timestamp) The time specified for when a contact signed up.

+ */ + _FinalStage signedUpAt(Optional signedUpAt); + + _FinalStage signedUpAt(Integer signedUpAt); + + /** + *

(UNIX timestamp) The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually).

+ */ + _FinalStage lastSeenAt(Optional lastSeenAt); + + _FinalStage lastSeenAt(Integer lastSeenAt); + + /** + *

(UNIX timestamp) The time when the contact last messaged in.

+ */ + _FinalStage lastRepliedAt(Optional lastRepliedAt); + + _FinalStage lastRepliedAt(Integer lastRepliedAt); + + /** + *

(UNIX timestamp) The time when the contact was last messaged.

+ */ + _FinalStage lastContactedAt(Optional lastContactedAt); + + _FinalStage lastContactedAt(Integer lastContactedAt); + + /** + *

(UNIX timestamp) The time when the contact last opened an email.

+ */ + _FinalStage lastEmailOpenedAt(Optional lastEmailOpenedAt); + + _FinalStage lastEmailOpenedAt(Integer lastEmailOpenedAt); + + /** + *

(UNIX timestamp) The time when the contact last clicked a link in an email.

+ */ + _FinalStage lastEmailClickedAt(Optional lastEmailClickedAt); + + _FinalStage lastEmailClickedAt(Integer lastEmailClickedAt); + + /** + *

A preferred language setting for the contact, used by the Intercom Messenger even if their browser settings change.

+ */ + _FinalStage languageOverride(Optional languageOverride); + + _FinalStage languageOverride(String languageOverride); + + /** + *

The name of the browser which the contact is using.

+ */ + _FinalStage browser(Optional browser); + + _FinalStage browser(String browser); + + /** + *

The version of the browser which the contact is using.

+ */ + _FinalStage browserVersion(Optional browserVersion); + + _FinalStage browserVersion(String browserVersion); + + /** + *

The language set by the browser which the contact is using.

+ */ + _FinalStage browserLanguage(Optional browserLanguage); + + _FinalStage browserLanguage(String browserLanguage); + + /** + *

The operating system which the contact is using.

+ */ + _FinalStage os(Optional os); + + _FinalStage os(String os); + + /** + *

The name of the Android app which the contact is using.

+ */ + _FinalStage androidAppName(Optional androidAppName); + + _FinalStage androidAppName(String androidAppName); + + /** + *

The version of the Android app which the contact is using.

+ */ + _FinalStage androidAppVersion(Optional androidAppVersion); + + _FinalStage androidAppVersion(String androidAppVersion); + + /** + *

The Android device which the contact is using.

+ */ + _FinalStage androidDevice(Optional androidDevice); + + _FinalStage androidDevice(String androidDevice); + + /** + *

The version of the Android OS which the contact is using.

+ */ + _FinalStage androidOsVersion(Optional androidOsVersion); + + _FinalStage androidOsVersion(String androidOsVersion); + + /** + *

The version of the Android SDK which the contact is using.

+ */ + _FinalStage androidSdkVersion(Optional androidSdkVersion); + + _FinalStage androidSdkVersion(String androidSdkVersion); + + /** + *

(UNIX timestamp) The time when the contact was last seen on an Android device.

+ */ + _FinalStage androidLastSeenAt(Optional androidLastSeenAt); + + _FinalStage androidLastSeenAt(Integer androidLastSeenAt); + + /** + *

The name of the iOS app which the contact is using.

+ */ + _FinalStage iosAppName(Optional iosAppName); + + _FinalStage iosAppName(String iosAppName); + + /** + *

The version of the iOS app which the contact is using.

+ */ + _FinalStage iosAppVersion(Optional iosAppVersion); + + _FinalStage iosAppVersion(String iosAppVersion); + + /** + *

The iOS device which the contact is using.

+ */ + _FinalStage iosDevice(Optional iosDevice); + + _FinalStage iosDevice(String iosDevice); + + /** + *

The version of iOS which the contact is using.

+ */ + _FinalStage iosOsVersion(Optional iosOsVersion); + + _FinalStage iosOsVersion(String iosOsVersion); + + /** + *

The version of the iOS SDK which the contact is using.

+ */ + _FinalStage iosSdkVersion(Optional iosSdkVersion); + + _FinalStage iosSdkVersion(String iosSdkVersion); + + /** + *

(UNIX timestamp) The last time the contact used the iOS app.

+ */ + _FinalStage iosLastSeenAt(Optional iosLastSeenAt); + + _FinalStage iosLastSeenAt(Integer iosLastSeenAt); + + /** + *

The custom attributes which are set for the contact.

+ */ + _FinalStage customAttributes(Optional> customAttributes); + + _FinalStage customAttributes(Map customAttributes); + + /** + *

An image URL containing the avatar of a contact.

+ */ + _FinalStage avatar(Optional avatar); + + _FinalStage avatar(String avatar); + + _FinalStage tags(Optional tags); + + _FinalStage tags(ContactTags tags); + + _FinalStage notes(Optional notes); + + _FinalStage notes(ContactNotes notes); + + _FinalStage companies(Optional companies); + + _FinalStage companies(ContactCompanies companies); + + _FinalStage location(Optional location); + + _FinalStage location(ContactLocation location); + + _FinalStage socialProfiles(Optional socialProfiles); + + _FinalStage socialProfiles(ContactSocialProfiles socialProfiles); + + /** + *

If the user has enabled push messaging.

+ */ + _FinalStage enabledPushMessaging(Optional enabledPushMessaging); + + _FinalStage enabledPushMessaging(Boolean enabledPushMessaging); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder + implements IdStage, + WorkspaceIdStage, + RoleStage, + HasHardBouncedStage, + MarkedEmailAsSpamStage, + UnsubscribedFromEmailsStage, + CreatedAtStage, + UpdatedAtStage, + _FinalStage { + private String id; + + private String workspaceId; + + private String role; + + private boolean hasHardBounced; + + private boolean markedEmailAsSpam; + + private boolean unsubscribedFromEmails; + + private int createdAt; + + private int updatedAt; + + private Optional enabledPushMessaging = Optional.empty(); + + private Optional socialProfiles = Optional.empty(); + + private Optional location = Optional.empty(); + + private Optional companies = Optional.empty(); + + private Optional notes = Optional.empty(); + + private Optional tags = Optional.empty(); + + private Optional avatar = Optional.empty(); + + private Optional> customAttributes = Optional.empty(); + + private Optional iosLastSeenAt = Optional.empty(); + + private Optional iosSdkVersion = Optional.empty(); + + private Optional iosOsVersion = Optional.empty(); + + private Optional iosDevice = Optional.empty(); + + private Optional iosAppVersion = Optional.empty(); + + private Optional iosAppName = Optional.empty(); + + private Optional androidLastSeenAt = Optional.empty(); + + private Optional androidSdkVersion = Optional.empty(); + + private Optional androidOsVersion = Optional.empty(); + + private Optional androidDevice = Optional.empty(); + + private Optional androidAppVersion = Optional.empty(); + + private Optional androidAppName = Optional.empty(); + + private Optional os = Optional.empty(); + + private Optional browserLanguage = Optional.empty(); + + private Optional browserVersion = Optional.empty(); + + private Optional browser = Optional.empty(); + + private Optional languageOverride = Optional.empty(); + + private Optional lastEmailClickedAt = Optional.empty(); + + private Optional lastEmailOpenedAt = Optional.empty(); + + private Optional lastContactedAt = Optional.empty(); + + private Optional lastRepliedAt = Optional.empty(); + + private Optional lastSeenAt = Optional.empty(); + + private Optional signedUpAt = Optional.empty(); + + private Optional ownerId = Optional.empty(); + + private Optional name = Optional.empty(); + + private Optional phone = Optional.empty(); + + private Optional emailDomain = Optional.empty(); + + private Optional email = Optional.empty(); + + private Optional externalId = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(ContactsFindResponse other) { + id(other.getId()); + externalId(other.getExternalId()); + workspaceId(other.getWorkspaceId()); + role(other.getRole()); + email(other.getEmail()); + emailDomain(other.getEmailDomain()); + phone(other.getPhone()); + name(other.getName()); + ownerId(other.getOwnerId()); + hasHardBounced(other.getHasHardBounced()); + markedEmailAsSpam(other.getMarkedEmailAsSpam()); + unsubscribedFromEmails(other.getUnsubscribedFromEmails()); + createdAt(other.getCreatedAt()); + updatedAt(other.getUpdatedAt()); + signedUpAt(other.getSignedUpAt()); + lastSeenAt(other.getLastSeenAt()); + lastRepliedAt(other.getLastRepliedAt()); + lastContactedAt(other.getLastContactedAt()); + lastEmailOpenedAt(other.getLastEmailOpenedAt()); + lastEmailClickedAt(other.getLastEmailClickedAt()); + languageOverride(other.getLanguageOverride()); + browser(other.getBrowser()); + browserVersion(other.getBrowserVersion()); + browserLanguage(other.getBrowserLanguage()); + os(other.getOs()); + androidAppName(other.getAndroidAppName()); + androidAppVersion(other.getAndroidAppVersion()); + androidDevice(other.getAndroidDevice()); + androidOsVersion(other.getAndroidOsVersion()); + androidSdkVersion(other.getAndroidSdkVersion()); + androidLastSeenAt(other.getAndroidLastSeenAt()); + iosAppName(other.getIosAppName()); + iosAppVersion(other.getIosAppVersion()); + iosDevice(other.getIosDevice()); + iosOsVersion(other.getIosOsVersion()); + iosSdkVersion(other.getIosSdkVersion()); + iosLastSeenAt(other.getIosLastSeenAt()); + customAttributes(other.getCustomAttributes()); + avatar(other.getAvatar()); + tags(other.getTags()); + notes(other.getNotes()); + companies(other.getCompanies()); + location(other.getLocation()); + socialProfiles(other.getSocialProfiles()); + enabledPushMessaging(other.getEnabledPushMessaging()); + return this; + } + + /** + *

The unique identifier for the contact which is given by Intercom.

+ *

The unique identifier for the contact which is given by Intercom.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("id") + public WorkspaceIdStage id(@NotNull String id) { + this.id = Objects.requireNonNull(id, "id must not be null"); + return this; + } + + /** + *

The id of the workspace which the contact belongs to.

+ *

The id of the workspace which the contact belongs to.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("workspace_id") + public RoleStage workspaceId(@NotNull String workspaceId) { + this.workspaceId = Objects.requireNonNull(workspaceId, "workspaceId must not be null"); + return this; + } + + /** + *

The role of the contact.

+ *

The role of the contact.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("role") + public HasHardBouncedStage role(@NotNull String role) { + this.role = Objects.requireNonNull(role, "role must not be null"); + return this; + } + + /** + *

Whether the contact has had an email sent to them hard bounce.

+ *

Whether the contact has had an email sent to them hard bounce.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("has_hard_bounced") + public MarkedEmailAsSpamStage hasHardBounced(boolean hasHardBounced) { + this.hasHardBounced = hasHardBounced; + return this; + } + + /** + *

Whether the contact has marked an email sent to them as spam.

+ *

Whether the contact has marked an email sent to them as spam.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("marked_email_as_spam") + public UnsubscribedFromEmailsStage markedEmailAsSpam(boolean markedEmailAsSpam) { + this.markedEmailAsSpam = markedEmailAsSpam; + return this; + } + + /** + *

Whether the contact is unsubscribed from emails.

+ *

Whether the contact is unsubscribed from emails.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("unsubscribed_from_emails") + public CreatedAtStage unsubscribedFromEmails(boolean unsubscribedFromEmails) { + this.unsubscribedFromEmails = unsubscribedFromEmails; + return this; + } + + /** + *

(UNIX timestamp) The time when the contact was created.

+ *

(UNIX timestamp) The time when the contact was created.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("created_at") + public UpdatedAtStage createdAt(int createdAt) { + this.createdAt = createdAt; + return this; + } + + /** + *

(UNIX timestamp) The time when the contact was last updated.

+ *

(UNIX timestamp) The time when the contact was last updated.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("updated_at") + public _FinalStage updatedAt(int updatedAt) { + this.updatedAt = updatedAt; + return this; + } + + /** + *

If the user has enabled push messaging.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage enabledPushMessaging(Boolean enabledPushMessaging) { + this.enabledPushMessaging = Optional.ofNullable(enabledPushMessaging); + return this; + } + + /** + *

If the user has enabled push messaging.

+ */ + @java.lang.Override + @JsonSetter(value = "enabled_push_messaging", nulls = Nulls.SKIP) + public _FinalStage enabledPushMessaging(Optional enabledPushMessaging) { + this.enabledPushMessaging = enabledPushMessaging; + return this; + } + + @java.lang.Override + public _FinalStage socialProfiles(ContactSocialProfiles socialProfiles) { + this.socialProfiles = Optional.ofNullable(socialProfiles); + return this; + } + + @java.lang.Override + @JsonSetter(value = "social_profiles", nulls = Nulls.SKIP) + public _FinalStage socialProfiles(Optional socialProfiles) { + this.socialProfiles = socialProfiles; + return this; + } + + @java.lang.Override + public _FinalStage location(ContactLocation location) { + this.location = Optional.ofNullable(location); + return this; + } + + @java.lang.Override + @JsonSetter(value = "location", nulls = Nulls.SKIP) + public _FinalStage location(Optional location) { + this.location = location; + return this; + } + + @java.lang.Override + public _FinalStage companies(ContactCompanies companies) { + this.companies = Optional.ofNullable(companies); + return this; + } + + @java.lang.Override + @JsonSetter(value = "companies", nulls = Nulls.SKIP) + public _FinalStage companies(Optional companies) { + this.companies = companies; + return this; + } + + @java.lang.Override + public _FinalStage notes(ContactNotes notes) { + this.notes = Optional.ofNullable(notes); + return this; + } + + @java.lang.Override + @JsonSetter(value = "notes", nulls = Nulls.SKIP) + public _FinalStage notes(Optional notes) { + this.notes = notes; + return this; + } + + @java.lang.Override + public _FinalStage tags(ContactTags tags) { + this.tags = Optional.ofNullable(tags); + return this; + } + + @java.lang.Override + @JsonSetter(value = "tags", nulls = Nulls.SKIP) + public _FinalStage tags(Optional tags) { + this.tags = tags; + return this; + } + + /** + *

An image URL containing the avatar of a contact.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage avatar(String avatar) { + this.avatar = Optional.ofNullable(avatar); + return this; + } + + /** + *

An image URL containing the avatar of a contact.

+ */ + @java.lang.Override + @JsonSetter(value = "avatar", nulls = Nulls.SKIP) + public _FinalStage avatar(Optional avatar) { + this.avatar = avatar; + return this; + } + + /** + *

The custom attributes which are set for the contact.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage customAttributes(Map customAttributes) { + this.customAttributes = Optional.ofNullable(customAttributes); + return this; + } + + /** + *

The custom attributes which are set for the contact.

+ */ + @java.lang.Override + @JsonSetter(value = "custom_attributes", nulls = Nulls.SKIP) + public _FinalStage customAttributes(Optional> customAttributes) { + this.customAttributes = customAttributes; + return this; + } + + /** + *

(UNIX timestamp) The last time the contact used the iOS app.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage iosLastSeenAt(Integer iosLastSeenAt) { + this.iosLastSeenAt = Optional.ofNullable(iosLastSeenAt); + return this; + } + + /** + *

(UNIX timestamp) The last time the contact used the iOS app.

+ */ + @java.lang.Override + @JsonSetter(value = "ios_last_seen_at", nulls = Nulls.SKIP) + public _FinalStage iosLastSeenAt(Optional iosLastSeenAt) { + this.iosLastSeenAt = iosLastSeenAt; + return this; + } + + /** + *

The version of the iOS SDK which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage iosSdkVersion(String iosSdkVersion) { + this.iosSdkVersion = Optional.ofNullable(iosSdkVersion); + return this; + } + + /** + *

The version of the iOS SDK which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "ios_sdk_version", nulls = Nulls.SKIP) + public _FinalStage iosSdkVersion(Optional iosSdkVersion) { + this.iosSdkVersion = iosSdkVersion; + return this; + } + + /** + *

The version of iOS which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage iosOsVersion(String iosOsVersion) { + this.iosOsVersion = Optional.ofNullable(iosOsVersion); + return this; + } + + /** + *

The version of iOS which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "ios_os_version", nulls = Nulls.SKIP) + public _FinalStage iosOsVersion(Optional iosOsVersion) { + this.iosOsVersion = iosOsVersion; + return this; + } + + /** + *

The iOS device which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage iosDevice(String iosDevice) { + this.iosDevice = Optional.ofNullable(iosDevice); + return this; + } + + /** + *

The iOS device which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "ios_device", nulls = Nulls.SKIP) + public _FinalStage iosDevice(Optional iosDevice) { + this.iosDevice = iosDevice; + return this; + } + + /** + *

The version of the iOS app which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage iosAppVersion(String iosAppVersion) { + this.iosAppVersion = Optional.ofNullable(iosAppVersion); + return this; + } + + /** + *

The version of the iOS app which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "ios_app_version", nulls = Nulls.SKIP) + public _FinalStage iosAppVersion(Optional iosAppVersion) { + this.iosAppVersion = iosAppVersion; + return this; + } + + /** + *

The name of the iOS app which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage iosAppName(String iosAppName) { + this.iosAppName = Optional.ofNullable(iosAppName); + return this; + } + + /** + *

The name of the iOS app which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "ios_app_name", nulls = Nulls.SKIP) + public _FinalStage iosAppName(Optional iosAppName) { + this.iosAppName = iosAppName; + return this; + } + + /** + *

(UNIX timestamp) The time when the contact was last seen on an Android device.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage androidLastSeenAt(Integer androidLastSeenAt) { + this.androidLastSeenAt = Optional.ofNullable(androidLastSeenAt); + return this; + } + + /** + *

(UNIX timestamp) The time when the contact was last seen on an Android device.

+ */ + @java.lang.Override + @JsonSetter(value = "android_last_seen_at", nulls = Nulls.SKIP) + public _FinalStage androidLastSeenAt(Optional androidLastSeenAt) { + this.androidLastSeenAt = androidLastSeenAt; + return this; + } + + /** + *

The version of the Android SDK which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage androidSdkVersion(String androidSdkVersion) { + this.androidSdkVersion = Optional.ofNullable(androidSdkVersion); + return this; + } + + /** + *

The version of the Android SDK which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "android_sdk_version", nulls = Nulls.SKIP) + public _FinalStage androidSdkVersion(Optional androidSdkVersion) { + this.androidSdkVersion = androidSdkVersion; + return this; + } + + /** + *

The version of the Android OS which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage androidOsVersion(String androidOsVersion) { + this.androidOsVersion = Optional.ofNullable(androidOsVersion); + return this; + } + + /** + *

The version of the Android OS which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "android_os_version", nulls = Nulls.SKIP) + public _FinalStage androidOsVersion(Optional androidOsVersion) { + this.androidOsVersion = androidOsVersion; + return this; + } + + /** + *

The Android device which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage androidDevice(String androidDevice) { + this.androidDevice = Optional.ofNullable(androidDevice); + return this; + } + + /** + *

The Android device which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "android_device", nulls = Nulls.SKIP) + public _FinalStage androidDevice(Optional androidDevice) { + this.androidDevice = androidDevice; + return this; + } + + /** + *

The version of the Android app which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage androidAppVersion(String androidAppVersion) { + this.androidAppVersion = Optional.ofNullable(androidAppVersion); + return this; + } + + /** + *

The version of the Android app which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "android_app_version", nulls = Nulls.SKIP) + public _FinalStage androidAppVersion(Optional androidAppVersion) { + this.androidAppVersion = androidAppVersion; + return this; + } + + /** + *

The name of the Android app which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage androidAppName(String androidAppName) { + this.androidAppName = Optional.ofNullable(androidAppName); + return this; + } + + /** + *

The name of the Android app which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "android_app_name", nulls = Nulls.SKIP) + public _FinalStage androidAppName(Optional androidAppName) { + this.androidAppName = androidAppName; + return this; + } + + /** + *

The operating system which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage os(String os) { + this.os = Optional.ofNullable(os); + return this; + } + + /** + *

The operating system which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "os", nulls = Nulls.SKIP) + public _FinalStage os(Optional os) { + this.os = os; + return this; + } + + /** + *

The language set by the browser which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage browserLanguage(String browserLanguage) { + this.browserLanguage = Optional.ofNullable(browserLanguage); + return this; + } + + /** + *

The language set by the browser which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "browser_language", nulls = Nulls.SKIP) + public _FinalStage browserLanguage(Optional browserLanguage) { + this.browserLanguage = browserLanguage; + return this; + } + + /** + *

The version of the browser which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage browserVersion(String browserVersion) { + this.browserVersion = Optional.ofNullable(browserVersion); + return this; + } + + /** + *

The version of the browser which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "browser_version", nulls = Nulls.SKIP) + public _FinalStage browserVersion(Optional browserVersion) { + this.browserVersion = browserVersion; + return this; + } + + /** + *

The name of the browser which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage browser(String browser) { + this.browser = Optional.ofNullable(browser); + return this; + } + + /** + *

The name of the browser which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "browser", nulls = Nulls.SKIP) + public _FinalStage browser(Optional browser) { + this.browser = browser; + return this; + } + + /** + *

A preferred language setting for the contact, used by the Intercom Messenger even if their browser settings change.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage languageOverride(String languageOverride) { + this.languageOverride = Optional.ofNullable(languageOverride); + return this; + } + + /** + *

A preferred language setting for the contact, used by the Intercom Messenger even if their browser settings change.

+ */ + @java.lang.Override + @JsonSetter(value = "language_override", nulls = Nulls.SKIP) + public _FinalStage languageOverride(Optional languageOverride) { + this.languageOverride = languageOverride; + return this; + } + + /** + *

(UNIX timestamp) The time when the contact last clicked a link in an email.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage lastEmailClickedAt(Integer lastEmailClickedAt) { + this.lastEmailClickedAt = Optional.ofNullable(lastEmailClickedAt); + return this; + } + + /** + *

(UNIX timestamp) The time when the contact last clicked a link in an email.

+ */ + @java.lang.Override + @JsonSetter(value = "last_email_clicked_at", nulls = Nulls.SKIP) + public _FinalStage lastEmailClickedAt(Optional lastEmailClickedAt) { + this.lastEmailClickedAt = lastEmailClickedAt; + return this; + } + + /** + *

(UNIX timestamp) The time when the contact last opened an email.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage lastEmailOpenedAt(Integer lastEmailOpenedAt) { + this.lastEmailOpenedAt = Optional.ofNullable(lastEmailOpenedAt); + return this; + } + + /** + *

(UNIX timestamp) The time when the contact last opened an email.

+ */ + @java.lang.Override + @JsonSetter(value = "last_email_opened_at", nulls = Nulls.SKIP) + public _FinalStage lastEmailOpenedAt(Optional lastEmailOpenedAt) { + this.lastEmailOpenedAt = lastEmailOpenedAt; + return this; + } + + /** + *

(UNIX timestamp) The time when the contact was last messaged.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage lastContactedAt(Integer lastContactedAt) { + this.lastContactedAt = Optional.ofNullable(lastContactedAt); + return this; + } + + /** + *

(UNIX timestamp) The time when the contact was last messaged.

+ */ + @java.lang.Override + @JsonSetter(value = "last_contacted_at", nulls = Nulls.SKIP) + public _FinalStage lastContactedAt(Optional lastContactedAt) { + this.lastContactedAt = lastContactedAt; + return this; + } + + /** + *

(UNIX timestamp) The time when the contact last messaged in.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage lastRepliedAt(Integer lastRepliedAt) { + this.lastRepliedAt = Optional.ofNullable(lastRepliedAt); + return this; + } + + /** + *

(UNIX timestamp) The time when the contact last messaged in.

+ */ + @java.lang.Override + @JsonSetter(value = "last_replied_at", nulls = Nulls.SKIP) + public _FinalStage lastRepliedAt(Optional lastRepliedAt) { + this.lastRepliedAt = lastRepliedAt; + return this; + } + + /** + *

(UNIX timestamp) The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually).

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage lastSeenAt(Integer lastSeenAt) { + this.lastSeenAt = Optional.ofNullable(lastSeenAt); + return this; + } + + /** + *

(UNIX timestamp) The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually).

+ */ + @java.lang.Override + @JsonSetter(value = "last_seen_at", nulls = Nulls.SKIP) + public _FinalStage lastSeenAt(Optional lastSeenAt) { + this.lastSeenAt = lastSeenAt; + return this; + } + + /** + *

(UNIX timestamp) The time specified for when a contact signed up.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage signedUpAt(Integer signedUpAt) { + this.signedUpAt = Optional.ofNullable(signedUpAt); + return this; + } + + /** + *

(UNIX timestamp) The time specified for when a contact signed up.

+ */ + @java.lang.Override + @JsonSetter(value = "signed_up_at", nulls = Nulls.SKIP) + public _FinalStage signedUpAt(Optional signedUpAt) { + this.signedUpAt = signedUpAt; + return this; + } + + /** + *

The id of an admin that has been assigned account ownership of the contact.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage ownerId(Integer ownerId) { + this.ownerId = Optional.ofNullable(ownerId); + return this; + } + + /** + *

The id of an admin that has been assigned account ownership of the contact.

+ */ + @java.lang.Override + @JsonSetter(value = "owner_id", nulls = Nulls.SKIP) + public _FinalStage ownerId(Optional ownerId) { + this.ownerId = ownerId; + return this; + } + + /** + *

The contacts name.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage name(String name) { + this.name = Optional.ofNullable(name); + return this; + } + + /** + *

The contacts name.

+ */ + @java.lang.Override + @JsonSetter(value = "name", nulls = Nulls.SKIP) + public _FinalStage name(Optional name) { + this.name = name; + return this; + } + + /** + *

The contacts phone.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage phone(String phone) { + this.phone = Optional.ofNullable(phone); + return this; + } + + /** + *

The contacts phone.

+ */ + @java.lang.Override + @JsonSetter(value = "phone", nulls = Nulls.SKIP) + public _FinalStage phone(Optional phone) { + this.phone = phone; + return this; + } + + /** + *

The contact's email domain.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage emailDomain(String emailDomain) { + this.emailDomain = Optional.ofNullable(emailDomain); + return this; + } + + /** + *

The contact's email domain.

+ */ + @java.lang.Override + @JsonSetter(value = "email_domain", nulls = Nulls.SKIP) + public _FinalStage emailDomain(Optional emailDomain) { + this.emailDomain = emailDomain; + return this; + } + + /** + *

The contact's email.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage email(String email) { + this.email = Optional.ofNullable(email); + return this; + } + + /** + *

The contact's email.

+ */ + @java.lang.Override + @JsonSetter(value = "email", nulls = Nulls.SKIP) + public _FinalStage email(Optional email) { + this.email = email; + return this; + } + + /** + *

The unique identifier for the contact which is provided by the Client.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage externalId(String externalId) { + this.externalId = Optional.ofNullable(externalId); + return this; + } + + /** + *

The unique identifier for the contact which is provided by the Client.

+ */ + @java.lang.Override + @JsonSetter(value = "external_id", nulls = Nulls.SKIP) + public _FinalStage externalId(Optional externalId) { + this.externalId = externalId; + return this; + } + + @java.lang.Override + public ContactsFindResponse build() { + return new ContactsFindResponse( + id, + externalId, + workspaceId, + role, + email, + emailDomain, + phone, + name, + ownerId, + hasHardBounced, + markedEmailAsSpam, + unsubscribedFromEmails, + createdAt, + updatedAt, + signedUpAt, + lastSeenAt, + lastRepliedAt, + lastContactedAt, + lastEmailOpenedAt, + lastEmailClickedAt, + languageOverride, + browser, + browserVersion, + browserLanguage, + os, + androidAppName, + androidAppVersion, + androidDevice, + androidOsVersion, + androidSdkVersion, + androidLastSeenAt, + iosAppName, + iosAppVersion, + iosDevice, + iosOsVersion, + iosSdkVersion, + iosLastSeenAt, + customAttributes, + avatar, + tags, + notes, + companies, + location, + socialProfiles, + enabledPushMessaging, + additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/contacts/types/ContactsMergeLeadInUserResponse.java b/src/main/java/com/intercom/api/resources/contacts/types/ContactsMergeLeadInUserResponse.java new file mode 100644 index 00000000..1fa1a4c1 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/contacts/types/ContactsMergeLeadInUserResponse.java @@ -0,0 +1,2001 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.contacts.types; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.types.ContactCompanies; +import com.intercom.api.types.ContactLocation; +import com.intercom.api.types.ContactNotes; +import com.intercom.api.types.ContactSocialProfiles; +import com.intercom.api.types.ContactTags; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = ContactsMergeLeadInUserResponse.Builder.class) +public final class ContactsMergeLeadInUserResponse implements IContact { + private final String id; + + private final Optional externalId; + + private final String workspaceId; + + private final String role; + + private final Optional email; + + private final Optional emailDomain; + + private final Optional phone; + + private final Optional name; + + private final Optional ownerId; + + private final boolean hasHardBounced; + + private final boolean markedEmailAsSpam; + + private final boolean unsubscribedFromEmails; + + private final int createdAt; + + private final int updatedAt; + + private final Optional signedUpAt; + + private final Optional lastSeenAt; + + private final Optional lastRepliedAt; + + private final Optional lastContactedAt; + + private final Optional lastEmailOpenedAt; + + private final Optional lastEmailClickedAt; + + private final Optional languageOverride; + + private final Optional browser; + + private final Optional browserVersion; + + private final Optional browserLanguage; + + private final Optional os; + + private final Optional androidAppName; + + private final Optional androidAppVersion; + + private final Optional androidDevice; + + private final Optional androidOsVersion; + + private final Optional androidSdkVersion; + + private final Optional androidLastSeenAt; + + private final Optional iosAppName; + + private final Optional iosAppVersion; + + private final Optional iosDevice; + + private final Optional iosOsVersion; + + private final Optional iosSdkVersion; + + private final Optional iosLastSeenAt; + + private final Optional> customAttributes; + + private final Optional avatar; + + private final Optional tags; + + private final Optional notes; + + private final Optional companies; + + private final Optional location; + + private final Optional socialProfiles; + + private final Optional enabledPushMessaging; + + private final Map additionalProperties; + + private ContactsMergeLeadInUserResponse( + String id, + Optional externalId, + String workspaceId, + String role, + Optional email, + Optional emailDomain, + Optional phone, + Optional name, + Optional ownerId, + boolean hasHardBounced, + boolean markedEmailAsSpam, + boolean unsubscribedFromEmails, + int createdAt, + int updatedAt, + Optional signedUpAt, + Optional lastSeenAt, + Optional lastRepliedAt, + Optional lastContactedAt, + Optional lastEmailOpenedAt, + Optional lastEmailClickedAt, + Optional languageOverride, + Optional browser, + Optional browserVersion, + Optional browserLanguage, + Optional os, + Optional androidAppName, + Optional androidAppVersion, + Optional androidDevice, + Optional androidOsVersion, + Optional androidSdkVersion, + Optional androidLastSeenAt, + Optional iosAppName, + Optional iosAppVersion, + Optional iosDevice, + Optional iosOsVersion, + Optional iosSdkVersion, + Optional iosLastSeenAt, + Optional> customAttributes, + Optional avatar, + Optional tags, + Optional notes, + Optional companies, + Optional location, + Optional socialProfiles, + Optional enabledPushMessaging, + Map additionalProperties) { + this.id = id; + this.externalId = externalId; + this.workspaceId = workspaceId; + this.role = role; + this.email = email; + this.emailDomain = emailDomain; + this.phone = phone; + this.name = name; + this.ownerId = ownerId; + this.hasHardBounced = hasHardBounced; + this.markedEmailAsSpam = markedEmailAsSpam; + this.unsubscribedFromEmails = unsubscribedFromEmails; + this.createdAt = createdAt; + this.updatedAt = updatedAt; + this.signedUpAt = signedUpAt; + this.lastSeenAt = lastSeenAt; + this.lastRepliedAt = lastRepliedAt; + this.lastContactedAt = lastContactedAt; + this.lastEmailOpenedAt = lastEmailOpenedAt; + this.lastEmailClickedAt = lastEmailClickedAt; + this.languageOverride = languageOverride; + this.browser = browser; + this.browserVersion = browserVersion; + this.browserLanguage = browserLanguage; + this.os = os; + this.androidAppName = androidAppName; + this.androidAppVersion = androidAppVersion; + this.androidDevice = androidDevice; + this.androidOsVersion = androidOsVersion; + this.androidSdkVersion = androidSdkVersion; + this.androidLastSeenAt = androidLastSeenAt; + this.iosAppName = iosAppName; + this.iosAppVersion = iosAppVersion; + this.iosDevice = iosDevice; + this.iosOsVersion = iosOsVersion; + this.iosSdkVersion = iosSdkVersion; + this.iosLastSeenAt = iosLastSeenAt; + this.customAttributes = customAttributes; + this.avatar = avatar; + this.tags = tags; + this.notes = notes; + this.companies = companies; + this.location = location; + this.socialProfiles = socialProfiles; + this.enabledPushMessaging = enabledPushMessaging; + this.additionalProperties = additionalProperties; + } + + /** + * @return The type of object. + */ + @JsonProperty("type") + public String getType() { + return "contact"; + } + + /** + * @return The unique identifier for the contact which is given by Intercom. + */ + @JsonProperty("id") + public String getId() { + return id; + } + + /** + * @return The unique identifier for the contact which is provided by the Client. + */ + @JsonProperty("external_id") + public Optional getExternalId() { + return externalId; + } + + /** + * @return The id of the workspace which the contact belongs to. + */ + @JsonProperty("workspace_id") + public String getWorkspaceId() { + return workspaceId; + } + + /** + * @return The role of the contact. + */ + @JsonProperty("role") + public String getRole() { + return role; + } + + /** + * @return The contact's email. + */ + @JsonProperty("email") + public Optional getEmail() { + return email; + } + + /** + * @return The contact's email domain. + */ + @JsonProperty("email_domain") + public Optional getEmailDomain() { + return emailDomain; + } + + /** + * @return The contacts phone. + */ + @JsonProperty("phone") + public Optional getPhone() { + return phone; + } + + /** + * @return The contacts name. + */ + @JsonProperty("name") + public Optional getName() { + return name; + } + + /** + * @return The id of an admin that has been assigned account ownership of the contact. + */ + @JsonProperty("owner_id") + public Optional getOwnerId() { + return ownerId; + } + + /** + * @return Whether the contact has had an email sent to them hard bounce. + */ + @JsonProperty("has_hard_bounced") + public boolean getHasHardBounced() { + return hasHardBounced; + } + + /** + * @return Whether the contact has marked an email sent to them as spam. + */ + @JsonProperty("marked_email_as_spam") + public boolean getMarkedEmailAsSpam() { + return markedEmailAsSpam; + } + + /** + * @return Whether the contact is unsubscribed from emails. + */ + @JsonProperty("unsubscribed_from_emails") + public boolean getUnsubscribedFromEmails() { + return unsubscribedFromEmails; + } + + /** + * @return (UNIX timestamp) The time when the contact was created. + */ + @JsonProperty("created_at") + public int getCreatedAt() { + return createdAt; + } + + /** + * @return (UNIX timestamp) The time when the contact was last updated. + */ + @JsonProperty("updated_at") + public int getUpdatedAt() { + return updatedAt; + } + + /** + * @return (UNIX timestamp) The time specified for when a contact signed up. + */ + @JsonProperty("signed_up_at") + public Optional getSignedUpAt() { + return signedUpAt; + } + + /** + * @return (UNIX timestamp) The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually). + */ + @JsonProperty("last_seen_at") + public Optional getLastSeenAt() { + return lastSeenAt; + } + + /** + * @return (UNIX timestamp) The time when the contact last messaged in. + */ + @JsonProperty("last_replied_at") + public Optional getLastRepliedAt() { + return lastRepliedAt; + } + + /** + * @return (UNIX timestamp) The time when the contact was last messaged. + */ + @JsonProperty("last_contacted_at") + public Optional getLastContactedAt() { + return lastContactedAt; + } + + /** + * @return (UNIX timestamp) The time when the contact last opened an email. + */ + @JsonProperty("last_email_opened_at") + public Optional getLastEmailOpenedAt() { + return lastEmailOpenedAt; + } + + /** + * @return (UNIX timestamp) The time when the contact last clicked a link in an email. + */ + @JsonProperty("last_email_clicked_at") + public Optional getLastEmailClickedAt() { + return lastEmailClickedAt; + } + + /** + * @return A preferred language setting for the contact, used by the Intercom Messenger even if their browser settings change. + */ + @JsonProperty("language_override") + public Optional getLanguageOverride() { + return languageOverride; + } + + /** + * @return The name of the browser which the contact is using. + */ + @JsonProperty("browser") + public Optional getBrowser() { + return browser; + } + + /** + * @return The version of the browser which the contact is using. + */ + @JsonProperty("browser_version") + public Optional getBrowserVersion() { + return browserVersion; + } + + /** + * @return The language set by the browser which the contact is using. + */ + @JsonProperty("browser_language") + public Optional getBrowserLanguage() { + return browserLanguage; + } + + /** + * @return The operating system which the contact is using. + */ + @JsonProperty("os") + public Optional getOs() { + return os; + } + + /** + * @return The name of the Android app which the contact is using. + */ + @JsonProperty("android_app_name") + public Optional getAndroidAppName() { + return androidAppName; + } + + /** + * @return The version of the Android app which the contact is using. + */ + @JsonProperty("android_app_version") + public Optional getAndroidAppVersion() { + return androidAppVersion; + } + + /** + * @return The Android device which the contact is using. + */ + @JsonProperty("android_device") + public Optional getAndroidDevice() { + return androidDevice; + } + + /** + * @return The version of the Android OS which the contact is using. + */ + @JsonProperty("android_os_version") + public Optional getAndroidOsVersion() { + return androidOsVersion; + } + + /** + * @return The version of the Android SDK which the contact is using. + */ + @JsonProperty("android_sdk_version") + public Optional getAndroidSdkVersion() { + return androidSdkVersion; + } + + /** + * @return (UNIX timestamp) The time when the contact was last seen on an Android device. + */ + @JsonProperty("android_last_seen_at") + public Optional getAndroidLastSeenAt() { + return androidLastSeenAt; + } + + /** + * @return The name of the iOS app which the contact is using. + */ + @JsonProperty("ios_app_name") + public Optional getIosAppName() { + return iosAppName; + } + + /** + * @return The version of the iOS app which the contact is using. + */ + @JsonProperty("ios_app_version") + public Optional getIosAppVersion() { + return iosAppVersion; + } + + /** + * @return The iOS device which the contact is using. + */ + @JsonProperty("ios_device") + public Optional getIosDevice() { + return iosDevice; + } + + /** + * @return The version of iOS which the contact is using. + */ + @JsonProperty("ios_os_version") + public Optional getIosOsVersion() { + return iosOsVersion; + } + + /** + * @return The version of the iOS SDK which the contact is using. + */ + @JsonProperty("ios_sdk_version") + public Optional getIosSdkVersion() { + return iosSdkVersion; + } + + /** + * @return (UNIX timestamp) The last time the contact used the iOS app. + */ + @JsonProperty("ios_last_seen_at") + public Optional getIosLastSeenAt() { + return iosLastSeenAt; + } + + /** + * @return The custom attributes which are set for the contact. + */ + @JsonProperty("custom_attributes") + public Optional> getCustomAttributes() { + return customAttributes; + } + + /** + * @return An image URL containing the avatar of a contact. + */ + @JsonProperty("avatar") + public Optional getAvatar() { + return avatar; + } + + @JsonProperty("tags") + public Optional getTags() { + return tags; + } + + @JsonProperty("notes") + public Optional getNotes() { + return notes; + } + + @JsonProperty("companies") + public Optional getCompanies() { + return companies; + } + + @JsonProperty("location") + public Optional getLocation() { + return location; + } + + @JsonProperty("social_profiles") + public Optional getSocialProfiles() { + return socialProfiles; + } + + /** + * @return If the user has enabled push messaging. + */ + @JsonProperty("enabled_push_messaging") + public Optional getEnabledPushMessaging() { + return enabledPushMessaging; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof ContactsMergeLeadInUserResponse && equalTo((ContactsMergeLeadInUserResponse) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(ContactsMergeLeadInUserResponse other) { + return id.equals(other.id) + && externalId.equals(other.externalId) + && workspaceId.equals(other.workspaceId) + && role.equals(other.role) + && email.equals(other.email) + && emailDomain.equals(other.emailDomain) + && phone.equals(other.phone) + && name.equals(other.name) + && ownerId.equals(other.ownerId) + && hasHardBounced == other.hasHardBounced + && markedEmailAsSpam == other.markedEmailAsSpam + && unsubscribedFromEmails == other.unsubscribedFromEmails + && createdAt == other.createdAt + && updatedAt == other.updatedAt + && signedUpAt.equals(other.signedUpAt) + && lastSeenAt.equals(other.lastSeenAt) + && lastRepliedAt.equals(other.lastRepliedAt) + && lastContactedAt.equals(other.lastContactedAt) + && lastEmailOpenedAt.equals(other.lastEmailOpenedAt) + && lastEmailClickedAt.equals(other.lastEmailClickedAt) + && languageOverride.equals(other.languageOverride) + && browser.equals(other.browser) + && browserVersion.equals(other.browserVersion) + && browserLanguage.equals(other.browserLanguage) + && os.equals(other.os) + && androidAppName.equals(other.androidAppName) + && androidAppVersion.equals(other.androidAppVersion) + && androidDevice.equals(other.androidDevice) + && androidOsVersion.equals(other.androidOsVersion) + && androidSdkVersion.equals(other.androidSdkVersion) + && androidLastSeenAt.equals(other.androidLastSeenAt) + && iosAppName.equals(other.iosAppName) + && iosAppVersion.equals(other.iosAppVersion) + && iosDevice.equals(other.iosDevice) + && iosOsVersion.equals(other.iosOsVersion) + && iosSdkVersion.equals(other.iosSdkVersion) + && iosLastSeenAt.equals(other.iosLastSeenAt) + && customAttributes.equals(other.customAttributes) + && avatar.equals(other.avatar) + && tags.equals(other.tags) + && notes.equals(other.notes) + && companies.equals(other.companies) + && location.equals(other.location) + && socialProfiles.equals(other.socialProfiles) + && enabledPushMessaging.equals(other.enabledPushMessaging); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash( + this.id, + this.externalId, + this.workspaceId, + this.role, + this.email, + this.emailDomain, + this.phone, + this.name, + this.ownerId, + this.hasHardBounced, + this.markedEmailAsSpam, + this.unsubscribedFromEmails, + this.createdAt, + this.updatedAt, + this.signedUpAt, + this.lastSeenAt, + this.lastRepliedAt, + this.lastContactedAt, + this.lastEmailOpenedAt, + this.lastEmailClickedAt, + this.languageOverride, + this.browser, + this.browserVersion, + this.browserLanguage, + this.os, + this.androidAppName, + this.androidAppVersion, + this.androidDevice, + this.androidOsVersion, + this.androidSdkVersion, + this.androidLastSeenAt, + this.iosAppName, + this.iosAppVersion, + this.iosDevice, + this.iosOsVersion, + this.iosSdkVersion, + this.iosLastSeenAt, + this.customAttributes, + this.avatar, + this.tags, + this.notes, + this.companies, + this.location, + this.socialProfiles, + this.enabledPushMessaging); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static IdStage builder() { + return new Builder(); + } + + public interface IdStage { + /** + *

The unique identifier for the contact which is given by Intercom.

+ */ + WorkspaceIdStage id(@NotNull String id); + + Builder from(ContactsMergeLeadInUserResponse other); + } + + public interface WorkspaceIdStage { + /** + *

The id of the workspace which the contact belongs to.

+ */ + RoleStage workspaceId(@NotNull String workspaceId); + } + + public interface RoleStage { + /** + *

The role of the contact.

+ */ + HasHardBouncedStage role(@NotNull String role); + } + + public interface HasHardBouncedStage { + /** + *

Whether the contact has had an email sent to them hard bounce.

+ */ + MarkedEmailAsSpamStage hasHardBounced(boolean hasHardBounced); + } + + public interface MarkedEmailAsSpamStage { + /** + *

Whether the contact has marked an email sent to them as spam.

+ */ + UnsubscribedFromEmailsStage markedEmailAsSpam(boolean markedEmailAsSpam); + } + + public interface UnsubscribedFromEmailsStage { + /** + *

Whether the contact is unsubscribed from emails.

+ */ + CreatedAtStage unsubscribedFromEmails(boolean unsubscribedFromEmails); + } + + public interface CreatedAtStage { + /** + *

(UNIX timestamp) The time when the contact was created.

+ */ + UpdatedAtStage createdAt(int createdAt); + } + + public interface UpdatedAtStage { + /** + *

(UNIX timestamp) The time when the contact was last updated.

+ */ + _FinalStage updatedAt(int updatedAt); + } + + public interface _FinalStage { + ContactsMergeLeadInUserResponse build(); + + /** + *

The unique identifier for the contact which is provided by the Client.

+ */ + _FinalStage externalId(Optional externalId); + + _FinalStage externalId(String externalId); + + /** + *

The contact's email.

+ */ + _FinalStage email(Optional email); + + _FinalStage email(String email); + + /** + *

The contact's email domain.

+ */ + _FinalStage emailDomain(Optional emailDomain); + + _FinalStage emailDomain(String emailDomain); + + /** + *

The contacts phone.

+ */ + _FinalStage phone(Optional phone); + + _FinalStage phone(String phone); + + /** + *

The contacts name.

+ */ + _FinalStage name(Optional name); + + _FinalStage name(String name); + + /** + *

The id of an admin that has been assigned account ownership of the contact.

+ */ + _FinalStage ownerId(Optional ownerId); + + _FinalStage ownerId(Integer ownerId); + + /** + *

(UNIX timestamp) The time specified for when a contact signed up.

+ */ + _FinalStage signedUpAt(Optional signedUpAt); + + _FinalStage signedUpAt(Integer signedUpAt); + + /** + *

(UNIX timestamp) The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually).

+ */ + _FinalStage lastSeenAt(Optional lastSeenAt); + + _FinalStage lastSeenAt(Integer lastSeenAt); + + /** + *

(UNIX timestamp) The time when the contact last messaged in.

+ */ + _FinalStage lastRepliedAt(Optional lastRepliedAt); + + _FinalStage lastRepliedAt(Integer lastRepliedAt); + + /** + *

(UNIX timestamp) The time when the contact was last messaged.

+ */ + _FinalStage lastContactedAt(Optional lastContactedAt); + + _FinalStage lastContactedAt(Integer lastContactedAt); + + /** + *

(UNIX timestamp) The time when the contact last opened an email.

+ */ + _FinalStage lastEmailOpenedAt(Optional lastEmailOpenedAt); + + _FinalStage lastEmailOpenedAt(Integer lastEmailOpenedAt); + + /** + *

(UNIX timestamp) The time when the contact last clicked a link in an email.

+ */ + _FinalStage lastEmailClickedAt(Optional lastEmailClickedAt); + + _FinalStage lastEmailClickedAt(Integer lastEmailClickedAt); + + /** + *

A preferred language setting for the contact, used by the Intercom Messenger even if their browser settings change.

+ */ + _FinalStage languageOverride(Optional languageOverride); + + _FinalStage languageOverride(String languageOverride); + + /** + *

The name of the browser which the contact is using.

+ */ + _FinalStage browser(Optional browser); + + _FinalStage browser(String browser); + + /** + *

The version of the browser which the contact is using.

+ */ + _FinalStage browserVersion(Optional browserVersion); + + _FinalStage browserVersion(String browserVersion); + + /** + *

The language set by the browser which the contact is using.

+ */ + _FinalStage browserLanguage(Optional browserLanguage); + + _FinalStage browserLanguage(String browserLanguage); + + /** + *

The operating system which the contact is using.

+ */ + _FinalStage os(Optional os); + + _FinalStage os(String os); + + /** + *

The name of the Android app which the contact is using.

+ */ + _FinalStage androidAppName(Optional androidAppName); + + _FinalStage androidAppName(String androidAppName); + + /** + *

The version of the Android app which the contact is using.

+ */ + _FinalStage androidAppVersion(Optional androidAppVersion); + + _FinalStage androidAppVersion(String androidAppVersion); + + /** + *

The Android device which the contact is using.

+ */ + _FinalStage androidDevice(Optional androidDevice); + + _FinalStage androidDevice(String androidDevice); + + /** + *

The version of the Android OS which the contact is using.

+ */ + _FinalStage androidOsVersion(Optional androidOsVersion); + + _FinalStage androidOsVersion(String androidOsVersion); + + /** + *

The version of the Android SDK which the contact is using.

+ */ + _FinalStage androidSdkVersion(Optional androidSdkVersion); + + _FinalStage androidSdkVersion(String androidSdkVersion); + + /** + *

(UNIX timestamp) The time when the contact was last seen on an Android device.

+ */ + _FinalStage androidLastSeenAt(Optional androidLastSeenAt); + + _FinalStage androidLastSeenAt(Integer androidLastSeenAt); + + /** + *

The name of the iOS app which the contact is using.

+ */ + _FinalStage iosAppName(Optional iosAppName); + + _FinalStage iosAppName(String iosAppName); + + /** + *

The version of the iOS app which the contact is using.

+ */ + _FinalStage iosAppVersion(Optional iosAppVersion); + + _FinalStage iosAppVersion(String iosAppVersion); + + /** + *

The iOS device which the contact is using.

+ */ + _FinalStage iosDevice(Optional iosDevice); + + _FinalStage iosDevice(String iosDevice); + + /** + *

The version of iOS which the contact is using.

+ */ + _FinalStage iosOsVersion(Optional iosOsVersion); + + _FinalStage iosOsVersion(String iosOsVersion); + + /** + *

The version of the iOS SDK which the contact is using.

+ */ + _FinalStage iosSdkVersion(Optional iosSdkVersion); + + _FinalStage iosSdkVersion(String iosSdkVersion); + + /** + *

(UNIX timestamp) The last time the contact used the iOS app.

+ */ + _FinalStage iosLastSeenAt(Optional iosLastSeenAt); + + _FinalStage iosLastSeenAt(Integer iosLastSeenAt); + + /** + *

The custom attributes which are set for the contact.

+ */ + _FinalStage customAttributes(Optional> customAttributes); + + _FinalStage customAttributes(Map customAttributes); + + /** + *

An image URL containing the avatar of a contact.

+ */ + _FinalStage avatar(Optional avatar); + + _FinalStage avatar(String avatar); + + _FinalStage tags(Optional tags); + + _FinalStage tags(ContactTags tags); + + _FinalStage notes(Optional notes); + + _FinalStage notes(ContactNotes notes); + + _FinalStage companies(Optional companies); + + _FinalStage companies(ContactCompanies companies); + + _FinalStage location(Optional location); + + _FinalStage location(ContactLocation location); + + _FinalStage socialProfiles(Optional socialProfiles); + + _FinalStage socialProfiles(ContactSocialProfiles socialProfiles); + + /** + *

If the user has enabled push messaging.

+ */ + _FinalStage enabledPushMessaging(Optional enabledPushMessaging); + + _FinalStage enabledPushMessaging(Boolean enabledPushMessaging); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder + implements IdStage, + WorkspaceIdStage, + RoleStage, + HasHardBouncedStage, + MarkedEmailAsSpamStage, + UnsubscribedFromEmailsStage, + CreatedAtStage, + UpdatedAtStage, + _FinalStage { + private String id; + + private String workspaceId; + + private String role; + + private boolean hasHardBounced; + + private boolean markedEmailAsSpam; + + private boolean unsubscribedFromEmails; + + private int createdAt; + + private int updatedAt; + + private Optional enabledPushMessaging = Optional.empty(); + + private Optional socialProfiles = Optional.empty(); + + private Optional location = Optional.empty(); + + private Optional companies = Optional.empty(); + + private Optional notes = Optional.empty(); + + private Optional tags = Optional.empty(); + + private Optional avatar = Optional.empty(); + + private Optional> customAttributes = Optional.empty(); + + private Optional iosLastSeenAt = Optional.empty(); + + private Optional iosSdkVersion = Optional.empty(); + + private Optional iosOsVersion = Optional.empty(); + + private Optional iosDevice = Optional.empty(); + + private Optional iosAppVersion = Optional.empty(); + + private Optional iosAppName = Optional.empty(); + + private Optional androidLastSeenAt = Optional.empty(); + + private Optional androidSdkVersion = Optional.empty(); + + private Optional androidOsVersion = Optional.empty(); + + private Optional androidDevice = Optional.empty(); + + private Optional androidAppVersion = Optional.empty(); + + private Optional androidAppName = Optional.empty(); + + private Optional os = Optional.empty(); + + private Optional browserLanguage = Optional.empty(); + + private Optional browserVersion = Optional.empty(); + + private Optional browser = Optional.empty(); + + private Optional languageOverride = Optional.empty(); + + private Optional lastEmailClickedAt = Optional.empty(); + + private Optional lastEmailOpenedAt = Optional.empty(); + + private Optional lastContactedAt = Optional.empty(); + + private Optional lastRepliedAt = Optional.empty(); + + private Optional lastSeenAt = Optional.empty(); + + private Optional signedUpAt = Optional.empty(); + + private Optional ownerId = Optional.empty(); + + private Optional name = Optional.empty(); + + private Optional phone = Optional.empty(); + + private Optional emailDomain = Optional.empty(); + + private Optional email = Optional.empty(); + + private Optional externalId = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(ContactsMergeLeadInUserResponse other) { + id(other.getId()); + externalId(other.getExternalId()); + workspaceId(other.getWorkspaceId()); + role(other.getRole()); + email(other.getEmail()); + emailDomain(other.getEmailDomain()); + phone(other.getPhone()); + name(other.getName()); + ownerId(other.getOwnerId()); + hasHardBounced(other.getHasHardBounced()); + markedEmailAsSpam(other.getMarkedEmailAsSpam()); + unsubscribedFromEmails(other.getUnsubscribedFromEmails()); + createdAt(other.getCreatedAt()); + updatedAt(other.getUpdatedAt()); + signedUpAt(other.getSignedUpAt()); + lastSeenAt(other.getLastSeenAt()); + lastRepliedAt(other.getLastRepliedAt()); + lastContactedAt(other.getLastContactedAt()); + lastEmailOpenedAt(other.getLastEmailOpenedAt()); + lastEmailClickedAt(other.getLastEmailClickedAt()); + languageOverride(other.getLanguageOverride()); + browser(other.getBrowser()); + browserVersion(other.getBrowserVersion()); + browserLanguage(other.getBrowserLanguage()); + os(other.getOs()); + androidAppName(other.getAndroidAppName()); + androidAppVersion(other.getAndroidAppVersion()); + androidDevice(other.getAndroidDevice()); + androidOsVersion(other.getAndroidOsVersion()); + androidSdkVersion(other.getAndroidSdkVersion()); + androidLastSeenAt(other.getAndroidLastSeenAt()); + iosAppName(other.getIosAppName()); + iosAppVersion(other.getIosAppVersion()); + iosDevice(other.getIosDevice()); + iosOsVersion(other.getIosOsVersion()); + iosSdkVersion(other.getIosSdkVersion()); + iosLastSeenAt(other.getIosLastSeenAt()); + customAttributes(other.getCustomAttributes()); + avatar(other.getAvatar()); + tags(other.getTags()); + notes(other.getNotes()); + companies(other.getCompanies()); + location(other.getLocation()); + socialProfiles(other.getSocialProfiles()); + enabledPushMessaging(other.getEnabledPushMessaging()); + return this; + } + + /** + *

The unique identifier for the contact which is given by Intercom.

+ *

The unique identifier for the contact which is given by Intercom.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("id") + public WorkspaceIdStage id(@NotNull String id) { + this.id = Objects.requireNonNull(id, "id must not be null"); + return this; + } + + /** + *

The id of the workspace which the contact belongs to.

+ *

The id of the workspace which the contact belongs to.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("workspace_id") + public RoleStage workspaceId(@NotNull String workspaceId) { + this.workspaceId = Objects.requireNonNull(workspaceId, "workspaceId must not be null"); + return this; + } + + /** + *

The role of the contact.

+ *

The role of the contact.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("role") + public HasHardBouncedStage role(@NotNull String role) { + this.role = Objects.requireNonNull(role, "role must not be null"); + return this; + } + + /** + *

Whether the contact has had an email sent to them hard bounce.

+ *

Whether the contact has had an email sent to them hard bounce.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("has_hard_bounced") + public MarkedEmailAsSpamStage hasHardBounced(boolean hasHardBounced) { + this.hasHardBounced = hasHardBounced; + return this; + } + + /** + *

Whether the contact has marked an email sent to them as spam.

+ *

Whether the contact has marked an email sent to them as spam.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("marked_email_as_spam") + public UnsubscribedFromEmailsStage markedEmailAsSpam(boolean markedEmailAsSpam) { + this.markedEmailAsSpam = markedEmailAsSpam; + return this; + } + + /** + *

Whether the contact is unsubscribed from emails.

+ *

Whether the contact is unsubscribed from emails.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("unsubscribed_from_emails") + public CreatedAtStage unsubscribedFromEmails(boolean unsubscribedFromEmails) { + this.unsubscribedFromEmails = unsubscribedFromEmails; + return this; + } + + /** + *

(UNIX timestamp) The time when the contact was created.

+ *

(UNIX timestamp) The time when the contact was created.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("created_at") + public UpdatedAtStage createdAt(int createdAt) { + this.createdAt = createdAt; + return this; + } + + /** + *

(UNIX timestamp) The time when the contact was last updated.

+ *

(UNIX timestamp) The time when the contact was last updated.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("updated_at") + public _FinalStage updatedAt(int updatedAt) { + this.updatedAt = updatedAt; + return this; + } + + /** + *

If the user has enabled push messaging.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage enabledPushMessaging(Boolean enabledPushMessaging) { + this.enabledPushMessaging = Optional.ofNullable(enabledPushMessaging); + return this; + } + + /** + *

If the user has enabled push messaging.

+ */ + @java.lang.Override + @JsonSetter(value = "enabled_push_messaging", nulls = Nulls.SKIP) + public _FinalStage enabledPushMessaging(Optional enabledPushMessaging) { + this.enabledPushMessaging = enabledPushMessaging; + return this; + } + + @java.lang.Override + public _FinalStage socialProfiles(ContactSocialProfiles socialProfiles) { + this.socialProfiles = Optional.ofNullable(socialProfiles); + return this; + } + + @java.lang.Override + @JsonSetter(value = "social_profiles", nulls = Nulls.SKIP) + public _FinalStage socialProfiles(Optional socialProfiles) { + this.socialProfiles = socialProfiles; + return this; + } + + @java.lang.Override + public _FinalStage location(ContactLocation location) { + this.location = Optional.ofNullable(location); + return this; + } + + @java.lang.Override + @JsonSetter(value = "location", nulls = Nulls.SKIP) + public _FinalStage location(Optional location) { + this.location = location; + return this; + } + + @java.lang.Override + public _FinalStage companies(ContactCompanies companies) { + this.companies = Optional.ofNullable(companies); + return this; + } + + @java.lang.Override + @JsonSetter(value = "companies", nulls = Nulls.SKIP) + public _FinalStage companies(Optional companies) { + this.companies = companies; + return this; + } + + @java.lang.Override + public _FinalStage notes(ContactNotes notes) { + this.notes = Optional.ofNullable(notes); + return this; + } + + @java.lang.Override + @JsonSetter(value = "notes", nulls = Nulls.SKIP) + public _FinalStage notes(Optional notes) { + this.notes = notes; + return this; + } + + @java.lang.Override + public _FinalStage tags(ContactTags tags) { + this.tags = Optional.ofNullable(tags); + return this; + } + + @java.lang.Override + @JsonSetter(value = "tags", nulls = Nulls.SKIP) + public _FinalStage tags(Optional tags) { + this.tags = tags; + return this; + } + + /** + *

An image URL containing the avatar of a contact.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage avatar(String avatar) { + this.avatar = Optional.ofNullable(avatar); + return this; + } + + /** + *

An image URL containing the avatar of a contact.

+ */ + @java.lang.Override + @JsonSetter(value = "avatar", nulls = Nulls.SKIP) + public _FinalStage avatar(Optional avatar) { + this.avatar = avatar; + return this; + } + + /** + *

The custom attributes which are set for the contact.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage customAttributes(Map customAttributes) { + this.customAttributes = Optional.ofNullable(customAttributes); + return this; + } + + /** + *

The custom attributes which are set for the contact.

+ */ + @java.lang.Override + @JsonSetter(value = "custom_attributes", nulls = Nulls.SKIP) + public _FinalStage customAttributes(Optional> customAttributes) { + this.customAttributes = customAttributes; + return this; + } + + /** + *

(UNIX timestamp) The last time the contact used the iOS app.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage iosLastSeenAt(Integer iosLastSeenAt) { + this.iosLastSeenAt = Optional.ofNullable(iosLastSeenAt); + return this; + } + + /** + *

(UNIX timestamp) The last time the contact used the iOS app.

+ */ + @java.lang.Override + @JsonSetter(value = "ios_last_seen_at", nulls = Nulls.SKIP) + public _FinalStage iosLastSeenAt(Optional iosLastSeenAt) { + this.iosLastSeenAt = iosLastSeenAt; + return this; + } + + /** + *

The version of the iOS SDK which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage iosSdkVersion(String iosSdkVersion) { + this.iosSdkVersion = Optional.ofNullable(iosSdkVersion); + return this; + } + + /** + *

The version of the iOS SDK which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "ios_sdk_version", nulls = Nulls.SKIP) + public _FinalStage iosSdkVersion(Optional iosSdkVersion) { + this.iosSdkVersion = iosSdkVersion; + return this; + } + + /** + *

The version of iOS which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage iosOsVersion(String iosOsVersion) { + this.iosOsVersion = Optional.ofNullable(iosOsVersion); + return this; + } + + /** + *

The version of iOS which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "ios_os_version", nulls = Nulls.SKIP) + public _FinalStage iosOsVersion(Optional iosOsVersion) { + this.iosOsVersion = iosOsVersion; + return this; + } + + /** + *

The iOS device which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage iosDevice(String iosDevice) { + this.iosDevice = Optional.ofNullable(iosDevice); + return this; + } + + /** + *

The iOS device which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "ios_device", nulls = Nulls.SKIP) + public _FinalStage iosDevice(Optional iosDevice) { + this.iosDevice = iosDevice; + return this; + } + + /** + *

The version of the iOS app which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage iosAppVersion(String iosAppVersion) { + this.iosAppVersion = Optional.ofNullable(iosAppVersion); + return this; + } + + /** + *

The version of the iOS app which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "ios_app_version", nulls = Nulls.SKIP) + public _FinalStage iosAppVersion(Optional iosAppVersion) { + this.iosAppVersion = iosAppVersion; + return this; + } + + /** + *

The name of the iOS app which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage iosAppName(String iosAppName) { + this.iosAppName = Optional.ofNullable(iosAppName); + return this; + } + + /** + *

The name of the iOS app which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "ios_app_name", nulls = Nulls.SKIP) + public _FinalStage iosAppName(Optional iosAppName) { + this.iosAppName = iosAppName; + return this; + } + + /** + *

(UNIX timestamp) The time when the contact was last seen on an Android device.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage androidLastSeenAt(Integer androidLastSeenAt) { + this.androidLastSeenAt = Optional.ofNullable(androidLastSeenAt); + return this; + } + + /** + *

(UNIX timestamp) The time when the contact was last seen on an Android device.

+ */ + @java.lang.Override + @JsonSetter(value = "android_last_seen_at", nulls = Nulls.SKIP) + public _FinalStage androidLastSeenAt(Optional androidLastSeenAt) { + this.androidLastSeenAt = androidLastSeenAt; + return this; + } + + /** + *

The version of the Android SDK which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage androidSdkVersion(String androidSdkVersion) { + this.androidSdkVersion = Optional.ofNullable(androidSdkVersion); + return this; + } + + /** + *

The version of the Android SDK which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "android_sdk_version", nulls = Nulls.SKIP) + public _FinalStage androidSdkVersion(Optional androidSdkVersion) { + this.androidSdkVersion = androidSdkVersion; + return this; + } + + /** + *

The version of the Android OS which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage androidOsVersion(String androidOsVersion) { + this.androidOsVersion = Optional.ofNullable(androidOsVersion); + return this; + } + + /** + *

The version of the Android OS which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "android_os_version", nulls = Nulls.SKIP) + public _FinalStage androidOsVersion(Optional androidOsVersion) { + this.androidOsVersion = androidOsVersion; + return this; + } + + /** + *

The Android device which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage androidDevice(String androidDevice) { + this.androidDevice = Optional.ofNullable(androidDevice); + return this; + } + + /** + *

The Android device which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "android_device", nulls = Nulls.SKIP) + public _FinalStage androidDevice(Optional androidDevice) { + this.androidDevice = androidDevice; + return this; + } + + /** + *

The version of the Android app which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage androidAppVersion(String androidAppVersion) { + this.androidAppVersion = Optional.ofNullable(androidAppVersion); + return this; + } + + /** + *

The version of the Android app which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "android_app_version", nulls = Nulls.SKIP) + public _FinalStage androidAppVersion(Optional androidAppVersion) { + this.androidAppVersion = androidAppVersion; + return this; + } + + /** + *

The name of the Android app which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage androidAppName(String androidAppName) { + this.androidAppName = Optional.ofNullable(androidAppName); + return this; + } + + /** + *

The name of the Android app which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "android_app_name", nulls = Nulls.SKIP) + public _FinalStage androidAppName(Optional androidAppName) { + this.androidAppName = androidAppName; + return this; + } + + /** + *

The operating system which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage os(String os) { + this.os = Optional.ofNullable(os); + return this; + } + + /** + *

The operating system which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "os", nulls = Nulls.SKIP) + public _FinalStage os(Optional os) { + this.os = os; + return this; + } + + /** + *

The language set by the browser which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage browserLanguage(String browserLanguage) { + this.browserLanguage = Optional.ofNullable(browserLanguage); + return this; + } + + /** + *

The language set by the browser which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "browser_language", nulls = Nulls.SKIP) + public _FinalStage browserLanguage(Optional browserLanguage) { + this.browserLanguage = browserLanguage; + return this; + } + + /** + *

The version of the browser which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage browserVersion(String browserVersion) { + this.browserVersion = Optional.ofNullable(browserVersion); + return this; + } + + /** + *

The version of the browser which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "browser_version", nulls = Nulls.SKIP) + public _FinalStage browserVersion(Optional browserVersion) { + this.browserVersion = browserVersion; + return this; + } + + /** + *

The name of the browser which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage browser(String browser) { + this.browser = Optional.ofNullable(browser); + return this; + } + + /** + *

The name of the browser which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "browser", nulls = Nulls.SKIP) + public _FinalStage browser(Optional browser) { + this.browser = browser; + return this; + } + + /** + *

A preferred language setting for the contact, used by the Intercom Messenger even if their browser settings change.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage languageOverride(String languageOverride) { + this.languageOverride = Optional.ofNullable(languageOverride); + return this; + } + + /** + *

A preferred language setting for the contact, used by the Intercom Messenger even if their browser settings change.

+ */ + @java.lang.Override + @JsonSetter(value = "language_override", nulls = Nulls.SKIP) + public _FinalStage languageOverride(Optional languageOverride) { + this.languageOverride = languageOverride; + return this; + } + + /** + *

(UNIX timestamp) The time when the contact last clicked a link in an email.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage lastEmailClickedAt(Integer lastEmailClickedAt) { + this.lastEmailClickedAt = Optional.ofNullable(lastEmailClickedAt); + return this; + } + + /** + *

(UNIX timestamp) The time when the contact last clicked a link in an email.

+ */ + @java.lang.Override + @JsonSetter(value = "last_email_clicked_at", nulls = Nulls.SKIP) + public _FinalStage lastEmailClickedAt(Optional lastEmailClickedAt) { + this.lastEmailClickedAt = lastEmailClickedAt; + return this; + } + + /** + *

(UNIX timestamp) The time when the contact last opened an email.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage lastEmailOpenedAt(Integer lastEmailOpenedAt) { + this.lastEmailOpenedAt = Optional.ofNullable(lastEmailOpenedAt); + return this; + } + + /** + *

(UNIX timestamp) The time when the contact last opened an email.

+ */ + @java.lang.Override + @JsonSetter(value = "last_email_opened_at", nulls = Nulls.SKIP) + public _FinalStage lastEmailOpenedAt(Optional lastEmailOpenedAt) { + this.lastEmailOpenedAt = lastEmailOpenedAt; + return this; + } + + /** + *

(UNIX timestamp) The time when the contact was last messaged.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage lastContactedAt(Integer lastContactedAt) { + this.lastContactedAt = Optional.ofNullable(lastContactedAt); + return this; + } + + /** + *

(UNIX timestamp) The time when the contact was last messaged.

+ */ + @java.lang.Override + @JsonSetter(value = "last_contacted_at", nulls = Nulls.SKIP) + public _FinalStage lastContactedAt(Optional lastContactedAt) { + this.lastContactedAt = lastContactedAt; + return this; + } + + /** + *

(UNIX timestamp) The time when the contact last messaged in.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage lastRepliedAt(Integer lastRepliedAt) { + this.lastRepliedAt = Optional.ofNullable(lastRepliedAt); + return this; + } + + /** + *

(UNIX timestamp) The time when the contact last messaged in.

+ */ + @java.lang.Override + @JsonSetter(value = "last_replied_at", nulls = Nulls.SKIP) + public _FinalStage lastRepliedAt(Optional lastRepliedAt) { + this.lastRepliedAt = lastRepliedAt; + return this; + } + + /** + *

(UNIX timestamp) The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually).

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage lastSeenAt(Integer lastSeenAt) { + this.lastSeenAt = Optional.ofNullable(lastSeenAt); + return this; + } + + /** + *

(UNIX timestamp) The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually).

+ */ + @java.lang.Override + @JsonSetter(value = "last_seen_at", nulls = Nulls.SKIP) + public _FinalStage lastSeenAt(Optional lastSeenAt) { + this.lastSeenAt = lastSeenAt; + return this; + } + + /** + *

(UNIX timestamp) The time specified for when a contact signed up.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage signedUpAt(Integer signedUpAt) { + this.signedUpAt = Optional.ofNullable(signedUpAt); + return this; + } + + /** + *

(UNIX timestamp) The time specified for when a contact signed up.

+ */ + @java.lang.Override + @JsonSetter(value = "signed_up_at", nulls = Nulls.SKIP) + public _FinalStage signedUpAt(Optional signedUpAt) { + this.signedUpAt = signedUpAt; + return this; + } + + /** + *

The id of an admin that has been assigned account ownership of the contact.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage ownerId(Integer ownerId) { + this.ownerId = Optional.ofNullable(ownerId); + return this; + } + + /** + *

The id of an admin that has been assigned account ownership of the contact.

+ */ + @java.lang.Override + @JsonSetter(value = "owner_id", nulls = Nulls.SKIP) + public _FinalStage ownerId(Optional ownerId) { + this.ownerId = ownerId; + return this; + } + + /** + *

The contacts name.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage name(String name) { + this.name = Optional.ofNullable(name); + return this; + } + + /** + *

The contacts name.

+ */ + @java.lang.Override + @JsonSetter(value = "name", nulls = Nulls.SKIP) + public _FinalStage name(Optional name) { + this.name = name; + return this; + } + + /** + *

The contacts phone.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage phone(String phone) { + this.phone = Optional.ofNullable(phone); + return this; + } + + /** + *

The contacts phone.

+ */ + @java.lang.Override + @JsonSetter(value = "phone", nulls = Nulls.SKIP) + public _FinalStage phone(Optional phone) { + this.phone = phone; + return this; + } + + /** + *

The contact's email domain.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage emailDomain(String emailDomain) { + this.emailDomain = Optional.ofNullable(emailDomain); + return this; + } + + /** + *

The contact's email domain.

+ */ + @java.lang.Override + @JsonSetter(value = "email_domain", nulls = Nulls.SKIP) + public _FinalStage emailDomain(Optional emailDomain) { + this.emailDomain = emailDomain; + return this; + } + + /** + *

The contact's email.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage email(String email) { + this.email = Optional.ofNullable(email); + return this; + } + + /** + *

The contact's email.

+ */ + @java.lang.Override + @JsonSetter(value = "email", nulls = Nulls.SKIP) + public _FinalStage email(Optional email) { + this.email = email; + return this; + } + + /** + *

The unique identifier for the contact which is provided by the Client.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage externalId(String externalId) { + this.externalId = Optional.ofNullable(externalId); + return this; + } + + /** + *

The unique identifier for the contact which is provided by the Client.

+ */ + @java.lang.Override + @JsonSetter(value = "external_id", nulls = Nulls.SKIP) + public _FinalStage externalId(Optional externalId) { + this.externalId = externalId; + return this; + } + + @java.lang.Override + public ContactsMergeLeadInUserResponse build() { + return new ContactsMergeLeadInUserResponse( + id, + externalId, + workspaceId, + role, + email, + emailDomain, + phone, + name, + ownerId, + hasHardBounced, + markedEmailAsSpam, + unsubscribedFromEmails, + createdAt, + updatedAt, + signedUpAt, + lastSeenAt, + lastRepliedAt, + lastContactedAt, + lastEmailOpenedAt, + lastEmailClickedAt, + languageOverride, + browser, + browserVersion, + browserLanguage, + os, + androidAppName, + androidAppVersion, + androidDevice, + androidOsVersion, + androidSdkVersion, + androidLastSeenAt, + iosAppName, + iosAppVersion, + iosDevice, + iosOsVersion, + iosSdkVersion, + iosLastSeenAt, + customAttributes, + avatar, + tags, + notes, + companies, + location, + socialProfiles, + enabledPushMessaging, + additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/contacts/types/ContactsUpdateResponse.java b/src/main/java/com/intercom/api/resources/contacts/types/ContactsUpdateResponse.java new file mode 100644 index 00000000..5123a28b --- /dev/null +++ b/src/main/java/com/intercom/api/resources/contacts/types/ContactsUpdateResponse.java @@ -0,0 +1,2001 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.contacts.types; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.types.ContactCompanies; +import com.intercom.api.types.ContactLocation; +import com.intercom.api.types.ContactNotes; +import com.intercom.api.types.ContactSocialProfiles; +import com.intercom.api.types.ContactTags; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = ContactsUpdateResponse.Builder.class) +public final class ContactsUpdateResponse implements IContact { + private final String id; + + private final Optional externalId; + + private final String workspaceId; + + private final String role; + + private final Optional email; + + private final Optional emailDomain; + + private final Optional phone; + + private final Optional name; + + private final Optional ownerId; + + private final boolean hasHardBounced; + + private final boolean markedEmailAsSpam; + + private final boolean unsubscribedFromEmails; + + private final int createdAt; + + private final int updatedAt; + + private final Optional signedUpAt; + + private final Optional lastSeenAt; + + private final Optional lastRepliedAt; + + private final Optional lastContactedAt; + + private final Optional lastEmailOpenedAt; + + private final Optional lastEmailClickedAt; + + private final Optional languageOverride; + + private final Optional browser; + + private final Optional browserVersion; + + private final Optional browserLanguage; + + private final Optional os; + + private final Optional androidAppName; + + private final Optional androidAppVersion; + + private final Optional androidDevice; + + private final Optional androidOsVersion; + + private final Optional androidSdkVersion; + + private final Optional androidLastSeenAt; + + private final Optional iosAppName; + + private final Optional iosAppVersion; + + private final Optional iosDevice; + + private final Optional iosOsVersion; + + private final Optional iosSdkVersion; + + private final Optional iosLastSeenAt; + + private final Optional> customAttributes; + + private final Optional avatar; + + private final Optional tags; + + private final Optional notes; + + private final Optional companies; + + private final Optional location; + + private final Optional socialProfiles; + + private final Optional enabledPushMessaging; + + private final Map additionalProperties; + + private ContactsUpdateResponse( + String id, + Optional externalId, + String workspaceId, + String role, + Optional email, + Optional emailDomain, + Optional phone, + Optional name, + Optional ownerId, + boolean hasHardBounced, + boolean markedEmailAsSpam, + boolean unsubscribedFromEmails, + int createdAt, + int updatedAt, + Optional signedUpAt, + Optional lastSeenAt, + Optional lastRepliedAt, + Optional lastContactedAt, + Optional lastEmailOpenedAt, + Optional lastEmailClickedAt, + Optional languageOverride, + Optional browser, + Optional browserVersion, + Optional browserLanguage, + Optional os, + Optional androidAppName, + Optional androidAppVersion, + Optional androidDevice, + Optional androidOsVersion, + Optional androidSdkVersion, + Optional androidLastSeenAt, + Optional iosAppName, + Optional iosAppVersion, + Optional iosDevice, + Optional iosOsVersion, + Optional iosSdkVersion, + Optional iosLastSeenAt, + Optional> customAttributes, + Optional avatar, + Optional tags, + Optional notes, + Optional companies, + Optional location, + Optional socialProfiles, + Optional enabledPushMessaging, + Map additionalProperties) { + this.id = id; + this.externalId = externalId; + this.workspaceId = workspaceId; + this.role = role; + this.email = email; + this.emailDomain = emailDomain; + this.phone = phone; + this.name = name; + this.ownerId = ownerId; + this.hasHardBounced = hasHardBounced; + this.markedEmailAsSpam = markedEmailAsSpam; + this.unsubscribedFromEmails = unsubscribedFromEmails; + this.createdAt = createdAt; + this.updatedAt = updatedAt; + this.signedUpAt = signedUpAt; + this.lastSeenAt = lastSeenAt; + this.lastRepliedAt = lastRepliedAt; + this.lastContactedAt = lastContactedAt; + this.lastEmailOpenedAt = lastEmailOpenedAt; + this.lastEmailClickedAt = lastEmailClickedAt; + this.languageOverride = languageOverride; + this.browser = browser; + this.browserVersion = browserVersion; + this.browserLanguage = browserLanguage; + this.os = os; + this.androidAppName = androidAppName; + this.androidAppVersion = androidAppVersion; + this.androidDevice = androidDevice; + this.androidOsVersion = androidOsVersion; + this.androidSdkVersion = androidSdkVersion; + this.androidLastSeenAt = androidLastSeenAt; + this.iosAppName = iosAppName; + this.iosAppVersion = iosAppVersion; + this.iosDevice = iosDevice; + this.iosOsVersion = iosOsVersion; + this.iosSdkVersion = iosSdkVersion; + this.iosLastSeenAt = iosLastSeenAt; + this.customAttributes = customAttributes; + this.avatar = avatar; + this.tags = tags; + this.notes = notes; + this.companies = companies; + this.location = location; + this.socialProfiles = socialProfiles; + this.enabledPushMessaging = enabledPushMessaging; + this.additionalProperties = additionalProperties; + } + + /** + * @return The type of object. + */ + @JsonProperty("type") + public String getType() { + return "contact"; + } + + /** + * @return The unique identifier for the contact which is given by Intercom. + */ + @JsonProperty("id") + public String getId() { + return id; + } + + /** + * @return The unique identifier for the contact which is provided by the Client. + */ + @JsonProperty("external_id") + public Optional getExternalId() { + return externalId; + } + + /** + * @return The id of the workspace which the contact belongs to. + */ + @JsonProperty("workspace_id") + public String getWorkspaceId() { + return workspaceId; + } + + /** + * @return The role of the contact. + */ + @JsonProperty("role") + public String getRole() { + return role; + } + + /** + * @return The contact's email. + */ + @JsonProperty("email") + public Optional getEmail() { + return email; + } + + /** + * @return The contact's email domain. + */ + @JsonProperty("email_domain") + public Optional getEmailDomain() { + return emailDomain; + } + + /** + * @return The contacts phone. + */ + @JsonProperty("phone") + public Optional getPhone() { + return phone; + } + + /** + * @return The contacts name. + */ + @JsonProperty("name") + public Optional getName() { + return name; + } + + /** + * @return The id of an admin that has been assigned account ownership of the contact. + */ + @JsonProperty("owner_id") + public Optional getOwnerId() { + return ownerId; + } + + /** + * @return Whether the contact has had an email sent to them hard bounce. + */ + @JsonProperty("has_hard_bounced") + public boolean getHasHardBounced() { + return hasHardBounced; + } + + /** + * @return Whether the contact has marked an email sent to them as spam. + */ + @JsonProperty("marked_email_as_spam") + public boolean getMarkedEmailAsSpam() { + return markedEmailAsSpam; + } + + /** + * @return Whether the contact is unsubscribed from emails. + */ + @JsonProperty("unsubscribed_from_emails") + public boolean getUnsubscribedFromEmails() { + return unsubscribedFromEmails; + } + + /** + * @return (UNIX timestamp) The time when the contact was created. + */ + @JsonProperty("created_at") + public int getCreatedAt() { + return createdAt; + } + + /** + * @return (UNIX timestamp) The time when the contact was last updated. + */ + @JsonProperty("updated_at") + public int getUpdatedAt() { + return updatedAt; + } + + /** + * @return (UNIX timestamp) The time specified for when a contact signed up. + */ + @JsonProperty("signed_up_at") + public Optional getSignedUpAt() { + return signedUpAt; + } + + /** + * @return (UNIX timestamp) The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually). + */ + @JsonProperty("last_seen_at") + public Optional getLastSeenAt() { + return lastSeenAt; + } + + /** + * @return (UNIX timestamp) The time when the contact last messaged in. + */ + @JsonProperty("last_replied_at") + public Optional getLastRepliedAt() { + return lastRepliedAt; + } + + /** + * @return (UNIX timestamp) The time when the contact was last messaged. + */ + @JsonProperty("last_contacted_at") + public Optional getLastContactedAt() { + return lastContactedAt; + } + + /** + * @return (UNIX timestamp) The time when the contact last opened an email. + */ + @JsonProperty("last_email_opened_at") + public Optional getLastEmailOpenedAt() { + return lastEmailOpenedAt; + } + + /** + * @return (UNIX timestamp) The time when the contact last clicked a link in an email. + */ + @JsonProperty("last_email_clicked_at") + public Optional getLastEmailClickedAt() { + return lastEmailClickedAt; + } + + /** + * @return A preferred language setting for the contact, used by the Intercom Messenger even if their browser settings change. + */ + @JsonProperty("language_override") + public Optional getLanguageOverride() { + return languageOverride; + } + + /** + * @return The name of the browser which the contact is using. + */ + @JsonProperty("browser") + public Optional getBrowser() { + return browser; + } + + /** + * @return The version of the browser which the contact is using. + */ + @JsonProperty("browser_version") + public Optional getBrowserVersion() { + return browserVersion; + } + + /** + * @return The language set by the browser which the contact is using. + */ + @JsonProperty("browser_language") + public Optional getBrowserLanguage() { + return browserLanguage; + } + + /** + * @return The operating system which the contact is using. + */ + @JsonProperty("os") + public Optional getOs() { + return os; + } + + /** + * @return The name of the Android app which the contact is using. + */ + @JsonProperty("android_app_name") + public Optional getAndroidAppName() { + return androidAppName; + } + + /** + * @return The version of the Android app which the contact is using. + */ + @JsonProperty("android_app_version") + public Optional getAndroidAppVersion() { + return androidAppVersion; + } + + /** + * @return The Android device which the contact is using. + */ + @JsonProperty("android_device") + public Optional getAndroidDevice() { + return androidDevice; + } + + /** + * @return The version of the Android OS which the contact is using. + */ + @JsonProperty("android_os_version") + public Optional getAndroidOsVersion() { + return androidOsVersion; + } + + /** + * @return The version of the Android SDK which the contact is using. + */ + @JsonProperty("android_sdk_version") + public Optional getAndroidSdkVersion() { + return androidSdkVersion; + } + + /** + * @return (UNIX timestamp) The time when the contact was last seen on an Android device. + */ + @JsonProperty("android_last_seen_at") + public Optional getAndroidLastSeenAt() { + return androidLastSeenAt; + } + + /** + * @return The name of the iOS app which the contact is using. + */ + @JsonProperty("ios_app_name") + public Optional getIosAppName() { + return iosAppName; + } + + /** + * @return The version of the iOS app which the contact is using. + */ + @JsonProperty("ios_app_version") + public Optional getIosAppVersion() { + return iosAppVersion; + } + + /** + * @return The iOS device which the contact is using. + */ + @JsonProperty("ios_device") + public Optional getIosDevice() { + return iosDevice; + } + + /** + * @return The version of iOS which the contact is using. + */ + @JsonProperty("ios_os_version") + public Optional getIosOsVersion() { + return iosOsVersion; + } + + /** + * @return The version of the iOS SDK which the contact is using. + */ + @JsonProperty("ios_sdk_version") + public Optional getIosSdkVersion() { + return iosSdkVersion; + } + + /** + * @return (UNIX timestamp) The last time the contact used the iOS app. + */ + @JsonProperty("ios_last_seen_at") + public Optional getIosLastSeenAt() { + return iosLastSeenAt; + } + + /** + * @return The custom attributes which are set for the contact. + */ + @JsonProperty("custom_attributes") + public Optional> getCustomAttributes() { + return customAttributes; + } + + /** + * @return An image URL containing the avatar of a contact. + */ + @JsonProperty("avatar") + public Optional getAvatar() { + return avatar; + } + + @JsonProperty("tags") + public Optional getTags() { + return tags; + } + + @JsonProperty("notes") + public Optional getNotes() { + return notes; + } + + @JsonProperty("companies") + public Optional getCompanies() { + return companies; + } + + @JsonProperty("location") + public Optional getLocation() { + return location; + } + + @JsonProperty("social_profiles") + public Optional getSocialProfiles() { + return socialProfiles; + } + + /** + * @return If the user has enabled push messaging. + */ + @JsonProperty("enabled_push_messaging") + public Optional getEnabledPushMessaging() { + return enabledPushMessaging; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof ContactsUpdateResponse && equalTo((ContactsUpdateResponse) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(ContactsUpdateResponse other) { + return id.equals(other.id) + && externalId.equals(other.externalId) + && workspaceId.equals(other.workspaceId) + && role.equals(other.role) + && email.equals(other.email) + && emailDomain.equals(other.emailDomain) + && phone.equals(other.phone) + && name.equals(other.name) + && ownerId.equals(other.ownerId) + && hasHardBounced == other.hasHardBounced + && markedEmailAsSpam == other.markedEmailAsSpam + && unsubscribedFromEmails == other.unsubscribedFromEmails + && createdAt == other.createdAt + && updatedAt == other.updatedAt + && signedUpAt.equals(other.signedUpAt) + && lastSeenAt.equals(other.lastSeenAt) + && lastRepliedAt.equals(other.lastRepliedAt) + && lastContactedAt.equals(other.lastContactedAt) + && lastEmailOpenedAt.equals(other.lastEmailOpenedAt) + && lastEmailClickedAt.equals(other.lastEmailClickedAt) + && languageOverride.equals(other.languageOverride) + && browser.equals(other.browser) + && browserVersion.equals(other.browserVersion) + && browserLanguage.equals(other.browserLanguage) + && os.equals(other.os) + && androidAppName.equals(other.androidAppName) + && androidAppVersion.equals(other.androidAppVersion) + && androidDevice.equals(other.androidDevice) + && androidOsVersion.equals(other.androidOsVersion) + && androidSdkVersion.equals(other.androidSdkVersion) + && androidLastSeenAt.equals(other.androidLastSeenAt) + && iosAppName.equals(other.iosAppName) + && iosAppVersion.equals(other.iosAppVersion) + && iosDevice.equals(other.iosDevice) + && iosOsVersion.equals(other.iosOsVersion) + && iosSdkVersion.equals(other.iosSdkVersion) + && iosLastSeenAt.equals(other.iosLastSeenAt) + && customAttributes.equals(other.customAttributes) + && avatar.equals(other.avatar) + && tags.equals(other.tags) + && notes.equals(other.notes) + && companies.equals(other.companies) + && location.equals(other.location) + && socialProfiles.equals(other.socialProfiles) + && enabledPushMessaging.equals(other.enabledPushMessaging); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash( + this.id, + this.externalId, + this.workspaceId, + this.role, + this.email, + this.emailDomain, + this.phone, + this.name, + this.ownerId, + this.hasHardBounced, + this.markedEmailAsSpam, + this.unsubscribedFromEmails, + this.createdAt, + this.updatedAt, + this.signedUpAt, + this.lastSeenAt, + this.lastRepliedAt, + this.lastContactedAt, + this.lastEmailOpenedAt, + this.lastEmailClickedAt, + this.languageOverride, + this.browser, + this.browserVersion, + this.browserLanguage, + this.os, + this.androidAppName, + this.androidAppVersion, + this.androidDevice, + this.androidOsVersion, + this.androidSdkVersion, + this.androidLastSeenAt, + this.iosAppName, + this.iosAppVersion, + this.iosDevice, + this.iosOsVersion, + this.iosSdkVersion, + this.iosLastSeenAt, + this.customAttributes, + this.avatar, + this.tags, + this.notes, + this.companies, + this.location, + this.socialProfiles, + this.enabledPushMessaging); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static IdStage builder() { + return new Builder(); + } + + public interface IdStage { + /** + *

The unique identifier for the contact which is given by Intercom.

+ */ + WorkspaceIdStage id(@NotNull String id); + + Builder from(ContactsUpdateResponse other); + } + + public interface WorkspaceIdStage { + /** + *

The id of the workspace which the contact belongs to.

+ */ + RoleStage workspaceId(@NotNull String workspaceId); + } + + public interface RoleStage { + /** + *

The role of the contact.

+ */ + HasHardBouncedStage role(@NotNull String role); + } + + public interface HasHardBouncedStage { + /** + *

Whether the contact has had an email sent to them hard bounce.

+ */ + MarkedEmailAsSpamStage hasHardBounced(boolean hasHardBounced); + } + + public interface MarkedEmailAsSpamStage { + /** + *

Whether the contact has marked an email sent to them as spam.

+ */ + UnsubscribedFromEmailsStage markedEmailAsSpam(boolean markedEmailAsSpam); + } + + public interface UnsubscribedFromEmailsStage { + /** + *

Whether the contact is unsubscribed from emails.

+ */ + CreatedAtStage unsubscribedFromEmails(boolean unsubscribedFromEmails); + } + + public interface CreatedAtStage { + /** + *

(UNIX timestamp) The time when the contact was created.

+ */ + UpdatedAtStage createdAt(int createdAt); + } + + public interface UpdatedAtStage { + /** + *

(UNIX timestamp) The time when the contact was last updated.

+ */ + _FinalStage updatedAt(int updatedAt); + } + + public interface _FinalStage { + ContactsUpdateResponse build(); + + /** + *

The unique identifier for the contact which is provided by the Client.

+ */ + _FinalStage externalId(Optional externalId); + + _FinalStage externalId(String externalId); + + /** + *

The contact's email.

+ */ + _FinalStage email(Optional email); + + _FinalStage email(String email); + + /** + *

The contact's email domain.

+ */ + _FinalStage emailDomain(Optional emailDomain); + + _FinalStage emailDomain(String emailDomain); + + /** + *

The contacts phone.

+ */ + _FinalStage phone(Optional phone); + + _FinalStage phone(String phone); + + /** + *

The contacts name.

+ */ + _FinalStage name(Optional name); + + _FinalStage name(String name); + + /** + *

The id of an admin that has been assigned account ownership of the contact.

+ */ + _FinalStage ownerId(Optional ownerId); + + _FinalStage ownerId(Integer ownerId); + + /** + *

(UNIX timestamp) The time specified for when a contact signed up.

+ */ + _FinalStage signedUpAt(Optional signedUpAt); + + _FinalStage signedUpAt(Integer signedUpAt); + + /** + *

(UNIX timestamp) The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually).

+ */ + _FinalStage lastSeenAt(Optional lastSeenAt); + + _FinalStage lastSeenAt(Integer lastSeenAt); + + /** + *

(UNIX timestamp) The time when the contact last messaged in.

+ */ + _FinalStage lastRepliedAt(Optional lastRepliedAt); + + _FinalStage lastRepliedAt(Integer lastRepliedAt); + + /** + *

(UNIX timestamp) The time when the contact was last messaged.

+ */ + _FinalStage lastContactedAt(Optional lastContactedAt); + + _FinalStage lastContactedAt(Integer lastContactedAt); + + /** + *

(UNIX timestamp) The time when the contact last opened an email.

+ */ + _FinalStage lastEmailOpenedAt(Optional lastEmailOpenedAt); + + _FinalStage lastEmailOpenedAt(Integer lastEmailOpenedAt); + + /** + *

(UNIX timestamp) The time when the contact last clicked a link in an email.

+ */ + _FinalStage lastEmailClickedAt(Optional lastEmailClickedAt); + + _FinalStage lastEmailClickedAt(Integer lastEmailClickedAt); + + /** + *

A preferred language setting for the contact, used by the Intercom Messenger even if their browser settings change.

+ */ + _FinalStage languageOverride(Optional languageOverride); + + _FinalStage languageOverride(String languageOverride); + + /** + *

The name of the browser which the contact is using.

+ */ + _FinalStage browser(Optional browser); + + _FinalStage browser(String browser); + + /** + *

The version of the browser which the contact is using.

+ */ + _FinalStage browserVersion(Optional browserVersion); + + _FinalStage browserVersion(String browserVersion); + + /** + *

The language set by the browser which the contact is using.

+ */ + _FinalStage browserLanguage(Optional browserLanguage); + + _FinalStage browserLanguage(String browserLanguage); + + /** + *

The operating system which the contact is using.

+ */ + _FinalStage os(Optional os); + + _FinalStage os(String os); + + /** + *

The name of the Android app which the contact is using.

+ */ + _FinalStage androidAppName(Optional androidAppName); + + _FinalStage androidAppName(String androidAppName); + + /** + *

The version of the Android app which the contact is using.

+ */ + _FinalStage androidAppVersion(Optional androidAppVersion); + + _FinalStage androidAppVersion(String androidAppVersion); + + /** + *

The Android device which the contact is using.

+ */ + _FinalStage androidDevice(Optional androidDevice); + + _FinalStage androidDevice(String androidDevice); + + /** + *

The version of the Android OS which the contact is using.

+ */ + _FinalStage androidOsVersion(Optional androidOsVersion); + + _FinalStage androidOsVersion(String androidOsVersion); + + /** + *

The version of the Android SDK which the contact is using.

+ */ + _FinalStage androidSdkVersion(Optional androidSdkVersion); + + _FinalStage androidSdkVersion(String androidSdkVersion); + + /** + *

(UNIX timestamp) The time when the contact was last seen on an Android device.

+ */ + _FinalStage androidLastSeenAt(Optional androidLastSeenAt); + + _FinalStage androidLastSeenAt(Integer androidLastSeenAt); + + /** + *

The name of the iOS app which the contact is using.

+ */ + _FinalStage iosAppName(Optional iosAppName); + + _FinalStage iosAppName(String iosAppName); + + /** + *

The version of the iOS app which the contact is using.

+ */ + _FinalStage iosAppVersion(Optional iosAppVersion); + + _FinalStage iosAppVersion(String iosAppVersion); + + /** + *

The iOS device which the contact is using.

+ */ + _FinalStage iosDevice(Optional iosDevice); + + _FinalStage iosDevice(String iosDevice); + + /** + *

The version of iOS which the contact is using.

+ */ + _FinalStage iosOsVersion(Optional iosOsVersion); + + _FinalStage iosOsVersion(String iosOsVersion); + + /** + *

The version of the iOS SDK which the contact is using.

+ */ + _FinalStage iosSdkVersion(Optional iosSdkVersion); + + _FinalStage iosSdkVersion(String iosSdkVersion); + + /** + *

(UNIX timestamp) The last time the contact used the iOS app.

+ */ + _FinalStage iosLastSeenAt(Optional iosLastSeenAt); + + _FinalStage iosLastSeenAt(Integer iosLastSeenAt); + + /** + *

The custom attributes which are set for the contact.

+ */ + _FinalStage customAttributes(Optional> customAttributes); + + _FinalStage customAttributes(Map customAttributes); + + /** + *

An image URL containing the avatar of a contact.

+ */ + _FinalStage avatar(Optional avatar); + + _FinalStage avatar(String avatar); + + _FinalStage tags(Optional tags); + + _FinalStage tags(ContactTags tags); + + _FinalStage notes(Optional notes); + + _FinalStage notes(ContactNotes notes); + + _FinalStage companies(Optional companies); + + _FinalStage companies(ContactCompanies companies); + + _FinalStage location(Optional location); + + _FinalStage location(ContactLocation location); + + _FinalStage socialProfiles(Optional socialProfiles); + + _FinalStage socialProfiles(ContactSocialProfiles socialProfiles); + + /** + *

If the user has enabled push messaging.

+ */ + _FinalStage enabledPushMessaging(Optional enabledPushMessaging); + + _FinalStage enabledPushMessaging(Boolean enabledPushMessaging); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder + implements IdStage, + WorkspaceIdStage, + RoleStage, + HasHardBouncedStage, + MarkedEmailAsSpamStage, + UnsubscribedFromEmailsStage, + CreatedAtStage, + UpdatedAtStage, + _FinalStage { + private String id; + + private String workspaceId; + + private String role; + + private boolean hasHardBounced; + + private boolean markedEmailAsSpam; + + private boolean unsubscribedFromEmails; + + private int createdAt; + + private int updatedAt; + + private Optional enabledPushMessaging = Optional.empty(); + + private Optional socialProfiles = Optional.empty(); + + private Optional location = Optional.empty(); + + private Optional companies = Optional.empty(); + + private Optional notes = Optional.empty(); + + private Optional tags = Optional.empty(); + + private Optional avatar = Optional.empty(); + + private Optional> customAttributes = Optional.empty(); + + private Optional iosLastSeenAt = Optional.empty(); + + private Optional iosSdkVersion = Optional.empty(); + + private Optional iosOsVersion = Optional.empty(); + + private Optional iosDevice = Optional.empty(); + + private Optional iosAppVersion = Optional.empty(); + + private Optional iosAppName = Optional.empty(); + + private Optional androidLastSeenAt = Optional.empty(); + + private Optional androidSdkVersion = Optional.empty(); + + private Optional androidOsVersion = Optional.empty(); + + private Optional androidDevice = Optional.empty(); + + private Optional androidAppVersion = Optional.empty(); + + private Optional androidAppName = Optional.empty(); + + private Optional os = Optional.empty(); + + private Optional browserLanguage = Optional.empty(); + + private Optional browserVersion = Optional.empty(); + + private Optional browser = Optional.empty(); + + private Optional languageOverride = Optional.empty(); + + private Optional lastEmailClickedAt = Optional.empty(); + + private Optional lastEmailOpenedAt = Optional.empty(); + + private Optional lastContactedAt = Optional.empty(); + + private Optional lastRepliedAt = Optional.empty(); + + private Optional lastSeenAt = Optional.empty(); + + private Optional signedUpAt = Optional.empty(); + + private Optional ownerId = Optional.empty(); + + private Optional name = Optional.empty(); + + private Optional phone = Optional.empty(); + + private Optional emailDomain = Optional.empty(); + + private Optional email = Optional.empty(); + + private Optional externalId = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(ContactsUpdateResponse other) { + id(other.getId()); + externalId(other.getExternalId()); + workspaceId(other.getWorkspaceId()); + role(other.getRole()); + email(other.getEmail()); + emailDomain(other.getEmailDomain()); + phone(other.getPhone()); + name(other.getName()); + ownerId(other.getOwnerId()); + hasHardBounced(other.getHasHardBounced()); + markedEmailAsSpam(other.getMarkedEmailAsSpam()); + unsubscribedFromEmails(other.getUnsubscribedFromEmails()); + createdAt(other.getCreatedAt()); + updatedAt(other.getUpdatedAt()); + signedUpAt(other.getSignedUpAt()); + lastSeenAt(other.getLastSeenAt()); + lastRepliedAt(other.getLastRepliedAt()); + lastContactedAt(other.getLastContactedAt()); + lastEmailOpenedAt(other.getLastEmailOpenedAt()); + lastEmailClickedAt(other.getLastEmailClickedAt()); + languageOverride(other.getLanguageOverride()); + browser(other.getBrowser()); + browserVersion(other.getBrowserVersion()); + browserLanguage(other.getBrowserLanguage()); + os(other.getOs()); + androidAppName(other.getAndroidAppName()); + androidAppVersion(other.getAndroidAppVersion()); + androidDevice(other.getAndroidDevice()); + androidOsVersion(other.getAndroidOsVersion()); + androidSdkVersion(other.getAndroidSdkVersion()); + androidLastSeenAt(other.getAndroidLastSeenAt()); + iosAppName(other.getIosAppName()); + iosAppVersion(other.getIosAppVersion()); + iosDevice(other.getIosDevice()); + iosOsVersion(other.getIosOsVersion()); + iosSdkVersion(other.getIosSdkVersion()); + iosLastSeenAt(other.getIosLastSeenAt()); + customAttributes(other.getCustomAttributes()); + avatar(other.getAvatar()); + tags(other.getTags()); + notes(other.getNotes()); + companies(other.getCompanies()); + location(other.getLocation()); + socialProfiles(other.getSocialProfiles()); + enabledPushMessaging(other.getEnabledPushMessaging()); + return this; + } + + /** + *

The unique identifier for the contact which is given by Intercom.

+ *

The unique identifier for the contact which is given by Intercom.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("id") + public WorkspaceIdStage id(@NotNull String id) { + this.id = Objects.requireNonNull(id, "id must not be null"); + return this; + } + + /** + *

The id of the workspace which the contact belongs to.

+ *

The id of the workspace which the contact belongs to.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("workspace_id") + public RoleStage workspaceId(@NotNull String workspaceId) { + this.workspaceId = Objects.requireNonNull(workspaceId, "workspaceId must not be null"); + return this; + } + + /** + *

The role of the contact.

+ *

The role of the contact.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("role") + public HasHardBouncedStage role(@NotNull String role) { + this.role = Objects.requireNonNull(role, "role must not be null"); + return this; + } + + /** + *

Whether the contact has had an email sent to them hard bounce.

+ *

Whether the contact has had an email sent to them hard bounce.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("has_hard_bounced") + public MarkedEmailAsSpamStage hasHardBounced(boolean hasHardBounced) { + this.hasHardBounced = hasHardBounced; + return this; + } + + /** + *

Whether the contact has marked an email sent to them as spam.

+ *

Whether the contact has marked an email sent to them as spam.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("marked_email_as_spam") + public UnsubscribedFromEmailsStage markedEmailAsSpam(boolean markedEmailAsSpam) { + this.markedEmailAsSpam = markedEmailAsSpam; + return this; + } + + /** + *

Whether the contact is unsubscribed from emails.

+ *

Whether the contact is unsubscribed from emails.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("unsubscribed_from_emails") + public CreatedAtStage unsubscribedFromEmails(boolean unsubscribedFromEmails) { + this.unsubscribedFromEmails = unsubscribedFromEmails; + return this; + } + + /** + *

(UNIX timestamp) The time when the contact was created.

+ *

(UNIX timestamp) The time when the contact was created.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("created_at") + public UpdatedAtStage createdAt(int createdAt) { + this.createdAt = createdAt; + return this; + } + + /** + *

(UNIX timestamp) The time when the contact was last updated.

+ *

(UNIX timestamp) The time when the contact was last updated.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("updated_at") + public _FinalStage updatedAt(int updatedAt) { + this.updatedAt = updatedAt; + return this; + } + + /** + *

If the user has enabled push messaging.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage enabledPushMessaging(Boolean enabledPushMessaging) { + this.enabledPushMessaging = Optional.ofNullable(enabledPushMessaging); + return this; + } + + /** + *

If the user has enabled push messaging.

+ */ + @java.lang.Override + @JsonSetter(value = "enabled_push_messaging", nulls = Nulls.SKIP) + public _FinalStage enabledPushMessaging(Optional enabledPushMessaging) { + this.enabledPushMessaging = enabledPushMessaging; + return this; + } + + @java.lang.Override + public _FinalStage socialProfiles(ContactSocialProfiles socialProfiles) { + this.socialProfiles = Optional.ofNullable(socialProfiles); + return this; + } + + @java.lang.Override + @JsonSetter(value = "social_profiles", nulls = Nulls.SKIP) + public _FinalStage socialProfiles(Optional socialProfiles) { + this.socialProfiles = socialProfiles; + return this; + } + + @java.lang.Override + public _FinalStage location(ContactLocation location) { + this.location = Optional.ofNullable(location); + return this; + } + + @java.lang.Override + @JsonSetter(value = "location", nulls = Nulls.SKIP) + public _FinalStage location(Optional location) { + this.location = location; + return this; + } + + @java.lang.Override + public _FinalStage companies(ContactCompanies companies) { + this.companies = Optional.ofNullable(companies); + return this; + } + + @java.lang.Override + @JsonSetter(value = "companies", nulls = Nulls.SKIP) + public _FinalStage companies(Optional companies) { + this.companies = companies; + return this; + } + + @java.lang.Override + public _FinalStage notes(ContactNotes notes) { + this.notes = Optional.ofNullable(notes); + return this; + } + + @java.lang.Override + @JsonSetter(value = "notes", nulls = Nulls.SKIP) + public _FinalStage notes(Optional notes) { + this.notes = notes; + return this; + } + + @java.lang.Override + public _FinalStage tags(ContactTags tags) { + this.tags = Optional.ofNullable(tags); + return this; + } + + @java.lang.Override + @JsonSetter(value = "tags", nulls = Nulls.SKIP) + public _FinalStage tags(Optional tags) { + this.tags = tags; + return this; + } + + /** + *

An image URL containing the avatar of a contact.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage avatar(String avatar) { + this.avatar = Optional.ofNullable(avatar); + return this; + } + + /** + *

An image URL containing the avatar of a contact.

+ */ + @java.lang.Override + @JsonSetter(value = "avatar", nulls = Nulls.SKIP) + public _FinalStage avatar(Optional avatar) { + this.avatar = avatar; + return this; + } + + /** + *

The custom attributes which are set for the contact.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage customAttributes(Map customAttributes) { + this.customAttributes = Optional.ofNullable(customAttributes); + return this; + } + + /** + *

The custom attributes which are set for the contact.

+ */ + @java.lang.Override + @JsonSetter(value = "custom_attributes", nulls = Nulls.SKIP) + public _FinalStage customAttributes(Optional> customAttributes) { + this.customAttributes = customAttributes; + return this; + } + + /** + *

(UNIX timestamp) The last time the contact used the iOS app.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage iosLastSeenAt(Integer iosLastSeenAt) { + this.iosLastSeenAt = Optional.ofNullable(iosLastSeenAt); + return this; + } + + /** + *

(UNIX timestamp) The last time the contact used the iOS app.

+ */ + @java.lang.Override + @JsonSetter(value = "ios_last_seen_at", nulls = Nulls.SKIP) + public _FinalStage iosLastSeenAt(Optional iosLastSeenAt) { + this.iosLastSeenAt = iosLastSeenAt; + return this; + } + + /** + *

The version of the iOS SDK which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage iosSdkVersion(String iosSdkVersion) { + this.iosSdkVersion = Optional.ofNullable(iosSdkVersion); + return this; + } + + /** + *

The version of the iOS SDK which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "ios_sdk_version", nulls = Nulls.SKIP) + public _FinalStage iosSdkVersion(Optional iosSdkVersion) { + this.iosSdkVersion = iosSdkVersion; + return this; + } + + /** + *

The version of iOS which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage iosOsVersion(String iosOsVersion) { + this.iosOsVersion = Optional.ofNullable(iosOsVersion); + return this; + } + + /** + *

The version of iOS which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "ios_os_version", nulls = Nulls.SKIP) + public _FinalStage iosOsVersion(Optional iosOsVersion) { + this.iosOsVersion = iosOsVersion; + return this; + } + + /** + *

The iOS device which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage iosDevice(String iosDevice) { + this.iosDevice = Optional.ofNullable(iosDevice); + return this; + } + + /** + *

The iOS device which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "ios_device", nulls = Nulls.SKIP) + public _FinalStage iosDevice(Optional iosDevice) { + this.iosDevice = iosDevice; + return this; + } + + /** + *

The version of the iOS app which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage iosAppVersion(String iosAppVersion) { + this.iosAppVersion = Optional.ofNullable(iosAppVersion); + return this; + } + + /** + *

The version of the iOS app which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "ios_app_version", nulls = Nulls.SKIP) + public _FinalStage iosAppVersion(Optional iosAppVersion) { + this.iosAppVersion = iosAppVersion; + return this; + } + + /** + *

The name of the iOS app which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage iosAppName(String iosAppName) { + this.iosAppName = Optional.ofNullable(iosAppName); + return this; + } + + /** + *

The name of the iOS app which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "ios_app_name", nulls = Nulls.SKIP) + public _FinalStage iosAppName(Optional iosAppName) { + this.iosAppName = iosAppName; + return this; + } + + /** + *

(UNIX timestamp) The time when the contact was last seen on an Android device.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage androidLastSeenAt(Integer androidLastSeenAt) { + this.androidLastSeenAt = Optional.ofNullable(androidLastSeenAt); + return this; + } + + /** + *

(UNIX timestamp) The time when the contact was last seen on an Android device.

+ */ + @java.lang.Override + @JsonSetter(value = "android_last_seen_at", nulls = Nulls.SKIP) + public _FinalStage androidLastSeenAt(Optional androidLastSeenAt) { + this.androidLastSeenAt = androidLastSeenAt; + return this; + } + + /** + *

The version of the Android SDK which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage androidSdkVersion(String androidSdkVersion) { + this.androidSdkVersion = Optional.ofNullable(androidSdkVersion); + return this; + } + + /** + *

The version of the Android SDK which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "android_sdk_version", nulls = Nulls.SKIP) + public _FinalStage androidSdkVersion(Optional androidSdkVersion) { + this.androidSdkVersion = androidSdkVersion; + return this; + } + + /** + *

The version of the Android OS which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage androidOsVersion(String androidOsVersion) { + this.androidOsVersion = Optional.ofNullable(androidOsVersion); + return this; + } + + /** + *

The version of the Android OS which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "android_os_version", nulls = Nulls.SKIP) + public _FinalStage androidOsVersion(Optional androidOsVersion) { + this.androidOsVersion = androidOsVersion; + return this; + } + + /** + *

The Android device which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage androidDevice(String androidDevice) { + this.androidDevice = Optional.ofNullable(androidDevice); + return this; + } + + /** + *

The Android device which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "android_device", nulls = Nulls.SKIP) + public _FinalStage androidDevice(Optional androidDevice) { + this.androidDevice = androidDevice; + return this; + } + + /** + *

The version of the Android app which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage androidAppVersion(String androidAppVersion) { + this.androidAppVersion = Optional.ofNullable(androidAppVersion); + return this; + } + + /** + *

The version of the Android app which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "android_app_version", nulls = Nulls.SKIP) + public _FinalStage androidAppVersion(Optional androidAppVersion) { + this.androidAppVersion = androidAppVersion; + return this; + } + + /** + *

The name of the Android app which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage androidAppName(String androidAppName) { + this.androidAppName = Optional.ofNullable(androidAppName); + return this; + } + + /** + *

The name of the Android app which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "android_app_name", nulls = Nulls.SKIP) + public _FinalStage androidAppName(Optional androidAppName) { + this.androidAppName = androidAppName; + return this; + } + + /** + *

The operating system which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage os(String os) { + this.os = Optional.ofNullable(os); + return this; + } + + /** + *

The operating system which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "os", nulls = Nulls.SKIP) + public _FinalStage os(Optional os) { + this.os = os; + return this; + } + + /** + *

The language set by the browser which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage browserLanguage(String browserLanguage) { + this.browserLanguage = Optional.ofNullable(browserLanguage); + return this; + } + + /** + *

The language set by the browser which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "browser_language", nulls = Nulls.SKIP) + public _FinalStage browserLanguage(Optional browserLanguage) { + this.browserLanguage = browserLanguage; + return this; + } + + /** + *

The version of the browser which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage browserVersion(String browserVersion) { + this.browserVersion = Optional.ofNullable(browserVersion); + return this; + } + + /** + *

The version of the browser which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "browser_version", nulls = Nulls.SKIP) + public _FinalStage browserVersion(Optional browserVersion) { + this.browserVersion = browserVersion; + return this; + } + + /** + *

The name of the browser which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage browser(String browser) { + this.browser = Optional.ofNullable(browser); + return this; + } + + /** + *

The name of the browser which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "browser", nulls = Nulls.SKIP) + public _FinalStage browser(Optional browser) { + this.browser = browser; + return this; + } + + /** + *

A preferred language setting for the contact, used by the Intercom Messenger even if their browser settings change.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage languageOverride(String languageOverride) { + this.languageOverride = Optional.ofNullable(languageOverride); + return this; + } + + /** + *

A preferred language setting for the contact, used by the Intercom Messenger even if their browser settings change.

+ */ + @java.lang.Override + @JsonSetter(value = "language_override", nulls = Nulls.SKIP) + public _FinalStage languageOverride(Optional languageOverride) { + this.languageOverride = languageOverride; + return this; + } + + /** + *

(UNIX timestamp) The time when the contact last clicked a link in an email.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage lastEmailClickedAt(Integer lastEmailClickedAt) { + this.lastEmailClickedAt = Optional.ofNullable(lastEmailClickedAt); + return this; + } + + /** + *

(UNIX timestamp) The time when the contact last clicked a link in an email.

+ */ + @java.lang.Override + @JsonSetter(value = "last_email_clicked_at", nulls = Nulls.SKIP) + public _FinalStage lastEmailClickedAt(Optional lastEmailClickedAt) { + this.lastEmailClickedAt = lastEmailClickedAt; + return this; + } + + /** + *

(UNIX timestamp) The time when the contact last opened an email.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage lastEmailOpenedAt(Integer lastEmailOpenedAt) { + this.lastEmailOpenedAt = Optional.ofNullable(lastEmailOpenedAt); + return this; + } + + /** + *

(UNIX timestamp) The time when the contact last opened an email.

+ */ + @java.lang.Override + @JsonSetter(value = "last_email_opened_at", nulls = Nulls.SKIP) + public _FinalStage lastEmailOpenedAt(Optional lastEmailOpenedAt) { + this.lastEmailOpenedAt = lastEmailOpenedAt; + return this; + } + + /** + *

(UNIX timestamp) The time when the contact was last messaged.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage lastContactedAt(Integer lastContactedAt) { + this.lastContactedAt = Optional.ofNullable(lastContactedAt); + return this; + } + + /** + *

(UNIX timestamp) The time when the contact was last messaged.

+ */ + @java.lang.Override + @JsonSetter(value = "last_contacted_at", nulls = Nulls.SKIP) + public _FinalStage lastContactedAt(Optional lastContactedAt) { + this.lastContactedAt = lastContactedAt; + return this; + } + + /** + *

(UNIX timestamp) The time when the contact last messaged in.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage lastRepliedAt(Integer lastRepliedAt) { + this.lastRepliedAt = Optional.ofNullable(lastRepliedAt); + return this; + } + + /** + *

(UNIX timestamp) The time when the contact last messaged in.

+ */ + @java.lang.Override + @JsonSetter(value = "last_replied_at", nulls = Nulls.SKIP) + public _FinalStage lastRepliedAt(Optional lastRepliedAt) { + this.lastRepliedAt = lastRepliedAt; + return this; + } + + /** + *

(UNIX timestamp) The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually).

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage lastSeenAt(Integer lastSeenAt) { + this.lastSeenAt = Optional.ofNullable(lastSeenAt); + return this; + } + + /** + *

(UNIX timestamp) The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually).

+ */ + @java.lang.Override + @JsonSetter(value = "last_seen_at", nulls = Nulls.SKIP) + public _FinalStage lastSeenAt(Optional lastSeenAt) { + this.lastSeenAt = lastSeenAt; + return this; + } + + /** + *

(UNIX timestamp) The time specified for when a contact signed up.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage signedUpAt(Integer signedUpAt) { + this.signedUpAt = Optional.ofNullable(signedUpAt); + return this; + } + + /** + *

(UNIX timestamp) The time specified for when a contact signed up.

+ */ + @java.lang.Override + @JsonSetter(value = "signed_up_at", nulls = Nulls.SKIP) + public _FinalStage signedUpAt(Optional signedUpAt) { + this.signedUpAt = signedUpAt; + return this; + } + + /** + *

The id of an admin that has been assigned account ownership of the contact.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage ownerId(Integer ownerId) { + this.ownerId = Optional.ofNullable(ownerId); + return this; + } + + /** + *

The id of an admin that has been assigned account ownership of the contact.

+ */ + @java.lang.Override + @JsonSetter(value = "owner_id", nulls = Nulls.SKIP) + public _FinalStage ownerId(Optional ownerId) { + this.ownerId = ownerId; + return this; + } + + /** + *

The contacts name.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage name(String name) { + this.name = Optional.ofNullable(name); + return this; + } + + /** + *

The contacts name.

+ */ + @java.lang.Override + @JsonSetter(value = "name", nulls = Nulls.SKIP) + public _FinalStage name(Optional name) { + this.name = name; + return this; + } + + /** + *

The contacts phone.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage phone(String phone) { + this.phone = Optional.ofNullable(phone); + return this; + } + + /** + *

The contacts phone.

+ */ + @java.lang.Override + @JsonSetter(value = "phone", nulls = Nulls.SKIP) + public _FinalStage phone(Optional phone) { + this.phone = phone; + return this; + } + + /** + *

The contact's email domain.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage emailDomain(String emailDomain) { + this.emailDomain = Optional.ofNullable(emailDomain); + return this; + } + + /** + *

The contact's email domain.

+ */ + @java.lang.Override + @JsonSetter(value = "email_domain", nulls = Nulls.SKIP) + public _FinalStage emailDomain(Optional emailDomain) { + this.emailDomain = emailDomain; + return this; + } + + /** + *

The contact's email.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage email(String email) { + this.email = Optional.ofNullable(email); + return this; + } + + /** + *

The contact's email.

+ */ + @java.lang.Override + @JsonSetter(value = "email", nulls = Nulls.SKIP) + public _FinalStage email(Optional email) { + this.email = email; + return this; + } + + /** + *

The unique identifier for the contact which is provided by the Client.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage externalId(String externalId) { + this.externalId = Optional.ofNullable(externalId); + return this; + } + + /** + *

The unique identifier for the contact which is provided by the Client.

+ */ + @java.lang.Override + @JsonSetter(value = "external_id", nulls = Nulls.SKIP) + public _FinalStage externalId(Optional externalId) { + this.externalId = externalId; + return this; + } + + @java.lang.Override + public ContactsUpdateResponse build() { + return new ContactsUpdateResponse( + id, + externalId, + workspaceId, + role, + email, + emailDomain, + phone, + name, + ownerId, + hasHardBounced, + markedEmailAsSpam, + unsubscribedFromEmails, + createdAt, + updatedAt, + signedUpAt, + lastSeenAt, + lastRepliedAt, + lastContactedAt, + lastEmailOpenedAt, + lastEmailClickedAt, + languageOverride, + browser, + browserVersion, + browserLanguage, + os, + androidAppName, + androidAppVersion, + androidDevice, + androidOsVersion, + androidSdkVersion, + androidLastSeenAt, + iosAppName, + iosAppVersion, + iosDevice, + iosOsVersion, + iosSdkVersion, + iosLastSeenAt, + customAttributes, + avatar, + tags, + notes, + companies, + location, + socialProfiles, + enabledPushMessaging, + additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/contacts/types/IContact.java b/src/main/java/com/intercom/api/resources/contacts/types/IContact.java new file mode 100644 index 00000000..946900a2 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/contacts/types/IContact.java @@ -0,0 +1,104 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.contacts.types; + +import com.intercom.api.types.ContactCompanies; +import com.intercom.api.types.ContactLocation; +import com.intercom.api.types.ContactNotes; +import com.intercom.api.types.ContactSocialProfiles; +import com.intercom.api.types.ContactTags; +import java.util.Map; +import java.util.Optional; + +public interface IContact { + String getType(); + + String getId(); + + Optional getExternalId(); + + String getWorkspaceId(); + + String getRole(); + + Optional getEmail(); + + Optional getEmailDomain(); + + Optional getPhone(); + + Optional getName(); + + Optional getOwnerId(); + + boolean getHasHardBounced(); + + boolean getMarkedEmailAsSpam(); + + boolean getUnsubscribedFromEmails(); + + int getCreatedAt(); + + int getUpdatedAt(); + + Optional getSignedUpAt(); + + Optional getLastSeenAt(); + + Optional getLastRepliedAt(); + + Optional getLastContactedAt(); + + Optional getLastEmailOpenedAt(); + + Optional getLastEmailClickedAt(); + + Optional getLanguageOverride(); + + Optional getBrowser(); + + Optional getBrowserVersion(); + + Optional getBrowserLanguage(); + + Optional getOs(); + + Optional getAndroidAppName(); + + Optional getAndroidAppVersion(); + + Optional getAndroidDevice(); + + Optional getAndroidOsVersion(); + + Optional getAndroidSdkVersion(); + + Optional getAndroidLastSeenAt(); + + Optional getIosAppName(); + + Optional getIosAppVersion(); + + Optional getIosDevice(); + + Optional getIosOsVersion(); + + Optional getIosSdkVersion(); + + Optional getIosLastSeenAt(); + + Optional> getCustomAttributes(); + + Optional getAvatar(); + + Optional getTags(); + + Optional getNotes(); + + Optional getCompanies(); + + Optional getLocation(); + + Optional getSocialProfiles(); +} diff --git a/src/main/java/com/intercom/api/resources/contacts/types/ShowContactByExternalIdResponse.java b/src/main/java/com/intercom/api/resources/contacts/types/ShowContactByExternalIdResponse.java new file mode 100644 index 00000000..c75919f3 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/contacts/types/ShowContactByExternalIdResponse.java @@ -0,0 +1,2001 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.contacts.types; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.types.ContactCompanies; +import com.intercom.api.types.ContactLocation; +import com.intercom.api.types.ContactNotes; +import com.intercom.api.types.ContactSocialProfiles; +import com.intercom.api.types.ContactTags; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = ShowContactByExternalIdResponse.Builder.class) +public final class ShowContactByExternalIdResponse implements IContact { + private final String id; + + private final Optional externalId; + + private final String workspaceId; + + private final String role; + + private final Optional email; + + private final Optional emailDomain; + + private final Optional phone; + + private final Optional name; + + private final Optional ownerId; + + private final boolean hasHardBounced; + + private final boolean markedEmailAsSpam; + + private final boolean unsubscribedFromEmails; + + private final int createdAt; + + private final int updatedAt; + + private final Optional signedUpAt; + + private final Optional lastSeenAt; + + private final Optional lastRepliedAt; + + private final Optional lastContactedAt; + + private final Optional lastEmailOpenedAt; + + private final Optional lastEmailClickedAt; + + private final Optional languageOverride; + + private final Optional browser; + + private final Optional browserVersion; + + private final Optional browserLanguage; + + private final Optional os; + + private final Optional androidAppName; + + private final Optional androidAppVersion; + + private final Optional androidDevice; + + private final Optional androidOsVersion; + + private final Optional androidSdkVersion; + + private final Optional androidLastSeenAt; + + private final Optional iosAppName; + + private final Optional iosAppVersion; + + private final Optional iosDevice; + + private final Optional iosOsVersion; + + private final Optional iosSdkVersion; + + private final Optional iosLastSeenAt; + + private final Optional> customAttributes; + + private final Optional avatar; + + private final Optional tags; + + private final Optional notes; + + private final Optional companies; + + private final Optional location; + + private final Optional socialProfiles; + + private final Optional enabledPushMessaging; + + private final Map additionalProperties; + + private ShowContactByExternalIdResponse( + String id, + Optional externalId, + String workspaceId, + String role, + Optional email, + Optional emailDomain, + Optional phone, + Optional name, + Optional ownerId, + boolean hasHardBounced, + boolean markedEmailAsSpam, + boolean unsubscribedFromEmails, + int createdAt, + int updatedAt, + Optional signedUpAt, + Optional lastSeenAt, + Optional lastRepliedAt, + Optional lastContactedAt, + Optional lastEmailOpenedAt, + Optional lastEmailClickedAt, + Optional languageOverride, + Optional browser, + Optional browserVersion, + Optional browserLanguage, + Optional os, + Optional androidAppName, + Optional androidAppVersion, + Optional androidDevice, + Optional androidOsVersion, + Optional androidSdkVersion, + Optional androidLastSeenAt, + Optional iosAppName, + Optional iosAppVersion, + Optional iosDevice, + Optional iosOsVersion, + Optional iosSdkVersion, + Optional iosLastSeenAt, + Optional> customAttributes, + Optional avatar, + Optional tags, + Optional notes, + Optional companies, + Optional location, + Optional socialProfiles, + Optional enabledPushMessaging, + Map additionalProperties) { + this.id = id; + this.externalId = externalId; + this.workspaceId = workspaceId; + this.role = role; + this.email = email; + this.emailDomain = emailDomain; + this.phone = phone; + this.name = name; + this.ownerId = ownerId; + this.hasHardBounced = hasHardBounced; + this.markedEmailAsSpam = markedEmailAsSpam; + this.unsubscribedFromEmails = unsubscribedFromEmails; + this.createdAt = createdAt; + this.updatedAt = updatedAt; + this.signedUpAt = signedUpAt; + this.lastSeenAt = lastSeenAt; + this.lastRepliedAt = lastRepliedAt; + this.lastContactedAt = lastContactedAt; + this.lastEmailOpenedAt = lastEmailOpenedAt; + this.lastEmailClickedAt = lastEmailClickedAt; + this.languageOverride = languageOverride; + this.browser = browser; + this.browserVersion = browserVersion; + this.browserLanguage = browserLanguage; + this.os = os; + this.androidAppName = androidAppName; + this.androidAppVersion = androidAppVersion; + this.androidDevice = androidDevice; + this.androidOsVersion = androidOsVersion; + this.androidSdkVersion = androidSdkVersion; + this.androidLastSeenAt = androidLastSeenAt; + this.iosAppName = iosAppName; + this.iosAppVersion = iosAppVersion; + this.iosDevice = iosDevice; + this.iosOsVersion = iosOsVersion; + this.iosSdkVersion = iosSdkVersion; + this.iosLastSeenAt = iosLastSeenAt; + this.customAttributes = customAttributes; + this.avatar = avatar; + this.tags = tags; + this.notes = notes; + this.companies = companies; + this.location = location; + this.socialProfiles = socialProfiles; + this.enabledPushMessaging = enabledPushMessaging; + this.additionalProperties = additionalProperties; + } + + /** + * @return The type of object. + */ + @JsonProperty("type") + public String getType() { + return "contact"; + } + + /** + * @return The unique identifier for the contact which is given by Intercom. + */ + @JsonProperty("id") + public String getId() { + return id; + } + + /** + * @return The unique identifier for the contact which is provided by the Client. + */ + @JsonProperty("external_id") + public Optional getExternalId() { + return externalId; + } + + /** + * @return The id of the workspace which the contact belongs to. + */ + @JsonProperty("workspace_id") + public String getWorkspaceId() { + return workspaceId; + } + + /** + * @return The role of the contact. + */ + @JsonProperty("role") + public String getRole() { + return role; + } + + /** + * @return The contact's email. + */ + @JsonProperty("email") + public Optional getEmail() { + return email; + } + + /** + * @return The contact's email domain. + */ + @JsonProperty("email_domain") + public Optional getEmailDomain() { + return emailDomain; + } + + /** + * @return The contacts phone. + */ + @JsonProperty("phone") + public Optional getPhone() { + return phone; + } + + /** + * @return The contacts name. + */ + @JsonProperty("name") + public Optional getName() { + return name; + } + + /** + * @return The id of an admin that has been assigned account ownership of the contact. + */ + @JsonProperty("owner_id") + public Optional getOwnerId() { + return ownerId; + } + + /** + * @return Whether the contact has had an email sent to them hard bounce. + */ + @JsonProperty("has_hard_bounced") + public boolean getHasHardBounced() { + return hasHardBounced; + } + + /** + * @return Whether the contact has marked an email sent to them as spam. + */ + @JsonProperty("marked_email_as_spam") + public boolean getMarkedEmailAsSpam() { + return markedEmailAsSpam; + } + + /** + * @return Whether the contact is unsubscribed from emails. + */ + @JsonProperty("unsubscribed_from_emails") + public boolean getUnsubscribedFromEmails() { + return unsubscribedFromEmails; + } + + /** + * @return (UNIX timestamp) The time when the contact was created. + */ + @JsonProperty("created_at") + public int getCreatedAt() { + return createdAt; + } + + /** + * @return (UNIX timestamp) The time when the contact was last updated. + */ + @JsonProperty("updated_at") + public int getUpdatedAt() { + return updatedAt; + } + + /** + * @return (UNIX timestamp) The time specified for when a contact signed up. + */ + @JsonProperty("signed_up_at") + public Optional getSignedUpAt() { + return signedUpAt; + } + + /** + * @return (UNIX timestamp) The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually). + */ + @JsonProperty("last_seen_at") + public Optional getLastSeenAt() { + return lastSeenAt; + } + + /** + * @return (UNIX timestamp) The time when the contact last messaged in. + */ + @JsonProperty("last_replied_at") + public Optional getLastRepliedAt() { + return lastRepliedAt; + } + + /** + * @return (UNIX timestamp) The time when the contact was last messaged. + */ + @JsonProperty("last_contacted_at") + public Optional getLastContactedAt() { + return lastContactedAt; + } + + /** + * @return (UNIX timestamp) The time when the contact last opened an email. + */ + @JsonProperty("last_email_opened_at") + public Optional getLastEmailOpenedAt() { + return lastEmailOpenedAt; + } + + /** + * @return (UNIX timestamp) The time when the contact last clicked a link in an email. + */ + @JsonProperty("last_email_clicked_at") + public Optional getLastEmailClickedAt() { + return lastEmailClickedAt; + } + + /** + * @return A preferred language setting for the contact, used by the Intercom Messenger even if their browser settings change. + */ + @JsonProperty("language_override") + public Optional getLanguageOverride() { + return languageOverride; + } + + /** + * @return The name of the browser which the contact is using. + */ + @JsonProperty("browser") + public Optional getBrowser() { + return browser; + } + + /** + * @return The version of the browser which the contact is using. + */ + @JsonProperty("browser_version") + public Optional getBrowserVersion() { + return browserVersion; + } + + /** + * @return The language set by the browser which the contact is using. + */ + @JsonProperty("browser_language") + public Optional getBrowserLanguage() { + return browserLanguage; + } + + /** + * @return The operating system which the contact is using. + */ + @JsonProperty("os") + public Optional getOs() { + return os; + } + + /** + * @return The name of the Android app which the contact is using. + */ + @JsonProperty("android_app_name") + public Optional getAndroidAppName() { + return androidAppName; + } + + /** + * @return The version of the Android app which the contact is using. + */ + @JsonProperty("android_app_version") + public Optional getAndroidAppVersion() { + return androidAppVersion; + } + + /** + * @return The Android device which the contact is using. + */ + @JsonProperty("android_device") + public Optional getAndroidDevice() { + return androidDevice; + } + + /** + * @return The version of the Android OS which the contact is using. + */ + @JsonProperty("android_os_version") + public Optional getAndroidOsVersion() { + return androidOsVersion; + } + + /** + * @return The version of the Android SDK which the contact is using. + */ + @JsonProperty("android_sdk_version") + public Optional getAndroidSdkVersion() { + return androidSdkVersion; + } + + /** + * @return (UNIX timestamp) The time when the contact was last seen on an Android device. + */ + @JsonProperty("android_last_seen_at") + public Optional getAndroidLastSeenAt() { + return androidLastSeenAt; + } + + /** + * @return The name of the iOS app which the contact is using. + */ + @JsonProperty("ios_app_name") + public Optional getIosAppName() { + return iosAppName; + } + + /** + * @return The version of the iOS app which the contact is using. + */ + @JsonProperty("ios_app_version") + public Optional getIosAppVersion() { + return iosAppVersion; + } + + /** + * @return The iOS device which the contact is using. + */ + @JsonProperty("ios_device") + public Optional getIosDevice() { + return iosDevice; + } + + /** + * @return The version of iOS which the contact is using. + */ + @JsonProperty("ios_os_version") + public Optional getIosOsVersion() { + return iosOsVersion; + } + + /** + * @return The version of the iOS SDK which the contact is using. + */ + @JsonProperty("ios_sdk_version") + public Optional getIosSdkVersion() { + return iosSdkVersion; + } + + /** + * @return (UNIX timestamp) The last time the contact used the iOS app. + */ + @JsonProperty("ios_last_seen_at") + public Optional getIosLastSeenAt() { + return iosLastSeenAt; + } + + /** + * @return The custom attributes which are set for the contact. + */ + @JsonProperty("custom_attributes") + public Optional> getCustomAttributes() { + return customAttributes; + } + + /** + * @return An image URL containing the avatar of a contact. + */ + @JsonProperty("avatar") + public Optional getAvatar() { + return avatar; + } + + @JsonProperty("tags") + public Optional getTags() { + return tags; + } + + @JsonProperty("notes") + public Optional getNotes() { + return notes; + } + + @JsonProperty("companies") + public Optional getCompanies() { + return companies; + } + + @JsonProperty("location") + public Optional getLocation() { + return location; + } + + @JsonProperty("social_profiles") + public Optional getSocialProfiles() { + return socialProfiles; + } + + /** + * @return If the user has enabled push messaging. + */ + @JsonProperty("enabled_push_messaging") + public Optional getEnabledPushMessaging() { + return enabledPushMessaging; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof ShowContactByExternalIdResponse && equalTo((ShowContactByExternalIdResponse) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(ShowContactByExternalIdResponse other) { + return id.equals(other.id) + && externalId.equals(other.externalId) + && workspaceId.equals(other.workspaceId) + && role.equals(other.role) + && email.equals(other.email) + && emailDomain.equals(other.emailDomain) + && phone.equals(other.phone) + && name.equals(other.name) + && ownerId.equals(other.ownerId) + && hasHardBounced == other.hasHardBounced + && markedEmailAsSpam == other.markedEmailAsSpam + && unsubscribedFromEmails == other.unsubscribedFromEmails + && createdAt == other.createdAt + && updatedAt == other.updatedAt + && signedUpAt.equals(other.signedUpAt) + && lastSeenAt.equals(other.lastSeenAt) + && lastRepliedAt.equals(other.lastRepliedAt) + && lastContactedAt.equals(other.lastContactedAt) + && lastEmailOpenedAt.equals(other.lastEmailOpenedAt) + && lastEmailClickedAt.equals(other.lastEmailClickedAt) + && languageOverride.equals(other.languageOverride) + && browser.equals(other.browser) + && browserVersion.equals(other.browserVersion) + && browserLanguage.equals(other.browserLanguage) + && os.equals(other.os) + && androidAppName.equals(other.androidAppName) + && androidAppVersion.equals(other.androidAppVersion) + && androidDevice.equals(other.androidDevice) + && androidOsVersion.equals(other.androidOsVersion) + && androidSdkVersion.equals(other.androidSdkVersion) + && androidLastSeenAt.equals(other.androidLastSeenAt) + && iosAppName.equals(other.iosAppName) + && iosAppVersion.equals(other.iosAppVersion) + && iosDevice.equals(other.iosDevice) + && iosOsVersion.equals(other.iosOsVersion) + && iosSdkVersion.equals(other.iosSdkVersion) + && iosLastSeenAt.equals(other.iosLastSeenAt) + && customAttributes.equals(other.customAttributes) + && avatar.equals(other.avatar) + && tags.equals(other.tags) + && notes.equals(other.notes) + && companies.equals(other.companies) + && location.equals(other.location) + && socialProfiles.equals(other.socialProfiles) + && enabledPushMessaging.equals(other.enabledPushMessaging); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash( + this.id, + this.externalId, + this.workspaceId, + this.role, + this.email, + this.emailDomain, + this.phone, + this.name, + this.ownerId, + this.hasHardBounced, + this.markedEmailAsSpam, + this.unsubscribedFromEmails, + this.createdAt, + this.updatedAt, + this.signedUpAt, + this.lastSeenAt, + this.lastRepliedAt, + this.lastContactedAt, + this.lastEmailOpenedAt, + this.lastEmailClickedAt, + this.languageOverride, + this.browser, + this.browserVersion, + this.browserLanguage, + this.os, + this.androidAppName, + this.androidAppVersion, + this.androidDevice, + this.androidOsVersion, + this.androidSdkVersion, + this.androidLastSeenAt, + this.iosAppName, + this.iosAppVersion, + this.iosDevice, + this.iosOsVersion, + this.iosSdkVersion, + this.iosLastSeenAt, + this.customAttributes, + this.avatar, + this.tags, + this.notes, + this.companies, + this.location, + this.socialProfiles, + this.enabledPushMessaging); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static IdStage builder() { + return new Builder(); + } + + public interface IdStage { + /** + *

The unique identifier for the contact which is given by Intercom.

+ */ + WorkspaceIdStage id(@NotNull String id); + + Builder from(ShowContactByExternalIdResponse other); + } + + public interface WorkspaceIdStage { + /** + *

The id of the workspace which the contact belongs to.

+ */ + RoleStage workspaceId(@NotNull String workspaceId); + } + + public interface RoleStage { + /** + *

The role of the contact.

+ */ + HasHardBouncedStage role(@NotNull String role); + } + + public interface HasHardBouncedStage { + /** + *

Whether the contact has had an email sent to them hard bounce.

+ */ + MarkedEmailAsSpamStage hasHardBounced(boolean hasHardBounced); + } + + public interface MarkedEmailAsSpamStage { + /** + *

Whether the contact has marked an email sent to them as spam.

+ */ + UnsubscribedFromEmailsStage markedEmailAsSpam(boolean markedEmailAsSpam); + } + + public interface UnsubscribedFromEmailsStage { + /** + *

Whether the contact is unsubscribed from emails.

+ */ + CreatedAtStage unsubscribedFromEmails(boolean unsubscribedFromEmails); + } + + public interface CreatedAtStage { + /** + *

(UNIX timestamp) The time when the contact was created.

+ */ + UpdatedAtStage createdAt(int createdAt); + } + + public interface UpdatedAtStage { + /** + *

(UNIX timestamp) The time when the contact was last updated.

+ */ + _FinalStage updatedAt(int updatedAt); + } + + public interface _FinalStage { + ShowContactByExternalIdResponse build(); + + /** + *

The unique identifier for the contact which is provided by the Client.

+ */ + _FinalStage externalId(Optional externalId); + + _FinalStage externalId(String externalId); + + /** + *

The contact's email.

+ */ + _FinalStage email(Optional email); + + _FinalStage email(String email); + + /** + *

The contact's email domain.

+ */ + _FinalStage emailDomain(Optional emailDomain); + + _FinalStage emailDomain(String emailDomain); + + /** + *

The contacts phone.

+ */ + _FinalStage phone(Optional phone); + + _FinalStage phone(String phone); + + /** + *

The contacts name.

+ */ + _FinalStage name(Optional name); + + _FinalStage name(String name); + + /** + *

The id of an admin that has been assigned account ownership of the contact.

+ */ + _FinalStage ownerId(Optional ownerId); + + _FinalStage ownerId(Integer ownerId); + + /** + *

(UNIX timestamp) The time specified for when a contact signed up.

+ */ + _FinalStage signedUpAt(Optional signedUpAt); + + _FinalStage signedUpAt(Integer signedUpAt); + + /** + *

(UNIX timestamp) The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually).

+ */ + _FinalStage lastSeenAt(Optional lastSeenAt); + + _FinalStage lastSeenAt(Integer lastSeenAt); + + /** + *

(UNIX timestamp) The time when the contact last messaged in.

+ */ + _FinalStage lastRepliedAt(Optional lastRepliedAt); + + _FinalStage lastRepliedAt(Integer lastRepliedAt); + + /** + *

(UNIX timestamp) The time when the contact was last messaged.

+ */ + _FinalStage lastContactedAt(Optional lastContactedAt); + + _FinalStage lastContactedAt(Integer lastContactedAt); + + /** + *

(UNIX timestamp) The time when the contact last opened an email.

+ */ + _FinalStage lastEmailOpenedAt(Optional lastEmailOpenedAt); + + _FinalStage lastEmailOpenedAt(Integer lastEmailOpenedAt); + + /** + *

(UNIX timestamp) The time when the contact last clicked a link in an email.

+ */ + _FinalStage lastEmailClickedAt(Optional lastEmailClickedAt); + + _FinalStage lastEmailClickedAt(Integer lastEmailClickedAt); + + /** + *

A preferred language setting for the contact, used by the Intercom Messenger even if their browser settings change.

+ */ + _FinalStage languageOverride(Optional languageOverride); + + _FinalStage languageOverride(String languageOverride); + + /** + *

The name of the browser which the contact is using.

+ */ + _FinalStage browser(Optional browser); + + _FinalStage browser(String browser); + + /** + *

The version of the browser which the contact is using.

+ */ + _FinalStage browserVersion(Optional browserVersion); + + _FinalStage browserVersion(String browserVersion); + + /** + *

The language set by the browser which the contact is using.

+ */ + _FinalStage browserLanguage(Optional browserLanguage); + + _FinalStage browserLanguage(String browserLanguage); + + /** + *

The operating system which the contact is using.

+ */ + _FinalStage os(Optional os); + + _FinalStage os(String os); + + /** + *

The name of the Android app which the contact is using.

+ */ + _FinalStage androidAppName(Optional androidAppName); + + _FinalStage androidAppName(String androidAppName); + + /** + *

The version of the Android app which the contact is using.

+ */ + _FinalStage androidAppVersion(Optional androidAppVersion); + + _FinalStage androidAppVersion(String androidAppVersion); + + /** + *

The Android device which the contact is using.

+ */ + _FinalStage androidDevice(Optional androidDevice); + + _FinalStage androidDevice(String androidDevice); + + /** + *

The version of the Android OS which the contact is using.

+ */ + _FinalStage androidOsVersion(Optional androidOsVersion); + + _FinalStage androidOsVersion(String androidOsVersion); + + /** + *

The version of the Android SDK which the contact is using.

+ */ + _FinalStage androidSdkVersion(Optional androidSdkVersion); + + _FinalStage androidSdkVersion(String androidSdkVersion); + + /** + *

(UNIX timestamp) The time when the contact was last seen on an Android device.

+ */ + _FinalStage androidLastSeenAt(Optional androidLastSeenAt); + + _FinalStage androidLastSeenAt(Integer androidLastSeenAt); + + /** + *

The name of the iOS app which the contact is using.

+ */ + _FinalStage iosAppName(Optional iosAppName); + + _FinalStage iosAppName(String iosAppName); + + /** + *

The version of the iOS app which the contact is using.

+ */ + _FinalStage iosAppVersion(Optional iosAppVersion); + + _FinalStage iosAppVersion(String iosAppVersion); + + /** + *

The iOS device which the contact is using.

+ */ + _FinalStage iosDevice(Optional iosDevice); + + _FinalStage iosDevice(String iosDevice); + + /** + *

The version of iOS which the contact is using.

+ */ + _FinalStage iosOsVersion(Optional iosOsVersion); + + _FinalStage iosOsVersion(String iosOsVersion); + + /** + *

The version of the iOS SDK which the contact is using.

+ */ + _FinalStage iosSdkVersion(Optional iosSdkVersion); + + _FinalStage iosSdkVersion(String iosSdkVersion); + + /** + *

(UNIX timestamp) The last time the contact used the iOS app.

+ */ + _FinalStage iosLastSeenAt(Optional iosLastSeenAt); + + _FinalStage iosLastSeenAt(Integer iosLastSeenAt); + + /** + *

The custom attributes which are set for the contact.

+ */ + _FinalStage customAttributes(Optional> customAttributes); + + _FinalStage customAttributes(Map customAttributes); + + /** + *

An image URL containing the avatar of a contact.

+ */ + _FinalStage avatar(Optional avatar); + + _FinalStage avatar(String avatar); + + _FinalStage tags(Optional tags); + + _FinalStage tags(ContactTags tags); + + _FinalStage notes(Optional notes); + + _FinalStage notes(ContactNotes notes); + + _FinalStage companies(Optional companies); + + _FinalStage companies(ContactCompanies companies); + + _FinalStage location(Optional location); + + _FinalStage location(ContactLocation location); + + _FinalStage socialProfiles(Optional socialProfiles); + + _FinalStage socialProfiles(ContactSocialProfiles socialProfiles); + + /** + *

If the user has enabled push messaging.

+ */ + _FinalStage enabledPushMessaging(Optional enabledPushMessaging); + + _FinalStage enabledPushMessaging(Boolean enabledPushMessaging); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder + implements IdStage, + WorkspaceIdStage, + RoleStage, + HasHardBouncedStage, + MarkedEmailAsSpamStage, + UnsubscribedFromEmailsStage, + CreatedAtStage, + UpdatedAtStage, + _FinalStage { + private String id; + + private String workspaceId; + + private String role; + + private boolean hasHardBounced; + + private boolean markedEmailAsSpam; + + private boolean unsubscribedFromEmails; + + private int createdAt; + + private int updatedAt; + + private Optional enabledPushMessaging = Optional.empty(); + + private Optional socialProfiles = Optional.empty(); + + private Optional location = Optional.empty(); + + private Optional companies = Optional.empty(); + + private Optional notes = Optional.empty(); + + private Optional tags = Optional.empty(); + + private Optional avatar = Optional.empty(); + + private Optional> customAttributes = Optional.empty(); + + private Optional iosLastSeenAt = Optional.empty(); + + private Optional iosSdkVersion = Optional.empty(); + + private Optional iosOsVersion = Optional.empty(); + + private Optional iosDevice = Optional.empty(); + + private Optional iosAppVersion = Optional.empty(); + + private Optional iosAppName = Optional.empty(); + + private Optional androidLastSeenAt = Optional.empty(); + + private Optional androidSdkVersion = Optional.empty(); + + private Optional androidOsVersion = Optional.empty(); + + private Optional androidDevice = Optional.empty(); + + private Optional androidAppVersion = Optional.empty(); + + private Optional androidAppName = Optional.empty(); + + private Optional os = Optional.empty(); + + private Optional browserLanguage = Optional.empty(); + + private Optional browserVersion = Optional.empty(); + + private Optional browser = Optional.empty(); + + private Optional languageOverride = Optional.empty(); + + private Optional lastEmailClickedAt = Optional.empty(); + + private Optional lastEmailOpenedAt = Optional.empty(); + + private Optional lastContactedAt = Optional.empty(); + + private Optional lastRepliedAt = Optional.empty(); + + private Optional lastSeenAt = Optional.empty(); + + private Optional signedUpAt = Optional.empty(); + + private Optional ownerId = Optional.empty(); + + private Optional name = Optional.empty(); + + private Optional phone = Optional.empty(); + + private Optional emailDomain = Optional.empty(); + + private Optional email = Optional.empty(); + + private Optional externalId = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(ShowContactByExternalIdResponse other) { + id(other.getId()); + externalId(other.getExternalId()); + workspaceId(other.getWorkspaceId()); + role(other.getRole()); + email(other.getEmail()); + emailDomain(other.getEmailDomain()); + phone(other.getPhone()); + name(other.getName()); + ownerId(other.getOwnerId()); + hasHardBounced(other.getHasHardBounced()); + markedEmailAsSpam(other.getMarkedEmailAsSpam()); + unsubscribedFromEmails(other.getUnsubscribedFromEmails()); + createdAt(other.getCreatedAt()); + updatedAt(other.getUpdatedAt()); + signedUpAt(other.getSignedUpAt()); + lastSeenAt(other.getLastSeenAt()); + lastRepliedAt(other.getLastRepliedAt()); + lastContactedAt(other.getLastContactedAt()); + lastEmailOpenedAt(other.getLastEmailOpenedAt()); + lastEmailClickedAt(other.getLastEmailClickedAt()); + languageOverride(other.getLanguageOverride()); + browser(other.getBrowser()); + browserVersion(other.getBrowserVersion()); + browserLanguage(other.getBrowserLanguage()); + os(other.getOs()); + androidAppName(other.getAndroidAppName()); + androidAppVersion(other.getAndroidAppVersion()); + androidDevice(other.getAndroidDevice()); + androidOsVersion(other.getAndroidOsVersion()); + androidSdkVersion(other.getAndroidSdkVersion()); + androidLastSeenAt(other.getAndroidLastSeenAt()); + iosAppName(other.getIosAppName()); + iosAppVersion(other.getIosAppVersion()); + iosDevice(other.getIosDevice()); + iosOsVersion(other.getIosOsVersion()); + iosSdkVersion(other.getIosSdkVersion()); + iosLastSeenAt(other.getIosLastSeenAt()); + customAttributes(other.getCustomAttributes()); + avatar(other.getAvatar()); + tags(other.getTags()); + notes(other.getNotes()); + companies(other.getCompanies()); + location(other.getLocation()); + socialProfiles(other.getSocialProfiles()); + enabledPushMessaging(other.getEnabledPushMessaging()); + return this; + } + + /** + *

The unique identifier for the contact which is given by Intercom.

+ *

The unique identifier for the contact which is given by Intercom.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("id") + public WorkspaceIdStage id(@NotNull String id) { + this.id = Objects.requireNonNull(id, "id must not be null"); + return this; + } + + /** + *

The id of the workspace which the contact belongs to.

+ *

The id of the workspace which the contact belongs to.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("workspace_id") + public RoleStage workspaceId(@NotNull String workspaceId) { + this.workspaceId = Objects.requireNonNull(workspaceId, "workspaceId must not be null"); + return this; + } + + /** + *

The role of the contact.

+ *

The role of the contact.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("role") + public HasHardBouncedStage role(@NotNull String role) { + this.role = Objects.requireNonNull(role, "role must not be null"); + return this; + } + + /** + *

Whether the contact has had an email sent to them hard bounce.

+ *

Whether the contact has had an email sent to them hard bounce.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("has_hard_bounced") + public MarkedEmailAsSpamStage hasHardBounced(boolean hasHardBounced) { + this.hasHardBounced = hasHardBounced; + return this; + } + + /** + *

Whether the contact has marked an email sent to them as spam.

+ *

Whether the contact has marked an email sent to them as spam.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("marked_email_as_spam") + public UnsubscribedFromEmailsStage markedEmailAsSpam(boolean markedEmailAsSpam) { + this.markedEmailAsSpam = markedEmailAsSpam; + return this; + } + + /** + *

Whether the contact is unsubscribed from emails.

+ *

Whether the contact is unsubscribed from emails.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("unsubscribed_from_emails") + public CreatedAtStage unsubscribedFromEmails(boolean unsubscribedFromEmails) { + this.unsubscribedFromEmails = unsubscribedFromEmails; + return this; + } + + /** + *

(UNIX timestamp) The time when the contact was created.

+ *

(UNIX timestamp) The time when the contact was created.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("created_at") + public UpdatedAtStage createdAt(int createdAt) { + this.createdAt = createdAt; + return this; + } + + /** + *

(UNIX timestamp) The time when the contact was last updated.

+ *

(UNIX timestamp) The time when the contact was last updated.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("updated_at") + public _FinalStage updatedAt(int updatedAt) { + this.updatedAt = updatedAt; + return this; + } + + /** + *

If the user has enabled push messaging.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage enabledPushMessaging(Boolean enabledPushMessaging) { + this.enabledPushMessaging = Optional.ofNullable(enabledPushMessaging); + return this; + } + + /** + *

If the user has enabled push messaging.

+ */ + @java.lang.Override + @JsonSetter(value = "enabled_push_messaging", nulls = Nulls.SKIP) + public _FinalStage enabledPushMessaging(Optional enabledPushMessaging) { + this.enabledPushMessaging = enabledPushMessaging; + return this; + } + + @java.lang.Override + public _FinalStage socialProfiles(ContactSocialProfiles socialProfiles) { + this.socialProfiles = Optional.ofNullable(socialProfiles); + return this; + } + + @java.lang.Override + @JsonSetter(value = "social_profiles", nulls = Nulls.SKIP) + public _FinalStage socialProfiles(Optional socialProfiles) { + this.socialProfiles = socialProfiles; + return this; + } + + @java.lang.Override + public _FinalStage location(ContactLocation location) { + this.location = Optional.ofNullable(location); + return this; + } + + @java.lang.Override + @JsonSetter(value = "location", nulls = Nulls.SKIP) + public _FinalStage location(Optional location) { + this.location = location; + return this; + } + + @java.lang.Override + public _FinalStage companies(ContactCompanies companies) { + this.companies = Optional.ofNullable(companies); + return this; + } + + @java.lang.Override + @JsonSetter(value = "companies", nulls = Nulls.SKIP) + public _FinalStage companies(Optional companies) { + this.companies = companies; + return this; + } + + @java.lang.Override + public _FinalStage notes(ContactNotes notes) { + this.notes = Optional.ofNullable(notes); + return this; + } + + @java.lang.Override + @JsonSetter(value = "notes", nulls = Nulls.SKIP) + public _FinalStage notes(Optional notes) { + this.notes = notes; + return this; + } + + @java.lang.Override + public _FinalStage tags(ContactTags tags) { + this.tags = Optional.ofNullable(tags); + return this; + } + + @java.lang.Override + @JsonSetter(value = "tags", nulls = Nulls.SKIP) + public _FinalStage tags(Optional tags) { + this.tags = tags; + return this; + } + + /** + *

An image URL containing the avatar of a contact.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage avatar(String avatar) { + this.avatar = Optional.ofNullable(avatar); + return this; + } + + /** + *

An image URL containing the avatar of a contact.

+ */ + @java.lang.Override + @JsonSetter(value = "avatar", nulls = Nulls.SKIP) + public _FinalStage avatar(Optional avatar) { + this.avatar = avatar; + return this; + } + + /** + *

The custom attributes which are set for the contact.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage customAttributes(Map customAttributes) { + this.customAttributes = Optional.ofNullable(customAttributes); + return this; + } + + /** + *

The custom attributes which are set for the contact.

+ */ + @java.lang.Override + @JsonSetter(value = "custom_attributes", nulls = Nulls.SKIP) + public _FinalStage customAttributes(Optional> customAttributes) { + this.customAttributes = customAttributes; + return this; + } + + /** + *

(UNIX timestamp) The last time the contact used the iOS app.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage iosLastSeenAt(Integer iosLastSeenAt) { + this.iosLastSeenAt = Optional.ofNullable(iosLastSeenAt); + return this; + } + + /** + *

(UNIX timestamp) The last time the contact used the iOS app.

+ */ + @java.lang.Override + @JsonSetter(value = "ios_last_seen_at", nulls = Nulls.SKIP) + public _FinalStage iosLastSeenAt(Optional iosLastSeenAt) { + this.iosLastSeenAt = iosLastSeenAt; + return this; + } + + /** + *

The version of the iOS SDK which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage iosSdkVersion(String iosSdkVersion) { + this.iosSdkVersion = Optional.ofNullable(iosSdkVersion); + return this; + } + + /** + *

The version of the iOS SDK which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "ios_sdk_version", nulls = Nulls.SKIP) + public _FinalStage iosSdkVersion(Optional iosSdkVersion) { + this.iosSdkVersion = iosSdkVersion; + return this; + } + + /** + *

The version of iOS which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage iosOsVersion(String iosOsVersion) { + this.iosOsVersion = Optional.ofNullable(iosOsVersion); + return this; + } + + /** + *

The version of iOS which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "ios_os_version", nulls = Nulls.SKIP) + public _FinalStage iosOsVersion(Optional iosOsVersion) { + this.iosOsVersion = iosOsVersion; + return this; + } + + /** + *

The iOS device which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage iosDevice(String iosDevice) { + this.iosDevice = Optional.ofNullable(iosDevice); + return this; + } + + /** + *

The iOS device which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "ios_device", nulls = Nulls.SKIP) + public _FinalStage iosDevice(Optional iosDevice) { + this.iosDevice = iosDevice; + return this; + } + + /** + *

The version of the iOS app which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage iosAppVersion(String iosAppVersion) { + this.iosAppVersion = Optional.ofNullable(iosAppVersion); + return this; + } + + /** + *

The version of the iOS app which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "ios_app_version", nulls = Nulls.SKIP) + public _FinalStage iosAppVersion(Optional iosAppVersion) { + this.iosAppVersion = iosAppVersion; + return this; + } + + /** + *

The name of the iOS app which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage iosAppName(String iosAppName) { + this.iosAppName = Optional.ofNullable(iosAppName); + return this; + } + + /** + *

The name of the iOS app which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "ios_app_name", nulls = Nulls.SKIP) + public _FinalStage iosAppName(Optional iosAppName) { + this.iosAppName = iosAppName; + return this; + } + + /** + *

(UNIX timestamp) The time when the contact was last seen on an Android device.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage androidLastSeenAt(Integer androidLastSeenAt) { + this.androidLastSeenAt = Optional.ofNullable(androidLastSeenAt); + return this; + } + + /** + *

(UNIX timestamp) The time when the contact was last seen on an Android device.

+ */ + @java.lang.Override + @JsonSetter(value = "android_last_seen_at", nulls = Nulls.SKIP) + public _FinalStage androidLastSeenAt(Optional androidLastSeenAt) { + this.androidLastSeenAt = androidLastSeenAt; + return this; + } + + /** + *

The version of the Android SDK which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage androidSdkVersion(String androidSdkVersion) { + this.androidSdkVersion = Optional.ofNullable(androidSdkVersion); + return this; + } + + /** + *

The version of the Android SDK which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "android_sdk_version", nulls = Nulls.SKIP) + public _FinalStage androidSdkVersion(Optional androidSdkVersion) { + this.androidSdkVersion = androidSdkVersion; + return this; + } + + /** + *

The version of the Android OS which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage androidOsVersion(String androidOsVersion) { + this.androidOsVersion = Optional.ofNullable(androidOsVersion); + return this; + } + + /** + *

The version of the Android OS which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "android_os_version", nulls = Nulls.SKIP) + public _FinalStage androidOsVersion(Optional androidOsVersion) { + this.androidOsVersion = androidOsVersion; + return this; + } + + /** + *

The Android device which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage androidDevice(String androidDevice) { + this.androidDevice = Optional.ofNullable(androidDevice); + return this; + } + + /** + *

The Android device which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "android_device", nulls = Nulls.SKIP) + public _FinalStage androidDevice(Optional androidDevice) { + this.androidDevice = androidDevice; + return this; + } + + /** + *

The version of the Android app which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage androidAppVersion(String androidAppVersion) { + this.androidAppVersion = Optional.ofNullable(androidAppVersion); + return this; + } + + /** + *

The version of the Android app which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "android_app_version", nulls = Nulls.SKIP) + public _FinalStage androidAppVersion(Optional androidAppVersion) { + this.androidAppVersion = androidAppVersion; + return this; + } + + /** + *

The name of the Android app which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage androidAppName(String androidAppName) { + this.androidAppName = Optional.ofNullable(androidAppName); + return this; + } + + /** + *

The name of the Android app which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "android_app_name", nulls = Nulls.SKIP) + public _FinalStage androidAppName(Optional androidAppName) { + this.androidAppName = androidAppName; + return this; + } + + /** + *

The operating system which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage os(String os) { + this.os = Optional.ofNullable(os); + return this; + } + + /** + *

The operating system which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "os", nulls = Nulls.SKIP) + public _FinalStage os(Optional os) { + this.os = os; + return this; + } + + /** + *

The language set by the browser which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage browserLanguage(String browserLanguage) { + this.browserLanguage = Optional.ofNullable(browserLanguage); + return this; + } + + /** + *

The language set by the browser which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "browser_language", nulls = Nulls.SKIP) + public _FinalStage browserLanguage(Optional browserLanguage) { + this.browserLanguage = browserLanguage; + return this; + } + + /** + *

The version of the browser which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage browserVersion(String browserVersion) { + this.browserVersion = Optional.ofNullable(browserVersion); + return this; + } + + /** + *

The version of the browser which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "browser_version", nulls = Nulls.SKIP) + public _FinalStage browserVersion(Optional browserVersion) { + this.browserVersion = browserVersion; + return this; + } + + /** + *

The name of the browser which the contact is using.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage browser(String browser) { + this.browser = Optional.ofNullable(browser); + return this; + } + + /** + *

The name of the browser which the contact is using.

+ */ + @java.lang.Override + @JsonSetter(value = "browser", nulls = Nulls.SKIP) + public _FinalStage browser(Optional browser) { + this.browser = browser; + return this; + } + + /** + *

A preferred language setting for the contact, used by the Intercom Messenger even if their browser settings change.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage languageOverride(String languageOverride) { + this.languageOverride = Optional.ofNullable(languageOverride); + return this; + } + + /** + *

A preferred language setting for the contact, used by the Intercom Messenger even if their browser settings change.

+ */ + @java.lang.Override + @JsonSetter(value = "language_override", nulls = Nulls.SKIP) + public _FinalStage languageOverride(Optional languageOverride) { + this.languageOverride = languageOverride; + return this; + } + + /** + *

(UNIX timestamp) The time when the contact last clicked a link in an email.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage lastEmailClickedAt(Integer lastEmailClickedAt) { + this.lastEmailClickedAt = Optional.ofNullable(lastEmailClickedAt); + return this; + } + + /** + *

(UNIX timestamp) The time when the contact last clicked a link in an email.

+ */ + @java.lang.Override + @JsonSetter(value = "last_email_clicked_at", nulls = Nulls.SKIP) + public _FinalStage lastEmailClickedAt(Optional lastEmailClickedAt) { + this.lastEmailClickedAt = lastEmailClickedAt; + return this; + } + + /** + *

(UNIX timestamp) The time when the contact last opened an email.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage lastEmailOpenedAt(Integer lastEmailOpenedAt) { + this.lastEmailOpenedAt = Optional.ofNullable(lastEmailOpenedAt); + return this; + } + + /** + *

(UNIX timestamp) The time when the contact last opened an email.

+ */ + @java.lang.Override + @JsonSetter(value = "last_email_opened_at", nulls = Nulls.SKIP) + public _FinalStage lastEmailOpenedAt(Optional lastEmailOpenedAt) { + this.lastEmailOpenedAt = lastEmailOpenedAt; + return this; + } + + /** + *

(UNIX timestamp) The time when the contact was last messaged.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage lastContactedAt(Integer lastContactedAt) { + this.lastContactedAt = Optional.ofNullable(lastContactedAt); + return this; + } + + /** + *

(UNIX timestamp) The time when the contact was last messaged.

+ */ + @java.lang.Override + @JsonSetter(value = "last_contacted_at", nulls = Nulls.SKIP) + public _FinalStage lastContactedAt(Optional lastContactedAt) { + this.lastContactedAt = lastContactedAt; + return this; + } + + /** + *

(UNIX timestamp) The time when the contact last messaged in.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage lastRepliedAt(Integer lastRepliedAt) { + this.lastRepliedAt = Optional.ofNullable(lastRepliedAt); + return this; + } + + /** + *

(UNIX timestamp) The time when the contact last messaged in.

+ */ + @java.lang.Override + @JsonSetter(value = "last_replied_at", nulls = Nulls.SKIP) + public _FinalStage lastRepliedAt(Optional lastRepliedAt) { + this.lastRepliedAt = lastRepliedAt; + return this; + } + + /** + *

(UNIX timestamp) The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually).

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage lastSeenAt(Integer lastSeenAt) { + this.lastSeenAt = Optional.ofNullable(lastSeenAt); + return this; + } + + /** + *

(UNIX timestamp) The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually).

+ */ + @java.lang.Override + @JsonSetter(value = "last_seen_at", nulls = Nulls.SKIP) + public _FinalStage lastSeenAt(Optional lastSeenAt) { + this.lastSeenAt = lastSeenAt; + return this; + } + + /** + *

(UNIX timestamp) The time specified for when a contact signed up.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage signedUpAt(Integer signedUpAt) { + this.signedUpAt = Optional.ofNullable(signedUpAt); + return this; + } + + /** + *

(UNIX timestamp) The time specified for when a contact signed up.

+ */ + @java.lang.Override + @JsonSetter(value = "signed_up_at", nulls = Nulls.SKIP) + public _FinalStage signedUpAt(Optional signedUpAt) { + this.signedUpAt = signedUpAt; + return this; + } + + /** + *

The id of an admin that has been assigned account ownership of the contact.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage ownerId(Integer ownerId) { + this.ownerId = Optional.ofNullable(ownerId); + return this; + } + + /** + *

The id of an admin that has been assigned account ownership of the contact.

+ */ + @java.lang.Override + @JsonSetter(value = "owner_id", nulls = Nulls.SKIP) + public _FinalStage ownerId(Optional ownerId) { + this.ownerId = ownerId; + return this; + } + + /** + *

The contacts name.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage name(String name) { + this.name = Optional.ofNullable(name); + return this; + } + + /** + *

The contacts name.

+ */ + @java.lang.Override + @JsonSetter(value = "name", nulls = Nulls.SKIP) + public _FinalStage name(Optional name) { + this.name = name; + return this; + } + + /** + *

The contacts phone.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage phone(String phone) { + this.phone = Optional.ofNullable(phone); + return this; + } + + /** + *

The contacts phone.

+ */ + @java.lang.Override + @JsonSetter(value = "phone", nulls = Nulls.SKIP) + public _FinalStage phone(Optional phone) { + this.phone = phone; + return this; + } + + /** + *

The contact's email domain.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage emailDomain(String emailDomain) { + this.emailDomain = Optional.ofNullable(emailDomain); + return this; + } + + /** + *

The contact's email domain.

+ */ + @java.lang.Override + @JsonSetter(value = "email_domain", nulls = Nulls.SKIP) + public _FinalStage emailDomain(Optional emailDomain) { + this.emailDomain = emailDomain; + return this; + } + + /** + *

The contact's email.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage email(String email) { + this.email = Optional.ofNullable(email); + return this; + } + + /** + *

The contact's email.

+ */ + @java.lang.Override + @JsonSetter(value = "email", nulls = Nulls.SKIP) + public _FinalStage email(Optional email) { + this.email = email; + return this; + } + + /** + *

The unique identifier for the contact which is provided by the Client.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage externalId(String externalId) { + this.externalId = Optional.ofNullable(externalId); + return this; + } + + /** + *

The unique identifier for the contact which is provided by the Client.

+ */ + @java.lang.Override + @JsonSetter(value = "external_id", nulls = Nulls.SKIP) + public _FinalStage externalId(Optional externalId) { + this.externalId = externalId; + return this; + } + + @java.lang.Override + public ShowContactByExternalIdResponse build() { + return new ShowContactByExternalIdResponse( + id, + externalId, + workspaceId, + role, + email, + emailDomain, + phone, + name, + ownerId, + hasHardBounced, + markedEmailAsSpam, + unsubscribedFromEmails, + createdAt, + updatedAt, + signedUpAt, + lastSeenAt, + lastRepliedAt, + lastContactedAt, + lastEmailOpenedAt, + lastEmailClickedAt, + languageOverride, + browser, + browserVersion, + browserLanguage, + os, + androidAppName, + androidAppVersion, + androidDevice, + androidOsVersion, + androidSdkVersion, + androidLastSeenAt, + iosAppName, + iosAppVersion, + iosDevice, + iosOsVersion, + iosSdkVersion, + iosLastSeenAt, + customAttributes, + avatar, + tags, + notes, + companies, + location, + socialProfiles, + enabledPushMessaging, + additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/conversations/AsyncConversationsClient.java b/src/main/java/com/intercom/api/resources/conversations/AsyncConversationsClient.java new file mode 100644 index 00000000..acb67a90 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/conversations/AsyncConversationsClient.java @@ -0,0 +1,516 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.conversations; + +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.core.pagination.SyncPagingIterable; +import com.intercom.api.resources.conversations.requests.AttachContactToConversationRequest; +import com.intercom.api.resources.conversations.requests.AutoAssignConversationRequest; +import com.intercom.api.resources.conversations.requests.ConvertConversationToTicketRequest; +import com.intercom.api.resources.conversations.requests.CreateConversationRequest; +import com.intercom.api.resources.conversations.requests.DeleteConversationRequest; +import com.intercom.api.resources.conversations.requests.DetachContactFromConversationRequest; +import com.intercom.api.resources.conversations.requests.FindConversationRequest; +import com.intercom.api.resources.conversations.requests.ListConversationsRequest; +import com.intercom.api.resources.conversations.requests.ManageConversationPartsRequest; +import com.intercom.api.resources.conversations.requests.ReplyToConversationRequest; +import com.intercom.api.resources.conversations.requests.UpdateConversationRequest; +import com.intercom.api.resources.conversations.types.Conversation; +import com.intercom.api.resources.messages.types.Message; +import com.intercom.api.resources.tickets.types.Ticket; +import com.intercom.api.types.ConversationDeleted; +import com.intercom.api.types.RedactConversationRequest; +import com.intercom.api.types.SearchRequest; +import java.util.Optional; +import java.util.concurrent.CompletableFuture; + +public class AsyncConversationsClient { + protected final ClientOptions clientOptions; + + private final AsyncRawConversationsClient rawClient; + + public AsyncConversationsClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + this.rawClient = new AsyncRawConversationsClient(clientOptions); + } + + /** + * Get responses with HTTP metadata like headers + */ + public AsyncRawConversationsClient withRawResponse() { + return this.rawClient; + } + + /** + * You can fetch a list of all conversations. + *

You can optionally request the result page size and the cursor to start after to fetch the result. + * {% admonition type="warning" name="Pagination" %} + * You can use pagination to limit the number of results returned. The default is 20 results per page. + * See the pagination section for more details on how to use the starting_after param. + * {% /admonition %}

+ */ + public CompletableFuture> list() { + return this.rawClient.list().thenApply(response -> response.body()); + } + + /** + * You can fetch a list of all conversations. + *

You can optionally request the result page size and the cursor to start after to fetch the result. + * {% admonition type="warning" name="Pagination" %} + * You can use pagination to limit the number of results returned. The default is 20 results per page. + * See the pagination section for more details on how to use the starting_after param. + * {% /admonition %}

+ */ + public CompletableFuture> list(ListConversationsRequest request) { + return this.rawClient.list(request).thenApply(response -> response.body()); + } + + /** + * You can fetch a list of all conversations. + *

You can optionally request the result page size and the cursor to start after to fetch the result. + * {% admonition type="warning" name="Pagination" %} + * You can use pagination to limit the number of results returned. The default is 20 results per page. + * See the pagination section for more details on how to use the starting_after param. + * {% /admonition %}

+ */ + public CompletableFuture> list( + ListConversationsRequest request, RequestOptions requestOptions) { + return this.rawClient.list(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can create a conversation that has been initiated by a contact (ie. user or lead). + * The conversation can be an in-app message only. + *

{% admonition type="info" name="Sending for visitors" %} + * You can also send a message from a visitor by specifying their user_id or id value in the from field, along with a type field value of contact. + * This visitor will be automatically converted to a contact with a lead role once the conversation is created. + * {% /admonition %}

+ *

This will return the Message model that has been created.

+ */ + public CompletableFuture create(CreateConversationRequest request) { + return this.rawClient.create(request).thenApply(response -> response.body()); + } + + /** + * You can create a conversation that has been initiated by a contact (ie. user or lead). + * The conversation can be an in-app message only. + *

{% admonition type="info" name="Sending for visitors" %} + * You can also send a message from a visitor by specifying their user_id or id value in the from field, along with a type field value of contact. + * This visitor will be automatically converted to a contact with a lead role once the conversation is created. + * {% /admonition %}

+ *

This will return the Message model that has been created.

+ */ + public CompletableFuture create(CreateConversationRequest request, RequestOptions requestOptions) { + return this.rawClient.create(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can fetch the details of a single conversation. + *

This will return a single Conversation model with all its conversation parts.

+ *

{% admonition type="warning" name="Hard limit of 500 parts" %} + * The maximum number of conversation parts that can be returned via the API is 500. If you have more than that we will return the 500 most recent conversation parts. + * {% /admonition %}

+ *

For AI agent conversation metadata, please note that you need to have the agent enabled in your workspace, which is a paid feature.

+ */ + public CompletableFuture find(FindConversationRequest request) { + return this.rawClient.find(request).thenApply(response -> response.body()); + } + + /** + * You can fetch the details of a single conversation. + *

This will return a single Conversation model with all its conversation parts.

+ *

{% admonition type="warning" name="Hard limit of 500 parts" %} + * The maximum number of conversation parts that can be returned via the API is 500. If you have more than that we will return the 500 most recent conversation parts. + * {% /admonition %}

+ *

For AI agent conversation metadata, please note that you need to have the agent enabled in your workspace, which is a paid feature.

+ */ + public CompletableFuture find(FindConversationRequest request, RequestOptions requestOptions) { + return this.rawClient.find(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can update an existing conversation. + *

{% admonition type="info" name="Replying and other actions" %} + * If you want to reply to a coveration or take an action such as assign, unassign, open, close or snooze, take a look at the reply and manage endpoints. + * {% /admonition %}

+ *

{% admonition type="info" %} + * This endpoint handles both conversation updates and custom object associations.

+ *

See update a conversation with an association to a custom object instance in the request/response examples to see the custom object association format. + * {% /admonition %}

+ */ + public CompletableFuture update(UpdateConversationRequest request) { + return this.rawClient.update(request).thenApply(response -> response.body()); + } + + /** + * You can update an existing conversation. + *

{% admonition type="info" name="Replying and other actions" %} + * If you want to reply to a coveration or take an action such as assign, unassign, open, close or snooze, take a look at the reply and manage endpoints. + * {% /admonition %}

+ *

{% admonition type="info" %} + * This endpoint handles both conversation updates and custom object associations.

+ *

See update a conversation with an association to a custom object instance in the request/response examples to see the custom object association format. + * {% /admonition %}

+ */ + public CompletableFuture update(UpdateConversationRequest request, RequestOptions requestOptions) { + return this.rawClient.update(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can delete a single conversation. + */ + public CompletableFuture deleteConversation(DeleteConversationRequest request) { + return this.rawClient.deleteConversation(request).thenApply(response -> response.body()); + } + + /** + * You can delete a single conversation. + */ + public CompletableFuture deleteConversation( + DeleteConversationRequest request, RequestOptions requestOptions) { + return this.rawClient.deleteConversation(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can search for multiple conversations by the value of their attributes in order to fetch exactly which ones you want. + *

To search for conversations, you need to send a POST request to https://api.intercom.io/conversations/search.

+ *

This will accept a query object in the body which will define your filters in order to search for conversations. + * {% admonition type="warning" name="Optimizing search queries" %} + * Search queries can be complex, so optimizing them can help the performance of your search. + * Use the AND and OR operators to combine multiple filters to get the exact results you need and utilize + * pagination to limit the number of results returned. The default is 20 results per page and maximum is 150. + * See the pagination section for more details on how to use the starting_after param. + * {% /admonition %}

+ *

Nesting & Limitations

+ *

You can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4). + * There are some limitations to the amount of multiple's there can be:

+ *
    + *
  • There's a limit of max 2 nested filters
    • + *
  • There's a limit of max 15 filters for each AND or OR group
    • + *
+ *

Accepted Fields

+ *

Most keys listed in the conversation model are searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as created_at accepts a date, the value cannot be a string such as "foorbar"). + * The source.body field is unique as the search will not be performed against the entire value, but instead against every element of the value separately. For example, when searching for a conversation with a "I need support" body - the query should contain a = operator with the value "support" for such conversation to be returned. A query with a = operator and a "need support" value will not yield a result.

+ *

| Field | Type | + * | :---------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------- | + * | id | String | + * | created_at | Date (UNIX timestamp) | + * | updated_at | Date (UNIX timestamp) | + * | source.type | String<br>Accepted fields are conversation, email, facebook, instagram, phone_call, phone_switch, push, sms, twitter and whatsapp. | + * | source.id | String | + * | source.delivered_as | String | + * | source.subject | String | + * | source.body | String | + * | source.author.id | String | + * | source.author.type | String | + * | source.author.name | String | + * | source.author.email | String | + * | source.url | String | + * | contact_ids | String | + * | teammate_ids | String | + * | admin_assignee_id | String | + * | team_assignee_id | String | + * | channel_initiated | String | + * | open | Boolean | + * | read | Boolean | + * | state | String | + * | waiting_since | Date (UNIX timestamp) | + * | snoozed_until | Date (UNIX timestamp) | + * | tag_ids | String | + * | priority | String | + * | statistics.time_to_assignment | Integer | + * | statistics.time_to_admin_reply | Integer | + * | statistics.time_to_first_close | Integer | + * | statistics.time_to_last_close | Integer | + * | statistics.median_time_to_reply | Integer | + * | statistics.first_contact_reply_at | Date (UNIX timestamp) | + * | statistics.first_assignment_at | Date (UNIX timestamp) | + * | statistics.first_admin_reply_at | Date (UNIX timestamp) | + * | statistics.first_close_at | Date (UNIX timestamp) | + * | statistics.last_assignment_at | Date (UNIX timestamp) | + * | statistics.last_assignment_admin_reply_at | Date (UNIX timestamp) | + * | statistics.last_contact_reply_at | Date (UNIX timestamp) | + * | statistics.last_admin_reply_at | Date (UNIX timestamp) | + * | statistics.last_close_at | Date (UNIX timestamp) | + * | statistics.last_closed_by_id | String | + * | statistics.count_reopens | Integer | + * | statistics.count_assignments | Integer | + * | statistics.count_conversation_parts | Integer | + * | conversation_rating.requested_at | Date (UNIX timestamp) | + * | conversation_rating.replied_at | Date (UNIX timestamp) | + * | conversation_rating.score | Integer | + * | conversation_rating.remark | String | + * | conversation_rating.contact_id | String | + * | conversation_rating.admin_d | String | + * | ai_agent_participated | Boolean | + * | ai_agent.resolution_state | String | + * | ai_agent.last_answer_type | String | + * | ai_agent.rating | Integer | + * | ai_agent.rating_remark | String | + * | ai_agent.source_type | String | + * | ai_agent.source_title | String |

+ *

Accepted Operators

+ *

The table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string ("="). The operator has to be compatible with the field's type (eg. you cannot search with > for a given string value as it's only compatible for integer's and dates).

+ *

| Operator | Valid Types | Description | + * | :------- | :----------------------------- | :----------------------------------------------------------- | + * | = | All | Equals | + * | != | All | Doesn't Equal | + * | IN | All | In Shortcut for OR queries Values most be in Array | + * | NIN | All | Not In Shortcut for OR ! queries Values must be in Array | + * | > | Integer Date (UNIX Timestamp) | Greater (or equal) than | + * | < | Integer Date (UNIX Timestamp) | Lower (or equal) than | + * | ~ | String | Contains | + * | !~ | String | Doesn't Contain | + * | ^ | String | Starts With | + * | $ | String | Ends With |

+ */ + public CompletableFuture> search(SearchRequest request) { + return this.rawClient.search(request).thenApply(response -> response.body()); + } + + /** + * You can search for multiple conversations by the value of their attributes in order to fetch exactly which ones you want. + *

To search for conversations, you need to send a POST request to https://api.intercom.io/conversations/search.

+ *

This will accept a query object in the body which will define your filters in order to search for conversations. + * {% admonition type="warning" name="Optimizing search queries" %} + * Search queries can be complex, so optimizing them can help the performance of your search. + * Use the AND and OR operators to combine multiple filters to get the exact results you need and utilize + * pagination to limit the number of results returned. The default is 20 results per page and maximum is 150. + * See the pagination section for more details on how to use the starting_after param. + * {% /admonition %}

+ *

Nesting & Limitations

+ *

You can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4). + * There are some limitations to the amount of multiple's there can be:

+ *
    + *
  • There's a limit of max 2 nested filters
    • + *
  • There's a limit of max 15 filters for each AND or OR group
    • + *
+ *

Accepted Fields

+ *

Most keys listed in the conversation model are searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as created_at accepts a date, the value cannot be a string such as "foorbar"). + * The source.body field is unique as the search will not be performed against the entire value, but instead against every element of the value separately. For example, when searching for a conversation with a "I need support" body - the query should contain a = operator with the value "support" for such conversation to be returned. A query with a = operator and a "need support" value will not yield a result.

+ *

| Field | Type | + * | :---------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------- | + * | id | String | + * | created_at | Date (UNIX timestamp) | + * | updated_at | Date (UNIX timestamp) | + * | source.type | String<br>Accepted fields are conversation, email, facebook, instagram, phone_call, phone_switch, push, sms, twitter and whatsapp. | + * | source.id | String | + * | source.delivered_as | String | + * | source.subject | String | + * | source.body | String | + * | source.author.id | String | + * | source.author.type | String | + * | source.author.name | String | + * | source.author.email | String | + * | source.url | String | + * | contact_ids | String | + * | teammate_ids | String | + * | admin_assignee_id | String | + * | team_assignee_id | String | + * | channel_initiated | String | + * | open | Boolean | + * | read | Boolean | + * | state | String | + * | waiting_since | Date (UNIX timestamp) | + * | snoozed_until | Date (UNIX timestamp) | + * | tag_ids | String | + * | priority | String | + * | statistics.time_to_assignment | Integer | + * | statistics.time_to_admin_reply | Integer | + * | statistics.time_to_first_close | Integer | + * | statistics.time_to_last_close | Integer | + * | statistics.median_time_to_reply | Integer | + * | statistics.first_contact_reply_at | Date (UNIX timestamp) | + * | statistics.first_assignment_at | Date (UNIX timestamp) | + * | statistics.first_admin_reply_at | Date (UNIX timestamp) | + * | statistics.first_close_at | Date (UNIX timestamp) | + * | statistics.last_assignment_at | Date (UNIX timestamp) | + * | statistics.last_assignment_admin_reply_at | Date (UNIX timestamp) | + * | statistics.last_contact_reply_at | Date (UNIX timestamp) | + * | statistics.last_admin_reply_at | Date (UNIX timestamp) | + * | statistics.last_close_at | Date (UNIX timestamp) | + * | statistics.last_closed_by_id | String | + * | statistics.count_reopens | Integer | + * | statistics.count_assignments | Integer | + * | statistics.count_conversation_parts | Integer | + * | conversation_rating.requested_at | Date (UNIX timestamp) | + * | conversation_rating.replied_at | Date (UNIX timestamp) | + * | conversation_rating.score | Integer | + * | conversation_rating.remark | String | + * | conversation_rating.contact_id | String | + * | conversation_rating.admin_d | String | + * | ai_agent_participated | Boolean | + * | ai_agent.resolution_state | String | + * | ai_agent.last_answer_type | String | + * | ai_agent.rating | Integer | + * | ai_agent.rating_remark | String | + * | ai_agent.source_type | String | + * | ai_agent.source_title | String |

+ *

Accepted Operators

+ *

The table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string ("="). The operator has to be compatible with the field's type (eg. you cannot search with > for a given string value as it's only compatible for integer's and dates).

+ *

| Operator | Valid Types | Description | + * | :------- | :----------------------------- | :----------------------------------------------------------- | + * | = | All | Equals | + * | != | All | Doesn't Equal | + * | IN | All | In Shortcut for OR queries Values most be in Array | + * | NIN | All | Not In Shortcut for OR ! queries Values must be in Array | + * | > | Integer Date (UNIX Timestamp) | Greater (or equal) than | + * | < | Integer Date (UNIX Timestamp) | Lower (or equal) than | + * | ~ | String | Contains | + * | !~ | String | Doesn't Contain | + * | ^ | String | Starts With | + * | $ | String | Ends With |

+ */ + public CompletableFuture> search( + SearchRequest request, RequestOptions requestOptions) { + return this.rawClient.search(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can reply to a conversation with a message from an admin or on behalf of a contact, or with a note for admins. + */ + public CompletableFuture reply(ReplyToConversationRequest request) { + return this.rawClient.reply(request).thenApply(response -> response.body()); + } + + /** + * You can reply to a conversation with a message from an admin or on behalf of a contact, or with a note for admins. + */ + public CompletableFuture reply(ReplyToConversationRequest request, RequestOptions requestOptions) { + return this.rawClient.reply(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * For managing conversations you can: + *
    + *
  • Close a conversation
    • + *
  • Snooze a conversation to reopen on a future date
    • + *
  • Open a conversation which is snoozed or closed
    • + *
  • Assign a conversation to an admin and/or team.
    • + *
+ */ + public CompletableFuture manage(ManageConversationPartsRequest request) { + return this.rawClient.manage(request).thenApply(response -> response.body()); + } + + /** + * For managing conversations you can: + *
    + *
  • Close a conversation
    • + *
  • Snooze a conversation to reopen on a future date
    • + *
  • Open a conversation which is snoozed or closed
    • + *
  • Assign a conversation to an admin and/or team.
    • + *
+ */ + public CompletableFuture manage( + ManageConversationPartsRequest request, RequestOptions requestOptions) { + return this.rawClient.manage(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can add participants who are contacts to a conversation, on behalf of either another contact or an admin. + *

{% admonition type="warning" name="Contacts without an email" %} + * If you add a contact via the email parameter and there is no user/lead found on that workspace with he given email, then we will create a new contact with role set to lead. + * {% /admonition %}

+ */ + public CompletableFuture attachContactAsAdmin(AttachContactToConversationRequest request) { + return this.rawClient.attachContactAsAdmin(request).thenApply(response -> response.body()); + } + + /** + * You can add participants who are contacts to a conversation, on behalf of either another contact or an admin. + *

{% admonition type="warning" name="Contacts without an email" %} + * If you add a contact via the email parameter and there is no user/lead found on that workspace with he given email, then we will create a new contact with role set to lead. + * {% /admonition %}

+ */ + public CompletableFuture attachContactAsAdmin( + AttachContactToConversationRequest request, RequestOptions requestOptions) { + return this.rawClient.attachContactAsAdmin(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can add participants who are contacts to a conversation, on behalf of either another contact or an admin. + *

{% admonition type="warning" name="Contacts without an email" %} + * If you add a contact via the email parameter and there is no user/lead found on that workspace with he given email, then we will create a new contact with role set to lead. + * {% /admonition %}

+ */ + public CompletableFuture detachContactAsAdmin(DetachContactFromConversationRequest request) { + return this.rawClient.detachContactAsAdmin(request).thenApply(response -> response.body()); + } + + /** + * You can add participants who are contacts to a conversation, on behalf of either another contact or an admin. + *

{% admonition type="warning" name="Contacts without an email" %} + * If you add a contact via the email parameter and there is no user/lead found on that workspace with he given email, then we will create a new contact with role set to lead. + * {% /admonition %}

+ */ + public CompletableFuture detachContactAsAdmin( + DetachContactFromConversationRequest request, RequestOptions requestOptions) { + return this.rawClient.detachContactAsAdmin(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can redact a conversation part or the source message of a conversation (as seen in the source object). + *

{% admonition type="info" name="Redacting parts and messages" %} + * If you are redacting a conversation part, it must have a body. If you are redacting a source message, it must have been created by a contact. We will return a conversation_part_not_redactable error if these criteria are not met. + * {% /admonition %}

+ */ + public CompletableFuture redactConversationPart(RedactConversationRequest request) { + return this.rawClient.redactConversationPart(request).thenApply(response -> response.body()); + } + + /** + * You can redact a conversation part or the source message of a conversation (as seen in the source object). + *

{% admonition type="info" name="Redacting parts and messages" %} + * If you are redacting a conversation part, it must have a body. If you are redacting a source message, it must have been created by a contact. We will return a conversation_part_not_redactable error if these criteria are not met. + * {% /admonition %}

+ */ + public CompletableFuture redactConversationPart( + RedactConversationRequest request, RequestOptions requestOptions) { + return this.rawClient.redactConversationPart(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can convert a conversation to a ticket. + */ + public CompletableFuture> convertToTicket(ConvertConversationToTicketRequest request) { + return this.rawClient.convertToTicket(request).thenApply(response -> response.body()); + } + + /** + * You can convert a conversation to a ticket. + */ + public CompletableFuture> convertToTicket( + ConvertConversationToTicketRequest request, RequestOptions requestOptions) { + return this.rawClient.convertToTicket(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * {% admonition type="danger" name="Deprecation of Run Assignment Rules" %} + * Run assignment rules is now deprecated in version 2.12 and future versions and will be permanently removed on December 31, 2026. After this date, any requests made to this endpoint will fail. + * {% /admonition %} + * You can let a conversation be automatically assigned following assignment rules. + * {% admonition type="warning" name="When using workflows" %} + * It is not possible to use this endpoint with Workflows. + * {% /admonition %} + */ + public CompletableFuture runAssignmentRules(AutoAssignConversationRequest request) { + return this.rawClient.runAssignmentRules(request).thenApply(response -> response.body()); + } + + /** + * {% admonition type="danger" name="Deprecation of Run Assignment Rules" %} + * Run assignment rules is now deprecated in version 2.12 and future versions and will be permanently removed on December 31, 2026. After this date, any requests made to this endpoint will fail. + * {% /admonition %} + * You can let a conversation be automatically assigned following assignment rules. + * {% admonition type="warning" name="When using workflows" %} + * It is not possible to use this endpoint with Workflows. + * {% /admonition %} + */ + public CompletableFuture runAssignmentRules( + AutoAssignConversationRequest request, RequestOptions requestOptions) { + return this.rawClient.runAssignmentRules(request, requestOptions).thenApply(response -> response.body()); + } +} diff --git a/src/main/java/com/intercom/api/resources/conversations/AsyncRawConversationsClient.java b/src/main/java/com/intercom/api/resources/conversations/AsyncRawConversationsClient.java new file mode 100644 index 00000000..9c95c4b0 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/conversations/AsyncRawConversationsClient.java @@ -0,0 +1,1445 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.conversations; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.fasterxml.jackson.core.type.TypeReference; +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.IntercomApiException; +import com.intercom.api.core.IntercomException; +import com.intercom.api.core.IntercomHttpResponse; +import com.intercom.api.core.MediaTypes; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.core.QueryStringMapper; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.core.pagination.SyncPagingIterable; +import com.intercom.api.errors.BadRequestError; +import com.intercom.api.errors.ForbiddenError; +import com.intercom.api.errors.NotFoundError; +import com.intercom.api.errors.UnauthorizedError; +import com.intercom.api.errors.UnprocessableEntityError; +import com.intercom.api.resources.conversations.requests.AttachContactToConversationRequest; +import com.intercom.api.resources.conversations.requests.AutoAssignConversationRequest; +import com.intercom.api.resources.conversations.requests.ConvertConversationToTicketRequest; +import com.intercom.api.resources.conversations.requests.CreateConversationRequest; +import com.intercom.api.resources.conversations.requests.DeleteConversationRequest; +import com.intercom.api.resources.conversations.requests.DetachContactFromConversationRequest; +import com.intercom.api.resources.conversations.requests.FindConversationRequest; +import com.intercom.api.resources.conversations.requests.ListConversationsRequest; +import com.intercom.api.resources.conversations.requests.ManageConversationPartsRequest; +import com.intercom.api.resources.conversations.requests.ReplyToConversationRequest; +import com.intercom.api.resources.conversations.requests.UpdateConversationRequest; +import com.intercom.api.resources.conversations.types.Conversation; +import com.intercom.api.resources.messages.types.Message; +import com.intercom.api.resources.tickets.types.Ticket; +import com.intercom.api.types.ConversationDeleted; +import com.intercom.api.types.ConversationList; +import com.intercom.api.types.CursorPages; +import com.intercom.api.types.Error; +import com.intercom.api.types.RedactConversationRequest; +import com.intercom.api.types.SearchRequest; +import com.intercom.api.types.StartingAfterPaging; +import java.io.IOException; +import java.util.Collections; +import java.util.List; +import java.util.Optional; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.ExecutionException; +import okhttp3.Call; +import okhttp3.Callback; +import okhttp3.Headers; +import okhttp3.HttpUrl; +import okhttp3.OkHttpClient; +import okhttp3.Request; +import okhttp3.RequestBody; +import okhttp3.Response; +import okhttp3.ResponseBody; +import org.jetbrains.annotations.NotNull; + +public class AsyncRawConversationsClient { + protected final ClientOptions clientOptions; + + public AsyncRawConversationsClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + } + + /** + * You can fetch a list of all conversations. + *

You can optionally request the result page size and the cursor to start after to fetch the result. + * {% admonition type="warning" name="Pagination" %} + * You can use pagination to limit the number of results returned. The default is 20 results per page. + * See the pagination section for more details on how to use the starting_after param. + * {% /admonition %}

+ */ + public CompletableFuture>> list() { + return list(ListConversationsRequest.builder().build()); + } + + /** + * You can fetch a list of all conversations. + *

You can optionally request the result page size and the cursor to start after to fetch the result. + * {% admonition type="warning" name="Pagination" %} + * You can use pagination to limit the number of results returned. The default is 20 results per page. + * See the pagination section for more details on how to use the starting_after param. + * {% /admonition %}

+ */ + public CompletableFuture>> list( + ListConversationsRequest request) { + return list(request, null); + } + + /** + * You can fetch a list of all conversations. + *

You can optionally request the result page size and the cursor to start after to fetch the result. + * {% admonition type="warning" name="Pagination" %} + * You can use pagination to limit the number of results returned. The default is 20 results per page. + * See the pagination section for more details on how to use the starting_after param. + * {% /admonition %}

+ */ + public CompletableFuture>> list( + ListConversationsRequest request, RequestOptions requestOptions) { + HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("conversations"); + if (request.getPerPage().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "per_page", request.getPerPage().get(), false); + } + if (request.getStartingAfter().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "starting_after", request.getStartingAfter().get(), false); + } + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl.build()) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture>> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + ConversationList parsedResponse = + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, ConversationList.class); + Optional startingAfter = parsedResponse + .getPages() + .flatMap(CursorPages::getNext) + .flatMap(StartingAfterPaging::getStartingAfter); + ListConversationsRequest nextRequest = ListConversationsRequest.builder() + .from(request) + .startingAfter(startingAfter) + .build(); + List result = + parsedResponse.getConversations().orElse(Collections.emptyList()); + future.complete(new IntercomHttpResponse<>( + new SyncPagingIterable( + startingAfter.isPresent(), result, parsedResponse, () -> { + try { + return list(nextRequest, requestOptions) + .get() + .body(); + } catch (InterruptedException | ExecutionException e) { + throw new RuntimeException(e); + } + }), + response)); + return; + } + try { + switch (response.code()) { + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 403: + future.completeExceptionally(new ForbiddenError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can create a conversation that has been initiated by a contact (ie. user or lead). + * The conversation can be an in-app message only. + *

{% admonition type="info" name="Sending for visitors" %} + * You can also send a message from a visitor by specifying their user_id or id value in the from field, along with a type field value of contact. + * This visitor will be automatically converted to a contact with a lead role once the conversation is created. + * {% /admonition %}

+ *

This will return the Message model that has been created.

+ */ + public CompletableFuture> create(CreateConversationRequest request) { + return create(request, null); + } + + /** + * You can create a conversation that has been initiated by a contact (ie. user or lead). + * The conversation can be an in-app message only. + *

{% admonition type="info" name="Sending for visitors" %} + * You can also send a message from a visitor by specifying their user_id or id value in the from field, along with a type field value of contact. + * This visitor will be automatically converted to a contact with a lead role once the conversation is created. + * {% /admonition %}

+ *

This will return the Message model that has been created.

+ */ + public CompletableFuture> create( + CreateConversationRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("conversations") + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Message.class), response)); + return; + } + try { + switch (response.code()) { + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 403: + future.completeExceptionally(new ForbiddenError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 404: + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can fetch the details of a single conversation. + *

This will return a single Conversation model with all its conversation parts.

+ *

{% admonition type="warning" name="Hard limit of 500 parts" %} + * The maximum number of conversation parts that can be returned via the API is 500. If you have more than that we will return the 500 most recent conversation parts. + * {% /admonition %}

+ *

For AI agent conversation metadata, please note that you need to have the agent enabled in your workspace, which is a paid feature.

+ */ + public CompletableFuture> find(FindConversationRequest request) { + return find(request, null); + } + + /** + * You can fetch the details of a single conversation. + *

This will return a single Conversation model with all its conversation parts.

+ *

{% admonition type="warning" name="Hard limit of 500 parts" %} + * The maximum number of conversation parts that can be returned via the API is 500. If you have more than that we will return the 500 most recent conversation parts. + * {% /admonition %}

+ *

For AI agent conversation metadata, please note that you need to have the agent enabled in your workspace, which is a paid feature.

+ */ + public CompletableFuture> find( + FindConversationRequest request, RequestOptions requestOptions) { + HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("conversations") + .addPathSegment(request.getConversationId()); + if (request.getDisplayAs().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "display_as", request.getDisplayAs().get(), false); + } + if (request.getIncludeTranslations().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, + "include_translations", + request.getIncludeTranslations().get(), + false); + } + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl.build()) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Conversation.class), response)); + return; + } + try { + switch (response.code()) { + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 403: + future.completeExceptionally(new ForbiddenError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 404: + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can update an existing conversation. + *

{% admonition type="info" name="Replying and other actions" %} + * If you want to reply to a coveration or take an action such as assign, unassign, open, close or snooze, take a look at the reply and manage endpoints. + * {% /admonition %}

+ *

{% admonition type="info" %} + * This endpoint handles both conversation updates and custom object associations.

+ *

See update a conversation with an association to a custom object instance in the request/response examples to see the custom object association format. + * {% /admonition %}

+ */ + public CompletableFuture> update(UpdateConversationRequest request) { + return update(request, null); + } + + /** + * You can update an existing conversation. + *

{% admonition type="info" name="Replying and other actions" %} + * If you want to reply to a coveration or take an action such as assign, unassign, open, close or snooze, take a look at the reply and manage endpoints. + * {% /admonition %}

+ *

{% admonition type="info" %} + * This endpoint handles both conversation updates and custom object associations.

+ *

See update a conversation with an association to a custom object instance in the request/response examples to see the custom object association format. + * {% /admonition %}

+ */ + public CompletableFuture> update( + UpdateConversationRequest request, RequestOptions requestOptions) { + HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("conversations") + .addPathSegment(request.getConversationId()); + if (request.getDisplayAs().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "display_as", request.getDisplayAs().get(), false); + } + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (Exception e) { + throw new RuntimeException(e); + } + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl.build()) + .method("PUT", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Conversation.class), response)); + return; + } + try { + switch (response.code()) { + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 403: + future.completeExceptionally(new ForbiddenError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 404: + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can delete a single conversation. + */ + public CompletableFuture> deleteConversation( + DeleteConversationRequest request) { + return deleteConversation(request, null); + } + + /** + * You can delete a single conversation. + */ + public CompletableFuture> deleteConversation( + DeleteConversationRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("conversations") + .addPathSegment(Integer.toString(request.getConversationId())) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("DELETE", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, ConversationDeleted.class), + response)); + return; + } + try { + switch (response.code()) { + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 403: + future.completeExceptionally(new ForbiddenError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can search for multiple conversations by the value of their attributes in order to fetch exactly which ones you want. + *

To search for conversations, you need to send a POST request to https://api.intercom.io/conversations/search.

+ *

This will accept a query object in the body which will define your filters in order to search for conversations. + * {% admonition type="warning" name="Optimizing search queries" %} + * Search queries can be complex, so optimizing them can help the performance of your search. + * Use the AND and OR operators to combine multiple filters to get the exact results you need and utilize + * pagination to limit the number of results returned. The default is 20 results per page and maximum is 150. + * See the pagination section for more details on how to use the starting_after param. + * {% /admonition %}

+ *

Nesting & Limitations

+ *

You can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4). + * There are some limitations to the amount of multiple's there can be:

+ *
    + *
  • There's a limit of max 2 nested filters
    • + *
  • There's a limit of max 15 filters for each AND or OR group
    • + *
+ *

Accepted Fields

+ *

Most keys listed in the conversation model are searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as created_at accepts a date, the value cannot be a string such as "foorbar"). + * The source.body field is unique as the search will not be performed against the entire value, but instead against every element of the value separately. For example, when searching for a conversation with a "I need support" body - the query should contain a = operator with the value "support" for such conversation to be returned. A query with a = operator and a "need support" value will not yield a result.

+ *

| Field | Type | + * | :---------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------- | + * | id | String | + * | created_at | Date (UNIX timestamp) | + * | updated_at | Date (UNIX timestamp) | + * | source.type | String<br>Accepted fields are conversation, email, facebook, instagram, phone_call, phone_switch, push, sms, twitter and whatsapp. | + * | source.id | String | + * | source.delivered_as | String | + * | source.subject | String | + * | source.body | String | + * | source.author.id | String | + * | source.author.type | String | + * | source.author.name | String | + * | source.author.email | String | + * | source.url | String | + * | contact_ids | String | + * | teammate_ids | String | + * | admin_assignee_id | String | + * | team_assignee_id | String | + * | channel_initiated | String | + * | open | Boolean | + * | read | Boolean | + * | state | String | + * | waiting_since | Date (UNIX timestamp) | + * | snoozed_until | Date (UNIX timestamp) | + * | tag_ids | String | + * | priority | String | + * | statistics.time_to_assignment | Integer | + * | statistics.time_to_admin_reply | Integer | + * | statistics.time_to_first_close | Integer | + * | statistics.time_to_last_close | Integer | + * | statistics.median_time_to_reply | Integer | + * | statistics.first_contact_reply_at | Date (UNIX timestamp) | + * | statistics.first_assignment_at | Date (UNIX timestamp) | + * | statistics.first_admin_reply_at | Date (UNIX timestamp) | + * | statistics.first_close_at | Date (UNIX timestamp) | + * | statistics.last_assignment_at | Date (UNIX timestamp) | + * | statistics.last_assignment_admin_reply_at | Date (UNIX timestamp) | + * | statistics.last_contact_reply_at | Date (UNIX timestamp) | + * | statistics.last_admin_reply_at | Date (UNIX timestamp) | + * | statistics.last_close_at | Date (UNIX timestamp) | + * | statistics.last_closed_by_id | String | + * | statistics.count_reopens | Integer | + * | statistics.count_assignments | Integer | + * | statistics.count_conversation_parts | Integer | + * | conversation_rating.requested_at | Date (UNIX timestamp) | + * | conversation_rating.replied_at | Date (UNIX timestamp) | + * | conversation_rating.score | Integer | + * | conversation_rating.remark | String | + * | conversation_rating.contact_id | String | + * | conversation_rating.admin_d | String | + * | ai_agent_participated | Boolean | + * | ai_agent.resolution_state | String | + * | ai_agent.last_answer_type | String | + * | ai_agent.rating | Integer | + * | ai_agent.rating_remark | String | + * | ai_agent.source_type | String | + * | ai_agent.source_title | String |

+ *

Accepted Operators

+ *

The table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string ("="). The operator has to be compatible with the field's type (eg. you cannot search with > for a given string value as it's only compatible for integer's and dates).

+ *

| Operator | Valid Types | Description | + * | :------- | :----------------------------- | :----------------------------------------------------------- | + * | = | All | Equals | + * | != | All | Doesn't Equal | + * | IN | All | In Shortcut for OR queries Values most be in Array | + * | NIN | All | Not In Shortcut for OR ! queries Values must be in Array | + * | > | Integer Date (UNIX Timestamp) | Greater (or equal) than | + * | < | Integer Date (UNIX Timestamp) | Lower (or equal) than | + * | ~ | String | Contains | + * | !~ | String | Doesn't Contain | + * | ^ | String | Starts With | + * | $ | String | Ends With |

+ */ + public CompletableFuture>> search(SearchRequest request) { + return search(request, null); + } + + /** + * You can search for multiple conversations by the value of their attributes in order to fetch exactly which ones you want. + *

To search for conversations, you need to send a POST request to https://api.intercom.io/conversations/search.

+ *

This will accept a query object in the body which will define your filters in order to search for conversations. + * {% admonition type="warning" name="Optimizing search queries" %} + * Search queries can be complex, so optimizing them can help the performance of your search. + * Use the AND and OR operators to combine multiple filters to get the exact results you need and utilize + * pagination to limit the number of results returned. The default is 20 results per page and maximum is 150. + * See the pagination section for more details on how to use the starting_after param. + * {% /admonition %}

+ *

Nesting & Limitations

+ *

You can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4). + * There are some limitations to the amount of multiple's there can be:

+ *
    + *
  • There's a limit of max 2 nested filters
    • + *
  • There's a limit of max 15 filters for each AND or OR group
    • + *
+ *

Accepted Fields

+ *

Most keys listed in the conversation model are searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as created_at accepts a date, the value cannot be a string such as "foorbar"). + * The source.body field is unique as the search will not be performed against the entire value, but instead against every element of the value separately. For example, when searching for a conversation with a "I need support" body - the query should contain a = operator with the value "support" for such conversation to be returned. A query with a = operator and a "need support" value will not yield a result.

+ *

| Field | Type | + * | :---------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------- | + * | id | String | + * | created_at | Date (UNIX timestamp) | + * | updated_at | Date (UNIX timestamp) | + * | source.type | String<br>Accepted fields are conversation, email, facebook, instagram, phone_call, phone_switch, push, sms, twitter and whatsapp. | + * | source.id | String | + * | source.delivered_as | String | + * | source.subject | String | + * | source.body | String | + * | source.author.id | String | + * | source.author.type | String | + * | source.author.name | String | + * | source.author.email | String | + * | source.url | String | + * | contact_ids | String | + * | teammate_ids | String | + * | admin_assignee_id | String | + * | team_assignee_id | String | + * | channel_initiated | String | + * | open | Boolean | + * | read | Boolean | + * | state | String | + * | waiting_since | Date (UNIX timestamp) | + * | snoozed_until | Date (UNIX timestamp) | + * | tag_ids | String | + * | priority | String | + * | statistics.time_to_assignment | Integer | + * | statistics.time_to_admin_reply | Integer | + * | statistics.time_to_first_close | Integer | + * | statistics.time_to_last_close | Integer | + * | statistics.median_time_to_reply | Integer | + * | statistics.first_contact_reply_at | Date (UNIX timestamp) | + * | statistics.first_assignment_at | Date (UNIX timestamp) | + * | statistics.first_admin_reply_at | Date (UNIX timestamp) | + * | statistics.first_close_at | Date (UNIX timestamp) | + * | statistics.last_assignment_at | Date (UNIX timestamp) | + * | statistics.last_assignment_admin_reply_at | Date (UNIX timestamp) | + * | statistics.last_contact_reply_at | Date (UNIX timestamp) | + * | statistics.last_admin_reply_at | Date (UNIX timestamp) | + * | statistics.last_close_at | Date (UNIX timestamp) | + * | statistics.last_closed_by_id | String | + * | statistics.count_reopens | Integer | + * | statistics.count_assignments | Integer | + * | statistics.count_conversation_parts | Integer | + * | conversation_rating.requested_at | Date (UNIX timestamp) | + * | conversation_rating.replied_at | Date (UNIX timestamp) | + * | conversation_rating.score | Integer | + * | conversation_rating.remark | String | + * | conversation_rating.contact_id | String | + * | conversation_rating.admin_d | String | + * | ai_agent_participated | Boolean | + * | ai_agent.resolution_state | String | + * | ai_agent.last_answer_type | String | + * | ai_agent.rating | Integer | + * | ai_agent.rating_remark | String | + * | ai_agent.source_type | String | + * | ai_agent.source_title | String |

+ *

Accepted Operators

+ *

The table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string ("="). The operator has to be compatible with the field's type (eg. you cannot search with > for a given string value as it's only compatible for integer's and dates).

+ *

| Operator | Valid Types | Description | + * | :------- | :----------------------------- | :----------------------------------------------------------- | + * | = | All | Equals | + * | != | All | Doesn't Equal | + * | IN | All | In Shortcut for OR queries Values most be in Array | + * | NIN | All | Not In Shortcut for OR ! queries Values must be in Array | + * | > | Integer Date (UNIX Timestamp) | Greater (or equal) than | + * | < | Integer Date (UNIX Timestamp) | Lower (or equal) than | + * | ~ | String | Contains | + * | !~ | String | Doesn't Contain | + * | ^ | String | Starts With | + * | $ | String | Ends With |

+ */ + public CompletableFuture>> search( + SearchRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("conversations/search") + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture>> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + ConversationList parsedResponse = + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, ConversationList.class); + Optional startingAfter = parsedResponse + .getPages() + .flatMap(CursorPages::getNext) + .flatMap(StartingAfterPaging::getStartingAfter); + Optional pagination = request.getPagination() + .map((StartingAfterPaging pagination_) -> StartingAfterPaging.builder() + .from(pagination_) + .startingAfter(startingAfter) + .build()); + SearchRequest nextRequest = SearchRequest.builder() + .from(request) + .pagination(pagination) + .build(); + List result = + parsedResponse.getConversations().orElse(Collections.emptyList()); + future.complete(new IntercomHttpResponse<>( + new SyncPagingIterable( + startingAfter.isPresent(), result, parsedResponse, () -> { + try { + return search(nextRequest, requestOptions) + .get() + .body(); + } catch (InterruptedException | ExecutionException e) { + throw new RuntimeException(e); + } + }), + response)); + return; + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can reply to a conversation with a message from an admin or on behalf of a contact, or with a note for admins. + */ + public CompletableFuture> reply(ReplyToConversationRequest request) { + return reply(request, null); + } + + /** + * You can reply to a conversation with a message from an admin or on behalf of a contact, or with a note for admins. + */ + public CompletableFuture> reply( + ReplyToConversationRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("conversations") + .addPathSegment(request.getConversationId()) + .addPathSegments("reply") + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request.getBody()), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Conversation.class), response)); + return; + } + try { + switch (response.code()) { + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 403: + future.completeExceptionally(new ForbiddenError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 404: + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * For managing conversations you can: + *
    + *
  • Close a conversation
    • + *
  • Snooze a conversation to reopen on a future date
    • + *
  • Open a conversation which is snoozed or closed
    • + *
  • Assign a conversation to an admin and/or team.
    • + *
+ */ + public CompletableFuture> manage(ManageConversationPartsRequest request) { + return manage(request, null); + } + + /** + * For managing conversations you can: + *
    + *
  • Close a conversation
    • + *
  • Snooze a conversation to reopen on a future date
    • + *
  • Open a conversation which is snoozed or closed
    • + *
  • Assign a conversation to an admin and/or team.
    • + *
+ */ + public CompletableFuture> manage( + ManageConversationPartsRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("conversations") + .addPathSegment(request.getConversationId()) + .addPathSegments("parts") + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request.getBody()), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Conversation.class), response)); + return; + } + try { + switch (response.code()) { + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 403: + future.completeExceptionally(new ForbiddenError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 404: + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can add participants who are contacts to a conversation, on behalf of either another contact or an admin. + *

{% admonition type="warning" name="Contacts without an email" %} + * If you add a contact via the email parameter and there is no user/lead found on that workspace with he given email, then we will create a new contact with role set to lead. + * {% /admonition %}

+ */ + public CompletableFuture> attachContactAsAdmin( + AttachContactToConversationRequest request) { + return attachContactAsAdmin(request, null); + } + + /** + * You can add participants who are contacts to a conversation, on behalf of either another contact or an admin. + *

{% admonition type="warning" name="Contacts without an email" %} + * If you add a contact via the email parameter and there is no user/lead found on that workspace with he given email, then we will create a new contact with role set to lead. + * {% /admonition %}

+ */ + public CompletableFuture> attachContactAsAdmin( + AttachContactToConversationRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("conversations") + .addPathSegment(request.getConversationId()) + .addPathSegments("customers") + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Conversation.class), response)); + return; + } + try { + switch (response.code()) { + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 403: + future.completeExceptionally(new ForbiddenError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 404: + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can add participants who are contacts to a conversation, on behalf of either another contact or an admin. + *

{% admonition type="warning" name="Contacts without an email" %} + * If you add a contact via the email parameter and there is no user/lead found on that workspace with he given email, then we will create a new contact with role set to lead. + * {% /admonition %}

+ */ + public CompletableFuture> detachContactAsAdmin( + DetachContactFromConversationRequest request) { + return detachContactAsAdmin(request, null); + } + + /** + * You can add participants who are contacts to a conversation, on behalf of either another contact or an admin. + *

{% admonition type="warning" name="Contacts without an email" %} + * If you add a contact via the email parameter and there is no user/lead found on that workspace with he given email, then we will create a new contact with role set to lead. + * {% /admonition %}

+ */ + public CompletableFuture> detachContactAsAdmin( + DetachContactFromConversationRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("conversations") + .addPathSegment(request.getConversationId()) + .addPathSegments("customers") + .addPathSegment(request.getContactId()) + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("DELETE", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Conversation.class), response)); + return; + } + try { + switch (response.code()) { + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 403: + future.completeExceptionally(new ForbiddenError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 404: + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + case 422: + future.completeExceptionally(new UnprocessableEntityError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can redact a conversation part or the source message of a conversation (as seen in the source object). + *

{% admonition type="info" name="Redacting parts and messages" %} + * If you are redacting a conversation part, it must have a body. If you are redacting a source message, it must have been created by a contact. We will return a conversation_part_not_redactable error if these criteria are not met. + * {% /admonition %}

+ */ + public CompletableFuture> redactConversationPart( + RedactConversationRequest request) { + return redactConversationPart(request, null); + } + + /** + * You can redact a conversation part or the source message of a conversation (as seen in the source object). + *

{% admonition type="info" name="Redacting parts and messages" %} + * If you are redacting a conversation part, it must have a body. If you are redacting a source message, it must have been created by a contact. We will return a conversation_part_not_redactable error if these criteria are not met. + * {% /admonition %}

+ */ + public CompletableFuture> redactConversationPart( + RedactConversationRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("conversations/redact") + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Conversation.class), response)); + return; + } + try { + switch (response.code()) { + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 404: + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can convert a conversation to a ticket. + */ + public CompletableFuture>> convertToTicket( + ConvertConversationToTicketRequest request) { + return convertToTicket(request, null); + } + + /** + * You can convert a conversation to a ticket. + */ + public CompletableFuture>> convertToTicket( + ConvertConversationToTicketRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("conversations") + .addPathSegment(Integer.toString(request.getConversationId())) + .addPathSegments("convert") + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture>> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue( + responseBodyString, new TypeReference>() {}), + response)); + return; + } + try { + if (response.code() == 400) { + future.completeExceptionally(new BadRequestError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * {% admonition type="danger" name="Deprecation of Run Assignment Rules" %} + * Run assignment rules is now deprecated in version 2.12 and future versions and will be permanently removed on December 31, 2026. After this date, any requests made to this endpoint will fail. + * {% /admonition %} + * You can let a conversation be automatically assigned following assignment rules. + * {% admonition type="warning" name="When using workflows" %} + * It is not possible to use this endpoint with Workflows. + * {% /admonition %} + */ + public CompletableFuture> runAssignmentRules( + AutoAssignConversationRequest request) { + return runAssignmentRules(request, null); + } + + /** + * {% admonition type="danger" name="Deprecation of Run Assignment Rules" %} + * Run assignment rules is now deprecated in version 2.12 and future versions and will be permanently removed on December 31, 2026. After this date, any requests made to this endpoint will fail. + * {% /admonition %} + * You can let a conversation be automatically assigned following assignment rules. + * {% admonition type="warning" name="When using workflows" %} + * It is not possible to use this endpoint with Workflows. + * {% /admonition %} + */ + public CompletableFuture> runAssignmentRules( + AutoAssignConversationRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("conversations") + .addPathSegment(request.getConversationId()) + .addPathSegments("run_assignment_rules") + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("POST", RequestBody.create("", null)) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Conversation.class), response)); + return; + } + try { + switch (response.code()) { + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 403: + future.completeExceptionally(new ForbiddenError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 404: + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } +} diff --git a/src/main/java/com/intercom/api/resources/conversations/ConversationsClient.java b/src/main/java/com/intercom/api/resources/conversations/ConversationsClient.java new file mode 100644 index 00000000..8440374f --- /dev/null +++ b/src/main/java/com/intercom/api/resources/conversations/ConversationsClient.java @@ -0,0 +1,508 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.conversations; + +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.core.pagination.SyncPagingIterable; +import com.intercom.api.resources.conversations.requests.AttachContactToConversationRequest; +import com.intercom.api.resources.conversations.requests.AutoAssignConversationRequest; +import com.intercom.api.resources.conversations.requests.ConvertConversationToTicketRequest; +import com.intercom.api.resources.conversations.requests.CreateConversationRequest; +import com.intercom.api.resources.conversations.requests.DeleteConversationRequest; +import com.intercom.api.resources.conversations.requests.DetachContactFromConversationRequest; +import com.intercom.api.resources.conversations.requests.FindConversationRequest; +import com.intercom.api.resources.conversations.requests.ListConversationsRequest; +import com.intercom.api.resources.conversations.requests.ManageConversationPartsRequest; +import com.intercom.api.resources.conversations.requests.ReplyToConversationRequest; +import com.intercom.api.resources.conversations.requests.UpdateConversationRequest; +import com.intercom.api.resources.conversations.types.Conversation; +import com.intercom.api.resources.messages.types.Message; +import com.intercom.api.resources.tickets.types.Ticket; +import com.intercom.api.types.ConversationDeleted; +import com.intercom.api.types.RedactConversationRequest; +import com.intercom.api.types.SearchRequest; +import java.util.Optional; + +public class ConversationsClient { + protected final ClientOptions clientOptions; + + private final RawConversationsClient rawClient; + + public ConversationsClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + this.rawClient = new RawConversationsClient(clientOptions); + } + + /** + * Get responses with HTTP metadata like headers + */ + public RawConversationsClient withRawResponse() { + return this.rawClient; + } + + /** + * You can fetch a list of all conversations. + *

You can optionally request the result page size and the cursor to start after to fetch the result. + * {% admonition type="warning" name="Pagination" %} + * You can use pagination to limit the number of results returned. The default is 20 results per page. + * See the pagination section for more details on how to use the starting_after param. + * {% /admonition %}

+ */ + public SyncPagingIterable list() { + return this.rawClient.list().body(); + } + + /** + * You can fetch a list of all conversations. + *

You can optionally request the result page size and the cursor to start after to fetch the result. + * {% admonition type="warning" name="Pagination" %} + * You can use pagination to limit the number of results returned. The default is 20 results per page. + * See the pagination section for more details on how to use the starting_after param. + * {% /admonition %}

+ */ + public SyncPagingIterable list(ListConversationsRequest request) { + return this.rawClient.list(request).body(); + } + + /** + * You can fetch a list of all conversations. + *

You can optionally request the result page size and the cursor to start after to fetch the result. + * {% admonition type="warning" name="Pagination" %} + * You can use pagination to limit the number of results returned. The default is 20 results per page. + * See the pagination section for more details on how to use the starting_after param. + * {% /admonition %}

+ */ + public SyncPagingIterable list(ListConversationsRequest request, RequestOptions requestOptions) { + return this.rawClient.list(request, requestOptions).body(); + } + + /** + * You can create a conversation that has been initiated by a contact (ie. user or lead). + * The conversation can be an in-app message only. + *

{% admonition type="info" name="Sending for visitors" %} + * You can also send a message from a visitor by specifying their user_id or id value in the from field, along with a type field value of contact. + * This visitor will be automatically converted to a contact with a lead role once the conversation is created. + * {% /admonition %}

+ *

This will return the Message model that has been created.

+ */ + public Message create(CreateConversationRequest request) { + return this.rawClient.create(request).body(); + } + + /** + * You can create a conversation that has been initiated by a contact (ie. user or lead). + * The conversation can be an in-app message only. + *

{% admonition type="info" name="Sending for visitors" %} + * You can also send a message from a visitor by specifying their user_id or id value in the from field, along with a type field value of contact. + * This visitor will be automatically converted to a contact with a lead role once the conversation is created. + * {% /admonition %}

+ *

This will return the Message model that has been created.

+ */ + public Message create(CreateConversationRequest request, RequestOptions requestOptions) { + return this.rawClient.create(request, requestOptions).body(); + } + + /** + * You can fetch the details of a single conversation. + *

This will return a single Conversation model with all its conversation parts.

+ *

{% admonition type="warning" name="Hard limit of 500 parts" %} + * The maximum number of conversation parts that can be returned via the API is 500. If you have more than that we will return the 500 most recent conversation parts. + * {% /admonition %}

+ *

For AI agent conversation metadata, please note that you need to have the agent enabled in your workspace, which is a paid feature.

+ */ + public Conversation find(FindConversationRequest request) { + return this.rawClient.find(request).body(); + } + + /** + * You can fetch the details of a single conversation. + *

This will return a single Conversation model with all its conversation parts.

+ *

{% admonition type="warning" name="Hard limit of 500 parts" %} + * The maximum number of conversation parts that can be returned via the API is 500. If you have more than that we will return the 500 most recent conversation parts. + * {% /admonition %}

+ *

For AI agent conversation metadata, please note that you need to have the agent enabled in your workspace, which is a paid feature.

+ */ + public Conversation find(FindConversationRequest request, RequestOptions requestOptions) { + return this.rawClient.find(request, requestOptions).body(); + } + + /** + * You can update an existing conversation. + *

{% admonition type="info" name="Replying and other actions" %} + * If you want to reply to a coveration or take an action such as assign, unassign, open, close or snooze, take a look at the reply and manage endpoints. + * {% /admonition %}

+ *

{% admonition type="info" %} + * This endpoint handles both conversation updates and custom object associations.

+ *

See update a conversation with an association to a custom object instance in the request/response examples to see the custom object association format. + * {% /admonition %}

+ */ + public Conversation update(UpdateConversationRequest request) { + return this.rawClient.update(request).body(); + } + + /** + * You can update an existing conversation. + *

{% admonition type="info" name="Replying and other actions" %} + * If you want to reply to a coveration or take an action such as assign, unassign, open, close or snooze, take a look at the reply and manage endpoints. + * {% /admonition %}

+ *

{% admonition type="info" %} + * This endpoint handles both conversation updates and custom object associations.

+ *

See update a conversation with an association to a custom object instance in the request/response examples to see the custom object association format. + * {% /admonition %}

+ */ + public Conversation update(UpdateConversationRequest request, RequestOptions requestOptions) { + return this.rawClient.update(request, requestOptions).body(); + } + + /** + * You can delete a single conversation. + */ + public ConversationDeleted deleteConversation(DeleteConversationRequest request) { + return this.rawClient.deleteConversation(request).body(); + } + + /** + * You can delete a single conversation. + */ + public ConversationDeleted deleteConversation(DeleteConversationRequest request, RequestOptions requestOptions) { + return this.rawClient.deleteConversation(request, requestOptions).body(); + } + + /** + * You can search for multiple conversations by the value of their attributes in order to fetch exactly which ones you want. + *

To search for conversations, you need to send a POST request to https://api.intercom.io/conversations/search.

+ *

This will accept a query object in the body which will define your filters in order to search for conversations. + * {% admonition type="warning" name="Optimizing search queries" %} + * Search queries can be complex, so optimizing them can help the performance of your search. + * Use the AND and OR operators to combine multiple filters to get the exact results you need and utilize + * pagination to limit the number of results returned. The default is 20 results per page and maximum is 150. + * See the pagination section for more details on how to use the starting_after param. + * {% /admonition %}

+ *

Nesting & Limitations

+ *

You can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4). + * There are some limitations to the amount of multiple's there can be:

+ *
    + *
  • There's a limit of max 2 nested filters
    • + *
  • There's a limit of max 15 filters for each AND or OR group
    • + *
+ *

Accepted Fields

+ *

Most keys listed in the conversation model are searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as created_at accepts a date, the value cannot be a string such as "foorbar"). + * The source.body field is unique as the search will not be performed against the entire value, but instead against every element of the value separately. For example, when searching for a conversation with a "I need support" body - the query should contain a = operator with the value "support" for such conversation to be returned. A query with a = operator and a "need support" value will not yield a result.

+ *

| Field | Type | + * | :---------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------- | + * | id | String | + * | created_at | Date (UNIX timestamp) | + * | updated_at | Date (UNIX timestamp) | + * | source.type | String<br>Accepted fields are conversation, email, facebook, instagram, phone_call, phone_switch, push, sms, twitter and whatsapp. | + * | source.id | String | + * | source.delivered_as | String | + * | source.subject | String | + * | source.body | String | + * | source.author.id | String | + * | source.author.type | String | + * | source.author.name | String | + * | source.author.email | String | + * | source.url | String | + * | contact_ids | String | + * | teammate_ids | String | + * | admin_assignee_id | String | + * | team_assignee_id | String | + * | channel_initiated | String | + * | open | Boolean | + * | read | Boolean | + * | state | String | + * | waiting_since | Date (UNIX timestamp) | + * | snoozed_until | Date (UNIX timestamp) | + * | tag_ids | String | + * | priority | String | + * | statistics.time_to_assignment | Integer | + * | statistics.time_to_admin_reply | Integer | + * | statistics.time_to_first_close | Integer | + * | statistics.time_to_last_close | Integer | + * | statistics.median_time_to_reply | Integer | + * | statistics.first_contact_reply_at | Date (UNIX timestamp) | + * | statistics.first_assignment_at | Date (UNIX timestamp) | + * | statistics.first_admin_reply_at | Date (UNIX timestamp) | + * | statistics.first_close_at | Date (UNIX timestamp) | + * | statistics.last_assignment_at | Date (UNIX timestamp) | + * | statistics.last_assignment_admin_reply_at | Date (UNIX timestamp) | + * | statistics.last_contact_reply_at | Date (UNIX timestamp) | + * | statistics.last_admin_reply_at | Date (UNIX timestamp) | + * | statistics.last_close_at | Date (UNIX timestamp) | + * | statistics.last_closed_by_id | String | + * | statistics.count_reopens | Integer | + * | statistics.count_assignments | Integer | + * | statistics.count_conversation_parts | Integer | + * | conversation_rating.requested_at | Date (UNIX timestamp) | + * | conversation_rating.replied_at | Date (UNIX timestamp) | + * | conversation_rating.score | Integer | + * | conversation_rating.remark | String | + * | conversation_rating.contact_id | String | + * | conversation_rating.admin_d | String | + * | ai_agent_participated | Boolean | + * | ai_agent.resolution_state | String | + * | ai_agent.last_answer_type | String | + * | ai_agent.rating | Integer | + * | ai_agent.rating_remark | String | + * | ai_agent.source_type | String | + * | ai_agent.source_title | String |

+ *

Accepted Operators

+ *

The table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string ("="). The operator has to be compatible with the field's type (eg. you cannot search with > for a given string value as it's only compatible for integer's and dates).

+ *

| Operator | Valid Types | Description | + * | :------- | :----------------------------- | :----------------------------------------------------------- | + * | = | All | Equals | + * | != | All | Doesn't Equal | + * | IN | All | In Shortcut for OR queries Values most be in Array | + * | NIN | All | Not In Shortcut for OR ! queries Values must be in Array | + * | > | Integer Date (UNIX Timestamp) | Greater (or equal) than | + * | < | Integer Date (UNIX Timestamp) | Lower (or equal) than | + * | ~ | String | Contains | + * | !~ | String | Doesn't Contain | + * | ^ | String | Starts With | + * | $ | String | Ends With |

+ */ + public SyncPagingIterable search(SearchRequest request) { + return this.rawClient.search(request).body(); + } + + /** + * You can search for multiple conversations by the value of their attributes in order to fetch exactly which ones you want. + *

To search for conversations, you need to send a POST request to https://api.intercom.io/conversations/search.

+ *

This will accept a query object in the body which will define your filters in order to search for conversations. + * {% admonition type="warning" name="Optimizing search queries" %} + * Search queries can be complex, so optimizing them can help the performance of your search. + * Use the AND and OR operators to combine multiple filters to get the exact results you need and utilize + * pagination to limit the number of results returned. The default is 20 results per page and maximum is 150. + * See the pagination section for more details on how to use the starting_after param. + * {% /admonition %}

+ *

Nesting & Limitations

+ *

You can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4). + * There are some limitations to the amount of multiple's there can be:

+ *
    + *
  • There's a limit of max 2 nested filters
    • + *
  • There's a limit of max 15 filters for each AND or OR group
    • + *
+ *

Accepted Fields

+ *

Most keys listed in the conversation model are searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as created_at accepts a date, the value cannot be a string such as "foorbar"). + * The source.body field is unique as the search will not be performed against the entire value, but instead against every element of the value separately. For example, when searching for a conversation with a "I need support" body - the query should contain a = operator with the value "support" for such conversation to be returned. A query with a = operator and a "need support" value will not yield a result.

+ *

| Field | Type | + * | :---------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------- | + * | id | String | + * | created_at | Date (UNIX timestamp) | + * | updated_at | Date (UNIX timestamp) | + * | source.type | String<br>Accepted fields are conversation, email, facebook, instagram, phone_call, phone_switch, push, sms, twitter and whatsapp. | + * | source.id | String | + * | source.delivered_as | String | + * | source.subject | String | + * | source.body | String | + * | source.author.id | String | + * | source.author.type | String | + * | source.author.name | String | + * | source.author.email | String | + * | source.url | String | + * | contact_ids | String | + * | teammate_ids | String | + * | admin_assignee_id | String | + * | team_assignee_id | String | + * | channel_initiated | String | + * | open | Boolean | + * | read | Boolean | + * | state | String | + * | waiting_since | Date (UNIX timestamp) | + * | snoozed_until | Date (UNIX timestamp) | + * | tag_ids | String | + * | priority | String | + * | statistics.time_to_assignment | Integer | + * | statistics.time_to_admin_reply | Integer | + * | statistics.time_to_first_close | Integer | + * | statistics.time_to_last_close | Integer | + * | statistics.median_time_to_reply | Integer | + * | statistics.first_contact_reply_at | Date (UNIX timestamp) | + * | statistics.first_assignment_at | Date (UNIX timestamp) | + * | statistics.first_admin_reply_at | Date (UNIX timestamp) | + * | statistics.first_close_at | Date (UNIX timestamp) | + * | statistics.last_assignment_at | Date (UNIX timestamp) | + * | statistics.last_assignment_admin_reply_at | Date (UNIX timestamp) | + * | statistics.last_contact_reply_at | Date (UNIX timestamp) | + * | statistics.last_admin_reply_at | Date (UNIX timestamp) | + * | statistics.last_close_at | Date (UNIX timestamp) | + * | statistics.last_closed_by_id | String | + * | statistics.count_reopens | Integer | + * | statistics.count_assignments | Integer | + * | statistics.count_conversation_parts | Integer | + * | conversation_rating.requested_at | Date (UNIX timestamp) | + * | conversation_rating.replied_at | Date (UNIX timestamp) | + * | conversation_rating.score | Integer | + * | conversation_rating.remark | String | + * | conversation_rating.contact_id | String | + * | conversation_rating.admin_d | String | + * | ai_agent_participated | Boolean | + * | ai_agent.resolution_state | String | + * | ai_agent.last_answer_type | String | + * | ai_agent.rating | Integer | + * | ai_agent.rating_remark | String | + * | ai_agent.source_type | String | + * | ai_agent.source_title | String |

+ *

Accepted Operators

+ *

The table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string ("="). The operator has to be compatible with the field's type (eg. you cannot search with > for a given string value as it's only compatible for integer's and dates).

+ *

| Operator | Valid Types | Description | + * | :------- | :----------------------------- | :----------------------------------------------------------- | + * | = | All | Equals | + * | != | All | Doesn't Equal | + * | IN | All | In Shortcut for OR queries Values most be in Array | + * | NIN | All | Not In Shortcut for OR ! queries Values must be in Array | + * | > | Integer Date (UNIX Timestamp) | Greater (or equal) than | + * | < | Integer Date (UNIX Timestamp) | Lower (or equal) than | + * | ~ | String | Contains | + * | !~ | String | Doesn't Contain | + * | ^ | String | Starts With | + * | $ | String | Ends With |

+ */ + public SyncPagingIterable search(SearchRequest request, RequestOptions requestOptions) { + return this.rawClient.search(request, requestOptions).body(); + } + + /** + * You can reply to a conversation with a message from an admin or on behalf of a contact, or with a note for admins. + */ + public Conversation reply(ReplyToConversationRequest request) { + return this.rawClient.reply(request).body(); + } + + /** + * You can reply to a conversation with a message from an admin or on behalf of a contact, or with a note for admins. + */ + public Conversation reply(ReplyToConversationRequest request, RequestOptions requestOptions) { + return this.rawClient.reply(request, requestOptions).body(); + } + + /** + * For managing conversations you can: + *
    + *
  • Close a conversation
    • + *
  • Snooze a conversation to reopen on a future date
    • + *
  • Open a conversation which is snoozed or closed
    • + *
  • Assign a conversation to an admin and/or team.
    • + *
+ */ + public Conversation manage(ManageConversationPartsRequest request) { + return this.rawClient.manage(request).body(); + } + + /** + * For managing conversations you can: + *
    + *
  • Close a conversation
    • + *
  • Snooze a conversation to reopen on a future date
    • + *
  • Open a conversation which is snoozed or closed
    • + *
  • Assign a conversation to an admin and/or team.
    • + *
+ */ + public Conversation manage(ManageConversationPartsRequest request, RequestOptions requestOptions) { + return this.rawClient.manage(request, requestOptions).body(); + } + + /** + * You can add participants who are contacts to a conversation, on behalf of either another contact or an admin. + *

{% admonition type="warning" name="Contacts without an email" %} + * If you add a contact via the email parameter and there is no user/lead found on that workspace with he given email, then we will create a new contact with role set to lead. + * {% /admonition %}

+ */ + public Conversation attachContactAsAdmin(AttachContactToConversationRequest request) { + return this.rawClient.attachContactAsAdmin(request).body(); + } + + /** + * You can add participants who are contacts to a conversation, on behalf of either another contact or an admin. + *

{% admonition type="warning" name="Contacts without an email" %} + * If you add a contact via the email parameter and there is no user/lead found on that workspace with he given email, then we will create a new contact with role set to lead. + * {% /admonition %}

+ */ + public Conversation attachContactAsAdmin( + AttachContactToConversationRequest request, RequestOptions requestOptions) { + return this.rawClient.attachContactAsAdmin(request, requestOptions).body(); + } + + /** + * You can add participants who are contacts to a conversation, on behalf of either another contact or an admin. + *

{% admonition type="warning" name="Contacts without an email" %} + * If you add a contact via the email parameter and there is no user/lead found on that workspace with he given email, then we will create a new contact with role set to lead. + * {% /admonition %}

+ */ + public Conversation detachContactAsAdmin(DetachContactFromConversationRequest request) { + return this.rawClient.detachContactAsAdmin(request).body(); + } + + /** + * You can add participants who are contacts to a conversation, on behalf of either another contact or an admin. + *

{% admonition type="warning" name="Contacts without an email" %} + * If you add a contact via the email parameter and there is no user/lead found on that workspace with he given email, then we will create a new contact with role set to lead. + * {% /admonition %}

+ */ + public Conversation detachContactAsAdmin( + DetachContactFromConversationRequest request, RequestOptions requestOptions) { + return this.rawClient.detachContactAsAdmin(request, requestOptions).body(); + } + + /** + * You can redact a conversation part or the source message of a conversation (as seen in the source object). + *

{% admonition type="info" name="Redacting parts and messages" %} + * If you are redacting a conversation part, it must have a body. If you are redacting a source message, it must have been created by a contact. We will return a conversation_part_not_redactable error if these criteria are not met. + * {% /admonition %}

+ */ + public Conversation redactConversationPart(RedactConversationRequest request) { + return this.rawClient.redactConversationPart(request).body(); + } + + /** + * You can redact a conversation part or the source message of a conversation (as seen in the source object). + *

{% admonition type="info" name="Redacting parts and messages" %} + * If you are redacting a conversation part, it must have a body. If you are redacting a source message, it must have been created by a contact. We will return a conversation_part_not_redactable error if these criteria are not met. + * {% /admonition %}

+ */ + public Conversation redactConversationPart(RedactConversationRequest request, RequestOptions requestOptions) { + return this.rawClient.redactConversationPart(request, requestOptions).body(); + } + + /** + * You can convert a conversation to a ticket. + */ + public Optional convertToTicket(ConvertConversationToTicketRequest request) { + return this.rawClient.convertToTicket(request).body(); + } + + /** + * You can convert a conversation to a ticket. + */ + public Optional convertToTicket(ConvertConversationToTicketRequest request, RequestOptions requestOptions) { + return this.rawClient.convertToTicket(request, requestOptions).body(); + } + + /** + * {% admonition type="danger" name="Deprecation of Run Assignment Rules" %} + * Run assignment rules is now deprecated in version 2.12 and future versions and will be permanently removed on December 31, 2026. After this date, any requests made to this endpoint will fail. + * {% /admonition %} + * You can let a conversation be automatically assigned following assignment rules. + * {% admonition type="warning" name="When using workflows" %} + * It is not possible to use this endpoint with Workflows. + * {% /admonition %} + */ + public Conversation runAssignmentRules(AutoAssignConversationRequest request) { + return this.rawClient.runAssignmentRules(request).body(); + } + + /** + * {% admonition type="danger" name="Deprecation of Run Assignment Rules" %} + * Run assignment rules is now deprecated in version 2.12 and future versions and will be permanently removed on December 31, 2026. After this date, any requests made to this endpoint will fail. + * {% /admonition %} + * You can let a conversation be automatically assigned following assignment rules. + * {% admonition type="warning" name="When using workflows" %} + * It is not possible to use this endpoint with Workflows. + * {% /admonition %} + */ + public Conversation runAssignmentRules(AutoAssignConversationRequest request, RequestOptions requestOptions) { + return this.rawClient.runAssignmentRules(request, requestOptions).body(); + } +} diff --git a/src/main/java/com/intercom/api/resources/conversations/RawConversationsClient.java b/src/main/java/com/intercom/api/resources/conversations/RawConversationsClient.java new file mode 100644 index 00000000..cc3f0f17 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/conversations/RawConversationsClient.java @@ -0,0 +1,1182 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.conversations; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.fasterxml.jackson.core.type.TypeReference; +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.IntercomApiException; +import com.intercom.api.core.IntercomException; +import com.intercom.api.core.IntercomHttpResponse; +import com.intercom.api.core.MediaTypes; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.core.QueryStringMapper; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.core.pagination.SyncPagingIterable; +import com.intercom.api.errors.BadRequestError; +import com.intercom.api.errors.ForbiddenError; +import com.intercom.api.errors.NotFoundError; +import com.intercom.api.errors.UnauthorizedError; +import com.intercom.api.errors.UnprocessableEntityError; +import com.intercom.api.resources.conversations.requests.AttachContactToConversationRequest; +import com.intercom.api.resources.conversations.requests.AutoAssignConversationRequest; +import com.intercom.api.resources.conversations.requests.ConvertConversationToTicketRequest; +import com.intercom.api.resources.conversations.requests.CreateConversationRequest; +import com.intercom.api.resources.conversations.requests.DeleteConversationRequest; +import com.intercom.api.resources.conversations.requests.DetachContactFromConversationRequest; +import com.intercom.api.resources.conversations.requests.FindConversationRequest; +import com.intercom.api.resources.conversations.requests.ListConversationsRequest; +import com.intercom.api.resources.conversations.requests.ManageConversationPartsRequest; +import com.intercom.api.resources.conversations.requests.ReplyToConversationRequest; +import com.intercom.api.resources.conversations.requests.UpdateConversationRequest; +import com.intercom.api.resources.conversations.types.Conversation; +import com.intercom.api.resources.messages.types.Message; +import com.intercom.api.resources.tickets.types.Ticket; +import com.intercom.api.types.ConversationDeleted; +import com.intercom.api.types.ConversationList; +import com.intercom.api.types.CursorPages; +import com.intercom.api.types.Error; +import com.intercom.api.types.RedactConversationRequest; +import com.intercom.api.types.SearchRequest; +import com.intercom.api.types.StartingAfterPaging; +import java.io.IOException; +import java.util.Collections; +import java.util.List; +import java.util.Optional; +import okhttp3.Headers; +import okhttp3.HttpUrl; +import okhttp3.OkHttpClient; +import okhttp3.Request; +import okhttp3.RequestBody; +import okhttp3.Response; +import okhttp3.ResponseBody; + +public class RawConversationsClient { + protected final ClientOptions clientOptions; + + public RawConversationsClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + } + + /** + * You can fetch a list of all conversations. + *

You can optionally request the result page size and the cursor to start after to fetch the result. + * {% admonition type="warning" name="Pagination" %} + * You can use pagination to limit the number of results returned. The default is 20 results per page. + * See the pagination section for more details on how to use the starting_after param. + * {% /admonition %}

+ */ + public IntercomHttpResponse> list() { + return list(ListConversationsRequest.builder().build()); + } + + /** + * You can fetch a list of all conversations. + *

You can optionally request the result page size and the cursor to start after to fetch the result. + * {% admonition type="warning" name="Pagination" %} + * You can use pagination to limit the number of results returned. The default is 20 results per page. + * See the pagination section for more details on how to use the starting_after param. + * {% /admonition %}

+ */ + public IntercomHttpResponse> list(ListConversationsRequest request) { + return list(request, null); + } + + /** + * You can fetch a list of all conversations. + *

You can optionally request the result page size and the cursor to start after to fetch the result. + * {% admonition type="warning" name="Pagination" %} + * You can use pagination to limit the number of results returned. The default is 20 results per page. + * See the pagination section for more details on how to use the starting_after param. + * {% /admonition %}

+ */ + public IntercomHttpResponse> list( + ListConversationsRequest request, RequestOptions requestOptions) { + HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("conversations"); + if (request.getPerPage().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "per_page", request.getPerPage().get(), false); + } + if (request.getStartingAfter().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "starting_after", request.getStartingAfter().get(), false); + } + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl.build()) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + ConversationList parsedResponse = + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, ConversationList.class); + Optional startingAfter = parsedResponse + .getPages() + .flatMap(CursorPages::getNext) + .flatMap(StartingAfterPaging::getStartingAfter); + ListConversationsRequest nextRequest = ListConversationsRequest.builder() + .from(request) + .startingAfter(startingAfter) + .build(); + List result = parsedResponse.getConversations().orElse(Collections.emptyList()); + return new IntercomHttpResponse<>( + new SyncPagingIterable( + startingAfter.isPresent(), result, parsedResponse, () -> list( + nextRequest, requestOptions) + .body()), + response); + } + try { + switch (response.code()) { + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 403: + throw new ForbiddenError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can create a conversation that has been initiated by a contact (ie. user or lead). + * The conversation can be an in-app message only. + *

{% admonition type="info" name="Sending for visitors" %} + * You can also send a message from a visitor by specifying their user_id or id value in the from field, along with a type field value of contact. + * This visitor will be automatically converted to a contact with a lead role once the conversation is created. + * {% /admonition %}

+ *

This will return the Message model that has been created.

+ */ + public IntercomHttpResponse create(CreateConversationRequest request) { + return create(request, null); + } + + /** + * You can create a conversation that has been initiated by a contact (ie. user or lead). + * The conversation can be an in-app message only. + *

{% admonition type="info" name="Sending for visitors" %} + * You can also send a message from a visitor by specifying their user_id or id value in the from field, along with a type field value of contact. + * This visitor will be automatically converted to a contact with a lead role once the conversation is created. + * {% /admonition %}

+ *

This will return the Message model that has been created.

+ */ + public IntercomHttpResponse create(CreateConversationRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("conversations") + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Message.class), response); + } + try { + switch (response.code()) { + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 403: + throw new ForbiddenError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 404: + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can fetch the details of a single conversation. + *

This will return a single Conversation model with all its conversation parts.

+ *

{% admonition type="warning" name="Hard limit of 500 parts" %} + * The maximum number of conversation parts that can be returned via the API is 500. If you have more than that we will return the 500 most recent conversation parts. + * {% /admonition %}

+ *

For AI agent conversation metadata, please note that you need to have the agent enabled in your workspace, which is a paid feature.

+ */ + public IntercomHttpResponse find(FindConversationRequest request) { + return find(request, null); + } + + /** + * You can fetch the details of a single conversation. + *

This will return a single Conversation model with all its conversation parts.

+ *

{% admonition type="warning" name="Hard limit of 500 parts" %} + * The maximum number of conversation parts that can be returned via the API is 500. If you have more than that we will return the 500 most recent conversation parts. + * {% /admonition %}

+ *

For AI agent conversation metadata, please note that you need to have the agent enabled in your workspace, which is a paid feature.

+ */ + public IntercomHttpResponse find(FindConversationRequest request, RequestOptions requestOptions) { + HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("conversations") + .addPathSegment(request.getConversationId()); + if (request.getDisplayAs().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "display_as", request.getDisplayAs().get(), false); + } + if (request.getIncludeTranslations().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, + "include_translations", + request.getIncludeTranslations().get(), + false); + } + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl.build()) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Conversation.class), response); + } + try { + switch (response.code()) { + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 403: + throw new ForbiddenError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 404: + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can update an existing conversation. + *

{% admonition type="info" name="Replying and other actions" %} + * If you want to reply to a coveration or take an action such as assign, unassign, open, close or snooze, take a look at the reply and manage endpoints. + * {% /admonition %}

+ *

{% admonition type="info" %} + * This endpoint handles both conversation updates and custom object associations.

+ *

See update a conversation with an association to a custom object instance in the request/response examples to see the custom object association format. + * {% /admonition %}

+ */ + public IntercomHttpResponse update(UpdateConversationRequest request) { + return update(request, null); + } + + /** + * You can update an existing conversation. + *

{% admonition type="info" name="Replying and other actions" %} + * If you want to reply to a coveration or take an action such as assign, unassign, open, close or snooze, take a look at the reply and manage endpoints. + * {% /admonition %}

+ *

{% admonition type="info" %} + * This endpoint handles both conversation updates and custom object associations.

+ *

See update a conversation with an association to a custom object instance in the request/response examples to see the custom object association format. + * {% /admonition %}

+ */ + public IntercomHttpResponse update(UpdateConversationRequest request, RequestOptions requestOptions) { + HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("conversations") + .addPathSegment(request.getConversationId()); + if (request.getDisplayAs().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "display_as", request.getDisplayAs().get(), false); + } + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (Exception e) { + throw new RuntimeException(e); + } + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl.build()) + .method("PUT", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Conversation.class), response); + } + try { + switch (response.code()) { + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 403: + throw new ForbiddenError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 404: + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can delete a single conversation. + */ + public IntercomHttpResponse deleteConversation(DeleteConversationRequest request) { + return deleteConversation(request, null); + } + + /** + * You can delete a single conversation. + */ + public IntercomHttpResponse deleteConversation( + DeleteConversationRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("conversations") + .addPathSegment(Integer.toString(request.getConversationId())) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("DELETE", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, ConversationDeleted.class), response); + } + try { + switch (response.code()) { + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 403: + throw new ForbiddenError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can search for multiple conversations by the value of their attributes in order to fetch exactly which ones you want. + *

To search for conversations, you need to send a POST request to https://api.intercom.io/conversations/search.

+ *

This will accept a query object in the body which will define your filters in order to search for conversations. + * {% admonition type="warning" name="Optimizing search queries" %} + * Search queries can be complex, so optimizing them can help the performance of your search. + * Use the AND and OR operators to combine multiple filters to get the exact results you need and utilize + * pagination to limit the number of results returned. The default is 20 results per page and maximum is 150. + * See the pagination section for more details on how to use the starting_after param. + * {% /admonition %}

+ *

Nesting & Limitations

+ *

You can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4). + * There are some limitations to the amount of multiple's there can be:

+ *
    + *
  • There's a limit of max 2 nested filters
    • + *
  • There's a limit of max 15 filters for each AND or OR group
    • + *
+ *

Accepted Fields

+ *

Most keys listed in the conversation model are searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as created_at accepts a date, the value cannot be a string such as "foorbar"). + * The source.body field is unique as the search will not be performed against the entire value, but instead against every element of the value separately. For example, when searching for a conversation with a "I need support" body - the query should contain a = operator with the value "support" for such conversation to be returned. A query with a = operator and a "need support" value will not yield a result.

+ *

| Field | Type | + * | :---------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------- | + * | id | String | + * | created_at | Date (UNIX timestamp) | + * | updated_at | Date (UNIX timestamp) | + * | source.type | String<br>Accepted fields are conversation, email, facebook, instagram, phone_call, phone_switch, push, sms, twitter and whatsapp. | + * | source.id | String | + * | source.delivered_as | String | + * | source.subject | String | + * | source.body | String | + * | source.author.id | String | + * | source.author.type | String | + * | source.author.name | String | + * | source.author.email | String | + * | source.url | String | + * | contact_ids | String | + * | teammate_ids | String | + * | admin_assignee_id | String | + * | team_assignee_id | String | + * | channel_initiated | String | + * | open | Boolean | + * | read | Boolean | + * | state | String | + * | waiting_since | Date (UNIX timestamp) | + * | snoozed_until | Date (UNIX timestamp) | + * | tag_ids | String | + * | priority | String | + * | statistics.time_to_assignment | Integer | + * | statistics.time_to_admin_reply | Integer | + * | statistics.time_to_first_close | Integer | + * | statistics.time_to_last_close | Integer | + * | statistics.median_time_to_reply | Integer | + * | statistics.first_contact_reply_at | Date (UNIX timestamp) | + * | statistics.first_assignment_at | Date (UNIX timestamp) | + * | statistics.first_admin_reply_at | Date (UNIX timestamp) | + * | statistics.first_close_at | Date (UNIX timestamp) | + * | statistics.last_assignment_at | Date (UNIX timestamp) | + * | statistics.last_assignment_admin_reply_at | Date (UNIX timestamp) | + * | statistics.last_contact_reply_at | Date (UNIX timestamp) | + * | statistics.last_admin_reply_at | Date (UNIX timestamp) | + * | statistics.last_close_at | Date (UNIX timestamp) | + * | statistics.last_closed_by_id | String | + * | statistics.count_reopens | Integer | + * | statistics.count_assignments | Integer | + * | statistics.count_conversation_parts | Integer | + * | conversation_rating.requested_at | Date (UNIX timestamp) | + * | conversation_rating.replied_at | Date (UNIX timestamp) | + * | conversation_rating.score | Integer | + * | conversation_rating.remark | String | + * | conversation_rating.contact_id | String | + * | conversation_rating.admin_d | String | + * | ai_agent_participated | Boolean | + * | ai_agent.resolution_state | String | + * | ai_agent.last_answer_type | String | + * | ai_agent.rating | Integer | + * | ai_agent.rating_remark | String | + * | ai_agent.source_type | String | + * | ai_agent.source_title | String |

+ *

Accepted Operators

+ *

The table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string ("="). The operator has to be compatible with the field's type (eg. you cannot search with > for a given string value as it's only compatible for integer's and dates).

+ *

| Operator | Valid Types | Description | + * | :------- | :----------------------------- | :----------------------------------------------------------- | + * | = | All | Equals | + * | != | All | Doesn't Equal | + * | IN | All | In Shortcut for OR queries Values most be in Array | + * | NIN | All | Not In Shortcut for OR ! queries Values must be in Array | + * | > | Integer Date (UNIX Timestamp) | Greater (or equal) than | + * | < | Integer Date (UNIX Timestamp) | Lower (or equal) than | + * | ~ | String | Contains | + * | !~ | String | Doesn't Contain | + * | ^ | String | Starts With | + * | $ | String | Ends With |

+ */ + public IntercomHttpResponse> search(SearchRequest request) { + return search(request, null); + } + + /** + * You can search for multiple conversations by the value of their attributes in order to fetch exactly which ones you want. + *

To search for conversations, you need to send a POST request to https://api.intercom.io/conversations/search.

+ *

This will accept a query object in the body which will define your filters in order to search for conversations. + * {% admonition type="warning" name="Optimizing search queries" %} + * Search queries can be complex, so optimizing them can help the performance of your search. + * Use the AND and OR operators to combine multiple filters to get the exact results you need and utilize + * pagination to limit the number of results returned. The default is 20 results per page and maximum is 150. + * See the pagination section for more details on how to use the starting_after param. + * {% /admonition %}

+ *

Nesting & Limitations

+ *

You can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4). + * There are some limitations to the amount of multiple's there can be:

+ *
    + *
  • There's a limit of max 2 nested filters
    • + *
  • There's a limit of max 15 filters for each AND or OR group
    • + *
+ *

Accepted Fields

+ *

Most keys listed in the conversation model are searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as created_at accepts a date, the value cannot be a string such as "foorbar"). + * The source.body field is unique as the search will not be performed against the entire value, but instead against every element of the value separately. For example, when searching for a conversation with a "I need support" body - the query should contain a = operator with the value "support" for such conversation to be returned. A query with a = operator and a "need support" value will not yield a result.

+ *

| Field | Type | + * | :---------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------- | + * | id | String | + * | created_at | Date (UNIX timestamp) | + * | updated_at | Date (UNIX timestamp) | + * | source.type | String<br>Accepted fields are conversation, email, facebook, instagram, phone_call, phone_switch, push, sms, twitter and whatsapp. | + * | source.id | String | + * | source.delivered_as | String | + * | source.subject | String | + * | source.body | String | + * | source.author.id | String | + * | source.author.type | String | + * | source.author.name | String | + * | source.author.email | String | + * | source.url | String | + * | contact_ids | String | + * | teammate_ids | String | + * | admin_assignee_id | String | + * | team_assignee_id | String | + * | channel_initiated | String | + * | open | Boolean | + * | read | Boolean | + * | state | String | + * | waiting_since | Date (UNIX timestamp) | + * | snoozed_until | Date (UNIX timestamp) | + * | tag_ids | String | + * | priority | String | + * | statistics.time_to_assignment | Integer | + * | statistics.time_to_admin_reply | Integer | + * | statistics.time_to_first_close | Integer | + * | statistics.time_to_last_close | Integer | + * | statistics.median_time_to_reply | Integer | + * | statistics.first_contact_reply_at | Date (UNIX timestamp) | + * | statistics.first_assignment_at | Date (UNIX timestamp) | + * | statistics.first_admin_reply_at | Date (UNIX timestamp) | + * | statistics.first_close_at | Date (UNIX timestamp) | + * | statistics.last_assignment_at | Date (UNIX timestamp) | + * | statistics.last_assignment_admin_reply_at | Date (UNIX timestamp) | + * | statistics.last_contact_reply_at | Date (UNIX timestamp) | + * | statistics.last_admin_reply_at | Date (UNIX timestamp) | + * | statistics.last_close_at | Date (UNIX timestamp) | + * | statistics.last_closed_by_id | String | + * | statistics.count_reopens | Integer | + * | statistics.count_assignments | Integer | + * | statistics.count_conversation_parts | Integer | + * | conversation_rating.requested_at | Date (UNIX timestamp) | + * | conversation_rating.replied_at | Date (UNIX timestamp) | + * | conversation_rating.score | Integer | + * | conversation_rating.remark | String | + * | conversation_rating.contact_id | String | + * | conversation_rating.admin_d | String | + * | ai_agent_participated | Boolean | + * | ai_agent.resolution_state | String | + * | ai_agent.last_answer_type | String | + * | ai_agent.rating | Integer | + * | ai_agent.rating_remark | String | + * | ai_agent.source_type | String | + * | ai_agent.source_title | String |

+ *

Accepted Operators

+ *

The table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string ("="). The operator has to be compatible with the field's type (eg. you cannot search with > for a given string value as it's only compatible for integer's and dates).

+ *

| Operator | Valid Types | Description | + * | :------- | :----------------------------- | :----------------------------------------------------------- | + * | = | All | Equals | + * | != | All | Doesn't Equal | + * | IN | All | In Shortcut for OR queries Values most be in Array | + * | NIN | All | Not In Shortcut for OR ! queries Values must be in Array | + * | > | Integer Date (UNIX Timestamp) | Greater (or equal) than | + * | < | Integer Date (UNIX Timestamp) | Lower (or equal) than | + * | ~ | String | Contains | + * | !~ | String | Doesn't Contain | + * | ^ | String | Starts With | + * | $ | String | Ends With |

+ */ + public IntercomHttpResponse> search( + SearchRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("conversations/search") + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + ConversationList parsedResponse = + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, ConversationList.class); + Optional startingAfter = parsedResponse + .getPages() + .flatMap(CursorPages::getNext) + .flatMap(StartingAfterPaging::getStartingAfter); + Optional pagination = request.getPagination() + .map((StartingAfterPaging pagination_) -> StartingAfterPaging.builder() + .from(pagination_) + .startingAfter(startingAfter) + .build()); + SearchRequest nextRequest = SearchRequest.builder() + .from(request) + .pagination(pagination) + .build(); + List result = parsedResponse.getConversations().orElse(Collections.emptyList()); + return new IntercomHttpResponse<>( + new SyncPagingIterable( + startingAfter.isPresent(), result, parsedResponse, () -> search( + nextRequest, requestOptions) + .body()), + response); + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can reply to a conversation with a message from an admin or on behalf of a contact, or with a note for admins. + */ + public IntercomHttpResponse reply(ReplyToConversationRequest request) { + return reply(request, null); + } + + /** + * You can reply to a conversation with a message from an admin or on behalf of a contact, or with a note for admins. + */ + public IntercomHttpResponse reply(ReplyToConversationRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("conversations") + .addPathSegment(request.getConversationId()) + .addPathSegments("reply") + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request.getBody()), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Conversation.class), response); + } + try { + switch (response.code()) { + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 403: + throw new ForbiddenError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 404: + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * For managing conversations you can: + *
    + *
  • Close a conversation
    • + *
  • Snooze a conversation to reopen on a future date
    • + *
  • Open a conversation which is snoozed or closed
    • + *
  • Assign a conversation to an admin and/or team.
    • + *
+ */ + public IntercomHttpResponse manage(ManageConversationPartsRequest request) { + return manage(request, null); + } + + /** + * For managing conversations you can: + *
    + *
  • Close a conversation
    • + *
  • Snooze a conversation to reopen on a future date
    • + *
  • Open a conversation which is snoozed or closed
    • + *
  • Assign a conversation to an admin and/or team.
    • + *
+ */ + public IntercomHttpResponse manage( + ManageConversationPartsRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("conversations") + .addPathSegment(request.getConversationId()) + .addPathSegments("parts") + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request.getBody()), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Conversation.class), response); + } + try { + switch (response.code()) { + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 403: + throw new ForbiddenError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 404: + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can add participants who are contacts to a conversation, on behalf of either another contact or an admin. + *

{% admonition type="warning" name="Contacts without an email" %} + * If you add a contact via the email parameter and there is no user/lead found on that workspace with he given email, then we will create a new contact with role set to lead. + * {% /admonition %}

+ */ + public IntercomHttpResponse attachContactAsAdmin(AttachContactToConversationRequest request) { + return attachContactAsAdmin(request, null); + } + + /** + * You can add participants who are contacts to a conversation, on behalf of either another contact or an admin. + *

{% admonition type="warning" name="Contacts without an email" %} + * If you add a contact via the email parameter and there is no user/lead found on that workspace with he given email, then we will create a new contact with role set to lead. + * {% /admonition %}

+ */ + public IntercomHttpResponse attachContactAsAdmin( + AttachContactToConversationRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("conversations") + .addPathSegment(request.getConversationId()) + .addPathSegments("customers") + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Conversation.class), response); + } + try { + switch (response.code()) { + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 403: + throw new ForbiddenError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 404: + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can add participants who are contacts to a conversation, on behalf of either another contact or an admin. + *

{% admonition type="warning" name="Contacts without an email" %} + * If you add a contact via the email parameter and there is no user/lead found on that workspace with he given email, then we will create a new contact with role set to lead. + * {% /admonition %}

+ */ + public IntercomHttpResponse detachContactAsAdmin(DetachContactFromConversationRequest request) { + return detachContactAsAdmin(request, null); + } + + /** + * You can add participants who are contacts to a conversation, on behalf of either another contact or an admin. + *

{% admonition type="warning" name="Contacts without an email" %} + * If you add a contact via the email parameter and there is no user/lead found on that workspace with he given email, then we will create a new contact with role set to lead. + * {% /admonition %}

+ */ + public IntercomHttpResponse detachContactAsAdmin( + DetachContactFromConversationRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("conversations") + .addPathSegment(request.getConversationId()) + .addPathSegments("customers") + .addPathSegment(request.getContactId()) + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("DELETE", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Conversation.class), response); + } + try { + switch (response.code()) { + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 403: + throw new ForbiddenError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 404: + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + case 422: + throw new UnprocessableEntityError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can redact a conversation part or the source message of a conversation (as seen in the source object). + *

{% admonition type="info" name="Redacting parts and messages" %} + * If you are redacting a conversation part, it must have a body. If you are redacting a source message, it must have been created by a contact. We will return a conversation_part_not_redactable error if these criteria are not met. + * {% /admonition %}

+ */ + public IntercomHttpResponse redactConversationPart(RedactConversationRequest request) { + return redactConversationPart(request, null); + } + + /** + * You can redact a conversation part or the source message of a conversation (as seen in the source object). + *

{% admonition type="info" name="Redacting parts and messages" %} + * If you are redacting a conversation part, it must have a body. If you are redacting a source message, it must have been created by a contact. We will return a conversation_part_not_redactable error if these criteria are not met. + * {% /admonition %}

+ */ + public IntercomHttpResponse redactConversationPart( + RedactConversationRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("conversations/redact") + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Conversation.class), response); + } + try { + switch (response.code()) { + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 404: + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can convert a conversation to a ticket. + */ + public IntercomHttpResponse> convertToTicket(ConvertConversationToTicketRequest request) { + return convertToTicket(request, null); + } + + /** + * You can convert a conversation to a ticket. + */ + public IntercomHttpResponse> convertToTicket( + ConvertConversationToTicketRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("conversations") + .addPathSegment(Integer.toString(request.getConversationId())) + .addPathSegments("convert") + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue( + responseBodyString, new TypeReference>() {}), + response); + } + try { + if (response.code() == 400) { + throw new BadRequestError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * {% admonition type="danger" name="Deprecation of Run Assignment Rules" %} + * Run assignment rules is now deprecated in version 2.12 and future versions and will be permanently removed on December 31, 2026. After this date, any requests made to this endpoint will fail. + * {% /admonition %} + * You can let a conversation be automatically assigned following assignment rules. + * {% admonition type="warning" name="When using workflows" %} + * It is not possible to use this endpoint with Workflows. + * {% /admonition %} + */ + public IntercomHttpResponse runAssignmentRules(AutoAssignConversationRequest request) { + return runAssignmentRules(request, null); + } + + /** + * {% admonition type="danger" name="Deprecation of Run Assignment Rules" %} + * Run assignment rules is now deprecated in version 2.12 and future versions and will be permanently removed on December 31, 2026. After this date, any requests made to this endpoint will fail. + * {% /admonition %} + * You can let a conversation be automatically assigned following assignment rules. + * {% admonition type="warning" name="When using workflows" %} + * It is not possible to use this endpoint with Workflows. + * {% /admonition %} + */ + public IntercomHttpResponse runAssignmentRules( + AutoAssignConversationRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("conversations") + .addPathSegment(request.getConversationId()) + .addPathSegments("run_assignment_rules") + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("POST", RequestBody.create("", null)) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Conversation.class), response); + } + try { + switch (response.code()) { + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 403: + throw new ForbiddenError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 404: + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/conversations/requests/AttachContactToConversationRequest.java b/src/main/java/com/intercom/api/resources/conversations/requests/AttachContactToConversationRequest.java new file mode 100644 index 00000000..c22dcd56 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/conversations/requests/AttachContactToConversationRequest.java @@ -0,0 +1,668 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.conversations.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.JsonValue; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.core.JsonParseException; +import com.fasterxml.jackson.core.JsonParser; +import com.fasterxml.jackson.databind.DeserializationContext; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.fasterxml.jackson.databind.deser.std.StdDeserializer; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.types.CustomerRequest; +import java.io.IOException; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = AttachContactToConversationRequest.Builder.class) +public final class AttachContactToConversationRequest { + private final String conversationId; + + private final Optional adminId; + + private final Optional customer; + + private final Map additionalProperties; + + private AttachContactToConversationRequest( + String conversationId, + Optional adminId, + Optional customer, + Map additionalProperties) { + this.conversationId = conversationId; + this.adminId = adminId; + this.customer = customer; + this.additionalProperties = additionalProperties; + } + + /** + * @return The identifier for the conversation as given by Intercom. + */ + @JsonProperty("conversation_id") + public String getConversationId() { + return conversationId; + } + + /** + * @return The id of the admin who is adding the new participant. + */ + @JsonProperty("admin_id") + public Optional getAdminId() { + return adminId; + } + + @JsonProperty("customer") + public Optional getCustomer() { + return customer; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof AttachContactToConversationRequest + && equalTo((AttachContactToConversationRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(AttachContactToConversationRequest other) { + return conversationId.equals(other.conversationId) + && adminId.equals(other.adminId) + && customer.equals(other.customer); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.conversationId, this.adminId, this.customer); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static ConversationIdStage builder() { + return new Builder(); + } + + public interface ConversationIdStage { + /** + *

The identifier for the conversation as given by Intercom.

+ */ + _FinalStage conversationId(@NotNull String conversationId); + + Builder from(AttachContactToConversationRequest other); + } + + public interface _FinalStage { + AttachContactToConversationRequest build(); + + /** + *

The id of the admin who is adding the new participant.

+ */ + _FinalStage adminId(Optional adminId); + + _FinalStage adminId(String adminId); + + _FinalStage customer(Optional customer); + + _FinalStage customer(Customer customer); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements ConversationIdStage, _FinalStage { + private String conversationId; + + private Optional customer = Optional.empty(); + + private Optional adminId = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(AttachContactToConversationRequest other) { + conversationId(other.getConversationId()); + adminId(other.getAdminId()); + customer(other.getCustomer()); + return this; + } + + /** + *

The identifier for the conversation as given by Intercom.

+ *

The identifier for the conversation as given by Intercom.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("conversation_id") + public _FinalStage conversationId(@NotNull String conversationId) { + this.conversationId = Objects.requireNonNull(conversationId, "conversationId must not be null"); + return this; + } + + @java.lang.Override + public _FinalStage customer(Customer customer) { + this.customer = Optional.ofNullable(customer); + return this; + } + + @java.lang.Override + @JsonSetter(value = "customer", nulls = Nulls.SKIP) + public _FinalStage customer(Optional customer) { + this.customer = customer; + return this; + } + + /** + *

The id of the admin who is adding the new participant.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage adminId(String adminId) { + this.adminId = Optional.ofNullable(adminId); + return this; + } + + /** + *

The id of the admin who is adding the new participant.

+ */ + @java.lang.Override + @JsonSetter(value = "admin_id", nulls = Nulls.SKIP) + public _FinalStage adminId(Optional adminId) { + this.adminId = adminId; + return this; + } + + @java.lang.Override + public AttachContactToConversationRequest build() { + return new AttachContactToConversationRequest(conversationId, adminId, customer, additionalProperties); + } + } + + @JsonDeserialize(using = Customer.Deserializer.class) + public static final class Customer { + private final Object value; + + private final int type; + + private Customer(Object value, int type) { + this.value = value; + this.type = type; + } + + @JsonValue + public Object get() { + return this.value; + } + + @SuppressWarnings("unchecked") + public T visit(Visitor visitor) { + if (this.type == 0) { + return visitor.visit((IntercomUserId) this.value); + } else if (this.type == 1) { + return visitor.visit((UserId) this.value); + } else if (this.type == 2) { + return visitor.visit((Customer_) this.value); + } + throw new IllegalStateException("Failed to visit value. This should never happen."); + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof Customer && equalTo((Customer) other); + } + + private boolean equalTo(Customer other) { + return value.equals(other.value); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.value); + } + + @java.lang.Override + public String toString() { + return this.value.toString(); + } + + public static Customer of(IntercomUserId value) { + return new Customer(value, 0); + } + + public static Customer of(UserId value) { + return new Customer(value, 1); + } + + public static Customer of(Customer_ value) { + return new Customer(value, 2); + } + + public interface Visitor { + T visit(IntercomUserId value); + + T visit(UserId value); + + T visit(Customer_ value); + } + + static final class Deserializer extends StdDeserializer { + Deserializer() { + super(Customer.class); + } + + @java.lang.Override + public Customer deserialize(JsonParser p, DeserializationContext context) throws IOException { + Object value = p.readValueAs(Object.class); + try { + return of(ObjectMappers.JSON_MAPPER.convertValue(value, IntercomUserId.class)); + } catch (RuntimeException e) { + } + try { + return of(ObjectMappers.JSON_MAPPER.convertValue(value, UserId.class)); + } catch (RuntimeException e) { + } + try { + return of(ObjectMappers.JSON_MAPPER.convertValue(value, Customer_.class)); + } catch (RuntimeException e) { + } + throw new JsonParseException(p, "Failed to deserialize"); + } + } + + @JsonInclude(JsonInclude.Include.NON_ABSENT) + @JsonDeserialize(builder = UserId.Builder.class) + public static final class UserId { + private final String userId; + + private final Optional customer; + + private final Map additionalProperties; + + private UserId( + String userId, Optional customer, Map additionalProperties) { + this.userId = userId; + this.customer = customer; + this.additionalProperties = additionalProperties; + } + + /** + * @return The external_id you have defined for the contact who is being added as a participant. + */ + @JsonProperty("user_id") + public String getUserId() { + return userId; + } + + @JsonProperty("customer") + public Optional getCustomer() { + return customer; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof UserId && equalTo((UserId) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(UserId other) { + return userId.equals(other.userId) && customer.equals(other.customer); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.userId, this.customer); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static UserIdStage builder() { + return new Builder(); + } + + public interface UserIdStage { + /** + *

The external_id you have defined for the contact who is being added as a participant.

+ */ + _FinalStage userId(@NotNull String userId); + + Builder from(UserId other); + } + + public interface _FinalStage { + UserId build(); + + _FinalStage customer(Optional customer); + + _FinalStage customer(CustomerRequest customer); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements UserIdStage, _FinalStage { + private String userId; + + private Optional customer = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(UserId other) { + userId(other.getUserId()); + customer(other.getCustomer()); + return this; + } + + /** + *

The external_id you have defined for the contact who is being added as a participant.

+ *

The external_id you have defined for the contact who is being added as a participant.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("user_id") + public _FinalStage userId(@NotNull String userId) { + this.userId = Objects.requireNonNull(userId, "userId must not be null"); + return this; + } + + @java.lang.Override + public _FinalStage customer(CustomerRequest customer) { + this.customer = Optional.ofNullable(customer); + return this; + } + + @java.lang.Override + @JsonSetter(value = "customer", nulls = Nulls.SKIP) + public _FinalStage customer(Optional customer) { + this.customer = customer; + return this; + } + + @java.lang.Override + public UserId build() { + return new UserId(userId, customer, additionalProperties); + } + } + } + + @JsonInclude(JsonInclude.Include.NON_ABSENT) + @JsonDeserialize(builder = Customer_.Builder.class) + public static final class Customer_ { + private final String email; + + private final Optional customer; + + private final Map additionalProperties; + + private Customer_( + String email, Optional customer, Map additionalProperties) { + this.email = email; + this.customer = customer; + this.additionalProperties = additionalProperties; + } + + /** + * @return The email you have defined for the contact who is being added as a participant. + */ + @JsonProperty("email") + public String getEmail() { + return email; + } + + @JsonProperty("customer") + public Optional getCustomer() { + return customer; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof Customer_ && equalTo((Customer_) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(Customer_ other) { + return email.equals(other.email) && customer.equals(other.customer); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.email, this.customer); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static EmailStage builder() { + return new Builder(); + } + + public interface EmailStage { + /** + *

The email you have defined for the contact who is being added as a participant.

+ */ + _FinalStage email(@NotNull String email); + + Builder from(Customer_ other); + } + + public interface _FinalStage { + Customer_ build(); + + _FinalStage customer(Optional customer); + + _FinalStage customer(CustomerRequest customer); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements EmailStage, _FinalStage { + private String email; + + private Optional customer = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(Customer_ other) { + email(other.getEmail()); + customer(other.getCustomer()); + return this; + } + + /** + *

The email you have defined for the contact who is being added as a participant.

+ *

The email you have defined for the contact who is being added as a participant.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("email") + public _FinalStage email(@NotNull String email) { + this.email = Objects.requireNonNull(email, "email must not be null"); + return this; + } + + @java.lang.Override + public _FinalStage customer(CustomerRequest customer) { + this.customer = Optional.ofNullable(customer); + return this; + } + + @java.lang.Override + @JsonSetter(value = "customer", nulls = Nulls.SKIP) + public _FinalStage customer(Optional customer) { + this.customer = customer; + return this; + } + + @java.lang.Override + public Customer_ build() { + return new Customer_(email, customer, additionalProperties); + } + } + } + + @JsonInclude(JsonInclude.Include.NON_ABSENT) + @JsonDeserialize(builder = IntercomUserId.Builder.class) + public static final class IntercomUserId { + private final String intercomUserId; + + private final Optional customer; + + private final Map additionalProperties; + + private IntercomUserId( + String intercomUserId, + Optional customer, + Map additionalProperties) { + this.intercomUserId = intercomUserId; + this.customer = customer; + this.additionalProperties = additionalProperties; + } + + /** + * @return The identifier for the contact as given by Intercom. + */ + @JsonProperty("intercom_user_id") + public String getIntercomUserId() { + return intercomUserId; + } + + @JsonProperty("customer") + public Optional getCustomer() { + return customer; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof IntercomUserId && equalTo((IntercomUserId) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(IntercomUserId other) { + return intercomUserId.equals(other.intercomUserId) && customer.equals(other.customer); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.intercomUserId, this.customer); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static IntercomUserIdStage builder() { + return new Builder(); + } + + public interface IntercomUserIdStage { + /** + *

The identifier for the contact as given by Intercom.

+ */ + _FinalStage intercomUserId(@NotNull String intercomUserId); + + Builder from(IntercomUserId other); + } + + public interface _FinalStage { + IntercomUserId build(); + + _FinalStage customer(Optional customer); + + _FinalStage customer(CustomerRequest customer); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements IntercomUserIdStage, _FinalStage { + private String intercomUserId; + + private Optional customer = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(IntercomUserId other) { + intercomUserId(other.getIntercomUserId()); + customer(other.getCustomer()); + return this; + } + + /** + *

The identifier for the contact as given by Intercom.

+ *

The identifier for the contact as given by Intercom.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("intercom_user_id") + public _FinalStage intercomUserId(@NotNull String intercomUserId) { + this.intercomUserId = Objects.requireNonNull(intercomUserId, "intercomUserId must not be null"); + return this; + } + + @java.lang.Override + public _FinalStage customer(CustomerRequest customer) { + this.customer = Optional.ofNullable(customer); + return this; + } + + @java.lang.Override + @JsonSetter(value = "customer", nulls = Nulls.SKIP) + public _FinalStage customer(Optional customer) { + this.customer = customer; + return this; + } + + @java.lang.Override + public IntercomUserId build() { + return new IntercomUserId(intercomUserId, customer, additionalProperties); + } + } + } + } +} diff --git a/src/main/java/com/intercom/api/resources/conversations/requests/AutoAssignConversationRequest.java b/src/main/java/com/intercom/api/resources/conversations/requests/AutoAssignConversationRequest.java new file mode 100644 index 00000000..526265c7 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/conversations/requests/AutoAssignConversationRequest.java @@ -0,0 +1,113 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.conversations.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = AutoAssignConversationRequest.Builder.class) +public final class AutoAssignConversationRequest { + private final String conversationId; + + private final Map additionalProperties; + + private AutoAssignConversationRequest(String conversationId, Map additionalProperties) { + this.conversationId = conversationId; + this.additionalProperties = additionalProperties; + } + + /** + * @return The identifier for the conversation as given by Intercom. + */ + @JsonProperty("conversation_id") + public String getConversationId() { + return conversationId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof AutoAssignConversationRequest && equalTo((AutoAssignConversationRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(AutoAssignConversationRequest other) { + return conversationId.equals(other.conversationId); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.conversationId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static ConversationIdStage builder() { + return new Builder(); + } + + public interface ConversationIdStage { + /** + *

The identifier for the conversation as given by Intercom.

+ */ + _FinalStage conversationId(@NotNull String conversationId); + + Builder from(AutoAssignConversationRequest other); + } + + public interface _FinalStage { + AutoAssignConversationRequest build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements ConversationIdStage, _FinalStage { + private String conversationId; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(AutoAssignConversationRequest other) { + conversationId(other.getConversationId()); + return this; + } + + /** + *

The identifier for the conversation as given by Intercom.

+ *

The identifier for the conversation as given by Intercom.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("conversation_id") + public _FinalStage conversationId(@NotNull String conversationId) { + this.conversationId = Objects.requireNonNull(conversationId, "conversationId must not be null"); + return this; + } + + @java.lang.Override + public AutoAssignConversationRequest build() { + return new AutoAssignConversationRequest(conversationId, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/conversations/requests/ConvertConversationToTicketRequest.java b/src/main/java/com/intercom/api/resources/conversations/requests/ConvertConversationToTicketRequest.java new file mode 100644 index 00000000..6f719577 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/conversations/requests/ConvertConversationToTicketRequest.java @@ -0,0 +1,184 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.conversations.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = ConvertConversationToTicketRequest.Builder.class) +public final class ConvertConversationToTicketRequest { + private final int conversationId; + + private final String ticketTypeId; + + private final Optional> attributes; + + private final Map additionalProperties; + + private ConvertConversationToTicketRequest( + int conversationId, + String ticketTypeId, + Optional> attributes, + Map additionalProperties) { + this.conversationId = conversationId; + this.ticketTypeId = ticketTypeId; + this.attributes = attributes; + this.additionalProperties = additionalProperties; + } + + /** + * @return The id of the conversation to target + */ + @JsonProperty("conversation_id") + public int getConversationId() { + return conversationId; + } + + /** + * @return The ID of the type of ticket you want to convert the conversation to + */ + @JsonProperty("ticket_type_id") + public String getTicketTypeId() { + return ticketTypeId; + } + + @JsonProperty("attributes") + public Optional> getAttributes() { + return attributes; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof ConvertConversationToTicketRequest + && equalTo((ConvertConversationToTicketRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(ConvertConversationToTicketRequest other) { + return conversationId == other.conversationId + && ticketTypeId.equals(other.ticketTypeId) + && attributes.equals(other.attributes); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.conversationId, this.ticketTypeId, this.attributes); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static ConversationIdStage builder() { + return new Builder(); + } + + public interface ConversationIdStage { + /** + *

The id of the conversation to target

+ */ + TicketTypeIdStage conversationId(int conversationId); + + Builder from(ConvertConversationToTicketRequest other); + } + + public interface TicketTypeIdStage { + /** + *

The ID of the type of ticket you want to convert the conversation to

+ */ + _FinalStage ticketTypeId(@NotNull String ticketTypeId); + } + + public interface _FinalStage { + ConvertConversationToTicketRequest build(); + + _FinalStage attributes(Optional> attributes); + + _FinalStage attributes(Map attributes); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements ConversationIdStage, TicketTypeIdStage, _FinalStage { + private int conversationId; + + private String ticketTypeId; + + private Optional> attributes = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(ConvertConversationToTicketRequest other) { + conversationId(other.getConversationId()); + ticketTypeId(other.getTicketTypeId()); + attributes(other.getAttributes()); + return this; + } + + /** + *

The id of the conversation to target

+ *

The id of the conversation to target

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("conversation_id") + public TicketTypeIdStage conversationId(int conversationId) { + this.conversationId = conversationId; + return this; + } + + /** + *

The ID of the type of ticket you want to convert the conversation to

+ *

The ID of the type of ticket you want to convert the conversation to

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("ticket_type_id") + public _FinalStage ticketTypeId(@NotNull String ticketTypeId) { + this.ticketTypeId = Objects.requireNonNull(ticketTypeId, "ticketTypeId must not be null"); + return this; + } + + @java.lang.Override + public _FinalStage attributes(Map attributes) { + this.attributes = Optional.ofNullable(attributes); + return this; + } + + @java.lang.Override + @JsonSetter(value = "attributes", nulls = Nulls.SKIP) + public _FinalStage attributes(Optional> attributes) { + this.attributes = attributes; + return this; + } + + @java.lang.Override + public ConvertConversationToTicketRequest build() { + return new ConvertConversationToTicketRequest( + conversationId, ticketTypeId, attributes, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/conversations/requests/CreateConversationRequest.java b/src/main/java/com/intercom/api/resources/conversations/requests/CreateConversationRequest.java new file mode 100644 index 00000000..6dc7a0b2 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/conversations/requests/CreateConversationRequest.java @@ -0,0 +1,395 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.conversations.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.JsonValue; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = CreateConversationRequest.Builder.class) +public final class CreateConversationRequest { + private final From from; + + private final String body; + + private final Optional createdAt; + + private final Map additionalProperties; + + private CreateConversationRequest( + From from, String body, Optional createdAt, Map additionalProperties) { + this.from = from; + this.body = body; + this.createdAt = createdAt; + this.additionalProperties = additionalProperties; + } + + @JsonProperty("from") + public From getFrom() { + return from; + } + + /** + * @return The content of the message. HTML is not supported. + */ + @JsonProperty("body") + public String getBody() { + return body; + } + + /** + * @return The time the conversation was created as a UTC Unix timestamp. If not provided, the current time will be used. This field is only recommneded for migrating past conversations from another source into Intercom. + */ + @JsonProperty("created_at") + public Optional getCreatedAt() { + return createdAt; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof CreateConversationRequest && equalTo((CreateConversationRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(CreateConversationRequest other) { + return from.equals(other.from) && body.equals(other.body) && createdAt.equals(other.createdAt); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.from, this.body, this.createdAt); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static FromStage builder() { + return new Builder(); + } + + public interface FromStage { + BodyStage from(@NotNull From from); + + Builder from(CreateConversationRequest other); + } + + public interface BodyStage { + /** + *

The content of the message. HTML is not supported.

+ */ + _FinalStage body(@NotNull String body); + } + + public interface _FinalStage { + CreateConversationRequest build(); + + /** + *

The time the conversation was created as a UTC Unix timestamp. If not provided, the current time will be used. This field is only recommneded for migrating past conversations from another source into Intercom.

+ */ + _FinalStage createdAt(Optional createdAt); + + _FinalStage createdAt(Integer createdAt); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements FromStage, BodyStage, _FinalStage { + private From from; + + private String body; + + private Optional createdAt = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(CreateConversationRequest other) { + from(other.getFrom()); + body(other.getBody()); + createdAt(other.getCreatedAt()); + return this; + } + + @java.lang.Override + @JsonSetter("from") + public BodyStage from(@NotNull From from) { + this.from = Objects.requireNonNull(from, "from must not be null"); + return this; + } + + /** + *

The content of the message. HTML is not supported.

+ *

The content of the message. HTML is not supported.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("body") + public _FinalStage body(@NotNull String body) { + this.body = Objects.requireNonNull(body, "body must not be null"); + return this; + } + + /** + *

The time the conversation was created as a UTC Unix timestamp. If not provided, the current time will be used. This field is only recommneded for migrating past conversations from another source into Intercom.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage createdAt(Integer createdAt) { + this.createdAt = Optional.ofNullable(createdAt); + return this; + } + + /** + *

The time the conversation was created as a UTC Unix timestamp. If not provided, the current time will be used. This field is only recommneded for migrating past conversations from another source into Intercom.

+ */ + @java.lang.Override + @JsonSetter(value = "created_at", nulls = Nulls.SKIP) + public _FinalStage createdAt(Optional createdAt) { + this.createdAt = createdAt; + return this; + } + + @java.lang.Override + public CreateConversationRequest build() { + return new CreateConversationRequest(from, body, createdAt, additionalProperties); + } + } + + @JsonInclude(JsonInclude.Include.NON_ABSENT) + @JsonDeserialize(builder = From.Builder.class) + public static final class From { + private final Type type; + + private final String id; + + private final Map additionalProperties; + + private From(Type type, String id, Map additionalProperties) { + this.type = type; + this.id = id; + this.additionalProperties = additionalProperties; + } + + /** + * @return The role associated to the contact - user or lead. + */ + @JsonProperty("type") + public Type getType() { + return type; + } + + /** + * @return The identifier for the contact which is given by Intercom. + */ + @JsonProperty("id") + public String getId() { + return id; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof From && equalTo((From) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(From other) { + return type.equals(other.type) && id.equals(other.id); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.type, this.id); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static TypeStage builder() { + return new Builder(); + } + + public interface TypeStage { + /** + *

The role associated to the contact - user or lead.

+ */ + IdStage type(@NotNull Type type); + + Builder from(From other); + } + + public interface IdStage { + /** + *

The identifier for the contact which is given by Intercom.

+ */ + _FinalStage id(@NotNull String id); + } + + public interface _FinalStage { + From build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements TypeStage, IdStage, _FinalStage { + private Type type; + + private String id; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(From other) { + type(other.getType()); + id(other.getId()); + return this; + } + + /** + *

The role associated to the contact - user or lead.

+ *

The role associated to the contact - user or lead.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("type") + public IdStage type(@NotNull Type type) { + this.type = Objects.requireNonNull(type, "type must not be null"); + return this; + } + + /** + *

The identifier for the contact which is given by Intercom.

+ *

The identifier for the contact which is given by Intercom.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("id") + public _FinalStage id(@NotNull String id) { + this.id = Objects.requireNonNull(id, "id must not be null"); + return this; + } + + @java.lang.Override + public From build() { + return new From(type, id, additionalProperties); + } + } + + public static final class Type { + public static final Type USER = new Type(Value.USER, "user"); + + public static final Type CONTACT = new Type(Value.CONTACT, "contact"); + + public static final Type LEAD = new Type(Value.LEAD, "lead"); + + private final Value value; + + private final String string; + + Type(Value value, String string) { + this.value = value; + this.string = string; + } + + public Value getEnumValue() { + return value; + } + + @java.lang.Override + @JsonValue + public String toString() { + return this.string; + } + + @java.lang.Override + public boolean equals(Object other) { + return (this == other) || (other instanceof Type && this.string.equals(((Type) other).string)); + } + + @java.lang.Override + public int hashCode() { + return this.string.hashCode(); + } + + public T visit(Visitor visitor) { + switch (value) { + case USER: + return visitor.visitUser(); + case CONTACT: + return visitor.visitContact(); + case LEAD: + return visitor.visitLead(); + case UNKNOWN: + default: + return visitor.visitUnknown(string); + } + } + + @JsonCreator(mode = JsonCreator.Mode.DELEGATING) + public static Type valueOf(String value) { + switch (value) { + case "user": + return USER; + case "contact": + return CONTACT; + case "lead": + return LEAD; + default: + return new Type(Value.UNKNOWN, value); + } + } + + public enum Value { + LEAD, + + USER, + + CONTACT, + + UNKNOWN + } + + public interface Visitor { + T visitLead(); + + T visitUser(); + + T visitContact(); + + T visitUnknown(String unknownType); + } + } + } +} diff --git a/src/main/java/com/intercom/api/resources/conversations/requests/DeleteConversationRequest.java b/src/main/java/com/intercom/api/resources/conversations/requests/DeleteConversationRequest.java new file mode 100644 index 00000000..7699a833 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/conversations/requests/DeleteConversationRequest.java @@ -0,0 +1,112 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.conversations.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = DeleteConversationRequest.Builder.class) +public final class DeleteConversationRequest { + private final int conversationId; + + private final Map additionalProperties; + + private DeleteConversationRequest(int conversationId, Map additionalProperties) { + this.conversationId = conversationId; + this.additionalProperties = additionalProperties; + } + + /** + * @return id + */ + @JsonProperty("conversation_id") + public int getConversationId() { + return conversationId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof DeleteConversationRequest && equalTo((DeleteConversationRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(DeleteConversationRequest other) { + return conversationId == other.conversationId; + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.conversationId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static ConversationIdStage builder() { + return new Builder(); + } + + public interface ConversationIdStage { + /** + *

id

+ */ + _FinalStage conversationId(int conversationId); + + Builder from(DeleteConversationRequest other); + } + + public interface _FinalStage { + DeleteConversationRequest build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements ConversationIdStage, _FinalStage { + private int conversationId; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(DeleteConversationRequest other) { + conversationId(other.getConversationId()); + return this; + } + + /** + *

id

+ *

id

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("conversation_id") + public _FinalStage conversationId(int conversationId) { + this.conversationId = conversationId; + return this; + } + + @java.lang.Override + public DeleteConversationRequest build() { + return new DeleteConversationRequest(conversationId, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/conversations/requests/DetachContactFromConversationRequest.java b/src/main/java/com/intercom/api/resources/conversations/requests/DetachContactFromConversationRequest.java new file mode 100644 index 00000000..1773500a --- /dev/null +++ b/src/main/java/com/intercom/api/resources/conversations/requests/DetachContactFromConversationRequest.java @@ -0,0 +1,183 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.conversations.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = DetachContactFromConversationRequest.Builder.class) +public final class DetachContactFromConversationRequest { + private final String conversationId; + + private final String contactId; + + private final String adminId; + + private final Map additionalProperties; + + private DetachContactFromConversationRequest( + String conversationId, String contactId, String adminId, Map additionalProperties) { + this.conversationId = conversationId; + this.contactId = contactId; + this.adminId = adminId; + this.additionalProperties = additionalProperties; + } + + /** + * @return The identifier for the conversation as given by Intercom. + */ + @JsonProperty("conversation_id") + public String getConversationId() { + return conversationId; + } + + /** + * @return The identifier for the contact as given by Intercom. + */ + @JsonProperty("contact_id") + public String getContactId() { + return contactId; + } + + /** + * @return The id of the admin who is performing the action. + */ + @JsonProperty("admin_id") + public String getAdminId() { + return adminId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof DetachContactFromConversationRequest + && equalTo((DetachContactFromConversationRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(DetachContactFromConversationRequest other) { + return conversationId.equals(other.conversationId) + && contactId.equals(other.contactId) + && adminId.equals(other.adminId); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.conversationId, this.contactId, this.adminId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static ConversationIdStage builder() { + return new Builder(); + } + + public interface ConversationIdStage { + /** + *

The identifier for the conversation as given by Intercom.

+ */ + ContactIdStage conversationId(@NotNull String conversationId); + + Builder from(DetachContactFromConversationRequest other); + } + + public interface ContactIdStage { + /** + *

The identifier for the contact as given by Intercom.

+ */ + AdminIdStage contactId(@NotNull String contactId); + } + + public interface AdminIdStage { + /** + *

The id of the admin who is performing the action.

+ */ + _FinalStage adminId(@NotNull String adminId); + } + + public interface _FinalStage { + DetachContactFromConversationRequest build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements ConversationIdStage, ContactIdStage, AdminIdStage, _FinalStage { + private String conversationId; + + private String contactId; + + private String adminId; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(DetachContactFromConversationRequest other) { + conversationId(other.getConversationId()); + contactId(other.getContactId()); + adminId(other.getAdminId()); + return this; + } + + /** + *

The identifier for the conversation as given by Intercom.

+ *

The identifier for the conversation as given by Intercom.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("conversation_id") + public ContactIdStage conversationId(@NotNull String conversationId) { + this.conversationId = Objects.requireNonNull(conversationId, "conversationId must not be null"); + return this; + } + + /** + *

The identifier for the contact as given by Intercom.

+ *

The identifier for the contact as given by Intercom.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("contact_id") + public AdminIdStage contactId(@NotNull String contactId) { + this.contactId = Objects.requireNonNull(contactId, "contactId must not be null"); + return this; + } + + /** + *

The id of the admin who is performing the action.

+ *

The id of the admin who is performing the action.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("admin_id") + public _FinalStage adminId(@NotNull String adminId) { + this.adminId = Objects.requireNonNull(adminId, "adminId must not be null"); + return this; + } + + @java.lang.Override + public DetachContactFromConversationRequest build() { + return new DetachContactFromConversationRequest(conversationId, contactId, adminId, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/conversations/requests/FindConversationRequest.java b/src/main/java/com/intercom/api/resources/conversations/requests/FindConversationRequest.java new file mode 100644 index 00000000..a54d6e55 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/conversations/requests/FindConversationRequest.java @@ -0,0 +1,203 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.conversations.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = FindConversationRequest.Builder.class) +public final class FindConversationRequest { + private final String conversationId; + + private final Optional displayAs; + + private final Optional includeTranslations; + + private final Map additionalProperties; + + private FindConversationRequest( + String conversationId, + Optional displayAs, + Optional includeTranslations, + Map additionalProperties) { + this.conversationId = conversationId; + this.displayAs = displayAs; + this.includeTranslations = includeTranslations; + this.additionalProperties = additionalProperties; + } + + /** + * @return The id of the conversation to target + */ + @JsonProperty("conversation_id") + public String getConversationId() { + return conversationId; + } + + /** + * @return Set to plaintext to retrieve conversation messages in plain text. + */ + @JsonProperty("display_as") + public Optional getDisplayAs() { + return displayAs; + } + + /** + * @return If set to true, conversation parts will be translated to the detected language of the conversation. + */ + @JsonProperty("include_translations") + public Optional getIncludeTranslations() { + return includeTranslations; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof FindConversationRequest && equalTo((FindConversationRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(FindConversationRequest other) { + return conversationId.equals(other.conversationId) + && displayAs.equals(other.displayAs) + && includeTranslations.equals(other.includeTranslations); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.conversationId, this.displayAs, this.includeTranslations); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static ConversationIdStage builder() { + return new Builder(); + } + + public interface ConversationIdStage { + /** + *

The id of the conversation to target

+ */ + _FinalStage conversationId(@NotNull String conversationId); + + Builder from(FindConversationRequest other); + } + + public interface _FinalStage { + FindConversationRequest build(); + + /** + *

Set to plaintext to retrieve conversation messages in plain text.

+ */ + _FinalStage displayAs(Optional displayAs); + + _FinalStage displayAs(String displayAs); + + /** + *

If set to true, conversation parts will be translated to the detected language of the conversation.

+ */ + _FinalStage includeTranslations(Optional includeTranslations); + + _FinalStage includeTranslations(Boolean includeTranslations); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements ConversationIdStage, _FinalStage { + private String conversationId; + + private Optional includeTranslations = Optional.empty(); + + private Optional displayAs = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(FindConversationRequest other) { + conversationId(other.getConversationId()); + displayAs(other.getDisplayAs()); + includeTranslations(other.getIncludeTranslations()); + return this; + } + + /** + *

The id of the conversation to target

+ *

The id of the conversation to target

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("conversation_id") + public _FinalStage conversationId(@NotNull String conversationId) { + this.conversationId = Objects.requireNonNull(conversationId, "conversationId must not be null"); + return this; + } + + /** + *

If set to true, conversation parts will be translated to the detected language of the conversation.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage includeTranslations(Boolean includeTranslations) { + this.includeTranslations = Optional.ofNullable(includeTranslations); + return this; + } + + /** + *

If set to true, conversation parts will be translated to the detected language of the conversation.

+ */ + @java.lang.Override + @JsonSetter(value = "include_translations", nulls = Nulls.SKIP) + public _FinalStage includeTranslations(Optional includeTranslations) { + this.includeTranslations = includeTranslations; + return this; + } + + /** + *

Set to plaintext to retrieve conversation messages in plain text.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage displayAs(String displayAs) { + this.displayAs = Optional.ofNullable(displayAs); + return this; + } + + /** + *

Set to plaintext to retrieve conversation messages in plain text.

+ */ + @java.lang.Override + @JsonSetter(value = "display_as", nulls = Nulls.SKIP) + public _FinalStage displayAs(Optional displayAs) { + this.displayAs = displayAs; + return this; + } + + @java.lang.Override + public FindConversationRequest build() { + return new FindConversationRequest(conversationId, displayAs, includeTranslations, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/conversations/requests/ListConversationsRequest.java b/src/main/java/com/intercom/api/resources/conversations/requests/ListConversationsRequest.java new file mode 100644 index 00000000..79ba7bd4 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/conversations/requests/ListConversationsRequest.java @@ -0,0 +1,130 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.conversations.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = ListConversationsRequest.Builder.class) +public final class ListConversationsRequest { + private final Optional perPage; + + private final Optional startingAfter; + + private final Map additionalProperties; + + private ListConversationsRequest( + Optional perPage, Optional startingAfter, Map additionalProperties) { + this.perPage = perPage; + this.startingAfter = startingAfter; + this.additionalProperties = additionalProperties; + } + + /** + * @return How many results per page + */ + @JsonProperty("per_page") + public Optional getPerPage() { + return perPage; + } + + /** + * @return String used to get the next page of conversations. + */ + @JsonProperty("starting_after") + public Optional getStartingAfter() { + return startingAfter; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof ListConversationsRequest && equalTo((ListConversationsRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(ListConversationsRequest other) { + return perPage.equals(other.perPage) && startingAfter.equals(other.startingAfter); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.perPage, this.startingAfter); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static Builder builder() { + return new Builder(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder { + private Optional perPage = Optional.empty(); + + private Optional startingAfter = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + public Builder from(ListConversationsRequest other) { + perPage(other.getPerPage()); + startingAfter(other.getStartingAfter()); + return this; + } + + /** + *

How many results per page

+ */ + @JsonSetter(value = "per_page", nulls = Nulls.SKIP) + public Builder perPage(Optional perPage) { + this.perPage = perPage; + return this; + } + + public Builder perPage(Integer perPage) { + this.perPage = Optional.ofNullable(perPage); + return this; + } + + /** + *

String used to get the next page of conversations.

+ */ + @JsonSetter(value = "starting_after", nulls = Nulls.SKIP) + public Builder startingAfter(Optional startingAfter) { + this.startingAfter = startingAfter; + return this; + } + + public Builder startingAfter(String startingAfter) { + this.startingAfter = Optional.ofNullable(startingAfter); + return this; + } + + public ListConversationsRequest build() { + return new ListConversationsRequest(perPage, startingAfter, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/conversations/requests/ManageConversationPartsRequest.java b/src/main/java/com/intercom/api/resources/conversations/requests/ManageConversationPartsRequest.java new file mode 100644 index 00000000..dc36d2b7 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/conversations/requests/ManageConversationPartsRequest.java @@ -0,0 +1,137 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.conversations.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.resources.conversations.types.ConversationsManageRequestBody; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = ManageConversationPartsRequest.Builder.class) +public final class ManageConversationPartsRequest { + private final String conversationId; + + private final ConversationsManageRequestBody body; + + private final Map additionalProperties; + + private ManageConversationPartsRequest( + String conversationId, ConversationsManageRequestBody body, Map additionalProperties) { + this.conversationId = conversationId; + this.body = body; + this.additionalProperties = additionalProperties; + } + + /** + * @return The identifier for the conversation as given by Intercom. + */ + @JsonProperty("conversation_id") + public String getConversationId() { + return conversationId; + } + + @JsonProperty("body") + public ConversationsManageRequestBody getBody() { + return body; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof ManageConversationPartsRequest && equalTo((ManageConversationPartsRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(ManageConversationPartsRequest other) { + return conversationId.equals(other.conversationId) && body.equals(other.body); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.conversationId, this.body); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static ConversationIdStage builder() { + return new Builder(); + } + + public interface ConversationIdStage { + /** + *

The identifier for the conversation as given by Intercom.

+ */ + BodyStage conversationId(@NotNull String conversationId); + + Builder from(ManageConversationPartsRequest other); + } + + public interface BodyStage { + _FinalStage body(@NotNull ConversationsManageRequestBody body); + } + + public interface _FinalStage { + ManageConversationPartsRequest build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements ConversationIdStage, BodyStage, _FinalStage { + private String conversationId; + + private ConversationsManageRequestBody body; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(ManageConversationPartsRequest other) { + conversationId(other.getConversationId()); + body(other.getBody()); + return this; + } + + /** + *

The identifier for the conversation as given by Intercom.

+ *

The identifier for the conversation as given by Intercom.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("conversation_id") + public BodyStage conversationId(@NotNull String conversationId) { + this.conversationId = Objects.requireNonNull(conversationId, "conversationId must not be null"); + return this; + } + + @java.lang.Override + @JsonSetter("body") + public _FinalStage body(@NotNull ConversationsManageRequestBody body) { + this.body = Objects.requireNonNull(body, "body must not be null"); + return this; + } + + @java.lang.Override + public ManageConversationPartsRequest build() { + return new ManageConversationPartsRequest(conversationId, body, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/conversations/requests/ReplyToConversationRequest.java b/src/main/java/com/intercom/api/resources/conversations/requests/ReplyToConversationRequest.java new file mode 100644 index 00000000..07200530 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/conversations/requests/ReplyToConversationRequest.java @@ -0,0 +1,137 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.conversations.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.types.ReplyConversationRequest; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = ReplyToConversationRequest.Builder.class) +public final class ReplyToConversationRequest { + private final String conversationId; + + private final ReplyConversationRequest body; + + private final Map additionalProperties; + + private ReplyToConversationRequest( + String conversationId, ReplyConversationRequest body, Map additionalProperties) { + this.conversationId = conversationId; + this.body = body; + this.additionalProperties = additionalProperties; + } + + /** + * @return The Intercom provisioned identifier for the conversation or the string "last" to reply to the last part of the conversation + */ + @JsonProperty("conversation_id") + public String getConversationId() { + return conversationId; + } + + @JsonProperty("body") + public ReplyConversationRequest getBody() { + return body; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof ReplyToConversationRequest && equalTo((ReplyToConversationRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(ReplyToConversationRequest other) { + return conversationId.equals(other.conversationId) && body.equals(other.body); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.conversationId, this.body); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static ConversationIdStage builder() { + return new Builder(); + } + + public interface ConversationIdStage { + /** + *

The Intercom provisioned identifier for the conversation or the string "last" to reply to the last part of the conversation

+ */ + BodyStage conversationId(@NotNull String conversationId); + + Builder from(ReplyToConversationRequest other); + } + + public interface BodyStage { + _FinalStage body(@NotNull ReplyConversationRequest body); + } + + public interface _FinalStage { + ReplyToConversationRequest build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements ConversationIdStage, BodyStage, _FinalStage { + private String conversationId; + + private ReplyConversationRequest body; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(ReplyToConversationRequest other) { + conversationId(other.getConversationId()); + body(other.getBody()); + return this; + } + + /** + *

The Intercom provisioned identifier for the conversation or the string "last" to reply to the last part of the conversation

+ *

The Intercom provisioned identifier for the conversation or the string "last" to reply to the last part of the conversation

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("conversation_id") + public BodyStage conversationId(@NotNull String conversationId) { + this.conversationId = Objects.requireNonNull(conversationId, "conversationId must not be null"); + return this; + } + + @java.lang.Override + @JsonSetter("body") + public _FinalStage body(@NotNull ReplyConversationRequest body) { + this.body = Objects.requireNonNull(body, "body must not be null"); + return this; + } + + @java.lang.Override + public ReplyToConversationRequest build() { + return new ReplyToConversationRequest(conversationId, body, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/conversations/requests/UpdateConversationRequest.java b/src/main/java/com/intercom/api/resources/conversations/requests/UpdateConversationRequest.java new file mode 100644 index 00000000..08db0b5e --- /dev/null +++ b/src/main/java/com/intercom/api/resources/conversations/requests/UpdateConversationRequest.java @@ -0,0 +1,433 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.conversations.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.JsonValue; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.core.JsonParseException; +import com.fasterxml.jackson.core.JsonParser; +import com.fasterxml.jackson.databind.DeserializationContext; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.fasterxml.jackson.databind.deser.std.StdDeserializer; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.types.CustomObjectInstanceList; +import com.intercom.api.types.Datetime; +import java.io.IOException; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = UpdateConversationRequest.Builder.class) +public final class UpdateConversationRequest { + private final String conversationId; + + private final Optional displayAs; + + private final Optional read; + + private final Optional title; + + private final Optional> customAttributes; + + private final Optional companyId; + + private final Map additionalProperties; + + private UpdateConversationRequest( + String conversationId, + Optional displayAs, + Optional read, + Optional title, + Optional> customAttributes, + Optional companyId, + Map additionalProperties) { + this.conversationId = conversationId; + this.displayAs = displayAs; + this.read = read; + this.title = title; + this.customAttributes = customAttributes; + this.companyId = companyId; + this.additionalProperties = additionalProperties; + } + + /** + * @return The id of the conversation to target + */ + @JsonProperty("conversation_id") + public String getConversationId() { + return conversationId; + } + + /** + * @return Set to plaintext to retrieve conversation messages in plain text. + */ + @JsonProperty("display_as") + public Optional getDisplayAs() { + return displayAs; + } + + /** + * @return Mark a conversation as read within Intercom. + */ + @JsonProperty("read") + public Optional getRead() { + return read; + } + + /** + * @return The title given to the conversation + */ + @JsonProperty("title") + public Optional getTitle() { + return title; + } + + @JsonProperty("custom_attributes") + public Optional> getCustomAttributes() { + return customAttributes; + } + + /** + * @return The ID of the company that the conversation is associated with. The unique identifier for the company which is given by Intercom. Set to nil to remove company. + */ + @JsonProperty("company_id") + public Optional getCompanyId() { + return companyId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof UpdateConversationRequest && equalTo((UpdateConversationRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(UpdateConversationRequest other) { + return conversationId.equals(other.conversationId) + && displayAs.equals(other.displayAs) + && read.equals(other.read) + && title.equals(other.title) + && customAttributes.equals(other.customAttributes) + && companyId.equals(other.companyId); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash( + this.conversationId, this.displayAs, this.read, this.title, this.customAttributes, this.companyId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static ConversationIdStage builder() { + return new Builder(); + } + + public interface ConversationIdStage { + /** + *

The id of the conversation to target

+ */ + _FinalStage conversationId(@NotNull String conversationId); + + Builder from(UpdateConversationRequest other); + } + + public interface _FinalStage { + UpdateConversationRequest build(); + + /** + *

Set to plaintext to retrieve conversation messages in plain text.

+ */ + _FinalStage displayAs(Optional displayAs); + + _FinalStage displayAs(String displayAs); + + /** + *

Mark a conversation as read within Intercom.

+ */ + _FinalStage read(Optional read); + + _FinalStage read(Boolean read); + + /** + *

The title given to the conversation

+ */ + _FinalStage title(Optional title); + + _FinalStage title(String title); + + _FinalStage customAttributes(Optional> customAttributes); + + _FinalStage customAttributes(Map customAttributes); + + /** + *

The ID of the company that the conversation is associated with. The unique identifier for the company which is given by Intercom. Set to nil to remove company.

+ */ + _FinalStage companyId(Optional companyId); + + _FinalStage companyId(String companyId); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements ConversationIdStage, _FinalStage { + private String conversationId; + + private Optional companyId = Optional.empty(); + + private Optional> customAttributes = Optional.empty(); + + private Optional title = Optional.empty(); + + private Optional read = Optional.empty(); + + private Optional displayAs = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(UpdateConversationRequest other) { + conversationId(other.getConversationId()); + displayAs(other.getDisplayAs()); + read(other.getRead()); + title(other.getTitle()); + customAttributes(other.getCustomAttributes()); + companyId(other.getCompanyId()); + return this; + } + + /** + *

The id of the conversation to target

+ *

The id of the conversation to target

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("conversation_id") + public _FinalStage conversationId(@NotNull String conversationId) { + this.conversationId = Objects.requireNonNull(conversationId, "conversationId must not be null"); + return this; + } + + /** + *

The ID of the company that the conversation is associated with. The unique identifier for the company which is given by Intercom. Set to nil to remove company.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage companyId(String companyId) { + this.companyId = Optional.ofNullable(companyId); + return this; + } + + /** + *

The ID of the company that the conversation is associated with. The unique identifier for the company which is given by Intercom. Set to nil to remove company.

+ */ + @java.lang.Override + @JsonSetter(value = "company_id", nulls = Nulls.SKIP) + public _FinalStage companyId(Optional companyId) { + this.companyId = companyId; + return this; + } + + @java.lang.Override + public _FinalStage customAttributes(Map customAttributes) { + this.customAttributes = Optional.ofNullable(customAttributes); + return this; + } + + @java.lang.Override + @JsonSetter(value = "custom_attributes", nulls = Nulls.SKIP) + public _FinalStage customAttributes(Optional> customAttributes) { + this.customAttributes = customAttributes; + return this; + } + + /** + *

The title given to the conversation

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage title(String title) { + this.title = Optional.ofNullable(title); + return this; + } + + /** + *

The title given to the conversation

+ */ + @java.lang.Override + @JsonSetter(value = "title", nulls = Nulls.SKIP) + public _FinalStage title(Optional title) { + this.title = title; + return this; + } + + /** + *

Mark a conversation as read within Intercom.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage read(Boolean read) { + this.read = Optional.ofNullable(read); + return this; + } + + /** + *

Mark a conversation as read within Intercom.

+ */ + @java.lang.Override + @JsonSetter(value = "read", nulls = Nulls.SKIP) + public _FinalStage read(Optional read) { + this.read = read; + return this; + } + + /** + *

Set to plaintext to retrieve conversation messages in plain text.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage displayAs(String displayAs) { + this.displayAs = Optional.ofNullable(displayAs); + return this; + } + + /** + *

Set to plaintext to retrieve conversation messages in plain text.

+ */ + @java.lang.Override + @JsonSetter(value = "display_as", nulls = Nulls.SKIP) + public _FinalStage displayAs(Optional displayAs) { + this.displayAs = displayAs; + return this; + } + + @java.lang.Override + public UpdateConversationRequest build() { + return new UpdateConversationRequest( + conversationId, displayAs, read, title, customAttributes, companyId, additionalProperties); + } + } + + @JsonDeserialize(using = CustomAttributesValue.Deserializer.class) + public static final class CustomAttributesValue { + private final Object value; + + private final int type; + + private CustomAttributesValue(Object value, int type) { + this.value = value; + this.type = type; + } + + @JsonValue + public Object get() { + return this.value; + } + + @SuppressWarnings("unchecked") + public T visit(Visitor visitor) { + if (this.type == 0) { + return visitor.visit((String) this.value); + } else if (this.type == 1) { + return visitor.visit((int) this.value); + } else if (this.type == 2) { + return visitor.visit((Datetime) this.value); + } else if (this.type == 3) { + return visitor.visit((CustomObjectInstanceList) this.value); + } + throw new IllegalStateException("Failed to visit value. This should never happen."); + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof CustomAttributesValue && equalTo((CustomAttributesValue) other); + } + + private boolean equalTo(CustomAttributesValue other) { + return value.equals(other.value); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.value); + } + + @java.lang.Override + public String toString() { + return this.value.toString(); + } + + public static CustomAttributesValue of(String value) { + return new CustomAttributesValue(value, 0); + } + + public static CustomAttributesValue of(int value) { + return new CustomAttributesValue(value, 1); + } + + public static CustomAttributesValue of(Datetime value) { + return new CustomAttributesValue(value, 2); + } + + public static CustomAttributesValue of(CustomObjectInstanceList value) { + return new CustomAttributesValue(value, 3); + } + + public interface Visitor { + T visit(String value); + + T visit(int value); + + T visit(Datetime value); + + T visit(CustomObjectInstanceList value); + } + + static final class Deserializer extends StdDeserializer { + Deserializer() { + super(CustomAttributesValue.class); + } + + @java.lang.Override + public CustomAttributesValue deserialize(JsonParser p, DeserializationContext context) throws IOException { + Object value = p.readValueAs(Object.class); + try { + return of(ObjectMappers.JSON_MAPPER.convertValue(value, String.class)); + } catch (RuntimeException e) { + } + if (value instanceof Integer) { + return of((Integer) value); + } + try { + return of(ObjectMappers.JSON_MAPPER.convertValue(value, Datetime.class)); + } catch (RuntimeException e) { + } + try { + return of(ObjectMappers.JSON_MAPPER.convertValue(value, CustomObjectInstanceList.class)); + } catch (RuntimeException e) { + } + throw new JsonParseException(p, "Failed to deserialize"); + } + } + } +} diff --git a/src/main/java/com/intercom/api/resources/conversations/types/Conversation.java b/src/main/java/com/intercom/api/resources/conversations/types/Conversation.java new file mode 100644 index 00000000..4d5acaa8 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/conversations/types/Conversation.java @@ -0,0 +1,1382 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.conversations.types; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.JsonValue; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.core.JsonParseException; +import com.fasterxml.jackson.core.JsonParser; +import com.fasterxml.jackson.databind.DeserializationContext; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.fasterxml.jackson.databind.deser.std.StdDeserializer; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.resources.aiagent.types.AiAgent; +import com.intercom.api.types.ConversationContacts; +import com.intercom.api.types.ConversationFirstContactReply; +import com.intercom.api.types.ConversationParts; +import com.intercom.api.types.ConversationRating; +import com.intercom.api.types.ConversationSource; +import com.intercom.api.types.ConversationStatistics; +import com.intercom.api.types.ConversationTeammates; +import com.intercom.api.types.CustomObjectInstanceList; +import com.intercom.api.types.Datetime; +import com.intercom.api.types.LinkedObjectList; +import com.intercom.api.types.SlaApplied; +import com.intercom.api.types.Tags; +import java.io.IOException; +import java.util.HashMap; +import java.util.LinkedHashMap; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = Conversation.Builder.class) +public final class Conversation { + private final String type; + + private final String id; + + private final Optional title; + + private final int createdAt; + + private final int updatedAt; + + private final Optional waitingSince; + + private final Optional snoozedUntil; + + private final boolean open; + + private final State state; + + private final boolean read; + + private final Optional priority; + + private final Optional adminAssigneeId; + + private final Optional teamAssigneeId; + + private final Optional companyId; + + private final Optional tags; + + private final Optional conversationRating; + + private final ConversationSource source; + + private final ConversationContacts contacts; + + private final Optional teammates; + + private final Map customAttributes; + + private final Optional firstContactReply; + + private final Optional slaApplied; + + private final Optional statistics; + + private final Optional conversationParts; + + private final Optional linkedObjects; + + private final Optional aiAgentParticipated; + + private final Optional aiAgent; + + private final Map additionalProperties; + + private Conversation( + String type, + String id, + Optional title, + int createdAt, + int updatedAt, + Optional waitingSince, + Optional snoozedUntil, + boolean open, + State state, + boolean read, + Optional priority, + Optional adminAssigneeId, + Optional teamAssigneeId, + Optional companyId, + Optional tags, + Optional conversationRating, + ConversationSource source, + ConversationContacts contacts, + Optional teammates, + Map customAttributes, + Optional firstContactReply, + Optional slaApplied, + Optional statistics, + Optional conversationParts, + Optional linkedObjects, + Optional aiAgentParticipated, + Optional aiAgent, + Map additionalProperties) { + this.type = type; + this.id = id; + this.title = title; + this.createdAt = createdAt; + this.updatedAt = updatedAt; + this.waitingSince = waitingSince; + this.snoozedUntil = snoozedUntil; + this.open = open; + this.state = state; + this.read = read; + this.priority = priority; + this.adminAssigneeId = adminAssigneeId; + this.teamAssigneeId = teamAssigneeId; + this.companyId = companyId; + this.tags = tags; + this.conversationRating = conversationRating; + this.source = source; + this.contacts = contacts; + this.teammates = teammates; + this.customAttributes = customAttributes; + this.firstContactReply = firstContactReply; + this.slaApplied = slaApplied; + this.statistics = statistics; + this.conversationParts = conversationParts; + this.linkedObjects = linkedObjects; + this.aiAgentParticipated = aiAgentParticipated; + this.aiAgent = aiAgent; + this.additionalProperties = additionalProperties; + } + + /** + * @return Always conversation. + */ + @JsonProperty("type") + public String getType() { + return type; + } + + /** + * @return The id representing the conversation. + */ + @JsonProperty("id") + public String getId() { + return id; + } + + /** + * @return The title given to the conversation. + */ + @JsonProperty("title") + public Optional getTitle() { + return title; + } + + /** + * @return The time the conversation was created. + */ + @JsonProperty("created_at") + public int getCreatedAt() { + return createdAt; + } + + /** + * @return The last time the conversation was updated. + */ + @JsonProperty("updated_at") + public int getUpdatedAt() { + return updatedAt; + } + + /** + * @return The last time a Contact responded to an Admin. In other words, the time a customer started waiting for a response. Set to null if last reply is from an Admin. + */ + @JsonProperty("waiting_since") + public Optional getWaitingSince() { + return waitingSince; + } + + /** + * @return If set this is the time in the future when this conversation will be marked as open. i.e. it will be in a snoozed state until this time. i.e. it will be in a snoozed state until this time. + */ + @JsonProperty("snoozed_until") + public Optional getSnoozedUntil() { + return snoozedUntil; + } + + /** + * @return Indicates whether a conversation is open (true) or closed (false). + */ + @JsonProperty("open") + public boolean getOpen() { + return open; + } + + /** + * @return Can be set to "open", "closed" or "snoozed". + */ + @JsonProperty("state") + public State getState() { + return state; + } + + /** + * @return Indicates whether a conversation has been read. + */ + @JsonProperty("read") + public boolean getRead() { + return read; + } + + /** + * @return If marked as priority, it will return priority or else not_priority. + */ + @JsonProperty("priority") + public Optional getPriority() { + return priority; + } + + /** + * @return The id of the admin assigned to the conversation. If it's not assigned to an admin it will return null. + */ + @JsonProperty("admin_assignee_id") + public Optional getAdminAssigneeId() { + return adminAssigneeId; + } + + /** + * @return The id of the team assigned to the conversation. If it's not assigned to a team it will return null. + */ + @JsonProperty("team_assignee_id") + public Optional getTeamAssigneeId() { + return teamAssigneeId; + } + + /** + * @return The ID of the company that the conversation is associated with. The unique identifier for the company which is given by Intercom. + */ + @JsonProperty("company_id") + public Optional getCompanyId() { + return companyId; + } + + @JsonProperty("tags") + public Optional getTags() { + return tags; + } + + @JsonProperty("conversation_rating") + public Optional getConversationRating() { + return conversationRating; + } + + @JsonProperty("source") + public ConversationSource getSource() { + return source; + } + + @JsonProperty("contacts") + public ConversationContacts getContacts() { + return contacts; + } + + @JsonProperty("teammates") + public Optional getTeammates() { + return teammates; + } + + @JsonProperty("custom_attributes") + public Map getCustomAttributes() { + return customAttributes; + } + + @JsonProperty("first_contact_reply") + public Optional getFirstContactReply() { + return firstContactReply; + } + + @JsonProperty("sla_applied") + public Optional getSlaApplied() { + return slaApplied; + } + + @JsonProperty("statistics") + public Optional getStatistics() { + return statistics; + } + + @JsonProperty("conversation_parts") + public Optional getConversationParts() { + return conversationParts; + } + + @JsonProperty("linked_objects") + public Optional getLinkedObjects() { + return linkedObjects; + } + + /** + * @return Indicates whether the AI Agent participated in the conversation. + */ + @JsonProperty("ai_agent_participated") + public Optional getAiAgentParticipated() { + return aiAgentParticipated; + } + + @JsonProperty("ai_agent") + public Optional getAiAgent() { + return aiAgent; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof Conversation && equalTo((Conversation) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(Conversation other) { + return type.equals(other.type) + && id.equals(other.id) + && title.equals(other.title) + && createdAt == other.createdAt + && updatedAt == other.updatedAt + && waitingSince.equals(other.waitingSince) + && snoozedUntil.equals(other.snoozedUntil) + && open == other.open + && state.equals(other.state) + && read == other.read + && priority.equals(other.priority) + && adminAssigneeId.equals(other.adminAssigneeId) + && teamAssigneeId.equals(other.teamAssigneeId) + && companyId.equals(other.companyId) + && tags.equals(other.tags) + && conversationRating.equals(other.conversationRating) + && source.equals(other.source) + && contacts.equals(other.contacts) + && teammates.equals(other.teammates) + && customAttributes.equals(other.customAttributes) + && firstContactReply.equals(other.firstContactReply) + && slaApplied.equals(other.slaApplied) + && statistics.equals(other.statistics) + && conversationParts.equals(other.conversationParts) + && linkedObjects.equals(other.linkedObjects) + && aiAgentParticipated.equals(other.aiAgentParticipated) + && aiAgent.equals(other.aiAgent); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash( + this.type, + this.id, + this.title, + this.createdAt, + this.updatedAt, + this.waitingSince, + this.snoozedUntil, + this.open, + this.state, + this.read, + this.priority, + this.adminAssigneeId, + this.teamAssigneeId, + this.companyId, + this.tags, + this.conversationRating, + this.source, + this.contacts, + this.teammates, + this.customAttributes, + this.firstContactReply, + this.slaApplied, + this.statistics, + this.conversationParts, + this.linkedObjects, + this.aiAgentParticipated, + this.aiAgent); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static TypeStage builder() { + return new Builder(); + } + + public interface TypeStage { + /** + *

Always conversation.

+ */ + IdStage type(@NotNull String type); + + Builder from(Conversation other); + } + + public interface IdStage { + /** + *

The id representing the conversation.

+ */ + CreatedAtStage id(@NotNull String id); + } + + public interface CreatedAtStage { + /** + *

The time the conversation was created.

+ */ + UpdatedAtStage createdAt(int createdAt); + } + + public interface UpdatedAtStage { + /** + *

The last time the conversation was updated.

+ */ + OpenStage updatedAt(int updatedAt); + } + + public interface OpenStage { + /** + *

Indicates whether a conversation is open (true) or closed (false).

+ */ + StateStage open(boolean open); + } + + public interface StateStage { + /** + *

Can be set to "open", "closed" or "snoozed".

+ */ + ReadStage state(@NotNull State state); + } + + public interface ReadStage { + /** + *

Indicates whether a conversation has been read.

+ */ + SourceStage read(boolean read); + } + + public interface SourceStage { + ContactsStage source(@NotNull ConversationSource source); + } + + public interface ContactsStage { + _FinalStage contacts(@NotNull ConversationContacts contacts); + } + + public interface _FinalStage { + Conversation build(); + + /** + *

The title given to the conversation.

+ */ + _FinalStage title(Optional title); + + _FinalStage title(String title); + + /** + *

The last time a Contact responded to an Admin. In other words, the time a customer started waiting for a response. Set to null if last reply is from an Admin.

+ */ + _FinalStage waitingSince(Optional waitingSince); + + _FinalStage waitingSince(Integer waitingSince); + + /** + *

If set this is the time in the future when this conversation will be marked as open. i.e. it will be in a snoozed state until this time. i.e. it will be in a snoozed state until this time.

+ */ + _FinalStage snoozedUntil(Optional snoozedUntil); + + _FinalStage snoozedUntil(Integer snoozedUntil); + + /** + *

If marked as priority, it will return priority or else not_priority.

+ */ + _FinalStage priority(Optional priority); + + _FinalStage priority(Priority priority); + + /** + *

The id of the admin assigned to the conversation. If it's not assigned to an admin it will return null.

+ */ + _FinalStage adminAssigneeId(Optional adminAssigneeId); + + _FinalStage adminAssigneeId(Integer adminAssigneeId); + + /** + *

The id of the team assigned to the conversation. If it's not assigned to a team it will return null.

+ */ + _FinalStage teamAssigneeId(Optional teamAssigneeId); + + _FinalStage teamAssigneeId(String teamAssigneeId); + + /** + *

The ID of the company that the conversation is associated with. The unique identifier for the company which is given by Intercom.

+ */ + _FinalStage companyId(Optional companyId); + + _FinalStage companyId(String companyId); + + _FinalStage tags(Optional tags); + + _FinalStage tags(Tags tags); + + _FinalStage conversationRating(Optional conversationRating); + + _FinalStage conversationRating(ConversationRating conversationRating); + + _FinalStage teammates(Optional teammates); + + _FinalStage teammates(ConversationTeammates teammates); + + _FinalStage customAttributes(Map customAttributes); + + _FinalStage putAllCustomAttributes(Map customAttributes); + + _FinalStage customAttributes(String key, CustomAttributesValue value); + + _FinalStage firstContactReply(Optional firstContactReply); + + _FinalStage firstContactReply(ConversationFirstContactReply firstContactReply); + + _FinalStage slaApplied(Optional slaApplied); + + _FinalStage slaApplied(SlaApplied slaApplied); + + _FinalStage statistics(Optional statistics); + + _FinalStage statistics(ConversationStatistics statistics); + + _FinalStage conversationParts(Optional conversationParts); + + _FinalStage conversationParts(ConversationParts conversationParts); + + _FinalStage linkedObjects(Optional linkedObjects); + + _FinalStage linkedObjects(LinkedObjectList linkedObjects); + + /** + *

Indicates whether the AI Agent participated in the conversation.

+ */ + _FinalStage aiAgentParticipated(Optional aiAgentParticipated); + + _FinalStage aiAgentParticipated(Boolean aiAgentParticipated); + + _FinalStage aiAgent(Optional aiAgent); + + _FinalStage aiAgent(AiAgent aiAgent); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder + implements TypeStage, + IdStage, + CreatedAtStage, + UpdatedAtStage, + OpenStage, + StateStage, + ReadStage, + SourceStage, + ContactsStage, + _FinalStage { + private String type; + + private String id; + + private int createdAt; + + private int updatedAt; + + private boolean open; + + private State state; + + private boolean read; + + private ConversationSource source; + + private ConversationContacts contacts; + + private Optional aiAgent = Optional.empty(); + + private Optional aiAgentParticipated = Optional.empty(); + + private Optional linkedObjects = Optional.empty(); + + private Optional conversationParts = Optional.empty(); + + private Optional statistics = Optional.empty(); + + private Optional slaApplied = Optional.empty(); + + private Optional firstContactReply = Optional.empty(); + + private Map customAttributes = new LinkedHashMap<>(); + + private Optional teammates = Optional.empty(); + + private Optional conversationRating = Optional.empty(); + + private Optional tags = Optional.empty(); + + private Optional companyId = Optional.empty(); + + private Optional teamAssigneeId = Optional.empty(); + + private Optional adminAssigneeId = Optional.empty(); + + private Optional priority = Optional.empty(); + + private Optional snoozedUntil = Optional.empty(); + + private Optional waitingSince = Optional.empty(); + + private Optional title = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(Conversation other) { + type(other.getType()); + id(other.getId()); + title(other.getTitle()); + createdAt(other.getCreatedAt()); + updatedAt(other.getUpdatedAt()); + waitingSince(other.getWaitingSince()); + snoozedUntil(other.getSnoozedUntil()); + open(other.getOpen()); + state(other.getState()); + read(other.getRead()); + priority(other.getPriority()); + adminAssigneeId(other.getAdminAssigneeId()); + teamAssigneeId(other.getTeamAssigneeId()); + companyId(other.getCompanyId()); + tags(other.getTags()); + conversationRating(other.getConversationRating()); + source(other.getSource()); + contacts(other.getContacts()); + teammates(other.getTeammates()); + customAttributes(other.getCustomAttributes()); + firstContactReply(other.getFirstContactReply()); + slaApplied(other.getSlaApplied()); + statistics(other.getStatistics()); + conversationParts(other.getConversationParts()); + linkedObjects(other.getLinkedObjects()); + aiAgentParticipated(other.getAiAgentParticipated()); + aiAgent(other.getAiAgent()); + return this; + } + + /** + *

Always conversation.

+ *

Always conversation.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("type") + public IdStage type(@NotNull String type) { + this.type = Objects.requireNonNull(type, "type must not be null"); + return this; + } + + /** + *

The id representing the conversation.

+ *

The id representing the conversation.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("id") + public CreatedAtStage id(@NotNull String id) { + this.id = Objects.requireNonNull(id, "id must not be null"); + return this; + } + + /** + *

The time the conversation was created.

+ *

The time the conversation was created.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("created_at") + public UpdatedAtStage createdAt(int createdAt) { + this.createdAt = createdAt; + return this; + } + + /** + *

The last time the conversation was updated.

+ *

The last time the conversation was updated.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("updated_at") + public OpenStage updatedAt(int updatedAt) { + this.updatedAt = updatedAt; + return this; + } + + /** + *

Indicates whether a conversation is open (true) or closed (false).

+ *

Indicates whether a conversation is open (true) or closed (false).

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("open") + public StateStage open(boolean open) { + this.open = open; + return this; + } + + /** + *

Can be set to "open", "closed" or "snoozed".

+ *

Can be set to "open", "closed" or "snoozed".

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("state") + public ReadStage state(@NotNull State state) { + this.state = Objects.requireNonNull(state, "state must not be null"); + return this; + } + + /** + *

Indicates whether a conversation has been read.

+ *

Indicates whether a conversation has been read.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("read") + public SourceStage read(boolean read) { + this.read = read; + return this; + } + + @java.lang.Override + @JsonSetter("source") + public ContactsStage source(@NotNull ConversationSource source) { + this.source = Objects.requireNonNull(source, "source must not be null"); + return this; + } + + @java.lang.Override + @JsonSetter("contacts") + public _FinalStage contacts(@NotNull ConversationContacts contacts) { + this.contacts = Objects.requireNonNull(contacts, "contacts must not be null"); + return this; + } + + @java.lang.Override + public _FinalStage aiAgent(AiAgent aiAgent) { + this.aiAgent = Optional.ofNullable(aiAgent); + return this; + } + + @java.lang.Override + @JsonSetter(value = "ai_agent", nulls = Nulls.SKIP) + public _FinalStage aiAgent(Optional aiAgent) { + this.aiAgent = aiAgent; + return this; + } + + /** + *

Indicates whether the AI Agent participated in the conversation.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage aiAgentParticipated(Boolean aiAgentParticipated) { + this.aiAgentParticipated = Optional.ofNullable(aiAgentParticipated); + return this; + } + + /** + *

Indicates whether the AI Agent participated in the conversation.

+ */ + @java.lang.Override + @JsonSetter(value = "ai_agent_participated", nulls = Nulls.SKIP) + public _FinalStage aiAgentParticipated(Optional aiAgentParticipated) { + this.aiAgentParticipated = aiAgentParticipated; + return this; + } + + @java.lang.Override + public _FinalStage linkedObjects(LinkedObjectList linkedObjects) { + this.linkedObjects = Optional.ofNullable(linkedObjects); + return this; + } + + @java.lang.Override + @JsonSetter(value = "linked_objects", nulls = Nulls.SKIP) + public _FinalStage linkedObjects(Optional linkedObjects) { + this.linkedObjects = linkedObjects; + return this; + } + + @java.lang.Override + public _FinalStage conversationParts(ConversationParts conversationParts) { + this.conversationParts = Optional.ofNullable(conversationParts); + return this; + } + + @java.lang.Override + @JsonSetter(value = "conversation_parts", nulls = Nulls.SKIP) + public _FinalStage conversationParts(Optional conversationParts) { + this.conversationParts = conversationParts; + return this; + } + + @java.lang.Override + public _FinalStage statistics(ConversationStatistics statistics) { + this.statistics = Optional.ofNullable(statistics); + return this; + } + + @java.lang.Override + @JsonSetter(value = "statistics", nulls = Nulls.SKIP) + public _FinalStage statistics(Optional statistics) { + this.statistics = statistics; + return this; + } + + @java.lang.Override + public _FinalStage slaApplied(SlaApplied slaApplied) { + this.slaApplied = Optional.ofNullable(slaApplied); + return this; + } + + @java.lang.Override + @JsonSetter(value = "sla_applied", nulls = Nulls.SKIP) + public _FinalStage slaApplied(Optional slaApplied) { + this.slaApplied = slaApplied; + return this; + } + + @java.lang.Override + public _FinalStage firstContactReply(ConversationFirstContactReply firstContactReply) { + this.firstContactReply = Optional.ofNullable(firstContactReply); + return this; + } + + @java.lang.Override + @JsonSetter(value = "first_contact_reply", nulls = Nulls.SKIP) + public _FinalStage firstContactReply(Optional firstContactReply) { + this.firstContactReply = firstContactReply; + return this; + } + + @java.lang.Override + public _FinalStage customAttributes(String key, CustomAttributesValue value) { + this.customAttributes.put(key, value); + return this; + } + + @java.lang.Override + public _FinalStage putAllCustomAttributes(Map customAttributes) { + if (customAttributes != null) { + this.customAttributes.putAll(customAttributes); + } + return this; + } + + @java.lang.Override + @JsonSetter(value = "custom_attributes", nulls = Nulls.SKIP) + public _FinalStage customAttributes(Map customAttributes) { + this.customAttributes.clear(); + if (customAttributes != null) { + this.customAttributes.putAll(customAttributes); + } + return this; + } + + @java.lang.Override + public _FinalStage teammates(ConversationTeammates teammates) { + this.teammates = Optional.ofNullable(teammates); + return this; + } + + @java.lang.Override + @JsonSetter(value = "teammates", nulls = Nulls.SKIP) + public _FinalStage teammates(Optional teammates) { + this.teammates = teammates; + return this; + } + + @java.lang.Override + public _FinalStage conversationRating(ConversationRating conversationRating) { + this.conversationRating = Optional.ofNullable(conversationRating); + return this; + } + + @java.lang.Override + @JsonSetter(value = "conversation_rating", nulls = Nulls.SKIP) + public _FinalStage conversationRating(Optional conversationRating) { + this.conversationRating = conversationRating; + return this; + } + + @java.lang.Override + public _FinalStage tags(Tags tags) { + this.tags = Optional.ofNullable(tags); + return this; + } + + @java.lang.Override + @JsonSetter(value = "tags", nulls = Nulls.SKIP) + public _FinalStage tags(Optional tags) { + this.tags = tags; + return this; + } + + /** + *

The ID of the company that the conversation is associated with. The unique identifier for the company which is given by Intercom.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage companyId(String companyId) { + this.companyId = Optional.ofNullable(companyId); + return this; + } + + /** + *

The ID of the company that the conversation is associated with. The unique identifier for the company which is given by Intercom.

+ */ + @java.lang.Override + @JsonSetter(value = "company_id", nulls = Nulls.SKIP) + public _FinalStage companyId(Optional companyId) { + this.companyId = companyId; + return this; + } + + /** + *

The id of the team assigned to the conversation. If it's not assigned to a team it will return null.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage teamAssigneeId(String teamAssigneeId) { + this.teamAssigneeId = Optional.ofNullable(teamAssigneeId); + return this; + } + + /** + *

The id of the team assigned to the conversation. If it's not assigned to a team it will return null.

+ */ + @java.lang.Override + @JsonSetter(value = "team_assignee_id", nulls = Nulls.SKIP) + public _FinalStage teamAssigneeId(Optional teamAssigneeId) { + this.teamAssigneeId = teamAssigneeId; + return this; + } + + /** + *

The id of the admin assigned to the conversation. If it's not assigned to an admin it will return null.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage adminAssigneeId(Integer adminAssigneeId) { + this.adminAssigneeId = Optional.ofNullable(adminAssigneeId); + return this; + } + + /** + *

The id of the admin assigned to the conversation. If it's not assigned to an admin it will return null.

+ */ + @java.lang.Override + @JsonSetter(value = "admin_assignee_id", nulls = Nulls.SKIP) + public _FinalStage adminAssigneeId(Optional adminAssigneeId) { + this.adminAssigneeId = adminAssigneeId; + return this; + } + + /** + *

If marked as priority, it will return priority or else not_priority.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage priority(Priority priority) { + this.priority = Optional.ofNullable(priority); + return this; + } + + /** + *

If marked as priority, it will return priority or else not_priority.

+ */ + @java.lang.Override + @JsonSetter(value = "priority", nulls = Nulls.SKIP) + public _FinalStage priority(Optional priority) { + this.priority = priority; + return this; + } + + /** + *

If set this is the time in the future when this conversation will be marked as open. i.e. it will be in a snoozed state until this time. i.e. it will be in a snoozed state until this time.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage snoozedUntil(Integer snoozedUntil) { + this.snoozedUntil = Optional.ofNullable(snoozedUntil); + return this; + } + + /** + *

If set this is the time in the future when this conversation will be marked as open. i.e. it will be in a snoozed state until this time. i.e. it will be in a snoozed state until this time.

+ */ + @java.lang.Override + @JsonSetter(value = "snoozed_until", nulls = Nulls.SKIP) + public _FinalStage snoozedUntil(Optional snoozedUntil) { + this.snoozedUntil = snoozedUntil; + return this; + } + + /** + *

The last time a Contact responded to an Admin. In other words, the time a customer started waiting for a response. Set to null if last reply is from an Admin.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage waitingSince(Integer waitingSince) { + this.waitingSince = Optional.ofNullable(waitingSince); + return this; + } + + /** + *

The last time a Contact responded to an Admin. In other words, the time a customer started waiting for a response. Set to null if last reply is from an Admin.

+ */ + @java.lang.Override + @JsonSetter(value = "waiting_since", nulls = Nulls.SKIP) + public _FinalStage waitingSince(Optional waitingSince) { + this.waitingSince = waitingSince; + return this; + } + + /** + *

The title given to the conversation.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage title(String title) { + this.title = Optional.ofNullable(title); + return this; + } + + /** + *

The title given to the conversation.

+ */ + @java.lang.Override + @JsonSetter(value = "title", nulls = Nulls.SKIP) + public _FinalStage title(Optional title) { + this.title = title; + return this; + } + + @java.lang.Override + public Conversation build() { + return new Conversation( + type, + id, + title, + createdAt, + updatedAt, + waitingSince, + snoozedUntil, + open, + state, + read, + priority, + adminAssigneeId, + teamAssigneeId, + companyId, + tags, + conversationRating, + source, + contacts, + teammates, + customAttributes, + firstContactReply, + slaApplied, + statistics, + conversationParts, + linkedObjects, + aiAgentParticipated, + aiAgent, + additionalProperties); + } + } + + public static final class Priority { + public static final Priority PRIORITY = new Priority(Value.PRIORITY, "priority"); + + public static final Priority NOT_PRIORITY = new Priority(Value.NOT_PRIORITY, "not_priority"); + + private final Value value; + + private final String string; + + Priority(Value value, String string) { + this.value = value; + this.string = string; + } + + public Value getEnumValue() { + return value; + } + + @java.lang.Override + @JsonValue + public String toString() { + return this.string; + } + + @java.lang.Override + public boolean equals(Object other) { + return (this == other) || (other instanceof Priority && this.string.equals(((Priority) other).string)); + } + + @java.lang.Override + public int hashCode() { + return this.string.hashCode(); + } + + public T visit(Visitor visitor) { + switch (value) { + case PRIORITY: + return visitor.visitPriority(); + case NOT_PRIORITY: + return visitor.visitNotPriority(); + case UNKNOWN: + default: + return visitor.visitUnknown(string); + } + } + + @JsonCreator(mode = JsonCreator.Mode.DELEGATING) + public static Priority valueOf(String value) { + switch (value) { + case "priority": + return PRIORITY; + case "not_priority": + return NOT_PRIORITY; + default: + return new Priority(Value.UNKNOWN, value); + } + } + + public enum Value { + PRIORITY, + + NOT_PRIORITY, + + UNKNOWN + } + + public interface Visitor { + T visitPriority(); + + T visitNotPriority(); + + T visitUnknown(String unknownType); + } + } + + public static final class State { + public static final State SNOOZED = new State(Value.SNOOZED, "snoozed"); + + public static final State CLOSED = new State(Value.CLOSED, "closed"); + + public static final State OPEN = new State(Value.OPEN, "open"); + + private final Value value; + + private final String string; + + State(Value value, String string) { + this.value = value; + this.string = string; + } + + public Value getEnumValue() { + return value; + } + + @java.lang.Override + @JsonValue + public String toString() { + return this.string; + } + + @java.lang.Override + public boolean equals(Object other) { + return (this == other) || (other instanceof State && this.string.equals(((State) other).string)); + } + + @java.lang.Override + public int hashCode() { + return this.string.hashCode(); + } + + public T visit(Visitor visitor) { + switch (value) { + case SNOOZED: + return visitor.visitSnoozed(); + case CLOSED: + return visitor.visitClosed(); + case OPEN: + return visitor.visitOpen(); + case UNKNOWN: + default: + return visitor.visitUnknown(string); + } + } + + @JsonCreator(mode = JsonCreator.Mode.DELEGATING) + public static State valueOf(String value) { + switch (value) { + case "snoozed": + return SNOOZED; + case "closed": + return CLOSED; + case "open": + return OPEN; + default: + return new State(Value.UNKNOWN, value); + } + } + + public enum Value { + OPEN, + + CLOSED, + + SNOOZED, + + UNKNOWN + } + + public interface Visitor { + T visitOpen(); + + T visitClosed(); + + T visitSnoozed(); + + T visitUnknown(String unknownType); + } + } + + @JsonDeserialize(using = CustomAttributesValue.Deserializer.class) + public static final class CustomAttributesValue { + private final Object value; + + private final int type; + + private CustomAttributesValue(Object value, int type) { + this.value = value; + this.type = type; + } + + @JsonValue + public Object get() { + return this.value; + } + + @SuppressWarnings("unchecked") + public T visit(Visitor visitor) { + if (this.type == 0) { + return visitor.visit((String) this.value); + } else if (this.type == 1) { + return visitor.visit((int) this.value); + } else if (this.type == 2) { + return visitor.visit((Datetime) this.value); + } else if (this.type == 3) { + return visitor.visit((CustomObjectInstanceList) this.value); + } + throw new IllegalStateException("Failed to visit value. This should never happen."); + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof CustomAttributesValue && equalTo((CustomAttributesValue) other); + } + + private boolean equalTo(CustomAttributesValue other) { + return value.equals(other.value); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.value); + } + + @java.lang.Override + public String toString() { + return this.value.toString(); + } + + public static CustomAttributesValue of(String value) { + return new CustomAttributesValue(value, 0); + } + + public static CustomAttributesValue of(int value) { + return new CustomAttributesValue(value, 1); + } + + public static CustomAttributesValue of(Datetime value) { + return new CustomAttributesValue(value, 2); + } + + public static CustomAttributesValue of(CustomObjectInstanceList value) { + return new CustomAttributesValue(value, 3); + } + + public interface Visitor { + T visit(String value); + + T visit(int value); + + T visit(Datetime value); + + T visit(CustomObjectInstanceList value); + } + + static final class Deserializer extends StdDeserializer { + Deserializer() { + super(CustomAttributesValue.class); + } + + @java.lang.Override + public CustomAttributesValue deserialize(JsonParser p, DeserializationContext context) throws IOException { + Object value = p.readValueAs(Object.class); + try { + return of(ObjectMappers.JSON_MAPPER.convertValue(value, String.class)); + } catch (RuntimeException e) { + } + if (value instanceof Integer) { + return of((Integer) value); + } + try { + return of(ObjectMappers.JSON_MAPPER.convertValue(value, Datetime.class)); + } catch (RuntimeException e) { + } + try { + return of(ObjectMappers.JSON_MAPPER.convertValue(value, CustomObjectInstanceList.class)); + } catch (RuntimeException e) { + } + throw new JsonParseException(p, "Failed to deserialize"); + } + } + } +} diff --git a/src/main/java/com/intercom/api/resources/conversations/types/ConversationsManageRequestBody.java b/src/main/java/com/intercom/api/resources/conversations/types/ConversationsManageRequestBody.java new file mode 100644 index 00000000..e40cfdc6 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/conversations/types/ConversationsManageRequestBody.java @@ -0,0 +1,328 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.conversations.types; + +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSubTypes; +import com.fasterxml.jackson.annotation.JsonTypeInfo; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonUnwrapped; +import com.fasterxml.jackson.annotation.JsonValue; +import com.intercom.api.types.AssignConversationRequest; +import com.intercom.api.types.CloseConversationRequest; +import com.intercom.api.types.OpenConversationRequest; +import com.intercom.api.types.SnoozeConversationRequest; +import java.util.Objects; +import java.util.Optional; + +public final class ConversationsManageRequestBody { + private final Value value; + + @JsonCreator(mode = JsonCreator.Mode.DELEGATING) + private ConversationsManageRequestBody(Value value) { + this.value = value; + } + + public T visit(Visitor visitor) { + return value.visit(visitor); + } + + public static ConversationsManageRequestBody close(CloseConversationRequest value) { + return new ConversationsManageRequestBody(new CloseValue(value)); + } + + public static ConversationsManageRequestBody snoozed(SnoozeConversationRequest value) { + return new ConversationsManageRequestBody(new SnoozedValue(value)); + } + + public static ConversationsManageRequestBody open(OpenConversationRequest value) { + return new ConversationsManageRequestBody(new OpenValue(value)); + } + + public static ConversationsManageRequestBody assignment(AssignConversationRequest value) { + return new ConversationsManageRequestBody(new AssignmentValue(value)); + } + + public boolean isClose() { + return value instanceof CloseValue; + } + + public boolean isSnoozed() { + return value instanceof SnoozedValue; + } + + public boolean isOpen() { + return value instanceof OpenValue; + } + + public boolean isAssignment() { + return value instanceof AssignmentValue; + } + + public boolean _isUnknown() { + return value instanceof _UnknownValue; + } + + public Optional getClose() { + if (isClose()) { + return Optional.of(((CloseValue) value).value); + } + return Optional.empty(); + } + + public Optional getSnoozed() { + if (isSnoozed()) { + return Optional.of(((SnoozedValue) value).value); + } + return Optional.empty(); + } + + public Optional getOpen() { + if (isOpen()) { + return Optional.of(((OpenValue) value).value); + } + return Optional.empty(); + } + + public Optional getAssignment() { + if (isAssignment()) { + return Optional.of(((AssignmentValue) value).value); + } + return Optional.empty(); + } + + public Optional _getUnknown() { + if (_isUnknown()) { + return Optional.of(((_UnknownValue) value).value); + } + return Optional.empty(); + } + + @JsonValue + private Value getValue() { + return this.value; + } + + public interface Visitor { + T visitClose(CloseConversationRequest close); + + T visitSnoozed(SnoozeConversationRequest snoozed); + + T visitOpen(OpenConversationRequest open); + + T visitAssignment(AssignConversationRequest assignment); + + T _visitUnknown(Object unknownType); + } + + @JsonTypeInfo( + use = JsonTypeInfo.Id.NAME, + property = "message_type", + visible = true, + defaultImpl = _UnknownValue.class) + @JsonSubTypes({ + @JsonSubTypes.Type(CloseValue.class), + @JsonSubTypes.Type(SnoozedValue.class), + @JsonSubTypes.Type(OpenValue.class), + @JsonSubTypes.Type(AssignmentValue.class) + }) + @JsonIgnoreProperties(ignoreUnknown = true) + private interface Value { + T visit(Visitor visitor); + } + + @JsonTypeName("close") + @JsonIgnoreProperties("message_type") + private static final class CloseValue implements Value { + @JsonUnwrapped + private CloseConversationRequest value; + + @JsonCreator(mode = JsonCreator.Mode.PROPERTIES) + private CloseValue() {} + + private CloseValue(CloseConversationRequest value) { + this.value = value; + } + + @java.lang.Override + public T visit(Visitor visitor) { + return visitor.visitClose(value); + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof CloseValue && equalTo((CloseValue) other); + } + + private boolean equalTo(CloseValue other) { + return value.equals(other.value); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.value); + } + + @java.lang.Override + public String toString() { + return "ConversationsManageRequestBody{" + "value: " + value + "}"; + } + } + + @JsonTypeName("snoozed") + @JsonIgnoreProperties("message_type") + private static final class SnoozedValue implements Value { + @JsonUnwrapped + private SnoozeConversationRequest value; + + @JsonCreator(mode = JsonCreator.Mode.PROPERTIES) + private SnoozedValue() {} + + private SnoozedValue(SnoozeConversationRequest value) { + this.value = value; + } + + @java.lang.Override + public T visit(Visitor visitor) { + return visitor.visitSnoozed(value); + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof SnoozedValue && equalTo((SnoozedValue) other); + } + + private boolean equalTo(SnoozedValue other) { + return value.equals(other.value); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.value); + } + + @java.lang.Override + public String toString() { + return "ConversationsManageRequestBody{" + "value: " + value + "}"; + } + } + + @JsonTypeName("open") + @JsonIgnoreProperties("message_type") + private static final class OpenValue implements Value { + @JsonUnwrapped + private OpenConversationRequest value; + + @JsonCreator(mode = JsonCreator.Mode.PROPERTIES) + private OpenValue() {} + + private OpenValue(OpenConversationRequest value) { + this.value = value; + } + + @java.lang.Override + public T visit(Visitor visitor) { + return visitor.visitOpen(value); + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof OpenValue && equalTo((OpenValue) other); + } + + private boolean equalTo(OpenValue other) { + return value.equals(other.value); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.value); + } + + @java.lang.Override + public String toString() { + return "ConversationsManageRequestBody{" + "value: " + value + "}"; + } + } + + @JsonTypeName("assignment") + @JsonIgnoreProperties("message_type") + private static final class AssignmentValue implements Value { + @JsonUnwrapped + private AssignConversationRequest value; + + @JsonCreator(mode = JsonCreator.Mode.PROPERTIES) + private AssignmentValue() {} + + private AssignmentValue(AssignConversationRequest value) { + this.value = value; + } + + @java.lang.Override + public T visit(Visitor visitor) { + return visitor.visitAssignment(value); + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof AssignmentValue && equalTo((AssignmentValue) other); + } + + private boolean equalTo(AssignmentValue other) { + return value.equals(other.value); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.value); + } + + @java.lang.Override + public String toString() { + return "ConversationsManageRequestBody{" + "value: " + value + "}"; + } + } + + @JsonIgnoreProperties("message_type") + private static final class _UnknownValue implements Value { + private String type; + + @JsonValue + private Object value; + + @JsonCreator(mode = JsonCreator.Mode.PROPERTIES) + private _UnknownValue(@JsonProperty("value") Object value) {} + + @java.lang.Override + public T visit(Visitor visitor) { + return visitor._visitUnknown(value); + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof _UnknownValue && equalTo((_UnknownValue) other); + } + + private boolean equalTo(_UnknownValue other) { + return type.equals(other.type) && value.equals(other.value); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.type, this.value); + } + + @java.lang.Override + public String toString() { + return "ConversationsManageRequestBody{" + "type: " + type + ", value: " + value + "}"; + } + } +} diff --git a/src/main/java/com/intercom/api/resources/customchannelevents/AsyncCustomChannelEventsClient.java b/src/main/java/com/intercom/api/resources/customchannelevents/AsyncCustomChannelEventsClient.java new file mode 100644 index 00000000..c007d7c2 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/customchannelevents/AsyncCustomChannelEventsClient.java @@ -0,0 +1,117 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.customchannelevents; + +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.resources.customchannelevents.requests.NotifyAttributeCollectedRequest; +import com.intercom.api.resources.customchannelevents.requests.NotifyNewMessageRequest; +import com.intercom.api.resources.customchannelevents.requests.NotifyQuickReplySelectedRequest; +import com.intercom.api.types.CustomChannelBaseEvent; +import com.intercom.api.types.CustomChannelNotificationResponse; +import java.util.concurrent.CompletableFuture; + +public class AsyncCustomChannelEventsClient { + protected final ClientOptions clientOptions; + + private final AsyncRawCustomChannelEventsClient rawClient; + + public AsyncCustomChannelEventsClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + this.rawClient = new AsyncRawCustomChannelEventsClient(clientOptions); + } + + /** + * Get responses with HTTP metadata like headers + */ + public AsyncRawCustomChannelEventsClient withRawResponse() { + return this.rawClient; + } + + /** + * Notifies Intercom that a new conversation was created in your custom channel/platform. This triggers conversation creation and workflow automations within Intercom for your custom channel integration. + *
+ *

Note: This endpoint is currently under managed availability. Please reach out to your accounts team to discuss access and tailored, hands-on support.

+ *
+ */ + public CompletableFuture notifyNewConversation(CustomChannelBaseEvent request) { + return this.rawClient.notifyNewConversation(request).thenApply(response -> response.body()); + } + + /** + * Notifies Intercom that a new conversation was created in your custom channel/platform. This triggers conversation creation and workflow automations within Intercom for your custom channel integration. + *
+ *

Note: This endpoint is currently under managed availability. Please reach out to your accounts team to discuss access and tailored, hands-on support.

+ *
+ */ + public CompletableFuture notifyNewConversation( + CustomChannelBaseEvent request, RequestOptions requestOptions) { + return this.rawClient.notifyNewConversation(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * Notifies Intercom that a new message was sent in a conversation on your custom channel/platform. This allows Intercom to process the message and trigger any relevant workflow automations. + *
+ *

Note: This endpoint is currently under managed availability. Please reach out to your accounts team to discuss access and tailored, hands-on support.

+ *
+ */ + public CompletableFuture notifyNewMessage(NotifyNewMessageRequest request) { + return this.rawClient.notifyNewMessage(request).thenApply(response -> response.body()); + } + + /** + * Notifies Intercom that a new message was sent in a conversation on your custom channel/platform. This allows Intercom to process the message and trigger any relevant workflow automations. + *
+ *

Note: This endpoint is currently under managed availability. Please reach out to your accounts team to discuss access and tailored, hands-on support.

+ *
+ */ + public CompletableFuture notifyNewMessage( + NotifyNewMessageRequest request, RequestOptions requestOptions) { + return this.rawClient.notifyNewMessage(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * Notifies Intercom that a user selected a quick reply option in your custom channel/platform. This allows Intercom to process the response and trigger any relevant workflow automations. + *
+ *

Note: This endpoint is currently under managed availability. Please reach out to your accounts team to discuss access and tailored, hands-on support.

+ *
+ */ + public CompletableFuture notifyQuickReplySelected( + NotifyQuickReplySelectedRequest request) { + return this.rawClient.notifyQuickReplySelected(request).thenApply(response -> response.body()); + } + + /** + * Notifies Intercom that a user selected a quick reply option in your custom channel/platform. This allows Intercom to process the response and trigger any relevant workflow automations. + *
+ *

Note: This endpoint is currently under managed availability. Please reach out to your accounts team to discuss access and tailored, hands-on support.

+ *
+ */ + public CompletableFuture notifyQuickReplySelected( + NotifyQuickReplySelectedRequest request, RequestOptions requestOptions) { + return this.rawClient.notifyQuickReplySelected(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * Notifies Intercom that a user provided a response to an attribute collector in your custom channel/platform. This allows Intercom to process the attribute and trigger any relevant workflow automations. + *
+ *

Note: This endpoint is currently under managed availability. Please reach out to your accounts team to discuss access and tailored, hands-on support.

+ *
+ */ + public CompletableFuture notifyAttributeCollected( + NotifyAttributeCollectedRequest request) { + return this.rawClient.notifyAttributeCollected(request).thenApply(response -> response.body()); + } + + /** + * Notifies Intercom that a user provided a response to an attribute collector in your custom channel/platform. This allows Intercom to process the attribute and trigger any relevant workflow automations. + *
+ *

Note: This endpoint is currently under managed availability. Please reach out to your accounts team to discuss access and tailored, hands-on support.

+ *
+ */ + public CompletableFuture notifyAttributeCollected( + NotifyAttributeCollectedRequest request, RequestOptions requestOptions) { + return this.rawClient.notifyAttributeCollected(request, requestOptions).thenApply(response -> response.body()); + } +} diff --git a/src/main/java/com/intercom/api/resources/customchannelevents/AsyncRawCustomChannelEventsClient.java b/src/main/java/com/intercom/api/resources/customchannelevents/AsyncRawCustomChannelEventsClient.java new file mode 100644 index 00000000..72ffe7b1 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/customchannelevents/AsyncRawCustomChannelEventsClient.java @@ -0,0 +1,431 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.customchannelevents; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.IntercomApiException; +import com.intercom.api.core.IntercomException; +import com.intercom.api.core.IntercomHttpResponse; +import com.intercom.api.core.MediaTypes; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.errors.BadRequestError; +import com.intercom.api.errors.NotFoundError; +import com.intercom.api.errors.UnauthorizedError; +import com.intercom.api.errors.UnprocessableEntityError; +import com.intercom.api.resources.customchannelevents.requests.NotifyAttributeCollectedRequest; +import com.intercom.api.resources.customchannelevents.requests.NotifyNewMessageRequest; +import com.intercom.api.resources.customchannelevents.requests.NotifyQuickReplySelectedRequest; +import com.intercom.api.types.CustomChannelBaseEvent; +import com.intercom.api.types.CustomChannelNotificationResponse; +import com.intercom.api.types.Error; +import java.io.IOException; +import java.util.concurrent.CompletableFuture; +import okhttp3.Call; +import okhttp3.Callback; +import okhttp3.Headers; +import okhttp3.HttpUrl; +import okhttp3.OkHttpClient; +import okhttp3.Request; +import okhttp3.RequestBody; +import okhttp3.Response; +import okhttp3.ResponseBody; +import org.jetbrains.annotations.NotNull; + +public class AsyncRawCustomChannelEventsClient { + protected final ClientOptions clientOptions; + + public AsyncRawCustomChannelEventsClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + } + + /** + * Notifies Intercom that a new conversation was created in your custom channel/platform. This triggers conversation creation and workflow automations within Intercom for your custom channel integration. + *
+ *

Note: This endpoint is currently under managed availability. Please reach out to your accounts team to discuss access and tailored, hands-on support.

+ *
+ */ + public CompletableFuture> notifyNewConversation( + CustomChannelBaseEvent request) { + return notifyNewConversation(request, null); + } + + /** + * Notifies Intercom that a new conversation was created in your custom channel/platform. This triggers conversation creation and workflow automations within Intercom for your custom channel integration. + *
+ *

Note: This endpoint is currently under managed availability. Please reach out to your accounts team to discuss access and tailored, hands-on support.

+ *
+ */ + public CompletableFuture> notifyNewConversation( + CustomChannelBaseEvent request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("custom_channel_events/notify_new_conversation") + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue( + responseBodyString, CustomChannelNotificationResponse.class), + response)); + return; + } + try { + switch (response.code()) { + case 400: + future.completeExceptionally(new BadRequestError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 404: + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + case 422: + future.completeExceptionally(new UnprocessableEntityError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * Notifies Intercom that a new message was sent in a conversation on your custom channel/platform. This allows Intercom to process the message and trigger any relevant workflow automations. + *
+ *

Note: This endpoint is currently under managed availability. Please reach out to your accounts team to discuss access and tailored, hands-on support.

+ *
+ */ + public CompletableFuture> notifyNewMessage( + NotifyNewMessageRequest request) { + return notifyNewMessage(request, null); + } + + /** + * Notifies Intercom that a new message was sent in a conversation on your custom channel/platform. This allows Intercom to process the message and trigger any relevant workflow automations. + *
+ *

Note: This endpoint is currently under managed availability. Please reach out to your accounts team to discuss access and tailored, hands-on support.

+ *
+ */ + public CompletableFuture> notifyNewMessage( + NotifyNewMessageRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("custom_channel_events/notify_new_message") + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue( + responseBodyString, CustomChannelNotificationResponse.class), + response)); + return; + } + try { + switch (response.code()) { + case 400: + future.completeExceptionally(new BadRequestError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 404: + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + case 422: + future.completeExceptionally(new UnprocessableEntityError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * Notifies Intercom that a user selected a quick reply option in your custom channel/platform. This allows Intercom to process the response and trigger any relevant workflow automations. + *
+ *

Note: This endpoint is currently under managed availability. Please reach out to your accounts team to discuss access and tailored, hands-on support.

+ *
+ */ + public CompletableFuture> notifyQuickReplySelected( + NotifyQuickReplySelectedRequest request) { + return notifyQuickReplySelected(request, null); + } + + /** + * Notifies Intercom that a user selected a quick reply option in your custom channel/platform. This allows Intercom to process the response and trigger any relevant workflow automations. + *
+ *

Note: This endpoint is currently under managed availability. Please reach out to your accounts team to discuss access and tailored, hands-on support.

+ *
+ */ + public CompletableFuture> notifyQuickReplySelected( + NotifyQuickReplySelectedRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("custom_channel_events/notify_quick_reply_selected") + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue( + responseBodyString, CustomChannelNotificationResponse.class), + response)); + return; + } + try { + switch (response.code()) { + case 400: + future.completeExceptionally(new BadRequestError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 404: + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + case 422: + future.completeExceptionally(new UnprocessableEntityError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * Notifies Intercom that a user provided a response to an attribute collector in your custom channel/platform. This allows Intercom to process the attribute and trigger any relevant workflow automations. + *
+ *

Note: This endpoint is currently under managed availability. Please reach out to your accounts team to discuss access and tailored, hands-on support.

+ *
+ */ + public CompletableFuture> notifyAttributeCollected( + NotifyAttributeCollectedRequest request) { + return notifyAttributeCollected(request, null); + } + + /** + * Notifies Intercom that a user provided a response to an attribute collector in your custom channel/platform. This allows Intercom to process the attribute and trigger any relevant workflow automations. + *
+ *

Note: This endpoint is currently under managed availability. Please reach out to your accounts team to discuss access and tailored, hands-on support.

+ *
+ */ + public CompletableFuture> notifyAttributeCollected( + NotifyAttributeCollectedRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("custom_channel_events/notify_attribute_collected") + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue( + responseBodyString, CustomChannelNotificationResponse.class), + response)); + return; + } + try { + switch (response.code()) { + case 400: + future.completeExceptionally(new BadRequestError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 404: + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + case 422: + future.completeExceptionally(new UnprocessableEntityError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } +} diff --git a/src/main/java/com/intercom/api/resources/customchannelevents/CustomChannelEventsClient.java b/src/main/java/com/intercom/api/resources/customchannelevents/CustomChannelEventsClient.java new file mode 100644 index 00000000..87283059 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/customchannelevents/CustomChannelEventsClient.java @@ -0,0 +1,114 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.customchannelevents; + +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.resources.customchannelevents.requests.NotifyAttributeCollectedRequest; +import com.intercom.api.resources.customchannelevents.requests.NotifyNewMessageRequest; +import com.intercom.api.resources.customchannelevents.requests.NotifyQuickReplySelectedRequest; +import com.intercom.api.types.CustomChannelBaseEvent; +import com.intercom.api.types.CustomChannelNotificationResponse; + +public class CustomChannelEventsClient { + protected final ClientOptions clientOptions; + + private final RawCustomChannelEventsClient rawClient; + + public CustomChannelEventsClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + this.rawClient = new RawCustomChannelEventsClient(clientOptions); + } + + /** + * Get responses with HTTP metadata like headers + */ + public RawCustomChannelEventsClient withRawResponse() { + return this.rawClient; + } + + /** + * Notifies Intercom that a new conversation was created in your custom channel/platform. This triggers conversation creation and workflow automations within Intercom for your custom channel integration. + *
+ *

Note: This endpoint is currently under managed availability. Please reach out to your accounts team to discuss access and tailored, hands-on support.

+ *
+ */ + public CustomChannelNotificationResponse notifyNewConversation(CustomChannelBaseEvent request) { + return this.rawClient.notifyNewConversation(request).body(); + } + + /** + * Notifies Intercom that a new conversation was created in your custom channel/platform. This triggers conversation creation and workflow automations within Intercom for your custom channel integration. + *
+ *

Note: This endpoint is currently under managed availability. Please reach out to your accounts team to discuss access and tailored, hands-on support.

+ *
+ */ + public CustomChannelNotificationResponse notifyNewConversation( + CustomChannelBaseEvent request, RequestOptions requestOptions) { + return this.rawClient.notifyNewConversation(request, requestOptions).body(); + } + + /** + * Notifies Intercom that a new message was sent in a conversation on your custom channel/platform. This allows Intercom to process the message and trigger any relevant workflow automations. + *
+ *

Note: This endpoint is currently under managed availability. Please reach out to your accounts team to discuss access and tailored, hands-on support.

+ *
+ */ + public CustomChannelNotificationResponse notifyNewMessage(NotifyNewMessageRequest request) { + return this.rawClient.notifyNewMessage(request).body(); + } + + /** + * Notifies Intercom that a new message was sent in a conversation on your custom channel/platform. This allows Intercom to process the message and trigger any relevant workflow automations. + *
+ *

Note: This endpoint is currently under managed availability. Please reach out to your accounts team to discuss access and tailored, hands-on support.

+ *
+ */ + public CustomChannelNotificationResponse notifyNewMessage( + NotifyNewMessageRequest request, RequestOptions requestOptions) { + return this.rawClient.notifyNewMessage(request, requestOptions).body(); + } + + /** + * Notifies Intercom that a user selected a quick reply option in your custom channel/platform. This allows Intercom to process the response and trigger any relevant workflow automations. + *
+ *

Note: This endpoint is currently under managed availability. Please reach out to your accounts team to discuss access and tailored, hands-on support.

+ *
+ */ + public CustomChannelNotificationResponse notifyQuickReplySelected(NotifyQuickReplySelectedRequest request) { + return this.rawClient.notifyQuickReplySelected(request).body(); + } + + /** + * Notifies Intercom that a user selected a quick reply option in your custom channel/platform. This allows Intercom to process the response and trigger any relevant workflow automations. + *
+ *

Note: This endpoint is currently under managed availability. Please reach out to your accounts team to discuss access and tailored, hands-on support.

+ *
+ */ + public CustomChannelNotificationResponse notifyQuickReplySelected( + NotifyQuickReplySelectedRequest request, RequestOptions requestOptions) { + return this.rawClient.notifyQuickReplySelected(request, requestOptions).body(); + } + + /** + * Notifies Intercom that a user provided a response to an attribute collector in your custom channel/platform. This allows Intercom to process the attribute and trigger any relevant workflow automations. + *
+ *

Note: This endpoint is currently under managed availability. Please reach out to your accounts team to discuss access and tailored, hands-on support.

+ *
+ */ + public CustomChannelNotificationResponse notifyAttributeCollected(NotifyAttributeCollectedRequest request) { + return this.rawClient.notifyAttributeCollected(request).body(); + } + + /** + * Notifies Intercom that a user provided a response to an attribute collector in your custom channel/platform. This allows Intercom to process the attribute and trigger any relevant workflow automations. + *
+ *

Note: This endpoint is currently under managed availability. Please reach out to your accounts team to discuss access and tailored, hands-on support.

+ *
+ */ + public CustomChannelNotificationResponse notifyAttributeCollected( + NotifyAttributeCollectedRequest request, RequestOptions requestOptions) { + return this.rawClient.notifyAttributeCollected(request, requestOptions).body(); + } +} diff --git a/src/main/java/com/intercom/api/resources/customchannelevents/RawCustomChannelEventsClient.java b/src/main/java/com/intercom/api/resources/customchannelevents/RawCustomChannelEventsClient.java new file mode 100644 index 00000000..bb45aa45 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/customchannelevents/RawCustomChannelEventsClient.java @@ -0,0 +1,342 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.customchannelevents; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.IntercomApiException; +import com.intercom.api.core.IntercomException; +import com.intercom.api.core.IntercomHttpResponse; +import com.intercom.api.core.MediaTypes; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.errors.BadRequestError; +import com.intercom.api.errors.NotFoundError; +import com.intercom.api.errors.UnauthorizedError; +import com.intercom.api.errors.UnprocessableEntityError; +import com.intercom.api.resources.customchannelevents.requests.NotifyAttributeCollectedRequest; +import com.intercom.api.resources.customchannelevents.requests.NotifyNewMessageRequest; +import com.intercom.api.resources.customchannelevents.requests.NotifyQuickReplySelectedRequest; +import com.intercom.api.types.CustomChannelBaseEvent; +import com.intercom.api.types.CustomChannelNotificationResponse; +import com.intercom.api.types.Error; +import java.io.IOException; +import okhttp3.Headers; +import okhttp3.HttpUrl; +import okhttp3.OkHttpClient; +import okhttp3.Request; +import okhttp3.RequestBody; +import okhttp3.Response; +import okhttp3.ResponseBody; + +public class RawCustomChannelEventsClient { + protected final ClientOptions clientOptions; + + public RawCustomChannelEventsClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + } + + /** + * Notifies Intercom that a new conversation was created in your custom channel/platform. This triggers conversation creation and workflow automations within Intercom for your custom channel integration. + *
+ *

Note: This endpoint is currently under managed availability. Please reach out to your accounts team to discuss access and tailored, hands-on support.

+ *
+ */ + public IntercomHttpResponse notifyNewConversation( + CustomChannelBaseEvent request) { + return notifyNewConversation(request, null); + } + + /** + * Notifies Intercom that a new conversation was created in your custom channel/platform. This triggers conversation creation and workflow automations within Intercom for your custom channel integration. + *
+ *

Note: This endpoint is currently under managed availability. Please reach out to your accounts team to discuss access and tailored, hands-on support.

+ *
+ */ + public IntercomHttpResponse notifyNewConversation( + CustomChannelBaseEvent request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("custom_channel_events/notify_new_conversation") + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue( + responseBodyString, CustomChannelNotificationResponse.class), + response); + } + try { + switch (response.code()) { + case 400: + throw new BadRequestError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 404: + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + case 422: + throw new UnprocessableEntityError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * Notifies Intercom that a new message was sent in a conversation on your custom channel/platform. This allows Intercom to process the message and trigger any relevant workflow automations. + *
+ *

Note: This endpoint is currently under managed availability. Please reach out to your accounts team to discuss access and tailored, hands-on support.

+ *
+ */ + public IntercomHttpResponse notifyNewMessage(NotifyNewMessageRequest request) { + return notifyNewMessage(request, null); + } + + /** + * Notifies Intercom that a new message was sent in a conversation on your custom channel/platform. This allows Intercom to process the message and trigger any relevant workflow automations. + *
+ *

Note: This endpoint is currently under managed availability. Please reach out to your accounts team to discuss access and tailored, hands-on support.

+ *
+ */ + public IntercomHttpResponse notifyNewMessage( + NotifyNewMessageRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("custom_channel_events/notify_new_message") + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue( + responseBodyString, CustomChannelNotificationResponse.class), + response); + } + try { + switch (response.code()) { + case 400: + throw new BadRequestError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 404: + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + case 422: + throw new UnprocessableEntityError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * Notifies Intercom that a user selected a quick reply option in your custom channel/platform. This allows Intercom to process the response and trigger any relevant workflow automations. + *
+ *

Note: This endpoint is currently under managed availability. Please reach out to your accounts team to discuss access and tailored, hands-on support.

+ *
+ */ + public IntercomHttpResponse notifyQuickReplySelected( + NotifyQuickReplySelectedRequest request) { + return notifyQuickReplySelected(request, null); + } + + /** + * Notifies Intercom that a user selected a quick reply option in your custom channel/platform. This allows Intercom to process the response and trigger any relevant workflow automations. + *
+ *

Note: This endpoint is currently under managed availability. Please reach out to your accounts team to discuss access and tailored, hands-on support.

+ *
+ */ + public IntercomHttpResponse notifyQuickReplySelected( + NotifyQuickReplySelectedRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("custom_channel_events/notify_quick_reply_selected") + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue( + responseBodyString, CustomChannelNotificationResponse.class), + response); + } + try { + switch (response.code()) { + case 400: + throw new BadRequestError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 404: + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + case 422: + throw new UnprocessableEntityError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * Notifies Intercom that a user provided a response to an attribute collector in your custom channel/platform. This allows Intercom to process the attribute and trigger any relevant workflow automations. + *
+ *

Note: This endpoint is currently under managed availability. Please reach out to your accounts team to discuss access and tailored, hands-on support.

+ *
+ */ + public IntercomHttpResponse notifyAttributeCollected( + NotifyAttributeCollectedRequest request) { + return notifyAttributeCollected(request, null); + } + + /** + * Notifies Intercom that a user provided a response to an attribute collector in your custom channel/platform. This allows Intercom to process the attribute and trigger any relevant workflow automations. + *
+ *

Note: This endpoint is currently under managed availability. Please reach out to your accounts team to discuss access and tailored, hands-on support.

+ *
+ */ + public IntercomHttpResponse notifyAttributeCollected( + NotifyAttributeCollectedRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("custom_channel_events/notify_attribute_collected") + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue( + responseBodyString, CustomChannelNotificationResponse.class), + response); + } + try { + switch (response.code()) { + case 400: + throw new BadRequestError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 404: + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + case 422: + throw new UnprocessableEntityError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/customchannelevents/requests/NotifyAttributeCollectedRequest.java b/src/main/java/com/intercom/api/resources/customchannelevents/requests/NotifyAttributeCollectedRequest.java new file mode 100644 index 00000000..2bb5b6ef --- /dev/null +++ b/src/main/java/com/intercom/api/resources/customchannelevents/requests/NotifyAttributeCollectedRequest.java @@ -0,0 +1,204 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.customchannelevents.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.types.CustomChannelAttribute; +import com.intercom.api.types.CustomChannelContact; +import com.intercom.api.types.ICustomChannelBaseEvent; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = NotifyAttributeCollectedRequest.Builder.class) +public final class NotifyAttributeCollectedRequest implements ICustomChannelBaseEvent { + private final String eventId; + + private final String externalConversationId; + + private final CustomChannelContact contact; + + private final CustomChannelAttribute attribute; + + private final Map additionalProperties; + + private NotifyAttributeCollectedRequest( + String eventId, + String externalConversationId, + CustomChannelContact contact, + CustomChannelAttribute attribute, + Map additionalProperties) { + this.eventId = eventId; + this.externalConversationId = externalConversationId; + this.contact = contact; + this.attribute = attribute; + this.additionalProperties = additionalProperties; + } + + /** + * @return Unique identifier for the event. + */ + @JsonProperty("event_id") + public String getEventId() { + return eventId; + } + + /** + * @return Identifier for the conversation in your application. + */ + @JsonProperty("external_conversation_id") + public String getExternalConversationId() { + return externalConversationId; + } + + @JsonProperty("contact") + public CustomChannelContact getContact() { + return contact; + } + + @JsonProperty("attribute") + public CustomChannelAttribute getAttribute() { + return attribute; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof NotifyAttributeCollectedRequest && equalTo((NotifyAttributeCollectedRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(NotifyAttributeCollectedRequest other) { + return eventId.equals(other.eventId) + && externalConversationId.equals(other.externalConversationId) + && contact.equals(other.contact) + && attribute.equals(other.attribute); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.eventId, this.externalConversationId, this.contact, this.attribute); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static EventIdStage builder() { + return new Builder(); + } + + public interface EventIdStage { + /** + *

Unique identifier for the event.

+ */ + ExternalConversationIdStage eventId(@NotNull String eventId); + + Builder from(NotifyAttributeCollectedRequest other); + } + + public interface ExternalConversationIdStage { + /** + *

Identifier for the conversation in your application.

+ */ + ContactStage externalConversationId(@NotNull String externalConversationId); + } + + public interface ContactStage { + AttributeStage contact(@NotNull CustomChannelContact contact); + } + + public interface AttributeStage { + _FinalStage attribute(@NotNull CustomChannelAttribute attribute); + } + + public interface _FinalStage { + NotifyAttributeCollectedRequest build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder + implements EventIdStage, ExternalConversationIdStage, ContactStage, AttributeStage, _FinalStage { + private String eventId; + + private String externalConversationId; + + private CustomChannelContact contact; + + private CustomChannelAttribute attribute; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(NotifyAttributeCollectedRequest other) { + eventId(other.getEventId()); + externalConversationId(other.getExternalConversationId()); + contact(other.getContact()); + attribute(other.getAttribute()); + return this; + } + + /** + *

Unique identifier for the event.

+ *

Unique identifier for the event.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("event_id") + public ExternalConversationIdStage eventId(@NotNull String eventId) { + this.eventId = Objects.requireNonNull(eventId, "eventId must not be null"); + return this; + } + + /** + *

Identifier for the conversation in your application.

+ *

Identifier for the conversation in your application.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("external_conversation_id") + public ContactStage externalConversationId(@NotNull String externalConversationId) { + this.externalConversationId = + Objects.requireNonNull(externalConversationId, "externalConversationId must not be null"); + return this; + } + + @java.lang.Override + @JsonSetter("contact") + public AttributeStage contact(@NotNull CustomChannelContact contact) { + this.contact = Objects.requireNonNull(contact, "contact must not be null"); + return this; + } + + @java.lang.Override + @JsonSetter("attribute") + public _FinalStage attribute(@NotNull CustomChannelAttribute attribute) { + this.attribute = Objects.requireNonNull(attribute, "attribute must not be null"); + return this; + } + + @java.lang.Override + public NotifyAttributeCollectedRequest build() { + return new NotifyAttributeCollectedRequest( + eventId, externalConversationId, contact, attribute, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/customchannelevents/requests/NotifyNewMessageRequest.java b/src/main/java/com/intercom/api/resources/customchannelevents/requests/NotifyNewMessageRequest.java new file mode 100644 index 00000000..33bfa564 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/customchannelevents/requests/NotifyNewMessageRequest.java @@ -0,0 +1,213 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.customchannelevents.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.types.CustomChannelContact; +import com.intercom.api.types.ICustomChannelBaseEvent; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = NotifyNewMessageRequest.Builder.class) +public final class NotifyNewMessageRequest implements ICustomChannelBaseEvent { + private final String eventId; + + private final String externalConversationId; + + private final CustomChannelContact contact; + + private final String body; + + private final Map additionalProperties; + + private NotifyNewMessageRequest( + String eventId, + String externalConversationId, + CustomChannelContact contact, + String body, + Map additionalProperties) { + this.eventId = eventId; + this.externalConversationId = externalConversationId; + this.contact = contact; + this.body = body; + this.additionalProperties = additionalProperties; + } + + /** + * @return Unique identifier for the event. + */ + @JsonProperty("event_id") + public String getEventId() { + return eventId; + } + + /** + * @return Identifier for the conversation in your application. + */ + @JsonProperty("external_conversation_id") + public String getExternalConversationId() { + return externalConversationId; + } + + @JsonProperty("contact") + public CustomChannelContact getContact() { + return contact; + } + + /** + * @return The message content sent by the user. + */ + @JsonProperty("body") + public String getBody() { + return body; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof NotifyNewMessageRequest && equalTo((NotifyNewMessageRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(NotifyNewMessageRequest other) { + return eventId.equals(other.eventId) + && externalConversationId.equals(other.externalConversationId) + && contact.equals(other.contact) + && body.equals(other.body); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.eventId, this.externalConversationId, this.contact, this.body); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static EventIdStage builder() { + return new Builder(); + } + + public interface EventIdStage { + /** + *

Unique identifier for the event.

+ */ + ExternalConversationIdStage eventId(@NotNull String eventId); + + Builder from(NotifyNewMessageRequest other); + } + + public interface ExternalConversationIdStage { + /** + *

Identifier for the conversation in your application.

+ */ + ContactStage externalConversationId(@NotNull String externalConversationId); + } + + public interface ContactStage { + BodyStage contact(@NotNull CustomChannelContact contact); + } + + public interface BodyStage { + /** + *

The message content sent by the user.

+ */ + _FinalStage body(@NotNull String body); + } + + public interface _FinalStage { + NotifyNewMessageRequest build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder + implements EventIdStage, ExternalConversationIdStage, ContactStage, BodyStage, _FinalStage { + private String eventId; + + private String externalConversationId; + + private CustomChannelContact contact; + + private String body; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(NotifyNewMessageRequest other) { + eventId(other.getEventId()); + externalConversationId(other.getExternalConversationId()); + contact(other.getContact()); + body(other.getBody()); + return this; + } + + /** + *

Unique identifier for the event.

+ *

Unique identifier for the event.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("event_id") + public ExternalConversationIdStage eventId(@NotNull String eventId) { + this.eventId = Objects.requireNonNull(eventId, "eventId must not be null"); + return this; + } + + /** + *

Identifier for the conversation in your application.

+ *

Identifier for the conversation in your application.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("external_conversation_id") + public ContactStage externalConversationId(@NotNull String externalConversationId) { + this.externalConversationId = + Objects.requireNonNull(externalConversationId, "externalConversationId must not be null"); + return this; + } + + @java.lang.Override + @JsonSetter("contact") + public BodyStage contact(@NotNull CustomChannelContact contact) { + this.contact = Objects.requireNonNull(contact, "contact must not be null"); + return this; + } + + /** + *

The message content sent by the user.

+ *

The message content sent by the user.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("body") + public _FinalStage body(@NotNull String body) { + this.body = Objects.requireNonNull(body, "body must not be null"); + return this; + } + + @java.lang.Override + public NotifyNewMessageRequest build() { + return new NotifyNewMessageRequest(eventId, externalConversationId, contact, body, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/customchannelevents/requests/NotifyQuickReplySelectedRequest.java b/src/main/java/com/intercom/api/resources/customchannelevents/requests/NotifyQuickReplySelectedRequest.java new file mode 100644 index 00000000..637e648d --- /dev/null +++ b/src/main/java/com/intercom/api/resources/customchannelevents/requests/NotifyQuickReplySelectedRequest.java @@ -0,0 +1,214 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.customchannelevents.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.types.CustomChannelContact; +import com.intercom.api.types.ICustomChannelBaseEvent; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = NotifyQuickReplySelectedRequest.Builder.class) +public final class NotifyQuickReplySelectedRequest implements ICustomChannelBaseEvent { + private final String eventId; + + private final String externalConversationId; + + private final CustomChannelContact contact; + + private final String quickReplyOptionId; + + private final Map additionalProperties; + + private NotifyQuickReplySelectedRequest( + String eventId, + String externalConversationId, + CustomChannelContact contact, + String quickReplyOptionId, + Map additionalProperties) { + this.eventId = eventId; + this.externalConversationId = externalConversationId; + this.contact = contact; + this.quickReplyOptionId = quickReplyOptionId; + this.additionalProperties = additionalProperties; + } + + /** + * @return Unique identifier for the event. + */ + @JsonProperty("event_id") + public String getEventId() { + return eventId; + } + + /** + * @return Identifier for the conversation in your application. + */ + @JsonProperty("external_conversation_id") + public String getExternalConversationId() { + return externalConversationId; + } + + @JsonProperty("contact") + public CustomChannelContact getContact() { + return contact; + } + + /** + * @return Id of the selected quick reply option. + */ + @JsonProperty("quick_reply_option_id") + public String getQuickReplyOptionId() { + return quickReplyOptionId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof NotifyQuickReplySelectedRequest && equalTo((NotifyQuickReplySelectedRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(NotifyQuickReplySelectedRequest other) { + return eventId.equals(other.eventId) + && externalConversationId.equals(other.externalConversationId) + && contact.equals(other.contact) + && quickReplyOptionId.equals(other.quickReplyOptionId); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.eventId, this.externalConversationId, this.contact, this.quickReplyOptionId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static EventIdStage builder() { + return new Builder(); + } + + public interface EventIdStage { + /** + *

Unique identifier for the event.

+ */ + ExternalConversationIdStage eventId(@NotNull String eventId); + + Builder from(NotifyQuickReplySelectedRequest other); + } + + public interface ExternalConversationIdStage { + /** + *

Identifier for the conversation in your application.

+ */ + ContactStage externalConversationId(@NotNull String externalConversationId); + } + + public interface ContactStage { + QuickReplyOptionIdStage contact(@NotNull CustomChannelContact contact); + } + + public interface QuickReplyOptionIdStage { + /** + *

Id of the selected quick reply option.

+ */ + _FinalStage quickReplyOptionId(@NotNull String quickReplyOptionId); + } + + public interface _FinalStage { + NotifyQuickReplySelectedRequest build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder + implements EventIdStage, ExternalConversationIdStage, ContactStage, QuickReplyOptionIdStage, _FinalStage { + private String eventId; + + private String externalConversationId; + + private CustomChannelContact contact; + + private String quickReplyOptionId; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(NotifyQuickReplySelectedRequest other) { + eventId(other.getEventId()); + externalConversationId(other.getExternalConversationId()); + contact(other.getContact()); + quickReplyOptionId(other.getQuickReplyOptionId()); + return this; + } + + /** + *

Unique identifier for the event.

+ *

Unique identifier for the event.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("event_id") + public ExternalConversationIdStage eventId(@NotNull String eventId) { + this.eventId = Objects.requireNonNull(eventId, "eventId must not be null"); + return this; + } + + /** + *

Identifier for the conversation in your application.

+ *

Identifier for the conversation in your application.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("external_conversation_id") + public ContactStage externalConversationId(@NotNull String externalConversationId) { + this.externalConversationId = + Objects.requireNonNull(externalConversationId, "externalConversationId must not be null"); + return this; + } + + @java.lang.Override + @JsonSetter("contact") + public QuickReplyOptionIdStage contact(@NotNull CustomChannelContact contact) { + this.contact = Objects.requireNonNull(contact, "contact must not be null"); + return this; + } + + /** + *

Id of the selected quick reply option.

+ *

Id of the selected quick reply option.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("quick_reply_option_id") + public _FinalStage quickReplyOptionId(@NotNull String quickReplyOptionId) { + this.quickReplyOptionId = Objects.requireNonNull(quickReplyOptionId, "quickReplyOptionId must not be null"); + return this; + } + + @java.lang.Override + public NotifyQuickReplySelectedRequest build() { + return new NotifyQuickReplySelectedRequest( + eventId, externalConversationId, contact, quickReplyOptionId, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/customobjectinstances/AsyncCustomObjectInstancesClient.java b/src/main/java/com/intercom/api/resources/customobjectinstances/AsyncCustomObjectInstancesClient.java new file mode 100644 index 00000000..240bd257 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/customobjectinstances/AsyncCustomObjectInstancesClient.java @@ -0,0 +1,124 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.customobjectinstances; + +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.resources.customobjectinstances.requests.CreateOrUpdateCustomObjectInstanceRequest; +import com.intercom.api.resources.customobjectinstances.requests.DeleteCustomObjectInstancesByExternalIdRequest; +import com.intercom.api.resources.customobjectinstances.requests.DeleteCustomObjectInstancesByIdRequest; +import com.intercom.api.resources.customobjectinstances.requests.GetCustomObjectInstancesByExternalIdRequest; +import com.intercom.api.resources.customobjectinstances.requests.GetCustomObjectInstancesByIdRequest; +import com.intercom.api.resources.customobjectinstances.types.CustomObjectInstance; +import com.intercom.api.types.CustomObjectInstanceDeleted; +import java.util.Optional; +import java.util.concurrent.CompletableFuture; + +public class AsyncCustomObjectInstancesClient { + protected final ClientOptions clientOptions; + + private final AsyncRawCustomObjectInstancesClient rawClient; + + public AsyncCustomObjectInstancesClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + this.rawClient = new AsyncRawCustomObjectInstancesClient(clientOptions); + } + + /** + * Get responses with HTTP metadata like headers + */ + public AsyncRawCustomObjectInstancesClient withRawResponse() { + return this.rawClient; + } + + /** + * Fetch a Custom Object Instance by external_id. + */ + public CompletableFuture> getCustomObjectInstancesByExternalId( + GetCustomObjectInstancesByExternalIdRequest request) { + return this.rawClient.getCustomObjectInstancesByExternalId(request).thenApply(response -> response.body()); + } + + /** + * Fetch a Custom Object Instance by external_id. + */ + public CompletableFuture> getCustomObjectInstancesByExternalId( + GetCustomObjectInstancesByExternalIdRequest request, RequestOptions requestOptions) { + return this.rawClient + .getCustomObjectInstancesByExternalId(request, requestOptions) + .thenApply(response -> response.body()); + } + + /** + * Create or update a custom object instance + */ + public CompletableFuture> createCustomObjectInstances( + CreateOrUpdateCustomObjectInstanceRequest request) { + return this.rawClient.createCustomObjectInstances(request).thenApply(response -> response.body()); + } + + /** + * Create or update a custom object instance + */ + public CompletableFuture> createCustomObjectInstances( + CreateOrUpdateCustomObjectInstanceRequest request, RequestOptions requestOptions) { + return this.rawClient + .createCustomObjectInstances(request, requestOptions) + .thenApply(response -> response.body()); + } + + /** + * Delete a single Custom Object instance by external_id. + */ + public CompletableFuture deleteCustomObjectInstancesById( + DeleteCustomObjectInstancesByIdRequest request) { + return this.rawClient.deleteCustomObjectInstancesById(request).thenApply(response -> response.body()); + } + + /** + * Delete a single Custom Object instance by external_id. + */ + public CompletableFuture deleteCustomObjectInstancesById( + DeleteCustomObjectInstancesByIdRequest request, RequestOptions requestOptions) { + return this.rawClient + .deleteCustomObjectInstancesById(request, requestOptions) + .thenApply(response -> response.body()); + } + + /** + * Fetch a Custom Object Instance by id. + */ + public CompletableFuture> getCustomObjectInstancesById( + GetCustomObjectInstancesByIdRequest request) { + return this.rawClient.getCustomObjectInstancesById(request).thenApply(response -> response.body()); + } + + /** + * Fetch a Custom Object Instance by id. + */ + public CompletableFuture> getCustomObjectInstancesById( + GetCustomObjectInstancesByIdRequest request, RequestOptions requestOptions) { + return this.rawClient + .getCustomObjectInstancesById(request, requestOptions) + .thenApply(response -> response.body()); + } + + /** + * Delete a single Custom Object instance using the Intercom defined id. + */ + public CompletableFuture deleteCustomObjectInstancesByExternalId( + DeleteCustomObjectInstancesByExternalIdRequest request) { + return this.rawClient.deleteCustomObjectInstancesByExternalId(request).thenApply(response -> response.body()); + } + + /** + * Delete a single Custom Object instance using the Intercom defined id. + */ + public CompletableFuture deleteCustomObjectInstancesByExternalId( + DeleteCustomObjectInstancesByExternalIdRequest request, RequestOptions requestOptions) { + return this.rawClient + .deleteCustomObjectInstancesByExternalId(request, requestOptions) + .thenApply(response -> response.body()); + } +} diff --git a/src/main/java/com/intercom/api/resources/customobjectinstances/AsyncRawCustomObjectInstancesClient.java b/src/main/java/com/intercom/api/resources/customobjectinstances/AsyncRawCustomObjectInstancesClient.java new file mode 100644 index 00000000..67adb896 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/customobjectinstances/AsyncRawCustomObjectInstancesClient.java @@ -0,0 +1,426 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.customobjectinstances; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.fasterxml.jackson.core.type.TypeReference; +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.IntercomApiException; +import com.intercom.api.core.IntercomException; +import com.intercom.api.core.IntercomHttpResponse; +import com.intercom.api.core.MediaTypes; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.core.QueryStringMapper; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.errors.NotFoundError; +import com.intercom.api.errors.UnauthorizedError; +import com.intercom.api.resources.customobjectinstances.requests.CreateOrUpdateCustomObjectInstanceRequest; +import com.intercom.api.resources.customobjectinstances.requests.DeleteCustomObjectInstancesByExternalIdRequest; +import com.intercom.api.resources.customobjectinstances.requests.DeleteCustomObjectInstancesByIdRequest; +import com.intercom.api.resources.customobjectinstances.requests.GetCustomObjectInstancesByExternalIdRequest; +import com.intercom.api.resources.customobjectinstances.requests.GetCustomObjectInstancesByIdRequest; +import com.intercom.api.resources.customobjectinstances.types.CustomObjectInstance; +import com.intercom.api.types.CustomObjectInstanceDeleted; +import com.intercom.api.types.Error; +import java.io.IOException; +import java.util.Optional; +import java.util.concurrent.CompletableFuture; +import okhttp3.Call; +import okhttp3.Callback; +import okhttp3.Headers; +import okhttp3.HttpUrl; +import okhttp3.OkHttpClient; +import okhttp3.Request; +import okhttp3.RequestBody; +import okhttp3.Response; +import okhttp3.ResponseBody; +import org.jetbrains.annotations.NotNull; + +public class AsyncRawCustomObjectInstancesClient { + protected final ClientOptions clientOptions; + + public AsyncRawCustomObjectInstancesClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + } + + /** + * Fetch a Custom Object Instance by external_id. + */ + public CompletableFuture>> getCustomObjectInstancesByExternalId( + GetCustomObjectInstancesByExternalIdRequest request) { + return getCustomObjectInstancesByExternalId(request, null); + } + + /** + * Fetch a Custom Object Instance by external_id. + */ + public CompletableFuture>> getCustomObjectInstancesByExternalId( + GetCustomObjectInstancesByExternalIdRequest request, RequestOptions requestOptions) { + HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("custom_object_instances") + .addPathSegment(request.getCustomObjectTypeIdentifier()); + QueryStringMapper.addQueryParameter(httpUrl, "external_id", request.getExternalId(), false); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl.build()) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture>> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue( + responseBodyString, new TypeReference>() {}), + response)); + return; + } + try { + switch (response.code()) { + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 404: + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * Create or update a custom object instance + */ + public CompletableFuture>> createCustomObjectInstances( + CreateOrUpdateCustomObjectInstanceRequest request) { + return createCustomObjectInstances(request, null); + } + + /** + * Create or update a custom object instance + */ + public CompletableFuture>> createCustomObjectInstances( + CreateOrUpdateCustomObjectInstanceRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("custom_object_instances") + .addPathSegment(request.getCustomObjectTypeIdentifier()) + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture>> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue( + responseBodyString, new TypeReference>() {}), + response)); + return; + } + try { + switch (response.code()) { + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 404: + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * Delete a single Custom Object instance by external_id. + */ + public CompletableFuture> deleteCustomObjectInstancesById( + DeleteCustomObjectInstancesByIdRequest request) { + return deleteCustomObjectInstancesById(request, null); + } + + /** + * Delete a single Custom Object instance by external_id. + */ + public CompletableFuture> deleteCustomObjectInstancesById( + DeleteCustomObjectInstancesByIdRequest request, RequestOptions requestOptions) { + HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("custom_object_instances") + .addPathSegment(request.getCustomObjectTypeIdentifier()); + QueryStringMapper.addQueryParameter(httpUrl, "external_id", request.getExternalId(), false); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl.build()) + .method("DELETE", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue( + responseBodyString, CustomObjectInstanceDeleted.class), + response)); + return; + } + try { + switch (response.code()) { + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 404: + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * Fetch a Custom Object Instance by id. + */ + public CompletableFuture>> getCustomObjectInstancesById( + GetCustomObjectInstancesByIdRequest request) { + return getCustomObjectInstancesById(request, null); + } + + /** + * Fetch a Custom Object Instance by id. + */ + public CompletableFuture>> getCustomObjectInstancesById( + GetCustomObjectInstancesByIdRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("custom_object_instances") + .addPathSegment(request.getCustomObjectTypeIdentifier()) + .addPathSegment(request.getCustomObjectInstanceId()) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture>> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue( + responseBodyString, new TypeReference>() {}), + response)); + return; + } + try { + switch (response.code()) { + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 404: + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * Delete a single Custom Object instance using the Intercom defined id. + */ + public CompletableFuture> deleteCustomObjectInstancesByExternalId( + DeleteCustomObjectInstancesByExternalIdRequest request) { + return deleteCustomObjectInstancesByExternalId(request, null); + } + + /** + * Delete a single Custom Object instance using the Intercom defined id. + */ + public CompletableFuture> deleteCustomObjectInstancesByExternalId( + DeleteCustomObjectInstancesByExternalIdRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("custom_object_instances") + .addPathSegment(request.getCustomObjectTypeIdentifier()) + .addPathSegment(request.getCustomObjectInstanceId()) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("DELETE", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue( + responseBodyString, CustomObjectInstanceDeleted.class), + response)); + return; + } + try { + switch (response.code()) { + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 404: + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } +} diff --git a/src/main/java/com/intercom/api/resources/customobjectinstances/CustomObjectInstancesClient.java b/src/main/java/com/intercom/api/resources/customobjectinstances/CustomObjectInstancesClient.java new file mode 100644 index 00000000..b7f77dbe --- /dev/null +++ b/src/main/java/com/intercom/api/resources/customobjectinstances/CustomObjectInstancesClient.java @@ -0,0 +1,121 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.customobjectinstances; + +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.resources.customobjectinstances.requests.CreateOrUpdateCustomObjectInstanceRequest; +import com.intercom.api.resources.customobjectinstances.requests.DeleteCustomObjectInstancesByExternalIdRequest; +import com.intercom.api.resources.customobjectinstances.requests.DeleteCustomObjectInstancesByIdRequest; +import com.intercom.api.resources.customobjectinstances.requests.GetCustomObjectInstancesByExternalIdRequest; +import com.intercom.api.resources.customobjectinstances.requests.GetCustomObjectInstancesByIdRequest; +import com.intercom.api.resources.customobjectinstances.types.CustomObjectInstance; +import com.intercom.api.types.CustomObjectInstanceDeleted; +import java.util.Optional; + +public class CustomObjectInstancesClient { + protected final ClientOptions clientOptions; + + private final RawCustomObjectInstancesClient rawClient; + + public CustomObjectInstancesClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + this.rawClient = new RawCustomObjectInstancesClient(clientOptions); + } + + /** + * Get responses with HTTP metadata like headers + */ + public RawCustomObjectInstancesClient withRawResponse() { + return this.rawClient; + } + + /** + * Fetch a Custom Object Instance by external_id. + */ + public Optional getCustomObjectInstancesByExternalId( + GetCustomObjectInstancesByExternalIdRequest request) { + return this.rawClient.getCustomObjectInstancesByExternalId(request).body(); + } + + /** + * Fetch a Custom Object Instance by external_id. + */ + public Optional getCustomObjectInstancesByExternalId( + GetCustomObjectInstancesByExternalIdRequest request, RequestOptions requestOptions) { + return this.rawClient + .getCustomObjectInstancesByExternalId(request, requestOptions) + .body(); + } + + /** + * Create or update a custom object instance + */ + public Optional createCustomObjectInstances( + CreateOrUpdateCustomObjectInstanceRequest request) { + return this.rawClient.createCustomObjectInstances(request).body(); + } + + /** + * Create or update a custom object instance + */ + public Optional createCustomObjectInstances( + CreateOrUpdateCustomObjectInstanceRequest request, RequestOptions requestOptions) { + return this.rawClient + .createCustomObjectInstances(request, requestOptions) + .body(); + } + + /** + * Delete a single Custom Object instance by external_id. + */ + public CustomObjectInstanceDeleted deleteCustomObjectInstancesById(DeleteCustomObjectInstancesByIdRequest request) { + return this.rawClient.deleteCustomObjectInstancesById(request).body(); + } + + /** + * Delete a single Custom Object instance by external_id. + */ + public CustomObjectInstanceDeleted deleteCustomObjectInstancesById( + DeleteCustomObjectInstancesByIdRequest request, RequestOptions requestOptions) { + return this.rawClient + .deleteCustomObjectInstancesById(request, requestOptions) + .body(); + } + + /** + * Fetch a Custom Object Instance by id. + */ + public Optional getCustomObjectInstancesById(GetCustomObjectInstancesByIdRequest request) { + return this.rawClient.getCustomObjectInstancesById(request).body(); + } + + /** + * Fetch a Custom Object Instance by id. + */ + public Optional getCustomObjectInstancesById( + GetCustomObjectInstancesByIdRequest request, RequestOptions requestOptions) { + return this.rawClient + .getCustomObjectInstancesById(request, requestOptions) + .body(); + } + + /** + * Delete a single Custom Object instance using the Intercom defined id. + */ + public CustomObjectInstanceDeleted deleteCustomObjectInstancesByExternalId( + DeleteCustomObjectInstancesByExternalIdRequest request) { + return this.rawClient.deleteCustomObjectInstancesByExternalId(request).body(); + } + + /** + * Delete a single Custom Object instance using the Intercom defined id. + */ + public CustomObjectInstanceDeleted deleteCustomObjectInstancesByExternalId( + DeleteCustomObjectInstancesByExternalIdRequest request, RequestOptions requestOptions) { + return this.rawClient + .deleteCustomObjectInstancesByExternalId(request, requestOptions) + .body(); + } +} diff --git a/src/main/java/com/intercom/api/resources/customobjectinstances/RawCustomObjectInstancesClient.java b/src/main/java/com/intercom/api/resources/customobjectinstances/RawCustomObjectInstancesClient.java new file mode 100644 index 00000000..c384c5c7 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/customobjectinstances/RawCustomObjectInstancesClient.java @@ -0,0 +1,335 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.customobjectinstances; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.fasterxml.jackson.core.type.TypeReference; +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.IntercomApiException; +import com.intercom.api.core.IntercomException; +import com.intercom.api.core.IntercomHttpResponse; +import com.intercom.api.core.MediaTypes; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.core.QueryStringMapper; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.errors.NotFoundError; +import com.intercom.api.errors.UnauthorizedError; +import com.intercom.api.resources.customobjectinstances.requests.CreateOrUpdateCustomObjectInstanceRequest; +import com.intercom.api.resources.customobjectinstances.requests.DeleteCustomObjectInstancesByExternalIdRequest; +import com.intercom.api.resources.customobjectinstances.requests.DeleteCustomObjectInstancesByIdRequest; +import com.intercom.api.resources.customobjectinstances.requests.GetCustomObjectInstancesByExternalIdRequest; +import com.intercom.api.resources.customobjectinstances.requests.GetCustomObjectInstancesByIdRequest; +import com.intercom.api.resources.customobjectinstances.types.CustomObjectInstance; +import com.intercom.api.types.CustomObjectInstanceDeleted; +import com.intercom.api.types.Error; +import java.io.IOException; +import java.util.Optional; +import okhttp3.Headers; +import okhttp3.HttpUrl; +import okhttp3.OkHttpClient; +import okhttp3.Request; +import okhttp3.RequestBody; +import okhttp3.Response; +import okhttp3.ResponseBody; + +public class RawCustomObjectInstancesClient { + protected final ClientOptions clientOptions; + + public RawCustomObjectInstancesClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + } + + /** + * Fetch a Custom Object Instance by external_id. + */ + public IntercomHttpResponse> getCustomObjectInstancesByExternalId( + GetCustomObjectInstancesByExternalIdRequest request) { + return getCustomObjectInstancesByExternalId(request, null); + } + + /** + * Fetch a Custom Object Instance by external_id. + */ + public IntercomHttpResponse> getCustomObjectInstancesByExternalId( + GetCustomObjectInstancesByExternalIdRequest request, RequestOptions requestOptions) { + HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("custom_object_instances") + .addPathSegment(request.getCustomObjectTypeIdentifier()); + QueryStringMapper.addQueryParameter(httpUrl, "external_id", request.getExternalId(), false); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl.build()) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue( + responseBodyString, new TypeReference>() {}), + response); + } + try { + switch (response.code()) { + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 404: + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * Create or update a custom object instance + */ + public IntercomHttpResponse> createCustomObjectInstances( + CreateOrUpdateCustomObjectInstanceRequest request) { + return createCustomObjectInstances(request, null); + } + + /** + * Create or update a custom object instance + */ + public IntercomHttpResponse> createCustomObjectInstances( + CreateOrUpdateCustomObjectInstanceRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("custom_object_instances") + .addPathSegment(request.getCustomObjectTypeIdentifier()) + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue( + responseBodyString, new TypeReference>() {}), + response); + } + try { + switch (response.code()) { + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 404: + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * Delete a single Custom Object instance by external_id. + */ + public IntercomHttpResponse deleteCustomObjectInstancesById( + DeleteCustomObjectInstancesByIdRequest request) { + return deleteCustomObjectInstancesById(request, null); + } + + /** + * Delete a single Custom Object instance by external_id. + */ + public IntercomHttpResponse deleteCustomObjectInstancesById( + DeleteCustomObjectInstancesByIdRequest request, RequestOptions requestOptions) { + HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("custom_object_instances") + .addPathSegment(request.getCustomObjectTypeIdentifier()); + QueryStringMapper.addQueryParameter(httpUrl, "external_id", request.getExternalId(), false); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl.build()) + .method("DELETE", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, CustomObjectInstanceDeleted.class), + response); + } + try { + switch (response.code()) { + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 404: + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * Fetch a Custom Object Instance by id. + */ + public IntercomHttpResponse> getCustomObjectInstancesById( + GetCustomObjectInstancesByIdRequest request) { + return getCustomObjectInstancesById(request, null); + } + + /** + * Fetch a Custom Object Instance by id. + */ + public IntercomHttpResponse> getCustomObjectInstancesById( + GetCustomObjectInstancesByIdRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("custom_object_instances") + .addPathSegment(request.getCustomObjectTypeIdentifier()) + .addPathSegment(request.getCustomObjectInstanceId()) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue( + responseBodyString, new TypeReference>() {}), + response); + } + try { + switch (response.code()) { + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 404: + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * Delete a single Custom Object instance using the Intercom defined id. + */ + public IntercomHttpResponse deleteCustomObjectInstancesByExternalId( + DeleteCustomObjectInstancesByExternalIdRequest request) { + return deleteCustomObjectInstancesByExternalId(request, null); + } + + /** + * Delete a single Custom Object instance using the Intercom defined id. + */ + public IntercomHttpResponse deleteCustomObjectInstancesByExternalId( + DeleteCustomObjectInstancesByExternalIdRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("custom_object_instances") + .addPathSegment(request.getCustomObjectTypeIdentifier()) + .addPathSegment(request.getCustomObjectInstanceId()) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("DELETE", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, CustomObjectInstanceDeleted.class), + response); + } + try { + switch (response.code()) { + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 404: + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/customobjectinstances/requests/CreateOrUpdateCustomObjectInstanceRequest.java b/src/main/java/com/intercom/api/resources/customobjectinstances/requests/CreateOrUpdateCustomObjectInstanceRequest.java new file mode 100644 index 00000000..340018bd --- /dev/null +++ b/src/main/java/com/intercom/api/resources/customobjectinstances/requests/CreateOrUpdateCustomObjectInstanceRequest.java @@ -0,0 +1,302 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.customobjectinstances.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = CreateOrUpdateCustomObjectInstanceRequest.Builder.class) +public final class CreateOrUpdateCustomObjectInstanceRequest { + private final String customObjectTypeIdentifier; + + private final Optional externalId; + + private final Optional externalCreatedAt; + + private final Optional externalUpdatedAt; + + private final Optional>> customAttributes; + + private final Map additionalProperties; + + private CreateOrUpdateCustomObjectInstanceRequest( + String customObjectTypeIdentifier, + Optional externalId, + Optional externalCreatedAt, + Optional externalUpdatedAt, + Optional>> customAttributes, + Map additionalProperties) { + this.customObjectTypeIdentifier = customObjectTypeIdentifier; + this.externalId = externalId; + this.externalCreatedAt = externalCreatedAt; + this.externalUpdatedAt = externalUpdatedAt; + this.customAttributes = customAttributes; + this.additionalProperties = additionalProperties; + } + + /** + * @return The unique identifier of the custom object type that defines the structure of the custom object instance. + */ + @JsonProperty("custom_object_type_identifier") + public String getCustomObjectTypeIdentifier() { + return customObjectTypeIdentifier; + } + + /** + * @return A unique identifier for the Custom Object instance in the external system it originated from. + */ + @JsonProperty("external_id") + public Optional getExternalId() { + return externalId; + } + + /** + * @return The time when the Custom Object instance was created in the external system it originated from. + */ + @JsonProperty("external_created_at") + public Optional getExternalCreatedAt() { + return externalCreatedAt; + } + + /** + * @return The time when the Custom Object instance was last updated in the external system it originated from. + */ + @JsonProperty("external_updated_at") + public Optional getExternalUpdatedAt() { + return externalUpdatedAt; + } + + /** + * @return The custom attributes which are set for the Custom Object instance. + */ + @JsonProperty("custom_attributes") + public Optional>> getCustomAttributes() { + return customAttributes; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof CreateOrUpdateCustomObjectInstanceRequest + && equalTo((CreateOrUpdateCustomObjectInstanceRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(CreateOrUpdateCustomObjectInstanceRequest other) { + return customObjectTypeIdentifier.equals(other.customObjectTypeIdentifier) + && externalId.equals(other.externalId) + && externalCreatedAt.equals(other.externalCreatedAt) + && externalUpdatedAt.equals(other.externalUpdatedAt) + && customAttributes.equals(other.customAttributes); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash( + this.customObjectTypeIdentifier, + this.externalId, + this.externalCreatedAt, + this.externalUpdatedAt, + this.customAttributes); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static CustomObjectTypeIdentifierStage builder() { + return new Builder(); + } + + public interface CustomObjectTypeIdentifierStage { + /** + *

The unique identifier of the custom object type that defines the structure of the custom object instance.

+ */ + _FinalStage customObjectTypeIdentifier(@NotNull String customObjectTypeIdentifier); + + Builder from(CreateOrUpdateCustomObjectInstanceRequest other); + } + + public interface _FinalStage { + CreateOrUpdateCustomObjectInstanceRequest build(); + + /** + *

A unique identifier for the Custom Object instance in the external system it originated from.

+ */ + _FinalStage externalId(Optional externalId); + + _FinalStage externalId(String externalId); + + /** + *

The time when the Custom Object instance was created in the external system it originated from.

+ */ + _FinalStage externalCreatedAt(Optional externalCreatedAt); + + _FinalStage externalCreatedAt(Integer externalCreatedAt); + + /** + *

The time when the Custom Object instance was last updated in the external system it originated from.

+ */ + _FinalStage externalUpdatedAt(Optional externalUpdatedAt); + + _FinalStage externalUpdatedAt(Integer externalUpdatedAt); + + /** + *

The custom attributes which are set for the Custom Object instance.

+ */ + _FinalStage customAttributes(Optional>> customAttributes); + + _FinalStage customAttributes(Map> customAttributes); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements CustomObjectTypeIdentifierStage, _FinalStage { + private String customObjectTypeIdentifier; + + private Optional>> customAttributes = Optional.empty(); + + private Optional externalUpdatedAt = Optional.empty(); + + private Optional externalCreatedAt = Optional.empty(); + + private Optional externalId = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(CreateOrUpdateCustomObjectInstanceRequest other) { + customObjectTypeIdentifier(other.getCustomObjectTypeIdentifier()); + externalId(other.getExternalId()); + externalCreatedAt(other.getExternalCreatedAt()); + externalUpdatedAt(other.getExternalUpdatedAt()); + customAttributes(other.getCustomAttributes()); + return this; + } + + /** + *

The unique identifier of the custom object type that defines the structure of the custom object instance.

+ *

The unique identifier of the custom object type that defines the structure of the custom object instance.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("custom_object_type_identifier") + public _FinalStage customObjectTypeIdentifier(@NotNull String customObjectTypeIdentifier) { + this.customObjectTypeIdentifier = + Objects.requireNonNull(customObjectTypeIdentifier, "customObjectTypeIdentifier must not be null"); + return this; + } + + /** + *

The custom attributes which are set for the Custom Object instance.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage customAttributes(Map> customAttributes) { + this.customAttributes = Optional.ofNullable(customAttributes); + return this; + } + + /** + *

The custom attributes which are set for the Custom Object instance.

+ */ + @java.lang.Override + @JsonSetter(value = "custom_attributes", nulls = Nulls.SKIP) + public _FinalStage customAttributes(Optional>> customAttributes) { + this.customAttributes = customAttributes; + return this; + } + + /** + *

The time when the Custom Object instance was last updated in the external system it originated from.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage externalUpdatedAt(Integer externalUpdatedAt) { + this.externalUpdatedAt = Optional.ofNullable(externalUpdatedAt); + return this; + } + + /** + *

The time when the Custom Object instance was last updated in the external system it originated from.

+ */ + @java.lang.Override + @JsonSetter(value = "external_updated_at", nulls = Nulls.SKIP) + public _FinalStage externalUpdatedAt(Optional externalUpdatedAt) { + this.externalUpdatedAt = externalUpdatedAt; + return this; + } + + /** + *

The time when the Custom Object instance was created in the external system it originated from.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage externalCreatedAt(Integer externalCreatedAt) { + this.externalCreatedAt = Optional.ofNullable(externalCreatedAt); + return this; + } + + /** + *

The time when the Custom Object instance was created in the external system it originated from.

+ */ + @java.lang.Override + @JsonSetter(value = "external_created_at", nulls = Nulls.SKIP) + public _FinalStage externalCreatedAt(Optional externalCreatedAt) { + this.externalCreatedAt = externalCreatedAt; + return this; + } + + /** + *

A unique identifier for the Custom Object instance in the external system it originated from.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage externalId(String externalId) { + this.externalId = Optional.ofNullable(externalId); + return this; + } + + /** + *

A unique identifier for the Custom Object instance in the external system it originated from.

+ */ + @java.lang.Override + @JsonSetter(value = "external_id", nulls = Nulls.SKIP) + public _FinalStage externalId(Optional externalId) { + this.externalId = externalId; + return this; + } + + @java.lang.Override + public CreateOrUpdateCustomObjectInstanceRequest build() { + return new CreateOrUpdateCustomObjectInstanceRequest( + customObjectTypeIdentifier, + externalId, + externalCreatedAt, + externalUpdatedAt, + customAttributes, + additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/customobjectinstances/requests/DeleteCustomObjectInstancesByExternalIdRequest.java b/src/main/java/com/intercom/api/resources/customobjectinstances/requests/DeleteCustomObjectInstancesByExternalIdRequest.java new file mode 100644 index 00000000..c3a0fe1c --- /dev/null +++ b/src/main/java/com/intercom/api/resources/customobjectinstances/requests/DeleteCustomObjectInstancesByExternalIdRequest.java @@ -0,0 +1,155 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.customobjectinstances.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = DeleteCustomObjectInstancesByExternalIdRequest.Builder.class) +public final class DeleteCustomObjectInstancesByExternalIdRequest { + private final String customObjectTypeIdentifier; + + private final String customObjectInstanceId; + + private final Map additionalProperties; + + private DeleteCustomObjectInstancesByExternalIdRequest( + String customObjectTypeIdentifier, + String customObjectInstanceId, + Map additionalProperties) { + this.customObjectTypeIdentifier = customObjectTypeIdentifier; + this.customObjectInstanceId = customObjectInstanceId; + this.additionalProperties = additionalProperties; + } + + /** + * @return The unique identifier of the custom object type that defines the structure of the custom object instance. + */ + @JsonProperty("custom_object_type_identifier") + public String getCustomObjectTypeIdentifier() { + return customObjectTypeIdentifier; + } + + /** + * @return The Intercom defined id of the custom object instance + */ + @JsonProperty("custom_object_instance_id") + public String getCustomObjectInstanceId() { + return customObjectInstanceId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof DeleteCustomObjectInstancesByExternalIdRequest + && equalTo((DeleteCustomObjectInstancesByExternalIdRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(DeleteCustomObjectInstancesByExternalIdRequest other) { + return customObjectTypeIdentifier.equals(other.customObjectTypeIdentifier) + && customObjectInstanceId.equals(other.customObjectInstanceId); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.customObjectTypeIdentifier, this.customObjectInstanceId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static CustomObjectTypeIdentifierStage builder() { + return new Builder(); + } + + public interface CustomObjectTypeIdentifierStage { + /** + *

The unique identifier of the custom object type that defines the structure of the custom object instance.

+ */ + CustomObjectInstanceIdStage customObjectTypeIdentifier(@NotNull String customObjectTypeIdentifier); + + Builder from(DeleteCustomObjectInstancesByExternalIdRequest other); + } + + public interface CustomObjectInstanceIdStage { + /** + *

The Intercom defined id of the custom object instance

+ */ + _FinalStage customObjectInstanceId(@NotNull String customObjectInstanceId); + } + + public interface _FinalStage { + DeleteCustomObjectInstancesByExternalIdRequest build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder + implements CustomObjectTypeIdentifierStage, CustomObjectInstanceIdStage, _FinalStage { + private String customObjectTypeIdentifier; + + private String customObjectInstanceId; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(DeleteCustomObjectInstancesByExternalIdRequest other) { + customObjectTypeIdentifier(other.getCustomObjectTypeIdentifier()); + customObjectInstanceId(other.getCustomObjectInstanceId()); + return this; + } + + /** + *

The unique identifier of the custom object type that defines the structure of the custom object instance.

+ *

The unique identifier of the custom object type that defines the structure of the custom object instance.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("custom_object_type_identifier") + public CustomObjectInstanceIdStage customObjectTypeIdentifier(@NotNull String customObjectTypeIdentifier) { + this.customObjectTypeIdentifier = + Objects.requireNonNull(customObjectTypeIdentifier, "customObjectTypeIdentifier must not be null"); + return this; + } + + /** + *

The Intercom defined id of the custom object instance

+ *

The Intercom defined id of the custom object instance

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("custom_object_instance_id") + public _FinalStage customObjectInstanceId(@NotNull String customObjectInstanceId) { + this.customObjectInstanceId = + Objects.requireNonNull(customObjectInstanceId, "customObjectInstanceId must not be null"); + return this; + } + + @java.lang.Override + public DeleteCustomObjectInstancesByExternalIdRequest build() { + return new DeleteCustomObjectInstancesByExternalIdRequest( + customObjectTypeIdentifier, customObjectInstanceId, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/customobjectinstances/requests/DeleteCustomObjectInstancesByIdRequest.java b/src/main/java/com/intercom/api/resources/customobjectinstances/requests/DeleteCustomObjectInstancesByIdRequest.java new file mode 100644 index 00000000..ff8d3248 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/customobjectinstances/requests/DeleteCustomObjectInstancesByIdRequest.java @@ -0,0 +1,140 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.customobjectinstances.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = DeleteCustomObjectInstancesByIdRequest.Builder.class) +public final class DeleteCustomObjectInstancesByIdRequest { + private final String customObjectTypeIdentifier; + + private final String externalId; + + private final Map additionalProperties; + + private DeleteCustomObjectInstancesByIdRequest( + String customObjectTypeIdentifier, String externalId, Map additionalProperties) { + this.customObjectTypeIdentifier = customObjectTypeIdentifier; + this.externalId = externalId; + this.additionalProperties = additionalProperties; + } + + /** + * @return The unique identifier of the custom object type that defines the structure of the custom object instance. + */ + @JsonProperty("custom_object_type_identifier") + public String getCustomObjectTypeIdentifier() { + return customObjectTypeIdentifier; + } + + @JsonProperty("external_id") + public String getExternalId() { + return externalId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof DeleteCustomObjectInstancesByIdRequest + && equalTo((DeleteCustomObjectInstancesByIdRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(DeleteCustomObjectInstancesByIdRequest other) { + return customObjectTypeIdentifier.equals(other.customObjectTypeIdentifier) + && externalId.equals(other.externalId); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.customObjectTypeIdentifier, this.externalId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static CustomObjectTypeIdentifierStage builder() { + return new Builder(); + } + + public interface CustomObjectTypeIdentifierStage { + /** + *

The unique identifier of the custom object type that defines the structure of the custom object instance.

+ */ + ExternalIdStage customObjectTypeIdentifier(@NotNull String customObjectTypeIdentifier); + + Builder from(DeleteCustomObjectInstancesByIdRequest other); + } + + public interface ExternalIdStage { + _FinalStage externalId(@NotNull String externalId); + } + + public interface _FinalStage { + DeleteCustomObjectInstancesByIdRequest build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements CustomObjectTypeIdentifierStage, ExternalIdStage, _FinalStage { + private String customObjectTypeIdentifier; + + private String externalId; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(DeleteCustomObjectInstancesByIdRequest other) { + customObjectTypeIdentifier(other.getCustomObjectTypeIdentifier()); + externalId(other.getExternalId()); + return this; + } + + /** + *

The unique identifier of the custom object type that defines the structure of the custom object instance.

+ *

The unique identifier of the custom object type that defines the structure of the custom object instance.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("custom_object_type_identifier") + public ExternalIdStage customObjectTypeIdentifier(@NotNull String customObjectTypeIdentifier) { + this.customObjectTypeIdentifier = + Objects.requireNonNull(customObjectTypeIdentifier, "customObjectTypeIdentifier must not be null"); + return this; + } + + @java.lang.Override + @JsonSetter("external_id") + public _FinalStage externalId(@NotNull String externalId) { + this.externalId = Objects.requireNonNull(externalId, "externalId must not be null"); + return this; + } + + @java.lang.Override + public DeleteCustomObjectInstancesByIdRequest build() { + return new DeleteCustomObjectInstancesByIdRequest( + customObjectTypeIdentifier, externalId, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/customobjectinstances/requests/GetCustomObjectInstancesByExternalIdRequest.java b/src/main/java/com/intercom/api/resources/customobjectinstances/requests/GetCustomObjectInstancesByExternalIdRequest.java new file mode 100644 index 00000000..d38c58f0 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/customobjectinstances/requests/GetCustomObjectInstancesByExternalIdRequest.java @@ -0,0 +1,140 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.customobjectinstances.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = GetCustomObjectInstancesByExternalIdRequest.Builder.class) +public final class GetCustomObjectInstancesByExternalIdRequest { + private final String customObjectTypeIdentifier; + + private final String externalId; + + private final Map additionalProperties; + + private GetCustomObjectInstancesByExternalIdRequest( + String customObjectTypeIdentifier, String externalId, Map additionalProperties) { + this.customObjectTypeIdentifier = customObjectTypeIdentifier; + this.externalId = externalId; + this.additionalProperties = additionalProperties; + } + + /** + * @return The unique identifier of the custom object type that defines the structure of the custom object instance. + */ + @JsonProperty("custom_object_type_identifier") + public String getCustomObjectTypeIdentifier() { + return customObjectTypeIdentifier; + } + + @JsonProperty("external_id") + public String getExternalId() { + return externalId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof GetCustomObjectInstancesByExternalIdRequest + && equalTo((GetCustomObjectInstancesByExternalIdRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(GetCustomObjectInstancesByExternalIdRequest other) { + return customObjectTypeIdentifier.equals(other.customObjectTypeIdentifier) + && externalId.equals(other.externalId); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.customObjectTypeIdentifier, this.externalId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static CustomObjectTypeIdentifierStage builder() { + return new Builder(); + } + + public interface CustomObjectTypeIdentifierStage { + /** + *

The unique identifier of the custom object type that defines the structure of the custom object instance.

+ */ + ExternalIdStage customObjectTypeIdentifier(@NotNull String customObjectTypeIdentifier); + + Builder from(GetCustomObjectInstancesByExternalIdRequest other); + } + + public interface ExternalIdStage { + _FinalStage externalId(@NotNull String externalId); + } + + public interface _FinalStage { + GetCustomObjectInstancesByExternalIdRequest build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements CustomObjectTypeIdentifierStage, ExternalIdStage, _FinalStage { + private String customObjectTypeIdentifier; + + private String externalId; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(GetCustomObjectInstancesByExternalIdRequest other) { + customObjectTypeIdentifier(other.getCustomObjectTypeIdentifier()); + externalId(other.getExternalId()); + return this; + } + + /** + *

The unique identifier of the custom object type that defines the structure of the custom object instance.

+ *

The unique identifier of the custom object type that defines the structure of the custom object instance.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("custom_object_type_identifier") + public ExternalIdStage customObjectTypeIdentifier(@NotNull String customObjectTypeIdentifier) { + this.customObjectTypeIdentifier = + Objects.requireNonNull(customObjectTypeIdentifier, "customObjectTypeIdentifier must not be null"); + return this; + } + + @java.lang.Override + @JsonSetter("external_id") + public _FinalStage externalId(@NotNull String externalId) { + this.externalId = Objects.requireNonNull(externalId, "externalId must not be null"); + return this; + } + + @java.lang.Override + public GetCustomObjectInstancesByExternalIdRequest build() { + return new GetCustomObjectInstancesByExternalIdRequest( + customObjectTypeIdentifier, externalId, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/customobjectinstances/requests/GetCustomObjectInstancesByIdRequest.java b/src/main/java/com/intercom/api/resources/customobjectinstances/requests/GetCustomObjectInstancesByIdRequest.java new file mode 100644 index 00000000..331f8646 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/customobjectinstances/requests/GetCustomObjectInstancesByIdRequest.java @@ -0,0 +1,155 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.customobjectinstances.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = GetCustomObjectInstancesByIdRequest.Builder.class) +public final class GetCustomObjectInstancesByIdRequest { + private final String customObjectTypeIdentifier; + + private final String customObjectInstanceId; + + private final Map additionalProperties; + + private GetCustomObjectInstancesByIdRequest( + String customObjectTypeIdentifier, + String customObjectInstanceId, + Map additionalProperties) { + this.customObjectTypeIdentifier = customObjectTypeIdentifier; + this.customObjectInstanceId = customObjectInstanceId; + this.additionalProperties = additionalProperties; + } + + /** + * @return The unique identifier of the custom object type that defines the structure of the custom object instance. + */ + @JsonProperty("custom_object_type_identifier") + public String getCustomObjectTypeIdentifier() { + return customObjectTypeIdentifier; + } + + /** + * @return The id or external_id of the custom object instance + */ + @JsonProperty("custom_object_instance_id") + public String getCustomObjectInstanceId() { + return customObjectInstanceId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof GetCustomObjectInstancesByIdRequest + && equalTo((GetCustomObjectInstancesByIdRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(GetCustomObjectInstancesByIdRequest other) { + return customObjectTypeIdentifier.equals(other.customObjectTypeIdentifier) + && customObjectInstanceId.equals(other.customObjectInstanceId); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.customObjectTypeIdentifier, this.customObjectInstanceId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static CustomObjectTypeIdentifierStage builder() { + return new Builder(); + } + + public interface CustomObjectTypeIdentifierStage { + /** + *

The unique identifier of the custom object type that defines the structure of the custom object instance.

+ */ + CustomObjectInstanceIdStage customObjectTypeIdentifier(@NotNull String customObjectTypeIdentifier); + + Builder from(GetCustomObjectInstancesByIdRequest other); + } + + public interface CustomObjectInstanceIdStage { + /** + *

The id or external_id of the custom object instance

+ */ + _FinalStage customObjectInstanceId(@NotNull String customObjectInstanceId); + } + + public interface _FinalStage { + GetCustomObjectInstancesByIdRequest build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder + implements CustomObjectTypeIdentifierStage, CustomObjectInstanceIdStage, _FinalStage { + private String customObjectTypeIdentifier; + + private String customObjectInstanceId; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(GetCustomObjectInstancesByIdRequest other) { + customObjectTypeIdentifier(other.getCustomObjectTypeIdentifier()); + customObjectInstanceId(other.getCustomObjectInstanceId()); + return this; + } + + /** + *

The unique identifier of the custom object type that defines the structure of the custom object instance.

+ *

The unique identifier of the custom object type that defines the structure of the custom object instance.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("custom_object_type_identifier") + public CustomObjectInstanceIdStage customObjectTypeIdentifier(@NotNull String customObjectTypeIdentifier) { + this.customObjectTypeIdentifier = + Objects.requireNonNull(customObjectTypeIdentifier, "customObjectTypeIdentifier must not be null"); + return this; + } + + /** + *

The id or external_id of the custom object instance

+ *

The id or external_id of the custom object instance

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("custom_object_instance_id") + public _FinalStage customObjectInstanceId(@NotNull String customObjectInstanceId) { + this.customObjectInstanceId = + Objects.requireNonNull(customObjectInstanceId, "customObjectInstanceId must not be null"); + return this; + } + + @java.lang.Override + public GetCustomObjectInstancesByIdRequest build() { + return new GetCustomObjectInstancesByIdRequest( + customObjectTypeIdentifier, customObjectInstanceId, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/customobjectinstances/types/CustomObjectInstance.java b/src/main/java/com/intercom/api/resources/customobjectinstances/types/CustomObjectInstance.java new file mode 100644 index 00000000..099b9ed0 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/customobjectinstances/types/CustomObjectInstance.java @@ -0,0 +1,330 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.customobjectinstances.types; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = CustomObjectInstance.Builder.class) +public final class CustomObjectInstance { + private final Optional id; + + private final Optional externalId; + + private final Optional externalCreatedAt; + + private final Optional externalUpdatedAt; + + private final Optional createdAt; + + private final Optional updatedAt; + + private final Optional type; + + private final Optional> customAttributes; + + private final Map additionalProperties; + + private CustomObjectInstance( + Optional id, + Optional externalId, + Optional externalCreatedAt, + Optional externalUpdatedAt, + Optional createdAt, + Optional updatedAt, + Optional type, + Optional> customAttributes, + Map additionalProperties) { + this.id = id; + this.externalId = externalId; + this.externalCreatedAt = externalCreatedAt; + this.externalUpdatedAt = externalUpdatedAt; + this.createdAt = createdAt; + this.updatedAt = updatedAt; + this.type = type; + this.customAttributes = customAttributes; + this.additionalProperties = additionalProperties; + } + + /** + * @return The Intercom defined id representing the custom object instance. + */ + @JsonProperty("id") + public Optional getId() { + return id; + } + + /** + * @return The id you have defined for the custom object instance. + */ + @JsonProperty("external_id") + public Optional getExternalId() { + return externalId; + } + + /** + * @return The time when the Custom Object instance was created in the external system it originated from. + */ + @JsonProperty("external_created_at") + public Optional getExternalCreatedAt() { + return externalCreatedAt; + } + + /** + * @return The time when the Custom Object instance was last updated in the external system it originated from. + */ + @JsonProperty("external_updated_at") + public Optional getExternalUpdatedAt() { + return externalUpdatedAt; + } + + /** + * @return The time the attribute was created as a UTC Unix timestamp + */ + @JsonProperty("created_at") + public Optional getCreatedAt() { + return createdAt; + } + + /** + * @return The time the attribute was last updated as a UTC Unix timestamp + */ + @JsonProperty("updated_at") + public Optional getUpdatedAt() { + return updatedAt; + } + + /** + * @return The identifier of the custom object type that defines the structure of the custom object instance. + */ + @JsonProperty("type") + public Optional getType() { + return type; + } + + /** + * @return The custom attributes you have set on the custom object instance. + */ + @JsonProperty("custom_attributes") + public Optional> getCustomAttributes() { + return customAttributes; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof CustomObjectInstance && equalTo((CustomObjectInstance) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(CustomObjectInstance other) { + return id.equals(other.id) + && externalId.equals(other.externalId) + && externalCreatedAt.equals(other.externalCreatedAt) + && externalUpdatedAt.equals(other.externalUpdatedAt) + && createdAt.equals(other.createdAt) + && updatedAt.equals(other.updatedAt) + && type.equals(other.type) + && customAttributes.equals(other.customAttributes); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash( + this.id, + this.externalId, + this.externalCreatedAt, + this.externalUpdatedAt, + this.createdAt, + this.updatedAt, + this.type, + this.customAttributes); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static Builder builder() { + return new Builder(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder { + private Optional id = Optional.empty(); + + private Optional externalId = Optional.empty(); + + private Optional externalCreatedAt = Optional.empty(); + + private Optional externalUpdatedAt = Optional.empty(); + + private Optional createdAt = Optional.empty(); + + private Optional updatedAt = Optional.empty(); + + private Optional type = Optional.empty(); + + private Optional> customAttributes = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + public Builder from(CustomObjectInstance other) { + id(other.getId()); + externalId(other.getExternalId()); + externalCreatedAt(other.getExternalCreatedAt()); + externalUpdatedAt(other.getExternalUpdatedAt()); + createdAt(other.getCreatedAt()); + updatedAt(other.getUpdatedAt()); + type(other.getType()); + customAttributes(other.getCustomAttributes()); + return this; + } + + /** + *

The Intercom defined id representing the custom object instance.

+ */ + @JsonSetter(value = "id", nulls = Nulls.SKIP) + public Builder id(Optional id) { + this.id = id; + return this; + } + + public Builder id(String id) { + this.id = Optional.ofNullable(id); + return this; + } + + /** + *

The id you have defined for the custom object instance.

+ */ + @JsonSetter(value = "external_id", nulls = Nulls.SKIP) + public Builder externalId(Optional externalId) { + this.externalId = externalId; + return this; + } + + public Builder externalId(String externalId) { + this.externalId = Optional.ofNullable(externalId); + return this; + } + + /** + *

The time when the Custom Object instance was created in the external system it originated from.

+ */ + @JsonSetter(value = "external_created_at", nulls = Nulls.SKIP) + public Builder externalCreatedAt(Optional externalCreatedAt) { + this.externalCreatedAt = externalCreatedAt; + return this; + } + + public Builder externalCreatedAt(Integer externalCreatedAt) { + this.externalCreatedAt = Optional.ofNullable(externalCreatedAt); + return this; + } + + /** + *

The time when the Custom Object instance was last updated in the external system it originated from.

+ */ + @JsonSetter(value = "external_updated_at", nulls = Nulls.SKIP) + public Builder externalUpdatedAt(Optional externalUpdatedAt) { + this.externalUpdatedAt = externalUpdatedAt; + return this; + } + + public Builder externalUpdatedAt(Integer externalUpdatedAt) { + this.externalUpdatedAt = Optional.ofNullable(externalUpdatedAt); + return this; + } + + /** + *

The time the attribute was created as a UTC Unix timestamp

+ */ + @JsonSetter(value = "created_at", nulls = Nulls.SKIP) + public Builder createdAt(Optional createdAt) { + this.createdAt = createdAt; + return this; + } + + public Builder createdAt(Integer createdAt) { + this.createdAt = Optional.ofNullable(createdAt); + return this; + } + + /** + *

The time the attribute was last updated as a UTC Unix timestamp

+ */ + @JsonSetter(value = "updated_at", nulls = Nulls.SKIP) + public Builder updatedAt(Optional updatedAt) { + this.updatedAt = updatedAt; + return this; + } + + public Builder updatedAt(Integer updatedAt) { + this.updatedAt = Optional.ofNullable(updatedAt); + return this; + } + + /** + *

The identifier of the custom object type that defines the structure of the custom object instance.

+ */ + @JsonSetter(value = "type", nulls = Nulls.SKIP) + public Builder type(Optional type) { + this.type = type; + return this; + } + + public Builder type(String type) { + this.type = Optional.ofNullable(type); + return this; + } + + /** + *

The custom attributes you have set on the custom object instance.

+ */ + @JsonSetter(value = "custom_attributes", nulls = Nulls.SKIP) + public Builder customAttributes(Optional> customAttributes) { + this.customAttributes = customAttributes; + return this; + } + + public Builder customAttributes(Map customAttributes) { + this.customAttributes = Optional.ofNullable(customAttributes); + return this; + } + + public CustomObjectInstance build() { + return new CustomObjectInstance( + id, + externalId, + externalCreatedAt, + externalUpdatedAt, + createdAt, + updatedAt, + type, + customAttributes, + additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/dataattributes/AsyncDataAttributesClient.java b/src/main/java/com/intercom/api/resources/dataattributes/AsyncDataAttributesClient.java new file mode 100644 index 00000000..ac0f6560 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/dataattributes/AsyncDataAttributesClient.java @@ -0,0 +1,88 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.dataattributes; + +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.resources.dataattributes.requests.ListDataAttributesRequest; +import com.intercom.api.resources.dataattributes.requests.UpdateDataAttributeRequest; +import com.intercom.api.resources.dataattributes.types.DataAttribute; +import com.intercom.api.types.CreateDataAttributeRequest; +import com.intercom.api.types.DataAttributeList; +import java.util.concurrent.CompletableFuture; + +public class AsyncDataAttributesClient { + protected final ClientOptions clientOptions; + + private final AsyncRawDataAttributesClient rawClient; + + public AsyncDataAttributesClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + this.rawClient = new AsyncRawDataAttributesClient(clientOptions); + } + + /** + * Get responses with HTTP metadata like headers + */ + public AsyncRawDataAttributesClient withRawResponse() { + return this.rawClient; + } + + /** + * You can fetch a list of all data attributes belonging to a workspace for contacts, companies or conversations. + */ + public CompletableFuture list() { + return this.rawClient.list().thenApply(response -> response.body()); + } + + /** + * You can fetch a list of all data attributes belonging to a workspace for contacts, companies or conversations. + */ + public CompletableFuture list(ListDataAttributesRequest request) { + return this.rawClient.list(request).thenApply(response -> response.body()); + } + + /** + * You can fetch a list of all data attributes belonging to a workspace for contacts, companies or conversations. + */ + public CompletableFuture list(ListDataAttributesRequest request, RequestOptions requestOptions) { + return this.rawClient.list(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can create a data attributes for a contact or a company. + */ + public CompletableFuture create(CreateDataAttributeRequest request) { + return this.rawClient.create(request).thenApply(response -> response.body()); + } + + /** + * You can create a data attributes for a contact or a company. + */ + public CompletableFuture create(CreateDataAttributeRequest request, RequestOptions requestOptions) { + return this.rawClient.create(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can update a data attribute. + *
+ *

🚧 Updating the data type is not possible

+ *

It is currently a dangerous action to execute changing a data attribute's type via the API. You will need to update the type via the UI instead.

+ *
+ */ + public CompletableFuture update(UpdateDataAttributeRequest request) { + return this.rawClient.update(request).thenApply(response -> response.body()); + } + + /** + * You can update a data attribute. + *
+ *

🚧 Updating the data type is not possible

+ *

It is currently a dangerous action to execute changing a data attribute's type via the API. You will need to update the type via the UI instead.

+ *
+ */ + public CompletableFuture update(UpdateDataAttributeRequest request, RequestOptions requestOptions) { + return this.rawClient.update(request, requestOptions).thenApply(response -> response.body()); + } +} diff --git a/src/main/java/com/intercom/api/resources/dataattributes/AsyncRawDataAttributesClient.java b/src/main/java/com/intercom/api/resources/dataattributes/AsyncRawDataAttributesClient.java new file mode 100644 index 00000000..2f3df746 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/dataattributes/AsyncRawDataAttributesClient.java @@ -0,0 +1,299 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.dataattributes; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.IntercomApiException; +import com.intercom.api.core.IntercomException; +import com.intercom.api.core.IntercomHttpResponse; +import com.intercom.api.core.MediaTypes; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.core.QueryStringMapper; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.errors.BadRequestError; +import com.intercom.api.errors.NotFoundError; +import com.intercom.api.errors.UnauthorizedError; +import com.intercom.api.errors.UnprocessableEntityError; +import com.intercom.api.resources.dataattributes.requests.ListDataAttributesRequest; +import com.intercom.api.resources.dataattributes.requests.UpdateDataAttributeRequest; +import com.intercom.api.resources.dataattributes.types.DataAttribute; +import com.intercom.api.types.CreateDataAttributeRequest; +import com.intercom.api.types.DataAttributeList; +import com.intercom.api.types.Error; +import java.io.IOException; +import java.util.concurrent.CompletableFuture; +import okhttp3.Call; +import okhttp3.Callback; +import okhttp3.Headers; +import okhttp3.HttpUrl; +import okhttp3.OkHttpClient; +import okhttp3.Request; +import okhttp3.RequestBody; +import okhttp3.Response; +import okhttp3.ResponseBody; +import org.jetbrains.annotations.NotNull; + +public class AsyncRawDataAttributesClient { + protected final ClientOptions clientOptions; + + public AsyncRawDataAttributesClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + } + + /** + * You can fetch a list of all data attributes belonging to a workspace for contacts, companies or conversations. + */ + public CompletableFuture> list() { + return list(ListDataAttributesRequest.builder().build()); + } + + /** + * You can fetch a list of all data attributes belonging to a workspace for contacts, companies or conversations. + */ + public CompletableFuture> list(ListDataAttributesRequest request) { + return list(request, null); + } + + /** + * You can fetch a list of all data attributes belonging to a workspace for contacts, companies or conversations. + */ + public CompletableFuture> list( + ListDataAttributesRequest request, RequestOptions requestOptions) { + HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("data_attributes"); + if (request.getModel().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "model", request.getModel().get(), false); + } + if (request.getIncludeArchived().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "include_archived", request.getIncludeArchived().get(), false); + } + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl.build()) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, DataAttributeList.class), + response)); + return; + } + try { + if (response.code() == 401) { + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can create a data attributes for a contact or a company. + */ + public CompletableFuture> create(CreateDataAttributeRequest request) { + return create(request, null); + } + + /** + * You can create a data attributes for a contact or a company. + */ + public CompletableFuture> create( + CreateDataAttributeRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("data_attributes") + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, DataAttribute.class), + response)); + return; + } + try { + switch (response.code()) { + case 400: + future.completeExceptionally(new BadRequestError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can update a data attribute. + *
+ *

🚧 Updating the data type is not possible

+ *

It is currently a dangerous action to execute changing a data attribute's type via the API. You will need to update the type via the UI instead.

+ *
+ */ + public CompletableFuture> update(UpdateDataAttributeRequest request) { + return update(request, null); + } + + /** + * You can update a data attribute. + *
+ *

🚧 Updating the data type is not possible

+ *

It is currently a dangerous action to execute changing a data attribute's type via the API. You will need to update the type via the UI instead.

+ *
+ */ + public CompletableFuture> update( + UpdateDataAttributeRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("data_attributes") + .addPathSegment(Integer.toString(request.getDataAttributeId())) + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request.getBody()), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("PUT", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, DataAttribute.class), + response)); + return; + } + try { + switch (response.code()) { + case 400: + future.completeExceptionally(new BadRequestError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 404: + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + case 422: + future.completeExceptionally(new UnprocessableEntityError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } +} diff --git a/src/main/java/com/intercom/api/resources/dataattributes/DataAttributesClient.java b/src/main/java/com/intercom/api/resources/dataattributes/DataAttributesClient.java new file mode 100644 index 00000000..b672ceb3 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/dataattributes/DataAttributesClient.java @@ -0,0 +1,87 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.dataattributes; + +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.resources.dataattributes.requests.ListDataAttributesRequest; +import com.intercom.api.resources.dataattributes.requests.UpdateDataAttributeRequest; +import com.intercom.api.resources.dataattributes.types.DataAttribute; +import com.intercom.api.types.CreateDataAttributeRequest; +import com.intercom.api.types.DataAttributeList; + +public class DataAttributesClient { + protected final ClientOptions clientOptions; + + private final RawDataAttributesClient rawClient; + + public DataAttributesClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + this.rawClient = new RawDataAttributesClient(clientOptions); + } + + /** + * Get responses with HTTP metadata like headers + */ + public RawDataAttributesClient withRawResponse() { + return this.rawClient; + } + + /** + * You can fetch a list of all data attributes belonging to a workspace for contacts, companies or conversations. + */ + public DataAttributeList list() { + return this.rawClient.list().body(); + } + + /** + * You can fetch a list of all data attributes belonging to a workspace for contacts, companies or conversations. + */ + public DataAttributeList list(ListDataAttributesRequest request) { + return this.rawClient.list(request).body(); + } + + /** + * You can fetch a list of all data attributes belonging to a workspace for contacts, companies or conversations. + */ + public DataAttributeList list(ListDataAttributesRequest request, RequestOptions requestOptions) { + return this.rawClient.list(request, requestOptions).body(); + } + + /** + * You can create a data attributes for a contact or a company. + */ + public DataAttribute create(CreateDataAttributeRequest request) { + return this.rawClient.create(request).body(); + } + + /** + * You can create a data attributes for a contact or a company. + */ + public DataAttribute create(CreateDataAttributeRequest request, RequestOptions requestOptions) { + return this.rawClient.create(request, requestOptions).body(); + } + + /** + * You can update a data attribute. + *
+ *

🚧 Updating the data type is not possible

+ *

It is currently a dangerous action to execute changing a data attribute's type via the API. You will need to update the type via the UI instead.

+ *
+ */ + public DataAttribute update(UpdateDataAttributeRequest request) { + return this.rawClient.update(request).body(); + } + + /** + * You can update a data attribute. + *
+ *

🚧 Updating the data type is not possible

+ *

It is currently a dangerous action to execute changing a data attribute's type via the API. You will need to update the type via the UI instead.

+ *
+ */ + public DataAttribute update(UpdateDataAttributeRequest request, RequestOptions requestOptions) { + return this.rawClient.update(request, requestOptions).body(); + } +} diff --git a/src/main/java/com/intercom/api/resources/dataattributes/RawDataAttributesClient.java b/src/main/java/com/intercom/api/resources/dataattributes/RawDataAttributesClient.java new file mode 100644 index 00000000..dc20158e --- /dev/null +++ b/src/main/java/com/intercom/api/resources/dataattributes/RawDataAttributesClient.java @@ -0,0 +1,240 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.dataattributes; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.IntercomApiException; +import com.intercom.api.core.IntercomException; +import com.intercom.api.core.IntercomHttpResponse; +import com.intercom.api.core.MediaTypes; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.core.QueryStringMapper; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.errors.BadRequestError; +import com.intercom.api.errors.NotFoundError; +import com.intercom.api.errors.UnauthorizedError; +import com.intercom.api.errors.UnprocessableEntityError; +import com.intercom.api.resources.dataattributes.requests.ListDataAttributesRequest; +import com.intercom.api.resources.dataattributes.requests.UpdateDataAttributeRequest; +import com.intercom.api.resources.dataattributes.types.DataAttribute; +import com.intercom.api.types.CreateDataAttributeRequest; +import com.intercom.api.types.DataAttributeList; +import com.intercom.api.types.Error; +import java.io.IOException; +import okhttp3.Headers; +import okhttp3.HttpUrl; +import okhttp3.OkHttpClient; +import okhttp3.Request; +import okhttp3.RequestBody; +import okhttp3.Response; +import okhttp3.ResponseBody; + +public class RawDataAttributesClient { + protected final ClientOptions clientOptions; + + public RawDataAttributesClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + } + + /** + * You can fetch a list of all data attributes belonging to a workspace for contacts, companies or conversations. + */ + public IntercomHttpResponse list() { + return list(ListDataAttributesRequest.builder().build()); + } + + /** + * You can fetch a list of all data attributes belonging to a workspace for contacts, companies or conversations. + */ + public IntercomHttpResponse list(ListDataAttributesRequest request) { + return list(request, null); + } + + /** + * You can fetch a list of all data attributes belonging to a workspace for contacts, companies or conversations. + */ + public IntercomHttpResponse list( + ListDataAttributesRequest request, RequestOptions requestOptions) { + HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("data_attributes"); + if (request.getModel().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "model", request.getModel().get(), false); + } + if (request.getIncludeArchived().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "include_archived", request.getIncludeArchived().get(), false); + } + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl.build()) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, DataAttributeList.class), response); + } + try { + if (response.code() == 401) { + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can create a data attributes for a contact or a company. + */ + public IntercomHttpResponse create(CreateDataAttributeRequest request) { + return create(request, null); + } + + /** + * You can create a data attributes for a contact or a company. + */ + public IntercomHttpResponse create( + CreateDataAttributeRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("data_attributes") + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, DataAttribute.class), response); + } + try { + switch (response.code()) { + case 400: + throw new BadRequestError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can update a data attribute. + *
+ *

🚧 Updating the data type is not possible

+ *

It is currently a dangerous action to execute changing a data attribute's type via the API. You will need to update the type via the UI instead.

+ *
+ */ + public IntercomHttpResponse update(UpdateDataAttributeRequest request) { + return update(request, null); + } + + /** + * You can update a data attribute. + *
+ *

🚧 Updating the data type is not possible

+ *

It is currently a dangerous action to execute changing a data attribute's type via the API. You will need to update the type via the UI instead.

+ *
+ */ + public IntercomHttpResponse update( + UpdateDataAttributeRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("data_attributes") + .addPathSegment(Integer.toString(request.getDataAttributeId())) + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request.getBody()), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("PUT", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, DataAttribute.class), response); + } + try { + switch (response.code()) { + case 400: + throw new BadRequestError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 404: + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + case 422: + throw new UnprocessableEntityError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/dataattributes/requests/ListDataAttributesRequest.java b/src/main/java/com/intercom/api/resources/dataattributes/requests/ListDataAttributesRequest.java new file mode 100644 index 00000000..c44658b4 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/dataattributes/requests/ListDataAttributesRequest.java @@ -0,0 +1,133 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.dataattributes.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.resources.dataattributes.types.DataAttributesListRequestModel; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = ListDataAttributesRequest.Builder.class) +public final class ListDataAttributesRequest { + private final Optional model; + + private final Optional includeArchived; + + private final Map additionalProperties; + + private ListDataAttributesRequest( + Optional model, + Optional includeArchived, + Map additionalProperties) { + this.model = model; + this.includeArchived = includeArchived; + this.additionalProperties = additionalProperties; + } + + /** + * @return Specify the data attribute model to return. + */ + @JsonProperty("model") + public Optional getModel() { + return model; + } + + /** + * @return Include archived attributes in the list. By default we return only non archived data attributes. + */ + @JsonProperty("include_archived") + public Optional getIncludeArchived() { + return includeArchived; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof ListDataAttributesRequest && equalTo((ListDataAttributesRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(ListDataAttributesRequest other) { + return model.equals(other.model) && includeArchived.equals(other.includeArchived); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.model, this.includeArchived); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static Builder builder() { + return new Builder(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder { + private Optional model = Optional.empty(); + + private Optional includeArchived = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + public Builder from(ListDataAttributesRequest other) { + model(other.getModel()); + includeArchived(other.getIncludeArchived()); + return this; + } + + /** + *

Specify the data attribute model to return.

+ */ + @JsonSetter(value = "model", nulls = Nulls.SKIP) + public Builder model(Optional model) { + this.model = model; + return this; + } + + public Builder model(DataAttributesListRequestModel model) { + this.model = Optional.ofNullable(model); + return this; + } + + /** + *

Include archived attributes in the list. By default we return only non archived data attributes.

+ */ + @JsonSetter(value = "include_archived", nulls = Nulls.SKIP) + public Builder includeArchived(Optional includeArchived) { + this.includeArchived = includeArchived; + return this; + } + + public Builder includeArchived(Boolean includeArchived) { + this.includeArchived = Optional.ofNullable(includeArchived); + return this; + } + + public ListDataAttributesRequest build() { + return new ListDataAttributesRequest(model, includeArchived, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/dataattributes/requests/UpdateDataAttributeRequest.java b/src/main/java/com/intercom/api/resources/dataattributes/requests/UpdateDataAttributeRequest.java new file mode 100644 index 00000000..ef9e9328 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/dataattributes/requests/UpdateDataAttributeRequest.java @@ -0,0 +1,137 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.dataattributes.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.types.UpdateDataAttributeRequestBody; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = UpdateDataAttributeRequest.Builder.class) +public final class UpdateDataAttributeRequest { + private final int dataAttributeId; + + private final UpdateDataAttributeRequestBody body; + + private final Map additionalProperties; + + private UpdateDataAttributeRequest( + int dataAttributeId, UpdateDataAttributeRequestBody body, Map additionalProperties) { + this.dataAttributeId = dataAttributeId; + this.body = body; + this.additionalProperties = additionalProperties; + } + + /** + * @return The data attribute id + */ + @JsonProperty("data_attribute_id") + public int getDataAttributeId() { + return dataAttributeId; + } + + @JsonProperty("body") + public UpdateDataAttributeRequestBody getBody() { + return body; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof UpdateDataAttributeRequest && equalTo((UpdateDataAttributeRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(UpdateDataAttributeRequest other) { + return dataAttributeId == other.dataAttributeId && body.equals(other.body); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.dataAttributeId, this.body); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static DataAttributeIdStage builder() { + return new Builder(); + } + + public interface DataAttributeIdStage { + /** + *

The data attribute id

+ */ + BodyStage dataAttributeId(int dataAttributeId); + + Builder from(UpdateDataAttributeRequest other); + } + + public interface BodyStage { + _FinalStage body(@NotNull UpdateDataAttributeRequestBody body); + } + + public interface _FinalStage { + UpdateDataAttributeRequest build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements DataAttributeIdStage, BodyStage, _FinalStage { + private int dataAttributeId; + + private UpdateDataAttributeRequestBody body; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(UpdateDataAttributeRequest other) { + dataAttributeId(other.getDataAttributeId()); + body(other.getBody()); + return this; + } + + /** + *

The data attribute id

+ *

The data attribute id

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("data_attribute_id") + public BodyStage dataAttributeId(int dataAttributeId) { + this.dataAttributeId = dataAttributeId; + return this; + } + + @java.lang.Override + @JsonSetter("body") + public _FinalStage body(@NotNull UpdateDataAttributeRequestBody body) { + this.body = Objects.requireNonNull(body, "body must not be null"); + return this; + } + + @java.lang.Override + public UpdateDataAttributeRequest build() { + return new UpdateDataAttributeRequest(dataAttributeId, body, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/dataattributes/types/DataAttribute.java b/src/main/java/com/intercom/api/resources/dataattributes/types/DataAttribute.java new file mode 100644 index 00000000..09cc6bdd --- /dev/null +++ b/src/main/java/com/intercom/api/resources/dataattributes/types/DataAttribute.java @@ -0,0 +1,962 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.dataattributes.types; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.JsonValue; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = DataAttribute.Builder.class) +public final class DataAttribute { + private final Optional id; + + private final Optional model; + + private final String name; + + private final String fullName; + + private final String label; + + private final Optional description; + + private final DataType dataType; + + private final Optional> options; + + private final Optional apiWritable; + + private final Optional messengerWritable; + + private final Optional uiWritable; + + private final Optional custom; + + private final Optional archived; + + private final Optional createdAt; + + private final Optional updatedAt; + + private final Optional adminId; + + private final Map additionalProperties; + + private DataAttribute( + Optional id, + Optional model, + String name, + String fullName, + String label, + Optional description, + DataType dataType, + Optional> options, + Optional apiWritable, + Optional messengerWritable, + Optional uiWritable, + Optional custom, + Optional archived, + Optional createdAt, + Optional updatedAt, + Optional adminId, + Map additionalProperties) { + this.id = id; + this.model = model; + this.name = name; + this.fullName = fullName; + this.label = label; + this.description = description; + this.dataType = dataType; + this.options = options; + this.apiWritable = apiWritable; + this.messengerWritable = messengerWritable; + this.uiWritable = uiWritable; + this.custom = custom; + this.archived = archived; + this.createdAt = createdAt; + this.updatedAt = updatedAt; + this.adminId = adminId; + this.additionalProperties = additionalProperties; + } + + /** + * @return Value is data_attribute. + */ + @JsonProperty("type") + public String getType() { + return "data_attribute"; + } + + /** + * @return The unique identifier for the data attribute which is given by Intercom. Only available for custom attributes. + */ + @JsonProperty("id") + public Optional getId() { + return id; + } + + /** + * @return Value is contact for user/lead attributes and company for company attributes. + */ + @JsonProperty("model") + public Optional getModel() { + return model; + } + + /** + * @return Name of the attribute. + */ + @JsonProperty("name") + public String getName() { + return name; + } + + /** + * @return Full name of the attribute. Should match the name unless it's a nested attribute. We can split full_name on . to access nested user object values. + */ + @JsonProperty("full_name") + public String getFullName() { + return fullName; + } + + /** + * @return Readable name of the attribute (i.e. name you see in the UI) + */ + @JsonProperty("label") + public String getLabel() { + return label; + } + + /** + * @return Readable description of the attribute. + */ + @JsonProperty("description") + public Optional getDescription() { + return description; + } + + /** + * @return The data type of the attribute. + */ + @JsonProperty("data_type") + public DataType getDataType() { + return dataType; + } + + /** + * @return List of predefined options for attribute value. + */ + @JsonProperty("options") + public Optional> getOptions() { + return options; + } + + /** + * @return Can this attribute be updated through API + */ + @JsonProperty("api_writable") + public Optional getApiWritable() { + return apiWritable; + } + + /** + * @return Can this attribute be updated by the Messenger + */ + @JsonProperty("messenger_writable") + public Optional getMessengerWritable() { + return messengerWritable; + } + + /** + * @return Can this attribute be updated in the UI + */ + @JsonProperty("ui_writable") + public Optional getUiWritable() { + return uiWritable; + } + + /** + * @return Set to true if this is a CDA + */ + @JsonProperty("custom") + public Optional getCustom() { + return custom; + } + + /** + * @return Is this attribute archived. (Only applicable to CDAs) + */ + @JsonProperty("archived") + public Optional getArchived() { + return archived; + } + + /** + * @return The time the attribute was created as a UTC Unix timestamp + */ + @JsonProperty("created_at") + public Optional getCreatedAt() { + return createdAt; + } + + /** + * @return The time the attribute was last updated as a UTC Unix timestamp + */ + @JsonProperty("updated_at") + public Optional getUpdatedAt() { + return updatedAt; + } + + /** + * @return Teammate who created the attribute. Only applicable to CDAs + */ + @JsonProperty("admin_id") + public Optional getAdminId() { + return adminId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof DataAttribute && equalTo((DataAttribute) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(DataAttribute other) { + return id.equals(other.id) + && model.equals(other.model) + && name.equals(other.name) + && fullName.equals(other.fullName) + && label.equals(other.label) + && description.equals(other.description) + && dataType.equals(other.dataType) + && options.equals(other.options) + && apiWritable.equals(other.apiWritable) + && messengerWritable.equals(other.messengerWritable) + && uiWritable.equals(other.uiWritable) + && custom.equals(other.custom) + && archived.equals(other.archived) + && createdAt.equals(other.createdAt) + && updatedAt.equals(other.updatedAt) + && adminId.equals(other.adminId); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash( + this.id, + this.model, + this.name, + this.fullName, + this.label, + this.description, + this.dataType, + this.options, + this.apiWritable, + this.messengerWritable, + this.uiWritable, + this.custom, + this.archived, + this.createdAt, + this.updatedAt, + this.adminId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static NameStage builder() { + return new Builder(); + } + + public interface NameStage { + /** + *

Name of the attribute.

+ */ + FullNameStage name(@NotNull String name); + + Builder from(DataAttribute other); + } + + public interface FullNameStage { + /** + *

Full name of the attribute. Should match the name unless it's a nested attribute. We can split full_name on . to access nested user object values.

+ */ + LabelStage fullName(@NotNull String fullName); + } + + public interface LabelStage { + /** + *

Readable name of the attribute (i.e. name you see in the UI)

+ */ + DataTypeStage label(@NotNull String label); + } + + public interface DataTypeStage { + /** + *

The data type of the attribute.

+ */ + _FinalStage dataType(@NotNull DataType dataType); + } + + public interface _FinalStage { + DataAttribute build(); + + /** + *

The unique identifier for the data attribute which is given by Intercom. Only available for custom attributes.

+ */ + _FinalStage id(Optional id); + + _FinalStage id(Integer id); + + /** + *

Value is contact for user/lead attributes and company for company attributes.

+ */ + _FinalStage model(Optional model); + + _FinalStage model(Model model); + + /** + *

Readable description of the attribute.

+ */ + _FinalStage description(Optional description); + + _FinalStage description(String description); + + /** + *

List of predefined options for attribute value.

+ */ + _FinalStage options(Optional> options); + + _FinalStage options(List options); + + /** + *

Can this attribute be updated through API

+ */ + _FinalStage apiWritable(Optional apiWritable); + + _FinalStage apiWritable(Boolean apiWritable); + + /** + *

Can this attribute be updated by the Messenger

+ */ + _FinalStage messengerWritable(Optional messengerWritable); + + _FinalStage messengerWritable(Boolean messengerWritable); + + /** + *

Can this attribute be updated in the UI

+ */ + _FinalStage uiWritable(Optional uiWritable); + + _FinalStage uiWritable(Boolean uiWritable); + + /** + *

Set to true if this is a CDA

+ */ + _FinalStage custom(Optional custom); + + _FinalStage custom(Boolean custom); + + /** + *

Is this attribute archived. (Only applicable to CDAs)

+ */ + _FinalStage archived(Optional archived); + + _FinalStage archived(Boolean archived); + + /** + *

The time the attribute was created as a UTC Unix timestamp

+ */ + _FinalStage createdAt(Optional createdAt); + + _FinalStage createdAt(Integer createdAt); + + /** + *

The time the attribute was last updated as a UTC Unix timestamp

+ */ + _FinalStage updatedAt(Optional updatedAt); + + _FinalStage updatedAt(Integer updatedAt); + + /** + *

Teammate who created the attribute. Only applicable to CDAs

+ */ + _FinalStage adminId(Optional adminId); + + _FinalStage adminId(String adminId); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements NameStage, FullNameStage, LabelStage, DataTypeStage, _FinalStage { + private String name; + + private String fullName; + + private String label; + + private DataType dataType; + + private Optional adminId = Optional.empty(); + + private Optional updatedAt = Optional.empty(); + + private Optional createdAt = Optional.empty(); + + private Optional archived = Optional.empty(); + + private Optional custom = Optional.empty(); + + private Optional uiWritable = Optional.empty(); + + private Optional messengerWritable = Optional.empty(); + + private Optional apiWritable = Optional.empty(); + + private Optional> options = Optional.empty(); + + private Optional description = Optional.empty(); + + private Optional model = Optional.empty(); + + private Optional id = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(DataAttribute other) { + id(other.getId()); + model(other.getModel()); + name(other.getName()); + fullName(other.getFullName()); + label(other.getLabel()); + description(other.getDescription()); + dataType(other.getDataType()); + options(other.getOptions()); + apiWritable(other.getApiWritable()); + messengerWritable(other.getMessengerWritable()); + uiWritable(other.getUiWritable()); + custom(other.getCustom()); + archived(other.getArchived()); + createdAt(other.getCreatedAt()); + updatedAt(other.getUpdatedAt()); + adminId(other.getAdminId()); + return this; + } + + /** + *

Name of the attribute.

+ *

Name of the attribute.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("name") + public FullNameStage name(@NotNull String name) { + this.name = Objects.requireNonNull(name, "name must not be null"); + return this; + } + + /** + *

Full name of the attribute. Should match the name unless it's a nested attribute. We can split full_name on . to access nested user object values.

+ *

Full name of the attribute. Should match the name unless it's a nested attribute. We can split full_name on . to access nested user object values.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("full_name") + public LabelStage fullName(@NotNull String fullName) { + this.fullName = Objects.requireNonNull(fullName, "fullName must not be null"); + return this; + } + + /** + *

Readable name of the attribute (i.e. name you see in the UI)

+ *

Readable name of the attribute (i.e. name you see in the UI)

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("label") + public DataTypeStage label(@NotNull String label) { + this.label = Objects.requireNonNull(label, "label must not be null"); + return this; + } + + /** + *

The data type of the attribute.

+ *

The data type of the attribute.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("data_type") + public _FinalStage dataType(@NotNull DataType dataType) { + this.dataType = Objects.requireNonNull(dataType, "dataType must not be null"); + return this; + } + + /** + *

Teammate who created the attribute. Only applicable to CDAs

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage adminId(String adminId) { + this.adminId = Optional.ofNullable(adminId); + return this; + } + + /** + *

Teammate who created the attribute. Only applicable to CDAs

+ */ + @java.lang.Override + @JsonSetter(value = "admin_id", nulls = Nulls.SKIP) + public _FinalStage adminId(Optional adminId) { + this.adminId = adminId; + return this; + } + + /** + *

The time the attribute was last updated as a UTC Unix timestamp

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage updatedAt(Integer updatedAt) { + this.updatedAt = Optional.ofNullable(updatedAt); + return this; + } + + /** + *

The time the attribute was last updated as a UTC Unix timestamp

+ */ + @java.lang.Override + @JsonSetter(value = "updated_at", nulls = Nulls.SKIP) + public _FinalStage updatedAt(Optional updatedAt) { + this.updatedAt = updatedAt; + return this; + } + + /** + *

The time the attribute was created as a UTC Unix timestamp

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage createdAt(Integer createdAt) { + this.createdAt = Optional.ofNullable(createdAt); + return this; + } + + /** + *

The time the attribute was created as a UTC Unix timestamp

+ */ + @java.lang.Override + @JsonSetter(value = "created_at", nulls = Nulls.SKIP) + public _FinalStage createdAt(Optional createdAt) { + this.createdAt = createdAt; + return this; + } + + /** + *

Is this attribute archived. (Only applicable to CDAs)

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage archived(Boolean archived) { + this.archived = Optional.ofNullable(archived); + return this; + } + + /** + *

Is this attribute archived. (Only applicable to CDAs)

+ */ + @java.lang.Override + @JsonSetter(value = "archived", nulls = Nulls.SKIP) + public _FinalStage archived(Optional archived) { + this.archived = archived; + return this; + } + + /** + *

Set to true if this is a CDA

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage custom(Boolean custom) { + this.custom = Optional.ofNullable(custom); + return this; + } + + /** + *

Set to true if this is a CDA

+ */ + @java.lang.Override + @JsonSetter(value = "custom", nulls = Nulls.SKIP) + public _FinalStage custom(Optional custom) { + this.custom = custom; + return this; + } + + /** + *

Can this attribute be updated in the UI

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage uiWritable(Boolean uiWritable) { + this.uiWritable = Optional.ofNullable(uiWritable); + return this; + } + + /** + *

Can this attribute be updated in the UI

+ */ + @java.lang.Override + @JsonSetter(value = "ui_writable", nulls = Nulls.SKIP) + public _FinalStage uiWritable(Optional uiWritable) { + this.uiWritable = uiWritable; + return this; + } + + /** + *

Can this attribute be updated by the Messenger

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage messengerWritable(Boolean messengerWritable) { + this.messengerWritable = Optional.ofNullable(messengerWritable); + return this; + } + + /** + *

Can this attribute be updated by the Messenger

+ */ + @java.lang.Override + @JsonSetter(value = "messenger_writable", nulls = Nulls.SKIP) + public _FinalStage messengerWritable(Optional messengerWritable) { + this.messengerWritable = messengerWritable; + return this; + } + + /** + *

Can this attribute be updated through API

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage apiWritable(Boolean apiWritable) { + this.apiWritable = Optional.ofNullable(apiWritable); + return this; + } + + /** + *

Can this attribute be updated through API

+ */ + @java.lang.Override + @JsonSetter(value = "api_writable", nulls = Nulls.SKIP) + public _FinalStage apiWritable(Optional apiWritable) { + this.apiWritable = apiWritable; + return this; + } + + /** + *

List of predefined options for attribute value.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage options(List options) { + this.options = Optional.ofNullable(options); + return this; + } + + /** + *

List of predefined options for attribute value.

+ */ + @java.lang.Override + @JsonSetter(value = "options", nulls = Nulls.SKIP) + public _FinalStage options(Optional> options) { + this.options = options; + return this; + } + + /** + *

Readable description of the attribute.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage description(String description) { + this.description = Optional.ofNullable(description); + return this; + } + + /** + *

Readable description of the attribute.

+ */ + @java.lang.Override + @JsonSetter(value = "description", nulls = Nulls.SKIP) + public _FinalStage description(Optional description) { + this.description = description; + return this; + } + + /** + *

Value is contact for user/lead attributes and company for company attributes.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage model(Model model) { + this.model = Optional.ofNullable(model); + return this; + } + + /** + *

Value is contact for user/lead attributes and company for company attributes.

+ */ + @java.lang.Override + @JsonSetter(value = "model", nulls = Nulls.SKIP) + public _FinalStage model(Optional model) { + this.model = model; + return this; + } + + /** + *

The unique identifier for the data attribute which is given by Intercom. Only available for custom attributes.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage id(Integer id) { + this.id = Optional.ofNullable(id); + return this; + } + + /** + *

The unique identifier for the data attribute which is given by Intercom. Only available for custom attributes.

+ */ + @java.lang.Override + @JsonSetter(value = "id", nulls = Nulls.SKIP) + public _FinalStage id(Optional id) { + this.id = id; + return this; + } + + @java.lang.Override + public DataAttribute build() { + return new DataAttribute( + id, + model, + name, + fullName, + label, + description, + dataType, + options, + apiWritable, + messengerWritable, + uiWritable, + custom, + archived, + createdAt, + updatedAt, + adminId, + additionalProperties); + } + } + + public static final class Model { + public static final Model CONTACT = new Model(Value.CONTACT, "contact"); + + public static final Model COMPANY = new Model(Value.COMPANY, "company"); + + private final Value value; + + private final String string; + + Model(Value value, String string) { + this.value = value; + this.string = string; + } + + public Value getEnumValue() { + return value; + } + + @java.lang.Override + @JsonValue + public String toString() { + return this.string; + } + + @java.lang.Override + public boolean equals(Object other) { + return (this == other) || (other instanceof Model && this.string.equals(((Model) other).string)); + } + + @java.lang.Override + public int hashCode() { + return this.string.hashCode(); + } + + public T visit(Visitor visitor) { + switch (value) { + case CONTACT: + return visitor.visitContact(); + case COMPANY: + return visitor.visitCompany(); + case UNKNOWN: + default: + return visitor.visitUnknown(string); + } + } + + @JsonCreator(mode = JsonCreator.Mode.DELEGATING) + public static Model valueOf(String value) { + switch (value) { + case "contact": + return CONTACT; + case "company": + return COMPANY; + default: + return new Model(Value.UNKNOWN, value); + } + } + + public enum Value { + CONTACT, + + COMPANY, + + UNKNOWN + } + + public interface Visitor { + T visitContact(); + + T visitCompany(); + + T visitUnknown(String unknownType); + } + } + + public static final class DataType { + public static final DataType STRING = new DataType(Value.STRING, "string"); + + public static final DataType FLOAT = new DataType(Value.FLOAT, "float"); + + public static final DataType INTEGER = new DataType(Value.INTEGER, "integer"); + + public static final DataType BOOLEAN = new DataType(Value.BOOLEAN, "boolean"); + + public static final DataType DATE = new DataType(Value.DATE, "date"); + + private final Value value; + + private final String string; + + DataType(Value value, String string) { + this.value = value; + this.string = string; + } + + public Value getEnumValue() { + return value; + } + + @java.lang.Override + @JsonValue + public String toString() { + return this.string; + } + + @java.lang.Override + public boolean equals(Object other) { + return (this == other) || (other instanceof DataType && this.string.equals(((DataType) other).string)); + } + + @java.lang.Override + public int hashCode() { + return this.string.hashCode(); + } + + public T visit(Visitor visitor) { + switch (value) { + case STRING: + return visitor.visitString(); + case FLOAT: + return visitor.visitFloat(); + case INTEGER: + return visitor.visitInteger(); + case BOOLEAN: + return visitor.visitBoolean(); + case DATE: + return visitor.visitDate(); + case UNKNOWN: + default: + return visitor.visitUnknown(string); + } + } + + @JsonCreator(mode = JsonCreator.Mode.DELEGATING) + public static DataType valueOf(String value) { + switch (value) { + case "string": + return STRING; + case "float": + return FLOAT; + case "integer": + return INTEGER; + case "boolean": + return BOOLEAN; + case "date": + return DATE; + default: + return new DataType(Value.UNKNOWN, value); + } + } + + public enum Value { + STRING, + + INTEGER, + + FLOAT, + + BOOLEAN, + + DATE, + + UNKNOWN + } + + public interface Visitor { + T visitString(); + + T visitInteger(); + + T visitFloat(); + + T visitBoolean(); + + T visitDate(); + + T visitUnknown(String unknownType); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/dataattributes/types/DataAttributesListRequestModel.java b/src/main/java/com/intercom/api/resources/dataattributes/types/DataAttributesListRequestModel.java new file mode 100644 index 00000000..9180fe18 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/dataattributes/types/DataAttributesListRequestModel.java @@ -0,0 +1,97 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.dataattributes.types; + +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonValue; + +public final class DataAttributesListRequestModel { + public static final DataAttributesListRequestModel CONTACT = + new DataAttributesListRequestModel(Value.CONTACT, "contact"); + + public static final DataAttributesListRequestModel CONVERSATION = + new DataAttributesListRequestModel(Value.CONVERSATION, "conversation"); + + public static final DataAttributesListRequestModel COMPANY = + new DataAttributesListRequestModel(Value.COMPANY, "company"); + + private final Value value; + + private final String string; + + DataAttributesListRequestModel(Value value, String string) { + this.value = value; + this.string = string; + } + + public Value getEnumValue() { + return value; + } + + @java.lang.Override + @JsonValue + public String toString() { + return this.string; + } + + @java.lang.Override + public boolean equals(Object other) { + return (this == other) + || (other instanceof DataAttributesListRequestModel + && this.string.equals(((DataAttributesListRequestModel) other).string)); + } + + @java.lang.Override + public int hashCode() { + return this.string.hashCode(); + } + + public T visit(Visitor visitor) { + switch (value) { + case CONTACT: + return visitor.visitContact(); + case CONVERSATION: + return visitor.visitConversation(); + case COMPANY: + return visitor.visitCompany(); + case UNKNOWN: + default: + return visitor.visitUnknown(string); + } + } + + @JsonCreator(mode = JsonCreator.Mode.DELEGATING) + public static DataAttributesListRequestModel valueOf(String value) { + switch (value) { + case "contact": + return CONTACT; + case "conversation": + return CONVERSATION; + case "company": + return COMPANY; + default: + return new DataAttributesListRequestModel(Value.UNKNOWN, value); + } + } + + public enum Value { + CONTACT, + + COMPANY, + + CONVERSATION, + + UNKNOWN + } + + public interface Visitor { + T visitContact(); + + T visitCompany(); + + T visitConversation(); + + T visitUnknown(String unknownType); + } +} diff --git a/src/main/java/com/intercom/api/resources/dataevents/types/DataEvent.java b/src/main/java/com/intercom/api/resources/dataevents/types/DataEvent.java new file mode 100644 index 00000000..dd41d0a3 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/dataevents/types/DataEvent.java @@ -0,0 +1,377 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.dataevents.types; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = DataEvent.Builder.class) +public final class DataEvent { + private final String eventName; + + private final int createdAt; + + private final Optional userId; + + private final Optional id; + + private final Optional intercomUserId; + + private final Optional email; + + private final Optional> metadata; + + private final Map additionalProperties; + + private DataEvent( + String eventName, + int createdAt, + Optional userId, + Optional id, + Optional intercomUserId, + Optional email, + Optional> metadata, + Map additionalProperties) { + this.eventName = eventName; + this.createdAt = createdAt; + this.userId = userId; + this.id = id; + this.intercomUserId = intercomUserId; + this.email = email; + this.metadata = metadata; + this.additionalProperties = additionalProperties; + } + + /** + * @return The type of the object + */ + @JsonProperty("type") + public String getType() { + return "event"; + } + + /** + * @return The name of the event that occurred. This is presented to your App's admins when filtering and creating segments - a good event name is typically a past tense 'verb-noun' combination, to improve readability, for example updated-plan. + */ + @JsonProperty("event_name") + public String getEventName() { + return eventName; + } + + /** + * @return The time the event occurred as a UTC Unix timestamp + */ + @JsonProperty("created_at") + public int getCreatedAt() { + return createdAt; + } + + /** + * @return Your identifier for the user. + */ + @JsonProperty("user_id") + public Optional getUserId() { + return userId; + } + + /** + * @return Your identifier for a lead or a user. + */ + @JsonProperty("id") + public Optional getId() { + return id; + } + + /** + * @return The Intercom identifier for the user. + */ + @JsonProperty("intercom_user_id") + public Optional getIntercomUserId() { + return intercomUserId; + } + + /** + * @return An email address for your user. An email should only be used where your application uses email to uniquely identify users. + */ + @JsonProperty("email") + public Optional getEmail() { + return email; + } + + /** + * @return Optional metadata about the event. + */ + @JsonProperty("metadata") + public Optional> getMetadata() { + return metadata; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof DataEvent && equalTo((DataEvent) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(DataEvent other) { + return eventName.equals(other.eventName) + && createdAt == other.createdAt + && userId.equals(other.userId) + && id.equals(other.id) + && intercomUserId.equals(other.intercomUserId) + && email.equals(other.email) + && metadata.equals(other.metadata); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash( + this.eventName, this.createdAt, this.userId, this.id, this.intercomUserId, this.email, this.metadata); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static EventNameStage builder() { + return new Builder(); + } + + public interface EventNameStage { + /** + *

The name of the event that occurred. This is presented to your App's admins when filtering and creating segments - a good event name is typically a past tense 'verb-noun' combination, to improve readability, for example updated-plan.

+ */ + CreatedAtStage eventName(@NotNull String eventName); + + Builder from(DataEvent other); + } + + public interface CreatedAtStage { + /** + *

The time the event occurred as a UTC Unix timestamp

+ */ + _FinalStage createdAt(int createdAt); + } + + public interface _FinalStage { + DataEvent build(); + + /** + *

Your identifier for the user.

+ */ + _FinalStage userId(Optional userId); + + _FinalStage userId(String userId); + + /** + *

Your identifier for a lead or a user.

+ */ + _FinalStage id(Optional id); + + _FinalStage id(String id); + + /** + *

The Intercom identifier for the user.

+ */ + _FinalStage intercomUserId(Optional intercomUserId); + + _FinalStage intercomUserId(String intercomUserId); + + /** + *

An email address for your user. An email should only be used where your application uses email to uniquely identify users.

+ */ + _FinalStage email(Optional email); + + _FinalStage email(String email); + + /** + *

Optional metadata about the event.

+ */ + _FinalStage metadata(Optional> metadata); + + _FinalStage metadata(Map metadata); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements EventNameStage, CreatedAtStage, _FinalStage { + private String eventName; + + private int createdAt; + + private Optional> metadata = Optional.empty(); + + private Optional email = Optional.empty(); + + private Optional intercomUserId = Optional.empty(); + + private Optional id = Optional.empty(); + + private Optional userId = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(DataEvent other) { + eventName(other.getEventName()); + createdAt(other.getCreatedAt()); + userId(other.getUserId()); + id(other.getId()); + intercomUserId(other.getIntercomUserId()); + email(other.getEmail()); + metadata(other.getMetadata()); + return this; + } + + /** + *

The name of the event that occurred. This is presented to your App's admins when filtering and creating segments - a good event name is typically a past tense 'verb-noun' combination, to improve readability, for example updated-plan.

+ *

The name of the event that occurred. This is presented to your App's admins when filtering and creating segments - a good event name is typically a past tense 'verb-noun' combination, to improve readability, for example updated-plan.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("event_name") + public CreatedAtStage eventName(@NotNull String eventName) { + this.eventName = Objects.requireNonNull(eventName, "eventName must not be null"); + return this; + } + + /** + *

The time the event occurred as a UTC Unix timestamp

+ *

The time the event occurred as a UTC Unix timestamp

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("created_at") + public _FinalStage createdAt(int createdAt) { + this.createdAt = createdAt; + return this; + } + + /** + *

Optional metadata about the event.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage metadata(Map metadata) { + this.metadata = Optional.ofNullable(metadata); + return this; + } + + /** + *

Optional metadata about the event.

+ */ + @java.lang.Override + @JsonSetter(value = "metadata", nulls = Nulls.SKIP) + public _FinalStage metadata(Optional> metadata) { + this.metadata = metadata; + return this; + } + + /** + *

An email address for your user. An email should only be used where your application uses email to uniquely identify users.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage email(String email) { + this.email = Optional.ofNullable(email); + return this; + } + + /** + *

An email address for your user. An email should only be used where your application uses email to uniquely identify users.

+ */ + @java.lang.Override + @JsonSetter(value = "email", nulls = Nulls.SKIP) + public _FinalStage email(Optional email) { + this.email = email; + return this; + } + + /** + *

The Intercom identifier for the user.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage intercomUserId(String intercomUserId) { + this.intercomUserId = Optional.ofNullable(intercomUserId); + return this; + } + + /** + *

The Intercom identifier for the user.

+ */ + @java.lang.Override + @JsonSetter(value = "intercom_user_id", nulls = Nulls.SKIP) + public _FinalStage intercomUserId(Optional intercomUserId) { + this.intercomUserId = intercomUserId; + return this; + } + + /** + *

Your identifier for a lead or a user.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage id(String id) { + this.id = Optional.ofNullable(id); + return this; + } + + /** + *

Your identifier for a lead or a user.

+ */ + @java.lang.Override + @JsonSetter(value = "id", nulls = Nulls.SKIP) + public _FinalStage id(Optional id) { + this.id = id; + return this; + } + + /** + *

Your identifier for the user.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage userId(String userId) { + this.userId = Optional.ofNullable(userId); + return this; + } + + /** + *

Your identifier for the user.

+ */ + @java.lang.Override + @JsonSetter(value = "user_id", nulls = Nulls.SKIP) + public _FinalStage userId(Optional userId) { + this.userId = userId; + return this; + } + + @java.lang.Override + public DataEvent build() { + return new DataEvent( + eventName, createdAt, userId, id, intercomUserId, email, metadata, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/dataexport/AsyncDataExportClient.java b/src/main/java/com/intercom/api/resources/dataexport/AsyncDataExportClient.java new file mode 100644 index 00000000..e5cde461 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/dataexport/AsyncDataExportClient.java @@ -0,0 +1,171 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.dataexport; + +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.resources.dataexport.requests.CancelDataExportRequest; +import com.intercom.api.resources.dataexport.requests.CreateDataExportRequest; +import com.intercom.api.resources.dataexport.requests.DownloadDataExportRequest; +import com.intercom.api.resources.dataexport.requests.DownloadReportingDataExportRequest; +import com.intercom.api.resources.dataexport.requests.ExportReportingDataRequest; +import com.intercom.api.resources.dataexport.requests.FindDataExportRequest; +import com.intercom.api.resources.dataexport.types.DataExport; +import com.intercom.api.resources.dataexport.types.DataExportExportReportingDataResponse; +import java.util.concurrent.CompletableFuture; + +public class AsyncDataExportClient { + protected final ClientOptions clientOptions; + + private final AsyncRawDataExportClient rawClient; + + public AsyncDataExportClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + this.rawClient = new AsyncRawDataExportClient(clientOptions); + } + + /** + * Get responses with HTTP metadata like headers + */ + public AsyncRawDataExportClient withRawResponse() { + return this.rawClient; + } + + public CompletableFuture exportReportingData( + ExportReportingDataRequest request) { + return this.rawClient.exportReportingData(request).thenApply(response -> response.body()); + } + + public CompletableFuture exportReportingData( + ExportReportingDataRequest request, RequestOptions requestOptions) { + return this.rawClient.exportReportingData(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * Download the data from a completed reporting data export job. + *
+ *

Octet header required

+ *

You will have to specify the header Accept: application/octet-stream when hitting this endpoint.

+ *
+ */ + public CompletableFuture downloadReportingDataExport(DownloadReportingDataExportRequest request) { + return this.rawClient.downloadReportingDataExport(request).thenApply(response -> response.body()); + } + + /** + * Download the data from a completed reporting data export job. + *
+ *

Octet header required

+ *

You will have to specify the header Accept: application/octet-stream when hitting this endpoint.

+ *
+ */ + public CompletableFuture downloadReportingDataExport( + DownloadReportingDataExportRequest request, RequestOptions requestOptions) { + return this.rawClient + .downloadReportingDataExport(request, requestOptions) + .thenApply(response -> response.body()); + } + + /** + * To create your export job, you need to send a POST request to the export endpoint https://api.intercom.io/export/content/data. + *

The only parameters you need to provide are the range of dates that you want exported.

+ *
+ *

🚧 Limit of one active job

+ *

You can only have one active job per workspace. You will receive a HTTP status code of 429 with the message Exceeded rate limit of 1 pending message data export jobs if you attempt to create a second concurrent job.

+ *
+ *
+ *

❗️ Updated_at not included

+ *

It should be noted that the timeframe only includes messages sent during the time period and not messages that were only updated during this period. For example, if a message was updated yesterday but sent two days ago, you would need to set the created_at_after date before the message was sent to include that in your retrieval job.

+ *
+ *
+ *

📘 Date ranges are inclusive

+ *

Requesting data for 2018-06-01 until 2018-06-30 will get all data for those days including those specified - e.g. 2018-06-01 00:00:00 until 2018-06-30 23:59:99.

+ *
+ */ + public CompletableFuture create(CreateDataExportRequest request) { + return this.rawClient.create(request).thenApply(response -> response.body()); + } + + /** + * To create your export job, you need to send a POST request to the export endpoint https://api.intercom.io/export/content/data. + *

The only parameters you need to provide are the range of dates that you want exported.

+ *
+ *

🚧 Limit of one active job

+ *

You can only have one active job per workspace. You will receive a HTTP status code of 429 with the message Exceeded rate limit of 1 pending message data export jobs if you attempt to create a second concurrent job.

+ *
+ *
+ *

❗️ Updated_at not included

+ *

It should be noted that the timeframe only includes messages sent during the time period and not messages that were only updated during this period. For example, if a message was updated yesterday but sent two days ago, you would need to set the created_at_after date before the message was sent to include that in your retrieval job.

+ *
+ *
+ *

📘 Date ranges are inclusive

+ *

Requesting data for 2018-06-01 until 2018-06-30 will get all data for those days including those specified - e.g. 2018-06-01 00:00:00 until 2018-06-30 23:59:99.

+ *
+ */ + public CompletableFuture create(CreateDataExportRequest request, RequestOptions requestOptions) { + return this.rawClient.create(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can view the status of your job by sending a GET request to the URL + * https://api.intercom.io/export/content/data/{job_identifier} - the {job_identifier} is the value returned in the response when you first created the export job. More on it can be seen in the Export Job Model. + *
+ *

🚧 Jobs expire after two days + * All jobs that have completed processing (and are thus available to download from the provided URL) will have an expiry limit of two days from when the export ob completed. After this, the data will no longer be available.

+ *
+ */ + public CompletableFuture find(FindDataExportRequest request) { + return this.rawClient.find(request).thenApply(response -> response.body()); + } + + /** + * You can view the status of your job by sending a GET request to the URL + * https://api.intercom.io/export/content/data/{job_identifier} - the {job_identifier} is the value returned in the response when you first created the export job. More on it can be seen in the Export Job Model. + *
+ *

🚧 Jobs expire after two days + * All jobs that have completed processing (and are thus available to download from the provided URL) will have an expiry limit of two days from when the export ob completed. After this, the data will no longer be available.

+ *
+ */ + public CompletableFuture find(FindDataExportRequest request, RequestOptions requestOptions) { + return this.rawClient.find(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can cancel your job + */ + public CompletableFuture cancel(CancelDataExportRequest request) { + return this.rawClient.cancel(request).thenApply(response -> response.body()); + } + + /** + * You can cancel your job + */ + public CompletableFuture cancel(CancelDataExportRequest request, RequestOptions requestOptions) { + return this.rawClient.cancel(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * When a job has a status of complete, and thus a filled download_url, you can download your data by hitting that provided URL, formatted like so: https://api.intercom.io/download/content/data/xyz1234. + *

Your exported message data will be streamed continuously back down to you in a gzipped CSV format.

+ *
+ *

📘 Octet header required

+ *

You will have to specify the header Accept: application/octet-stream when hitting this endpoint.

+ *
+ */ + public CompletableFuture download(DownloadDataExportRequest request) { + return this.rawClient.download(request).thenApply(response -> response.body()); + } + + /** + * When a job has a status of complete, and thus a filled download_url, you can download your data by hitting that provided URL, formatted like so: https://api.intercom.io/download/content/data/xyz1234. + *

Your exported message data will be streamed continuously back down to you in a gzipped CSV format.

+ *
+ *

📘 Octet header required

+ *

You will have to specify the header Accept: application/octet-stream when hitting this endpoint.

+ *
+ */ + public CompletableFuture download(DownloadDataExportRequest request, RequestOptions requestOptions) { + return this.rawClient.download(request, requestOptions).thenApply(response -> response.body()); + } +} diff --git a/src/main/java/com/intercom/api/resources/dataexport/AsyncRawDataExportClient.java b/src/main/java/com/intercom/api/resources/dataexport/AsyncRawDataExportClient.java new file mode 100644 index 00000000..732c3732 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/dataexport/AsyncRawDataExportClient.java @@ -0,0 +1,450 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.dataexport; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.IntercomApiException; +import com.intercom.api.core.IntercomException; +import com.intercom.api.core.IntercomHttpResponse; +import com.intercom.api.core.MediaTypes; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.core.QueryStringMapper; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.errors.NotFoundError; +import com.intercom.api.resources.dataexport.requests.CancelDataExportRequest; +import com.intercom.api.resources.dataexport.requests.CreateDataExportRequest; +import com.intercom.api.resources.dataexport.requests.DownloadDataExportRequest; +import com.intercom.api.resources.dataexport.requests.DownloadReportingDataExportRequest; +import com.intercom.api.resources.dataexport.requests.ExportReportingDataRequest; +import com.intercom.api.resources.dataexport.requests.FindDataExportRequest; +import com.intercom.api.resources.dataexport.types.DataExport; +import com.intercom.api.resources.dataexport.types.DataExportExportReportingDataResponse; +import java.io.IOException; +import java.util.concurrent.CompletableFuture; +import okhttp3.Call; +import okhttp3.Callback; +import okhttp3.Headers; +import okhttp3.HttpUrl; +import okhttp3.OkHttpClient; +import okhttp3.Request; +import okhttp3.RequestBody; +import okhttp3.Response; +import okhttp3.ResponseBody; +import org.jetbrains.annotations.NotNull; + +public class AsyncRawDataExportClient { + protected final ClientOptions clientOptions; + + public AsyncRawDataExportClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + } + + public CompletableFuture> exportReportingData( + ExportReportingDataRequest request) { + return exportReportingData(request, null); + } + + public CompletableFuture> exportReportingData( + ExportReportingDataRequest request, RequestOptions requestOptions) { + HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("export/reporting_data") + .addPathSegment(request.getJobIdentifier()); + QueryStringMapper.addQueryParameter(httpUrl, "app_id", request.getAppId(), false); + QueryStringMapper.addQueryParameter(httpUrl, "client_id", request.getClientId(), false); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl.build()) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = + new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue( + responseBodyString, DataExportExportReportingDataResponse.class), + response)); + return; + } + try { + if (response.code() == 404) { + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * Download the data from a completed reporting data export job. + *
+ *

Octet header required

+ *

You will have to specify the header Accept: application/octet-stream when hitting this endpoint.

+ *
+ */ + public CompletableFuture> downloadReportingDataExport( + DownloadReportingDataExportRequest request) { + return downloadReportingDataExport(request, null); + } + + /** + * Download the data from a completed reporting data export job. + *
+ *

Octet header required

+ *

You will have to specify the header Accept: application/octet-stream when hitting this endpoint.

+ *
+ */ + public CompletableFuture> downloadReportingDataExport( + DownloadReportingDataExportRequest request, RequestOptions requestOptions) { + HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("download/reporting_data") + .addPathSegment(request.getJobIdentifier()); + QueryStringMapper.addQueryParameter(httpUrl, "app_id", request.getAppId(), false); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl.build()) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + _requestBuilder.addHeader("accept", request.getAccept()); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>(null, response)); + return; + } + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + try { + if (response.code() == 404) { + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * To create your export job, you need to send a POST request to the export endpoint https://api.intercom.io/export/content/data. + *

The only parameters you need to provide are the range of dates that you want exported.

+ *
+ *

🚧 Limit of one active job

+ *

You can only have one active job per workspace. You will receive a HTTP status code of 429 with the message Exceeded rate limit of 1 pending message data export jobs if you attempt to create a second concurrent job.

+ *
+ *
+ *

❗️ Updated_at not included

+ *

It should be noted that the timeframe only includes messages sent during the time period and not messages that were only updated during this period. For example, if a message was updated yesterday but sent two days ago, you would need to set the created_at_after date before the message was sent to include that in your retrieval job.

+ *
+ *
+ *

📘 Date ranges are inclusive

+ *

Requesting data for 2018-06-01 until 2018-06-30 will get all data for those days including those specified - e.g. 2018-06-01 00:00:00 until 2018-06-30 23:59:99.

+ *
+ */ + public CompletableFuture> create(CreateDataExportRequest request) { + return create(request, null); + } + + /** + * To create your export job, you need to send a POST request to the export endpoint https://api.intercom.io/export/content/data. + *

The only parameters you need to provide are the range of dates that you want exported.

+ *
+ *

🚧 Limit of one active job

+ *

You can only have one active job per workspace. You will receive a HTTP status code of 429 with the message Exceeded rate limit of 1 pending message data export jobs if you attempt to create a second concurrent job.

+ *
+ *
+ *

❗️ Updated_at not included

+ *

It should be noted that the timeframe only includes messages sent during the time period and not messages that were only updated during this period. For example, if a message was updated yesterday but sent two days ago, you would need to set the created_at_after date before the message was sent to include that in your retrieval job.

+ *
+ *
+ *

📘 Date ranges are inclusive

+ *

Requesting data for 2018-06-01 until 2018-06-30 will get all data for those days including those specified - e.g. 2018-06-01 00:00:00 until 2018-06-30 23:59:99.

+ *
+ */ + public CompletableFuture> create( + CreateDataExportRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("export/content/data") + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, DataExport.class), response)); + return; + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can view the status of your job by sending a GET request to the URL + * https://api.intercom.io/export/content/data/{job_identifier} - the {job_identifier} is the value returned in the response when you first created the export job. More on it can be seen in the Export Job Model. + *
+ *

🚧 Jobs expire after two days + * All jobs that have completed processing (and are thus available to download from the provided URL) will have an expiry limit of two days from when the export ob completed. After this, the data will no longer be available.

+ *
+ */ + public CompletableFuture> find(FindDataExportRequest request) { + return find(request, null); + } + + /** + * You can view the status of your job by sending a GET request to the URL + * https://api.intercom.io/export/content/data/{job_identifier} - the {job_identifier} is the value returned in the response when you first created the export job. More on it can be seen in the Export Job Model. + *
+ *

🚧 Jobs expire after two days + * All jobs that have completed processing (and are thus available to download from the provided URL) will have an expiry limit of two days from when the export ob completed. After this, the data will no longer be available.

+ *
+ */ + public CompletableFuture> find( + FindDataExportRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("export/content/data") + .addPathSegment(request.getJobIdentifier()) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, DataExport.class), response)); + return; + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can cancel your job + */ + public CompletableFuture> cancel(CancelDataExportRequest request) { + return cancel(request, null); + } + + /** + * You can cancel your job + */ + public CompletableFuture> cancel( + CancelDataExportRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("export/cancel") + .addPathSegment(request.getJobIdentifier()) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("POST", RequestBody.create("", null)) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, DataExport.class), response)); + return; + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * When a job has a status of complete, and thus a filled download_url, you can download your data by hitting that provided URL, formatted like so: https://api.intercom.io/download/content/data/xyz1234. + *

Your exported message data will be streamed continuously back down to you in a gzipped CSV format.

+ *
+ *

📘 Octet header required

+ *

You will have to specify the header Accept: application/octet-stream when hitting this endpoint.

+ *
+ */ + public CompletableFuture> download(DownloadDataExportRequest request) { + return download(request, null); + } + + /** + * When a job has a status of complete, and thus a filled download_url, you can download your data by hitting that provided URL, formatted like so: https://api.intercom.io/download/content/data/xyz1234. + *

Your exported message data will be streamed continuously back down to you in a gzipped CSV format.

+ *
+ *

📘 Octet header required

+ *

You will have to specify the header Accept: application/octet-stream when hitting this endpoint.

+ *
+ */ + public CompletableFuture> download( + DownloadDataExportRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("download/content/data") + .addPathSegment(request.getJobIdentifier()) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>(null, response)); + return; + } + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } +} diff --git a/src/main/java/com/intercom/api/resources/dataexport/DataExportClient.java b/src/main/java/com/intercom/api/resources/dataexport/DataExportClient.java new file mode 100644 index 00000000..2aab00a8 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/dataexport/DataExportClient.java @@ -0,0 +1,166 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.dataexport; + +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.resources.dataexport.requests.CancelDataExportRequest; +import com.intercom.api.resources.dataexport.requests.CreateDataExportRequest; +import com.intercom.api.resources.dataexport.requests.DownloadDataExportRequest; +import com.intercom.api.resources.dataexport.requests.DownloadReportingDataExportRequest; +import com.intercom.api.resources.dataexport.requests.ExportReportingDataRequest; +import com.intercom.api.resources.dataexport.requests.FindDataExportRequest; +import com.intercom.api.resources.dataexport.types.DataExport; +import com.intercom.api.resources.dataexport.types.DataExportExportReportingDataResponse; + +public class DataExportClient { + protected final ClientOptions clientOptions; + + private final RawDataExportClient rawClient; + + public DataExportClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + this.rawClient = new RawDataExportClient(clientOptions); + } + + /** + * Get responses with HTTP metadata like headers + */ + public RawDataExportClient withRawResponse() { + return this.rawClient; + } + + public DataExportExportReportingDataResponse exportReportingData(ExportReportingDataRequest request) { + return this.rawClient.exportReportingData(request).body(); + } + + public DataExportExportReportingDataResponse exportReportingData( + ExportReportingDataRequest request, RequestOptions requestOptions) { + return this.rawClient.exportReportingData(request, requestOptions).body(); + } + + /** + * Download the data from a completed reporting data export job. + *
+ *

Octet header required

+ *

You will have to specify the header Accept: application/octet-stream when hitting this endpoint.

+ *
+ */ + public void downloadReportingDataExport(DownloadReportingDataExportRequest request) { + this.rawClient.downloadReportingDataExport(request).body(); + } + + /** + * Download the data from a completed reporting data export job. + *
+ *

Octet header required

+ *

You will have to specify the header Accept: application/octet-stream when hitting this endpoint.

+ *
+ */ + public void downloadReportingDataExport(DownloadReportingDataExportRequest request, RequestOptions requestOptions) { + this.rawClient.downloadReportingDataExport(request, requestOptions).body(); + } + + /** + * To create your export job, you need to send a POST request to the export endpoint https://api.intercom.io/export/content/data. + *

The only parameters you need to provide are the range of dates that you want exported.

+ *
+ *

🚧 Limit of one active job

+ *

You can only have one active job per workspace. You will receive a HTTP status code of 429 with the message Exceeded rate limit of 1 pending message data export jobs if you attempt to create a second concurrent job.

+ *
+ *
+ *

❗️ Updated_at not included

+ *

It should be noted that the timeframe only includes messages sent during the time period and not messages that were only updated during this period. For example, if a message was updated yesterday but sent two days ago, you would need to set the created_at_after date before the message was sent to include that in your retrieval job.

+ *
+ *
+ *

📘 Date ranges are inclusive

+ *

Requesting data for 2018-06-01 until 2018-06-30 will get all data for those days including those specified - e.g. 2018-06-01 00:00:00 until 2018-06-30 23:59:99.

+ *
+ */ + public DataExport create(CreateDataExportRequest request) { + return this.rawClient.create(request).body(); + } + + /** + * To create your export job, you need to send a POST request to the export endpoint https://api.intercom.io/export/content/data. + *

The only parameters you need to provide are the range of dates that you want exported.

+ *
+ *

🚧 Limit of one active job

+ *

You can only have one active job per workspace. You will receive a HTTP status code of 429 with the message Exceeded rate limit of 1 pending message data export jobs if you attempt to create a second concurrent job.

+ *
+ *
+ *

❗️ Updated_at not included

+ *

It should be noted that the timeframe only includes messages sent during the time period and not messages that were only updated during this period. For example, if a message was updated yesterday but sent two days ago, you would need to set the created_at_after date before the message was sent to include that in your retrieval job.

+ *
+ *
+ *

📘 Date ranges are inclusive

+ *

Requesting data for 2018-06-01 until 2018-06-30 will get all data for those days including those specified - e.g. 2018-06-01 00:00:00 until 2018-06-30 23:59:99.

+ *
+ */ + public DataExport create(CreateDataExportRequest request, RequestOptions requestOptions) { + return this.rawClient.create(request, requestOptions).body(); + } + + /** + * You can view the status of your job by sending a GET request to the URL + * https://api.intercom.io/export/content/data/{job_identifier} - the {job_identifier} is the value returned in the response when you first created the export job. More on it can be seen in the Export Job Model. + *
+ *

🚧 Jobs expire after two days + * All jobs that have completed processing (and are thus available to download from the provided URL) will have an expiry limit of two days from when the export ob completed. After this, the data will no longer be available.

+ *
+ */ + public DataExport find(FindDataExportRequest request) { + return this.rawClient.find(request).body(); + } + + /** + * You can view the status of your job by sending a GET request to the URL + * https://api.intercom.io/export/content/data/{job_identifier} - the {job_identifier} is the value returned in the response when you first created the export job. More on it can be seen in the Export Job Model. + *
+ *

🚧 Jobs expire after two days + * All jobs that have completed processing (and are thus available to download from the provided URL) will have an expiry limit of two days from when the export ob completed. After this, the data will no longer be available.

+ *
+ */ + public DataExport find(FindDataExportRequest request, RequestOptions requestOptions) { + return this.rawClient.find(request, requestOptions).body(); + } + + /** + * You can cancel your job + */ + public DataExport cancel(CancelDataExportRequest request) { + return this.rawClient.cancel(request).body(); + } + + /** + * You can cancel your job + */ + public DataExport cancel(CancelDataExportRequest request, RequestOptions requestOptions) { + return this.rawClient.cancel(request, requestOptions).body(); + } + + /** + * When a job has a status of complete, and thus a filled download_url, you can download your data by hitting that provided URL, formatted like so: https://api.intercom.io/download/content/data/xyz1234. + *

Your exported message data will be streamed continuously back down to you in a gzipped CSV format.

+ *
+ *

📘 Octet header required

+ *

You will have to specify the header Accept: application/octet-stream when hitting this endpoint.

+ *
+ */ + public void download(DownloadDataExportRequest request) { + this.rawClient.download(request).body(); + } + + /** + * When a job has a status of complete, and thus a filled download_url, you can download your data by hitting that provided URL, formatted like so: https://api.intercom.io/download/content/data/xyz1234. + *

Your exported message data will be streamed continuously back down to you in a gzipped CSV format.

+ *
+ *

📘 Octet header required

+ *

You will have to specify the header Accept: application/octet-stream when hitting this endpoint.

+ *
+ */ + public void download(DownloadDataExportRequest request, RequestOptions requestOptions) { + this.rawClient.download(request, requestOptions).body(); + } +} diff --git a/src/main/java/com/intercom/api/resources/dataexport/RawDataExportClient.java b/src/main/java/com/intercom/api/resources/dataexport/RawDataExportClient.java new file mode 100644 index 00000000..c04b729e --- /dev/null +++ b/src/main/java/com/intercom/api/resources/dataexport/RawDataExportClient.java @@ -0,0 +1,360 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.dataexport; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.IntercomApiException; +import com.intercom.api.core.IntercomException; +import com.intercom.api.core.IntercomHttpResponse; +import com.intercom.api.core.MediaTypes; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.core.QueryStringMapper; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.errors.NotFoundError; +import com.intercom.api.resources.dataexport.requests.CancelDataExportRequest; +import com.intercom.api.resources.dataexport.requests.CreateDataExportRequest; +import com.intercom.api.resources.dataexport.requests.DownloadDataExportRequest; +import com.intercom.api.resources.dataexport.requests.DownloadReportingDataExportRequest; +import com.intercom.api.resources.dataexport.requests.ExportReportingDataRequest; +import com.intercom.api.resources.dataexport.requests.FindDataExportRequest; +import com.intercom.api.resources.dataexport.types.DataExport; +import com.intercom.api.resources.dataexport.types.DataExportExportReportingDataResponse; +import java.io.IOException; +import okhttp3.Headers; +import okhttp3.HttpUrl; +import okhttp3.OkHttpClient; +import okhttp3.Request; +import okhttp3.RequestBody; +import okhttp3.Response; +import okhttp3.ResponseBody; + +public class RawDataExportClient { + protected final ClientOptions clientOptions; + + public RawDataExportClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + } + + public IntercomHttpResponse exportReportingData( + ExportReportingDataRequest request) { + return exportReportingData(request, null); + } + + public IntercomHttpResponse exportReportingData( + ExportReportingDataRequest request, RequestOptions requestOptions) { + HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("export/reporting_data") + .addPathSegment(request.getJobIdentifier()); + QueryStringMapper.addQueryParameter(httpUrl, "app_id", request.getAppId(), false); + QueryStringMapper.addQueryParameter(httpUrl, "client_id", request.getClientId(), false); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl.build()) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue( + responseBodyString, DataExportExportReportingDataResponse.class), + response); + } + try { + if (response.code() == 404) { + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * Download the data from a completed reporting data export job. + *
+ *

Octet header required

+ *

You will have to specify the header Accept: application/octet-stream when hitting this endpoint.

+ *
+ */ + public IntercomHttpResponse downloadReportingDataExport(DownloadReportingDataExportRequest request) { + return downloadReportingDataExport(request, null); + } + + /** + * Download the data from a completed reporting data export job. + *
+ *

Octet header required

+ *

You will have to specify the header Accept: application/octet-stream when hitting this endpoint.

+ *
+ */ + public IntercomHttpResponse downloadReportingDataExport( + DownloadReportingDataExportRequest request, RequestOptions requestOptions) { + HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("download/reporting_data") + .addPathSegment(request.getJobIdentifier()); + QueryStringMapper.addQueryParameter(httpUrl, "app_id", request.getAppId(), false); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl.build()) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + _requestBuilder.addHeader("accept", request.getAccept()); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + if (response.isSuccessful()) { + return new IntercomHttpResponse<>(null, response); + } + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + try { + if (response.code() == 404) { + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * To create your export job, you need to send a POST request to the export endpoint https://api.intercom.io/export/content/data. + *

The only parameters you need to provide are the range of dates that you want exported.

+ *
+ *

🚧 Limit of one active job

+ *

You can only have one active job per workspace. You will receive a HTTP status code of 429 with the message Exceeded rate limit of 1 pending message data export jobs if you attempt to create a second concurrent job.

+ *
+ *
+ *

❗️ Updated_at not included

+ *

It should be noted that the timeframe only includes messages sent during the time period and not messages that were only updated during this period. For example, if a message was updated yesterday but sent two days ago, you would need to set the created_at_after date before the message was sent to include that in your retrieval job.

+ *
+ *
+ *

📘 Date ranges are inclusive

+ *

Requesting data for 2018-06-01 until 2018-06-30 will get all data for those days including those specified - e.g. 2018-06-01 00:00:00 until 2018-06-30 23:59:99.

+ *
+ */ + public IntercomHttpResponse create(CreateDataExportRequest request) { + return create(request, null); + } + + /** + * To create your export job, you need to send a POST request to the export endpoint https://api.intercom.io/export/content/data. + *

The only parameters you need to provide are the range of dates that you want exported.

+ *
+ *

🚧 Limit of one active job

+ *

You can only have one active job per workspace. You will receive a HTTP status code of 429 with the message Exceeded rate limit of 1 pending message data export jobs if you attempt to create a second concurrent job.

+ *
+ *
+ *

❗️ Updated_at not included

+ *

It should be noted that the timeframe only includes messages sent during the time period and not messages that were only updated during this period. For example, if a message was updated yesterday but sent two days ago, you would need to set the created_at_after date before the message was sent to include that in your retrieval job.

+ *
+ *
+ *

📘 Date ranges are inclusive

+ *

Requesting data for 2018-06-01 until 2018-06-30 will get all data for those days including those specified - e.g. 2018-06-01 00:00:00 until 2018-06-30 23:59:99.

+ *
+ */ + public IntercomHttpResponse create(CreateDataExportRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("export/content/data") + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, DataExport.class), response); + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can view the status of your job by sending a GET request to the URL + * https://api.intercom.io/export/content/data/{job_identifier} - the {job_identifier} is the value returned in the response when you first created the export job. More on it can be seen in the Export Job Model. + *
+ *

🚧 Jobs expire after two days + * All jobs that have completed processing (and are thus available to download from the provided URL) will have an expiry limit of two days from when the export ob completed. After this, the data will no longer be available.

+ *
+ */ + public IntercomHttpResponse find(FindDataExportRequest request) { + return find(request, null); + } + + /** + * You can view the status of your job by sending a GET request to the URL + * https://api.intercom.io/export/content/data/{job_identifier} - the {job_identifier} is the value returned in the response when you first created the export job. More on it can be seen in the Export Job Model. + *
+ *

🚧 Jobs expire after two days + * All jobs that have completed processing (and are thus available to download from the provided URL) will have an expiry limit of two days from when the export ob completed. After this, the data will no longer be available.

+ *
+ */ + public IntercomHttpResponse find(FindDataExportRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("export/content/data") + .addPathSegment(request.getJobIdentifier()) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, DataExport.class), response); + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can cancel your job + */ + public IntercomHttpResponse cancel(CancelDataExportRequest request) { + return cancel(request, null); + } + + /** + * You can cancel your job + */ + public IntercomHttpResponse cancel(CancelDataExportRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("export/cancel") + .addPathSegment(request.getJobIdentifier()) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("POST", RequestBody.create("", null)) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, DataExport.class), response); + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * When a job has a status of complete, and thus a filled download_url, you can download your data by hitting that provided URL, formatted like so: https://api.intercom.io/download/content/data/xyz1234. + *

Your exported message data will be streamed continuously back down to you in a gzipped CSV format.

+ *
+ *

📘 Octet header required

+ *

You will have to specify the header Accept: application/octet-stream when hitting this endpoint.

+ *
+ */ + public IntercomHttpResponse download(DownloadDataExportRequest request) { + return download(request, null); + } + + /** + * When a job has a status of complete, and thus a filled download_url, you can download your data by hitting that provided URL, formatted like so: https://api.intercom.io/download/content/data/xyz1234. + *

Your exported message data will be streamed continuously back down to you in a gzipped CSV format.

+ *
+ *

📘 Octet header required

+ *

You will have to specify the header Accept: application/octet-stream when hitting this endpoint.

+ *
+ */ + public IntercomHttpResponse download(DownloadDataExportRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("download/content/data") + .addPathSegment(request.getJobIdentifier()) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + if (response.isSuccessful()) { + return new IntercomHttpResponse<>(null, response); + } + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/dataexport/requests/CancelDataExportRequest.java b/src/main/java/com/intercom/api/resources/dataexport/requests/CancelDataExportRequest.java new file mode 100644 index 00000000..1b215ec9 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/dataexport/requests/CancelDataExportRequest.java @@ -0,0 +1,113 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.dataexport.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = CancelDataExportRequest.Builder.class) +public final class CancelDataExportRequest { + private final String jobIdentifier; + + private final Map additionalProperties; + + private CancelDataExportRequest(String jobIdentifier, Map additionalProperties) { + this.jobIdentifier = jobIdentifier; + this.additionalProperties = additionalProperties; + } + + /** + * @return job_identifier + */ + @JsonProperty("job_identifier") + public String getJobIdentifier() { + return jobIdentifier; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof CancelDataExportRequest && equalTo((CancelDataExportRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(CancelDataExportRequest other) { + return jobIdentifier.equals(other.jobIdentifier); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.jobIdentifier); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static JobIdentifierStage builder() { + return new Builder(); + } + + public interface JobIdentifierStage { + /** + *

job_identifier

+ */ + _FinalStage jobIdentifier(@NotNull String jobIdentifier); + + Builder from(CancelDataExportRequest other); + } + + public interface _FinalStage { + CancelDataExportRequest build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements JobIdentifierStage, _FinalStage { + private String jobIdentifier; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(CancelDataExportRequest other) { + jobIdentifier(other.getJobIdentifier()); + return this; + } + + /** + *

job_identifier

+ *

job_identifier

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("job_identifier") + public _FinalStage jobIdentifier(@NotNull String jobIdentifier) { + this.jobIdentifier = Objects.requireNonNull(jobIdentifier, "jobIdentifier must not be null"); + return this; + } + + @java.lang.Override + public CancelDataExportRequest build() { + return new CancelDataExportRequest(jobIdentifier, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/dataexport/requests/CreateDataExportRequest.java b/src/main/java/com/intercom/api/resources/dataexport/requests/CreateDataExportRequest.java new file mode 100644 index 00000000..23da7f63 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/dataexport/requests/CreateDataExportRequest.java @@ -0,0 +1,145 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.dataexport.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = CreateDataExportRequest.Builder.class) +public final class CreateDataExportRequest { + private final int createdAtAfter; + + private final int createdAtBefore; + + private final Map additionalProperties; + + private CreateDataExportRequest(int createdAtAfter, int createdAtBefore, Map additionalProperties) { + this.createdAtAfter = createdAtAfter; + this.createdAtBefore = createdAtBefore; + this.additionalProperties = additionalProperties; + } + + /** + * @return The start date that you request data for. It must be formatted as a unix timestamp. + */ + @JsonProperty("created_at_after") + public int getCreatedAtAfter() { + return createdAtAfter; + } + + /** + * @return The end date that you request data for. It must be formatted as a unix timestamp. + */ + @JsonProperty("created_at_before") + public int getCreatedAtBefore() { + return createdAtBefore; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof CreateDataExportRequest && equalTo((CreateDataExportRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(CreateDataExportRequest other) { + return createdAtAfter == other.createdAtAfter && createdAtBefore == other.createdAtBefore; + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.createdAtAfter, this.createdAtBefore); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static CreatedAtAfterStage builder() { + return new Builder(); + } + + public interface CreatedAtAfterStage { + /** + *

The start date that you request data for. It must be formatted as a unix timestamp.

+ */ + CreatedAtBeforeStage createdAtAfter(int createdAtAfter); + + Builder from(CreateDataExportRequest other); + } + + public interface CreatedAtBeforeStage { + /** + *

The end date that you request data for. It must be formatted as a unix timestamp.

+ */ + _FinalStage createdAtBefore(int createdAtBefore); + } + + public interface _FinalStage { + CreateDataExportRequest build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements CreatedAtAfterStage, CreatedAtBeforeStage, _FinalStage { + private int createdAtAfter; + + private int createdAtBefore; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(CreateDataExportRequest other) { + createdAtAfter(other.getCreatedAtAfter()); + createdAtBefore(other.getCreatedAtBefore()); + return this; + } + + /** + *

The start date that you request data for. It must be formatted as a unix timestamp.

+ *

The start date that you request data for. It must be formatted as a unix timestamp.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("created_at_after") + public CreatedAtBeforeStage createdAtAfter(int createdAtAfter) { + this.createdAtAfter = createdAtAfter; + return this; + } + + /** + *

The end date that you request data for. It must be formatted as a unix timestamp.

+ *

The end date that you request data for. It must be formatted as a unix timestamp.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("created_at_before") + public _FinalStage createdAtBefore(int createdAtBefore) { + this.createdAtBefore = createdAtBefore; + return this; + } + + @java.lang.Override + public CreateDataExportRequest build() { + return new CreateDataExportRequest(createdAtAfter, createdAtBefore, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/dataexport/requests/DownloadDataExportRequest.java b/src/main/java/com/intercom/api/resources/dataexport/requests/DownloadDataExportRequest.java new file mode 100644 index 00000000..bfd5f327 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/dataexport/requests/DownloadDataExportRequest.java @@ -0,0 +1,113 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.dataexport.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = DownloadDataExportRequest.Builder.class) +public final class DownloadDataExportRequest { + private final String jobIdentifier; + + private final Map additionalProperties; + + private DownloadDataExportRequest(String jobIdentifier, Map additionalProperties) { + this.jobIdentifier = jobIdentifier; + this.additionalProperties = additionalProperties; + } + + /** + * @return job_identifier + */ + @JsonProperty("job_identifier") + public String getJobIdentifier() { + return jobIdentifier; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof DownloadDataExportRequest && equalTo((DownloadDataExportRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(DownloadDataExportRequest other) { + return jobIdentifier.equals(other.jobIdentifier); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.jobIdentifier); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static JobIdentifierStage builder() { + return new Builder(); + } + + public interface JobIdentifierStage { + /** + *

job_identifier

+ */ + _FinalStage jobIdentifier(@NotNull String jobIdentifier); + + Builder from(DownloadDataExportRequest other); + } + + public interface _FinalStage { + DownloadDataExportRequest build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements JobIdentifierStage, _FinalStage { + private String jobIdentifier; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(DownloadDataExportRequest other) { + jobIdentifier(other.getJobIdentifier()); + return this; + } + + /** + *

job_identifier

+ *

job_identifier

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("job_identifier") + public _FinalStage jobIdentifier(@NotNull String jobIdentifier) { + this.jobIdentifier = Objects.requireNonNull(jobIdentifier, "jobIdentifier must not be null"); + return this; + } + + @java.lang.Override + public DownloadDataExportRequest build() { + return new DownloadDataExportRequest(jobIdentifier, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/dataexport/requests/DownloadReportingDataExportRequest.java b/src/main/java/com/intercom/api/resources/dataexport/requests/DownloadReportingDataExportRequest.java new file mode 100644 index 00000000..3bac7a81 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/dataexport/requests/DownloadReportingDataExportRequest.java @@ -0,0 +1,135 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.dataexport.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnore; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = DownloadReportingDataExportRequest.Builder.class) +public final class DownloadReportingDataExportRequest { + private final String jobIdentifier; + + private final String appId; + + private final Map additionalProperties; + + private DownloadReportingDataExportRequest( + String jobIdentifier, String appId, Map additionalProperties) { + this.jobIdentifier = jobIdentifier; + this.appId = appId; + this.additionalProperties = additionalProperties; + } + + @JsonProperty("job_identifier") + public String getJobIdentifier() { + return jobIdentifier; + } + + /** + * @return Required header for downloading the export file + */ + @JsonIgnore + public String getAccept() { + return "application/octet-stream"; + } + + @JsonProperty("app_id") + public String getAppId() { + return appId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof DownloadReportingDataExportRequest + && equalTo((DownloadReportingDataExportRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(DownloadReportingDataExportRequest other) { + return jobIdentifier.equals(other.jobIdentifier) && appId.equals(other.appId); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.jobIdentifier, this.appId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static JobIdentifierStage builder() { + return new Builder(); + } + + public interface JobIdentifierStage { + AppIdStage jobIdentifier(@NotNull String jobIdentifier); + + Builder from(DownloadReportingDataExportRequest other); + } + + public interface AppIdStage { + _FinalStage appId(@NotNull String appId); + } + + public interface _FinalStage { + DownloadReportingDataExportRequest build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements JobIdentifierStage, AppIdStage, _FinalStage { + private String jobIdentifier; + + private String appId; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(DownloadReportingDataExportRequest other) { + jobIdentifier(other.getJobIdentifier()); + appId(other.getAppId()); + return this; + } + + @java.lang.Override + @JsonSetter("job_identifier") + public AppIdStage jobIdentifier(@NotNull String jobIdentifier) { + this.jobIdentifier = Objects.requireNonNull(jobIdentifier, "jobIdentifier must not be null"); + return this; + } + + @java.lang.Override + @JsonSetter("app_id") + public _FinalStage appId(@NotNull String appId) { + this.appId = Objects.requireNonNull(appId, "appId must not be null"); + return this; + } + + @java.lang.Override + public DownloadReportingDataExportRequest build() { + return new DownloadReportingDataExportRequest(jobIdentifier, appId, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/dataexport/requests/ExportReportingDataRequest.java b/src/main/java/com/intercom/api/resources/dataexport/requests/ExportReportingDataRequest.java new file mode 100644 index 00000000..bb2c6c87 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/dataexport/requests/ExportReportingDataRequest.java @@ -0,0 +1,171 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.dataexport.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = ExportReportingDataRequest.Builder.class) +public final class ExportReportingDataRequest { + private final String jobIdentifier; + + private final String appId; + + private final String clientId; + + private final Map additionalProperties; + + private ExportReportingDataRequest( + String jobIdentifier, String appId, String clientId, Map additionalProperties) { + this.jobIdentifier = jobIdentifier; + this.appId = appId; + this.clientId = clientId; + this.additionalProperties = additionalProperties; + } + + /** + * @return Unique identifier of the job. + */ + @JsonProperty("job_identifier") + public String getJobIdentifier() { + return jobIdentifier; + } + + /** + * @return The Intercom defined code of the workspace the company is associated to. + */ + @JsonProperty("app_id") + public String getAppId() { + return appId; + } + + @JsonProperty("client_id") + public String getClientId() { + return clientId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof ExportReportingDataRequest && equalTo((ExportReportingDataRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(ExportReportingDataRequest other) { + return jobIdentifier.equals(other.jobIdentifier) + && appId.equals(other.appId) + && clientId.equals(other.clientId); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.jobIdentifier, this.appId, this.clientId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static JobIdentifierStage builder() { + return new Builder(); + } + + public interface JobIdentifierStage { + /** + *

Unique identifier of the job.

+ */ + AppIdStage jobIdentifier(@NotNull String jobIdentifier); + + Builder from(ExportReportingDataRequest other); + } + + public interface AppIdStage { + /** + *

The Intercom defined code of the workspace the company is associated to.

+ */ + ClientIdStage appId(@NotNull String appId); + } + + public interface ClientIdStage { + _FinalStage clientId(@NotNull String clientId); + } + + public interface _FinalStage { + ExportReportingDataRequest build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements JobIdentifierStage, AppIdStage, ClientIdStage, _FinalStage { + private String jobIdentifier; + + private String appId; + + private String clientId; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(ExportReportingDataRequest other) { + jobIdentifier(other.getJobIdentifier()); + appId(other.getAppId()); + clientId(other.getClientId()); + return this; + } + + /** + *

Unique identifier of the job.

+ *

Unique identifier of the job.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("job_identifier") + public AppIdStage jobIdentifier(@NotNull String jobIdentifier) { + this.jobIdentifier = Objects.requireNonNull(jobIdentifier, "jobIdentifier must not be null"); + return this; + } + + /** + *

The Intercom defined code of the workspace the company is associated to.

+ *

The Intercom defined code of the workspace the company is associated to.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("app_id") + public ClientIdStage appId(@NotNull String appId) { + this.appId = Objects.requireNonNull(appId, "appId must not be null"); + return this; + } + + @java.lang.Override + @JsonSetter("client_id") + public _FinalStage clientId(@NotNull String clientId) { + this.clientId = Objects.requireNonNull(clientId, "clientId must not be null"); + return this; + } + + @java.lang.Override + public ExportReportingDataRequest build() { + return new ExportReportingDataRequest(jobIdentifier, appId, clientId, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/dataexport/requests/FindDataExportRequest.java b/src/main/java/com/intercom/api/resources/dataexport/requests/FindDataExportRequest.java new file mode 100644 index 00000000..c5eece10 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/dataexport/requests/FindDataExportRequest.java @@ -0,0 +1,113 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.dataexport.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = FindDataExportRequest.Builder.class) +public final class FindDataExportRequest { + private final String jobIdentifier; + + private final Map additionalProperties; + + private FindDataExportRequest(String jobIdentifier, Map additionalProperties) { + this.jobIdentifier = jobIdentifier; + this.additionalProperties = additionalProperties; + } + + /** + * @return job_identifier + */ + @JsonProperty("job_identifier") + public String getJobIdentifier() { + return jobIdentifier; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof FindDataExportRequest && equalTo((FindDataExportRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(FindDataExportRequest other) { + return jobIdentifier.equals(other.jobIdentifier); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.jobIdentifier); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static JobIdentifierStage builder() { + return new Builder(); + } + + public interface JobIdentifierStage { + /** + *

job_identifier

+ */ + _FinalStage jobIdentifier(@NotNull String jobIdentifier); + + Builder from(FindDataExportRequest other); + } + + public interface _FinalStage { + FindDataExportRequest build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements JobIdentifierStage, _FinalStage { + private String jobIdentifier; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(FindDataExportRequest other) { + jobIdentifier(other.getJobIdentifier()); + return this; + } + + /** + *

job_identifier

+ *

job_identifier

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("job_identifier") + public _FinalStage jobIdentifier(@NotNull String jobIdentifier) { + this.jobIdentifier = Objects.requireNonNull(jobIdentifier, "jobIdentifier must not be null"); + return this; + } + + @java.lang.Override + public FindDataExportRequest build() { + return new FindDataExportRequest(jobIdentifier, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/dataexport/types/DataExport.java b/src/main/java/com/intercom/api/resources/dataexport/types/DataExport.java new file mode 100644 index 00000000..237938e9 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/dataexport/types/DataExport.java @@ -0,0 +1,310 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.dataexport.types; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.JsonValue; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = DataExport.Builder.class) +public final class DataExport { + private final Optional jobIdentifier; + + private final Optional status; + + private final Optional downloadExpiresAt; + + private final Optional downloadUrl; + + private final Map additionalProperties; + + private DataExport( + Optional jobIdentifier, + Optional status, + Optional downloadExpiresAt, + Optional downloadUrl, + Map additionalProperties) { + this.jobIdentifier = jobIdentifier; + this.status = status; + this.downloadExpiresAt = downloadExpiresAt; + this.downloadUrl = downloadUrl; + this.additionalProperties = additionalProperties; + } + + /** + * @return The identifier for your job. + */ + @JsonProperty("job_identifier") + public Optional getJobIdentifier() { + return jobIdentifier; + } + + /** + * @return The current state of your job. + */ + @JsonProperty("status") + public Optional getStatus() { + return status; + } + + /** + * @return The time after which you will not be able to access the data. + */ + @JsonProperty("download_expires_at") + public Optional getDownloadExpiresAt() { + return downloadExpiresAt; + } + + /** + * @return The location where you can download your data. + */ + @JsonProperty("download_url") + public Optional getDownloadUrl() { + return downloadUrl; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof DataExport && equalTo((DataExport) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(DataExport other) { + return jobIdentifier.equals(other.jobIdentifier) + && status.equals(other.status) + && downloadExpiresAt.equals(other.downloadExpiresAt) + && downloadUrl.equals(other.downloadUrl); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.jobIdentifier, this.status, this.downloadExpiresAt, this.downloadUrl); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static Builder builder() { + return new Builder(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder { + private Optional jobIdentifier = Optional.empty(); + + private Optional status = Optional.empty(); + + private Optional downloadExpiresAt = Optional.empty(); + + private Optional downloadUrl = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + public Builder from(DataExport other) { + jobIdentifier(other.getJobIdentifier()); + status(other.getStatus()); + downloadExpiresAt(other.getDownloadExpiresAt()); + downloadUrl(other.getDownloadUrl()); + return this; + } + + /** + *

The identifier for your job.

+ */ + @JsonSetter(value = "job_identifier", nulls = Nulls.SKIP) + public Builder jobIdentifier(Optional jobIdentifier) { + this.jobIdentifier = jobIdentifier; + return this; + } + + public Builder jobIdentifier(String jobIdentifier) { + this.jobIdentifier = Optional.ofNullable(jobIdentifier); + return this; + } + + /** + *

The current state of your job.

+ */ + @JsonSetter(value = "status", nulls = Nulls.SKIP) + public Builder status(Optional status) { + this.status = status; + return this; + } + + public Builder status(Status status) { + this.status = Optional.ofNullable(status); + return this; + } + + /** + *

The time after which you will not be able to access the data.

+ */ + @JsonSetter(value = "download_expires_at", nulls = Nulls.SKIP) + public Builder downloadExpiresAt(Optional downloadExpiresAt) { + this.downloadExpiresAt = downloadExpiresAt; + return this; + } + + public Builder downloadExpiresAt(String downloadExpiresAt) { + this.downloadExpiresAt = Optional.ofNullable(downloadExpiresAt); + return this; + } + + /** + *

The location where you can download your data.

+ */ + @JsonSetter(value = "download_url", nulls = Nulls.SKIP) + public Builder downloadUrl(Optional downloadUrl) { + this.downloadUrl = downloadUrl; + return this; + } + + public Builder downloadUrl(String downloadUrl) { + this.downloadUrl = Optional.ofNullable(downloadUrl); + return this; + } + + public DataExport build() { + return new DataExport(jobIdentifier, status, downloadExpiresAt, downloadUrl, additionalProperties); + } + } + + public static final class Status { + public static final Status FAILED = new Status(Value.FAILED, "failed"); + + public static final Status COMPLETED = new Status(Value.COMPLETED, "completed"); + + public static final Status NO_DATA = new Status(Value.NO_DATA, "no_data"); + + public static final Status PENDING = new Status(Value.PENDING, "pending"); + + public static final Status IN_PROGRESS = new Status(Value.IN_PROGRESS, "in_progress"); + + public static final Status CANCELED = new Status(Value.CANCELED, "canceled"); + + private final Value value; + + private final String string; + + Status(Value value, String string) { + this.value = value; + this.string = string; + } + + public Value getEnumValue() { + return value; + } + + @java.lang.Override + @JsonValue + public String toString() { + return this.string; + } + + @java.lang.Override + public boolean equals(Object other) { + return (this == other) || (other instanceof Status && this.string.equals(((Status) other).string)); + } + + @java.lang.Override + public int hashCode() { + return this.string.hashCode(); + } + + public T visit(Visitor visitor) { + switch (value) { + case FAILED: + return visitor.visitFailed(); + case COMPLETED: + return visitor.visitCompleted(); + case NO_DATA: + return visitor.visitNoData(); + case PENDING: + return visitor.visitPending(); + case IN_PROGRESS: + return visitor.visitInProgress(); + case CANCELED: + return visitor.visitCanceled(); + case UNKNOWN: + default: + return visitor.visitUnknown(string); + } + } + + @JsonCreator(mode = JsonCreator.Mode.DELEGATING) + public static Status valueOf(String value) { + switch (value) { + case "failed": + return FAILED; + case "completed": + return COMPLETED; + case "no_data": + return NO_DATA; + case "pending": + return PENDING; + case "in_progress": + return IN_PROGRESS; + case "canceled": + return CANCELED; + default: + return new Status(Value.UNKNOWN, value); + } + } + + public enum Value { + PENDING, + + IN_PROGRESS, + + FAILED, + + COMPLETED, + + NO_DATA, + + CANCELED, + + UNKNOWN + } + + public interface Visitor { + T visitPending(); + + T visitInProgress(); + + T visitFailed(); + + T visitCompleted(); + + T visitNoData(); + + T visitCanceled(); + + T visitUnknown(String unknownType); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/dataexport/types/DataExportExportReportingDataResponse.java b/src/main/java/com/intercom/api/resources/dataexport/types/DataExportExportReportingDataResponse.java new file mode 100644 index 00000000..315451c9 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/dataexport/types/DataExportExportReportingDataResponse.java @@ -0,0 +1,171 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.dataexport.types; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = DataExportExportReportingDataResponse.Builder.class) +public final class DataExportExportReportingDataResponse { + private final Optional jobIdentifier; + + private final Optional status; + + private final Optional downloadUrl; + + private final Optional downloadExpiresAt; + + private final Map additionalProperties; + + private DataExportExportReportingDataResponse( + Optional jobIdentifier, + Optional status, + Optional downloadUrl, + Optional downloadExpiresAt, + Map additionalProperties) { + this.jobIdentifier = jobIdentifier; + this.status = status; + this.downloadUrl = downloadUrl; + this.downloadExpiresAt = downloadExpiresAt; + this.additionalProperties = additionalProperties; + } + + @JsonProperty("job_identifier") + public Optional getJobIdentifier() { + return jobIdentifier; + } + + @JsonProperty("status") + public Optional getStatus() { + return status; + } + + @JsonProperty("download_url") + public Optional getDownloadUrl() { + return downloadUrl; + } + + @JsonProperty("download_expires_at") + public Optional getDownloadExpiresAt() { + return downloadExpiresAt; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof DataExportExportReportingDataResponse + && equalTo((DataExportExportReportingDataResponse) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(DataExportExportReportingDataResponse other) { + return jobIdentifier.equals(other.jobIdentifier) + && status.equals(other.status) + && downloadUrl.equals(other.downloadUrl) + && downloadExpiresAt.equals(other.downloadExpiresAt); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.jobIdentifier, this.status, this.downloadUrl, this.downloadExpiresAt); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static Builder builder() { + return new Builder(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder { + private Optional jobIdentifier = Optional.empty(); + + private Optional status = Optional.empty(); + + private Optional downloadUrl = Optional.empty(); + + private Optional downloadExpiresAt = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + public Builder from(DataExportExportReportingDataResponse other) { + jobIdentifier(other.getJobIdentifier()); + status(other.getStatus()); + downloadUrl(other.getDownloadUrl()); + downloadExpiresAt(other.getDownloadExpiresAt()); + return this; + } + + @JsonSetter(value = "job_identifier", nulls = Nulls.SKIP) + public Builder jobIdentifier(Optional jobIdentifier) { + this.jobIdentifier = jobIdentifier; + return this; + } + + public Builder jobIdentifier(String jobIdentifier) { + this.jobIdentifier = Optional.ofNullable(jobIdentifier); + return this; + } + + @JsonSetter(value = "status", nulls = Nulls.SKIP) + public Builder status(Optional status) { + this.status = status; + return this; + } + + public Builder status(String status) { + this.status = Optional.ofNullable(status); + return this; + } + + @JsonSetter(value = "download_url", nulls = Nulls.SKIP) + public Builder downloadUrl(Optional downloadUrl) { + this.downloadUrl = downloadUrl; + return this; + } + + public Builder downloadUrl(String downloadUrl) { + this.downloadUrl = Optional.ofNullable(downloadUrl); + return this; + } + + @JsonSetter(value = "download_expires_at", nulls = Nulls.SKIP) + public Builder downloadExpiresAt(Optional downloadExpiresAt) { + this.downloadExpiresAt = downloadExpiresAt; + return this; + } + + public Builder downloadExpiresAt(String downloadExpiresAt) { + this.downloadExpiresAt = Optional.ofNullable(downloadExpiresAt); + return this; + } + + public DataExportExportReportingDataResponse build() { + return new DataExportExportReportingDataResponse( + jobIdentifier, status, downloadUrl, downloadExpiresAt, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/events/AsyncEventsClient.java b/src/main/java/com/intercom/api/resources/events/AsyncEventsClient.java new file mode 100644 index 00000000..b1e060e9 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/events/AsyncEventsClient.java @@ -0,0 +1,161 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.events; + +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.resources.events.requests.ListEventSummariesRequest; +import com.intercom.api.resources.events.requests.ListEventsRequest; +import com.intercom.api.types.CreateDataEventRequest; +import com.intercom.api.types.DataEventSummary; +import java.util.concurrent.CompletableFuture; + +public class AsyncEventsClient { + protected final ClientOptions clientOptions; + + private final AsyncRawEventsClient rawClient; + + public AsyncEventsClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + this.rawClient = new AsyncRawEventsClient(clientOptions); + } + + /** + * Get responses with HTTP metadata like headers + */ + public AsyncRawEventsClient withRawResponse() { + return this.rawClient; + } + + /** + *
+ * 🚧 + *

Please note that you can only 'list' events that are less than 90 days old. Event counts and summaries will still include your events older than 90 days but you cannot 'list' these events individually if they are older than 90 days

+ *
+ *

The events belonging to a customer can be listed by sending a GET request to https://api.intercom.io/events with a user or lead identifier along with a type parameter. The identifier parameter can be one of user_id, email or intercom_user_id. The type parameter value must be user.

+ *
    + *
  • https://api.intercom.io/events?type=user&user_id={user_id}
    • + *
  • https://api.intercom.io/events?type=user&email={email}
    • + *
  • https://api.intercom.io/events?type=user&intercom_user_id={id} (this call can be used to list leads)
    • + *
+ *

The email parameter value should be url encoded when sending.

+ *

You can optionally define the result page size as well with the per_page parameter.

+ */ + public CompletableFuture list(ListEventsRequest request) { + return this.rawClient.list(request).thenApply(response -> response.body()); + } + + /** + *
+ * 🚧 + *

Please note that you can only 'list' events that are less than 90 days old. Event counts and summaries will still include your events older than 90 days but you cannot 'list' these events individually if they are older than 90 days

+ *
+ *

The events belonging to a customer can be listed by sending a GET request to https://api.intercom.io/events with a user or lead identifier along with a type parameter. The identifier parameter can be one of user_id, email or intercom_user_id. The type parameter value must be user.

+ *
    + *
  • https://api.intercom.io/events?type=user&user_id={user_id}
    • + *
  • https://api.intercom.io/events?type=user&email={email}
    • + *
  • https://api.intercom.io/events?type=user&intercom_user_id={id} (this call can be used to list leads)
    • + *
+ *

The email parameter value should be url encoded when sending.

+ *

You can optionally define the result page size as well with the per_page parameter.

+ */ + public CompletableFuture list(ListEventsRequest request, RequestOptions requestOptions) { + return this.rawClient.list(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You will need an Access Token that has write permissions to send Events. Once you have a key you can submit events via POST to the Events resource, which is located at https://api.intercom.io/events, or you can send events using one of the client libraries. When working with the HTTP API directly a client should send the event with a Content-Type of application/json. + *

When using the JavaScript API, adding the code to your app makes the Events API available. Once added, you can submit an event using the trackEvent method. This will associate the event with the Lead or currently logged-in user or logged-out visitor/lead and send it to Intercom. The final parameter is a map that can be used to send optional metadata about the event.

+ *

With the Ruby client you pass a hash describing the event to Intercom::Event.create, or call the track_user method directly on the current user object (e.g. user.track_event).

+ *

NB: For the JSON object types, please note that we do not currently support nested JSON structure.

+ *

| Type | Description | Example | + * | :-------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------- | + * | String | The value is a JSON String | "source":"desktop" | + * | Number | The value is a JSON Number | "load": 3.67 | + * | Date | The key ends with the String _date and the value is a Unix timestamp, assumed to be in the UTC timezone. | "contact_date": 1392036272 | + * | Link | The value is a HTTP or HTTPS URI. | "article": "https://example.org/ab1de.html" | + * | Rich Link | The value is a JSON object that contains url and value keys. | "article": {"url": "https://example.org/ab1de.html", "value":"the dude abides"} | + * | Monetary Amount | The value is a JSON object that contains amount and currency keys. The amount key is a positive integer representing the amount in cents. The price in the example to the right denotes €349.99. | "price": {"amount": 34999, "currency": "eur"} |

+ *

Lead Events

+ *

When submitting events for Leads, you will need to specify the Lead's id.

+ *

Metadata behaviour

+ *
    + *
  • We currently limit the number of tracked metadata keys to 10 per event. Once the quota is reached, we ignore any further keys we receive. The first 10 metadata keys are determined by the order in which they are sent in with the event.
    • + *
  • It is not possible to change the metadata keys once the event has been sent. A new event will need to be created with the new keys and you can archive the old one.
    • + *
  • There might be up to 24 hrs delay when you send a new metadata for an existing event.
    • + *
+ *

Event de-duplication

+ *

The API may detect and ignore duplicate events. Each event is uniquely identified as a combination of the following data - the Workspace identifier, the Contact external identifier, the Data Event name and the Data Event created time. As a result, it is strongly recommended to send a second granularity Unix timestamp in the created_at field.

+ *

Duplicated events are responded to using the normal 202 Accepted code - an error is not thrown, however repeat requests will be counted against any rate limit that is in place.

+ *

HTTP API Responses

+ *
    + *
  • Successful responses to submitted events return 202 Accepted with an empty body.
    • + *
  • Unauthorised access will be rejected with a 401 Unauthorized or 403 Forbidden response code.
    • + *
  • Events sent about users that cannot be found will return a 404 Not Found.
    • + *
  • Event lists containing duplicate events will have those duplicates ignored.
    • + *
  • Server errors will return a 500 response code and may contain an error message in the body.
    • + *
+ */ + public CompletableFuture create(CreateDataEventRequest request) { + return this.rawClient.create(request).thenApply(response -> response.body()); + } + + /** + * You will need an Access Token that has write permissions to send Events. Once you have a key you can submit events via POST to the Events resource, which is located at https://api.intercom.io/events, or you can send events using one of the client libraries. When working with the HTTP API directly a client should send the event with a Content-Type of application/json. + *

When using the JavaScript API, adding the code to your app makes the Events API available. Once added, you can submit an event using the trackEvent method. This will associate the event with the Lead or currently logged-in user or logged-out visitor/lead and send it to Intercom. The final parameter is a map that can be used to send optional metadata about the event.

+ *

With the Ruby client you pass a hash describing the event to Intercom::Event.create, or call the track_user method directly on the current user object (e.g. user.track_event).

+ *

NB: For the JSON object types, please note that we do not currently support nested JSON structure.

+ *

| Type | Description | Example | + * | :-------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------- | + * | String | The value is a JSON String | "source":"desktop" | + * | Number | The value is a JSON Number | "load": 3.67 | + * | Date | The key ends with the String _date and the value is a Unix timestamp, assumed to be in the UTC timezone. | "contact_date": 1392036272 | + * | Link | The value is a HTTP or HTTPS URI. | "article": "https://example.org/ab1de.html" | + * | Rich Link | The value is a JSON object that contains url and value keys. | "article": {"url": "https://example.org/ab1de.html", "value":"the dude abides"} | + * | Monetary Amount | The value is a JSON object that contains amount and currency keys. The amount key is a positive integer representing the amount in cents. The price in the example to the right denotes €349.99. | "price": {"amount": 34999, "currency": "eur"} |

+ *

Lead Events

+ *

When submitting events for Leads, you will need to specify the Lead's id.

+ *

Metadata behaviour

+ *
    + *
  • We currently limit the number of tracked metadata keys to 10 per event. Once the quota is reached, we ignore any further keys we receive. The first 10 metadata keys are determined by the order in which they are sent in with the event.
    • + *
  • It is not possible to change the metadata keys once the event has been sent. A new event will need to be created with the new keys and you can archive the old one.
    • + *
  • There might be up to 24 hrs delay when you send a new metadata for an existing event.
    • + *
+ *

Event de-duplication

+ *

The API may detect and ignore duplicate events. Each event is uniquely identified as a combination of the following data - the Workspace identifier, the Contact external identifier, the Data Event name and the Data Event created time. As a result, it is strongly recommended to send a second granularity Unix timestamp in the created_at field.

+ *

Duplicated events are responded to using the normal 202 Accepted code - an error is not thrown, however repeat requests will be counted against any rate limit that is in place.

+ *

HTTP API Responses

+ *
    + *
  • Successful responses to submitted events return 202 Accepted with an empty body.
    • + *
  • Unauthorised access will be rejected with a 401 Unauthorized or 403 Forbidden response code.
    • + *
  • Events sent about users that cannot be found will return a 404 Not Found.
    • + *
  • Event lists containing duplicate events will have those duplicates ignored.
    • + *
  • Server errors will return a 500 response code and may contain an error message in the body.
    • + *
+ */ + public CompletableFuture create(CreateDataEventRequest request, RequestOptions requestOptions) { + return this.rawClient.create(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * Create event summaries for a user. Event summaries are used to track the number of times an event has occurred, the first time it occurred and the last time it occurred. + */ + public CompletableFuture summaries() { + return this.rawClient.summaries().thenApply(response -> response.body()); + } + + /** + * Create event summaries for a user. Event summaries are used to track the number of times an event has occurred, the first time it occurred and the last time it occurred. + */ + public CompletableFuture summaries(ListEventSummariesRequest request) { + return this.rawClient.summaries(request).thenApply(response -> response.body()); + } + + /** + * Create event summaries for a user. Event summaries are used to track the number of times an event has occurred, the first time it occurred and the last time it occurred. + */ + public CompletableFuture summaries(ListEventSummariesRequest request, RequestOptions requestOptions) { + return this.rawClient.summaries(request, requestOptions).thenApply(response -> response.body()); + } +} diff --git a/src/main/java/com/intercom/api/resources/events/AsyncRawEventsClient.java b/src/main/java/com/intercom/api/resources/events/AsyncRawEventsClient.java new file mode 100644 index 00000000..d7e55023 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/events/AsyncRawEventsClient.java @@ -0,0 +1,353 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.events; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.IntercomApiException; +import com.intercom.api.core.IntercomException; +import com.intercom.api.core.IntercomHttpResponse; +import com.intercom.api.core.MediaTypes; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.core.QueryStringMapper; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.errors.UnauthorizedError; +import com.intercom.api.resources.events.requests.ListEventSummariesRequest; +import com.intercom.api.resources.events.requests.ListEventsRequest; +import com.intercom.api.types.CreateDataEventRequest; +import com.intercom.api.types.DataEventSummary; +import com.intercom.api.types.Error; +import java.io.IOException; +import java.util.concurrent.CompletableFuture; +import okhttp3.Call; +import okhttp3.Callback; +import okhttp3.Headers; +import okhttp3.HttpUrl; +import okhttp3.OkHttpClient; +import okhttp3.Request; +import okhttp3.RequestBody; +import okhttp3.Response; +import okhttp3.ResponseBody; +import org.jetbrains.annotations.NotNull; + +public class AsyncRawEventsClient { + protected final ClientOptions clientOptions; + + public AsyncRawEventsClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + } + + /** + *
+ * 🚧 + *

Please note that you can only 'list' events that are less than 90 days old. Event counts and summaries will still include your events older than 90 days but you cannot 'list' these events individually if they are older than 90 days

+ *
+ *

The events belonging to a customer can be listed by sending a GET request to https://api.intercom.io/events with a user or lead identifier along with a type parameter. The identifier parameter can be one of user_id, email or intercom_user_id. The type parameter value must be user.

+ *
    + *
  • https://api.intercom.io/events?type=user&user_id={user_id}
    • + *
  • https://api.intercom.io/events?type=user&email={email}
    • + *
  • https://api.intercom.io/events?type=user&intercom_user_id={id} (this call can be used to list leads)
    • + *
+ *

The email parameter value should be url encoded when sending.

+ *

You can optionally define the result page size as well with the per_page parameter.

+ */ + public CompletableFuture> list(ListEventsRequest request) { + return list(request, null); + } + + /** + *
+ * 🚧 + *

Please note that you can only 'list' events that are less than 90 days old. Event counts and summaries will still include your events older than 90 days but you cannot 'list' these events individually if they are older than 90 days

+ *
+ *

The events belonging to a customer can be listed by sending a GET request to https://api.intercom.io/events with a user or lead identifier along with a type parameter. The identifier parameter can be one of user_id, email or intercom_user_id. The type parameter value must be user.

+ *
    + *
  • https://api.intercom.io/events?type=user&user_id={user_id}
    • + *
  • https://api.intercom.io/events?type=user&email={email}
    • + *
  • https://api.intercom.io/events?type=user&intercom_user_id={id} (this call can be used to list leads)
    • + *
+ *

The email parameter value should be url encoded when sending.

+ *

You can optionally define the result page size as well with the per_page parameter.

+ */ + public CompletableFuture> list( + ListEventsRequest request, RequestOptions requestOptions) { + HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("events"); + if (request.getUserId().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "user_id", request.getUserId().get(), false); + } + if (request.getIntercomUserId().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "intercom_user_id", request.getIntercomUserId().get(), false); + } + if (request.getEmail().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "email", request.getEmail().get(), false); + } + QueryStringMapper.addQueryParameter(httpUrl, "type", request.getType(), false); + if (request.getSummary().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "summary", request.getSummary().get(), false); + } + if (request.getPerPage().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "per_page", request.getPerPage().get(), false); + } + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl.build()) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, DataEventSummary.class), + response)); + return; + } + try { + if (response.code() == 401) { + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You will need an Access Token that has write permissions to send Events. Once you have a key you can submit events via POST to the Events resource, which is located at https://api.intercom.io/events, or you can send events using one of the client libraries. When working with the HTTP API directly a client should send the event with a Content-Type of application/json. + *

When using the JavaScript API, adding the code to your app makes the Events API available. Once added, you can submit an event using the trackEvent method. This will associate the event with the Lead or currently logged-in user or logged-out visitor/lead and send it to Intercom. The final parameter is a map that can be used to send optional metadata about the event.

+ *

With the Ruby client you pass a hash describing the event to Intercom::Event.create, or call the track_user method directly on the current user object (e.g. user.track_event).

+ *

NB: For the JSON object types, please note that we do not currently support nested JSON structure.

+ *

| Type | Description | Example | + * | :-------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------- | + * | String | The value is a JSON String | "source":"desktop" | + * | Number | The value is a JSON Number | "load": 3.67 | + * | Date | The key ends with the String _date and the value is a Unix timestamp, assumed to be in the UTC timezone. | "contact_date": 1392036272 | + * | Link | The value is a HTTP or HTTPS URI. | "article": "https://example.org/ab1de.html" | + * | Rich Link | The value is a JSON object that contains url and value keys. | "article": {"url": "https://example.org/ab1de.html", "value":"the dude abides"} | + * | Monetary Amount | The value is a JSON object that contains amount and currency keys. The amount key is a positive integer representing the amount in cents. The price in the example to the right denotes €349.99. | "price": {"amount": 34999, "currency": "eur"} |

+ *

Lead Events

+ *

When submitting events for Leads, you will need to specify the Lead's id.

+ *

Metadata behaviour

+ *
    + *
  • We currently limit the number of tracked metadata keys to 10 per event. Once the quota is reached, we ignore any further keys we receive. The first 10 metadata keys are determined by the order in which they are sent in with the event.
    • + *
  • It is not possible to change the metadata keys once the event has been sent. A new event will need to be created with the new keys and you can archive the old one.
    • + *
  • There might be up to 24 hrs delay when you send a new metadata for an existing event.
    • + *
+ *

Event de-duplication

+ *

The API may detect and ignore duplicate events. Each event is uniquely identified as a combination of the following data - the Workspace identifier, the Contact external identifier, the Data Event name and the Data Event created time. As a result, it is strongly recommended to send a second granularity Unix timestamp in the created_at field.

+ *

Duplicated events are responded to using the normal 202 Accepted code - an error is not thrown, however repeat requests will be counted against any rate limit that is in place.

+ *

HTTP API Responses

+ *
    + *
  • Successful responses to submitted events return 202 Accepted with an empty body.
    • + *
  • Unauthorised access will be rejected with a 401 Unauthorized or 403 Forbidden response code.
    • + *
  • Events sent about users that cannot be found will return a 404 Not Found.
    • + *
  • Event lists containing duplicate events will have those duplicates ignored.
    • + *
  • Server errors will return a 500 response code and may contain an error message in the body.
    • + *
+ */ + public CompletableFuture> create(CreateDataEventRequest request) { + return create(request, null); + } + + /** + * You will need an Access Token that has write permissions to send Events. Once you have a key you can submit events via POST to the Events resource, which is located at https://api.intercom.io/events, or you can send events using one of the client libraries. When working with the HTTP API directly a client should send the event with a Content-Type of application/json. + *

When using the JavaScript API, adding the code to your app makes the Events API available. Once added, you can submit an event using the trackEvent method. This will associate the event with the Lead or currently logged-in user or logged-out visitor/lead and send it to Intercom. The final parameter is a map that can be used to send optional metadata about the event.

+ *

With the Ruby client you pass a hash describing the event to Intercom::Event.create, or call the track_user method directly on the current user object (e.g. user.track_event).

+ *

NB: For the JSON object types, please note that we do not currently support nested JSON structure.

+ *

| Type | Description | Example | + * | :-------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------- | + * | String | The value is a JSON String | "source":"desktop" | + * | Number | The value is a JSON Number | "load": 3.67 | + * | Date | The key ends with the String _date and the value is a Unix timestamp, assumed to be in the UTC timezone. | "contact_date": 1392036272 | + * | Link | The value is a HTTP or HTTPS URI. | "article": "https://example.org/ab1de.html" | + * | Rich Link | The value is a JSON object that contains url and value keys. | "article": {"url": "https://example.org/ab1de.html", "value":"the dude abides"} | + * | Monetary Amount | The value is a JSON object that contains amount and currency keys. The amount key is a positive integer representing the amount in cents. The price in the example to the right denotes €349.99. | "price": {"amount": 34999, "currency": "eur"} |

+ *

Lead Events

+ *

When submitting events for Leads, you will need to specify the Lead's id.

+ *

Metadata behaviour

+ *
    + *
  • We currently limit the number of tracked metadata keys to 10 per event. Once the quota is reached, we ignore any further keys we receive. The first 10 metadata keys are determined by the order in which they are sent in with the event.
    • + *
  • It is not possible to change the metadata keys once the event has been sent. A new event will need to be created with the new keys and you can archive the old one.
    • + *
  • There might be up to 24 hrs delay when you send a new metadata for an existing event.
    • + *
+ *

Event de-duplication

+ *

The API may detect and ignore duplicate events. Each event is uniquely identified as a combination of the following data - the Workspace identifier, the Contact external identifier, the Data Event name and the Data Event created time. As a result, it is strongly recommended to send a second granularity Unix timestamp in the created_at field.

+ *

Duplicated events are responded to using the normal 202 Accepted code - an error is not thrown, however repeat requests will be counted against any rate limit that is in place.

+ *

HTTP API Responses

+ *
    + *
  • Successful responses to submitted events return 202 Accepted with an empty body.
    • + *
  • Unauthorised access will be rejected with a 401 Unauthorized or 403 Forbidden response code.
    • + *
  • Events sent about users that cannot be found will return a 404 Not Found.
    • + *
  • Event lists containing duplicate events will have those duplicates ignored.
    • + *
  • Server errors will return a 500 response code and may contain an error message in the body.
    • + *
+ */ + public CompletableFuture> create( + CreateDataEventRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("events") + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>(null, response)); + return; + } + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + try { + if (response.code() == 401) { + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * Create event summaries for a user. Event summaries are used to track the number of times an event has occurred, the first time it occurred and the last time it occurred. + */ + public CompletableFuture> summaries() { + return summaries(ListEventSummariesRequest.builder().build()); + } + + /** + * Create event summaries for a user. Event summaries are used to track the number of times an event has occurred, the first time it occurred and the last time it occurred. + */ + public CompletableFuture> summaries(ListEventSummariesRequest request) { + return summaries(request, null); + } + + /** + * Create event summaries for a user. Event summaries are used to track the number of times an event has occurred, the first time it occurred and the last time it occurred. + */ + public CompletableFuture> summaries( + ListEventSummariesRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("events/summaries") + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>(null, response)); + return; + } + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + try { + if (response.code() == 401) { + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } +} diff --git a/src/main/java/com/intercom/api/resources/events/EventsClient.java b/src/main/java/com/intercom/api/resources/events/EventsClient.java new file mode 100644 index 00000000..79318e64 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/events/EventsClient.java @@ -0,0 +1,160 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.events; + +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.resources.events.requests.ListEventSummariesRequest; +import com.intercom.api.resources.events.requests.ListEventsRequest; +import com.intercom.api.types.CreateDataEventRequest; +import com.intercom.api.types.DataEventSummary; + +public class EventsClient { + protected final ClientOptions clientOptions; + + private final RawEventsClient rawClient; + + public EventsClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + this.rawClient = new RawEventsClient(clientOptions); + } + + /** + * Get responses with HTTP metadata like headers + */ + public RawEventsClient withRawResponse() { + return this.rawClient; + } + + /** + *
+ * 🚧 + *

Please note that you can only 'list' events that are less than 90 days old. Event counts and summaries will still include your events older than 90 days but you cannot 'list' these events individually if they are older than 90 days

+ *
+ *

The events belonging to a customer can be listed by sending a GET request to https://api.intercom.io/events with a user or lead identifier along with a type parameter. The identifier parameter can be one of user_id, email or intercom_user_id. The type parameter value must be user.

+ *
    + *
  • https://api.intercom.io/events?type=user&user_id={user_id}
    • + *
  • https://api.intercom.io/events?type=user&email={email}
    • + *
  • https://api.intercom.io/events?type=user&intercom_user_id={id} (this call can be used to list leads)
    • + *
+ *

The email parameter value should be url encoded when sending.

+ *

You can optionally define the result page size as well with the per_page parameter.

+ */ + public DataEventSummary list(ListEventsRequest request) { + return this.rawClient.list(request).body(); + } + + /** + *
+ * 🚧 + *

Please note that you can only 'list' events that are less than 90 days old. Event counts and summaries will still include your events older than 90 days but you cannot 'list' these events individually if they are older than 90 days

+ *
+ *

The events belonging to a customer can be listed by sending a GET request to https://api.intercom.io/events with a user or lead identifier along with a type parameter. The identifier parameter can be one of user_id, email or intercom_user_id. The type parameter value must be user.

+ *
    + *
  • https://api.intercom.io/events?type=user&user_id={user_id}
    • + *
  • https://api.intercom.io/events?type=user&email={email}
    • + *
  • https://api.intercom.io/events?type=user&intercom_user_id={id} (this call can be used to list leads)
    • + *
+ *

The email parameter value should be url encoded when sending.

+ *

You can optionally define the result page size as well with the per_page parameter.

+ */ + public DataEventSummary list(ListEventsRequest request, RequestOptions requestOptions) { + return this.rawClient.list(request, requestOptions).body(); + } + + /** + * You will need an Access Token that has write permissions to send Events. Once you have a key you can submit events via POST to the Events resource, which is located at https://api.intercom.io/events, or you can send events using one of the client libraries. When working with the HTTP API directly a client should send the event with a Content-Type of application/json. + *

When using the JavaScript API, adding the code to your app makes the Events API available. Once added, you can submit an event using the trackEvent method. This will associate the event with the Lead or currently logged-in user or logged-out visitor/lead and send it to Intercom. The final parameter is a map that can be used to send optional metadata about the event.

+ *

With the Ruby client you pass a hash describing the event to Intercom::Event.create, or call the track_user method directly on the current user object (e.g. user.track_event).

+ *

NB: For the JSON object types, please note that we do not currently support nested JSON structure.

+ *

| Type | Description | Example | + * | :-------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------- | + * | String | The value is a JSON String | "source":"desktop" | + * | Number | The value is a JSON Number | "load": 3.67 | + * | Date | The key ends with the String _date and the value is a Unix timestamp, assumed to be in the UTC timezone. | "contact_date": 1392036272 | + * | Link | The value is a HTTP or HTTPS URI. | "article": "https://example.org/ab1de.html" | + * | Rich Link | The value is a JSON object that contains url and value keys. | "article": {"url": "https://example.org/ab1de.html", "value":"the dude abides"} | + * | Monetary Amount | The value is a JSON object that contains amount and currency keys. The amount key is a positive integer representing the amount in cents. The price in the example to the right denotes €349.99. | "price": {"amount": 34999, "currency": "eur"} |

+ *

Lead Events

+ *

When submitting events for Leads, you will need to specify the Lead's id.

+ *

Metadata behaviour

+ *
    + *
  • We currently limit the number of tracked metadata keys to 10 per event. Once the quota is reached, we ignore any further keys we receive. The first 10 metadata keys are determined by the order in which they are sent in with the event.
    • + *
  • It is not possible to change the metadata keys once the event has been sent. A new event will need to be created with the new keys and you can archive the old one.
    • + *
  • There might be up to 24 hrs delay when you send a new metadata for an existing event.
    • + *
+ *

Event de-duplication

+ *

The API may detect and ignore duplicate events. Each event is uniquely identified as a combination of the following data - the Workspace identifier, the Contact external identifier, the Data Event name and the Data Event created time. As a result, it is strongly recommended to send a second granularity Unix timestamp in the created_at field.

+ *

Duplicated events are responded to using the normal 202 Accepted code - an error is not thrown, however repeat requests will be counted against any rate limit that is in place.

+ *

HTTP API Responses

+ *
    + *
  • Successful responses to submitted events return 202 Accepted with an empty body.
    • + *
  • Unauthorised access will be rejected with a 401 Unauthorized or 403 Forbidden response code.
    • + *
  • Events sent about users that cannot be found will return a 404 Not Found.
    • + *
  • Event lists containing duplicate events will have those duplicates ignored.
    • + *
  • Server errors will return a 500 response code and may contain an error message in the body.
    • + *
+ */ + public void create(CreateDataEventRequest request) { + this.rawClient.create(request).body(); + } + + /** + * You will need an Access Token that has write permissions to send Events. Once you have a key you can submit events via POST to the Events resource, which is located at https://api.intercom.io/events, or you can send events using one of the client libraries. When working with the HTTP API directly a client should send the event with a Content-Type of application/json. + *

When using the JavaScript API, adding the code to your app makes the Events API available. Once added, you can submit an event using the trackEvent method. This will associate the event with the Lead or currently logged-in user or logged-out visitor/lead and send it to Intercom. The final parameter is a map that can be used to send optional metadata about the event.

+ *

With the Ruby client you pass a hash describing the event to Intercom::Event.create, or call the track_user method directly on the current user object (e.g. user.track_event).

+ *

NB: For the JSON object types, please note that we do not currently support nested JSON structure.

+ *

| Type | Description | Example | + * | :-------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------- | + * | String | The value is a JSON String | "source":"desktop" | + * | Number | The value is a JSON Number | "load": 3.67 | + * | Date | The key ends with the String _date and the value is a Unix timestamp, assumed to be in the UTC timezone. | "contact_date": 1392036272 | + * | Link | The value is a HTTP or HTTPS URI. | "article": "https://example.org/ab1de.html" | + * | Rich Link | The value is a JSON object that contains url and value keys. | "article": {"url": "https://example.org/ab1de.html", "value":"the dude abides"} | + * | Monetary Amount | The value is a JSON object that contains amount and currency keys. The amount key is a positive integer representing the amount in cents. The price in the example to the right denotes €349.99. | "price": {"amount": 34999, "currency": "eur"} |

+ *

Lead Events

+ *

When submitting events for Leads, you will need to specify the Lead's id.

+ *

Metadata behaviour

+ *
    + *
  • We currently limit the number of tracked metadata keys to 10 per event. Once the quota is reached, we ignore any further keys we receive. The first 10 metadata keys are determined by the order in which they are sent in with the event.
    • + *
  • It is not possible to change the metadata keys once the event has been sent. A new event will need to be created with the new keys and you can archive the old one.
    • + *
  • There might be up to 24 hrs delay when you send a new metadata for an existing event.
    • + *
+ *

Event de-duplication

+ *

The API may detect and ignore duplicate events. Each event is uniquely identified as a combination of the following data - the Workspace identifier, the Contact external identifier, the Data Event name and the Data Event created time. As a result, it is strongly recommended to send a second granularity Unix timestamp in the created_at field.

+ *

Duplicated events are responded to using the normal 202 Accepted code - an error is not thrown, however repeat requests will be counted against any rate limit that is in place.

+ *

HTTP API Responses

+ *
    + *
  • Successful responses to submitted events return 202 Accepted with an empty body.
    • + *
  • Unauthorised access will be rejected with a 401 Unauthorized or 403 Forbidden response code.
    • + *
  • Events sent about users that cannot be found will return a 404 Not Found.
    • + *
  • Event lists containing duplicate events will have those duplicates ignored.
    • + *
  • Server errors will return a 500 response code and may contain an error message in the body.
    • + *
+ */ + public void create(CreateDataEventRequest request, RequestOptions requestOptions) { + this.rawClient.create(request, requestOptions).body(); + } + + /** + * Create event summaries for a user. Event summaries are used to track the number of times an event has occurred, the first time it occurred and the last time it occurred. + */ + public void summaries() { + this.rawClient.summaries().body(); + } + + /** + * Create event summaries for a user. Event summaries are used to track the number of times an event has occurred, the first time it occurred and the last time it occurred. + */ + public void summaries(ListEventSummariesRequest request) { + this.rawClient.summaries(request).body(); + } + + /** + * Create event summaries for a user. Event summaries are used to track the number of times an event has occurred, the first time it occurred and the last time it occurred. + */ + public void summaries(ListEventSummariesRequest request, RequestOptions requestOptions) { + this.rawClient.summaries(request, requestOptions).body(); + } +} diff --git a/src/main/java/com/intercom/api/resources/events/RawEventsClient.java b/src/main/java/com/intercom/api/resources/events/RawEventsClient.java new file mode 100644 index 00000000..4f53d768 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/events/RawEventsClient.java @@ -0,0 +1,303 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.events; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.IntercomApiException; +import com.intercom.api.core.IntercomException; +import com.intercom.api.core.IntercomHttpResponse; +import com.intercom.api.core.MediaTypes; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.core.QueryStringMapper; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.errors.UnauthorizedError; +import com.intercom.api.resources.events.requests.ListEventSummariesRequest; +import com.intercom.api.resources.events.requests.ListEventsRequest; +import com.intercom.api.types.CreateDataEventRequest; +import com.intercom.api.types.DataEventSummary; +import com.intercom.api.types.Error; +import java.io.IOException; +import okhttp3.Headers; +import okhttp3.HttpUrl; +import okhttp3.OkHttpClient; +import okhttp3.Request; +import okhttp3.RequestBody; +import okhttp3.Response; +import okhttp3.ResponseBody; + +public class RawEventsClient { + protected final ClientOptions clientOptions; + + public RawEventsClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + } + + /** + *
+ * 🚧 + *

Please note that you can only 'list' events that are less than 90 days old. Event counts and summaries will still include your events older than 90 days but you cannot 'list' these events individually if they are older than 90 days

+ *
+ *

The events belonging to a customer can be listed by sending a GET request to https://api.intercom.io/events with a user or lead identifier along with a type parameter. The identifier parameter can be one of user_id, email or intercom_user_id. The type parameter value must be user.

+ *
    + *
  • https://api.intercom.io/events?type=user&user_id={user_id}
    • + *
  • https://api.intercom.io/events?type=user&email={email}
    • + *
  • https://api.intercom.io/events?type=user&intercom_user_id={id} (this call can be used to list leads)
    • + *
+ *

The email parameter value should be url encoded when sending.

+ *

You can optionally define the result page size as well with the per_page parameter.

+ */ + public IntercomHttpResponse list(ListEventsRequest request) { + return list(request, null); + } + + /** + *
+ * 🚧 + *

Please note that you can only 'list' events that are less than 90 days old. Event counts and summaries will still include your events older than 90 days but you cannot 'list' these events individually if they are older than 90 days

+ *
+ *

The events belonging to a customer can be listed by sending a GET request to https://api.intercom.io/events with a user or lead identifier along with a type parameter. The identifier parameter can be one of user_id, email or intercom_user_id. The type parameter value must be user.

+ *
    + *
  • https://api.intercom.io/events?type=user&user_id={user_id}
    • + *
  • https://api.intercom.io/events?type=user&email={email}
    • + *
  • https://api.intercom.io/events?type=user&intercom_user_id={id} (this call can be used to list leads)
    • + *
+ *

The email parameter value should be url encoded when sending.

+ *

You can optionally define the result page size as well with the per_page parameter.

+ */ + public IntercomHttpResponse list(ListEventsRequest request, RequestOptions requestOptions) { + HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("events"); + if (request.getUserId().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "user_id", request.getUserId().get(), false); + } + if (request.getIntercomUserId().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "intercom_user_id", request.getIntercomUserId().get(), false); + } + if (request.getEmail().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "email", request.getEmail().get(), false); + } + QueryStringMapper.addQueryParameter(httpUrl, "type", request.getType(), false); + if (request.getSummary().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "summary", request.getSummary().get(), false); + } + if (request.getPerPage().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "per_page", request.getPerPage().get(), false); + } + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl.build()) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, DataEventSummary.class), response); + } + try { + if (response.code() == 401) { + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You will need an Access Token that has write permissions to send Events. Once you have a key you can submit events via POST to the Events resource, which is located at https://api.intercom.io/events, or you can send events using one of the client libraries. When working with the HTTP API directly a client should send the event with a Content-Type of application/json. + *

When using the JavaScript API, adding the code to your app makes the Events API available. Once added, you can submit an event using the trackEvent method. This will associate the event with the Lead or currently logged-in user or logged-out visitor/lead and send it to Intercom. The final parameter is a map that can be used to send optional metadata about the event.

+ *

With the Ruby client you pass a hash describing the event to Intercom::Event.create, or call the track_user method directly on the current user object (e.g. user.track_event).

+ *

NB: For the JSON object types, please note that we do not currently support nested JSON structure.

+ *

| Type | Description | Example | + * | :-------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------- | + * | String | The value is a JSON String | "source":"desktop" | + * | Number | The value is a JSON Number | "load": 3.67 | + * | Date | The key ends with the String _date and the value is a Unix timestamp, assumed to be in the UTC timezone. | "contact_date": 1392036272 | + * | Link | The value is a HTTP or HTTPS URI. | "article": "https://example.org/ab1de.html" | + * | Rich Link | The value is a JSON object that contains url and value keys. | "article": {"url": "https://example.org/ab1de.html", "value":"the dude abides"} | + * | Monetary Amount | The value is a JSON object that contains amount and currency keys. The amount key is a positive integer representing the amount in cents. The price in the example to the right denotes €349.99. | "price": {"amount": 34999, "currency": "eur"} |

+ *

Lead Events

+ *

When submitting events for Leads, you will need to specify the Lead's id.

+ *

Metadata behaviour

+ *
    + *
  • We currently limit the number of tracked metadata keys to 10 per event. Once the quota is reached, we ignore any further keys we receive. The first 10 metadata keys are determined by the order in which they are sent in with the event.
    • + *
  • It is not possible to change the metadata keys once the event has been sent. A new event will need to be created with the new keys and you can archive the old one.
    • + *
  • There might be up to 24 hrs delay when you send a new metadata for an existing event.
    • + *
+ *

Event de-duplication

+ *

The API may detect and ignore duplicate events. Each event is uniquely identified as a combination of the following data - the Workspace identifier, the Contact external identifier, the Data Event name and the Data Event created time. As a result, it is strongly recommended to send a second granularity Unix timestamp in the created_at field.

+ *

Duplicated events are responded to using the normal 202 Accepted code - an error is not thrown, however repeat requests will be counted against any rate limit that is in place.

+ *

HTTP API Responses

+ *
    + *
  • Successful responses to submitted events return 202 Accepted with an empty body.
    • + *
  • Unauthorised access will be rejected with a 401 Unauthorized or 403 Forbidden response code.
    • + *
  • Events sent about users that cannot be found will return a 404 Not Found.
    • + *
  • Event lists containing duplicate events will have those duplicates ignored.
    • + *
  • Server errors will return a 500 response code and may contain an error message in the body.
    • + *
+ */ + public IntercomHttpResponse create(CreateDataEventRequest request) { + return create(request, null); + } + + /** + * You will need an Access Token that has write permissions to send Events. Once you have a key you can submit events via POST to the Events resource, which is located at https://api.intercom.io/events, or you can send events using one of the client libraries. When working with the HTTP API directly a client should send the event with a Content-Type of application/json. + *

When using the JavaScript API, adding the code to your app makes the Events API available. Once added, you can submit an event using the trackEvent method. This will associate the event with the Lead or currently logged-in user or logged-out visitor/lead and send it to Intercom. The final parameter is a map that can be used to send optional metadata about the event.

+ *

With the Ruby client you pass a hash describing the event to Intercom::Event.create, or call the track_user method directly on the current user object (e.g. user.track_event).

+ *

NB: For the JSON object types, please note that we do not currently support nested JSON structure.

+ *

| Type | Description | Example | + * | :-------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------- | + * | String | The value is a JSON String | "source":"desktop" | + * | Number | The value is a JSON Number | "load": 3.67 | + * | Date | The key ends with the String _date and the value is a Unix timestamp, assumed to be in the UTC timezone. | "contact_date": 1392036272 | + * | Link | The value is a HTTP or HTTPS URI. | "article": "https://example.org/ab1de.html" | + * | Rich Link | The value is a JSON object that contains url and value keys. | "article": {"url": "https://example.org/ab1de.html", "value":"the dude abides"} | + * | Monetary Amount | The value is a JSON object that contains amount and currency keys. The amount key is a positive integer representing the amount in cents. The price in the example to the right denotes €349.99. | "price": {"amount": 34999, "currency": "eur"} |

+ *

Lead Events

+ *

When submitting events for Leads, you will need to specify the Lead's id.

+ *

Metadata behaviour

+ *
    + *
  • We currently limit the number of tracked metadata keys to 10 per event. Once the quota is reached, we ignore any further keys we receive. The first 10 metadata keys are determined by the order in which they are sent in with the event.
    • + *
  • It is not possible to change the metadata keys once the event has been sent. A new event will need to be created with the new keys and you can archive the old one.
    • + *
  • There might be up to 24 hrs delay when you send a new metadata for an existing event.
    • + *
+ *

Event de-duplication

+ *

The API may detect and ignore duplicate events. Each event is uniquely identified as a combination of the following data - the Workspace identifier, the Contact external identifier, the Data Event name and the Data Event created time. As a result, it is strongly recommended to send a second granularity Unix timestamp in the created_at field.

+ *

Duplicated events are responded to using the normal 202 Accepted code - an error is not thrown, however repeat requests will be counted against any rate limit that is in place.

+ *

HTTP API Responses

+ *
    + *
  • Successful responses to submitted events return 202 Accepted with an empty body.
    • + *
  • Unauthorised access will be rejected with a 401 Unauthorized or 403 Forbidden response code.
    • + *
  • Events sent about users that cannot be found will return a 404 Not Found.
    • + *
  • Event lists containing duplicate events will have those duplicates ignored.
    • + *
  • Server errors will return a 500 response code and may contain an error message in the body.
    • + *
+ */ + public IntercomHttpResponse create(CreateDataEventRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("events") + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + if (response.isSuccessful()) { + return new IntercomHttpResponse<>(null, response); + } + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + try { + if (response.code() == 401) { + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * Create event summaries for a user. Event summaries are used to track the number of times an event has occurred, the first time it occurred and the last time it occurred. + */ + public IntercomHttpResponse summaries() { + return summaries(ListEventSummariesRequest.builder().build()); + } + + /** + * Create event summaries for a user. Event summaries are used to track the number of times an event has occurred, the first time it occurred and the last time it occurred. + */ + public IntercomHttpResponse summaries(ListEventSummariesRequest request) { + return summaries(request, null); + } + + /** + * Create event summaries for a user. Event summaries are used to track the number of times an event has occurred, the first time it occurred and the last time it occurred. + */ + public IntercomHttpResponse summaries(ListEventSummariesRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("events/summaries") + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + if (response.isSuccessful()) { + return new IntercomHttpResponse<>(null, response); + } + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + try { + if (response.code() == 401) { + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/events/requests/ListEventSummariesRequest.java b/src/main/java/com/intercom/api/resources/events/requests/ListEventSummariesRequest.java new file mode 100644 index 00000000..5fb7fe03 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/events/requests/ListEventSummariesRequest.java @@ -0,0 +1,307 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.events.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = ListEventSummariesRequest.Builder.class) +public final class ListEventSummariesRequest { + private final Optional userId; + + private final Optional eventSummaries; + + private final Map additionalProperties; + + private ListEventSummariesRequest( + Optional userId, + Optional eventSummaries, + Map additionalProperties) { + this.userId = userId; + this.eventSummaries = eventSummaries; + this.additionalProperties = additionalProperties; + } + + /** + * @return Your identifier for the user. + */ + @JsonProperty("user_id") + public Optional getUserId() { + return userId; + } + + /** + * @return A list of event summaries for the user. Each event summary should contain the event name, the time the event occurred, and the number of times the event occurred. The event name should be a past tense 'verb-noun' combination, to improve readability, for example updated-plan. + */ + @JsonProperty("event_summaries") + public Optional getEventSummaries() { + return eventSummaries; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof ListEventSummariesRequest && equalTo((ListEventSummariesRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(ListEventSummariesRequest other) { + return userId.equals(other.userId) && eventSummaries.equals(other.eventSummaries); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.userId, this.eventSummaries); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static Builder builder() { + return new Builder(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder { + private Optional userId = Optional.empty(); + + private Optional eventSummaries = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + public Builder from(ListEventSummariesRequest other) { + userId(other.getUserId()); + eventSummaries(other.getEventSummaries()); + return this; + } + + /** + *

Your identifier for the user.

+ */ + @JsonSetter(value = "user_id", nulls = Nulls.SKIP) + public Builder userId(Optional userId) { + this.userId = userId; + return this; + } + + public Builder userId(String userId) { + this.userId = Optional.ofNullable(userId); + return this; + } + + /** + *

A list of event summaries for the user. Each event summary should contain the event name, the time the event occurred, and the number of times the event occurred. The event name should be a past tense 'verb-noun' combination, to improve readability, for example updated-plan.

+ */ + @JsonSetter(value = "event_summaries", nulls = Nulls.SKIP) + public Builder eventSummaries(Optional eventSummaries) { + this.eventSummaries = eventSummaries; + return this; + } + + public Builder eventSummaries(EventSummaries eventSummaries) { + this.eventSummaries = Optional.ofNullable(eventSummaries); + return this; + } + + public ListEventSummariesRequest build() { + return new ListEventSummariesRequest(userId, eventSummaries, additionalProperties); + } + } + + @JsonInclude(JsonInclude.Include.NON_ABSENT) + @JsonDeserialize(builder = EventSummaries.Builder.class) + public static final class EventSummaries { + private final Optional eventName; + + private final Optional count; + + private final Optional first; + + private final Optional last; + + private final Map additionalProperties; + + private EventSummaries( + Optional eventName, + Optional count, + Optional first, + Optional last, + Map additionalProperties) { + this.eventName = eventName; + this.count = count; + this.first = first; + this.last = last; + this.additionalProperties = additionalProperties; + } + + /** + * @return The name of the event that occurred. A good event name is typically a past tense 'verb-noun' combination, to improve readability, for example updated-plan. + */ + @JsonProperty("event_name") + public Optional getEventName() { + return eventName; + } + + /** + * @return The number of times the event occurred. + */ + @JsonProperty("count") + public Optional getCount() { + return count; + } + + /** + * @return The first time the event was sent + */ + @JsonProperty("first") + public Optional getFirst() { + return first; + } + + /** + * @return The last time the event was sent + */ + @JsonProperty("last") + public Optional getLast() { + return last; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof EventSummaries && equalTo((EventSummaries) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(EventSummaries other) { + return eventName.equals(other.eventName) + && count.equals(other.count) + && first.equals(other.first) + && last.equals(other.last); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.eventName, this.count, this.first, this.last); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static Builder builder() { + return new Builder(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder { + private Optional eventName = Optional.empty(); + + private Optional count = Optional.empty(); + + private Optional first = Optional.empty(); + + private Optional last = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + public Builder from(EventSummaries other) { + eventName(other.getEventName()); + count(other.getCount()); + first(other.getFirst()); + last(other.getLast()); + return this; + } + + /** + *

The name of the event that occurred. A good event name is typically a past tense 'verb-noun' combination, to improve readability, for example updated-plan.

+ */ + @JsonSetter(value = "event_name", nulls = Nulls.SKIP) + public Builder eventName(Optional eventName) { + this.eventName = eventName; + return this; + } + + public Builder eventName(String eventName) { + this.eventName = Optional.ofNullable(eventName); + return this; + } + + /** + *

The number of times the event occurred.

+ */ + @JsonSetter(value = "count", nulls = Nulls.SKIP) + public Builder count(Optional count) { + this.count = count; + return this; + } + + public Builder count(Integer count) { + this.count = Optional.ofNullable(count); + return this; + } + + /** + *

The first time the event was sent

+ */ + @JsonSetter(value = "first", nulls = Nulls.SKIP) + public Builder first(Optional first) { + this.first = first; + return this; + } + + public Builder first(Integer first) { + this.first = Optional.ofNullable(first); + return this; + } + + /** + *

The last time the event was sent

+ */ + @JsonSetter(value = "last", nulls = Nulls.SKIP) + public Builder last(Optional last) { + this.last = last; + return this; + } + + public Builder last(Integer last) { + this.last = Optional.ofNullable(last); + return this; + } + + public EventSummaries build() { + return new EventSummaries(eventName, count, first, last, additionalProperties); + } + } + } +} diff --git a/src/main/java/com/intercom/api/resources/events/requests/ListEventsRequest.java b/src/main/java/com/intercom/api/resources/events/requests/ListEventsRequest.java new file mode 100644 index 00000000..b075147d --- /dev/null +++ b/src/main/java/com/intercom/api/resources/events/requests/ListEventsRequest.java @@ -0,0 +1,332 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.events.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = ListEventsRequest.Builder.class) +public final class ListEventsRequest { + private final Optional userId; + + private final Optional intercomUserId; + + private final Optional email; + + private final String type; + + private final Optional summary; + + private final Optional perPage; + + private final Map additionalProperties; + + private ListEventsRequest( + Optional userId, + Optional intercomUserId, + Optional email, + String type, + Optional summary, + Optional perPage, + Map additionalProperties) { + this.userId = userId; + this.intercomUserId = intercomUserId; + this.email = email; + this.type = type; + this.summary = summary; + this.perPage = perPage; + this.additionalProperties = additionalProperties; + } + + /** + * @return user_id query parameter + */ + @JsonProperty("user_id") + public Optional getUserId() { + return userId; + } + + /** + * @return intercom_user_id query parameter + */ + @JsonProperty("intercom_user_id") + public Optional getIntercomUserId() { + return intercomUserId; + } + + /** + * @return email query parameter + */ + @JsonProperty("email") + public Optional getEmail() { + return email; + } + + /** + * @return The value must be user + */ + @JsonProperty("type") + public String getType() { + return type; + } + + /** + * @return summary flag + */ + @JsonProperty("summary") + public Optional getSummary() { + return summary; + } + + /** + * @return How many results to display per page. Defaults to 15 + */ + @JsonProperty("per_page") + public Optional getPerPage() { + return perPage; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof ListEventsRequest && equalTo((ListEventsRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(ListEventsRequest other) { + return userId.equals(other.userId) + && intercomUserId.equals(other.intercomUserId) + && email.equals(other.email) + && type.equals(other.type) + && summary.equals(other.summary) + && perPage.equals(other.perPage); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.userId, this.intercomUserId, this.email, this.type, this.summary, this.perPage); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static TypeStage builder() { + return new Builder(); + } + + public interface TypeStage { + /** + *

The value must be user

+ */ + _FinalStage type(@NotNull String type); + + Builder from(ListEventsRequest other); + } + + public interface _FinalStage { + ListEventsRequest build(); + + /** + *

user_id query parameter

+ */ + _FinalStage userId(Optional userId); + + _FinalStage userId(String userId); + + /** + *

intercom_user_id query parameter

+ */ + _FinalStage intercomUserId(Optional intercomUserId); + + _FinalStage intercomUserId(String intercomUserId); + + /** + *

email query parameter

+ */ + _FinalStage email(Optional email); + + _FinalStage email(String email); + + /** + *

summary flag

+ */ + _FinalStage summary(Optional summary); + + _FinalStage summary(Boolean summary); + + /** + *

How many results to display per page. Defaults to 15

+ */ + _FinalStage perPage(Optional perPage); + + _FinalStage perPage(Integer perPage); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements TypeStage, _FinalStage { + private String type; + + private Optional perPage = Optional.empty(); + + private Optional summary = Optional.empty(); + + private Optional email = Optional.empty(); + + private Optional intercomUserId = Optional.empty(); + + private Optional userId = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(ListEventsRequest other) { + userId(other.getUserId()); + intercomUserId(other.getIntercomUserId()); + email(other.getEmail()); + type(other.getType()); + summary(other.getSummary()); + perPage(other.getPerPage()); + return this; + } + + /** + *

The value must be user

+ *

The value must be user

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("type") + public _FinalStage type(@NotNull String type) { + this.type = Objects.requireNonNull(type, "type must not be null"); + return this; + } + + /** + *

How many results to display per page. Defaults to 15

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage perPage(Integer perPage) { + this.perPage = Optional.ofNullable(perPage); + return this; + } + + /** + *

How many results to display per page. Defaults to 15

+ */ + @java.lang.Override + @JsonSetter(value = "per_page", nulls = Nulls.SKIP) + public _FinalStage perPage(Optional perPage) { + this.perPage = perPage; + return this; + } + + /** + *

summary flag

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage summary(Boolean summary) { + this.summary = Optional.ofNullable(summary); + return this; + } + + /** + *

summary flag

+ */ + @java.lang.Override + @JsonSetter(value = "summary", nulls = Nulls.SKIP) + public _FinalStage summary(Optional summary) { + this.summary = summary; + return this; + } + + /** + *

email query parameter

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage email(String email) { + this.email = Optional.ofNullable(email); + return this; + } + + /** + *

email query parameter

+ */ + @java.lang.Override + @JsonSetter(value = "email", nulls = Nulls.SKIP) + public _FinalStage email(Optional email) { + this.email = email; + return this; + } + + /** + *

intercom_user_id query parameter

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage intercomUserId(String intercomUserId) { + this.intercomUserId = Optional.ofNullable(intercomUserId); + return this; + } + + /** + *

intercom_user_id query parameter

+ */ + @java.lang.Override + @JsonSetter(value = "intercom_user_id", nulls = Nulls.SKIP) + public _FinalStage intercomUserId(Optional intercomUserId) { + this.intercomUserId = intercomUserId; + return this; + } + + /** + *

user_id query parameter

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage userId(String userId) { + this.userId = Optional.ofNullable(userId); + return this; + } + + /** + *

user_id query parameter

+ */ + @java.lang.Override + @JsonSetter(value = "user_id", nulls = Nulls.SKIP) + public _FinalStage userId(Optional userId) { + this.userId = userId; + return this; + } + + @java.lang.Override + public ListEventsRequest build() { + return new ListEventsRequest(userId, intercomUserId, email, type, summary, perPage, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/export/AsyncExportClient.java b/src/main/java/com/intercom/api/resources/export/AsyncExportClient.java new file mode 100644 index 00000000..1122e611 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/export/AsyncExportClient.java @@ -0,0 +1,50 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.export; + +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.resources.export.requests.PostExportReportingDataEnqueueRequest; +import com.intercom.api.resources.export.types.GetExportReportingDataGetDatasetsResponse; +import com.intercom.api.resources.export.types.PostExportReportingDataEnqueueResponse; +import java.util.concurrent.CompletableFuture; + +public class AsyncExportClient { + protected final ClientOptions clientOptions; + + private final AsyncRawExportClient rawClient; + + public AsyncExportClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + this.rawClient = new AsyncRawExportClient(clientOptions); + } + + /** + * Get responses with HTTP metadata like headers + */ + public AsyncRawExportClient withRawResponse() { + return this.rawClient; + } + + public CompletableFuture enqueueANewReportingDataExportJob( + PostExportReportingDataEnqueueRequest request) { + return this.rawClient.enqueueANewReportingDataExportJob(request).thenApply(response -> response.body()); + } + + public CompletableFuture enqueueANewReportingDataExportJob( + PostExportReportingDataEnqueueRequest request, RequestOptions requestOptions) { + return this.rawClient + .enqueueANewReportingDataExportJob(request, requestOptions) + .thenApply(response -> response.body()); + } + + public CompletableFuture listAvailableDatasetsAndAttributes() { + return this.rawClient.listAvailableDatasetsAndAttributes().thenApply(response -> response.body()); + } + + public CompletableFuture listAvailableDatasetsAndAttributes( + RequestOptions requestOptions) { + return this.rawClient.listAvailableDatasetsAndAttributes(requestOptions).thenApply(response -> response.body()); + } +} diff --git a/src/main/java/com/intercom/api/resources/export/AsyncRawExportClient.java b/src/main/java/com/intercom/api/resources/export/AsyncRawExportClient.java new file mode 100644 index 00000000..2b76ed57 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/export/AsyncRawExportClient.java @@ -0,0 +1,174 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.export; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.IntercomApiException; +import com.intercom.api.core.IntercomException; +import com.intercom.api.core.IntercomHttpResponse; +import com.intercom.api.core.MediaTypes; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.errors.BadRequestError; +import com.intercom.api.errors.TooManyRequestsError; +import com.intercom.api.errors.UnauthorizedError; +import com.intercom.api.resources.export.requests.PostExportReportingDataEnqueueRequest; +import com.intercom.api.resources.export.types.GetExportReportingDataGetDatasetsResponse; +import com.intercom.api.resources.export.types.PostExportReportingDataEnqueueResponse; +import com.intercom.api.types.Error; +import java.io.IOException; +import java.util.concurrent.CompletableFuture; +import okhttp3.Call; +import okhttp3.Callback; +import okhttp3.Headers; +import okhttp3.HttpUrl; +import okhttp3.OkHttpClient; +import okhttp3.Request; +import okhttp3.RequestBody; +import okhttp3.Response; +import okhttp3.ResponseBody; +import org.jetbrains.annotations.NotNull; + +public class AsyncRawExportClient { + protected final ClientOptions clientOptions; + + public AsyncRawExportClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + } + + public CompletableFuture> + enqueueANewReportingDataExportJob(PostExportReportingDataEnqueueRequest request) { + return enqueueANewReportingDataExportJob(request, null); + } + + public CompletableFuture> + enqueueANewReportingDataExportJob( + PostExportReportingDataEnqueueRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("export/reporting_data/enqueue") + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = + new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue( + responseBodyString, PostExportReportingDataEnqueueResponse.class), + response)); + return; + } + try { + switch (response.code()) { + case 400: + future.completeExceptionally(new BadRequestError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 429: + future.completeExceptionally(new TooManyRequestsError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + public CompletableFuture> + listAvailableDatasetsAndAttributes() { + return listAvailableDatasetsAndAttributes(null); + } + + public CompletableFuture> + listAvailableDatasetsAndAttributes(RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("export/reporting_data/get_datasets") + .build(); + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = + new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue( + responseBodyString, GetExportReportingDataGetDatasetsResponse.class), + response)); + return; + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } +} diff --git a/src/main/java/com/intercom/api/resources/export/ExportClient.java b/src/main/java/com/intercom/api/resources/export/ExportClient.java new file mode 100644 index 00000000..b2d79859 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/export/ExportClient.java @@ -0,0 +1,48 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.export; + +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.resources.export.requests.PostExportReportingDataEnqueueRequest; +import com.intercom.api.resources.export.types.GetExportReportingDataGetDatasetsResponse; +import com.intercom.api.resources.export.types.PostExportReportingDataEnqueueResponse; + +public class ExportClient { + protected final ClientOptions clientOptions; + + private final RawExportClient rawClient; + + public ExportClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + this.rawClient = new RawExportClient(clientOptions); + } + + /** + * Get responses with HTTP metadata like headers + */ + public RawExportClient withRawResponse() { + return this.rawClient; + } + + public PostExportReportingDataEnqueueResponse enqueueANewReportingDataExportJob( + PostExportReportingDataEnqueueRequest request) { + return this.rawClient.enqueueANewReportingDataExportJob(request).body(); + } + + public PostExportReportingDataEnqueueResponse enqueueANewReportingDataExportJob( + PostExportReportingDataEnqueueRequest request, RequestOptions requestOptions) { + return this.rawClient + .enqueueANewReportingDataExportJob(request, requestOptions) + .body(); + } + + public GetExportReportingDataGetDatasetsResponse listAvailableDatasetsAndAttributes() { + return this.rawClient.listAvailableDatasetsAndAttributes().body(); + } + + public GetExportReportingDataGetDatasetsResponse listAvailableDatasetsAndAttributes(RequestOptions requestOptions) { + return this.rawClient.listAvailableDatasetsAndAttributes(requestOptions).body(); + } +} diff --git a/src/main/java/com/intercom/api/resources/export/RawExportClient.java b/src/main/java/com/intercom/api/resources/export/RawExportClient.java new file mode 100644 index 00000000..9f3b7bf2 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/export/RawExportClient.java @@ -0,0 +1,134 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.export; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.IntercomApiException; +import com.intercom.api.core.IntercomException; +import com.intercom.api.core.IntercomHttpResponse; +import com.intercom.api.core.MediaTypes; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.errors.BadRequestError; +import com.intercom.api.errors.TooManyRequestsError; +import com.intercom.api.errors.UnauthorizedError; +import com.intercom.api.resources.export.requests.PostExportReportingDataEnqueueRequest; +import com.intercom.api.resources.export.types.GetExportReportingDataGetDatasetsResponse; +import com.intercom.api.resources.export.types.PostExportReportingDataEnqueueResponse; +import com.intercom.api.types.Error; +import java.io.IOException; +import okhttp3.Headers; +import okhttp3.HttpUrl; +import okhttp3.OkHttpClient; +import okhttp3.Request; +import okhttp3.RequestBody; +import okhttp3.Response; +import okhttp3.ResponseBody; + +public class RawExportClient { + protected final ClientOptions clientOptions; + + public RawExportClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + } + + public IntercomHttpResponse enqueueANewReportingDataExportJob( + PostExportReportingDataEnqueueRequest request) { + return enqueueANewReportingDataExportJob(request, null); + } + + public IntercomHttpResponse enqueueANewReportingDataExportJob( + PostExportReportingDataEnqueueRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("export/reporting_data/enqueue") + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue( + responseBodyString, PostExportReportingDataEnqueueResponse.class), + response); + } + try { + switch (response.code()) { + case 400: + throw new BadRequestError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 429: + throw new TooManyRequestsError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + public IntercomHttpResponse listAvailableDatasetsAndAttributes() { + return listAvailableDatasetsAndAttributes(null); + } + + public IntercomHttpResponse listAvailableDatasetsAndAttributes( + RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("export/reporting_data/get_datasets") + .build(); + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue( + responseBodyString, GetExportReportingDataGetDatasetsResponse.class), + response); + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/export/requests/PostExportReportingDataEnqueueRequest.java b/src/main/java/com/intercom/api/resources/export/requests/PostExportReportingDataEnqueueRequest.java new file mode 100644 index 00000000..406e7971 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/export/requests/PostExportReportingDataEnqueueRequest.java @@ -0,0 +1,200 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.export.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.Objects; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = PostExportReportingDataEnqueueRequest.Builder.class) +public final class PostExportReportingDataEnqueueRequest { + private final String datasetId; + + private final List attributeIds; + + private final long startTime; + + private final long endTime; + + private final Map additionalProperties; + + private PostExportReportingDataEnqueueRequest( + String datasetId, + List attributeIds, + long startTime, + long endTime, + Map additionalProperties) { + this.datasetId = datasetId; + this.attributeIds = attributeIds; + this.startTime = startTime; + this.endTime = endTime; + this.additionalProperties = additionalProperties; + } + + @JsonProperty("dataset_id") + public String getDatasetId() { + return datasetId; + } + + @JsonProperty("attribute_ids") + public List getAttributeIds() { + return attributeIds; + } + + @JsonProperty("start_time") + public long getStartTime() { + return startTime; + } + + @JsonProperty("end_time") + public long getEndTime() { + return endTime; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof PostExportReportingDataEnqueueRequest + && equalTo((PostExportReportingDataEnqueueRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(PostExportReportingDataEnqueueRequest other) { + return datasetId.equals(other.datasetId) + && attributeIds.equals(other.attributeIds) + && startTime == other.startTime + && endTime == other.endTime; + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.datasetId, this.attributeIds, this.startTime, this.endTime); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static DatasetIdStage builder() { + return new Builder(); + } + + public interface DatasetIdStage { + StartTimeStage datasetId(@NotNull String datasetId); + + Builder from(PostExportReportingDataEnqueueRequest other); + } + + public interface StartTimeStage { + EndTimeStage startTime(long startTime); + } + + public interface EndTimeStage { + _FinalStage endTime(long endTime); + } + + public interface _FinalStage { + PostExportReportingDataEnqueueRequest build(); + + _FinalStage attributeIds(List attributeIds); + + _FinalStage addAttributeIds(String attributeIds); + + _FinalStage addAllAttributeIds(List attributeIds); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements DatasetIdStage, StartTimeStage, EndTimeStage, _FinalStage { + private String datasetId; + + private long startTime; + + private long endTime; + + private List attributeIds = new ArrayList<>(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(PostExportReportingDataEnqueueRequest other) { + datasetId(other.getDatasetId()); + attributeIds(other.getAttributeIds()); + startTime(other.getStartTime()); + endTime(other.getEndTime()); + return this; + } + + @java.lang.Override + @JsonSetter("dataset_id") + public StartTimeStage datasetId(@NotNull String datasetId) { + this.datasetId = Objects.requireNonNull(datasetId, "datasetId must not be null"); + return this; + } + + @java.lang.Override + @JsonSetter("start_time") + public EndTimeStage startTime(long startTime) { + this.startTime = startTime; + return this; + } + + @java.lang.Override + @JsonSetter("end_time") + public _FinalStage endTime(long endTime) { + this.endTime = endTime; + return this; + } + + @java.lang.Override + public _FinalStage addAllAttributeIds(List attributeIds) { + if (attributeIds != null) { + this.attributeIds.addAll(attributeIds); + } + return this; + } + + @java.lang.Override + public _FinalStage addAttributeIds(String attributeIds) { + this.attributeIds.add(attributeIds); + return this; + } + + @java.lang.Override + @JsonSetter(value = "attribute_ids", nulls = Nulls.SKIP) + public _FinalStage attributeIds(List attributeIds) { + this.attributeIds.clear(); + if (attributeIds != null) { + this.attributeIds.addAll(attributeIds); + } + return this; + } + + @java.lang.Override + public PostExportReportingDataEnqueueRequest build() { + return new PostExportReportingDataEnqueueRequest( + datasetId, attributeIds, startTime, endTime, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/export/types/GetExportReportingDataGetDatasetsResponse.java b/src/main/java/com/intercom/api/resources/export/types/GetExportReportingDataGetDatasetsResponse.java new file mode 100644 index 00000000..27ab3528 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/export/types/GetExportReportingDataGetDatasetsResponse.java @@ -0,0 +1,395 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.export.types; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = GetExportReportingDataGetDatasetsResponse.Builder.class) +public final class GetExportReportingDataGetDatasetsResponse { + private final Optional type; + + private final Optional> data; + + private final Map additionalProperties; + + private GetExportReportingDataGetDatasetsResponse( + Optional type, Optional> data, Map additionalProperties) { + this.type = type; + this.data = data; + this.additionalProperties = additionalProperties; + } + + @JsonProperty("type") + public Optional getType() { + return type; + } + + @JsonProperty("data") + public Optional> getData() { + return data; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof GetExportReportingDataGetDatasetsResponse + && equalTo((GetExportReportingDataGetDatasetsResponse) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(GetExportReportingDataGetDatasetsResponse other) { + return type.equals(other.type) && data.equals(other.data); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.type, this.data); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static Builder builder() { + return new Builder(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder { + private Optional type = Optional.empty(); + + private Optional> data = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + public Builder from(GetExportReportingDataGetDatasetsResponse other) { + type(other.getType()); + data(other.getData()); + return this; + } + + @JsonSetter(value = "type", nulls = Nulls.SKIP) + public Builder type(Optional type) { + this.type = type; + return this; + } + + public Builder type(String type) { + this.type = Optional.ofNullable(type); + return this; + } + + @JsonSetter(value = "data", nulls = Nulls.SKIP) + public Builder data(Optional> data) { + this.data = data; + return this; + } + + public Builder data(List data) { + this.data = Optional.ofNullable(data); + return this; + } + + public GetExportReportingDataGetDatasetsResponse build() { + return new GetExportReportingDataGetDatasetsResponse(type, data, additionalProperties); + } + } + + @JsonInclude(JsonInclude.Include.NON_ABSENT) + @JsonDeserialize(builder = DataItem.Builder.class) + public static final class DataItem { + private final Optional id; + + private final Optional name; + + private final Optional description; + + private final Optional defaultTimeAttributeId; + + private final Optional> attributes; + + private final Map additionalProperties; + + private DataItem( + Optional id, + Optional name, + Optional description, + Optional defaultTimeAttributeId, + Optional> attributes, + Map additionalProperties) { + this.id = id; + this.name = name; + this.description = description; + this.defaultTimeAttributeId = defaultTimeAttributeId; + this.attributes = attributes; + this.additionalProperties = additionalProperties; + } + + @JsonProperty("id") + public Optional getId() { + return id; + } + + @JsonProperty("name") + public Optional getName() { + return name; + } + + @JsonProperty("description") + public Optional getDescription() { + return description; + } + + @JsonProperty("default_time_attribute_id") + public Optional getDefaultTimeAttributeId() { + return defaultTimeAttributeId; + } + + @JsonProperty("attributes") + public Optional> getAttributes() { + return attributes; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof DataItem && equalTo((DataItem) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(DataItem other) { + return id.equals(other.id) + && name.equals(other.name) + && description.equals(other.description) + && defaultTimeAttributeId.equals(other.defaultTimeAttributeId) + && attributes.equals(other.attributes); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.id, this.name, this.description, this.defaultTimeAttributeId, this.attributes); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static Builder builder() { + return new Builder(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder { + private Optional id = Optional.empty(); + + private Optional name = Optional.empty(); + + private Optional description = Optional.empty(); + + private Optional defaultTimeAttributeId = Optional.empty(); + + private Optional> attributes = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + public Builder from(DataItem other) { + id(other.getId()); + name(other.getName()); + description(other.getDescription()); + defaultTimeAttributeId(other.getDefaultTimeAttributeId()); + attributes(other.getAttributes()); + return this; + } + + @JsonSetter(value = "id", nulls = Nulls.SKIP) + public Builder id(Optional id) { + this.id = id; + return this; + } + + public Builder id(String id) { + this.id = Optional.ofNullable(id); + return this; + } + + @JsonSetter(value = "name", nulls = Nulls.SKIP) + public Builder name(Optional name) { + this.name = name; + return this; + } + + public Builder name(String name) { + this.name = Optional.ofNullable(name); + return this; + } + + @JsonSetter(value = "description", nulls = Nulls.SKIP) + public Builder description(Optional description) { + this.description = description; + return this; + } + + public Builder description(String description) { + this.description = Optional.ofNullable(description); + return this; + } + + @JsonSetter(value = "default_time_attribute_id", nulls = Nulls.SKIP) + public Builder defaultTimeAttributeId(Optional defaultTimeAttributeId) { + this.defaultTimeAttributeId = defaultTimeAttributeId; + return this; + } + + public Builder defaultTimeAttributeId(String defaultTimeAttributeId) { + this.defaultTimeAttributeId = Optional.ofNullable(defaultTimeAttributeId); + return this; + } + + @JsonSetter(value = "attributes", nulls = Nulls.SKIP) + public Builder attributes(Optional> attributes) { + this.attributes = attributes; + return this; + } + + public Builder attributes(List attributes) { + this.attributes = Optional.ofNullable(attributes); + return this; + } + + public DataItem build() { + return new DataItem(id, name, description, defaultTimeAttributeId, attributes, additionalProperties); + } + } + + @JsonInclude(JsonInclude.Include.NON_ABSENT) + @JsonDeserialize(builder = AttributesItem.Builder.class) + public static final class AttributesItem { + private final Optional id; + + private final Optional name; + + private final Map additionalProperties; + + private AttributesItem( + Optional id, Optional name, Map additionalProperties) { + this.id = id; + this.name = name; + this.additionalProperties = additionalProperties; + } + + @JsonProperty("id") + public Optional getId() { + return id; + } + + @JsonProperty("name") + public Optional getName() { + return name; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof AttributesItem && equalTo((AttributesItem) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(AttributesItem other) { + return id.equals(other.id) && name.equals(other.name); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.id, this.name); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static Builder builder() { + return new Builder(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder { + private Optional id = Optional.empty(); + + private Optional name = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + public Builder from(AttributesItem other) { + id(other.getId()); + name(other.getName()); + return this; + } + + @JsonSetter(value = "id", nulls = Nulls.SKIP) + public Builder id(Optional id) { + this.id = id; + return this; + } + + public Builder id(String id) { + this.id = Optional.ofNullable(id); + return this; + } + + @JsonSetter(value = "name", nulls = Nulls.SKIP) + public Builder name(Optional name) { + this.name = name; + return this; + } + + public Builder name(String name) { + this.name = Optional.ofNullable(name); + return this; + } + + public AttributesItem build() { + return new AttributesItem(id, name, additionalProperties); + } + } + } + } +} diff --git a/src/main/java/com/intercom/api/resources/export/types/PostExportReportingDataEnqueueResponse.java b/src/main/java/com/intercom/api/resources/export/types/PostExportReportingDataEnqueueResponse.java new file mode 100644 index 00000000..982e08fa --- /dev/null +++ b/src/main/java/com/intercom/api/resources/export/types/PostExportReportingDataEnqueueResponse.java @@ -0,0 +1,171 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.export.types; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = PostExportReportingDataEnqueueResponse.Builder.class) +public final class PostExportReportingDataEnqueueResponse { + private final Optional jobIdentifier; + + private final Optional status; + + private final Optional downloadUrl; + + private final Optional downloadExpiresAt; + + private final Map additionalProperties; + + private PostExportReportingDataEnqueueResponse( + Optional jobIdentifier, + Optional status, + Optional downloadUrl, + Optional downloadExpiresAt, + Map additionalProperties) { + this.jobIdentifier = jobIdentifier; + this.status = status; + this.downloadUrl = downloadUrl; + this.downloadExpiresAt = downloadExpiresAt; + this.additionalProperties = additionalProperties; + } + + @JsonProperty("job_identifier") + public Optional getJobIdentifier() { + return jobIdentifier; + } + + @JsonProperty("status") + public Optional getStatus() { + return status; + } + + @JsonProperty("download_url") + public Optional getDownloadUrl() { + return downloadUrl; + } + + @JsonProperty("download_expires_at") + public Optional getDownloadExpiresAt() { + return downloadExpiresAt; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof PostExportReportingDataEnqueueResponse + && equalTo((PostExportReportingDataEnqueueResponse) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(PostExportReportingDataEnqueueResponse other) { + return jobIdentifier.equals(other.jobIdentifier) + && status.equals(other.status) + && downloadUrl.equals(other.downloadUrl) + && downloadExpiresAt.equals(other.downloadExpiresAt); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.jobIdentifier, this.status, this.downloadUrl, this.downloadExpiresAt); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static Builder builder() { + return new Builder(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder { + private Optional jobIdentifier = Optional.empty(); + + private Optional status = Optional.empty(); + + private Optional downloadUrl = Optional.empty(); + + private Optional downloadExpiresAt = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + public Builder from(PostExportReportingDataEnqueueResponse other) { + jobIdentifier(other.getJobIdentifier()); + status(other.getStatus()); + downloadUrl(other.getDownloadUrl()); + downloadExpiresAt(other.getDownloadExpiresAt()); + return this; + } + + @JsonSetter(value = "job_identifier", nulls = Nulls.SKIP) + public Builder jobIdentifier(Optional jobIdentifier) { + this.jobIdentifier = jobIdentifier; + return this; + } + + public Builder jobIdentifier(String jobIdentifier) { + this.jobIdentifier = Optional.ofNullable(jobIdentifier); + return this; + } + + @JsonSetter(value = "status", nulls = Nulls.SKIP) + public Builder status(Optional status) { + this.status = status; + return this; + } + + public Builder status(String status) { + this.status = Optional.ofNullable(status); + return this; + } + + @JsonSetter(value = "download_url", nulls = Nulls.SKIP) + public Builder downloadUrl(Optional downloadUrl) { + this.downloadUrl = downloadUrl; + return this; + } + + public Builder downloadUrl(String downloadUrl) { + this.downloadUrl = Optional.ofNullable(downloadUrl); + return this; + } + + @JsonSetter(value = "download_expires_at", nulls = Nulls.SKIP) + public Builder downloadExpiresAt(Optional downloadExpiresAt) { + this.downloadExpiresAt = downloadExpiresAt; + return this; + } + + public Builder downloadExpiresAt(String downloadExpiresAt) { + this.downloadExpiresAt = Optional.ofNullable(downloadExpiresAt); + return this; + } + + public PostExportReportingDataEnqueueResponse build() { + return new PostExportReportingDataEnqueueResponse( + jobIdentifier, status, downloadUrl, downloadExpiresAt, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/helpcenter/types/Collection.java b/src/main/java/com/intercom/api/resources/helpcenter/types/Collection.java new file mode 100644 index 00000000..74b451c8 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/helpcenter/types/Collection.java @@ -0,0 +1,617 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.helpcenter.types; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.types.GroupTranslatedContent; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = Collection.Builder.class) +public final class Collection { + private final String id; + + private final String workspaceId; + + private final String name; + + private final Optional description; + + private final int createdAt; + + private final Optional updatedAt; + + private final Optional url; + + private final Optional icon; + + private final int order; + + private final Optional defaultLocale; + + private final Optional translatedContent; + + private final Optional parentId; + + private final Optional helpCenterId; + + private final Map additionalProperties; + + private Collection( + String id, + String workspaceId, + String name, + Optional description, + int createdAt, + Optional updatedAt, + Optional url, + Optional icon, + int order, + Optional defaultLocale, + Optional translatedContent, + Optional parentId, + Optional helpCenterId, + Map additionalProperties) { + this.id = id; + this.workspaceId = workspaceId; + this.name = name; + this.description = description; + this.createdAt = createdAt; + this.updatedAt = updatedAt; + this.url = url; + this.icon = icon; + this.order = order; + this.defaultLocale = defaultLocale; + this.translatedContent = translatedContent; + this.parentId = parentId; + this.helpCenterId = helpCenterId; + this.additionalProperties = additionalProperties; + } + + /** + * @return The unique identifier for the collection which is given by Intercom. + */ + @JsonProperty("id") + public String getId() { + return id; + } + + /** + * @return The id of the workspace which the collection belongs to. + */ + @JsonProperty("workspace_id") + public String getWorkspaceId() { + return workspaceId; + } + + /** + * @return The name of the collection. For multilingual collections, this will be the name of the default language's content. + */ + @JsonProperty("name") + public String getName() { + return name; + } + + /** + * @return The description of the collection. For multilingual help centers, this will be the description of the collection for the default language. + */ + @JsonProperty("description") + public Optional getDescription() { + return description; + } + + /** + * @return The time when the article was created (seconds). For multilingual articles, this will be the timestamp of creation of the default language's content. + */ + @JsonProperty("created_at") + public int getCreatedAt() { + return createdAt; + } + + /** + * @return The time when the article was last updated (seconds). For multilingual articles, this will be the timestamp of last update of the default language's content. + */ + @JsonProperty("updated_at") + public Optional getUpdatedAt() { + return updatedAt; + } + + /** + * @return The URL of the collection. For multilingual help centers, this will be the URL of the collection for the default language. + */ + @JsonProperty("url") + public Optional getUrl() { + return url; + } + + /** + * @return The icon of the collection. + */ + @JsonProperty("icon") + public Optional getIcon() { + return icon; + } + + /** + * @return The order of the section in relation to others sections within a collection. Values go from 0 upwards. 0 is the default if there's no order. + */ + @JsonProperty("order") + public int getOrder() { + return order; + } + + /** + * @return The default locale of the help center. This field is only returned for multilingual help centers. + */ + @JsonProperty("default_locale") + public Optional getDefaultLocale() { + return defaultLocale; + } + + @JsonProperty("translated_content") + public Optional getTranslatedContent() { + return translatedContent; + } + + /** + * @return The id of the parent collection. If null then it is the first level collection. + */ + @JsonProperty("parent_id") + public Optional getParentId() { + return parentId; + } + + /** + * @return The id of the help center the collection is in. + */ + @JsonProperty("help_center_id") + public Optional getHelpCenterId() { + return helpCenterId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof Collection && equalTo((Collection) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(Collection other) { + return id.equals(other.id) + && workspaceId.equals(other.workspaceId) + && name.equals(other.name) + && description.equals(other.description) + && createdAt == other.createdAt + && updatedAt.equals(other.updatedAt) + && url.equals(other.url) + && icon.equals(other.icon) + && order == other.order + && defaultLocale.equals(other.defaultLocale) + && translatedContent.equals(other.translatedContent) + && parentId.equals(other.parentId) + && helpCenterId.equals(other.helpCenterId); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash( + this.id, + this.workspaceId, + this.name, + this.description, + this.createdAt, + this.updatedAt, + this.url, + this.icon, + this.order, + this.defaultLocale, + this.translatedContent, + this.parentId, + this.helpCenterId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static IdStage builder() { + return new Builder(); + } + + public interface IdStage { + /** + *

The unique identifier for the collection which is given by Intercom.

+ */ + WorkspaceIdStage id(@NotNull String id); + + Builder from(Collection other); + } + + public interface WorkspaceIdStage { + /** + *

The id of the workspace which the collection belongs to.

+ */ + NameStage workspaceId(@NotNull String workspaceId); + } + + public interface NameStage { + /** + *

The name of the collection. For multilingual collections, this will be the name of the default language's content.

+ */ + CreatedAtStage name(@NotNull String name); + } + + public interface CreatedAtStage { + /** + *

The time when the article was created (seconds). For multilingual articles, this will be the timestamp of creation of the default language's content.

+ */ + OrderStage createdAt(int createdAt); + } + + public interface OrderStage { + /** + *

The order of the section in relation to others sections within a collection. Values go from 0 upwards. 0 is the default if there's no order.

+ */ + _FinalStage order(int order); + } + + public interface _FinalStage { + Collection build(); + + /** + *

The description of the collection. For multilingual help centers, this will be the description of the collection for the default language.

+ */ + _FinalStage description(Optional description); + + _FinalStage description(String description); + + /** + *

The time when the article was last updated (seconds). For multilingual articles, this will be the timestamp of last update of the default language's content.

+ */ + _FinalStage updatedAt(Optional updatedAt); + + _FinalStage updatedAt(Integer updatedAt); + + /** + *

The URL of the collection. For multilingual help centers, this will be the URL of the collection for the default language.

+ */ + _FinalStage url(Optional url); + + _FinalStage url(String url); + + /** + *

The icon of the collection.

+ */ + _FinalStage icon(Optional icon); + + _FinalStage icon(String icon); + + /** + *

The default locale of the help center. This field is only returned for multilingual help centers.

+ */ + _FinalStage defaultLocale(Optional defaultLocale); + + _FinalStage defaultLocale(String defaultLocale); + + _FinalStage translatedContent(Optional translatedContent); + + _FinalStage translatedContent(GroupTranslatedContent translatedContent); + + /** + *

The id of the parent collection. If null then it is the first level collection.

+ */ + _FinalStage parentId(Optional parentId); + + _FinalStage parentId(String parentId); + + /** + *

The id of the help center the collection is in.

+ */ + _FinalStage helpCenterId(Optional helpCenterId); + + _FinalStage helpCenterId(Integer helpCenterId); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder + implements IdStage, WorkspaceIdStage, NameStage, CreatedAtStage, OrderStage, _FinalStage { + private String id; + + private String workspaceId; + + private String name; + + private int createdAt; + + private int order; + + private Optional helpCenterId = Optional.empty(); + + private Optional parentId = Optional.empty(); + + private Optional translatedContent = Optional.empty(); + + private Optional defaultLocale = Optional.empty(); + + private Optional icon = Optional.empty(); + + private Optional url = Optional.empty(); + + private Optional updatedAt = Optional.empty(); + + private Optional description = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(Collection other) { + id(other.getId()); + workspaceId(other.getWorkspaceId()); + name(other.getName()); + description(other.getDescription()); + createdAt(other.getCreatedAt()); + updatedAt(other.getUpdatedAt()); + url(other.getUrl()); + icon(other.getIcon()); + order(other.getOrder()); + defaultLocale(other.getDefaultLocale()); + translatedContent(other.getTranslatedContent()); + parentId(other.getParentId()); + helpCenterId(other.getHelpCenterId()); + return this; + } + + /** + *

The unique identifier for the collection which is given by Intercom.

+ *

The unique identifier for the collection which is given by Intercom.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("id") + public WorkspaceIdStage id(@NotNull String id) { + this.id = Objects.requireNonNull(id, "id must not be null"); + return this; + } + + /** + *

The id of the workspace which the collection belongs to.

+ *

The id of the workspace which the collection belongs to.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("workspace_id") + public NameStage workspaceId(@NotNull String workspaceId) { + this.workspaceId = Objects.requireNonNull(workspaceId, "workspaceId must not be null"); + return this; + } + + /** + *

The name of the collection. For multilingual collections, this will be the name of the default language's content.

+ *

The name of the collection. For multilingual collections, this will be the name of the default language's content.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("name") + public CreatedAtStage name(@NotNull String name) { + this.name = Objects.requireNonNull(name, "name must not be null"); + return this; + } + + /** + *

The time when the article was created (seconds). For multilingual articles, this will be the timestamp of creation of the default language's content.

+ *

The time when the article was created (seconds). For multilingual articles, this will be the timestamp of creation of the default language's content.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("created_at") + public OrderStage createdAt(int createdAt) { + this.createdAt = createdAt; + return this; + } + + /** + *

The order of the section in relation to others sections within a collection. Values go from 0 upwards. 0 is the default if there's no order.

+ *

The order of the section in relation to others sections within a collection. Values go from 0 upwards. 0 is the default if there's no order.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("order") + public _FinalStage order(int order) { + this.order = order; + return this; + } + + /** + *

The id of the help center the collection is in.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage helpCenterId(Integer helpCenterId) { + this.helpCenterId = Optional.ofNullable(helpCenterId); + return this; + } + + /** + *

The id of the help center the collection is in.

+ */ + @java.lang.Override + @JsonSetter(value = "help_center_id", nulls = Nulls.SKIP) + public _FinalStage helpCenterId(Optional helpCenterId) { + this.helpCenterId = helpCenterId; + return this; + } + + /** + *

The id of the parent collection. If null then it is the first level collection.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage parentId(String parentId) { + this.parentId = Optional.ofNullable(parentId); + return this; + } + + /** + *

The id of the parent collection. If null then it is the first level collection.

+ */ + @java.lang.Override + @JsonSetter(value = "parent_id", nulls = Nulls.SKIP) + public _FinalStage parentId(Optional parentId) { + this.parentId = parentId; + return this; + } + + @java.lang.Override + public _FinalStage translatedContent(GroupTranslatedContent translatedContent) { + this.translatedContent = Optional.ofNullable(translatedContent); + return this; + } + + @java.lang.Override + @JsonSetter(value = "translated_content", nulls = Nulls.SKIP) + public _FinalStage translatedContent(Optional translatedContent) { + this.translatedContent = translatedContent; + return this; + } + + /** + *

The default locale of the help center. This field is only returned for multilingual help centers.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage defaultLocale(String defaultLocale) { + this.defaultLocale = Optional.ofNullable(defaultLocale); + return this; + } + + /** + *

The default locale of the help center. This field is only returned for multilingual help centers.

+ */ + @java.lang.Override + @JsonSetter(value = "default_locale", nulls = Nulls.SKIP) + public _FinalStage defaultLocale(Optional defaultLocale) { + this.defaultLocale = defaultLocale; + return this; + } + + /** + *

The icon of the collection.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage icon(String icon) { + this.icon = Optional.ofNullable(icon); + return this; + } + + /** + *

The icon of the collection.

+ */ + @java.lang.Override + @JsonSetter(value = "icon", nulls = Nulls.SKIP) + public _FinalStage icon(Optional icon) { + this.icon = icon; + return this; + } + + /** + *

The URL of the collection. For multilingual help centers, this will be the URL of the collection for the default language.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage url(String url) { + this.url = Optional.ofNullable(url); + return this; + } + + /** + *

The URL of the collection. For multilingual help centers, this will be the URL of the collection for the default language.

+ */ + @java.lang.Override + @JsonSetter(value = "url", nulls = Nulls.SKIP) + public _FinalStage url(Optional url) { + this.url = url; + return this; + } + + /** + *

The time when the article was last updated (seconds). For multilingual articles, this will be the timestamp of last update of the default language's content.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage updatedAt(Integer updatedAt) { + this.updatedAt = Optional.ofNullable(updatedAt); + return this; + } + + /** + *

The time when the article was last updated (seconds). For multilingual articles, this will be the timestamp of last update of the default language's content.

+ */ + @java.lang.Override + @JsonSetter(value = "updated_at", nulls = Nulls.SKIP) + public _FinalStage updatedAt(Optional updatedAt) { + this.updatedAt = updatedAt; + return this; + } + + /** + *

The description of the collection. For multilingual help centers, this will be the description of the collection for the default language.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage description(String description) { + this.description = Optional.ofNullable(description); + return this; + } + + /** + *

The description of the collection. For multilingual help centers, this will be the description of the collection for the default language.

+ */ + @java.lang.Override + @JsonSetter(value = "description", nulls = Nulls.SKIP) + public _FinalStage description(Optional description) { + this.description = description; + return this; + } + + @java.lang.Override + public Collection build() { + return new Collection( + id, + workspaceId, + name, + description, + createdAt, + updatedAt, + url, + icon, + order, + defaultLocale, + translatedContent, + parentId, + helpCenterId, + additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/helpcenter/types/HelpCenter.java b/src/main/java/com/intercom/api/resources/helpcenter/types/HelpCenter.java new file mode 100644 index 00000000..71281c3e --- /dev/null +++ b/src/main/java/com/intercom/api/resources/helpcenter/types/HelpCenter.java @@ -0,0 +1,449 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.helpcenter.types; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = HelpCenter.Builder.class) +public final class HelpCenter { + private final String id; + + private final String workspaceId; + + private final int createdAt; + + private final int updatedAt; + + private final String identifier; + + private final Optional websiteTurnedOn; + + private final Optional displayName; + + private final Optional url; + + private final Optional customDomain; + + private final Map additionalProperties; + + private HelpCenter( + String id, + String workspaceId, + int createdAt, + int updatedAt, + String identifier, + Optional websiteTurnedOn, + Optional displayName, + Optional url, + Optional customDomain, + Map additionalProperties) { + this.id = id; + this.workspaceId = workspaceId; + this.createdAt = createdAt; + this.updatedAt = updatedAt; + this.identifier = identifier; + this.websiteTurnedOn = websiteTurnedOn; + this.displayName = displayName; + this.url = url; + this.customDomain = customDomain; + this.additionalProperties = additionalProperties; + } + + /** + * @return The unique identifier for the Help Center which is given by Intercom. + */ + @JsonProperty("id") + public String getId() { + return id; + } + + /** + * @return The id of the workspace which the Help Center belongs to. + */ + @JsonProperty("workspace_id") + public String getWorkspaceId() { + return workspaceId; + } + + /** + * @return The time when the Help Center was created. + */ + @JsonProperty("created_at") + public int getCreatedAt() { + return createdAt; + } + + /** + * @return The time when the Help Center was last updated. + */ + @JsonProperty("updated_at") + public int getUpdatedAt() { + return updatedAt; + } + + /** + * @return The identifier of the Help Center. This is used in the URL of the Help Center. + */ + @JsonProperty("identifier") + public String getIdentifier() { + return identifier; + } + + /** + * @return Whether the Help Center is turned on or not. This is controlled in your Help Center settings. + */ + @JsonProperty("website_turned_on") + public Optional getWebsiteTurnedOn() { + return websiteTurnedOn; + } + + /** + * @return The display name of the Help Center only seen by teammates. + */ + @JsonProperty("display_name") + public Optional getDisplayName() { + return displayName; + } + + /** + * @return The URL for the help center, if you have a custom domain then this will show the URL using the custom domain. + */ + @JsonProperty("url") + public Optional getUrl() { + return url; + } + + /** + * @return Custom domain configured for the help center + */ + @JsonProperty("custom_domain") + public Optional getCustomDomain() { + return customDomain; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof HelpCenter && equalTo((HelpCenter) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(HelpCenter other) { + return id.equals(other.id) + && workspaceId.equals(other.workspaceId) + && createdAt == other.createdAt + && updatedAt == other.updatedAt + && identifier.equals(other.identifier) + && websiteTurnedOn.equals(other.websiteTurnedOn) + && displayName.equals(other.displayName) + && url.equals(other.url) + && customDomain.equals(other.customDomain); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash( + this.id, + this.workspaceId, + this.createdAt, + this.updatedAt, + this.identifier, + this.websiteTurnedOn, + this.displayName, + this.url, + this.customDomain); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static IdStage builder() { + return new Builder(); + } + + public interface IdStage { + /** + *

The unique identifier for the Help Center which is given by Intercom.

+ */ + WorkspaceIdStage id(@NotNull String id); + + Builder from(HelpCenter other); + } + + public interface WorkspaceIdStage { + /** + *

The id of the workspace which the Help Center belongs to.

+ */ + CreatedAtStage workspaceId(@NotNull String workspaceId); + } + + public interface CreatedAtStage { + /** + *

The time when the Help Center was created.

+ */ + UpdatedAtStage createdAt(int createdAt); + } + + public interface UpdatedAtStage { + /** + *

The time when the Help Center was last updated.

+ */ + IdentifierStage updatedAt(int updatedAt); + } + + public interface IdentifierStage { + /** + *

The identifier of the Help Center. This is used in the URL of the Help Center.

+ */ + _FinalStage identifier(@NotNull String identifier); + } + + public interface _FinalStage { + HelpCenter build(); + + /** + *

Whether the Help Center is turned on or not. This is controlled in your Help Center settings.

+ */ + _FinalStage websiteTurnedOn(Optional websiteTurnedOn); + + _FinalStage websiteTurnedOn(Boolean websiteTurnedOn); + + /** + *

The display name of the Help Center only seen by teammates.

+ */ + _FinalStage displayName(Optional displayName); + + _FinalStage displayName(String displayName); + + /** + *

The URL for the help center, if you have a custom domain then this will show the URL using the custom domain.

+ */ + _FinalStage url(Optional url); + + _FinalStage url(String url); + + /** + *

Custom domain configured for the help center

+ */ + _FinalStage customDomain(Optional customDomain); + + _FinalStage customDomain(String customDomain); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder + implements IdStage, WorkspaceIdStage, CreatedAtStage, UpdatedAtStage, IdentifierStage, _FinalStage { + private String id; + + private String workspaceId; + + private int createdAt; + + private int updatedAt; + + private String identifier; + + private Optional customDomain = Optional.empty(); + + private Optional url = Optional.empty(); + + private Optional displayName = Optional.empty(); + + private Optional websiteTurnedOn = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(HelpCenter other) { + id(other.getId()); + workspaceId(other.getWorkspaceId()); + createdAt(other.getCreatedAt()); + updatedAt(other.getUpdatedAt()); + identifier(other.getIdentifier()); + websiteTurnedOn(other.getWebsiteTurnedOn()); + displayName(other.getDisplayName()); + url(other.getUrl()); + customDomain(other.getCustomDomain()); + return this; + } + + /** + *

The unique identifier for the Help Center which is given by Intercom.

+ *

The unique identifier for the Help Center which is given by Intercom.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("id") + public WorkspaceIdStage id(@NotNull String id) { + this.id = Objects.requireNonNull(id, "id must not be null"); + return this; + } + + /** + *

The id of the workspace which the Help Center belongs to.

+ *

The id of the workspace which the Help Center belongs to.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("workspace_id") + public CreatedAtStage workspaceId(@NotNull String workspaceId) { + this.workspaceId = Objects.requireNonNull(workspaceId, "workspaceId must not be null"); + return this; + } + + /** + *

The time when the Help Center was created.

+ *

The time when the Help Center was created.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("created_at") + public UpdatedAtStage createdAt(int createdAt) { + this.createdAt = createdAt; + return this; + } + + /** + *

The time when the Help Center was last updated.

+ *

The time when the Help Center was last updated.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("updated_at") + public IdentifierStage updatedAt(int updatedAt) { + this.updatedAt = updatedAt; + return this; + } + + /** + *

The identifier of the Help Center. This is used in the URL of the Help Center.

+ *

The identifier of the Help Center. This is used in the URL of the Help Center.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("identifier") + public _FinalStage identifier(@NotNull String identifier) { + this.identifier = Objects.requireNonNull(identifier, "identifier must not be null"); + return this; + } + + /** + *

Custom domain configured for the help center

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage customDomain(String customDomain) { + this.customDomain = Optional.ofNullable(customDomain); + return this; + } + + /** + *

Custom domain configured for the help center

+ */ + @java.lang.Override + @JsonSetter(value = "custom_domain", nulls = Nulls.SKIP) + public _FinalStage customDomain(Optional customDomain) { + this.customDomain = customDomain; + return this; + } + + /** + *

The URL for the help center, if you have a custom domain then this will show the URL using the custom domain.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage url(String url) { + this.url = Optional.ofNullable(url); + return this; + } + + /** + *

The URL for the help center, if you have a custom domain then this will show the URL using the custom domain.

+ */ + @java.lang.Override + @JsonSetter(value = "url", nulls = Nulls.SKIP) + public _FinalStage url(Optional url) { + this.url = url; + return this; + } + + /** + *

The display name of the Help Center only seen by teammates.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage displayName(String displayName) { + this.displayName = Optional.ofNullable(displayName); + return this; + } + + /** + *

The display name of the Help Center only seen by teammates.

+ */ + @java.lang.Override + @JsonSetter(value = "display_name", nulls = Nulls.SKIP) + public _FinalStage displayName(Optional displayName) { + this.displayName = displayName; + return this; + } + + /** + *

Whether the Help Center is turned on or not. This is controlled in your Help Center settings.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage websiteTurnedOn(Boolean websiteTurnedOn) { + this.websiteTurnedOn = Optional.ofNullable(websiteTurnedOn); + return this; + } + + /** + *

Whether the Help Center is turned on or not. This is controlled in your Help Center settings.

+ */ + @java.lang.Override + @JsonSetter(value = "website_turned_on", nulls = Nulls.SKIP) + public _FinalStage websiteTurnedOn(Optional websiteTurnedOn) { + this.websiteTurnedOn = websiteTurnedOn; + return this; + } + + @java.lang.Override + public HelpCenter build() { + return new HelpCenter( + id, + workspaceId, + createdAt, + updatedAt, + identifier, + websiteTurnedOn, + displayName, + url, + customDomain, + additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/helpcenter/types/HelpCenterList.java b/src/main/java/com/intercom/api/resources/helpcenter/types/HelpCenterList.java new file mode 100644 index 00000000..1a1f9800 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/helpcenter/types/HelpCenterList.java @@ -0,0 +1,131 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.helpcenter.types; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = HelpCenterList.Builder.class) +public final class HelpCenterList { + private final Optional type; + + private final Optional> data; + + private final Map additionalProperties; + + private HelpCenterList( + Optional type, Optional> data, Map additionalProperties) { + this.type = type; + this.data = data; + this.additionalProperties = additionalProperties; + } + + /** + * @return The type of the object - list. + */ + @JsonProperty("type") + public Optional getType() { + return type; + } + + /** + * @return An array of Help Center objects + */ + @JsonProperty("data") + public Optional> getData() { + return data; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof HelpCenterList && equalTo((HelpCenterList) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(HelpCenterList other) { + return type.equals(other.type) && data.equals(other.data); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.type, this.data); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static Builder builder() { + return new Builder(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder { + private Optional type = Optional.empty(); + + private Optional> data = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + public Builder from(HelpCenterList other) { + type(other.getType()); + data(other.getData()); + return this; + } + + /** + *

The type of the object - list.

+ */ + @JsonSetter(value = "type", nulls = Nulls.SKIP) + public Builder type(Optional type) { + this.type = type; + return this; + } + + public Builder type(String type) { + this.type = Optional.ofNullable(type); + return this; + } + + /** + *

An array of Help Center objects

+ */ + @JsonSetter(value = "data", nulls = Nulls.SKIP) + public Builder data(Optional> data) { + this.data = data; + return this; + } + + public Builder data(List data) { + this.data = Optional.ofNullable(data); + return this; + } + + public HelpCenterList build() { + return new HelpCenterList(type, data, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/helpcenters/AsyncHelpCentersClient.java b/src/main/java/com/intercom/api/resources/helpcenters/AsyncHelpCentersClient.java new file mode 100644 index 00000000..546eb3ab --- /dev/null +++ b/src/main/java/com/intercom/api/resources/helpcenters/AsyncHelpCentersClient.java @@ -0,0 +1,76 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.helpcenters; + +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.core.Suppliers; +import com.intercom.api.core.pagination.SyncPagingIterable; +import com.intercom.api.resources.helpcenter.types.HelpCenter; +import com.intercom.api.resources.helpcenters.collections.AsyncCollectionsClient; +import com.intercom.api.resources.helpcenters.requests.FindHelpCenterRequest; +import com.intercom.api.resources.helpcenters.requests.ListHelpCentersRequest; +import java.util.concurrent.CompletableFuture; +import java.util.function.Supplier; + +public class AsyncHelpCentersClient { + protected final ClientOptions clientOptions; + + private final AsyncRawHelpCentersClient rawClient; + + protected final Supplier collectionsClient; + + public AsyncHelpCentersClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + this.rawClient = new AsyncRawHelpCentersClient(clientOptions); + this.collectionsClient = Suppliers.memoize(() -> new AsyncCollectionsClient(clientOptions)); + } + + /** + * Get responses with HTTP metadata like headers + */ + public AsyncRawHelpCentersClient withRawResponse() { + return this.rawClient; + } + + /** + * You can fetch the details of a single Help Center by making a GET request to https://api.intercom.io/help_center/help_center/<id>. + */ + public CompletableFuture find(FindHelpCenterRequest request) { + return this.rawClient.find(request).thenApply(response -> response.body()); + } + + /** + * You can fetch the details of a single Help Center by making a GET request to https://api.intercom.io/help_center/help_center/<id>. + */ + public CompletableFuture find(FindHelpCenterRequest request, RequestOptions requestOptions) { + return this.rawClient.find(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can list all Help Centers by making a GET request to https://api.intercom.io/help_center/help_centers. + */ + public CompletableFuture> list() { + return this.rawClient.list().thenApply(response -> response.body()); + } + + /** + * You can list all Help Centers by making a GET request to https://api.intercom.io/help_center/help_centers. + */ + public CompletableFuture> list(ListHelpCentersRequest request) { + return this.rawClient.list(request).thenApply(response -> response.body()); + } + + /** + * You can list all Help Centers by making a GET request to https://api.intercom.io/help_center/help_centers. + */ + public CompletableFuture> list( + ListHelpCentersRequest request, RequestOptions requestOptions) { + return this.rawClient.list(request, requestOptions).thenApply(response -> response.body()); + } + + public AsyncCollectionsClient collections() { + return this.collectionsClient.get(); + } +} diff --git a/src/main/java/com/intercom/api/resources/helpcenters/AsyncRawHelpCentersClient.java b/src/main/java/com/intercom/api/resources/helpcenters/AsyncRawHelpCentersClient.java new file mode 100644 index 00000000..e959ae65 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/helpcenters/AsyncRawHelpCentersClient.java @@ -0,0 +1,211 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.helpcenters; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.IntercomApiException; +import com.intercom.api.core.IntercomException; +import com.intercom.api.core.IntercomHttpResponse; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.core.QueryStringMapper; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.core.pagination.SyncPagingIterable; +import com.intercom.api.errors.NotFoundError; +import com.intercom.api.errors.UnauthorizedError; +import com.intercom.api.resources.helpcenter.types.HelpCenter; +import com.intercom.api.resources.helpcenter.types.HelpCenterList; +import com.intercom.api.resources.helpcenters.requests.FindHelpCenterRequest; +import com.intercom.api.resources.helpcenters.requests.ListHelpCentersRequest; +import com.intercom.api.types.Error; +import java.io.IOException; +import java.util.Collections; +import java.util.List; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.ExecutionException; +import okhttp3.Call; +import okhttp3.Callback; +import okhttp3.Headers; +import okhttp3.HttpUrl; +import okhttp3.OkHttpClient; +import okhttp3.Request; +import okhttp3.Response; +import okhttp3.ResponseBody; +import org.jetbrains.annotations.NotNull; + +public class AsyncRawHelpCentersClient { + protected final ClientOptions clientOptions; + + public AsyncRawHelpCentersClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + } + + /** + * You can fetch the details of a single Help Center by making a GET request to https://api.intercom.io/help_center/help_center/<id>. + */ + public CompletableFuture> find(FindHelpCenterRequest request) { + return find(request, null); + } + + /** + * You can fetch the details of a single Help Center by making a GET request to https://api.intercom.io/help_center/help_center/<id>. + */ + public CompletableFuture> find( + FindHelpCenterRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("help_center/help_centers") + .addPathSegment(Integer.toString(request.getHelpCenterId())) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, HelpCenter.class), response)); + return; + } + try { + switch (response.code()) { + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 404: + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can list all Help Centers by making a GET request to https://api.intercom.io/help_center/help_centers. + */ + public CompletableFuture>> list() { + return list(ListHelpCentersRequest.builder().build()); + } + + /** + * You can list all Help Centers by making a GET request to https://api.intercom.io/help_center/help_centers. + */ + public CompletableFuture>> list( + ListHelpCentersRequest request) { + return list(request, null); + } + + /** + * You can list all Help Centers by making a GET request to https://api.intercom.io/help_center/help_centers. + */ + public CompletableFuture>> list( + ListHelpCentersRequest request, RequestOptions requestOptions) { + HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("help_center/help_centers"); + if (request.getPage().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "page", request.getPage().get(), false); + } + if (request.getPerPage().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "per_page", request.getPerPage().get(), false); + } + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl.build()) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture>> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + HelpCenterList parsedResponse = + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, HelpCenterList.class); + int newPageNumber = request.getPage() + .map((Integer page) -> page + 1) + .orElse(1); + ListHelpCentersRequest nextRequest = ListHelpCentersRequest.builder() + .from(request) + .page(newPageNumber) + .build(); + List result = parsedResponse.getData().orElse(Collections.emptyList()); + future.complete(new IntercomHttpResponse<>( + new SyncPagingIterable(true, result, parsedResponse, () -> { + try { + return list(nextRequest, requestOptions) + .get() + .body(); + } catch (InterruptedException | ExecutionException e) { + throw new RuntimeException(e); + } + }), + response)); + return; + } + try { + if (response.code() == 401) { + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } +} diff --git a/src/main/java/com/intercom/api/resources/helpcenters/HelpCentersClient.java b/src/main/java/com/intercom/api/resources/helpcenters/HelpCentersClient.java new file mode 100644 index 00000000..71cac18f --- /dev/null +++ b/src/main/java/com/intercom/api/resources/helpcenters/HelpCentersClient.java @@ -0,0 +1,74 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.helpcenters; + +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.core.Suppliers; +import com.intercom.api.core.pagination.SyncPagingIterable; +import com.intercom.api.resources.helpcenter.types.HelpCenter; +import com.intercom.api.resources.helpcenters.collections.CollectionsClient; +import com.intercom.api.resources.helpcenters.requests.FindHelpCenterRequest; +import com.intercom.api.resources.helpcenters.requests.ListHelpCentersRequest; +import java.util.function.Supplier; + +public class HelpCentersClient { + protected final ClientOptions clientOptions; + + private final RawHelpCentersClient rawClient; + + protected final Supplier collectionsClient; + + public HelpCentersClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + this.rawClient = new RawHelpCentersClient(clientOptions); + this.collectionsClient = Suppliers.memoize(() -> new CollectionsClient(clientOptions)); + } + + /** + * Get responses with HTTP metadata like headers + */ + public RawHelpCentersClient withRawResponse() { + return this.rawClient; + } + + /** + * You can fetch the details of a single Help Center by making a GET request to https://api.intercom.io/help_center/help_center/<id>. + */ + public HelpCenter find(FindHelpCenterRequest request) { + return this.rawClient.find(request).body(); + } + + /** + * You can fetch the details of a single Help Center by making a GET request to https://api.intercom.io/help_center/help_center/<id>. + */ + public HelpCenter find(FindHelpCenterRequest request, RequestOptions requestOptions) { + return this.rawClient.find(request, requestOptions).body(); + } + + /** + * You can list all Help Centers by making a GET request to https://api.intercom.io/help_center/help_centers. + */ + public SyncPagingIterable list() { + return this.rawClient.list().body(); + } + + /** + * You can list all Help Centers by making a GET request to https://api.intercom.io/help_center/help_centers. + */ + public SyncPagingIterable list(ListHelpCentersRequest request) { + return this.rawClient.list(request).body(); + } + + /** + * You can list all Help Centers by making a GET request to https://api.intercom.io/help_center/help_centers. + */ + public SyncPagingIterable list(ListHelpCentersRequest request, RequestOptions requestOptions) { + return this.rawClient.list(request, requestOptions).body(); + } + + public CollectionsClient collections() { + return this.collectionsClient.get(); + } +} diff --git a/src/main/java/com/intercom/api/resources/helpcenters/RawHelpCentersClient.java b/src/main/java/com/intercom/api/resources/helpcenters/RawHelpCentersClient.java new file mode 100644 index 00000000..ae023ce9 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/helpcenters/RawHelpCentersClient.java @@ -0,0 +1,166 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.helpcenters; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.IntercomApiException; +import com.intercom.api.core.IntercomException; +import com.intercom.api.core.IntercomHttpResponse; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.core.QueryStringMapper; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.core.pagination.SyncPagingIterable; +import com.intercom.api.errors.NotFoundError; +import com.intercom.api.errors.UnauthorizedError; +import com.intercom.api.resources.helpcenter.types.HelpCenter; +import com.intercom.api.resources.helpcenter.types.HelpCenterList; +import com.intercom.api.resources.helpcenters.requests.FindHelpCenterRequest; +import com.intercom.api.resources.helpcenters.requests.ListHelpCentersRequest; +import com.intercom.api.types.Error; +import java.io.IOException; +import java.util.Collections; +import java.util.List; +import okhttp3.Headers; +import okhttp3.HttpUrl; +import okhttp3.OkHttpClient; +import okhttp3.Request; +import okhttp3.Response; +import okhttp3.ResponseBody; + +public class RawHelpCentersClient { + protected final ClientOptions clientOptions; + + public RawHelpCentersClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + } + + /** + * You can fetch the details of a single Help Center by making a GET request to https://api.intercom.io/help_center/help_center/<id>. + */ + public IntercomHttpResponse find(FindHelpCenterRequest request) { + return find(request, null); + } + + /** + * You can fetch the details of a single Help Center by making a GET request to https://api.intercom.io/help_center/help_center/<id>. + */ + public IntercomHttpResponse find(FindHelpCenterRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("help_center/help_centers") + .addPathSegment(Integer.toString(request.getHelpCenterId())) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, HelpCenter.class), response); + } + try { + switch (response.code()) { + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 404: + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can list all Help Centers by making a GET request to https://api.intercom.io/help_center/help_centers. + */ + public IntercomHttpResponse> list() { + return list(ListHelpCentersRequest.builder().build()); + } + + /** + * You can list all Help Centers by making a GET request to https://api.intercom.io/help_center/help_centers. + */ + public IntercomHttpResponse> list(ListHelpCentersRequest request) { + return list(request, null); + } + + /** + * You can list all Help Centers by making a GET request to https://api.intercom.io/help_center/help_centers. + */ + public IntercomHttpResponse> list( + ListHelpCentersRequest request, RequestOptions requestOptions) { + HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("help_center/help_centers"); + if (request.getPage().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "page", request.getPage().get(), false); + } + if (request.getPerPage().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "per_page", request.getPerPage().get(), false); + } + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl.build()) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + HelpCenterList parsedResponse = + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, HelpCenterList.class); + int newPageNumber = + request.getPage().map((Integer page) -> page + 1).orElse(1); + ListHelpCentersRequest nextRequest = ListHelpCentersRequest.builder() + .from(request) + .page(newPageNumber) + .build(); + List result = parsedResponse.getData().orElse(Collections.emptyList()); + return new IntercomHttpResponse<>( + new SyncPagingIterable( + true, result, parsedResponse, () -> list(nextRequest, requestOptions) + .body()), + response); + } + try { + if (response.code() == 401) { + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/helpcenters/collections/AsyncCollectionsClient.java b/src/main/java/com/intercom/api/resources/helpcenters/collections/AsyncCollectionsClient.java new file mode 100644 index 00000000..8ec144fc --- /dev/null +++ b/src/main/java/com/intercom/api/resources/helpcenters/collections/AsyncCollectionsClient.java @@ -0,0 +1,116 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.helpcenters.collections; + +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.core.pagination.SyncPagingIterable; +import com.intercom.api.resources.helpcenter.types.Collection; +import com.intercom.api.resources.helpcenters.collections.requests.CreateCollectionRequest; +import com.intercom.api.resources.helpcenters.collections.requests.DeleteCollectionRequest; +import com.intercom.api.resources.helpcenters.collections.requests.FindCollectionRequest; +import com.intercom.api.resources.helpcenters.collections.requests.ListCollectionsRequest; +import com.intercom.api.resources.helpcenters.collections.requests.UpdateCollectionRequest; +import com.intercom.api.types.DeletedCollectionObject; +import java.util.concurrent.CompletableFuture; + +public class AsyncCollectionsClient { + protected final ClientOptions clientOptions; + + private final AsyncRawCollectionsClient rawClient; + + public AsyncCollectionsClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + this.rawClient = new AsyncRawCollectionsClient(clientOptions); + } + + /** + * Get responses with HTTP metadata like headers + */ + public AsyncRawCollectionsClient withRawResponse() { + return this.rawClient; + } + + /** + * You can fetch a list of all collections by making a GET request to https://api.intercom.io/help_center/collections. + *

Collections will be returned in descending order on the updated_at attribute. This means if you need to iterate through results then we'll show the most recently updated collections first.

+ */ + public CompletableFuture> list() { + return this.rawClient.list().thenApply(response -> response.body()); + } + + /** + * You can fetch a list of all collections by making a GET request to https://api.intercom.io/help_center/collections. + *

Collections will be returned in descending order on the updated_at attribute. This means if you need to iterate through results then we'll show the most recently updated collections first.

+ */ + public CompletableFuture> list(ListCollectionsRequest request) { + return this.rawClient.list(request).thenApply(response -> response.body()); + } + + /** + * You can fetch a list of all collections by making a GET request to https://api.intercom.io/help_center/collections. + *

Collections will be returned in descending order on the updated_at attribute. This means if you need to iterate through results then we'll show the most recently updated collections first.

+ */ + public CompletableFuture> list( + ListCollectionsRequest request, RequestOptions requestOptions) { + return this.rawClient.list(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can create a new collection by making a POST request to https://api.intercom.io/help_center/collections. + */ + public CompletableFuture create(CreateCollectionRequest request) { + return this.rawClient.create(request).thenApply(response -> response.body()); + } + + /** + * You can create a new collection by making a POST request to https://api.intercom.io/help_center/collections. + */ + public CompletableFuture create(CreateCollectionRequest request, RequestOptions requestOptions) { + return this.rawClient.create(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can fetch the details of a single collection by making a GET request to https://api.intercom.io/help_center/collections/<id>. + */ + public CompletableFuture find(FindCollectionRequest request) { + return this.rawClient.find(request).thenApply(response -> response.body()); + } + + /** + * You can fetch the details of a single collection by making a GET request to https://api.intercom.io/help_center/collections/<id>. + */ + public CompletableFuture find(FindCollectionRequest request, RequestOptions requestOptions) { + return this.rawClient.find(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can update the details of a single collection by making a PUT request to https://api.intercom.io/collections/<id>. + */ + public CompletableFuture update(UpdateCollectionRequest request) { + return this.rawClient.update(request).thenApply(response -> response.body()); + } + + /** + * You can update the details of a single collection by making a PUT request to https://api.intercom.io/collections/<id>. + */ + public CompletableFuture update(UpdateCollectionRequest request, RequestOptions requestOptions) { + return this.rawClient.update(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can delete a single collection by making a DELETE request to https://api.intercom.io/collections/<id>. + */ + public CompletableFuture delete(DeleteCollectionRequest request) { + return this.rawClient.delete(request).thenApply(response -> response.body()); + } + + /** + * You can delete a single collection by making a DELETE request to https://api.intercom.io/collections/<id>. + */ + public CompletableFuture delete( + DeleteCollectionRequest request, RequestOptions requestOptions) { + return this.rawClient.delete(request, requestOptions).thenApply(response -> response.body()); + } +} diff --git a/src/main/java/com/intercom/api/resources/helpcenters/collections/AsyncRawCollectionsClient.java b/src/main/java/com/intercom/api/resources/helpcenters/collections/AsyncRawCollectionsClient.java new file mode 100644 index 00000000..093ff0bd --- /dev/null +++ b/src/main/java/com/intercom/api/resources/helpcenters/collections/AsyncRawCollectionsClient.java @@ -0,0 +1,450 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.helpcenters.collections; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.IntercomApiException; +import com.intercom.api.core.IntercomException; +import com.intercom.api.core.IntercomHttpResponse; +import com.intercom.api.core.MediaTypes; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.core.QueryStringMapper; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.core.pagination.SyncPagingIterable; +import com.intercom.api.errors.BadRequestError; +import com.intercom.api.errors.NotFoundError; +import com.intercom.api.errors.UnauthorizedError; +import com.intercom.api.resources.helpcenter.types.Collection; +import com.intercom.api.resources.helpcenters.collections.requests.CreateCollectionRequest; +import com.intercom.api.resources.helpcenters.collections.requests.DeleteCollectionRequest; +import com.intercom.api.resources.helpcenters.collections.requests.FindCollectionRequest; +import com.intercom.api.resources.helpcenters.collections.requests.ListCollectionsRequest; +import com.intercom.api.resources.helpcenters.collections.requests.UpdateCollectionRequest; +import com.intercom.api.types.CollectionList; +import com.intercom.api.types.DeletedCollectionObject; +import com.intercom.api.types.Error; +import java.io.IOException; +import java.util.Collections; +import java.util.List; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.ExecutionException; +import okhttp3.Call; +import okhttp3.Callback; +import okhttp3.Headers; +import okhttp3.HttpUrl; +import okhttp3.OkHttpClient; +import okhttp3.Request; +import okhttp3.RequestBody; +import okhttp3.Response; +import okhttp3.ResponseBody; +import org.jetbrains.annotations.NotNull; + +public class AsyncRawCollectionsClient { + protected final ClientOptions clientOptions; + + public AsyncRawCollectionsClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + } + + /** + * You can fetch a list of all collections by making a GET request to https://api.intercom.io/help_center/collections. + *

Collections will be returned in descending order on the updated_at attribute. This means if you need to iterate through results then we'll show the most recently updated collections first.

+ */ + public CompletableFuture>> list() { + return list(ListCollectionsRequest.builder().build()); + } + + /** + * You can fetch a list of all collections by making a GET request to https://api.intercom.io/help_center/collections. + *

Collections will be returned in descending order on the updated_at attribute. This means if you need to iterate through results then we'll show the most recently updated collections first.

+ */ + public CompletableFuture>> list( + ListCollectionsRequest request) { + return list(request, null); + } + + /** + * You can fetch a list of all collections by making a GET request to https://api.intercom.io/help_center/collections. + *

Collections will be returned in descending order on the updated_at attribute. This means if you need to iterate through results then we'll show the most recently updated collections first.

+ */ + public CompletableFuture>> list( + ListCollectionsRequest request, RequestOptions requestOptions) { + HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("help_center/collections"); + if (request.getPage().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "page", request.getPage().get(), false); + } + if (request.getPerPage().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "per_page", request.getPerPage().get(), false); + } + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl.build()) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture>> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + CollectionList parsedResponse = + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, CollectionList.class); + int newPageNumber = request.getPage() + .map((Integer page) -> page + 1) + .orElse(1); + ListCollectionsRequest nextRequest = ListCollectionsRequest.builder() + .from(request) + .page(newPageNumber) + .build(); + List result = parsedResponse.getData().orElse(Collections.emptyList()); + future.complete(new IntercomHttpResponse<>( + new SyncPagingIterable(true, result, parsedResponse, () -> { + try { + return list(nextRequest, requestOptions) + .get() + .body(); + } catch (InterruptedException | ExecutionException e) { + throw new RuntimeException(e); + } + }), + response)); + return; + } + try { + if (response.code() == 401) { + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can create a new collection by making a POST request to https://api.intercom.io/help_center/collections. + */ + public CompletableFuture> create(CreateCollectionRequest request) { + return create(request, null); + } + + /** + * You can create a new collection by making a POST request to https://api.intercom.io/help_center/collections. + */ + public CompletableFuture> create( + CreateCollectionRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("help_center/collections") + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Collection.class), response)); + return; + } + try { + switch (response.code()) { + case 400: + future.completeExceptionally(new BadRequestError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can fetch the details of a single collection by making a GET request to https://api.intercom.io/help_center/collections/<id>. + */ + public CompletableFuture> find(FindCollectionRequest request) { + return find(request, null); + } + + /** + * You can fetch the details of a single collection by making a GET request to https://api.intercom.io/help_center/collections/<id>. + */ + public CompletableFuture> find( + FindCollectionRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("help_center/collections") + .addPathSegment(Integer.toString(request.getCollectionId())) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Collection.class), response)); + return; + } + try { + switch (response.code()) { + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 404: + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can update the details of a single collection by making a PUT request to https://api.intercom.io/collections/<id>. + */ + public CompletableFuture> update(UpdateCollectionRequest request) { + return update(request, null); + } + + /** + * You can update the details of a single collection by making a PUT request to https://api.intercom.io/collections/<id>. + */ + public CompletableFuture> update( + UpdateCollectionRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("help_center/collections") + .addPathSegment(Integer.toString(request.getCollectionId())) + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("PUT", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Collection.class), response)); + return; + } + try { + switch (response.code()) { + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 404: + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can delete a single collection by making a DELETE request to https://api.intercom.io/collections/<id>. + */ + public CompletableFuture> delete(DeleteCollectionRequest request) { + return delete(request, null); + } + + /** + * You can delete a single collection by making a DELETE request to https://api.intercom.io/collections/<id>. + */ + public CompletableFuture> delete( + DeleteCollectionRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("help_center/collections") + .addPathSegment(Integer.toString(request.getCollectionId())) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("DELETE", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, DeletedCollectionObject.class), + response)); + return; + } + try { + switch (response.code()) { + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 404: + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } +} diff --git a/src/main/java/com/intercom/api/resources/helpcenters/collections/CollectionsClient.java b/src/main/java/com/intercom/api/resources/helpcenters/collections/CollectionsClient.java new file mode 100644 index 00000000..fda987d0 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/helpcenters/collections/CollectionsClient.java @@ -0,0 +1,113 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.helpcenters.collections; + +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.core.pagination.SyncPagingIterable; +import com.intercom.api.resources.helpcenter.types.Collection; +import com.intercom.api.resources.helpcenters.collections.requests.CreateCollectionRequest; +import com.intercom.api.resources.helpcenters.collections.requests.DeleteCollectionRequest; +import com.intercom.api.resources.helpcenters.collections.requests.FindCollectionRequest; +import com.intercom.api.resources.helpcenters.collections.requests.ListCollectionsRequest; +import com.intercom.api.resources.helpcenters.collections.requests.UpdateCollectionRequest; +import com.intercom.api.types.DeletedCollectionObject; + +public class CollectionsClient { + protected final ClientOptions clientOptions; + + private final RawCollectionsClient rawClient; + + public CollectionsClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + this.rawClient = new RawCollectionsClient(clientOptions); + } + + /** + * Get responses with HTTP metadata like headers + */ + public RawCollectionsClient withRawResponse() { + return this.rawClient; + } + + /** + * You can fetch a list of all collections by making a GET request to https://api.intercom.io/help_center/collections. + *

Collections will be returned in descending order on the updated_at attribute. This means if you need to iterate through results then we'll show the most recently updated collections first.

+ */ + public SyncPagingIterable list() { + return this.rawClient.list().body(); + } + + /** + * You can fetch a list of all collections by making a GET request to https://api.intercom.io/help_center/collections. + *

Collections will be returned in descending order on the updated_at attribute. This means if you need to iterate through results then we'll show the most recently updated collections first.

+ */ + public SyncPagingIterable list(ListCollectionsRequest request) { + return this.rawClient.list(request).body(); + } + + /** + * You can fetch a list of all collections by making a GET request to https://api.intercom.io/help_center/collections. + *

Collections will be returned in descending order on the updated_at attribute. This means if you need to iterate through results then we'll show the most recently updated collections first.

+ */ + public SyncPagingIterable list(ListCollectionsRequest request, RequestOptions requestOptions) { + return this.rawClient.list(request, requestOptions).body(); + } + + /** + * You can create a new collection by making a POST request to https://api.intercom.io/help_center/collections. + */ + public Collection create(CreateCollectionRequest request) { + return this.rawClient.create(request).body(); + } + + /** + * You can create a new collection by making a POST request to https://api.intercom.io/help_center/collections. + */ + public Collection create(CreateCollectionRequest request, RequestOptions requestOptions) { + return this.rawClient.create(request, requestOptions).body(); + } + + /** + * You can fetch the details of a single collection by making a GET request to https://api.intercom.io/help_center/collections/<id>. + */ + public Collection find(FindCollectionRequest request) { + return this.rawClient.find(request).body(); + } + + /** + * You can fetch the details of a single collection by making a GET request to https://api.intercom.io/help_center/collections/<id>. + */ + public Collection find(FindCollectionRequest request, RequestOptions requestOptions) { + return this.rawClient.find(request, requestOptions).body(); + } + + /** + * You can update the details of a single collection by making a PUT request to https://api.intercom.io/collections/<id>. + */ + public Collection update(UpdateCollectionRequest request) { + return this.rawClient.update(request).body(); + } + + /** + * You can update the details of a single collection by making a PUT request to https://api.intercom.io/collections/<id>. + */ + public Collection update(UpdateCollectionRequest request, RequestOptions requestOptions) { + return this.rawClient.update(request, requestOptions).body(); + } + + /** + * You can delete a single collection by making a DELETE request to https://api.intercom.io/collections/<id>. + */ + public DeletedCollectionObject delete(DeleteCollectionRequest request) { + return this.rawClient.delete(request).body(); + } + + /** + * You can delete a single collection by making a DELETE request to https://api.intercom.io/collections/<id>. + */ + public DeletedCollectionObject delete(DeleteCollectionRequest request, RequestOptions requestOptions) { + return this.rawClient.delete(request, requestOptions).body(); + } +} diff --git a/src/main/java/com/intercom/api/resources/helpcenters/collections/RawCollectionsClient.java b/src/main/java/com/intercom/api/resources/helpcenters/collections/RawCollectionsClient.java new file mode 100644 index 00000000..6a97ae9f --- /dev/null +++ b/src/main/java/com/intercom/api/resources/helpcenters/collections/RawCollectionsClient.java @@ -0,0 +1,352 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.helpcenters.collections; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.IntercomApiException; +import com.intercom.api.core.IntercomException; +import com.intercom.api.core.IntercomHttpResponse; +import com.intercom.api.core.MediaTypes; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.core.QueryStringMapper; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.core.pagination.SyncPagingIterable; +import com.intercom.api.errors.BadRequestError; +import com.intercom.api.errors.NotFoundError; +import com.intercom.api.errors.UnauthorizedError; +import com.intercom.api.resources.helpcenter.types.Collection; +import com.intercom.api.resources.helpcenters.collections.requests.CreateCollectionRequest; +import com.intercom.api.resources.helpcenters.collections.requests.DeleteCollectionRequest; +import com.intercom.api.resources.helpcenters.collections.requests.FindCollectionRequest; +import com.intercom.api.resources.helpcenters.collections.requests.ListCollectionsRequest; +import com.intercom.api.resources.helpcenters.collections.requests.UpdateCollectionRequest; +import com.intercom.api.types.CollectionList; +import com.intercom.api.types.DeletedCollectionObject; +import com.intercom.api.types.Error; +import java.io.IOException; +import java.util.Collections; +import java.util.List; +import okhttp3.Headers; +import okhttp3.HttpUrl; +import okhttp3.OkHttpClient; +import okhttp3.Request; +import okhttp3.RequestBody; +import okhttp3.Response; +import okhttp3.ResponseBody; + +public class RawCollectionsClient { + protected final ClientOptions clientOptions; + + public RawCollectionsClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + } + + /** + * You can fetch a list of all collections by making a GET request to https://api.intercom.io/help_center/collections. + *

Collections will be returned in descending order on the updated_at attribute. This means if you need to iterate through results then we'll show the most recently updated collections first.

+ */ + public IntercomHttpResponse> list() { + return list(ListCollectionsRequest.builder().build()); + } + + /** + * You can fetch a list of all collections by making a GET request to https://api.intercom.io/help_center/collections. + *

Collections will be returned in descending order on the updated_at attribute. This means if you need to iterate through results then we'll show the most recently updated collections first.

+ */ + public IntercomHttpResponse> list(ListCollectionsRequest request) { + return list(request, null); + } + + /** + * You can fetch a list of all collections by making a GET request to https://api.intercom.io/help_center/collections. + *

Collections will be returned in descending order on the updated_at attribute. This means if you need to iterate through results then we'll show the most recently updated collections first.

+ */ + public IntercomHttpResponse> list( + ListCollectionsRequest request, RequestOptions requestOptions) { + HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("help_center/collections"); + if (request.getPage().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "page", request.getPage().get(), false); + } + if (request.getPerPage().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "per_page", request.getPerPage().get(), false); + } + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl.build()) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + CollectionList parsedResponse = + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, CollectionList.class); + int newPageNumber = + request.getPage().map((Integer page) -> page + 1).orElse(1); + ListCollectionsRequest nextRequest = ListCollectionsRequest.builder() + .from(request) + .page(newPageNumber) + .build(); + List result = parsedResponse.getData().orElse(Collections.emptyList()); + return new IntercomHttpResponse<>( + new SyncPagingIterable( + true, result, parsedResponse, () -> list(nextRequest, requestOptions) + .body()), + response); + } + try { + if (response.code() == 401) { + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can create a new collection by making a POST request to https://api.intercom.io/help_center/collections. + */ + public IntercomHttpResponse create(CreateCollectionRequest request) { + return create(request, null); + } + + /** + * You can create a new collection by making a POST request to https://api.intercom.io/help_center/collections. + */ + public IntercomHttpResponse create(CreateCollectionRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("help_center/collections") + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Collection.class), response); + } + try { + switch (response.code()) { + case 400: + throw new BadRequestError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can fetch the details of a single collection by making a GET request to https://api.intercom.io/help_center/collections/<id>. + */ + public IntercomHttpResponse find(FindCollectionRequest request) { + return find(request, null); + } + + /** + * You can fetch the details of a single collection by making a GET request to https://api.intercom.io/help_center/collections/<id>. + */ + public IntercomHttpResponse find(FindCollectionRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("help_center/collections") + .addPathSegment(Integer.toString(request.getCollectionId())) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Collection.class), response); + } + try { + switch (response.code()) { + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 404: + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can update the details of a single collection by making a PUT request to https://api.intercom.io/collections/<id>. + */ + public IntercomHttpResponse update(UpdateCollectionRequest request) { + return update(request, null); + } + + /** + * You can update the details of a single collection by making a PUT request to https://api.intercom.io/collections/<id>. + */ + public IntercomHttpResponse update(UpdateCollectionRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("help_center/collections") + .addPathSegment(Integer.toString(request.getCollectionId())) + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("PUT", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Collection.class), response); + } + try { + switch (response.code()) { + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 404: + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can delete a single collection by making a DELETE request to https://api.intercom.io/collections/<id>. + */ + public IntercomHttpResponse delete(DeleteCollectionRequest request) { + return delete(request, null); + } + + /** + * You can delete a single collection by making a DELETE request to https://api.intercom.io/collections/<id>. + */ + public IntercomHttpResponse delete( + DeleteCollectionRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("help_center/collections") + .addPathSegment(Integer.toString(request.getCollectionId())) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("DELETE", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, DeletedCollectionObject.class), + response); + } + try { + switch (response.code()) { + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 404: + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/helpcenters/collections/requests/CreateCollectionRequest.java b/src/main/java/com/intercom/api/resources/helpcenters/collections/requests/CreateCollectionRequest.java new file mode 100644 index 00000000..7922c752 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/helpcenters/collections/requests/CreateCollectionRequest.java @@ -0,0 +1,278 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.helpcenters.collections.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.types.GroupTranslatedContent; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = CreateCollectionRequest.Builder.class) +public final class CreateCollectionRequest { + private final String name; + + private final Optional description; + + private final Optional translatedContent; + + private final Optional parentId; + + private final Optional helpCenterId; + + private final Map additionalProperties; + + private CreateCollectionRequest( + String name, + Optional description, + Optional translatedContent, + Optional parentId, + Optional helpCenterId, + Map additionalProperties) { + this.name = name; + this.description = description; + this.translatedContent = translatedContent; + this.parentId = parentId; + this.helpCenterId = helpCenterId; + this.additionalProperties = additionalProperties; + } + + /** + * @return The name of the collection. For multilingual collections, this will be the name of the default language's content. + */ + @JsonProperty("name") + public String getName() { + return name; + } + + /** + * @return The description of the collection. For multilingual collections, this will be the description of the default language's content. + */ + @JsonProperty("description") + public Optional getDescription() { + return description; + } + + @JsonProperty("translated_content") + public Optional getTranslatedContent() { + return translatedContent; + } + + /** + * @return The id of the parent collection. If null then it will be created as the first level collection. + */ + @JsonProperty("parent_id") + public Optional getParentId() { + return parentId; + } + + /** + * @return The id of the help center where the collection will be created. If null then it will be created in the default help center. + */ + @JsonProperty("help_center_id") + public Optional getHelpCenterId() { + return helpCenterId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof CreateCollectionRequest && equalTo((CreateCollectionRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(CreateCollectionRequest other) { + return name.equals(other.name) + && description.equals(other.description) + && translatedContent.equals(other.translatedContent) + && parentId.equals(other.parentId) + && helpCenterId.equals(other.helpCenterId); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.name, this.description, this.translatedContent, this.parentId, this.helpCenterId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static NameStage builder() { + return new Builder(); + } + + public interface NameStage { + /** + *

The name of the collection. For multilingual collections, this will be the name of the default language's content.

+ */ + _FinalStage name(@NotNull String name); + + Builder from(CreateCollectionRequest other); + } + + public interface _FinalStage { + CreateCollectionRequest build(); + + /** + *

The description of the collection. For multilingual collections, this will be the description of the default language's content.

+ */ + _FinalStage description(Optional description); + + _FinalStage description(String description); + + _FinalStage translatedContent(Optional translatedContent); + + _FinalStage translatedContent(GroupTranslatedContent translatedContent); + + /** + *

The id of the parent collection. If null then it will be created as the first level collection.

+ */ + _FinalStage parentId(Optional parentId); + + _FinalStage parentId(String parentId); + + /** + *

The id of the help center where the collection will be created. If null then it will be created in the default help center.

+ */ + _FinalStage helpCenterId(Optional helpCenterId); + + _FinalStage helpCenterId(Integer helpCenterId); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements NameStage, _FinalStage { + private String name; + + private Optional helpCenterId = Optional.empty(); + + private Optional parentId = Optional.empty(); + + private Optional translatedContent = Optional.empty(); + + private Optional description = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(CreateCollectionRequest other) { + name(other.getName()); + description(other.getDescription()); + translatedContent(other.getTranslatedContent()); + parentId(other.getParentId()); + helpCenterId(other.getHelpCenterId()); + return this; + } + + /** + *

The name of the collection. For multilingual collections, this will be the name of the default language's content.

+ *

The name of the collection. For multilingual collections, this will be the name of the default language's content.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("name") + public _FinalStage name(@NotNull String name) { + this.name = Objects.requireNonNull(name, "name must not be null"); + return this; + } + + /** + *

The id of the help center where the collection will be created. If null then it will be created in the default help center.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage helpCenterId(Integer helpCenterId) { + this.helpCenterId = Optional.ofNullable(helpCenterId); + return this; + } + + /** + *

The id of the help center where the collection will be created. If null then it will be created in the default help center.

+ */ + @java.lang.Override + @JsonSetter(value = "help_center_id", nulls = Nulls.SKIP) + public _FinalStage helpCenterId(Optional helpCenterId) { + this.helpCenterId = helpCenterId; + return this; + } + + /** + *

The id of the parent collection. If null then it will be created as the first level collection.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage parentId(String parentId) { + this.parentId = Optional.ofNullable(parentId); + return this; + } + + /** + *

The id of the parent collection. If null then it will be created as the first level collection.

+ */ + @java.lang.Override + @JsonSetter(value = "parent_id", nulls = Nulls.SKIP) + public _FinalStage parentId(Optional parentId) { + this.parentId = parentId; + return this; + } + + @java.lang.Override + public _FinalStage translatedContent(GroupTranslatedContent translatedContent) { + this.translatedContent = Optional.ofNullable(translatedContent); + return this; + } + + @java.lang.Override + @JsonSetter(value = "translated_content", nulls = Nulls.SKIP) + public _FinalStage translatedContent(Optional translatedContent) { + this.translatedContent = translatedContent; + return this; + } + + /** + *

The description of the collection. For multilingual collections, this will be the description of the default language's content.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage description(String description) { + this.description = Optional.ofNullable(description); + return this; + } + + /** + *

The description of the collection. For multilingual collections, this will be the description of the default language's content.

+ */ + @java.lang.Override + @JsonSetter(value = "description", nulls = Nulls.SKIP) + public _FinalStage description(Optional description) { + this.description = description; + return this; + } + + @java.lang.Override + public CreateCollectionRequest build() { + return new CreateCollectionRequest( + name, description, translatedContent, parentId, helpCenterId, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/helpcenters/collections/requests/DeleteCollectionRequest.java b/src/main/java/com/intercom/api/resources/helpcenters/collections/requests/DeleteCollectionRequest.java new file mode 100644 index 00000000..aadd1c27 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/helpcenters/collections/requests/DeleteCollectionRequest.java @@ -0,0 +1,112 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.helpcenters.collections.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = DeleteCollectionRequest.Builder.class) +public final class DeleteCollectionRequest { + private final int collectionId; + + private final Map additionalProperties; + + private DeleteCollectionRequest(int collectionId, Map additionalProperties) { + this.collectionId = collectionId; + this.additionalProperties = additionalProperties; + } + + /** + * @return The unique identifier for the collection which is given by Intercom. + */ + @JsonProperty("collection_id") + public int getCollectionId() { + return collectionId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof DeleteCollectionRequest && equalTo((DeleteCollectionRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(DeleteCollectionRequest other) { + return collectionId == other.collectionId; + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.collectionId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static CollectionIdStage builder() { + return new Builder(); + } + + public interface CollectionIdStage { + /** + *

The unique identifier for the collection which is given by Intercom.

+ */ + _FinalStage collectionId(int collectionId); + + Builder from(DeleteCollectionRequest other); + } + + public interface _FinalStage { + DeleteCollectionRequest build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements CollectionIdStage, _FinalStage { + private int collectionId; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(DeleteCollectionRequest other) { + collectionId(other.getCollectionId()); + return this; + } + + /** + *

The unique identifier for the collection which is given by Intercom.

+ *

The unique identifier for the collection which is given by Intercom.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("collection_id") + public _FinalStage collectionId(int collectionId) { + this.collectionId = collectionId; + return this; + } + + @java.lang.Override + public DeleteCollectionRequest build() { + return new DeleteCollectionRequest(collectionId, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/helpcenters/collections/requests/FindCollectionRequest.java b/src/main/java/com/intercom/api/resources/helpcenters/collections/requests/FindCollectionRequest.java new file mode 100644 index 00000000..825d552e --- /dev/null +++ b/src/main/java/com/intercom/api/resources/helpcenters/collections/requests/FindCollectionRequest.java @@ -0,0 +1,112 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.helpcenters.collections.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = FindCollectionRequest.Builder.class) +public final class FindCollectionRequest { + private final int collectionId; + + private final Map additionalProperties; + + private FindCollectionRequest(int collectionId, Map additionalProperties) { + this.collectionId = collectionId; + this.additionalProperties = additionalProperties; + } + + /** + * @return The unique identifier for the collection which is given by Intercom. + */ + @JsonProperty("collection_id") + public int getCollectionId() { + return collectionId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof FindCollectionRequest && equalTo((FindCollectionRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(FindCollectionRequest other) { + return collectionId == other.collectionId; + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.collectionId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static CollectionIdStage builder() { + return new Builder(); + } + + public interface CollectionIdStage { + /** + *

The unique identifier for the collection which is given by Intercom.

+ */ + _FinalStage collectionId(int collectionId); + + Builder from(FindCollectionRequest other); + } + + public interface _FinalStage { + FindCollectionRequest build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements CollectionIdStage, _FinalStage { + private int collectionId; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(FindCollectionRequest other) { + collectionId(other.getCollectionId()); + return this; + } + + /** + *

The unique identifier for the collection which is given by Intercom.

+ *

The unique identifier for the collection which is given by Intercom.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("collection_id") + public _FinalStage collectionId(int collectionId) { + this.collectionId = collectionId; + return this; + } + + @java.lang.Override + public FindCollectionRequest build() { + return new FindCollectionRequest(collectionId, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/helpcenters/collections/requests/ListCollectionsRequest.java b/src/main/java/com/intercom/api/resources/helpcenters/collections/requests/ListCollectionsRequest.java new file mode 100644 index 00000000..5ea02644 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/helpcenters/collections/requests/ListCollectionsRequest.java @@ -0,0 +1,130 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.helpcenters.collections.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = ListCollectionsRequest.Builder.class) +public final class ListCollectionsRequest { + private final Optional page; + + private final Optional perPage; + + private final Map additionalProperties; + + private ListCollectionsRequest( + Optional page, Optional perPage, Map additionalProperties) { + this.page = page; + this.perPage = perPage; + this.additionalProperties = additionalProperties; + } + + /** + * @return The page of results to fetch. Defaults to first page + */ + @JsonProperty("page") + public Optional getPage() { + return page; + } + + /** + * @return How many results to display per page. Defaults to 15 + */ + @JsonProperty("per_page") + public Optional getPerPage() { + return perPage; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof ListCollectionsRequest && equalTo((ListCollectionsRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(ListCollectionsRequest other) { + return page.equals(other.page) && perPage.equals(other.perPage); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.page, this.perPage); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static Builder builder() { + return new Builder(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder { + private Optional page = Optional.empty(); + + private Optional perPage = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + public Builder from(ListCollectionsRequest other) { + page(other.getPage()); + perPage(other.getPerPage()); + return this; + } + + /** + *

The page of results to fetch. Defaults to first page

+ */ + @JsonSetter(value = "page", nulls = Nulls.SKIP) + public Builder page(Optional page) { + this.page = page; + return this; + } + + public Builder page(Integer page) { + this.page = Optional.ofNullable(page); + return this; + } + + /** + *

How many results to display per page. Defaults to 15

+ */ + @JsonSetter(value = "per_page", nulls = Nulls.SKIP) + public Builder perPage(Optional perPage) { + this.perPage = perPage; + return this; + } + + public Builder perPage(Integer perPage) { + this.perPage = Optional.ofNullable(perPage); + return this; + } + + public ListCollectionsRequest build() { + return new ListCollectionsRequest(page, perPage, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/helpcenters/collections/requests/UpdateCollectionRequest.java b/src/main/java/com/intercom/api/resources/helpcenters/collections/requests/UpdateCollectionRequest.java new file mode 100644 index 00000000..35da9295 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/helpcenters/collections/requests/UpdateCollectionRequest.java @@ -0,0 +1,277 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.helpcenters.collections.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.types.GroupTranslatedContent; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = UpdateCollectionRequest.Builder.class) +public final class UpdateCollectionRequest { + private final int collectionId; + + private final Optional name; + + private final Optional description; + + private final Optional translatedContent; + + private final Optional parentId; + + private final Map additionalProperties; + + private UpdateCollectionRequest( + int collectionId, + Optional name, + Optional description, + Optional translatedContent, + Optional parentId, + Map additionalProperties) { + this.collectionId = collectionId; + this.name = name; + this.description = description; + this.translatedContent = translatedContent; + this.parentId = parentId; + this.additionalProperties = additionalProperties; + } + + /** + * @return The unique identifier for the collection which is given by Intercom. + */ + @JsonProperty("collection_id") + public int getCollectionId() { + return collectionId; + } + + /** + * @return The name of the collection. For multilingual collections, this will be the name of the default language's content. + */ + @JsonProperty("name") + public Optional getName() { + return name; + } + + /** + * @return The description of the collection. For multilingual collections, this will be the description of the default language's content. + */ + @JsonProperty("description") + public Optional getDescription() { + return description; + } + + @JsonProperty("translated_content") + public Optional getTranslatedContent() { + return translatedContent; + } + + /** + * @return The id of the parent collection. If null then it will be updated as the first level collection. + */ + @JsonProperty("parent_id") + public Optional getParentId() { + return parentId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof UpdateCollectionRequest && equalTo((UpdateCollectionRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(UpdateCollectionRequest other) { + return collectionId == other.collectionId + && name.equals(other.name) + && description.equals(other.description) + && translatedContent.equals(other.translatedContent) + && parentId.equals(other.parentId); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.collectionId, this.name, this.description, this.translatedContent, this.parentId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static CollectionIdStage builder() { + return new Builder(); + } + + public interface CollectionIdStage { + /** + *

The unique identifier for the collection which is given by Intercom.

+ */ + _FinalStage collectionId(int collectionId); + + Builder from(UpdateCollectionRequest other); + } + + public interface _FinalStage { + UpdateCollectionRequest build(); + + /** + *

The name of the collection. For multilingual collections, this will be the name of the default language's content.

+ */ + _FinalStage name(Optional name); + + _FinalStage name(String name); + + /** + *

The description of the collection. For multilingual collections, this will be the description of the default language's content.

+ */ + _FinalStage description(Optional description); + + _FinalStage description(String description); + + _FinalStage translatedContent(Optional translatedContent); + + _FinalStage translatedContent(GroupTranslatedContent translatedContent); + + /** + *

The id of the parent collection. If null then it will be updated as the first level collection.

+ */ + _FinalStage parentId(Optional parentId); + + _FinalStage parentId(String parentId); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements CollectionIdStage, _FinalStage { + private int collectionId; + + private Optional parentId = Optional.empty(); + + private Optional translatedContent = Optional.empty(); + + private Optional description = Optional.empty(); + + private Optional name = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(UpdateCollectionRequest other) { + collectionId(other.getCollectionId()); + name(other.getName()); + description(other.getDescription()); + translatedContent(other.getTranslatedContent()); + parentId(other.getParentId()); + return this; + } + + /** + *

The unique identifier for the collection which is given by Intercom.

+ *

The unique identifier for the collection which is given by Intercom.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("collection_id") + public _FinalStage collectionId(int collectionId) { + this.collectionId = collectionId; + return this; + } + + /** + *

The id of the parent collection. If null then it will be updated as the first level collection.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage parentId(String parentId) { + this.parentId = Optional.ofNullable(parentId); + return this; + } + + /** + *

The id of the parent collection. If null then it will be updated as the first level collection.

+ */ + @java.lang.Override + @JsonSetter(value = "parent_id", nulls = Nulls.SKIP) + public _FinalStage parentId(Optional parentId) { + this.parentId = parentId; + return this; + } + + @java.lang.Override + public _FinalStage translatedContent(GroupTranslatedContent translatedContent) { + this.translatedContent = Optional.ofNullable(translatedContent); + return this; + } + + @java.lang.Override + @JsonSetter(value = "translated_content", nulls = Nulls.SKIP) + public _FinalStage translatedContent(Optional translatedContent) { + this.translatedContent = translatedContent; + return this; + } + + /** + *

The description of the collection. For multilingual collections, this will be the description of the default language's content.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage description(String description) { + this.description = Optional.ofNullable(description); + return this; + } + + /** + *

The description of the collection. For multilingual collections, this will be the description of the default language's content.

+ */ + @java.lang.Override + @JsonSetter(value = "description", nulls = Nulls.SKIP) + public _FinalStage description(Optional description) { + this.description = description; + return this; + } + + /** + *

The name of the collection. For multilingual collections, this will be the name of the default language's content.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage name(String name) { + this.name = Optional.ofNullable(name); + return this; + } + + /** + *

The name of the collection. For multilingual collections, this will be the name of the default language's content.

+ */ + @java.lang.Override + @JsonSetter(value = "name", nulls = Nulls.SKIP) + public _FinalStage name(Optional name) { + this.name = name; + return this; + } + + @java.lang.Override + public UpdateCollectionRequest build() { + return new UpdateCollectionRequest( + collectionId, name, description, translatedContent, parentId, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/helpcenters/requests/FindHelpCenterRequest.java b/src/main/java/com/intercom/api/resources/helpcenters/requests/FindHelpCenterRequest.java new file mode 100644 index 00000000..a2c2b647 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/helpcenters/requests/FindHelpCenterRequest.java @@ -0,0 +1,112 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.helpcenters.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = FindHelpCenterRequest.Builder.class) +public final class FindHelpCenterRequest { + private final int helpCenterId; + + private final Map additionalProperties; + + private FindHelpCenterRequest(int helpCenterId, Map additionalProperties) { + this.helpCenterId = helpCenterId; + this.additionalProperties = additionalProperties; + } + + /** + * @return The unique identifier for the collection which is given by Intercom. + */ + @JsonProperty("help_center_id") + public int getHelpCenterId() { + return helpCenterId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof FindHelpCenterRequest && equalTo((FindHelpCenterRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(FindHelpCenterRequest other) { + return helpCenterId == other.helpCenterId; + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.helpCenterId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static HelpCenterIdStage builder() { + return new Builder(); + } + + public interface HelpCenterIdStage { + /** + *

The unique identifier for the collection which is given by Intercom.

+ */ + _FinalStage helpCenterId(int helpCenterId); + + Builder from(FindHelpCenterRequest other); + } + + public interface _FinalStage { + FindHelpCenterRequest build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements HelpCenterIdStage, _FinalStage { + private int helpCenterId; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(FindHelpCenterRequest other) { + helpCenterId(other.getHelpCenterId()); + return this; + } + + /** + *

The unique identifier for the collection which is given by Intercom.

+ *

The unique identifier for the collection which is given by Intercom.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("help_center_id") + public _FinalStage helpCenterId(int helpCenterId) { + this.helpCenterId = helpCenterId; + return this; + } + + @java.lang.Override + public FindHelpCenterRequest build() { + return new FindHelpCenterRequest(helpCenterId, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/helpcenters/requests/ListHelpCentersRequest.java b/src/main/java/com/intercom/api/resources/helpcenters/requests/ListHelpCentersRequest.java new file mode 100644 index 00000000..e47a8f96 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/helpcenters/requests/ListHelpCentersRequest.java @@ -0,0 +1,130 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.helpcenters.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = ListHelpCentersRequest.Builder.class) +public final class ListHelpCentersRequest { + private final Optional page; + + private final Optional perPage; + + private final Map additionalProperties; + + private ListHelpCentersRequest( + Optional page, Optional perPage, Map additionalProperties) { + this.page = page; + this.perPage = perPage; + this.additionalProperties = additionalProperties; + } + + /** + * @return The page of results to fetch. Defaults to first page + */ + @JsonProperty("page") + public Optional getPage() { + return page; + } + + /** + * @return How many results to display per page. Defaults to 15 + */ + @JsonProperty("per_page") + public Optional getPerPage() { + return perPage; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof ListHelpCentersRequest && equalTo((ListHelpCentersRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(ListHelpCentersRequest other) { + return page.equals(other.page) && perPage.equals(other.perPage); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.page, this.perPage); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static Builder builder() { + return new Builder(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder { + private Optional page = Optional.empty(); + + private Optional perPage = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + public Builder from(ListHelpCentersRequest other) { + page(other.getPage()); + perPage(other.getPerPage()); + return this; + } + + /** + *

The page of results to fetch. Defaults to first page

+ */ + @JsonSetter(value = "page", nulls = Nulls.SKIP) + public Builder page(Optional page) { + this.page = page; + return this; + } + + public Builder page(Integer page) { + this.page = Optional.ofNullable(page); + return this; + } + + /** + *

How many results to display per page. Defaults to 15

+ */ + @JsonSetter(value = "per_page", nulls = Nulls.SKIP) + public Builder perPage(Optional perPage) { + this.perPage = perPage; + return this; + } + + public Builder perPage(Integer perPage) { + this.perPage = Optional.ofNullable(perPage); + return this; + } + + public ListHelpCentersRequest build() { + return new ListHelpCentersRequest(page, perPage, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/internalarticles/AsyncInternalArticlesClient.java b/src/main/java/com/intercom/api/resources/internalarticles/AsyncInternalArticlesClient.java new file mode 100644 index 00000000..5bf7f0e3 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/internalarticles/AsyncInternalArticlesClient.java @@ -0,0 +1,141 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.internalarticles; + +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.resources.internalarticles.requests.DeleteInternalArticleRequest; +import com.intercom.api.resources.internalarticles.requests.RetrieveInternalArticleRequest; +import com.intercom.api.resources.internalarticles.requests.SearchInternalArticlesRequest; +import com.intercom.api.resources.internalarticles.requests.UpdateInternalArticleRequestBody; +import com.intercom.api.resources.internalarticles.types.InternalArticleListItem; +import com.intercom.api.resources.internalarticles.types.InternalArticleSearchResponse; +import com.intercom.api.types.CreateInternalArticleRequest; +import com.intercom.api.types.DeletedInternalArticleObject; +import com.intercom.api.types.InternalArticleList; +import java.util.Optional; +import java.util.concurrent.CompletableFuture; + +public class AsyncInternalArticlesClient { + protected final ClientOptions clientOptions; + + private final AsyncRawInternalArticlesClient rawClient; + + public AsyncInternalArticlesClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + this.rawClient = new AsyncRawInternalArticlesClient(clientOptions); + } + + /** + * Get responses with HTTP metadata like headers + */ + public AsyncRawInternalArticlesClient withRawResponse() { + return this.rawClient; + } + + /** + * You can fetch a list of all internal articles by making a GET request to https://api.intercom.io/internal_articles. + */ + public CompletableFuture listInternalArticles() { + return this.rawClient.listInternalArticles().thenApply(response -> response.body()); + } + + /** + * You can fetch a list of all internal articles by making a GET request to https://api.intercom.io/internal_articles. + */ + public CompletableFuture listInternalArticles(RequestOptions requestOptions) { + return this.rawClient.listInternalArticles(requestOptions).thenApply(response -> response.body()); + } + + /** + * You can create a new internal article by making a POST request to https://api.intercom.io/internal_articles. + */ + public CompletableFuture createInternalArticle() { + return this.rawClient.createInternalArticle().thenApply(response -> response.body()); + } + + /** + * You can create a new internal article by making a POST request to https://api.intercom.io/internal_articles. + */ + public CompletableFuture createInternalArticle( + Optional request) { + return this.rawClient.createInternalArticle(request).thenApply(response -> response.body()); + } + + /** + * You can create a new internal article by making a POST request to https://api.intercom.io/internal_articles. + */ + public CompletableFuture createInternalArticle( + Optional request, RequestOptions requestOptions) { + return this.rawClient.createInternalArticle(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can fetch the details of a single internal article by making a GET request to https://api.intercom.io/internal_articles/<id>. + */ + public CompletableFuture retrieveInternalArticle(RetrieveInternalArticleRequest request) { + return this.rawClient.retrieveInternalArticle(request).thenApply(response -> response.body()); + } + + /** + * You can fetch the details of a single internal article by making a GET request to https://api.intercom.io/internal_articles/<id>. + */ + public CompletableFuture retrieveInternalArticle( + RetrieveInternalArticleRequest request, RequestOptions requestOptions) { + return this.rawClient.retrieveInternalArticle(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can update the details of a single internal article by making a PUT request to https://api.intercom.io/internal_articles/<id>. + */ + public CompletableFuture updateInternalArticle(UpdateInternalArticleRequestBody request) { + return this.rawClient.updateInternalArticle(request).thenApply(response -> response.body()); + } + + /** + * You can update the details of a single internal article by making a PUT request to https://api.intercom.io/internal_articles/<id>. + */ + public CompletableFuture updateInternalArticle( + UpdateInternalArticleRequestBody request, RequestOptions requestOptions) { + return this.rawClient.updateInternalArticle(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can delete a single internal article by making a DELETE request to https://api.intercom.io/internal_articles/<id>. + */ + public CompletableFuture deleteInternalArticle(DeleteInternalArticleRequest request) { + return this.rawClient.deleteInternalArticle(request).thenApply(response -> response.body()); + } + + /** + * You can delete a single internal article by making a DELETE request to https://api.intercom.io/internal_articles/<id>. + */ + public CompletableFuture deleteInternalArticle( + DeleteInternalArticleRequest request, RequestOptions requestOptions) { + return this.rawClient.deleteInternalArticle(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can search for internal articles by making a GET request to https://api.intercom.io/internal_articles/search. + */ + public CompletableFuture searchInternalArticles() { + return this.rawClient.searchInternalArticles().thenApply(response -> response.body()); + } + + /** + * You can search for internal articles by making a GET request to https://api.intercom.io/internal_articles/search. + */ + public CompletableFuture searchInternalArticles( + SearchInternalArticlesRequest request) { + return this.rawClient.searchInternalArticles(request).thenApply(response -> response.body()); + } + + /** + * You can search for internal articles by making a GET request to https://api.intercom.io/internal_articles/search. + */ + public CompletableFuture searchInternalArticles( + SearchInternalArticlesRequest request, RequestOptions requestOptions) { + return this.rawClient.searchInternalArticles(request, requestOptions).thenApply(response -> response.body()); + } +} diff --git a/src/main/java/com/intercom/api/resources/internalarticles/AsyncRawInternalArticlesClient.java b/src/main/java/com/intercom/api/resources/internalarticles/AsyncRawInternalArticlesClient.java new file mode 100644 index 00000000..838eb498 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/internalarticles/AsyncRawInternalArticlesClient.java @@ -0,0 +1,506 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.internalarticles; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.IntercomApiException; +import com.intercom.api.core.IntercomException; +import com.intercom.api.core.IntercomHttpResponse; +import com.intercom.api.core.MediaTypes; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.core.QueryStringMapper; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.errors.BadRequestError; +import com.intercom.api.errors.NotFoundError; +import com.intercom.api.errors.UnauthorizedError; +import com.intercom.api.resources.internalarticles.requests.DeleteInternalArticleRequest; +import com.intercom.api.resources.internalarticles.requests.RetrieveInternalArticleRequest; +import com.intercom.api.resources.internalarticles.requests.SearchInternalArticlesRequest; +import com.intercom.api.resources.internalarticles.requests.UpdateInternalArticleRequestBody; +import com.intercom.api.resources.internalarticles.types.InternalArticleListItem; +import com.intercom.api.resources.internalarticles.types.InternalArticleSearchResponse; +import com.intercom.api.types.CreateInternalArticleRequest; +import com.intercom.api.types.DeletedInternalArticleObject; +import com.intercom.api.types.Error; +import com.intercom.api.types.InternalArticleList; +import java.io.IOException; +import java.util.Optional; +import java.util.concurrent.CompletableFuture; +import okhttp3.Call; +import okhttp3.Callback; +import okhttp3.Headers; +import okhttp3.HttpUrl; +import okhttp3.OkHttpClient; +import okhttp3.Request; +import okhttp3.RequestBody; +import okhttp3.Response; +import okhttp3.ResponseBody; +import org.jetbrains.annotations.NotNull; + +public class AsyncRawInternalArticlesClient { + protected final ClientOptions clientOptions; + + public AsyncRawInternalArticlesClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + } + + /** + * You can fetch a list of all internal articles by making a GET request to https://api.intercom.io/internal_articles. + */ + public CompletableFuture> listInternalArticles() { + return listInternalArticles(null); + } + + /** + * You can fetch a list of all internal articles by making a GET request to https://api.intercom.io/internal_articles. + */ + public CompletableFuture> listInternalArticles( + RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("internal_articles") + .build(); + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, InternalArticleList.class), + response)); + return; + } + try { + if (response.code() == 401) { + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can create a new internal article by making a POST request to https://api.intercom.io/internal_articles. + */ + public CompletableFuture> createInternalArticle() { + return createInternalArticle(Optional.empty()); + } + + /** + * You can create a new internal article by making a POST request to https://api.intercom.io/internal_articles. + */ + public CompletableFuture> createInternalArticle( + Optional request) { + return createInternalArticle(request, null); + } + + /** + * You can create a new internal article by making a POST request to https://api.intercom.io/internal_articles. + */ + public CompletableFuture> createInternalArticle( + Optional request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("internal_articles") + .build(); + RequestBody body; + try { + body = RequestBody.create("", null); + if (request.isPresent()) { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, InternalArticleListItem.class), + response)); + return; + } + try { + switch (response.code()) { + case 400: + future.completeExceptionally(new BadRequestError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can fetch the details of a single internal article by making a GET request to https://api.intercom.io/internal_articles/<id>. + */ + public CompletableFuture> retrieveInternalArticle( + RetrieveInternalArticleRequest request) { + return retrieveInternalArticle(request, null); + } + + /** + * You can fetch the details of a single internal article by making a GET request to https://api.intercom.io/internal_articles/<id>. + */ + public CompletableFuture> retrieveInternalArticle( + RetrieveInternalArticleRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("internal_articles") + .addPathSegment(Integer.toString(request.getInternalArticleId())) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, InternalArticleListItem.class), + response)); + return; + } + try { + switch (response.code()) { + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 404: + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can update the details of a single internal article by making a PUT request to https://api.intercom.io/internal_articles/<id>. + */ + public CompletableFuture> updateInternalArticle( + UpdateInternalArticleRequestBody request) { + return updateInternalArticle(request, null); + } + + /** + * You can update the details of a single internal article by making a PUT request to https://api.intercom.io/internal_articles/<id>. + */ + public CompletableFuture> updateInternalArticle( + UpdateInternalArticleRequestBody request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("internal_articles") + .addPathSegment(Integer.toString(request.getInternalArticleId())) + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("PUT", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, InternalArticleListItem.class), + response)); + return; + } + try { + switch (response.code()) { + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 404: + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can delete a single internal article by making a DELETE request to https://api.intercom.io/internal_articles/<id>. + */ + public CompletableFuture> deleteInternalArticle( + DeleteInternalArticleRequest request) { + return deleteInternalArticle(request, null); + } + + /** + * You can delete a single internal article by making a DELETE request to https://api.intercom.io/internal_articles/<id>. + */ + public CompletableFuture> deleteInternalArticle( + DeleteInternalArticleRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("internal_articles") + .addPathSegment(Integer.toString(request.getInternalArticleId())) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("DELETE", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue( + responseBodyString, DeletedInternalArticleObject.class), + response)); + return; + } + try { + switch (response.code()) { + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 404: + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can search for internal articles by making a GET request to https://api.intercom.io/internal_articles/search. + */ + public CompletableFuture> searchInternalArticles() { + return searchInternalArticles(SearchInternalArticlesRequest.builder().build()); + } + + /** + * You can search for internal articles by making a GET request to https://api.intercom.io/internal_articles/search. + */ + public CompletableFuture> searchInternalArticles( + SearchInternalArticlesRequest request) { + return searchInternalArticles(request, null); + } + + /** + * You can search for internal articles by making a GET request to https://api.intercom.io/internal_articles/search. + */ + public CompletableFuture> searchInternalArticles( + SearchInternalArticlesRequest request, RequestOptions requestOptions) { + HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("internal_articles/search"); + if (request.getFolderId().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "folder_id", request.getFolderId().get(), false); + } + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl.build()) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue( + responseBodyString, InternalArticleSearchResponse.class), + response)); + return; + } + try { + if (response.code() == 401) { + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } +} diff --git a/src/main/java/com/intercom/api/resources/internalarticles/InternalArticlesClient.java b/src/main/java/com/intercom/api/resources/internalarticles/InternalArticlesClient.java new file mode 100644 index 00000000..5eb9b9c6 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/internalarticles/InternalArticlesClient.java @@ -0,0 +1,138 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.internalarticles; + +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.resources.internalarticles.requests.DeleteInternalArticleRequest; +import com.intercom.api.resources.internalarticles.requests.RetrieveInternalArticleRequest; +import com.intercom.api.resources.internalarticles.requests.SearchInternalArticlesRequest; +import com.intercom.api.resources.internalarticles.requests.UpdateInternalArticleRequestBody; +import com.intercom.api.resources.internalarticles.types.InternalArticleListItem; +import com.intercom.api.resources.internalarticles.types.InternalArticleSearchResponse; +import com.intercom.api.types.CreateInternalArticleRequest; +import com.intercom.api.types.DeletedInternalArticleObject; +import com.intercom.api.types.InternalArticleList; +import java.util.Optional; + +public class InternalArticlesClient { + protected final ClientOptions clientOptions; + + private final RawInternalArticlesClient rawClient; + + public InternalArticlesClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + this.rawClient = new RawInternalArticlesClient(clientOptions); + } + + /** + * Get responses with HTTP metadata like headers + */ + public RawInternalArticlesClient withRawResponse() { + return this.rawClient; + } + + /** + * You can fetch a list of all internal articles by making a GET request to https://api.intercom.io/internal_articles. + */ + public InternalArticleList listInternalArticles() { + return this.rawClient.listInternalArticles().body(); + } + + /** + * You can fetch a list of all internal articles by making a GET request to https://api.intercom.io/internal_articles. + */ + public InternalArticleList listInternalArticles(RequestOptions requestOptions) { + return this.rawClient.listInternalArticles(requestOptions).body(); + } + + /** + * You can create a new internal article by making a POST request to https://api.intercom.io/internal_articles. + */ + public InternalArticleListItem createInternalArticle() { + return this.rawClient.createInternalArticle().body(); + } + + /** + * You can create a new internal article by making a POST request to https://api.intercom.io/internal_articles. + */ + public InternalArticleListItem createInternalArticle(Optional request) { + return this.rawClient.createInternalArticle(request).body(); + } + + /** + * You can create a new internal article by making a POST request to https://api.intercom.io/internal_articles. + */ + public InternalArticleListItem createInternalArticle( + Optional request, RequestOptions requestOptions) { + return this.rawClient.createInternalArticle(request, requestOptions).body(); + } + + /** + * You can fetch the details of a single internal article by making a GET request to https://api.intercom.io/internal_articles/<id>. + */ + public InternalArticleListItem retrieveInternalArticle(RetrieveInternalArticleRequest request) { + return this.rawClient.retrieveInternalArticle(request).body(); + } + + /** + * You can fetch the details of a single internal article by making a GET request to https://api.intercom.io/internal_articles/<id>. + */ + public InternalArticleListItem retrieveInternalArticle( + RetrieveInternalArticleRequest request, RequestOptions requestOptions) { + return this.rawClient.retrieveInternalArticle(request, requestOptions).body(); + } + + /** + * You can update the details of a single internal article by making a PUT request to https://api.intercom.io/internal_articles/<id>. + */ + public InternalArticleListItem updateInternalArticle(UpdateInternalArticleRequestBody request) { + return this.rawClient.updateInternalArticle(request).body(); + } + + /** + * You can update the details of a single internal article by making a PUT request to https://api.intercom.io/internal_articles/<id>. + */ + public InternalArticleListItem updateInternalArticle( + UpdateInternalArticleRequestBody request, RequestOptions requestOptions) { + return this.rawClient.updateInternalArticle(request, requestOptions).body(); + } + + /** + * You can delete a single internal article by making a DELETE request to https://api.intercom.io/internal_articles/<id>. + */ + public DeletedInternalArticleObject deleteInternalArticle(DeleteInternalArticleRequest request) { + return this.rawClient.deleteInternalArticle(request).body(); + } + + /** + * You can delete a single internal article by making a DELETE request to https://api.intercom.io/internal_articles/<id>. + */ + public DeletedInternalArticleObject deleteInternalArticle( + DeleteInternalArticleRequest request, RequestOptions requestOptions) { + return this.rawClient.deleteInternalArticle(request, requestOptions).body(); + } + + /** + * You can search for internal articles by making a GET request to https://api.intercom.io/internal_articles/search. + */ + public InternalArticleSearchResponse searchInternalArticles() { + return this.rawClient.searchInternalArticles().body(); + } + + /** + * You can search for internal articles by making a GET request to https://api.intercom.io/internal_articles/search. + */ + public InternalArticleSearchResponse searchInternalArticles(SearchInternalArticlesRequest request) { + return this.rawClient.searchInternalArticles(request).body(); + } + + /** + * You can search for internal articles by making a GET request to https://api.intercom.io/internal_articles/search. + */ + public InternalArticleSearchResponse searchInternalArticles( + SearchInternalArticlesRequest request, RequestOptions requestOptions) { + return this.rawClient.searchInternalArticles(request, requestOptions).body(); + } +} diff --git a/src/main/java/com/intercom/api/resources/internalarticles/RawInternalArticlesClient.java b/src/main/java/com/intercom/api/resources/internalarticles/RawInternalArticlesClient.java new file mode 100644 index 00000000..14aaa7a5 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/internalarticles/RawInternalArticlesClient.java @@ -0,0 +1,402 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.internalarticles; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.IntercomApiException; +import com.intercom.api.core.IntercomException; +import com.intercom.api.core.IntercomHttpResponse; +import com.intercom.api.core.MediaTypes; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.core.QueryStringMapper; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.errors.BadRequestError; +import com.intercom.api.errors.NotFoundError; +import com.intercom.api.errors.UnauthorizedError; +import com.intercom.api.resources.internalarticles.requests.DeleteInternalArticleRequest; +import com.intercom.api.resources.internalarticles.requests.RetrieveInternalArticleRequest; +import com.intercom.api.resources.internalarticles.requests.SearchInternalArticlesRequest; +import com.intercom.api.resources.internalarticles.requests.UpdateInternalArticleRequestBody; +import com.intercom.api.resources.internalarticles.types.InternalArticleListItem; +import com.intercom.api.resources.internalarticles.types.InternalArticleSearchResponse; +import com.intercom.api.types.CreateInternalArticleRequest; +import com.intercom.api.types.DeletedInternalArticleObject; +import com.intercom.api.types.Error; +import com.intercom.api.types.InternalArticleList; +import java.io.IOException; +import java.util.Optional; +import okhttp3.Headers; +import okhttp3.HttpUrl; +import okhttp3.OkHttpClient; +import okhttp3.Request; +import okhttp3.RequestBody; +import okhttp3.Response; +import okhttp3.ResponseBody; + +public class RawInternalArticlesClient { + protected final ClientOptions clientOptions; + + public RawInternalArticlesClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + } + + /** + * You can fetch a list of all internal articles by making a GET request to https://api.intercom.io/internal_articles. + */ + public IntercomHttpResponse listInternalArticles() { + return listInternalArticles(null); + } + + /** + * You can fetch a list of all internal articles by making a GET request to https://api.intercom.io/internal_articles. + */ + public IntercomHttpResponse listInternalArticles(RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("internal_articles") + .build(); + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, InternalArticleList.class), response); + } + try { + if (response.code() == 401) { + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can create a new internal article by making a POST request to https://api.intercom.io/internal_articles. + */ + public IntercomHttpResponse createInternalArticle() { + return createInternalArticle(Optional.empty()); + } + + /** + * You can create a new internal article by making a POST request to https://api.intercom.io/internal_articles. + */ + public IntercomHttpResponse createInternalArticle( + Optional request) { + return createInternalArticle(request, null); + } + + /** + * You can create a new internal article by making a POST request to https://api.intercom.io/internal_articles. + */ + public IntercomHttpResponse createInternalArticle( + Optional request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("internal_articles") + .build(); + RequestBody body; + try { + body = RequestBody.create("", null); + if (request.isPresent()) { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, InternalArticleListItem.class), + response); + } + try { + switch (response.code()) { + case 400: + throw new BadRequestError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can fetch the details of a single internal article by making a GET request to https://api.intercom.io/internal_articles/<id>. + */ + public IntercomHttpResponse retrieveInternalArticle( + RetrieveInternalArticleRequest request) { + return retrieveInternalArticle(request, null); + } + + /** + * You can fetch the details of a single internal article by making a GET request to https://api.intercom.io/internal_articles/<id>. + */ + public IntercomHttpResponse retrieveInternalArticle( + RetrieveInternalArticleRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("internal_articles") + .addPathSegment(Integer.toString(request.getInternalArticleId())) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, InternalArticleListItem.class), + response); + } + try { + switch (response.code()) { + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 404: + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can update the details of a single internal article by making a PUT request to https://api.intercom.io/internal_articles/<id>. + */ + public IntercomHttpResponse updateInternalArticle( + UpdateInternalArticleRequestBody request) { + return updateInternalArticle(request, null); + } + + /** + * You can update the details of a single internal article by making a PUT request to https://api.intercom.io/internal_articles/<id>. + */ + public IntercomHttpResponse updateInternalArticle( + UpdateInternalArticleRequestBody request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("internal_articles") + .addPathSegment(Integer.toString(request.getInternalArticleId())) + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("PUT", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, InternalArticleListItem.class), + response); + } + try { + switch (response.code()) { + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 404: + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can delete a single internal article by making a DELETE request to https://api.intercom.io/internal_articles/<id>. + */ + public IntercomHttpResponse deleteInternalArticle( + DeleteInternalArticleRequest request) { + return deleteInternalArticle(request, null); + } + + /** + * You can delete a single internal article by making a DELETE request to https://api.intercom.io/internal_articles/<id>. + */ + public IntercomHttpResponse deleteInternalArticle( + DeleteInternalArticleRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("internal_articles") + .addPathSegment(Integer.toString(request.getInternalArticleId())) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("DELETE", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, DeletedInternalArticleObject.class), + response); + } + try { + switch (response.code()) { + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 404: + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can search for internal articles by making a GET request to https://api.intercom.io/internal_articles/search. + */ + public IntercomHttpResponse searchInternalArticles() { + return searchInternalArticles(SearchInternalArticlesRequest.builder().build()); + } + + /** + * You can search for internal articles by making a GET request to https://api.intercom.io/internal_articles/search. + */ + public IntercomHttpResponse searchInternalArticles( + SearchInternalArticlesRequest request) { + return searchInternalArticles(request, null); + } + + /** + * You can search for internal articles by making a GET request to https://api.intercom.io/internal_articles/search. + */ + public IntercomHttpResponse searchInternalArticles( + SearchInternalArticlesRequest request, RequestOptions requestOptions) { + HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("internal_articles/search"); + if (request.getFolderId().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "folder_id", request.getFolderId().get(), false); + } + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl.build()) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, InternalArticleSearchResponse.class), + response); + } + try { + if (response.code() == 401) { + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/internalarticles/requests/DeleteInternalArticleRequest.java b/src/main/java/com/intercom/api/resources/internalarticles/requests/DeleteInternalArticleRequest.java new file mode 100644 index 00000000..2c15d0e6 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/internalarticles/requests/DeleteInternalArticleRequest.java @@ -0,0 +1,112 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.internalarticles.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = DeleteInternalArticleRequest.Builder.class) +public final class DeleteInternalArticleRequest { + private final int internalArticleId; + + private final Map additionalProperties; + + private DeleteInternalArticleRequest(int internalArticleId, Map additionalProperties) { + this.internalArticleId = internalArticleId; + this.additionalProperties = additionalProperties; + } + + /** + * @return The unique identifier for the internal article which is given by Intercom. + */ + @JsonProperty("internal_article_id") + public int getInternalArticleId() { + return internalArticleId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof DeleteInternalArticleRequest && equalTo((DeleteInternalArticleRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(DeleteInternalArticleRequest other) { + return internalArticleId == other.internalArticleId; + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.internalArticleId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static InternalArticleIdStage builder() { + return new Builder(); + } + + public interface InternalArticleIdStage { + /** + *

The unique identifier for the internal article which is given by Intercom.

+ */ + _FinalStage internalArticleId(int internalArticleId); + + Builder from(DeleteInternalArticleRequest other); + } + + public interface _FinalStage { + DeleteInternalArticleRequest build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements InternalArticleIdStage, _FinalStage { + private int internalArticleId; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(DeleteInternalArticleRequest other) { + internalArticleId(other.getInternalArticleId()); + return this; + } + + /** + *

The unique identifier for the internal article which is given by Intercom.

+ *

The unique identifier for the internal article which is given by Intercom.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("internal_article_id") + public _FinalStage internalArticleId(int internalArticleId) { + this.internalArticleId = internalArticleId; + return this; + } + + @java.lang.Override + public DeleteInternalArticleRequest build() { + return new DeleteInternalArticleRequest(internalArticleId, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/internalarticles/requests/RetrieveInternalArticleRequest.java b/src/main/java/com/intercom/api/resources/internalarticles/requests/RetrieveInternalArticleRequest.java new file mode 100644 index 00000000..4bc56b44 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/internalarticles/requests/RetrieveInternalArticleRequest.java @@ -0,0 +1,112 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.internalarticles.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = RetrieveInternalArticleRequest.Builder.class) +public final class RetrieveInternalArticleRequest { + private final int internalArticleId; + + private final Map additionalProperties; + + private RetrieveInternalArticleRequest(int internalArticleId, Map additionalProperties) { + this.internalArticleId = internalArticleId; + this.additionalProperties = additionalProperties; + } + + /** + * @return The unique identifier for the article which is given by Intercom. + */ + @JsonProperty("internal_article_id") + public int getInternalArticleId() { + return internalArticleId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof RetrieveInternalArticleRequest && equalTo((RetrieveInternalArticleRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(RetrieveInternalArticleRequest other) { + return internalArticleId == other.internalArticleId; + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.internalArticleId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static InternalArticleIdStage builder() { + return new Builder(); + } + + public interface InternalArticleIdStage { + /** + *

The unique identifier for the article which is given by Intercom.

+ */ + _FinalStage internalArticleId(int internalArticleId); + + Builder from(RetrieveInternalArticleRequest other); + } + + public interface _FinalStage { + RetrieveInternalArticleRequest build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements InternalArticleIdStage, _FinalStage { + private int internalArticleId; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(RetrieveInternalArticleRequest other) { + internalArticleId(other.getInternalArticleId()); + return this; + } + + /** + *

The unique identifier for the article which is given by Intercom.

+ *

The unique identifier for the article which is given by Intercom.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("internal_article_id") + public _FinalStage internalArticleId(int internalArticleId) { + this.internalArticleId = internalArticleId; + return this; + } + + @java.lang.Override + public RetrieveInternalArticleRequest build() { + return new RetrieveInternalArticleRequest(internalArticleId, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/internalarticles/requests/SearchInternalArticlesRequest.java b/src/main/java/com/intercom/api/resources/internalarticles/requests/SearchInternalArticlesRequest.java new file mode 100644 index 00000000..ce6c476c --- /dev/null +++ b/src/main/java/com/intercom/api/resources/internalarticles/requests/SearchInternalArticlesRequest.java @@ -0,0 +1,101 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.internalarticles.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = SearchInternalArticlesRequest.Builder.class) +public final class SearchInternalArticlesRequest { + private final Optional folderId; + + private final Map additionalProperties; + + private SearchInternalArticlesRequest(Optional folderId, Map additionalProperties) { + this.folderId = folderId; + this.additionalProperties = additionalProperties; + } + + /** + * @return The ID of the folder to search in. + */ + @JsonProperty("folder_id") + public Optional getFolderId() { + return folderId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof SearchInternalArticlesRequest && equalTo((SearchInternalArticlesRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(SearchInternalArticlesRequest other) { + return folderId.equals(other.folderId); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.folderId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static Builder builder() { + return new Builder(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder { + private Optional folderId = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + public Builder from(SearchInternalArticlesRequest other) { + folderId(other.getFolderId()); + return this; + } + + /** + *

The ID of the folder to search in.

+ */ + @JsonSetter(value = "folder_id", nulls = Nulls.SKIP) + public Builder folderId(Optional folderId) { + this.folderId = folderId; + return this; + } + + public Builder folderId(String folderId) { + this.folderId = Optional.ofNullable(folderId); + return this; + } + + public SearchInternalArticlesRequest build() { + return new SearchInternalArticlesRequest(folderId, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/internalarticles/requests/UpdateInternalArticleRequestBody.java b/src/main/java/com/intercom/api/resources/internalarticles/requests/UpdateInternalArticleRequestBody.java new file mode 100644 index 00000000..1040dd86 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/internalarticles/requests/UpdateInternalArticleRequestBody.java @@ -0,0 +1,289 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.internalarticles.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = UpdateInternalArticleRequestBody.Builder.class) +public final class UpdateInternalArticleRequestBody { + private final int internalArticleId; + + private final Optional title; + + private final Optional body; + + private final Optional authorId; + + private final Optional ownerId; + + private final Map additionalProperties; + + private UpdateInternalArticleRequestBody( + int internalArticleId, + Optional title, + Optional body, + Optional authorId, + Optional ownerId, + Map additionalProperties) { + this.internalArticleId = internalArticleId; + this.title = title; + this.body = body; + this.authorId = authorId; + this.ownerId = ownerId; + this.additionalProperties = additionalProperties; + } + + /** + * @return The unique identifier for the internal article which is given by Intercom. + */ + @JsonProperty("internal_article_id") + public int getInternalArticleId() { + return internalArticleId; + } + + /** + * @return The title of the article. + */ + @JsonProperty("title") + public Optional getTitle() { + return title; + } + + /** + * @return The content of the article. + */ + @JsonProperty("body") + public Optional getBody() { + return body; + } + + /** + * @return The id of the author of the article. + */ + @JsonProperty("author_id") + public Optional getAuthorId() { + return authorId; + } + + /** + * @return The id of the author of the article. + */ + @JsonProperty("owner_id") + public Optional getOwnerId() { + return ownerId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof UpdateInternalArticleRequestBody && equalTo((UpdateInternalArticleRequestBody) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(UpdateInternalArticleRequestBody other) { + return internalArticleId == other.internalArticleId + && title.equals(other.title) + && body.equals(other.body) + && authorId.equals(other.authorId) + && ownerId.equals(other.ownerId); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.internalArticleId, this.title, this.body, this.authorId, this.ownerId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static InternalArticleIdStage builder() { + return new Builder(); + } + + public interface InternalArticleIdStage { + /** + *

The unique identifier for the internal article which is given by Intercom.

+ */ + _FinalStage internalArticleId(int internalArticleId); + + Builder from(UpdateInternalArticleRequestBody other); + } + + public interface _FinalStage { + UpdateInternalArticleRequestBody build(); + + /** + *

The title of the article.

+ */ + _FinalStage title(Optional title); + + _FinalStage title(String title); + + /** + *

The content of the article.

+ */ + _FinalStage body(Optional body); + + _FinalStage body(String body); + + /** + *

The id of the author of the article.

+ */ + _FinalStage authorId(Optional authorId); + + _FinalStage authorId(Integer authorId); + + /** + *

The id of the author of the article.

+ */ + _FinalStage ownerId(Optional ownerId); + + _FinalStage ownerId(Integer ownerId); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements InternalArticleIdStage, _FinalStage { + private int internalArticleId; + + private Optional ownerId = Optional.empty(); + + private Optional authorId = Optional.empty(); + + private Optional body = Optional.empty(); + + private Optional title = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(UpdateInternalArticleRequestBody other) { + internalArticleId(other.getInternalArticleId()); + title(other.getTitle()); + body(other.getBody()); + authorId(other.getAuthorId()); + ownerId(other.getOwnerId()); + return this; + } + + /** + *

The unique identifier for the internal article which is given by Intercom.

+ *

The unique identifier for the internal article which is given by Intercom.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("internal_article_id") + public _FinalStage internalArticleId(int internalArticleId) { + this.internalArticleId = internalArticleId; + return this; + } + + /** + *

The id of the author of the article.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage ownerId(Integer ownerId) { + this.ownerId = Optional.ofNullable(ownerId); + return this; + } + + /** + *

The id of the author of the article.

+ */ + @java.lang.Override + @JsonSetter(value = "owner_id", nulls = Nulls.SKIP) + public _FinalStage ownerId(Optional ownerId) { + this.ownerId = ownerId; + return this; + } + + /** + *

The id of the author of the article.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage authorId(Integer authorId) { + this.authorId = Optional.ofNullable(authorId); + return this; + } + + /** + *

The id of the author of the article.

+ */ + @java.lang.Override + @JsonSetter(value = "author_id", nulls = Nulls.SKIP) + public _FinalStage authorId(Optional authorId) { + this.authorId = authorId; + return this; + } + + /** + *

The content of the article.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage body(String body) { + this.body = Optional.ofNullable(body); + return this; + } + + /** + *

The content of the article.

+ */ + @java.lang.Override + @JsonSetter(value = "body", nulls = Nulls.SKIP) + public _FinalStage body(Optional body) { + this.body = body; + return this; + } + + /** + *

The title of the article.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage title(String title) { + this.title = Optional.ofNullable(title); + return this; + } + + /** + *

The title of the article.

+ */ + @java.lang.Override + @JsonSetter(value = "title", nulls = Nulls.SKIP) + public _FinalStage title(Optional title) { + this.title = title; + return this; + } + + @java.lang.Override + public UpdateInternalArticleRequestBody build() { + return new UpdateInternalArticleRequestBody( + internalArticleId, title, body, authorId, ownerId, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/internalarticles/types/InternalArticleListItem.java b/src/main/java/com/intercom/api/resources/internalarticles/types/InternalArticleListItem.java new file mode 100644 index 00000000..e08b9395 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/internalarticles/types/InternalArticleListItem.java @@ -0,0 +1,353 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.internalarticles.types; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = InternalArticleListItem.Builder.class) +public final class InternalArticleListItem { + private final Optional type; + + private final Optional id; + + private final Optional title; + + private final Optional body; + + private final Optional ownerId; + + private final Optional authorId; + + private final Optional createdAt; + + private final Optional updatedAt; + + private final Optional locale; + + private final Map additionalProperties; + + private InternalArticleListItem( + Optional type, + Optional id, + Optional title, + Optional body, + Optional ownerId, + Optional authorId, + Optional createdAt, + Optional updatedAt, + Optional locale, + Map additionalProperties) { + this.type = type; + this.id = id; + this.title = title; + this.body = body; + this.ownerId = ownerId; + this.authorId = authorId; + this.createdAt = createdAt; + this.updatedAt = updatedAt; + this.locale = locale; + this.additionalProperties = additionalProperties; + } + + /** + * @return The type of object - internal_article. + */ + @JsonProperty("type") + public Optional getType() { + return type; + } + + /** + * @return The unique identifier for the article which is given by Intercom. + */ + @JsonProperty("id") + public Optional getId() { + return id; + } + + /** + * @return The title of the article. + */ + @JsonProperty("title") + public Optional getTitle() { + return title; + } + + /** + * @return The body of the article in HTML. + */ + @JsonProperty("body") + public Optional getBody() { + return body; + } + + /** + * @return The id of the owner of the article. + */ + @JsonProperty("owner_id") + public Optional getOwnerId() { + return ownerId; + } + + /** + * @return The id of the author of the article. + */ + @JsonProperty("author_id") + public Optional getAuthorId() { + return authorId; + } + + /** + * @return The time when the article was created. + */ + @JsonProperty("created_at") + public Optional getCreatedAt() { + return createdAt; + } + + /** + * @return The time when the article was last updated. + */ + @JsonProperty("updated_at") + public Optional getUpdatedAt() { + return updatedAt; + } + + /** + * @return The default locale of the article. + */ + @JsonProperty("locale") + public Optional getLocale() { + return locale; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof InternalArticleListItem && equalTo((InternalArticleListItem) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(InternalArticleListItem other) { + return type.equals(other.type) + && id.equals(other.id) + && title.equals(other.title) + && body.equals(other.body) + && ownerId.equals(other.ownerId) + && authorId.equals(other.authorId) + && createdAt.equals(other.createdAt) + && updatedAt.equals(other.updatedAt) + && locale.equals(other.locale); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash( + this.type, + this.id, + this.title, + this.body, + this.ownerId, + this.authorId, + this.createdAt, + this.updatedAt, + this.locale); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static Builder builder() { + return new Builder(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder { + private Optional type = Optional.empty(); + + private Optional id = Optional.empty(); + + private Optional title = Optional.empty(); + + private Optional body = Optional.empty(); + + private Optional ownerId = Optional.empty(); + + private Optional authorId = Optional.empty(); + + private Optional createdAt = Optional.empty(); + + private Optional updatedAt = Optional.empty(); + + private Optional locale = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + public Builder from(InternalArticleListItem other) { + type(other.getType()); + id(other.getId()); + title(other.getTitle()); + body(other.getBody()); + ownerId(other.getOwnerId()); + authorId(other.getAuthorId()); + createdAt(other.getCreatedAt()); + updatedAt(other.getUpdatedAt()); + locale(other.getLocale()); + return this; + } + + /** + *

The type of object - internal_article.

+ */ + @JsonSetter(value = "type", nulls = Nulls.SKIP) + public Builder type(Optional type) { + this.type = type; + return this; + } + + public Builder type(String type) { + this.type = Optional.ofNullable(type); + return this; + } + + /** + *

The unique identifier for the article which is given by Intercom.

+ */ + @JsonSetter(value = "id", nulls = Nulls.SKIP) + public Builder id(Optional id) { + this.id = id; + return this; + } + + public Builder id(String id) { + this.id = Optional.ofNullable(id); + return this; + } + + /** + *

The title of the article.

+ */ + @JsonSetter(value = "title", nulls = Nulls.SKIP) + public Builder title(Optional title) { + this.title = title; + return this; + } + + public Builder title(String title) { + this.title = Optional.ofNullable(title); + return this; + } + + /** + *

The body of the article in HTML.

+ */ + @JsonSetter(value = "body", nulls = Nulls.SKIP) + public Builder body(Optional body) { + this.body = body; + return this; + } + + public Builder body(String body) { + this.body = Optional.ofNullable(body); + return this; + } + + /** + *

The id of the owner of the article.

+ */ + @JsonSetter(value = "owner_id", nulls = Nulls.SKIP) + public Builder ownerId(Optional ownerId) { + this.ownerId = ownerId; + return this; + } + + public Builder ownerId(Integer ownerId) { + this.ownerId = Optional.ofNullable(ownerId); + return this; + } + + /** + *

The id of the author of the article.

+ */ + @JsonSetter(value = "author_id", nulls = Nulls.SKIP) + public Builder authorId(Optional authorId) { + this.authorId = authorId; + return this; + } + + public Builder authorId(Integer authorId) { + this.authorId = Optional.ofNullable(authorId); + return this; + } + + /** + *

The time when the article was created.

+ */ + @JsonSetter(value = "created_at", nulls = Nulls.SKIP) + public Builder createdAt(Optional createdAt) { + this.createdAt = createdAt; + return this; + } + + public Builder createdAt(Integer createdAt) { + this.createdAt = Optional.ofNullable(createdAt); + return this; + } + + /** + *

The time when the article was last updated.

+ */ + @JsonSetter(value = "updated_at", nulls = Nulls.SKIP) + public Builder updatedAt(Optional updatedAt) { + this.updatedAt = updatedAt; + return this; + } + + public Builder updatedAt(Integer updatedAt) { + this.updatedAt = Optional.ofNullable(updatedAt); + return this; + } + + /** + *

The default locale of the article.

+ */ + @JsonSetter(value = "locale", nulls = Nulls.SKIP) + public Builder locale(Optional locale) { + this.locale = locale; + return this; + } + + public Builder locale(String locale) { + this.locale = Optional.ofNullable(locale); + return this; + } + + public InternalArticleListItem build() { + return new InternalArticleListItem( + type, id, title, body, ownerId, authorId, createdAt, updatedAt, locale, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/internalarticles/types/InternalArticleSearchResponse.java b/src/main/java/com/intercom/api/resources/internalarticles/types/InternalArticleSearchResponse.java new file mode 100644 index 00000000..7bf51bd4 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/internalarticles/types/InternalArticleSearchResponse.java @@ -0,0 +1,273 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.internalarticles.types; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.types.CursorPages; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = InternalArticleSearchResponse.Builder.class) +public final class InternalArticleSearchResponse { + private final Optional type; + + private final Optional totalCount; + + private final Optional data; + + private final Optional pages; + + private final Map additionalProperties; + + private InternalArticleSearchResponse( + Optional type, + Optional totalCount, + Optional data, + Optional pages, + Map additionalProperties) { + this.type = type; + this.totalCount = totalCount; + this.data = data; + this.pages = pages; + this.additionalProperties = additionalProperties; + } + + /** + * @return The type of the object - list. + */ + @JsonProperty("type") + public Optional getType() { + return type; + } + + /** + * @return The total number of Internal Articles matching the search query + */ + @JsonProperty("total_count") + public Optional getTotalCount() { + return totalCount; + } + + /** + * @return An object containing the results of the search. + */ + @JsonProperty("data") + public Optional getData() { + return data; + } + + @JsonProperty("pages") + public Optional getPages() { + return pages; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof InternalArticleSearchResponse && equalTo((InternalArticleSearchResponse) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(InternalArticleSearchResponse other) { + return type.equals(other.type) + && totalCount.equals(other.totalCount) + && data.equals(other.data) + && pages.equals(other.pages); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.type, this.totalCount, this.data, this.pages); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static Builder builder() { + return new Builder(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder { + private Optional type = Optional.empty(); + + private Optional totalCount = Optional.empty(); + + private Optional data = Optional.empty(); + + private Optional pages = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + public Builder from(InternalArticleSearchResponse other) { + type(other.getType()); + totalCount(other.getTotalCount()); + data(other.getData()); + pages(other.getPages()); + return this; + } + + /** + *

The type of the object - list.

+ */ + @JsonSetter(value = "type", nulls = Nulls.SKIP) + public Builder type(Optional type) { + this.type = type; + return this; + } + + public Builder type(String type) { + this.type = Optional.ofNullable(type); + return this; + } + + /** + *

The total number of Internal Articles matching the search query

+ */ + @JsonSetter(value = "total_count", nulls = Nulls.SKIP) + public Builder totalCount(Optional totalCount) { + this.totalCount = totalCount; + return this; + } + + public Builder totalCount(Integer totalCount) { + this.totalCount = Optional.ofNullable(totalCount); + return this; + } + + /** + *

An object containing the results of the search.

+ */ + @JsonSetter(value = "data", nulls = Nulls.SKIP) + public Builder data(Optional data) { + this.data = data; + return this; + } + + public Builder data(Data data) { + this.data = Optional.ofNullable(data); + return this; + } + + @JsonSetter(value = "pages", nulls = Nulls.SKIP) + public Builder pages(Optional pages) { + this.pages = pages; + return this; + } + + public Builder pages(CursorPages pages) { + this.pages = Optional.ofNullable(pages); + return this; + } + + public InternalArticleSearchResponse build() { + return new InternalArticleSearchResponse(type, totalCount, data, pages, additionalProperties); + } + } + + @JsonInclude(JsonInclude.Include.NON_ABSENT) + @JsonDeserialize(builder = Data.Builder.class) + public static final class Data { + private final Optional> internalArticles; + + private final Map additionalProperties; + + private Data( + Optional> internalArticles, Map additionalProperties) { + this.internalArticles = internalArticles; + this.additionalProperties = additionalProperties; + } + + /** + * @return An array of Internal Article objects + */ + @JsonProperty("internal_articles") + public Optional> getInternalArticles() { + return internalArticles; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof Data && equalTo((Data) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(Data other) { + return internalArticles.equals(other.internalArticles); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.internalArticles); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static Builder builder() { + return new Builder(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder { + private Optional> internalArticles = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + public Builder from(Data other) { + internalArticles(other.getInternalArticles()); + return this; + } + + /** + *

An array of Internal Article objects

+ */ + @JsonSetter(value = "internal_articles", nulls = Nulls.SKIP) + public Builder internalArticles(Optional> internalArticles) { + this.internalArticles = internalArticles; + return this; + } + + public Builder internalArticles(List internalArticles) { + this.internalArticles = Optional.ofNullable(internalArticles); + return this; + } + + public Data build() { + return new Data(internalArticles, additionalProperties); + } + } + } +} diff --git a/src/main/java/com/intercom/api/resources/ipallowlist/AsyncIpAllowlistClient.java b/src/main/java/com/intercom/api/resources/ipallowlist/AsyncIpAllowlistClient.java new file mode 100644 index 00000000..e7184865 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/ipallowlist/AsyncIpAllowlistClient.java @@ -0,0 +1,71 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.ipallowlist; + +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.types.IpAllowlist; +import java.util.concurrent.CompletableFuture; + +public class AsyncIpAllowlistClient { + protected final ClientOptions clientOptions; + + private final AsyncRawIpAllowlistClient rawClient; + + public AsyncIpAllowlistClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + this.rawClient = new AsyncRawIpAllowlistClient(clientOptions); + } + + /** + * Get responses with HTTP metadata like headers + */ + public AsyncRawIpAllowlistClient withRawResponse() { + return this.rawClient; + } + + /** + * Retrieve the current IP allowlist configuration for the workspace. + */ + public CompletableFuture getIpAllowlist() { + return this.rawClient.getIpAllowlist().thenApply(response -> response.body()); + } + + /** + * Retrieve the current IP allowlist configuration for the workspace. + */ + public CompletableFuture getIpAllowlist(RequestOptions requestOptions) { + return this.rawClient.getIpAllowlist(requestOptions).thenApply(response -> response.body()); + } + + /** + * 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 %}

+ */ + public CompletableFuture updateIpAllowlist() { + return this.rawClient.updateIpAllowlist().thenApply(response -> response.body()); + } + + /** + * 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 %}

+ */ + public CompletableFuture updateIpAllowlist(IpAllowlist request) { + return this.rawClient.updateIpAllowlist(request).thenApply(response -> response.body()); + } + + /** + * 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 %}

+ */ + public CompletableFuture updateIpAllowlist(IpAllowlist request, RequestOptions requestOptions) { + return this.rawClient.updateIpAllowlist(request, requestOptions).thenApply(response -> response.body()); + } +} diff --git a/src/main/java/com/intercom/api/resources/ipallowlist/AsyncRawIpAllowlistClient.java b/src/main/java/com/intercom/api/resources/ipallowlist/AsyncRawIpAllowlistClient.java new file mode 100644 index 00000000..316ad3a1 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/ipallowlist/AsyncRawIpAllowlistClient.java @@ -0,0 +1,193 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.ipallowlist; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.IntercomApiException; +import com.intercom.api.core.IntercomException; +import com.intercom.api.core.IntercomHttpResponse; +import com.intercom.api.core.MediaTypes; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.errors.UnauthorizedError; +import com.intercom.api.errors.UnprocessableEntityError; +import com.intercom.api.types.Error; +import com.intercom.api.types.IpAllowlist; +import java.io.IOException; +import java.util.concurrent.CompletableFuture; +import okhttp3.Call; +import okhttp3.Callback; +import okhttp3.Headers; +import okhttp3.HttpUrl; +import okhttp3.OkHttpClient; +import okhttp3.Request; +import okhttp3.RequestBody; +import okhttp3.Response; +import okhttp3.ResponseBody; +import org.jetbrains.annotations.NotNull; + +public class AsyncRawIpAllowlistClient { + protected final ClientOptions clientOptions; + + public AsyncRawIpAllowlistClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + } + + /** + * Retrieve the current IP allowlist configuration for the workspace. + */ + public CompletableFuture> getIpAllowlist() { + return getIpAllowlist(null); + } + + /** + * Retrieve the current IP allowlist configuration for the workspace. + */ + public CompletableFuture> getIpAllowlist(RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("ip_allowlist") + .build(); + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, IpAllowlist.class), response)); + return; + } + try { + if (response.code() == 401) { + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * 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 %}

+ */ + public CompletableFuture> updateIpAllowlist() { + return updateIpAllowlist(IpAllowlist.builder().build()); + } + + /** + * 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 %}

+ */ + public CompletableFuture> updateIpAllowlist(IpAllowlist request) { + return updateIpAllowlist(request, null); + } + + /** + * 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 %}

+ */ + public CompletableFuture> updateIpAllowlist( + IpAllowlist request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("ip_allowlist") + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("PUT", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, IpAllowlist.class), response)); + return; + } + try { + switch (response.code()) { + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 422: + future.completeExceptionally(new UnprocessableEntityError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } +} diff --git a/src/main/java/com/intercom/api/resources/ipallowlist/IpAllowlistClient.java b/src/main/java/com/intercom/api/resources/ipallowlist/IpAllowlistClient.java new file mode 100644 index 00000000..d4e12b7c --- /dev/null +++ b/src/main/java/com/intercom/api/resources/ipallowlist/IpAllowlistClient.java @@ -0,0 +1,70 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.ipallowlist; + +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.types.IpAllowlist; + +public class IpAllowlistClient { + protected final ClientOptions clientOptions; + + private final RawIpAllowlistClient rawClient; + + public IpAllowlistClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + this.rawClient = new RawIpAllowlistClient(clientOptions); + } + + /** + * Get responses with HTTP metadata like headers + */ + public RawIpAllowlistClient withRawResponse() { + return this.rawClient; + } + + /** + * Retrieve the current IP allowlist configuration for the workspace. + */ + public IpAllowlist getIpAllowlist() { + return this.rawClient.getIpAllowlist().body(); + } + + /** + * Retrieve the current IP allowlist configuration for the workspace. + */ + public IpAllowlist getIpAllowlist(RequestOptions requestOptions) { + return this.rawClient.getIpAllowlist(requestOptions).body(); + } + + /** + * 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 %}

+ */ + public IpAllowlist updateIpAllowlist() { + return this.rawClient.updateIpAllowlist().body(); + } + + /** + * 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 %}

+ */ + public IpAllowlist updateIpAllowlist(IpAllowlist request) { + return this.rawClient.updateIpAllowlist(request).body(); + } + + /** + * 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 %}

+ */ + public IpAllowlist updateIpAllowlist(IpAllowlist request, RequestOptions requestOptions) { + return this.rawClient.updateIpAllowlist(request, requestOptions).body(); + } +} diff --git a/src/main/java/com/intercom/api/resources/ipallowlist/RawIpAllowlistClient.java b/src/main/java/com/intercom/api/resources/ipallowlist/RawIpAllowlistClient.java new file mode 100644 index 00000000..16e1c578 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/ipallowlist/RawIpAllowlistClient.java @@ -0,0 +1,157 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.ipallowlist; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.IntercomApiException; +import com.intercom.api.core.IntercomException; +import com.intercom.api.core.IntercomHttpResponse; +import com.intercom.api.core.MediaTypes; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.errors.UnauthorizedError; +import com.intercom.api.errors.UnprocessableEntityError; +import com.intercom.api.types.Error; +import com.intercom.api.types.IpAllowlist; +import java.io.IOException; +import okhttp3.Headers; +import okhttp3.HttpUrl; +import okhttp3.OkHttpClient; +import okhttp3.Request; +import okhttp3.RequestBody; +import okhttp3.Response; +import okhttp3.ResponseBody; + +public class RawIpAllowlistClient { + protected final ClientOptions clientOptions; + + public RawIpAllowlistClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + } + + /** + * Retrieve the current IP allowlist configuration for the workspace. + */ + public IntercomHttpResponse getIpAllowlist() { + return getIpAllowlist(null); + } + + /** + * Retrieve the current IP allowlist configuration for the workspace. + */ + public IntercomHttpResponse getIpAllowlist(RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("ip_allowlist") + .build(); + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, IpAllowlist.class), response); + } + try { + if (response.code() == 401) { + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * 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 %}

+ */ + public IntercomHttpResponse updateIpAllowlist() { + return updateIpAllowlist(IpAllowlist.builder().build()); + } + + /** + * 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 %}

+ */ + public IntercomHttpResponse updateIpAllowlist(IpAllowlist request) { + return updateIpAllowlist(request, null); + } + + /** + * 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 %}

+ */ + public IntercomHttpResponse updateIpAllowlist(IpAllowlist request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("ip_allowlist") + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("PUT", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, IpAllowlist.class), response); + } + try { + switch (response.code()) { + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 422: + throw new UnprocessableEntityError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/jobs/AsyncJobsClient.java b/src/main/java/com/intercom/api/resources/jobs/AsyncJobsClient.java new file mode 100644 index 00000000..093d4fc9 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/jobs/AsyncJobsClient.java @@ -0,0 +1,42 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.jobs; + +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.resources.jobs.requests.JobsStatusRequest; +import com.intercom.api.resources.jobs.types.Jobs; +import java.util.concurrent.CompletableFuture; + +public class AsyncJobsClient { + protected final ClientOptions clientOptions; + + private final AsyncRawJobsClient rawClient; + + public AsyncJobsClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + this.rawClient = new AsyncRawJobsClient(clientOptions); + } + + /** + * Get responses with HTTP metadata like headers + */ + public AsyncRawJobsClient withRawResponse() { + return this.rawClient; + } + + /** + * Retrieve the status of job execution. + */ + public CompletableFuture status(JobsStatusRequest request) { + return this.rawClient.status(request).thenApply(response -> response.body()); + } + + /** + * Retrieve the status of job execution. + */ + public CompletableFuture status(JobsStatusRequest request, RequestOptions requestOptions) { + return this.rawClient.status(request, requestOptions).thenApply(response -> response.body()); + } +} diff --git a/src/main/java/com/intercom/api/resources/jobs/AsyncRawJobsClient.java b/src/main/java/com/intercom/api/resources/jobs/AsyncRawJobsClient.java new file mode 100644 index 00000000..acdcb2c8 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/jobs/AsyncRawJobsClient.java @@ -0,0 +1,107 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.jobs; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.IntercomApiException; +import com.intercom.api.core.IntercomException; +import com.intercom.api.core.IntercomHttpResponse; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.errors.NotFoundError; +import com.intercom.api.errors.UnauthorizedError; +import com.intercom.api.resources.jobs.requests.JobsStatusRequest; +import com.intercom.api.resources.jobs.types.Jobs; +import com.intercom.api.types.Error; +import java.io.IOException; +import java.util.concurrent.CompletableFuture; +import okhttp3.Call; +import okhttp3.Callback; +import okhttp3.Headers; +import okhttp3.HttpUrl; +import okhttp3.OkHttpClient; +import okhttp3.Request; +import okhttp3.Response; +import okhttp3.ResponseBody; +import org.jetbrains.annotations.NotNull; + +public class AsyncRawJobsClient { + protected final ClientOptions clientOptions; + + public AsyncRawJobsClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + } + + /** + * Retrieve the status of job execution. + */ + public CompletableFuture> status(JobsStatusRequest request) { + return status(request, null); + } + + /** + * Retrieve the status of job execution. + */ + public CompletableFuture> status( + JobsStatusRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("jobs/status") + .addPathSegment(request.getJobId()) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Jobs.class), response)); + return; + } + try { + switch (response.code()) { + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 404: + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } +} diff --git a/src/main/java/com/intercom/api/resources/jobs/JobsClient.java b/src/main/java/com/intercom/api/resources/jobs/JobsClient.java new file mode 100644 index 00000000..23576e42 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/jobs/JobsClient.java @@ -0,0 +1,41 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.jobs; + +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.resources.jobs.requests.JobsStatusRequest; +import com.intercom.api.resources.jobs.types.Jobs; + +public class JobsClient { + protected final ClientOptions clientOptions; + + private final RawJobsClient rawClient; + + public JobsClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + this.rawClient = new RawJobsClient(clientOptions); + } + + /** + * Get responses with HTTP metadata like headers + */ + public RawJobsClient withRawResponse() { + return this.rawClient; + } + + /** + * Retrieve the status of job execution. + */ + public Jobs status(JobsStatusRequest request) { + return this.rawClient.status(request).body(); + } + + /** + * Retrieve the status of job execution. + */ + public Jobs status(JobsStatusRequest request, RequestOptions requestOptions) { + return this.rawClient.status(request, requestOptions).body(); + } +} diff --git a/src/main/java/com/intercom/api/resources/jobs/RawJobsClient.java b/src/main/java/com/intercom/api/resources/jobs/RawJobsClient.java new file mode 100644 index 00000000..4b77ef80 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/jobs/RawJobsClient.java @@ -0,0 +1,85 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.jobs; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.IntercomApiException; +import com.intercom.api.core.IntercomException; +import com.intercom.api.core.IntercomHttpResponse; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.errors.NotFoundError; +import com.intercom.api.errors.UnauthorizedError; +import com.intercom.api.resources.jobs.requests.JobsStatusRequest; +import com.intercom.api.resources.jobs.types.Jobs; +import com.intercom.api.types.Error; +import java.io.IOException; +import okhttp3.Headers; +import okhttp3.HttpUrl; +import okhttp3.OkHttpClient; +import okhttp3.Request; +import okhttp3.Response; +import okhttp3.ResponseBody; + +public class RawJobsClient { + protected final ClientOptions clientOptions; + + public RawJobsClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + } + + /** + * Retrieve the status of job execution. + */ + public IntercomHttpResponse status(JobsStatusRequest request) { + return status(request, null); + } + + /** + * Retrieve the status of job execution. + */ + public IntercomHttpResponse status(JobsStatusRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("jobs/status") + .addPathSegment(request.getJobId()) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Jobs.class), response); + } + try { + switch (response.code()) { + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 404: + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/jobs/requests/JobsStatusRequest.java b/src/main/java/com/intercom/api/resources/jobs/requests/JobsStatusRequest.java new file mode 100644 index 00000000..acacfaae --- /dev/null +++ b/src/main/java/com/intercom/api/resources/jobs/requests/JobsStatusRequest.java @@ -0,0 +1,113 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.jobs.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = JobsStatusRequest.Builder.class) +public final class JobsStatusRequest { + private final String jobId; + + private final Map additionalProperties; + + private JobsStatusRequest(String jobId, Map additionalProperties) { + this.jobId = jobId; + this.additionalProperties = additionalProperties; + } + + /** + * @return The unique identifier for the job which is given by Intercom + */ + @JsonProperty("job_id") + public String getJobId() { + return jobId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof JobsStatusRequest && equalTo((JobsStatusRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(JobsStatusRequest other) { + return jobId.equals(other.jobId); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.jobId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static JobIdStage builder() { + return new Builder(); + } + + public interface JobIdStage { + /** + *

The unique identifier for the job which is given by Intercom

+ */ + _FinalStage jobId(@NotNull String jobId); + + Builder from(JobsStatusRequest other); + } + + public interface _FinalStage { + JobsStatusRequest build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements JobIdStage, _FinalStage { + private String jobId; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(JobsStatusRequest other) { + jobId(other.getJobId()); + return this; + } + + /** + *

The unique identifier for the job which is given by Intercom

+ *

The unique identifier for the job which is given by Intercom

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("job_id") + public _FinalStage jobId(@NotNull String jobId) { + this.jobId = Objects.requireNonNull(jobId, "jobId must not be null"); + return this; + } + + @java.lang.Override + public JobsStatusRequest build() { + return new JobsStatusRequest(jobId, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/jobs/types/Jobs.java b/src/main/java/com/intercom/api/resources/jobs/types/Jobs.java new file mode 100644 index 00000000..06ef5c8d --- /dev/null +++ b/src/main/java/com/intercom/api/resources/jobs/types/Jobs.java @@ -0,0 +1,463 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.jobs.types; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.JsonValue; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = Jobs.Builder.class) +public final class Jobs { + private final Optional type; + + private final String id; + + private final Optional url; + + private final Optional status; + + private final Optional resourceType; + + private final Optional resourceId; + + private final Optional resourceUrl; + + private final Map additionalProperties; + + private Jobs( + Optional type, + String id, + Optional url, + Optional status, + Optional resourceType, + Optional resourceId, + Optional resourceUrl, + Map additionalProperties) { + this.type = type; + this.id = id; + this.url = url; + this.status = status; + this.resourceType = resourceType; + this.resourceId = resourceId; + this.resourceUrl = resourceUrl; + this.additionalProperties = additionalProperties; + } + + /** + * @return The type of the object + */ + @JsonProperty("type") + public Optional getType() { + return type; + } + + /** + * @return The id of the job that's currently being processed or has completed. + */ + @JsonProperty("id") + public String getId() { + return id; + } + + /** + * @return API endpoint URL to check the job status. + */ + @JsonProperty("url") + public Optional getUrl() { + return url; + } + + /** + * @return The status of the job execution. + */ + @JsonProperty("status") + public Optional getStatus() { + return status; + } + + /** + * @return The type of resource created during job execution. + */ + @JsonProperty("resource_type") + public Optional getResourceType() { + return resourceType; + } + + /** + * @return The id of the resource created during job execution (e.g. ticket id) + */ + @JsonProperty("resource_id") + public Optional getResourceId() { + return resourceId; + } + + /** + * @return The url of the resource created during job exeuction. Use this url to fetch the resource. + */ + @JsonProperty("resource_url") + public Optional getResourceUrl() { + return resourceUrl; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof Jobs && equalTo((Jobs) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(Jobs other) { + return type.equals(other.type) + && id.equals(other.id) + && url.equals(other.url) + && status.equals(other.status) + && resourceType.equals(other.resourceType) + && resourceId.equals(other.resourceId) + && resourceUrl.equals(other.resourceUrl); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash( + this.type, this.id, this.url, this.status, this.resourceType, this.resourceId, this.resourceUrl); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static IdStage builder() { + return new Builder(); + } + + public interface IdStage { + /** + *

The id of the job that's currently being processed or has completed.

+ */ + _FinalStage id(@NotNull String id); + + Builder from(Jobs other); + } + + public interface _FinalStage { + Jobs build(); + + /** + *

The type of the object

+ */ + _FinalStage type(Optional type); + + _FinalStage type(String type); + + /** + *

API endpoint URL to check the job status.

+ */ + _FinalStage url(Optional url); + + _FinalStage url(String url); + + /** + *

The status of the job execution.

+ */ + _FinalStage status(Optional status); + + _FinalStage status(Status status); + + /** + *

The type of resource created during job execution.

+ */ + _FinalStage resourceType(Optional resourceType); + + _FinalStage resourceType(String resourceType); + + /** + *

The id of the resource created during job execution (e.g. ticket id)

+ */ + _FinalStage resourceId(Optional resourceId); + + _FinalStage resourceId(String resourceId); + + /** + *

The url of the resource created during job exeuction. Use this url to fetch the resource.

+ */ + _FinalStage resourceUrl(Optional resourceUrl); + + _FinalStage resourceUrl(String resourceUrl); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements IdStage, _FinalStage { + private String id; + + private Optional resourceUrl = Optional.empty(); + + private Optional resourceId = Optional.empty(); + + private Optional resourceType = Optional.empty(); + + private Optional status = Optional.empty(); + + private Optional url = Optional.empty(); + + private Optional type = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(Jobs other) { + type(other.getType()); + id(other.getId()); + url(other.getUrl()); + status(other.getStatus()); + resourceType(other.getResourceType()); + resourceId(other.getResourceId()); + resourceUrl(other.getResourceUrl()); + return this; + } + + /** + *

The id of the job that's currently being processed or has completed.

+ *

The id of the job that's currently being processed or has completed.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("id") + public _FinalStage id(@NotNull String id) { + this.id = Objects.requireNonNull(id, "id must not be null"); + return this; + } + + /** + *

The url of the resource created during job exeuction. Use this url to fetch the resource.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage resourceUrl(String resourceUrl) { + this.resourceUrl = Optional.ofNullable(resourceUrl); + return this; + } + + /** + *

The url of the resource created during job exeuction. Use this url to fetch the resource.

+ */ + @java.lang.Override + @JsonSetter(value = "resource_url", nulls = Nulls.SKIP) + public _FinalStage resourceUrl(Optional resourceUrl) { + this.resourceUrl = resourceUrl; + return this; + } + + /** + *

The id of the resource created during job execution (e.g. ticket id)

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage resourceId(String resourceId) { + this.resourceId = Optional.ofNullable(resourceId); + return this; + } + + /** + *

The id of the resource created during job execution (e.g. ticket id)

+ */ + @java.lang.Override + @JsonSetter(value = "resource_id", nulls = Nulls.SKIP) + public _FinalStage resourceId(Optional resourceId) { + this.resourceId = resourceId; + return this; + } + + /** + *

The type of resource created during job execution.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage resourceType(String resourceType) { + this.resourceType = Optional.ofNullable(resourceType); + return this; + } + + /** + *

The type of resource created during job execution.

+ */ + @java.lang.Override + @JsonSetter(value = "resource_type", nulls = Nulls.SKIP) + public _FinalStage resourceType(Optional resourceType) { + this.resourceType = resourceType; + return this; + } + + /** + *

The status of the job execution.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage status(Status status) { + this.status = Optional.ofNullable(status); + return this; + } + + /** + *

The status of the job execution.

+ */ + @java.lang.Override + @JsonSetter(value = "status", nulls = Nulls.SKIP) + public _FinalStage status(Optional status) { + this.status = status; + return this; + } + + /** + *

API endpoint URL to check the job status.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage url(String url) { + this.url = Optional.ofNullable(url); + return this; + } + + /** + *

API endpoint URL to check the job status.

+ */ + @java.lang.Override + @JsonSetter(value = "url", nulls = Nulls.SKIP) + public _FinalStage url(Optional url) { + this.url = url; + return this; + } + + /** + *

The type of the object

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage type(String type) { + this.type = Optional.ofNullable(type); + return this; + } + + /** + *

The type of the object

+ */ + @java.lang.Override + @JsonSetter(value = "type", nulls = Nulls.SKIP) + public _FinalStage type(Optional type) { + this.type = type; + return this; + } + + @java.lang.Override + public Jobs build() { + return new Jobs(type, id, url, status, resourceType, resourceId, resourceUrl, additionalProperties); + } + } + + public static final class Status { + public static final Status SUCCESS = new Status(Value.SUCCESS, "success"); + + public static final Status FAILED = new Status(Value.FAILED, "failed"); + + public static final Status PENDING = new Status(Value.PENDING, "pending"); + + private final Value value; + + private final String string; + + Status(Value value, String string) { + this.value = value; + this.string = string; + } + + public Value getEnumValue() { + return value; + } + + @java.lang.Override + @JsonValue + public String toString() { + return this.string; + } + + @java.lang.Override + public boolean equals(Object other) { + return (this == other) || (other instanceof Status && this.string.equals(((Status) other).string)); + } + + @java.lang.Override + public int hashCode() { + return this.string.hashCode(); + } + + public T visit(Visitor visitor) { + switch (value) { + case SUCCESS: + return visitor.visitSuccess(); + case FAILED: + return visitor.visitFailed(); + case PENDING: + return visitor.visitPending(); + case UNKNOWN: + default: + return visitor.visitUnknown(string); + } + } + + @JsonCreator(mode = JsonCreator.Mode.DELEGATING) + public static Status valueOf(String value) { + switch (value) { + case "success": + return SUCCESS; + case "failed": + return FAILED; + case "pending": + return PENDING; + default: + return new Status(Value.UNKNOWN, value); + } + } + + public enum Value { + PENDING, + + SUCCESS, + + FAILED, + + UNKNOWN + } + + public interface Visitor { + T visitPending(); + + T visitSuccess(); + + T visitFailed(); + + T visitUnknown(String unknownType); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/messages/AsyncMessagesClient.java b/src/main/java/com/intercom/api/resources/messages/AsyncMessagesClient.java new file mode 100644 index 00000000..468fc472 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/messages/AsyncMessagesClient.java @@ -0,0 +1,77 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.messages; + +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.resources.messages.types.Message; +import com.intercom.api.types.CreateMessageRequest; +import java.util.Optional; +import java.util.concurrent.CompletableFuture; + +public class AsyncMessagesClient { + protected final ClientOptions clientOptions; + + private final AsyncRawMessagesClient rawClient; + + public AsyncMessagesClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + this.rawClient = new AsyncRawMessagesClient(clientOptions); + } + + /** + * Get responses with HTTP metadata like headers + */ + public AsyncRawMessagesClient withRawResponse() { + return this.rawClient; + } + + /** + * You can create a message that has been initiated by an admin. The conversation can be either an in-app message or an email. + *
+ *

🚧 Sending for visitors

+ *

There can be a short delay between when a contact is created and when a contact becomes available to be messaged through the API. A 404 Not Found error will be returned in this case.

+ *
+ *

This will return the Message model that has been created.

+ *
+ *

🚧 Retrieving Associated Conversations

+ *

As this is a message, there will be no conversation present until the contact responds. Once they do, you will have to search for a contact's conversations with the id of the message.

+ *
+ */ + public CompletableFuture create() { + return this.rawClient.create().thenApply(response -> response.body()); + } + + /** + * You can create a message that has been initiated by an admin. The conversation can be either an in-app message or an email. + *
+ *

🚧 Sending for visitors

+ *

There can be a short delay between when a contact is created and when a contact becomes available to be messaged through the API. A 404 Not Found error will be returned in this case.

+ *
+ *

This will return the Message model that has been created.

+ *
+ *

🚧 Retrieving Associated Conversations

+ *

As this is a message, there will be no conversation present until the contact responds. Once they do, you will have to search for a contact's conversations with the id of the message.

+ *
+ */ + public CompletableFuture create(Optional request) { + return this.rawClient.create(request).thenApply(response -> response.body()); + } + + /** + * You can create a message that has been initiated by an admin. The conversation can be either an in-app message or an email. + *
+ *

🚧 Sending for visitors

+ *

There can be a short delay between when a contact is created and when a contact becomes available to be messaged through the API. A 404 Not Found error will be returned in this case.

+ *
+ *

This will return the Message model that has been created.

+ *
+ *

🚧 Retrieving Associated Conversations

+ *

As this is a message, there will be no conversation present until the contact responds. Once they do, you will have to search for a contact's conversations with the id of the message.

+ *
+ */ + public CompletableFuture create(Optional request, RequestOptions requestOptions) { + return this.rawClient.create(request, requestOptions).thenApply(response -> response.body()); + } +} diff --git a/src/main/java/com/intercom/api/resources/messages/AsyncRawMessagesClient.java b/src/main/java/com/intercom/api/resources/messages/AsyncRawMessagesClient.java new file mode 100644 index 00000000..aad8cf0a --- /dev/null +++ b/src/main/java/com/intercom/api/resources/messages/AsyncRawMessagesClient.java @@ -0,0 +1,166 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.messages; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.IntercomApiException; +import com.intercom.api.core.IntercomException; +import com.intercom.api.core.IntercomHttpResponse; +import com.intercom.api.core.MediaTypes; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.errors.BadRequestError; +import com.intercom.api.errors.ForbiddenError; +import com.intercom.api.errors.UnauthorizedError; +import com.intercom.api.errors.UnprocessableEntityError; +import com.intercom.api.resources.messages.types.Message; +import com.intercom.api.types.CreateMessageRequest; +import com.intercom.api.types.Error; +import java.io.IOException; +import java.util.Optional; +import java.util.concurrent.CompletableFuture; +import okhttp3.Call; +import okhttp3.Callback; +import okhttp3.Headers; +import okhttp3.HttpUrl; +import okhttp3.OkHttpClient; +import okhttp3.Request; +import okhttp3.RequestBody; +import okhttp3.Response; +import okhttp3.ResponseBody; +import org.jetbrains.annotations.NotNull; + +public class AsyncRawMessagesClient { + protected final ClientOptions clientOptions; + + public AsyncRawMessagesClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + } + + /** + * You can create a message that has been initiated by an admin. The conversation can be either an in-app message or an email. + *
+ *

🚧 Sending for visitors

+ *

There can be a short delay between when a contact is created and when a contact becomes available to be messaged through the API. A 404 Not Found error will be returned in this case.

+ *
+ *

This will return the Message model that has been created.

+ *
+ *

🚧 Retrieving Associated Conversations

+ *

As this is a message, there will be no conversation present until the contact responds. Once they do, you will have to search for a contact's conversations with the id of the message.

+ *
+ */ + public CompletableFuture> create() { + return create(Optional.empty()); + } + + /** + * You can create a message that has been initiated by an admin. The conversation can be either an in-app message or an email. + *
+ *

🚧 Sending for visitors

+ *

There can be a short delay between when a contact is created and when a contact becomes available to be messaged through the API. A 404 Not Found error will be returned in this case.

+ *
+ *

This will return the Message model that has been created.

+ *
+ *

🚧 Retrieving Associated Conversations

+ *

As this is a message, there will be no conversation present until the contact responds. Once they do, you will have to search for a contact's conversations with the id of the message.

+ *
+ */ + public CompletableFuture> create(Optional request) { + return create(request, null); + } + + /** + * You can create a message that has been initiated by an admin. The conversation can be either an in-app message or an email. + *
+ *

🚧 Sending for visitors

+ *

There can be a short delay between when a contact is created and when a contact becomes available to be messaged through the API. A 404 Not Found error will be returned in this case.

+ *
+ *

This will return the Message model that has been created.

+ *
+ *

🚧 Retrieving Associated Conversations

+ *

As this is a message, there will be no conversation present until the contact responds. Once they do, you will have to search for a contact's conversations with the id of the message.

+ *
+ */ + public CompletableFuture> create( + Optional request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("messages") + .build(); + RequestBody body; + try { + body = RequestBody.create("", null); + if (request.isPresent()) { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Message.class), response)); + return; + } + try { + switch (response.code()) { + case 400: + future.completeExceptionally(new BadRequestError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 403: + future.completeExceptionally(new ForbiddenError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 422: + future.completeExceptionally(new UnprocessableEntityError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } +} diff --git a/src/main/java/com/intercom/api/resources/messages/MessagesClient.java b/src/main/java/com/intercom/api/resources/messages/MessagesClient.java new file mode 100644 index 00000000..afbd3d13 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/messages/MessagesClient.java @@ -0,0 +1,76 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.messages; + +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.resources.messages.types.Message; +import com.intercom.api.types.CreateMessageRequest; +import java.util.Optional; + +public class MessagesClient { + protected final ClientOptions clientOptions; + + private final RawMessagesClient rawClient; + + public MessagesClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + this.rawClient = new RawMessagesClient(clientOptions); + } + + /** + * Get responses with HTTP metadata like headers + */ + public RawMessagesClient withRawResponse() { + return this.rawClient; + } + + /** + * You can create a message that has been initiated by an admin. The conversation can be either an in-app message or an email. + *
+ *

🚧 Sending for visitors

+ *

There can be a short delay between when a contact is created and when a contact becomes available to be messaged through the API. A 404 Not Found error will be returned in this case.

+ *
+ *

This will return the Message model that has been created.

+ *
+ *

🚧 Retrieving Associated Conversations

+ *

As this is a message, there will be no conversation present until the contact responds. Once they do, you will have to search for a contact's conversations with the id of the message.

+ *
+ */ + public Message create() { + return this.rawClient.create().body(); + } + + /** + * You can create a message that has been initiated by an admin. The conversation can be either an in-app message or an email. + *
+ *

🚧 Sending for visitors

+ *

There can be a short delay between when a contact is created and when a contact becomes available to be messaged through the API. A 404 Not Found error will be returned in this case.

+ *
+ *

This will return the Message model that has been created.

+ *
+ *

🚧 Retrieving Associated Conversations

+ *

As this is a message, there will be no conversation present until the contact responds. Once they do, you will have to search for a contact's conversations with the id of the message.

+ *
+ */ + public Message create(Optional request) { + return this.rawClient.create(request).body(); + } + + /** + * You can create a message that has been initiated by an admin. The conversation can be either an in-app message or an email. + *
+ *

🚧 Sending for visitors

+ *

There can be a short delay between when a contact is created and when a contact becomes available to be messaged through the API. A 404 Not Found error will be returned in this case.

+ *
+ *

This will return the Message model that has been created.

+ *
+ *

🚧 Retrieving Associated Conversations

+ *

As this is a message, there will be no conversation present until the contact responds. Once they do, you will have to search for a contact's conversations with the id of the message.

+ *
+ */ + public Message create(Optional request, RequestOptions requestOptions) { + return this.rawClient.create(request, requestOptions).body(); + } +} diff --git a/src/main/java/com/intercom/api/resources/messages/RawMessagesClient.java b/src/main/java/com/intercom/api/resources/messages/RawMessagesClient.java new file mode 100644 index 00000000..067aad9c --- /dev/null +++ b/src/main/java/com/intercom/api/resources/messages/RawMessagesClient.java @@ -0,0 +1,140 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.messages; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.IntercomApiException; +import com.intercom.api.core.IntercomException; +import com.intercom.api.core.IntercomHttpResponse; +import com.intercom.api.core.MediaTypes; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.errors.BadRequestError; +import com.intercom.api.errors.ForbiddenError; +import com.intercom.api.errors.UnauthorizedError; +import com.intercom.api.errors.UnprocessableEntityError; +import com.intercom.api.resources.messages.types.Message; +import com.intercom.api.types.CreateMessageRequest; +import com.intercom.api.types.Error; +import java.io.IOException; +import java.util.Optional; +import okhttp3.Headers; +import okhttp3.HttpUrl; +import okhttp3.OkHttpClient; +import okhttp3.Request; +import okhttp3.RequestBody; +import okhttp3.Response; +import okhttp3.ResponseBody; + +public class RawMessagesClient { + protected final ClientOptions clientOptions; + + public RawMessagesClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + } + + /** + * You can create a message that has been initiated by an admin. The conversation can be either an in-app message or an email. + *
+ *

🚧 Sending for visitors

+ *

There can be a short delay between when a contact is created and when a contact becomes available to be messaged through the API. A 404 Not Found error will be returned in this case.

+ *
+ *

This will return the Message model that has been created.

+ *
+ *

🚧 Retrieving Associated Conversations

+ *

As this is a message, there will be no conversation present until the contact responds. Once they do, you will have to search for a contact's conversations with the id of the message.

+ *
+ */ + public IntercomHttpResponse create() { + return create(Optional.empty()); + } + + /** + * You can create a message that has been initiated by an admin. The conversation can be either an in-app message or an email. + *
+ *

🚧 Sending for visitors

+ *

There can be a short delay between when a contact is created and when a contact becomes available to be messaged through the API. A 404 Not Found error will be returned in this case.

+ *
+ *

This will return the Message model that has been created.

+ *
+ *

🚧 Retrieving Associated Conversations

+ *

As this is a message, there will be no conversation present until the contact responds. Once they do, you will have to search for a contact's conversations with the id of the message.

+ *
+ */ + public IntercomHttpResponse create(Optional request) { + return create(request, null); + } + + /** + * You can create a message that has been initiated by an admin. The conversation can be either an in-app message or an email. + *
+ *

🚧 Sending for visitors

+ *

There can be a short delay between when a contact is created and when a contact becomes available to be messaged through the API. A 404 Not Found error will be returned in this case.

+ *
+ *

This will return the Message model that has been created.

+ *
+ *

🚧 Retrieving Associated Conversations

+ *

As this is a message, there will be no conversation present until the contact responds. Once they do, you will have to search for a contact's conversations with the id of the message.

+ *
+ */ + public IntercomHttpResponse create(Optional request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("messages") + .build(); + RequestBody body; + try { + body = RequestBody.create("", null); + if (request.isPresent()) { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Message.class), response); + } + try { + switch (response.code()) { + case 400: + throw new BadRequestError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 403: + throw new ForbiddenError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 422: + throw new UnprocessableEntityError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/messages/types/Message.java b/src/main/java/com/intercom/api/resources/messages/types/Message.java new file mode 100644 index 00000000..7ac2f4cf --- /dev/null +++ b/src/main/java/com/intercom/api/resources/messages/types/Message.java @@ -0,0 +1,441 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.messages.types; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.JsonValue; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = Message.Builder.class) +public final class Message { + private final String type; + + private final String id; + + private final int createdAt; + + private final Optional subject; + + private final String body; + + private final MessageType messageType; + + private final String conversationId; + + private final Map additionalProperties; + + private Message( + String type, + String id, + int createdAt, + Optional subject, + String body, + MessageType messageType, + String conversationId, + Map additionalProperties) { + this.type = type; + this.id = id; + this.createdAt = createdAt; + this.subject = subject; + this.body = body; + this.messageType = messageType; + this.conversationId = conversationId; + this.additionalProperties = additionalProperties; + } + + /** + * @return The type of the message + */ + @JsonProperty("type") + public String getType() { + return type; + } + + /** + * @return The id representing the message. + */ + @JsonProperty("id") + public String getId() { + return id; + } + + /** + * @return The time the conversation was created. + */ + @JsonProperty("created_at") + public int getCreatedAt() { + return createdAt; + } + + /** + * @return The subject of the message. Only present if message_type: email. + */ + @JsonProperty("subject") + public Optional getSubject() { + return subject; + } + + /** + * @return The message body, which may contain HTML. + */ + @JsonProperty("body") + public String getBody() { + return body; + } + + /** + * @return The type of message that was sent. Can be email, inapp, facebook or twitter. + */ + @JsonProperty("message_type") + public MessageType getMessageType() { + return messageType; + } + + /** + * @return The associated conversation_id + */ + @JsonProperty("conversation_id") + public String getConversationId() { + return conversationId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof Message && equalTo((Message) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(Message other) { + return type.equals(other.type) + && id.equals(other.id) + && createdAt == other.createdAt + && subject.equals(other.subject) + && body.equals(other.body) + && messageType.equals(other.messageType) + && conversationId.equals(other.conversationId); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash( + this.type, this.id, this.createdAt, this.subject, this.body, this.messageType, this.conversationId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static TypeStage builder() { + return new Builder(); + } + + public interface TypeStage { + /** + *

The type of the message

+ */ + IdStage type(@NotNull String type); + + Builder from(Message other); + } + + public interface IdStage { + /** + *

The id representing the message.

+ */ + CreatedAtStage id(@NotNull String id); + } + + public interface CreatedAtStage { + /** + *

The time the conversation was created.

+ */ + BodyStage createdAt(int createdAt); + } + + public interface BodyStage { + /** + *

The message body, which may contain HTML.

+ */ + MessageTypeStage body(@NotNull String body); + } + + public interface MessageTypeStage { + /** + *

The type of message that was sent. Can be email, inapp, facebook or twitter.

+ */ + ConversationIdStage messageType(@NotNull MessageType messageType); + } + + public interface ConversationIdStage { + /** + *

The associated conversation_id

+ */ + _FinalStage conversationId(@NotNull String conversationId); + } + + public interface _FinalStage { + Message build(); + + /** + *

The subject of the message. Only present if message_type: email.

+ */ + _FinalStage subject(Optional subject); + + _FinalStage subject(String subject); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder + implements TypeStage, + IdStage, + CreatedAtStage, + BodyStage, + MessageTypeStage, + ConversationIdStage, + _FinalStage { + private String type; + + private String id; + + private int createdAt; + + private String body; + + private MessageType messageType; + + private String conversationId; + + private Optional subject = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(Message other) { + type(other.getType()); + id(other.getId()); + createdAt(other.getCreatedAt()); + subject(other.getSubject()); + body(other.getBody()); + messageType(other.getMessageType()); + conversationId(other.getConversationId()); + return this; + } + + /** + *

The type of the message

+ *

The type of the message

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("type") + public IdStage type(@NotNull String type) { + this.type = Objects.requireNonNull(type, "type must not be null"); + return this; + } + + /** + *

The id representing the message.

+ *

The id representing the message.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("id") + public CreatedAtStage id(@NotNull String id) { + this.id = Objects.requireNonNull(id, "id must not be null"); + return this; + } + + /** + *

The time the conversation was created.

+ *

The time the conversation was created.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("created_at") + public BodyStage createdAt(int createdAt) { + this.createdAt = createdAt; + return this; + } + + /** + *

The message body, which may contain HTML.

+ *

The message body, which may contain HTML.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("body") + public MessageTypeStage body(@NotNull String body) { + this.body = Objects.requireNonNull(body, "body must not be null"); + return this; + } + + /** + *

The type of message that was sent. Can be email, inapp, facebook or twitter.

+ *

The type of message that was sent. Can be email, inapp, facebook or twitter.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("message_type") + public ConversationIdStage messageType(@NotNull MessageType messageType) { + this.messageType = Objects.requireNonNull(messageType, "messageType must not be null"); + return this; + } + + /** + *

The associated conversation_id

+ *

The associated conversation_id

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("conversation_id") + public _FinalStage conversationId(@NotNull String conversationId) { + this.conversationId = Objects.requireNonNull(conversationId, "conversationId must not be null"); + return this; + } + + /** + *

The subject of the message. Only present if message_type: email.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage subject(String subject) { + this.subject = Optional.ofNullable(subject); + return this; + } + + /** + *

The subject of the message. Only present if message_type: email.

+ */ + @java.lang.Override + @JsonSetter(value = "subject", nulls = Nulls.SKIP) + public _FinalStage subject(Optional subject) { + this.subject = subject; + return this; + } + + @java.lang.Override + public Message build() { + return new Message(type, id, createdAt, subject, body, messageType, conversationId, additionalProperties); + } + } + + public static final class MessageType { + public static final MessageType EMAIL = new MessageType(Value.EMAIL, "email"); + + public static final MessageType FACEBOOK = new MessageType(Value.FACEBOOK, "facebook"); + + public static final MessageType INAPP = new MessageType(Value.INAPP, "inapp"); + + public static final MessageType TWITTER = new MessageType(Value.TWITTER, "twitter"); + + private final Value value; + + private final String string; + + MessageType(Value value, String string) { + this.value = value; + this.string = string; + } + + public Value getEnumValue() { + return value; + } + + @java.lang.Override + @JsonValue + public String toString() { + return this.string; + } + + @java.lang.Override + public boolean equals(Object other) { + return (this == other) + || (other instanceof MessageType && this.string.equals(((MessageType) other).string)); + } + + @java.lang.Override + public int hashCode() { + return this.string.hashCode(); + } + + public T visit(Visitor visitor) { + switch (value) { + case EMAIL: + return visitor.visitEmail(); + case FACEBOOK: + return visitor.visitFacebook(); + case INAPP: + return visitor.visitInapp(); + case TWITTER: + return visitor.visitTwitter(); + case UNKNOWN: + default: + return visitor.visitUnknown(string); + } + } + + @JsonCreator(mode = JsonCreator.Mode.DELEGATING) + public static MessageType valueOf(String value) { + switch (value) { + case "email": + return EMAIL; + case "facebook": + return FACEBOOK; + case "inapp": + return INAPP; + case "twitter": + return TWITTER; + default: + return new MessageType(Value.UNKNOWN, value); + } + } + + public enum Value { + EMAIL, + + INAPP, + + FACEBOOK, + + TWITTER, + + UNKNOWN + } + + public interface Visitor { + T visitEmail(); + + T visitInapp(); + + T visitFacebook(); + + T visitTwitter(); + + T visitUnknown(String unknownType); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/news/AsyncNewsClient.java b/src/main/java/com/intercom/api/resources/news/AsyncNewsClient.java new file mode 100644 index 00000000..97c6a79d --- /dev/null +++ b/src/main/java/com/intercom/api/resources/news/AsyncNewsClient.java @@ -0,0 +1,32 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.news; + +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.Suppliers; +import com.intercom.api.resources.news.feeds.AsyncFeedsClient; +import com.intercom.api.resources.news.items.AsyncItemsClient; +import java.util.function.Supplier; + +public class AsyncNewsClient { + protected final ClientOptions clientOptions; + + protected final Supplier itemsClient; + + protected final Supplier feedsClient; + + public AsyncNewsClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + this.itemsClient = Suppliers.memoize(() -> new AsyncItemsClient(clientOptions)); + this.feedsClient = Suppliers.memoize(() -> new AsyncFeedsClient(clientOptions)); + } + + public AsyncItemsClient items() { + return this.itemsClient.get(); + } + + public AsyncFeedsClient feeds() { + return this.feedsClient.get(); + } +} diff --git a/src/main/java/com/intercom/api/resources/news/NewsClient.java b/src/main/java/com/intercom/api/resources/news/NewsClient.java new file mode 100644 index 00000000..b3dcd25c --- /dev/null +++ b/src/main/java/com/intercom/api/resources/news/NewsClient.java @@ -0,0 +1,32 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.news; + +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.Suppliers; +import com.intercom.api.resources.news.feeds.FeedsClient; +import com.intercom.api.resources.news.items.ItemsClient; +import java.util.function.Supplier; + +public class NewsClient { + protected final ClientOptions clientOptions; + + protected final Supplier itemsClient; + + protected final Supplier feedsClient; + + public NewsClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + this.itemsClient = Suppliers.memoize(() -> new ItemsClient(clientOptions)); + this.feedsClient = Suppliers.memoize(() -> new FeedsClient(clientOptions)); + } + + public ItemsClient items() { + return this.itemsClient.get(); + } + + public FeedsClient feeds() { + return this.feedsClient.get(); + } +} diff --git a/src/main/java/com/intercom/api/resources/news/feeds/AsyncFeedsClient.java b/src/main/java/com/intercom/api/resources/news/feeds/AsyncFeedsClient.java new file mode 100644 index 00000000..c5557e4d --- /dev/null +++ b/src/main/java/com/intercom/api/resources/news/feeds/AsyncFeedsClient.java @@ -0,0 +1,73 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.news.feeds; + +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.resources.news.feeds.requests.FindNewsFeedRequest; +import com.intercom.api.resources.news.feeds.requests.ListNewsFeedItemsRequest; +import com.intercom.api.resources.news.types.Newsfeed; +import com.intercom.api.types.PaginatedResponse; +import java.util.concurrent.CompletableFuture; + +public class AsyncFeedsClient { + protected final ClientOptions clientOptions; + + private final AsyncRawFeedsClient rawClient; + + public AsyncFeedsClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + this.rawClient = new AsyncRawFeedsClient(clientOptions); + } + + /** + * Get responses with HTTP metadata like headers + */ + public AsyncRawFeedsClient withRawResponse() { + return this.rawClient; + } + + /** + * You can fetch a list of all news items that are live on a given newsfeed + */ + public CompletableFuture listItems(ListNewsFeedItemsRequest request) { + return this.rawClient.listItems(request).thenApply(response -> response.body()); + } + + /** + * You can fetch a list of all news items that are live on a given newsfeed + */ + public CompletableFuture listItems( + ListNewsFeedItemsRequest request, RequestOptions requestOptions) { + return this.rawClient.listItems(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can fetch a list of all newsfeeds + */ + public CompletableFuture list() { + return this.rawClient.list().thenApply(response -> response.body()); + } + + /** + * You can fetch a list of all newsfeeds + */ + public CompletableFuture list(RequestOptions requestOptions) { + return this.rawClient.list(requestOptions).thenApply(response -> response.body()); + } + + /** + * You can fetch the details of a single newsfeed + */ + public CompletableFuture find(FindNewsFeedRequest request) { + return this.rawClient.find(request).thenApply(response -> response.body()); + } + + /** + * You can fetch the details of a single newsfeed + */ + public CompletableFuture find(FindNewsFeedRequest request, RequestOptions requestOptions) { + return this.rawClient.find(request, requestOptions).thenApply(response -> response.body()); + } +} diff --git a/src/main/java/com/intercom/api/resources/news/feeds/AsyncRawFeedsClient.java b/src/main/java/com/intercom/api/resources/news/feeds/AsyncRawFeedsClient.java new file mode 100644 index 00000000..bb5aa286 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/news/feeds/AsyncRawFeedsClient.java @@ -0,0 +1,230 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.news.feeds; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.IntercomApiException; +import com.intercom.api.core.IntercomException; +import com.intercom.api.core.IntercomHttpResponse; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.errors.UnauthorizedError; +import com.intercom.api.resources.news.feeds.requests.FindNewsFeedRequest; +import com.intercom.api.resources.news.feeds.requests.ListNewsFeedItemsRequest; +import com.intercom.api.resources.news.types.Newsfeed; +import com.intercom.api.types.Error; +import com.intercom.api.types.PaginatedResponse; +import java.io.IOException; +import java.util.concurrent.CompletableFuture; +import okhttp3.Call; +import okhttp3.Callback; +import okhttp3.Headers; +import okhttp3.HttpUrl; +import okhttp3.OkHttpClient; +import okhttp3.Request; +import okhttp3.Response; +import okhttp3.ResponseBody; +import org.jetbrains.annotations.NotNull; + +public class AsyncRawFeedsClient { + protected final ClientOptions clientOptions; + + public AsyncRawFeedsClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + } + + /** + * You can fetch a list of all news items that are live on a given newsfeed + */ + public CompletableFuture> listItems(ListNewsFeedItemsRequest request) { + return listItems(request, null); + } + + /** + * You can fetch a list of all news items that are live on a given newsfeed + */ + public CompletableFuture> listItems( + ListNewsFeedItemsRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("news/newsfeeds") + .addPathSegment(request.getNewsfeedId()) + .addPathSegments("items") + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, PaginatedResponse.class), + response)); + return; + } + try { + if (response.code() == 401) { + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can fetch a list of all newsfeeds + */ + public CompletableFuture> list() { + return list(null); + } + + /** + * You can fetch a list of all newsfeeds + */ + public CompletableFuture> list(RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("news/newsfeeds") + .build(); + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, PaginatedResponse.class), + response)); + return; + } + try { + if (response.code() == 401) { + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can fetch the details of a single newsfeed + */ + public CompletableFuture> find(FindNewsFeedRequest request) { + return find(request, null); + } + + /** + * You can fetch the details of a single newsfeed + */ + public CompletableFuture> find( + FindNewsFeedRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("news/newsfeeds") + .addPathSegment(request.getNewsfeedId()) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Newsfeed.class), response)); + return; + } + try { + if (response.code() == 401) { + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } +} diff --git a/src/main/java/com/intercom/api/resources/news/feeds/FeedsClient.java b/src/main/java/com/intercom/api/resources/news/feeds/FeedsClient.java new file mode 100644 index 00000000..9de07532 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/news/feeds/FeedsClient.java @@ -0,0 +1,71 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.news.feeds; + +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.resources.news.feeds.requests.FindNewsFeedRequest; +import com.intercom.api.resources.news.feeds.requests.ListNewsFeedItemsRequest; +import com.intercom.api.resources.news.types.Newsfeed; +import com.intercom.api.types.PaginatedResponse; + +public class FeedsClient { + protected final ClientOptions clientOptions; + + private final RawFeedsClient rawClient; + + public FeedsClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + this.rawClient = new RawFeedsClient(clientOptions); + } + + /** + * Get responses with HTTP metadata like headers + */ + public RawFeedsClient withRawResponse() { + return this.rawClient; + } + + /** + * You can fetch a list of all news items that are live on a given newsfeed + */ + public PaginatedResponse listItems(ListNewsFeedItemsRequest request) { + return this.rawClient.listItems(request).body(); + } + + /** + * You can fetch a list of all news items that are live on a given newsfeed + */ + public PaginatedResponse listItems(ListNewsFeedItemsRequest request, RequestOptions requestOptions) { + return this.rawClient.listItems(request, requestOptions).body(); + } + + /** + * You can fetch a list of all newsfeeds + */ + public PaginatedResponse list() { + return this.rawClient.list().body(); + } + + /** + * You can fetch a list of all newsfeeds + */ + public PaginatedResponse list(RequestOptions requestOptions) { + return this.rawClient.list(requestOptions).body(); + } + + /** + * You can fetch the details of a single newsfeed + */ + public Newsfeed find(FindNewsFeedRequest request) { + return this.rawClient.find(request).body(); + } + + /** + * You can fetch the details of a single newsfeed + */ + public Newsfeed find(FindNewsFeedRequest request, RequestOptions requestOptions) { + return this.rawClient.find(request, requestOptions).body(); + } +} diff --git a/src/main/java/com/intercom/api/resources/news/feeds/RawFeedsClient.java b/src/main/java/com/intercom/api/resources/news/feeds/RawFeedsClient.java new file mode 100644 index 00000000..c908a523 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/news/feeds/RawFeedsClient.java @@ -0,0 +1,181 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.news.feeds; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.IntercomApiException; +import com.intercom.api.core.IntercomException; +import com.intercom.api.core.IntercomHttpResponse; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.errors.UnauthorizedError; +import com.intercom.api.resources.news.feeds.requests.FindNewsFeedRequest; +import com.intercom.api.resources.news.feeds.requests.ListNewsFeedItemsRequest; +import com.intercom.api.resources.news.types.Newsfeed; +import com.intercom.api.types.Error; +import com.intercom.api.types.PaginatedResponse; +import java.io.IOException; +import okhttp3.Headers; +import okhttp3.HttpUrl; +import okhttp3.OkHttpClient; +import okhttp3.Request; +import okhttp3.Response; +import okhttp3.ResponseBody; + +public class RawFeedsClient { + protected final ClientOptions clientOptions; + + public RawFeedsClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + } + + /** + * You can fetch a list of all news items that are live on a given newsfeed + */ + public IntercomHttpResponse listItems(ListNewsFeedItemsRequest request) { + return listItems(request, null); + } + + /** + * You can fetch a list of all news items that are live on a given newsfeed + */ + public IntercomHttpResponse listItems( + ListNewsFeedItemsRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("news/newsfeeds") + .addPathSegment(request.getNewsfeedId()) + .addPathSegments("items") + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, PaginatedResponse.class), response); + } + try { + if (response.code() == 401) { + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can fetch a list of all newsfeeds + */ + public IntercomHttpResponse list() { + return list(null); + } + + /** + * You can fetch a list of all newsfeeds + */ + public IntercomHttpResponse list(RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("news/newsfeeds") + .build(); + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, PaginatedResponse.class), response); + } + try { + if (response.code() == 401) { + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can fetch the details of a single newsfeed + */ + public IntercomHttpResponse find(FindNewsFeedRequest request) { + return find(request, null); + } + + /** + * You can fetch the details of a single newsfeed + */ + public IntercomHttpResponse find(FindNewsFeedRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("news/newsfeeds") + .addPathSegment(request.getNewsfeedId()) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Newsfeed.class), response); + } + try { + if (response.code() == 401) { + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/news/feeds/requests/FindNewsFeedRequest.java b/src/main/java/com/intercom/api/resources/news/feeds/requests/FindNewsFeedRequest.java new file mode 100644 index 00000000..36c7f2b2 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/news/feeds/requests/FindNewsFeedRequest.java @@ -0,0 +1,113 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.news.feeds.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = FindNewsFeedRequest.Builder.class) +public final class FindNewsFeedRequest { + private final String newsfeedId; + + private final Map additionalProperties; + + private FindNewsFeedRequest(String newsfeedId, Map additionalProperties) { + this.newsfeedId = newsfeedId; + this.additionalProperties = additionalProperties; + } + + /** + * @return The unique identifier for the news feed item which is given by Intercom. + */ + @JsonProperty("newsfeed_id") + public String getNewsfeedId() { + return newsfeedId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof FindNewsFeedRequest && equalTo((FindNewsFeedRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(FindNewsFeedRequest other) { + return newsfeedId.equals(other.newsfeedId); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.newsfeedId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static NewsfeedIdStage builder() { + return new Builder(); + } + + public interface NewsfeedIdStage { + /** + *

The unique identifier for the news feed item which is given by Intercom.

+ */ + _FinalStage newsfeedId(@NotNull String newsfeedId); + + Builder from(FindNewsFeedRequest other); + } + + public interface _FinalStage { + FindNewsFeedRequest build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements NewsfeedIdStage, _FinalStage { + private String newsfeedId; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(FindNewsFeedRequest other) { + newsfeedId(other.getNewsfeedId()); + return this; + } + + /** + *

The unique identifier for the news feed item which is given by Intercom.

+ *

The unique identifier for the news feed item which is given by Intercom.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("newsfeed_id") + public _FinalStage newsfeedId(@NotNull String newsfeedId) { + this.newsfeedId = Objects.requireNonNull(newsfeedId, "newsfeedId must not be null"); + return this; + } + + @java.lang.Override + public FindNewsFeedRequest build() { + return new FindNewsFeedRequest(newsfeedId, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/news/feeds/requests/ListNewsFeedItemsRequest.java b/src/main/java/com/intercom/api/resources/news/feeds/requests/ListNewsFeedItemsRequest.java new file mode 100644 index 00000000..9e5e5828 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/news/feeds/requests/ListNewsFeedItemsRequest.java @@ -0,0 +1,113 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.news.feeds.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = ListNewsFeedItemsRequest.Builder.class) +public final class ListNewsFeedItemsRequest { + private final String newsfeedId; + + private final Map additionalProperties; + + private ListNewsFeedItemsRequest(String newsfeedId, Map additionalProperties) { + this.newsfeedId = newsfeedId; + this.additionalProperties = additionalProperties; + } + + /** + * @return The unique identifier for the news feed item which is given by Intercom. + */ + @JsonProperty("newsfeed_id") + public String getNewsfeedId() { + return newsfeedId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof ListNewsFeedItemsRequest && equalTo((ListNewsFeedItemsRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(ListNewsFeedItemsRequest other) { + return newsfeedId.equals(other.newsfeedId); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.newsfeedId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static NewsfeedIdStage builder() { + return new Builder(); + } + + public interface NewsfeedIdStage { + /** + *

The unique identifier for the news feed item which is given by Intercom.

+ */ + _FinalStage newsfeedId(@NotNull String newsfeedId); + + Builder from(ListNewsFeedItemsRequest other); + } + + public interface _FinalStage { + ListNewsFeedItemsRequest build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements NewsfeedIdStage, _FinalStage { + private String newsfeedId; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(ListNewsFeedItemsRequest other) { + newsfeedId(other.getNewsfeedId()); + return this; + } + + /** + *

The unique identifier for the news feed item which is given by Intercom.

+ *

The unique identifier for the news feed item which is given by Intercom.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("newsfeed_id") + public _FinalStage newsfeedId(@NotNull String newsfeedId) { + this.newsfeedId = Objects.requireNonNull(newsfeedId, "newsfeedId must not be null"); + return this; + } + + @java.lang.Override + public ListNewsFeedItemsRequest build() { + return new ListNewsFeedItemsRequest(newsfeedId, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/news/items/AsyncItemsClient.java b/src/main/java/com/intercom/api/resources/news/items/AsyncItemsClient.java new file mode 100644 index 00000000..f540d569 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/news/items/AsyncItemsClient.java @@ -0,0 +1,97 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.news.items; + +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.resources.news.items.requests.DeleteNewsItemRequest; +import com.intercom.api.resources.news.items.requests.FindNewsItemRequest; +import com.intercom.api.resources.news.items.requests.UpdateNewsItemRequest; +import com.intercom.api.resources.news.types.NewsItem; +import com.intercom.api.types.DeletedObject; +import com.intercom.api.types.NewsItemRequest; +import com.intercom.api.types.PaginatedResponse; +import java.util.concurrent.CompletableFuture; + +public class AsyncItemsClient { + protected final ClientOptions clientOptions; + + private final AsyncRawItemsClient rawClient; + + public AsyncItemsClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + this.rawClient = new AsyncRawItemsClient(clientOptions); + } + + /** + * Get responses with HTTP metadata like headers + */ + public AsyncRawItemsClient withRawResponse() { + return this.rawClient; + } + + /** + * You can fetch a list of all news items + */ + public CompletableFuture list() { + return this.rawClient.list().thenApply(response -> response.body()); + } + + /** + * You can fetch a list of all news items + */ + public CompletableFuture list(RequestOptions requestOptions) { + return this.rawClient.list(requestOptions).thenApply(response -> response.body()); + } + + /** + * You can create a news item + */ + public CompletableFuture create(NewsItemRequest request) { + return this.rawClient.create(request).thenApply(response -> response.body()); + } + + /** + * You can create a news item + */ + public CompletableFuture create(NewsItemRequest request, RequestOptions requestOptions) { + return this.rawClient.create(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can fetch the details of a single news item. + */ + public CompletableFuture find(FindNewsItemRequest request) { + return this.rawClient.find(request).thenApply(response -> response.body()); + } + + /** + * You can fetch the details of a single news item. + */ + public CompletableFuture find(FindNewsItemRequest request, RequestOptions requestOptions) { + return this.rawClient.find(request, requestOptions).thenApply(response -> response.body()); + } + + public CompletableFuture update(UpdateNewsItemRequest request) { + return this.rawClient.update(request).thenApply(response -> response.body()); + } + + public CompletableFuture update(UpdateNewsItemRequest request, RequestOptions requestOptions) { + return this.rawClient.update(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can delete a single news item. + */ + public CompletableFuture delete(DeleteNewsItemRequest request) { + return this.rawClient.delete(request).thenApply(response -> response.body()); + } + + /** + * You can delete a single news item. + */ + public CompletableFuture delete(DeleteNewsItemRequest request, RequestOptions requestOptions) { + return this.rawClient.delete(request, requestOptions).thenApply(response -> response.body()); + } +} diff --git a/src/main/java/com/intercom/api/resources/news/items/AsyncRawItemsClient.java b/src/main/java/com/intercom/api/resources/news/items/AsyncRawItemsClient.java new file mode 100644 index 00000000..7a94590f --- /dev/null +++ b/src/main/java/com/intercom/api/resources/news/items/AsyncRawItemsClient.java @@ -0,0 +1,393 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.news.items; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.IntercomApiException; +import com.intercom.api.core.IntercomException; +import com.intercom.api.core.IntercomHttpResponse; +import com.intercom.api.core.MediaTypes; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.errors.NotFoundError; +import com.intercom.api.errors.UnauthorizedError; +import com.intercom.api.resources.news.items.requests.DeleteNewsItemRequest; +import com.intercom.api.resources.news.items.requests.FindNewsItemRequest; +import com.intercom.api.resources.news.items.requests.UpdateNewsItemRequest; +import com.intercom.api.resources.news.types.NewsItem; +import com.intercom.api.types.DeletedObject; +import com.intercom.api.types.Error; +import com.intercom.api.types.NewsItemRequest; +import com.intercom.api.types.PaginatedResponse; +import java.io.IOException; +import java.util.concurrent.CompletableFuture; +import okhttp3.Call; +import okhttp3.Callback; +import okhttp3.Headers; +import okhttp3.HttpUrl; +import okhttp3.OkHttpClient; +import okhttp3.Request; +import okhttp3.RequestBody; +import okhttp3.Response; +import okhttp3.ResponseBody; +import org.jetbrains.annotations.NotNull; + +public class AsyncRawItemsClient { + protected final ClientOptions clientOptions; + + public AsyncRawItemsClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + } + + /** + * You can fetch a list of all news items + */ + public CompletableFuture> list() { + return list(null); + } + + /** + * You can fetch a list of all news items + */ + public CompletableFuture> list(RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("news/news_items") + .build(); + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, PaginatedResponse.class), + response)); + return; + } + try { + if (response.code() == 401) { + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can create a news item + */ + public CompletableFuture> create(NewsItemRequest request) { + return create(request, null); + } + + /** + * You can create a news item + */ + public CompletableFuture> create( + NewsItemRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("news/news_items") + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, NewsItem.class), response)); + return; + } + try { + if (response.code() == 401) { + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can fetch the details of a single news item. + */ + public CompletableFuture> find(FindNewsItemRequest request) { + return find(request, null); + } + + /** + * You can fetch the details of a single news item. + */ + public CompletableFuture> find( + FindNewsItemRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("news/news_items") + .addPathSegment(Integer.toString(request.getNewsItemId())) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, NewsItem.class), response)); + return; + } + try { + switch (response.code()) { + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 404: + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + public CompletableFuture> update(UpdateNewsItemRequest request) { + return update(request, null); + } + + public CompletableFuture> update( + UpdateNewsItemRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("news/news_items") + .addPathSegment(Integer.toString(request.getNewsItemId())) + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request.getBody()), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("PUT", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, NewsItem.class), response)); + return; + } + try { + switch (response.code()) { + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 404: + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can delete a single news item. + */ + public CompletableFuture> delete(DeleteNewsItemRequest request) { + return delete(request, null); + } + + /** + * You can delete a single news item. + */ + public CompletableFuture> delete( + DeleteNewsItemRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("news/news_items") + .addPathSegment(Integer.toString(request.getNewsItemId())) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("DELETE", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, DeletedObject.class), + response)); + return; + } + try { + switch (response.code()) { + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 404: + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } +} diff --git a/src/main/java/com/intercom/api/resources/news/items/ItemsClient.java b/src/main/java/com/intercom/api/resources/news/items/ItemsClient.java new file mode 100644 index 00000000..cd7caa8a --- /dev/null +++ b/src/main/java/com/intercom/api/resources/news/items/ItemsClient.java @@ -0,0 +1,96 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.news.items; + +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.resources.news.items.requests.DeleteNewsItemRequest; +import com.intercom.api.resources.news.items.requests.FindNewsItemRequest; +import com.intercom.api.resources.news.items.requests.UpdateNewsItemRequest; +import com.intercom.api.resources.news.types.NewsItem; +import com.intercom.api.types.DeletedObject; +import com.intercom.api.types.NewsItemRequest; +import com.intercom.api.types.PaginatedResponse; + +public class ItemsClient { + protected final ClientOptions clientOptions; + + private final RawItemsClient rawClient; + + public ItemsClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + this.rawClient = new RawItemsClient(clientOptions); + } + + /** + * Get responses with HTTP metadata like headers + */ + public RawItemsClient withRawResponse() { + return this.rawClient; + } + + /** + * You can fetch a list of all news items + */ + public PaginatedResponse list() { + return this.rawClient.list().body(); + } + + /** + * You can fetch a list of all news items + */ + public PaginatedResponse list(RequestOptions requestOptions) { + return this.rawClient.list(requestOptions).body(); + } + + /** + * You can create a news item + */ + public NewsItem create(NewsItemRequest request) { + return this.rawClient.create(request).body(); + } + + /** + * You can create a news item + */ + public NewsItem create(NewsItemRequest request, RequestOptions requestOptions) { + return this.rawClient.create(request, requestOptions).body(); + } + + /** + * You can fetch the details of a single news item. + */ + public NewsItem find(FindNewsItemRequest request) { + return this.rawClient.find(request).body(); + } + + /** + * You can fetch the details of a single news item. + */ + public NewsItem find(FindNewsItemRequest request, RequestOptions requestOptions) { + return this.rawClient.find(request, requestOptions).body(); + } + + public NewsItem update(UpdateNewsItemRequest request) { + return this.rawClient.update(request).body(); + } + + public NewsItem update(UpdateNewsItemRequest request, RequestOptions requestOptions) { + return this.rawClient.update(request, requestOptions).body(); + } + + /** + * You can delete a single news item. + */ + public DeletedObject delete(DeleteNewsItemRequest request) { + return this.rawClient.delete(request).body(); + } + + /** + * You can delete a single news item. + */ + public DeletedObject delete(DeleteNewsItemRequest request, RequestOptions requestOptions) { + return this.rawClient.delete(request, requestOptions).body(); + } +} diff --git a/src/main/java/com/intercom/api/resources/news/items/RawItemsClient.java b/src/main/java/com/intercom/api/resources/news/items/RawItemsClient.java new file mode 100644 index 00000000..3c01a529 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/news/items/RawItemsClient.java @@ -0,0 +1,304 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.news.items; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.IntercomApiException; +import com.intercom.api.core.IntercomException; +import com.intercom.api.core.IntercomHttpResponse; +import com.intercom.api.core.MediaTypes; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.errors.NotFoundError; +import com.intercom.api.errors.UnauthorizedError; +import com.intercom.api.resources.news.items.requests.DeleteNewsItemRequest; +import com.intercom.api.resources.news.items.requests.FindNewsItemRequest; +import com.intercom.api.resources.news.items.requests.UpdateNewsItemRequest; +import com.intercom.api.resources.news.types.NewsItem; +import com.intercom.api.types.DeletedObject; +import com.intercom.api.types.Error; +import com.intercom.api.types.NewsItemRequest; +import com.intercom.api.types.PaginatedResponse; +import java.io.IOException; +import okhttp3.Headers; +import okhttp3.HttpUrl; +import okhttp3.OkHttpClient; +import okhttp3.Request; +import okhttp3.RequestBody; +import okhttp3.Response; +import okhttp3.ResponseBody; + +public class RawItemsClient { + protected final ClientOptions clientOptions; + + public RawItemsClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + } + + /** + * You can fetch a list of all news items + */ + public IntercomHttpResponse list() { + return list(null); + } + + /** + * You can fetch a list of all news items + */ + public IntercomHttpResponse list(RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("news/news_items") + .build(); + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, PaginatedResponse.class), response); + } + try { + if (response.code() == 401) { + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can create a news item + */ + public IntercomHttpResponse create(NewsItemRequest request) { + return create(request, null); + } + + /** + * You can create a news item + */ + public IntercomHttpResponse create(NewsItemRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("news/news_items") + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, NewsItem.class), response); + } + try { + if (response.code() == 401) { + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can fetch the details of a single news item. + */ + public IntercomHttpResponse find(FindNewsItemRequest request) { + return find(request, null); + } + + /** + * You can fetch the details of a single news item. + */ + public IntercomHttpResponse find(FindNewsItemRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("news/news_items") + .addPathSegment(Integer.toString(request.getNewsItemId())) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, NewsItem.class), response); + } + try { + switch (response.code()) { + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 404: + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + public IntercomHttpResponse update(UpdateNewsItemRequest request) { + return update(request, null); + } + + public IntercomHttpResponse update(UpdateNewsItemRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("news/news_items") + .addPathSegment(Integer.toString(request.getNewsItemId())) + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request.getBody()), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("PUT", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, NewsItem.class), response); + } + try { + switch (response.code()) { + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 404: + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can delete a single news item. + */ + public IntercomHttpResponse delete(DeleteNewsItemRequest request) { + return delete(request, null); + } + + /** + * You can delete a single news item. + */ + public IntercomHttpResponse delete(DeleteNewsItemRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("news/news_items") + .addPathSegment(Integer.toString(request.getNewsItemId())) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("DELETE", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, DeletedObject.class), response); + } + try { + switch (response.code()) { + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 404: + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/news/items/requests/DeleteNewsItemRequest.java b/src/main/java/com/intercom/api/resources/news/items/requests/DeleteNewsItemRequest.java new file mode 100644 index 00000000..03a9d08f --- /dev/null +++ b/src/main/java/com/intercom/api/resources/news/items/requests/DeleteNewsItemRequest.java @@ -0,0 +1,112 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.news.items.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = DeleteNewsItemRequest.Builder.class) +public final class DeleteNewsItemRequest { + private final int newsItemId; + + private final Map additionalProperties; + + private DeleteNewsItemRequest(int newsItemId, Map additionalProperties) { + this.newsItemId = newsItemId; + this.additionalProperties = additionalProperties; + } + + /** + * @return The unique identifier for the news item which is given by Intercom. + */ + @JsonProperty("news_item_id") + public int getNewsItemId() { + return newsItemId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof DeleteNewsItemRequest && equalTo((DeleteNewsItemRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(DeleteNewsItemRequest other) { + return newsItemId == other.newsItemId; + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.newsItemId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static NewsItemIdStage builder() { + return new Builder(); + } + + public interface NewsItemIdStage { + /** + *

The unique identifier for the news item which is given by Intercom.

+ */ + _FinalStage newsItemId(int newsItemId); + + Builder from(DeleteNewsItemRequest other); + } + + public interface _FinalStage { + DeleteNewsItemRequest build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements NewsItemIdStage, _FinalStage { + private int newsItemId; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(DeleteNewsItemRequest other) { + newsItemId(other.getNewsItemId()); + return this; + } + + /** + *

The unique identifier for the news item which is given by Intercom.

+ *

The unique identifier for the news item which is given by Intercom.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("news_item_id") + public _FinalStage newsItemId(int newsItemId) { + this.newsItemId = newsItemId; + return this; + } + + @java.lang.Override + public DeleteNewsItemRequest build() { + return new DeleteNewsItemRequest(newsItemId, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/news/items/requests/FindNewsItemRequest.java b/src/main/java/com/intercom/api/resources/news/items/requests/FindNewsItemRequest.java new file mode 100644 index 00000000..da37fba1 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/news/items/requests/FindNewsItemRequest.java @@ -0,0 +1,112 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.news.items.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = FindNewsItemRequest.Builder.class) +public final class FindNewsItemRequest { + private final int newsItemId; + + private final Map additionalProperties; + + private FindNewsItemRequest(int newsItemId, Map additionalProperties) { + this.newsItemId = newsItemId; + this.additionalProperties = additionalProperties; + } + + /** + * @return The unique identifier for the news item which is given by Intercom. + */ + @JsonProperty("news_item_id") + public int getNewsItemId() { + return newsItemId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof FindNewsItemRequest && equalTo((FindNewsItemRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(FindNewsItemRequest other) { + return newsItemId == other.newsItemId; + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.newsItemId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static NewsItemIdStage builder() { + return new Builder(); + } + + public interface NewsItemIdStage { + /** + *

The unique identifier for the news item which is given by Intercom.

+ */ + _FinalStage newsItemId(int newsItemId); + + Builder from(FindNewsItemRequest other); + } + + public interface _FinalStage { + FindNewsItemRequest build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements NewsItemIdStage, _FinalStage { + private int newsItemId; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(FindNewsItemRequest other) { + newsItemId(other.getNewsItemId()); + return this; + } + + /** + *

The unique identifier for the news item which is given by Intercom.

+ *

The unique identifier for the news item which is given by Intercom.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("news_item_id") + public _FinalStage newsItemId(int newsItemId) { + this.newsItemId = newsItemId; + return this; + } + + @java.lang.Override + public FindNewsItemRequest build() { + return new FindNewsItemRequest(newsItemId, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/news/items/requests/UpdateNewsItemRequest.java b/src/main/java/com/intercom/api/resources/news/items/requests/UpdateNewsItemRequest.java new file mode 100644 index 00000000..1de6528e --- /dev/null +++ b/src/main/java/com/intercom/api/resources/news/items/requests/UpdateNewsItemRequest.java @@ -0,0 +1,136 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.news.items.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.types.NewsItemRequest; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = UpdateNewsItemRequest.Builder.class) +public final class UpdateNewsItemRequest { + private final int newsItemId; + + private final NewsItemRequest body; + + private final Map additionalProperties; + + private UpdateNewsItemRequest(int newsItemId, NewsItemRequest body, Map additionalProperties) { + this.newsItemId = newsItemId; + this.body = body; + this.additionalProperties = additionalProperties; + } + + /** + * @return The unique identifier for the news item which is given by Intercom. + */ + @JsonProperty("news_item_id") + public int getNewsItemId() { + return newsItemId; + } + + @JsonProperty("body") + public NewsItemRequest getBody() { + return body; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof UpdateNewsItemRequest && equalTo((UpdateNewsItemRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(UpdateNewsItemRequest other) { + return newsItemId == other.newsItemId && body.equals(other.body); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.newsItemId, this.body); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static NewsItemIdStage builder() { + return new Builder(); + } + + public interface NewsItemIdStage { + /** + *

The unique identifier for the news item which is given by Intercom.

+ */ + BodyStage newsItemId(int newsItemId); + + Builder from(UpdateNewsItemRequest other); + } + + public interface BodyStage { + _FinalStage body(@NotNull NewsItemRequest body); + } + + public interface _FinalStage { + UpdateNewsItemRequest build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements NewsItemIdStage, BodyStage, _FinalStage { + private int newsItemId; + + private NewsItemRequest body; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(UpdateNewsItemRequest other) { + newsItemId(other.getNewsItemId()); + body(other.getBody()); + return this; + } + + /** + *

The unique identifier for the news item which is given by Intercom.

+ *

The unique identifier for the news item which is given by Intercom.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("news_item_id") + public BodyStage newsItemId(int newsItemId) { + this.newsItemId = newsItemId; + return this; + } + + @java.lang.Override + @JsonSetter("body") + public _FinalStage body(@NotNull NewsItemRequest body) { + this.body = Objects.requireNonNull(body, "body must not be null"); + return this; + } + + @java.lang.Override + public UpdateNewsItemRequest build() { + return new UpdateNewsItemRequest(newsItemId, body, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/news/types/NewsItem.java b/src/main/java/com/intercom/api/resources/news/types/NewsItem.java new file mode 100644 index 00000000..73c55556 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/news/types/NewsItem.java @@ -0,0 +1,707 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.news.types; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.JsonValue; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = NewsItem.Builder.class) +public final class NewsItem { + private final String id; + + private final String workspaceId; + + private final String title; + + private final Optional body; + + private final Optional senderId; + + private final State state; + + private final Optional> newsfeedAssignments; + + private final Optional>> labels; + + private final Optional coverImageUrl; + + private final Optional>> reactions; + + private final Optional deliverSilently; + + private final int createdAt; + + private final int updatedAt; + + private final Map additionalProperties; + + private NewsItem( + String id, + String workspaceId, + String title, + Optional body, + Optional senderId, + State state, + Optional> newsfeedAssignments, + Optional>> labels, + Optional coverImageUrl, + Optional>> reactions, + Optional deliverSilently, + int createdAt, + int updatedAt, + Map additionalProperties) { + this.id = id; + this.workspaceId = workspaceId; + this.title = title; + this.body = body; + this.senderId = senderId; + this.state = state; + this.newsfeedAssignments = newsfeedAssignments; + this.labels = labels; + this.coverImageUrl = coverImageUrl; + this.reactions = reactions; + this.deliverSilently = deliverSilently; + this.createdAt = createdAt; + this.updatedAt = updatedAt; + this.additionalProperties = additionalProperties; + } + + /** + * @return The type of object. + */ + @JsonProperty("type") + public String getType() { + return "news-item"; + } + + /** + * @return The unique identifier for the news item which is given by Intercom. + */ + @JsonProperty("id") + public String getId() { + return id; + } + + /** + * @return The id of the workspace which the news item belongs to. + */ + @JsonProperty("workspace_id") + public String getWorkspaceId() { + return workspaceId; + } + + /** + * @return The title of the news item. + */ + @JsonProperty("title") + public String getTitle() { + return title; + } + + /** + * @return The news item body, which may contain HTML. + */ + @JsonProperty("body") + public Optional getBody() { + return body; + } + + /** + * @return The id of the sender of the news item. Must be a teammate on the workspace. + */ + @JsonProperty("sender_id") + public Optional getSenderId() { + return senderId; + } + + /** + * @return News items will not be visible to your users in the assigned newsfeeds until they are set live. + */ + @JsonProperty("state") + public State getState() { + return state; + } + + /** + * @return A list of newsfeed_assignments to assign to the specified newsfeed. + */ + @JsonProperty("newsfeed_assignments") + public Optional> getNewsfeedAssignments() { + return newsfeedAssignments; + } + + /** + * @return Label names displayed to users to categorize the news item. + */ + @JsonProperty("labels") + public Optional>> getLabels() { + return labels; + } + + /** + * @return URL of the image used as cover. Must have .jpg or .png extension. + */ + @JsonProperty("cover_image_url") + public Optional getCoverImageUrl() { + return coverImageUrl; + } + + /** + * @return Ordered list of emoji reactions to the news item. When empty, reactions are disabled. + */ + @JsonProperty("reactions") + public Optional>> getReactions() { + return reactions; + } + + /** + * @return When set to true, the news item will appear in the messenger newsfeed without showing a notification badge. + */ + @JsonProperty("deliver_silently") + public Optional getDeliverSilently() { + return deliverSilently; + } + + /** + * @return Timestamp for when the news item was created. + */ + @JsonProperty("created_at") + public int getCreatedAt() { + return createdAt; + } + + /** + * @return Timestamp for when the news item was last updated. + */ + @JsonProperty("updated_at") + public int getUpdatedAt() { + return updatedAt; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof NewsItem && equalTo((NewsItem) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(NewsItem other) { + return id.equals(other.id) + && workspaceId.equals(other.workspaceId) + && title.equals(other.title) + && body.equals(other.body) + && senderId.equals(other.senderId) + && state.equals(other.state) + && newsfeedAssignments.equals(other.newsfeedAssignments) + && labels.equals(other.labels) + && coverImageUrl.equals(other.coverImageUrl) + && reactions.equals(other.reactions) + && deliverSilently.equals(other.deliverSilently) + && createdAt == other.createdAt + && updatedAt == other.updatedAt; + } + + @java.lang.Override + public int hashCode() { + return Objects.hash( + this.id, + this.workspaceId, + this.title, + this.body, + this.senderId, + this.state, + this.newsfeedAssignments, + this.labels, + this.coverImageUrl, + this.reactions, + this.deliverSilently, + this.createdAt, + this.updatedAt); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static IdStage builder() { + return new Builder(); + } + + public interface IdStage { + /** + *

The unique identifier for the news item which is given by Intercom.

+ */ + WorkspaceIdStage id(@NotNull String id); + + Builder from(NewsItem other); + } + + public interface WorkspaceIdStage { + /** + *

The id of the workspace which the news item belongs to.

+ */ + TitleStage workspaceId(@NotNull String workspaceId); + } + + public interface TitleStage { + /** + *

The title of the news item.

+ */ + StateStage title(@NotNull String title); + } + + public interface StateStage { + /** + *

News items will not be visible to your users in the assigned newsfeeds until they are set live.

+ */ + CreatedAtStage state(@NotNull State state); + } + + public interface CreatedAtStage { + /** + *

Timestamp for when the news item was created.

+ */ + UpdatedAtStage createdAt(int createdAt); + } + + public interface UpdatedAtStage { + /** + *

Timestamp for when the news item was last updated.

+ */ + _FinalStage updatedAt(int updatedAt); + } + + public interface _FinalStage { + NewsItem build(); + + /** + *

The news item body, which may contain HTML.

+ */ + _FinalStage body(Optional body); + + _FinalStage body(String body); + + /** + *

The id of the sender of the news item. Must be a teammate on the workspace.

+ */ + _FinalStage senderId(Optional senderId); + + _FinalStage senderId(Integer senderId); + + /** + *

A list of newsfeed_assignments to assign to the specified newsfeed.

+ */ + _FinalStage newsfeedAssignments(Optional> newsfeedAssignments); + + _FinalStage newsfeedAssignments(List newsfeedAssignments); + + /** + *

Label names displayed to users to categorize the news item.

+ */ + _FinalStage labels(Optional>> labels); + + _FinalStage labels(List> labels); + + /** + *

URL of the image used as cover. Must have .jpg or .png extension.

+ */ + _FinalStage coverImageUrl(Optional coverImageUrl); + + _FinalStage coverImageUrl(String coverImageUrl); + + /** + *

Ordered list of emoji reactions to the news item. When empty, reactions are disabled.

+ */ + _FinalStage reactions(Optional>> reactions); + + _FinalStage reactions(List> reactions); + + /** + *

When set to true, the news item will appear in the messenger newsfeed without showing a notification badge.

+ */ + _FinalStage deliverSilently(Optional deliverSilently); + + _FinalStage deliverSilently(Boolean deliverSilently); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder + implements IdStage, WorkspaceIdStage, TitleStage, StateStage, CreatedAtStage, UpdatedAtStage, _FinalStage { + private String id; + + private String workspaceId; + + private String title; + + private State state; + + private int createdAt; + + private int updatedAt; + + private Optional deliverSilently = Optional.empty(); + + private Optional>> reactions = Optional.empty(); + + private Optional coverImageUrl = Optional.empty(); + + private Optional>> labels = Optional.empty(); + + private Optional> newsfeedAssignments = Optional.empty(); + + private Optional senderId = Optional.empty(); + + private Optional body = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(NewsItem other) { + id(other.getId()); + workspaceId(other.getWorkspaceId()); + title(other.getTitle()); + body(other.getBody()); + senderId(other.getSenderId()); + state(other.getState()); + newsfeedAssignments(other.getNewsfeedAssignments()); + labels(other.getLabels()); + coverImageUrl(other.getCoverImageUrl()); + reactions(other.getReactions()); + deliverSilently(other.getDeliverSilently()); + createdAt(other.getCreatedAt()); + updatedAt(other.getUpdatedAt()); + return this; + } + + /** + *

The unique identifier for the news item which is given by Intercom.

+ *

The unique identifier for the news item which is given by Intercom.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("id") + public WorkspaceIdStage id(@NotNull String id) { + this.id = Objects.requireNonNull(id, "id must not be null"); + return this; + } + + /** + *

The id of the workspace which the news item belongs to.

+ *

The id of the workspace which the news item belongs to.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("workspace_id") + public TitleStage workspaceId(@NotNull String workspaceId) { + this.workspaceId = Objects.requireNonNull(workspaceId, "workspaceId must not be null"); + return this; + } + + /** + *

The title of the news item.

+ *

The title of the news item.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("title") + public StateStage title(@NotNull String title) { + this.title = Objects.requireNonNull(title, "title must not be null"); + return this; + } + + /** + *

News items will not be visible to your users in the assigned newsfeeds until they are set live.

+ *

News items will not be visible to your users in the assigned newsfeeds until they are set live.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("state") + public CreatedAtStage state(@NotNull State state) { + this.state = Objects.requireNonNull(state, "state must not be null"); + return this; + } + + /** + *

Timestamp for when the news item was created.

+ *

Timestamp for when the news item was created.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("created_at") + public UpdatedAtStage createdAt(int createdAt) { + this.createdAt = createdAt; + return this; + } + + /** + *

Timestamp for when the news item was last updated.

+ *

Timestamp for when the news item was last updated.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("updated_at") + public _FinalStage updatedAt(int updatedAt) { + this.updatedAt = updatedAt; + return this; + } + + /** + *

When set to true, the news item will appear in the messenger newsfeed without showing a notification badge.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage deliverSilently(Boolean deliverSilently) { + this.deliverSilently = Optional.ofNullable(deliverSilently); + return this; + } + + /** + *

When set to true, the news item will appear in the messenger newsfeed without showing a notification badge.

+ */ + @java.lang.Override + @JsonSetter(value = "deliver_silently", nulls = Nulls.SKIP) + public _FinalStage deliverSilently(Optional deliverSilently) { + this.deliverSilently = deliverSilently; + return this; + } + + /** + *

Ordered list of emoji reactions to the news item. When empty, reactions are disabled.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage reactions(List> reactions) { + this.reactions = Optional.ofNullable(reactions); + return this; + } + + /** + *

Ordered list of emoji reactions to the news item. When empty, reactions are disabled.

+ */ + @java.lang.Override + @JsonSetter(value = "reactions", nulls = Nulls.SKIP) + public _FinalStage reactions(Optional>> reactions) { + this.reactions = reactions; + return this; + } + + /** + *

URL of the image used as cover. Must have .jpg or .png extension.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage coverImageUrl(String coverImageUrl) { + this.coverImageUrl = Optional.ofNullable(coverImageUrl); + return this; + } + + /** + *

URL of the image used as cover. Must have .jpg or .png extension.

+ */ + @java.lang.Override + @JsonSetter(value = "cover_image_url", nulls = Nulls.SKIP) + public _FinalStage coverImageUrl(Optional coverImageUrl) { + this.coverImageUrl = coverImageUrl; + return this; + } + + /** + *

Label names displayed to users to categorize the news item.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage labels(List> labels) { + this.labels = Optional.ofNullable(labels); + return this; + } + + /** + *

Label names displayed to users to categorize the news item.

+ */ + @java.lang.Override + @JsonSetter(value = "labels", nulls = Nulls.SKIP) + public _FinalStage labels(Optional>> labels) { + this.labels = labels; + return this; + } + + /** + *

A list of newsfeed_assignments to assign to the specified newsfeed.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage newsfeedAssignments(List newsfeedAssignments) { + this.newsfeedAssignments = Optional.ofNullable(newsfeedAssignments); + return this; + } + + /** + *

A list of newsfeed_assignments to assign to the specified newsfeed.

+ */ + @java.lang.Override + @JsonSetter(value = "newsfeed_assignments", nulls = Nulls.SKIP) + public _FinalStage newsfeedAssignments(Optional> newsfeedAssignments) { + this.newsfeedAssignments = newsfeedAssignments; + return this; + } + + /** + *

The id of the sender of the news item. Must be a teammate on the workspace.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage senderId(Integer senderId) { + this.senderId = Optional.ofNullable(senderId); + return this; + } + + /** + *

The id of the sender of the news item. Must be a teammate on the workspace.

+ */ + @java.lang.Override + @JsonSetter(value = "sender_id", nulls = Nulls.SKIP) + public _FinalStage senderId(Optional senderId) { + this.senderId = senderId; + return this; + } + + /** + *

The news item body, which may contain HTML.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage body(String body) { + this.body = Optional.ofNullable(body); + return this; + } + + /** + *

The news item body, which may contain HTML.

+ */ + @java.lang.Override + @JsonSetter(value = "body", nulls = Nulls.SKIP) + public _FinalStage body(Optional body) { + this.body = body; + return this; + } + + @java.lang.Override + public NewsItem build() { + return new NewsItem( + id, + workspaceId, + title, + body, + senderId, + state, + newsfeedAssignments, + labels, + coverImageUrl, + reactions, + deliverSilently, + createdAt, + updatedAt, + additionalProperties); + } + } + + public static final class State { + public static final State LIVE = new State(Value.LIVE, "live"); + + public static final State DRAFT = new State(Value.DRAFT, "draft"); + + private final Value value; + + private final String string; + + State(Value value, String string) { + this.value = value; + this.string = string; + } + + public Value getEnumValue() { + return value; + } + + @java.lang.Override + @JsonValue + public String toString() { + return this.string; + } + + @java.lang.Override + public boolean equals(Object other) { + return (this == other) || (other instanceof State && this.string.equals(((State) other).string)); + } + + @java.lang.Override + public int hashCode() { + return this.string.hashCode(); + } + + public T visit(Visitor visitor) { + switch (value) { + case LIVE: + return visitor.visitLive(); + case DRAFT: + return visitor.visitDraft(); + case UNKNOWN: + default: + return visitor.visitUnknown(string); + } + } + + @JsonCreator(mode = JsonCreator.Mode.DELEGATING) + public static State valueOf(String value) { + switch (value) { + case "live": + return LIVE; + case "draft": + return DRAFT; + default: + return new State(Value.UNKNOWN, value); + } + } + + public enum Value { + DRAFT, + + LIVE, + + UNKNOWN + } + + public interface Visitor { + T visitDraft(); + + T visitLive(); + + T visitUnknown(String unknownType); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/news/types/Newsfeed.java b/src/main/java/com/intercom/api/resources/news/types/Newsfeed.java new file mode 100644 index 00000000..96664ab5 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/news/types/Newsfeed.java @@ -0,0 +1,223 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.news.types; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = Newsfeed.Builder.class) +public final class Newsfeed { + private final String id; + + private final String name; + + private final int createdAt; + + private final int updatedAt; + + private final Map additionalProperties; + + private Newsfeed(String id, String name, int createdAt, int updatedAt, Map additionalProperties) { + this.id = id; + this.name = name; + this.createdAt = createdAt; + this.updatedAt = updatedAt; + this.additionalProperties = additionalProperties; + } + + /** + * @return The unique identifier for the newsfeed which is given by Intercom. + */ + @JsonProperty("id") + public String getId() { + return id; + } + + /** + * @return The type of object. + */ + @JsonProperty("type") + public String getType() { + return "newsfeed"; + } + + /** + * @return The name of the newsfeed. This name will never be visible to your users. + */ + @JsonProperty("name") + public String getName() { + return name; + } + + /** + * @return Timestamp for when the newsfeed was created. + */ + @JsonProperty("created_at") + public int getCreatedAt() { + return createdAt; + } + + /** + * @return Timestamp for when the newsfeed was last updated. + */ + @JsonProperty("updated_at") + public int getUpdatedAt() { + return updatedAt; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof Newsfeed && equalTo((Newsfeed) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(Newsfeed other) { + return id.equals(other.id) + && name.equals(other.name) + && createdAt == other.createdAt + && updatedAt == other.updatedAt; + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.id, this.name, this.createdAt, this.updatedAt); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static IdStage builder() { + return new Builder(); + } + + public interface IdStage { + /** + *

The unique identifier for the newsfeed which is given by Intercom.

+ */ + NameStage id(@NotNull String id); + + Builder from(Newsfeed other); + } + + public interface NameStage { + /** + *

The name of the newsfeed. This name will never be visible to your users.

+ */ + CreatedAtStage name(@NotNull String name); + } + + public interface CreatedAtStage { + /** + *

Timestamp for when the newsfeed was created.

+ */ + UpdatedAtStage createdAt(int createdAt); + } + + public interface UpdatedAtStage { + /** + *

Timestamp for when the newsfeed was last updated.

+ */ + _FinalStage updatedAt(int updatedAt); + } + + public interface _FinalStage { + Newsfeed build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements IdStage, NameStage, CreatedAtStage, UpdatedAtStage, _FinalStage { + private String id; + + private String name; + + private int createdAt; + + private int updatedAt; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(Newsfeed other) { + id(other.getId()); + name(other.getName()); + createdAt(other.getCreatedAt()); + updatedAt(other.getUpdatedAt()); + return this; + } + + /** + *

The unique identifier for the newsfeed which is given by Intercom.

+ *

The unique identifier for the newsfeed which is given by Intercom.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("id") + public NameStage id(@NotNull String id) { + this.id = Objects.requireNonNull(id, "id must not be null"); + return this; + } + + /** + *

The name of the newsfeed. This name will never be visible to your users.

+ *

The name of the newsfeed. This name will never be visible to your users.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("name") + public CreatedAtStage name(@NotNull String name) { + this.name = Objects.requireNonNull(name, "name must not be null"); + return this; + } + + /** + *

Timestamp for when the newsfeed was created.

+ *

Timestamp for when the newsfeed was created.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("created_at") + public UpdatedAtStage createdAt(int createdAt) { + this.createdAt = createdAt; + return this; + } + + /** + *

Timestamp for when the newsfeed was last updated.

+ *

Timestamp for when the newsfeed was last updated.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("updated_at") + public _FinalStage updatedAt(int updatedAt) { + this.updatedAt = updatedAt; + return this; + } + + @java.lang.Override + public Newsfeed build() { + return new Newsfeed(id, name, createdAt, updatedAt, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/news/types/NewsfeedAssignment.java b/src/main/java/com/intercom/api/resources/news/types/NewsfeedAssignment.java new file mode 100644 index 00000000..60c3b067 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/news/types/NewsfeedAssignment.java @@ -0,0 +1,156 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.news.types; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = NewsfeedAssignment.Builder.class) +public final class NewsfeedAssignment { + private final int newsfeedId; + + private final Optional publishedAt; + + private final Map additionalProperties; + + private NewsfeedAssignment( + int newsfeedId, Optional publishedAt, Map additionalProperties) { + this.newsfeedId = newsfeedId; + this.publishedAt = publishedAt; + this.additionalProperties = additionalProperties; + } + + /** + * @return The unique identifier for the newsfeed which is given by Intercom. Publish dates cannot be in the future, to schedule news items use the dedicated feature in app (see this article). + */ + @JsonProperty("newsfeed_id") + public int getNewsfeedId() { + return newsfeedId; + } + + /** + * @return Publish date of the news item on the newsfeed, use this field if you want to set a publish date in the past (e.g. when importing existing news items). On write, this field will be ignored if the news item state is "draft". + */ + @JsonProperty("published_at") + public Optional getPublishedAt() { + return publishedAt; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof NewsfeedAssignment && equalTo((NewsfeedAssignment) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(NewsfeedAssignment other) { + return newsfeedId == other.newsfeedId && publishedAt.equals(other.publishedAt); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.newsfeedId, this.publishedAt); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static NewsfeedIdStage builder() { + return new Builder(); + } + + public interface NewsfeedIdStage { + /** + *

The unique identifier for the newsfeed which is given by Intercom. Publish dates cannot be in the future, to schedule news items use the dedicated feature in app (see this article).

+ */ + _FinalStage newsfeedId(int newsfeedId); + + Builder from(NewsfeedAssignment other); + } + + public interface _FinalStage { + NewsfeedAssignment build(); + + /** + *

Publish date of the news item on the newsfeed, use this field if you want to set a publish date in the past (e.g. when importing existing news items). On write, this field will be ignored if the news item state is "draft".

+ */ + _FinalStage publishedAt(Optional publishedAt); + + _FinalStage publishedAt(Integer publishedAt); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements NewsfeedIdStage, _FinalStage { + private int newsfeedId; + + private Optional publishedAt = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(NewsfeedAssignment other) { + newsfeedId(other.getNewsfeedId()); + publishedAt(other.getPublishedAt()); + return this; + } + + /** + *

The unique identifier for the newsfeed which is given by Intercom. Publish dates cannot be in the future, to schedule news items use the dedicated feature in app (see this article).

+ *

The unique identifier for the newsfeed which is given by Intercom. Publish dates cannot be in the future, to schedule news items use the dedicated feature in app (see this article).

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("newsfeed_id") + public _FinalStage newsfeedId(int newsfeedId) { + this.newsfeedId = newsfeedId; + return this; + } + + /** + *

Publish date of the news item on the newsfeed, use this field if you want to set a publish date in the past (e.g. when importing existing news items). On write, this field will be ignored if the news item state is "draft".

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage publishedAt(Integer publishedAt) { + this.publishedAt = Optional.ofNullable(publishedAt); + return this; + } + + /** + *

Publish date of the news item on the newsfeed, use this field if you want to set a publish date in the past (e.g. when importing existing news items). On write, this field will be ignored if the news item state is "draft".

+ */ + @java.lang.Override + @JsonSetter(value = "published_at", nulls = Nulls.SKIP) + public _FinalStage publishedAt(Optional publishedAt) { + this.publishedAt = publishedAt; + return this; + } + + @java.lang.Override + public NewsfeedAssignment build() { + return new NewsfeedAssignment(newsfeedId, publishedAt, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/notes/AsyncNotesClient.java b/src/main/java/com/intercom/api/resources/notes/AsyncNotesClient.java new file mode 100644 index 00000000..b9d17de1 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/notes/AsyncNotesClient.java @@ -0,0 +1,74 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.notes; + +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.core.pagination.SyncPagingIterable; +import com.intercom.api.resources.notes.requests.CreateContactNoteRequest; +import com.intercom.api.resources.notes.requests.FindNoteRequest; +import com.intercom.api.resources.notes.requests.ListContactNotesRequest; +import com.intercom.api.resources.notes.types.Note; +import java.util.concurrent.CompletableFuture; + +public class AsyncNotesClient { + protected final ClientOptions clientOptions; + + private final AsyncRawNotesClient rawClient; + + public AsyncNotesClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + this.rawClient = new AsyncRawNotesClient(clientOptions); + } + + /** + * Get responses with HTTP metadata like headers + */ + public AsyncRawNotesClient withRawResponse() { + return this.rawClient; + } + + /** + * You can fetch a list of notes that are associated to a contact. + */ + public CompletableFuture> list(ListContactNotesRequest request) { + return this.rawClient.list(request).thenApply(response -> response.body()); + } + + /** + * You can fetch a list of notes that are associated to a contact. + */ + public CompletableFuture> list( + ListContactNotesRequest request, RequestOptions requestOptions) { + return this.rawClient.list(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can add a note to a single contact. + */ + public CompletableFuture create(CreateContactNoteRequest request) { + return this.rawClient.create(request).thenApply(response -> response.body()); + } + + /** + * You can add a note to a single contact. + */ + public CompletableFuture create(CreateContactNoteRequest request, RequestOptions requestOptions) { + return this.rawClient.create(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can fetch the details of a single note. + */ + public CompletableFuture find(FindNoteRequest request) { + return this.rawClient.find(request).thenApply(response -> response.body()); + } + + /** + * You can fetch the details of a single note. + */ + public CompletableFuture find(FindNoteRequest request, RequestOptions requestOptions) { + return this.rawClient.find(request, requestOptions).thenApply(response -> response.body()); + } +} diff --git a/src/main/java/com/intercom/api/resources/notes/AsyncRawNotesClient.java b/src/main/java/com/intercom/api/resources/notes/AsyncRawNotesClient.java new file mode 100644 index 00000000..ad98e892 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/notes/AsyncRawNotesClient.java @@ -0,0 +1,280 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.notes; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.IntercomApiException; +import com.intercom.api.core.IntercomException; +import com.intercom.api.core.IntercomHttpResponse; +import com.intercom.api.core.MediaTypes; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.core.QueryStringMapper; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.core.pagination.SyncPagingIterable; +import com.intercom.api.errors.NotFoundError; +import com.intercom.api.errors.UnauthorizedError; +import com.intercom.api.resources.notes.requests.CreateContactNoteRequest; +import com.intercom.api.resources.notes.requests.FindNoteRequest; +import com.intercom.api.resources.notes.requests.ListContactNotesRequest; +import com.intercom.api.resources.notes.types.Note; +import com.intercom.api.types.Error; +import com.intercom.api.types.NoteList; +import java.io.IOException; +import java.util.Collections; +import java.util.List; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.ExecutionException; +import okhttp3.Call; +import okhttp3.Callback; +import okhttp3.Headers; +import okhttp3.HttpUrl; +import okhttp3.OkHttpClient; +import okhttp3.Request; +import okhttp3.RequestBody; +import okhttp3.Response; +import okhttp3.ResponseBody; +import org.jetbrains.annotations.NotNull; + +public class AsyncRawNotesClient { + protected final ClientOptions clientOptions; + + public AsyncRawNotesClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + } + + /** + * You can fetch a list of notes that are associated to a contact. + */ + public CompletableFuture>> list(ListContactNotesRequest request) { + return list(request, null); + } + + /** + * You can fetch a list of notes that are associated to a contact. + */ + public CompletableFuture>> list( + ListContactNotesRequest request, RequestOptions requestOptions) { + HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("contacts") + .addPathSegment(request.getContactId()) + .addPathSegments("notes"); + if (request.getPage().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "page", request.getPage().get(), false); + } + if (request.getPerPage().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "per_page", request.getPerPage().get(), false); + } + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl.build()) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture>> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + NoteList parsedResponse = + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, NoteList.class); + int newPageNumber = request.getPage() + .map((Integer page) -> page + 1) + .orElse(1); + ListContactNotesRequest nextRequest = ListContactNotesRequest.builder() + .from(request) + .page(newPageNumber) + .build(); + List result = parsedResponse.getData().orElse(Collections.emptyList()); + future.complete(new IntercomHttpResponse<>( + new SyncPagingIterable(true, result, parsedResponse, () -> { + try { + return list(nextRequest, requestOptions) + .get() + .body(); + } catch (InterruptedException | ExecutionException e) { + throw new RuntimeException(e); + } + }), + response)); + return; + } + try { + if (response.code() == 404) { + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can add a note to a single contact. + */ + public CompletableFuture> create(CreateContactNoteRequest request) { + return create(request, null); + } + + /** + * You can add a note to a single contact. + */ + public CompletableFuture> create( + CreateContactNoteRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("contacts") + .addPathSegment(request.getContactId()) + .addPathSegments("notes") + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Note.class), response)); + return; + } + try { + if (response.code() == 404) { + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can fetch the details of a single note. + */ + public CompletableFuture> find(FindNoteRequest request) { + return find(request, null); + } + + /** + * You can fetch the details of a single note. + */ + public CompletableFuture> find(FindNoteRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("notes") + .addPathSegment(Integer.toString(request.getNoteId())) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Note.class), response)); + return; + } + try { + switch (response.code()) { + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 404: + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } +} diff --git a/src/main/java/com/intercom/api/resources/notes/NotesClient.java b/src/main/java/com/intercom/api/resources/notes/NotesClient.java new file mode 100644 index 00000000..9ddade23 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/notes/NotesClient.java @@ -0,0 +1,72 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.notes; + +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.core.pagination.SyncPagingIterable; +import com.intercom.api.resources.notes.requests.CreateContactNoteRequest; +import com.intercom.api.resources.notes.requests.FindNoteRequest; +import com.intercom.api.resources.notes.requests.ListContactNotesRequest; +import com.intercom.api.resources.notes.types.Note; + +public class NotesClient { + protected final ClientOptions clientOptions; + + private final RawNotesClient rawClient; + + public NotesClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + this.rawClient = new RawNotesClient(clientOptions); + } + + /** + * Get responses with HTTP metadata like headers + */ + public RawNotesClient withRawResponse() { + return this.rawClient; + } + + /** + * You can fetch a list of notes that are associated to a contact. + */ + public SyncPagingIterable list(ListContactNotesRequest request) { + return this.rawClient.list(request).body(); + } + + /** + * You can fetch a list of notes that are associated to a contact. + */ + public SyncPagingIterable list(ListContactNotesRequest request, RequestOptions requestOptions) { + return this.rawClient.list(request, requestOptions).body(); + } + + /** + * You can add a note to a single contact. + */ + public Note create(CreateContactNoteRequest request) { + return this.rawClient.create(request).body(); + } + + /** + * You can add a note to a single contact. + */ + public Note create(CreateContactNoteRequest request, RequestOptions requestOptions) { + return this.rawClient.create(request, requestOptions).body(); + } + + /** + * You can fetch the details of a single note. + */ + public Note find(FindNoteRequest request) { + return this.rawClient.find(request).body(); + } + + /** + * You can fetch the details of a single note. + */ + public Note find(FindNoteRequest request, RequestOptions requestOptions) { + return this.rawClient.find(request, requestOptions).body(); + } +} diff --git a/src/main/java/com/intercom/api/resources/notes/RawNotesClient.java b/src/main/java/com/intercom/api/resources/notes/RawNotesClient.java new file mode 100644 index 00000000..21b7f082 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/notes/RawNotesClient.java @@ -0,0 +1,221 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.notes; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.IntercomApiException; +import com.intercom.api.core.IntercomException; +import com.intercom.api.core.IntercomHttpResponse; +import com.intercom.api.core.MediaTypes; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.core.QueryStringMapper; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.core.pagination.SyncPagingIterable; +import com.intercom.api.errors.NotFoundError; +import com.intercom.api.errors.UnauthorizedError; +import com.intercom.api.resources.notes.requests.CreateContactNoteRequest; +import com.intercom.api.resources.notes.requests.FindNoteRequest; +import com.intercom.api.resources.notes.requests.ListContactNotesRequest; +import com.intercom.api.resources.notes.types.Note; +import com.intercom.api.types.Error; +import com.intercom.api.types.NoteList; +import java.io.IOException; +import java.util.Collections; +import java.util.List; +import okhttp3.Headers; +import okhttp3.HttpUrl; +import okhttp3.OkHttpClient; +import okhttp3.Request; +import okhttp3.RequestBody; +import okhttp3.Response; +import okhttp3.ResponseBody; + +public class RawNotesClient { + protected final ClientOptions clientOptions; + + public RawNotesClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + } + + /** + * You can fetch a list of notes that are associated to a contact. + */ + public IntercomHttpResponse> list(ListContactNotesRequest request) { + return list(request, null); + } + + /** + * You can fetch a list of notes that are associated to a contact. + */ + public IntercomHttpResponse> list( + ListContactNotesRequest request, RequestOptions requestOptions) { + HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("contacts") + .addPathSegment(request.getContactId()) + .addPathSegments("notes"); + if (request.getPage().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "page", request.getPage().get(), false); + } + if (request.getPerPage().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "per_page", request.getPerPage().get(), false); + } + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl.build()) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + NoteList parsedResponse = ObjectMappers.JSON_MAPPER.readValue(responseBodyString, NoteList.class); + int newPageNumber = + request.getPage().map((Integer page) -> page + 1).orElse(1); + ListContactNotesRequest nextRequest = ListContactNotesRequest.builder() + .from(request) + .page(newPageNumber) + .build(); + List result = parsedResponse.getData().orElse(Collections.emptyList()); + return new IntercomHttpResponse<>( + new SyncPagingIterable( + true, result, parsedResponse, () -> list(nextRequest, requestOptions) + .body()), + response); + } + try { + if (response.code() == 404) { + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can add a note to a single contact. + */ + public IntercomHttpResponse create(CreateContactNoteRequest request) { + return create(request, null); + } + + /** + * You can add a note to a single contact. + */ + public IntercomHttpResponse create(CreateContactNoteRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("contacts") + .addPathSegment(request.getContactId()) + .addPathSegments("notes") + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Note.class), response); + } + try { + if (response.code() == 404) { + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can fetch the details of a single note. + */ + public IntercomHttpResponse find(FindNoteRequest request) { + return find(request, null); + } + + /** + * You can fetch the details of a single note. + */ + public IntercomHttpResponse find(FindNoteRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("notes") + .addPathSegment(Integer.toString(request.getNoteId())) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Note.class), response); + } + try { + switch (response.code()) { + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 404: + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/notes/requests/CreateContactNoteRequest.java b/src/main/java/com/intercom/api/resources/notes/requests/CreateContactNoteRequest.java new file mode 100644 index 00000000..c09369db --- /dev/null +++ b/src/main/java/com/intercom/api/resources/notes/requests/CreateContactNoteRequest.java @@ -0,0 +1,190 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.notes.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = CreateContactNoteRequest.Builder.class) +public final class CreateContactNoteRequest { + private final String contactId; + + private final String body; + + private final Optional adminId; + + private final Map additionalProperties; + + private CreateContactNoteRequest( + String contactId, String body, Optional adminId, Map additionalProperties) { + this.contactId = contactId; + this.body = body; + this.adminId = adminId; + this.additionalProperties = additionalProperties; + } + + /** + * @return The unique identifier of a given contact. + */ + @JsonProperty("contact_id") + public String getContactId() { + return contactId; + } + + /** + * @return The text of the note. + */ + @JsonProperty("body") + public String getBody() { + return body; + } + + /** + * @return The unique identifier of a given admin. + */ + @JsonProperty("admin_id") + public Optional getAdminId() { + return adminId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof CreateContactNoteRequest && equalTo((CreateContactNoteRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(CreateContactNoteRequest other) { + return contactId.equals(other.contactId) && body.equals(other.body) && adminId.equals(other.adminId); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.contactId, this.body, this.adminId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static ContactIdStage builder() { + return new Builder(); + } + + public interface ContactIdStage { + /** + *

The unique identifier of a given contact.

+ */ + BodyStage contactId(@NotNull String contactId); + + Builder from(CreateContactNoteRequest other); + } + + public interface BodyStage { + /** + *

The text of the note.

+ */ + _FinalStage body(@NotNull String body); + } + + public interface _FinalStage { + CreateContactNoteRequest build(); + + /** + *

The unique identifier of a given admin.

+ */ + _FinalStage adminId(Optional adminId); + + _FinalStage adminId(String adminId); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements ContactIdStage, BodyStage, _FinalStage { + private String contactId; + + private String body; + + private Optional adminId = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(CreateContactNoteRequest other) { + contactId(other.getContactId()); + body(other.getBody()); + adminId(other.getAdminId()); + return this; + } + + /** + *

The unique identifier of a given contact.

+ *

The unique identifier of a given contact.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("contact_id") + public BodyStage contactId(@NotNull String contactId) { + this.contactId = Objects.requireNonNull(contactId, "contactId must not be null"); + return this; + } + + /** + *

The text of the note.

+ *

The text of the note.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("body") + public _FinalStage body(@NotNull String body) { + this.body = Objects.requireNonNull(body, "body must not be null"); + return this; + } + + /** + *

The unique identifier of a given admin.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage adminId(String adminId) { + this.adminId = Optional.ofNullable(adminId); + return this; + } + + /** + *

The unique identifier of a given admin.

+ */ + @java.lang.Override + @JsonSetter(value = "admin_id", nulls = Nulls.SKIP) + public _FinalStage adminId(Optional adminId) { + this.adminId = adminId; + return this; + } + + @java.lang.Override + public CreateContactNoteRequest build() { + return new CreateContactNoteRequest(contactId, body, adminId, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/notes/requests/FindNoteRequest.java b/src/main/java/com/intercom/api/resources/notes/requests/FindNoteRequest.java new file mode 100644 index 00000000..11a46e9c --- /dev/null +++ b/src/main/java/com/intercom/api/resources/notes/requests/FindNoteRequest.java @@ -0,0 +1,112 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.notes.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = FindNoteRequest.Builder.class) +public final class FindNoteRequest { + private final int noteId; + + private final Map additionalProperties; + + private FindNoteRequest(int noteId, Map additionalProperties) { + this.noteId = noteId; + this.additionalProperties = additionalProperties; + } + + /** + * @return The unique identifier of a given note + */ + @JsonProperty("note_id") + public int getNoteId() { + return noteId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof FindNoteRequest && equalTo((FindNoteRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(FindNoteRequest other) { + return noteId == other.noteId; + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.noteId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static NoteIdStage builder() { + return new Builder(); + } + + public interface NoteIdStage { + /** + *

The unique identifier of a given note

+ */ + _FinalStage noteId(int noteId); + + Builder from(FindNoteRequest other); + } + + public interface _FinalStage { + FindNoteRequest build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements NoteIdStage, _FinalStage { + private int noteId; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(FindNoteRequest other) { + noteId(other.getNoteId()); + return this; + } + + /** + *

The unique identifier of a given note

+ *

The unique identifier of a given note

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("note_id") + public _FinalStage noteId(int noteId) { + this.noteId = noteId; + return this; + } + + @java.lang.Override + public FindNoteRequest build() { + return new FindNoteRequest(noteId, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/notes/requests/ListContactNotesRequest.java b/src/main/java/com/intercom/api/resources/notes/requests/ListContactNotesRequest.java new file mode 100644 index 00000000..d21927df --- /dev/null +++ b/src/main/java/com/intercom/api/resources/notes/requests/ListContactNotesRequest.java @@ -0,0 +1,201 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.notes.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = ListContactNotesRequest.Builder.class) +public final class ListContactNotesRequest { + private final String contactId; + + private final Optional page; + + private final Optional perPage; + + private final Map additionalProperties; + + private ListContactNotesRequest( + String contactId, + Optional page, + Optional perPage, + Map additionalProperties) { + this.contactId = contactId; + this.page = page; + this.perPage = perPage; + this.additionalProperties = additionalProperties; + } + + /** + * @return The unique identifier of a contact. + */ + @JsonProperty("contact_id") + public String getContactId() { + return contactId; + } + + /** + * @return The page of results to fetch. Defaults to first page + */ + @JsonProperty("page") + public Optional getPage() { + return page; + } + + /** + * @return How many results to display per page. Defaults to 15 + */ + @JsonProperty("per_page") + public Optional getPerPage() { + return perPage; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof ListContactNotesRequest && equalTo((ListContactNotesRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(ListContactNotesRequest other) { + return contactId.equals(other.contactId) && page.equals(other.page) && perPage.equals(other.perPage); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.contactId, this.page, this.perPage); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static ContactIdStage builder() { + return new Builder(); + } + + public interface ContactIdStage { + /** + *

The unique identifier of a contact.

+ */ + _FinalStage contactId(@NotNull String contactId); + + Builder from(ListContactNotesRequest other); + } + + public interface _FinalStage { + ListContactNotesRequest build(); + + /** + *

The page of results to fetch. Defaults to first page

+ */ + _FinalStage page(Optional page); + + _FinalStage page(Integer page); + + /** + *

How many results to display per page. Defaults to 15

+ */ + _FinalStage perPage(Optional perPage); + + _FinalStage perPage(Integer perPage); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements ContactIdStage, _FinalStage { + private String contactId; + + private Optional perPage = Optional.empty(); + + private Optional page = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(ListContactNotesRequest other) { + contactId(other.getContactId()); + page(other.getPage()); + perPage(other.getPerPage()); + return this; + } + + /** + *

The unique identifier of a contact.

+ *

The unique identifier of a contact.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("contact_id") + public _FinalStage contactId(@NotNull String contactId) { + this.contactId = Objects.requireNonNull(contactId, "contactId must not be null"); + return this; + } + + /** + *

How many results to display per page. Defaults to 15

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage perPage(Integer perPage) { + this.perPage = Optional.ofNullable(perPage); + return this; + } + + /** + *

How many results to display per page. Defaults to 15

+ */ + @java.lang.Override + @JsonSetter(value = "per_page", nulls = Nulls.SKIP) + public _FinalStage perPage(Optional perPage) { + this.perPage = perPage; + return this; + } + + /** + *

The page of results to fetch. Defaults to first page

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage page(Integer page) { + this.page = Optional.ofNullable(page); + return this; + } + + /** + *

The page of results to fetch. Defaults to first page

+ */ + @java.lang.Override + @JsonSetter(value = "page", nulls = Nulls.SKIP) + public _FinalStage page(Optional page) { + this.page = page; + return this; + } + + @java.lang.Override + public ListContactNotesRequest build() { + return new ListContactNotesRequest(contactId, page, perPage, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/notes/types/Note.java b/src/main/java/com/intercom/api/resources/notes/types/Note.java new file mode 100644 index 00000000..f730300d --- /dev/null +++ b/src/main/java/com/intercom/api/resources/notes/types/Note.java @@ -0,0 +1,420 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.notes.types; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.resources.admins.types.Admin; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = Note.Builder.class) +public final class Note { + private final String type; + + private final String id; + + private final int createdAt; + + private final Optional contact; + + private final Optional author; + + private final String body; + + private final Map additionalProperties; + + private Note( + String type, + String id, + int createdAt, + Optional contact, + Optional author, + String body, + Map additionalProperties) { + this.type = type; + this.id = id; + this.createdAt = createdAt; + this.contact = contact; + this.author = author; + this.body = body; + this.additionalProperties = additionalProperties; + } + + /** + * @return String representing the object's type. Always has the value note. + */ + @JsonProperty("type") + public String getType() { + return type; + } + + /** + * @return The id of the note. + */ + @JsonProperty("id") + public String getId() { + return id; + } + + /** + * @return The time the note was created. + */ + @JsonProperty("created_at") + public int getCreatedAt() { + return createdAt; + } + + /** + * @return Represents the contact that the note was created about. + */ + @JsonProperty("contact") + public Optional getContact() { + return contact; + } + + /** + * @return Optional. Represents the Admin that created the note. + */ + @JsonProperty("author") + public Optional getAuthor() { + return author; + } + + /** + * @return The body text of the note. + */ + @JsonProperty("body") + public String getBody() { + return body; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof Note && equalTo((Note) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(Note other) { + return type.equals(other.type) + && id.equals(other.id) + && createdAt == other.createdAt + && contact.equals(other.contact) + && author.equals(other.author) + && body.equals(other.body); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.type, this.id, this.createdAt, this.contact, this.author, this.body); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static TypeStage builder() { + return new Builder(); + } + + public interface TypeStage { + /** + *

String representing the object's type. Always has the value note.

+ */ + IdStage type(@NotNull String type); + + Builder from(Note other); + } + + public interface IdStage { + /** + *

The id of the note.

+ */ + CreatedAtStage id(@NotNull String id); + } + + public interface CreatedAtStage { + /** + *

The time the note was created.

+ */ + BodyStage createdAt(int createdAt); + } + + public interface BodyStage { + /** + *

The body text of the note.

+ */ + _FinalStage body(@NotNull String body); + } + + public interface _FinalStage { + Note build(); + + /** + *

Represents the contact that the note was created about.

+ */ + _FinalStage contact(Optional contact); + + _FinalStage contact(Contact contact); + + /** + *

Optional. Represents the Admin that created the note.

+ */ + _FinalStage author(Optional author); + + _FinalStage author(Admin author); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements TypeStage, IdStage, CreatedAtStage, BodyStage, _FinalStage { + private String type; + + private String id; + + private int createdAt; + + private String body; + + private Optional author = Optional.empty(); + + private Optional contact = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(Note other) { + type(other.getType()); + id(other.getId()); + createdAt(other.getCreatedAt()); + contact(other.getContact()); + author(other.getAuthor()); + body(other.getBody()); + return this; + } + + /** + *

String representing the object's type. Always has the value note.

+ *

String representing the object's type. Always has the value note.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("type") + public IdStage type(@NotNull String type) { + this.type = Objects.requireNonNull(type, "type must not be null"); + return this; + } + + /** + *

The id of the note.

+ *

The id of the note.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("id") + public CreatedAtStage id(@NotNull String id) { + this.id = Objects.requireNonNull(id, "id must not be null"); + return this; + } + + /** + *

The time the note was created.

+ *

The time the note was created.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("created_at") + public BodyStage createdAt(int createdAt) { + this.createdAt = createdAt; + return this; + } + + /** + *

The body text of the note.

+ *

The body text of the note.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("body") + public _FinalStage body(@NotNull String body) { + this.body = Objects.requireNonNull(body, "body must not be null"); + return this; + } + + /** + *

Optional. Represents the Admin that created the note.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage author(Admin author) { + this.author = Optional.ofNullable(author); + return this; + } + + /** + *

Optional. Represents the Admin that created the note.

+ */ + @java.lang.Override + @JsonSetter(value = "author", nulls = Nulls.SKIP) + public _FinalStage author(Optional author) { + this.author = author; + return this; + } + + /** + *

Represents the contact that the note was created about.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage contact(Contact contact) { + this.contact = Optional.ofNullable(contact); + return this; + } + + /** + *

Represents the contact that the note was created about.

+ */ + @java.lang.Override + @JsonSetter(value = "contact", nulls = Nulls.SKIP) + public _FinalStage contact(Optional contact) { + this.contact = contact; + return this; + } + + @java.lang.Override + public Note build() { + return new Note(type, id, createdAt, contact, author, body, additionalProperties); + } + } + + @JsonInclude(JsonInclude.Include.NON_ABSENT) + @JsonDeserialize(builder = Contact.Builder.class) + public static final class Contact { + private final Optional type; + + private final Optional id; + + private final Map additionalProperties; + + private Contact(Optional type, Optional id, Map additionalProperties) { + this.type = type; + this.id = id; + this.additionalProperties = additionalProperties; + } + + /** + * @return String representing the object's type. Always has the value contact. + */ + @JsonProperty("type") + public Optional getType() { + return type; + } + + /** + * @return The id of the contact. + */ + @JsonProperty("id") + public Optional getId() { + return id; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof Contact && equalTo((Contact) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(Contact other) { + return type.equals(other.type) && id.equals(other.id); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.type, this.id); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static Builder builder() { + return new Builder(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder { + private Optional type = Optional.empty(); + + private Optional id = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + public Builder from(Contact other) { + type(other.getType()); + id(other.getId()); + return this; + } + + /** + *

String representing the object's type. Always has the value contact.

+ */ + @JsonSetter(value = "type", nulls = Nulls.SKIP) + public Builder type(Optional type) { + this.type = type; + return this; + } + + public Builder type(String type) { + this.type = Optional.ofNullable(type); + return this; + } + + /** + *

The id of the contact.

+ */ + @JsonSetter(value = "id", nulls = Nulls.SKIP) + public Builder id(Optional id) { + this.id = id; + return this; + } + + public Builder id(String id) { + this.id = Optional.ofNullable(id); + return this; + } + + public Contact build() { + return new Contact(type, id, additionalProperties); + } + } + } +} diff --git a/src/main/java/com/intercom/api/resources/phonecallredirects/AsyncPhoneCallRedirectsClient.java b/src/main/java/com/intercom/api/resources/phonecallredirects/AsyncPhoneCallRedirectsClient.java new file mode 100644 index 00000000..e7b96767 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/phonecallredirects/AsyncPhoneCallRedirectsClient.java @@ -0,0 +1,57 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.phonecallredirects; + +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.types.CreatePhoneSwitchRequest; +import com.intercom.api.types.PhoneSwitch; +import java.util.Optional; +import java.util.concurrent.CompletableFuture; + +public class AsyncPhoneCallRedirectsClient { + protected final ClientOptions clientOptions; + + private final AsyncRawPhoneCallRedirectsClient rawClient; + + public AsyncPhoneCallRedirectsClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + this.rawClient = new AsyncRawPhoneCallRedirectsClient(clientOptions); + } + + /** + * Get responses with HTTP metadata like headers + */ + public AsyncRawPhoneCallRedirectsClient withRawResponse() { + return this.rawClient; + } + + /** + * You can use the API to deflect phone calls to the Intercom Messenger. + * Calling this endpoint will send an SMS with a link to the Messenger to the phone number specified. + *

If custom attributes are specified, they will be added to the user or lead's custom data attributes.

+ */ + public CompletableFuture> create() { + return this.rawClient.create().thenApply(response -> response.body()); + } + + /** + * You can use the API to deflect phone calls to the Intercom Messenger. + * Calling this endpoint will send an SMS with a link to the Messenger to the phone number specified. + *

If custom attributes are specified, they will be added to the user or lead's custom data attributes.

+ */ + public CompletableFuture> create(Optional request) { + return this.rawClient.create(request).thenApply(response -> response.body()); + } + + /** + * You can use the API to deflect phone calls to the Intercom Messenger. + * Calling this endpoint will send an SMS with a link to the Messenger to the phone number specified. + *

If custom attributes are specified, they will be added to the user or lead's custom data attributes.

+ */ + public CompletableFuture> create( + Optional request, RequestOptions requestOptions) { + return this.rawClient.create(request, requestOptions).thenApply(response -> response.body()); + } +} diff --git a/src/main/java/com/intercom/api/resources/phonecallredirects/AsyncRawPhoneCallRedirectsClient.java b/src/main/java/com/intercom/api/resources/phonecallredirects/AsyncRawPhoneCallRedirectsClient.java new file mode 100644 index 00000000..611751d5 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/phonecallredirects/AsyncRawPhoneCallRedirectsClient.java @@ -0,0 +1,143 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.phonecallredirects; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.fasterxml.jackson.core.type.TypeReference; +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.IntercomApiException; +import com.intercom.api.core.IntercomException; +import com.intercom.api.core.IntercomHttpResponse; +import com.intercom.api.core.MediaTypes; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.errors.BadRequestError; +import com.intercom.api.errors.UnauthorizedError; +import com.intercom.api.errors.UnprocessableEntityError; +import com.intercom.api.types.CreatePhoneSwitchRequest; +import com.intercom.api.types.Error; +import com.intercom.api.types.PhoneSwitch; +import java.io.IOException; +import java.util.Optional; +import java.util.concurrent.CompletableFuture; +import okhttp3.Call; +import okhttp3.Callback; +import okhttp3.Headers; +import okhttp3.HttpUrl; +import okhttp3.OkHttpClient; +import okhttp3.Request; +import okhttp3.RequestBody; +import okhttp3.Response; +import okhttp3.ResponseBody; +import org.jetbrains.annotations.NotNull; + +public class AsyncRawPhoneCallRedirectsClient { + protected final ClientOptions clientOptions; + + public AsyncRawPhoneCallRedirectsClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + } + + /** + * You can use the API to deflect phone calls to the Intercom Messenger. + * Calling this endpoint will send an SMS with a link to the Messenger to the phone number specified. + *

If custom attributes are specified, they will be added to the user or lead's custom data attributes.

+ */ + public CompletableFuture>> create() { + return create(Optional.empty()); + } + + /** + * You can use the API to deflect phone calls to the Intercom Messenger. + * Calling this endpoint will send an SMS with a link to the Messenger to the phone number specified. + *

If custom attributes are specified, they will be added to the user or lead's custom data attributes.

+ */ + public CompletableFuture>> create( + Optional request) { + return create(request, null); + } + + /** + * You can use the API to deflect phone calls to the Intercom Messenger. + * Calling this endpoint will send an SMS with a link to the Messenger to the phone number specified. + *

If custom attributes are specified, they will be added to the user or lead's custom data attributes.

+ */ + public CompletableFuture>> create( + Optional request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("phone_call_redirects") + .build(); + RequestBody body; + try { + body = RequestBody.create("", null); + if (request.isPresent()) { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture>> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue( + responseBodyString, new TypeReference>() {}), + response)); + return; + } + try { + switch (response.code()) { + case 400: + future.completeExceptionally(new BadRequestError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 422: + future.completeExceptionally(new UnprocessableEntityError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } +} diff --git a/src/main/java/com/intercom/api/resources/phonecallredirects/PhoneCallRedirectsClient.java b/src/main/java/com/intercom/api/resources/phonecallredirects/PhoneCallRedirectsClient.java new file mode 100644 index 00000000..dcbceabf --- /dev/null +++ b/src/main/java/com/intercom/api/resources/phonecallredirects/PhoneCallRedirectsClient.java @@ -0,0 +1,55 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.phonecallredirects; + +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.types.CreatePhoneSwitchRequest; +import com.intercom.api.types.PhoneSwitch; +import java.util.Optional; + +public class PhoneCallRedirectsClient { + protected final ClientOptions clientOptions; + + private final RawPhoneCallRedirectsClient rawClient; + + public PhoneCallRedirectsClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + this.rawClient = new RawPhoneCallRedirectsClient(clientOptions); + } + + /** + * Get responses with HTTP metadata like headers + */ + public RawPhoneCallRedirectsClient withRawResponse() { + return this.rawClient; + } + + /** + * You can use the API to deflect phone calls to the Intercom Messenger. + * Calling this endpoint will send an SMS with a link to the Messenger to the phone number specified. + *

If custom attributes are specified, they will be added to the user or lead's custom data attributes.

+ */ + public Optional create() { + return this.rawClient.create().body(); + } + + /** + * You can use the API to deflect phone calls to the Intercom Messenger. + * Calling this endpoint will send an SMS with a link to the Messenger to the phone number specified. + *

If custom attributes are specified, they will be added to the user or lead's custom data attributes.

+ */ + public Optional create(Optional request) { + return this.rawClient.create(request).body(); + } + + /** + * You can use the API to deflect phone calls to the Intercom Messenger. + * Calling this endpoint will send an SMS with a link to the Messenger to the phone number specified. + *

If custom attributes are specified, they will be added to the user or lead's custom data attributes.

+ */ + public Optional create(Optional request, RequestOptions requestOptions) { + return this.rawClient.create(request, requestOptions).body(); + } +} diff --git a/src/main/java/com/intercom/api/resources/phonecallredirects/RawPhoneCallRedirectsClient.java b/src/main/java/com/intercom/api/resources/phonecallredirects/RawPhoneCallRedirectsClient.java new file mode 100644 index 00000000..f34b6708 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/phonecallredirects/RawPhoneCallRedirectsClient.java @@ -0,0 +1,119 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.phonecallredirects; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.fasterxml.jackson.core.type.TypeReference; +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.IntercomApiException; +import com.intercom.api.core.IntercomException; +import com.intercom.api.core.IntercomHttpResponse; +import com.intercom.api.core.MediaTypes; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.errors.BadRequestError; +import com.intercom.api.errors.UnauthorizedError; +import com.intercom.api.errors.UnprocessableEntityError; +import com.intercom.api.types.CreatePhoneSwitchRequest; +import com.intercom.api.types.Error; +import com.intercom.api.types.PhoneSwitch; +import java.io.IOException; +import java.util.Optional; +import okhttp3.Headers; +import okhttp3.HttpUrl; +import okhttp3.OkHttpClient; +import okhttp3.Request; +import okhttp3.RequestBody; +import okhttp3.Response; +import okhttp3.ResponseBody; + +public class RawPhoneCallRedirectsClient { + protected final ClientOptions clientOptions; + + public RawPhoneCallRedirectsClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + } + + /** + * You can use the API to deflect phone calls to the Intercom Messenger. + * Calling this endpoint will send an SMS with a link to the Messenger to the phone number specified. + *

If custom attributes are specified, they will be added to the user or lead's custom data attributes.

+ */ + public IntercomHttpResponse> create() { + return create(Optional.empty()); + } + + /** + * You can use the API to deflect phone calls to the Intercom Messenger. + * Calling this endpoint will send an SMS with a link to the Messenger to the phone number specified. + *

If custom attributes are specified, they will be added to the user or lead's custom data attributes.

+ */ + public IntercomHttpResponse> create(Optional request) { + return create(request, null); + } + + /** + * You can use the API to deflect phone calls to the Intercom Messenger. + * Calling this endpoint will send an SMS with a link to the Messenger to the phone number specified. + *

If custom attributes are specified, they will be added to the user or lead's custom data attributes.

+ */ + public IntercomHttpResponse> create( + Optional request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("phone_call_redirects") + .build(); + RequestBody body; + try { + body = RequestBody.create("", null); + if (request.isPresent()) { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue( + responseBodyString, new TypeReference>() {}), + response); + } + try { + switch (response.code()) { + case 400: + throw new BadRequestError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 422: + throw new UnprocessableEntityError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/segments/AsyncRawSegmentsClient.java b/src/main/java/com/intercom/api/resources/segments/AsyncRawSegmentsClient.java new file mode 100644 index 00000000..1da20435 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/segments/AsyncRawSegmentsClient.java @@ -0,0 +1,183 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.segments; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.IntercomApiException; +import com.intercom.api.core.IntercomException; +import com.intercom.api.core.IntercomHttpResponse; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.core.QueryStringMapper; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.errors.NotFoundError; +import com.intercom.api.errors.UnauthorizedError; +import com.intercom.api.resources.segments.requests.FindSegmentRequest; +import com.intercom.api.resources.segments.requests.ListSegmentsRequest; +import com.intercom.api.resources.segments.types.Segment; +import com.intercom.api.types.Error; +import com.intercom.api.types.SegmentList; +import java.io.IOException; +import java.util.concurrent.CompletableFuture; +import okhttp3.Call; +import okhttp3.Callback; +import okhttp3.Headers; +import okhttp3.HttpUrl; +import okhttp3.OkHttpClient; +import okhttp3.Request; +import okhttp3.Response; +import okhttp3.ResponseBody; +import org.jetbrains.annotations.NotNull; + +public class AsyncRawSegmentsClient { + protected final ClientOptions clientOptions; + + public AsyncRawSegmentsClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + } + + /** + * You can fetch a list of all segments. + */ + public CompletableFuture> list() { + return list(ListSegmentsRequest.builder().build()); + } + + /** + * You can fetch a list of all segments. + */ + public CompletableFuture> list(ListSegmentsRequest request) { + return list(request, null); + } + + /** + * You can fetch a list of all segments. + */ + public CompletableFuture> list( + ListSegmentsRequest request, RequestOptions requestOptions) { + HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("segments"); + if (request.getIncludeCount().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "include_count", request.getIncludeCount().get(), false); + } + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl.build()) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, SegmentList.class), response)); + return; + } + try { + if (response.code() == 401) { + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can fetch the details of a single segment. + */ + public CompletableFuture> find(FindSegmentRequest request) { + return find(request, null); + } + + /** + * You can fetch the details of a single segment. + */ + public CompletableFuture> find( + FindSegmentRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("segments") + .addPathSegment(request.getSegmentId()) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Segment.class), response)); + return; + } + try { + switch (response.code()) { + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 404: + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } +} diff --git a/src/main/java/com/intercom/api/resources/segments/AsyncSegmentsClient.java b/src/main/java/com/intercom/api/resources/segments/AsyncSegmentsClient.java new file mode 100644 index 00000000..e1b18d91 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/segments/AsyncSegmentsClient.java @@ -0,0 +1,65 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.segments; + +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.resources.segments.requests.FindSegmentRequest; +import com.intercom.api.resources.segments.requests.ListSegmentsRequest; +import com.intercom.api.resources.segments.types.Segment; +import com.intercom.api.types.SegmentList; +import java.util.concurrent.CompletableFuture; + +public class AsyncSegmentsClient { + protected final ClientOptions clientOptions; + + private final AsyncRawSegmentsClient rawClient; + + public AsyncSegmentsClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + this.rawClient = new AsyncRawSegmentsClient(clientOptions); + } + + /** + * Get responses with HTTP metadata like headers + */ + public AsyncRawSegmentsClient withRawResponse() { + return this.rawClient; + } + + /** + * You can fetch a list of all segments. + */ + public CompletableFuture list() { + return this.rawClient.list().thenApply(response -> response.body()); + } + + /** + * You can fetch a list of all segments. + */ + public CompletableFuture list(ListSegmentsRequest request) { + return this.rawClient.list(request).thenApply(response -> response.body()); + } + + /** + * You can fetch a list of all segments. + */ + public CompletableFuture list(ListSegmentsRequest request, RequestOptions requestOptions) { + return this.rawClient.list(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can fetch the details of a single segment. + */ + public CompletableFuture find(FindSegmentRequest request) { + return this.rawClient.find(request).thenApply(response -> response.body()); + } + + /** + * You can fetch the details of a single segment. + */ + public CompletableFuture find(FindSegmentRequest request, RequestOptions requestOptions) { + return this.rawClient.find(request, requestOptions).thenApply(response -> response.body()); + } +} diff --git a/src/main/java/com/intercom/api/resources/segments/RawSegmentsClient.java b/src/main/java/com/intercom/api/resources/segments/RawSegmentsClient.java new file mode 100644 index 00000000..df168c0e --- /dev/null +++ b/src/main/java/com/intercom/api/resources/segments/RawSegmentsClient.java @@ -0,0 +1,146 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.segments; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.IntercomApiException; +import com.intercom.api.core.IntercomException; +import com.intercom.api.core.IntercomHttpResponse; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.core.QueryStringMapper; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.errors.NotFoundError; +import com.intercom.api.errors.UnauthorizedError; +import com.intercom.api.resources.segments.requests.FindSegmentRequest; +import com.intercom.api.resources.segments.requests.ListSegmentsRequest; +import com.intercom.api.resources.segments.types.Segment; +import com.intercom.api.types.Error; +import com.intercom.api.types.SegmentList; +import java.io.IOException; +import okhttp3.Headers; +import okhttp3.HttpUrl; +import okhttp3.OkHttpClient; +import okhttp3.Request; +import okhttp3.Response; +import okhttp3.ResponseBody; + +public class RawSegmentsClient { + protected final ClientOptions clientOptions; + + public RawSegmentsClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + } + + /** + * You can fetch a list of all segments. + */ + public IntercomHttpResponse list() { + return list(ListSegmentsRequest.builder().build()); + } + + /** + * You can fetch a list of all segments. + */ + public IntercomHttpResponse list(ListSegmentsRequest request) { + return list(request, null); + } + + /** + * You can fetch a list of all segments. + */ + public IntercomHttpResponse list(ListSegmentsRequest request, RequestOptions requestOptions) { + HttpUrl.Builder httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("segments"); + if (request.getIncludeCount().isPresent()) { + QueryStringMapper.addQueryParameter( + httpUrl, "include_count", request.getIncludeCount().get(), false); + } + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl.build()) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, SegmentList.class), response); + } + try { + if (response.code() == 401) { + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can fetch the details of a single segment. + */ + public IntercomHttpResponse find(FindSegmentRequest request) { + return find(request, null); + } + + /** + * You can fetch the details of a single segment. + */ + public IntercomHttpResponse find(FindSegmentRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("segments") + .addPathSegment(request.getSegmentId()) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Segment.class), response); + } + try { + switch (response.code()) { + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 404: + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/segments/SegmentsClient.java b/src/main/java/com/intercom/api/resources/segments/SegmentsClient.java new file mode 100644 index 00000000..c1999ea6 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/segments/SegmentsClient.java @@ -0,0 +1,64 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.segments; + +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.resources.segments.requests.FindSegmentRequest; +import com.intercom.api.resources.segments.requests.ListSegmentsRequest; +import com.intercom.api.resources.segments.types.Segment; +import com.intercom.api.types.SegmentList; + +public class SegmentsClient { + protected final ClientOptions clientOptions; + + private final RawSegmentsClient rawClient; + + public SegmentsClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + this.rawClient = new RawSegmentsClient(clientOptions); + } + + /** + * Get responses with HTTP metadata like headers + */ + public RawSegmentsClient withRawResponse() { + return this.rawClient; + } + + /** + * You can fetch a list of all segments. + */ + public SegmentList list() { + return this.rawClient.list().body(); + } + + /** + * You can fetch a list of all segments. + */ + public SegmentList list(ListSegmentsRequest request) { + return this.rawClient.list(request).body(); + } + + /** + * You can fetch a list of all segments. + */ + public SegmentList list(ListSegmentsRequest request, RequestOptions requestOptions) { + return this.rawClient.list(request, requestOptions).body(); + } + + /** + * You can fetch the details of a single segment. + */ + public Segment find(FindSegmentRequest request) { + return this.rawClient.find(request).body(); + } + + /** + * You can fetch the details of a single segment. + */ + public Segment find(FindSegmentRequest request, RequestOptions requestOptions) { + return this.rawClient.find(request, requestOptions).body(); + } +} diff --git a/src/main/java/com/intercom/api/resources/segments/requests/FindSegmentRequest.java b/src/main/java/com/intercom/api/resources/segments/requests/FindSegmentRequest.java new file mode 100644 index 00000000..b514aa05 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/segments/requests/FindSegmentRequest.java @@ -0,0 +1,113 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.segments.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = FindSegmentRequest.Builder.class) +public final class FindSegmentRequest { + private final String segmentId; + + private final Map additionalProperties; + + private FindSegmentRequest(String segmentId, Map additionalProperties) { + this.segmentId = segmentId; + this.additionalProperties = additionalProperties; + } + + /** + * @return The unique identified of a given segment. + */ + @JsonProperty("segment_id") + public String getSegmentId() { + return segmentId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof FindSegmentRequest && equalTo((FindSegmentRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(FindSegmentRequest other) { + return segmentId.equals(other.segmentId); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.segmentId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static SegmentIdStage builder() { + return new Builder(); + } + + public interface SegmentIdStage { + /** + *

The unique identified of a given segment.

+ */ + _FinalStage segmentId(@NotNull String segmentId); + + Builder from(FindSegmentRequest other); + } + + public interface _FinalStage { + FindSegmentRequest build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements SegmentIdStage, _FinalStage { + private String segmentId; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(FindSegmentRequest other) { + segmentId(other.getSegmentId()); + return this; + } + + /** + *

The unique identified of a given segment.

+ *

The unique identified of a given segment.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("segment_id") + public _FinalStage segmentId(@NotNull String segmentId) { + this.segmentId = Objects.requireNonNull(segmentId, "segmentId must not be null"); + return this; + } + + @java.lang.Override + public FindSegmentRequest build() { + return new FindSegmentRequest(segmentId, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/segments/requests/ListSegmentsRequest.java b/src/main/java/com/intercom/api/resources/segments/requests/ListSegmentsRequest.java new file mode 100644 index 00000000..0d49b3f9 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/segments/requests/ListSegmentsRequest.java @@ -0,0 +1,101 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.segments.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = ListSegmentsRequest.Builder.class) +public final class ListSegmentsRequest { + private final Optional includeCount; + + private final Map additionalProperties; + + private ListSegmentsRequest(Optional includeCount, Map additionalProperties) { + this.includeCount = includeCount; + this.additionalProperties = additionalProperties; + } + + /** + * @return It includes the count of contacts that belong to each segment. + */ + @JsonProperty("include_count") + public Optional getIncludeCount() { + return includeCount; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof ListSegmentsRequest && equalTo((ListSegmentsRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(ListSegmentsRequest other) { + return includeCount.equals(other.includeCount); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.includeCount); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static Builder builder() { + return new Builder(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder { + private Optional includeCount = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + public Builder from(ListSegmentsRequest other) { + includeCount(other.getIncludeCount()); + return this; + } + + /** + *

It includes the count of contacts that belong to each segment.

+ */ + @JsonSetter(value = "include_count", nulls = Nulls.SKIP) + public Builder includeCount(Optional includeCount) { + this.includeCount = includeCount; + return this; + } + + public Builder includeCount(Boolean includeCount) { + this.includeCount = Optional.ofNullable(includeCount); + return this; + } + + public ListSegmentsRequest build() { + return new ListSegmentsRequest(includeCount, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/segments/types/Segment.java b/src/main/java/com/intercom/api/resources/segments/types/Segment.java new file mode 100644 index 00000000..9be4c797 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/segments/types/Segment.java @@ -0,0 +1,386 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.segments.types; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.JsonValue; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = Segment.Builder.class) +public final class Segment { + private final String id; + + private final String name; + + private final int createdAt; + + private final int updatedAt; + + private final PersonType personType; + + private final Optional count; + + private final Map additionalProperties; + + private Segment( + String id, + String name, + int createdAt, + int updatedAt, + PersonType personType, + Optional count, + Map additionalProperties) { + this.id = id; + this.name = name; + this.createdAt = createdAt; + this.updatedAt = updatedAt; + this.personType = personType; + this.count = count; + this.additionalProperties = additionalProperties; + } + + /** + * @return The type of object. + */ + @JsonProperty("type") + public String getType() { + return "segment"; + } + + /** + * @return The unique identifier representing the segment. + */ + @JsonProperty("id") + public String getId() { + return id; + } + + /** + * @return The name of the segment. + */ + @JsonProperty("name") + public String getName() { + return name; + } + + /** + * @return The time the segment was created. + */ + @JsonProperty("created_at") + public int getCreatedAt() { + return createdAt; + } + + /** + * @return The time the segment was updated. + */ + @JsonProperty("updated_at") + public int getUpdatedAt() { + return updatedAt; + } + + /** + * @return Type of the contact: contact (lead) or user. + */ + @JsonProperty("person_type") + public PersonType getPersonType() { + return personType; + } + + /** + * @return The number of items in the user segment. It's returned when include_count=true is included in the request. + */ + @JsonProperty("count") + public Optional getCount() { + return count; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof Segment && equalTo((Segment) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(Segment other) { + return id.equals(other.id) + && name.equals(other.name) + && createdAt == other.createdAt + && updatedAt == other.updatedAt + && personType.equals(other.personType) + && count.equals(other.count); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.id, this.name, this.createdAt, this.updatedAt, this.personType, this.count); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static IdStage builder() { + return new Builder(); + } + + public interface IdStage { + /** + *

The unique identifier representing the segment.

+ */ + NameStage id(@NotNull String id); + + Builder from(Segment other); + } + + public interface NameStage { + /** + *

The name of the segment.

+ */ + CreatedAtStage name(@NotNull String name); + } + + public interface CreatedAtStage { + /** + *

The time the segment was created.

+ */ + UpdatedAtStage createdAt(int createdAt); + } + + public interface UpdatedAtStage { + /** + *

The time the segment was updated.

+ */ + PersonTypeStage updatedAt(int updatedAt); + } + + public interface PersonTypeStage { + /** + *

Type of the contact: contact (lead) or user.

+ */ + _FinalStage personType(@NotNull PersonType personType); + } + + public interface _FinalStage { + Segment build(); + + /** + *

The number of items in the user segment. It's returned when include_count=true is included in the request.

+ */ + _FinalStage count(Optional count); + + _FinalStage count(Integer count); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder + implements IdStage, NameStage, CreatedAtStage, UpdatedAtStage, PersonTypeStage, _FinalStage { + private String id; + + private String name; + + private int createdAt; + + private int updatedAt; + + private PersonType personType; + + private Optional count = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(Segment other) { + id(other.getId()); + name(other.getName()); + createdAt(other.getCreatedAt()); + updatedAt(other.getUpdatedAt()); + personType(other.getPersonType()); + count(other.getCount()); + return this; + } + + /** + *

The unique identifier representing the segment.

+ *

The unique identifier representing the segment.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("id") + public NameStage id(@NotNull String id) { + this.id = Objects.requireNonNull(id, "id must not be null"); + return this; + } + + /** + *

The name of the segment.

+ *

The name of the segment.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("name") + public CreatedAtStage name(@NotNull String name) { + this.name = Objects.requireNonNull(name, "name must not be null"); + return this; + } + + /** + *

The time the segment was created.

+ *

The time the segment was created.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("created_at") + public UpdatedAtStage createdAt(int createdAt) { + this.createdAt = createdAt; + return this; + } + + /** + *

The time the segment was updated.

+ *

The time the segment was updated.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("updated_at") + public PersonTypeStage updatedAt(int updatedAt) { + this.updatedAt = updatedAt; + return this; + } + + /** + *

Type of the contact: contact (lead) or user.

+ *

Type of the contact: contact (lead) or user.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("person_type") + public _FinalStage personType(@NotNull PersonType personType) { + this.personType = Objects.requireNonNull(personType, "personType must not be null"); + return this; + } + + /** + *

The number of items in the user segment. It's returned when include_count=true is included in the request.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage count(Integer count) { + this.count = Optional.ofNullable(count); + return this; + } + + /** + *

The number of items in the user segment. It's returned when include_count=true is included in the request.

+ */ + @java.lang.Override + @JsonSetter(value = "count", nulls = Nulls.SKIP) + public _FinalStage count(Optional count) { + this.count = count; + return this; + } + + @java.lang.Override + public Segment build() { + return new Segment(id, name, createdAt, updatedAt, personType, count, additionalProperties); + } + } + + public static final class PersonType { + public static final PersonType USER = new PersonType(Value.USER, "user"); + + public static final PersonType CONTACT = new PersonType(Value.CONTACT, "contact"); + + private final Value value; + + private final String string; + + PersonType(Value value, String string) { + this.value = value; + this.string = string; + } + + public Value getEnumValue() { + return value; + } + + @java.lang.Override + @JsonValue + public String toString() { + return this.string; + } + + @java.lang.Override + public boolean equals(Object other) { + return (this == other) || (other instanceof PersonType && this.string.equals(((PersonType) other).string)); + } + + @java.lang.Override + public int hashCode() { + return this.string.hashCode(); + } + + public T visit(Visitor visitor) { + switch (value) { + case USER: + return visitor.visitUser(); + case CONTACT: + return visitor.visitContact(); + case UNKNOWN: + default: + return visitor.visitUnknown(string); + } + } + + @JsonCreator(mode = JsonCreator.Mode.DELEGATING) + public static PersonType valueOf(String value) { + switch (value) { + case "user": + return USER; + case "contact": + return CONTACT; + default: + return new PersonType(Value.UNKNOWN, value); + } + } + + public enum Value { + CONTACT, + + USER, + + UNKNOWN + } + + public interface Visitor { + T visitContact(); + + T visitUser(); + + T visitUnknown(String unknownType); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/subscriptiontypes/AsyncRawSubscriptionTypesClient.java b/src/main/java/com/intercom/api/resources/subscriptiontypes/AsyncRawSubscriptionTypesClient.java new file mode 100644 index 00000000..39ad4da2 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/subscriptiontypes/AsyncRawSubscriptionTypesClient.java @@ -0,0 +1,97 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.subscriptiontypes; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.IntercomApiException; +import com.intercom.api.core.IntercomException; +import com.intercom.api.core.IntercomHttpResponse; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.errors.UnauthorizedError; +import com.intercom.api.types.Error; +import com.intercom.api.types.SubscriptionTypeList; +import java.io.IOException; +import java.util.concurrent.CompletableFuture; +import okhttp3.Call; +import okhttp3.Callback; +import okhttp3.Headers; +import okhttp3.HttpUrl; +import okhttp3.OkHttpClient; +import okhttp3.Request; +import okhttp3.Response; +import okhttp3.ResponseBody; +import org.jetbrains.annotations.NotNull; + +public class AsyncRawSubscriptionTypesClient { + protected final ClientOptions clientOptions; + + public AsyncRawSubscriptionTypesClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + } + + /** + * You can list all subscription types. A list of subscription type objects will be returned. + */ + public CompletableFuture> list() { + return list(null); + } + + /** + * You can list all subscription types. A list of subscription type objects will be returned. + */ + public CompletableFuture> list(RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("subscription_types") + .build(); + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, SubscriptionTypeList.class), + response)); + return; + } + try { + if (response.code() == 401) { + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } +} diff --git a/src/main/java/com/intercom/api/resources/subscriptiontypes/AsyncSubscriptionTypesClient.java b/src/main/java/com/intercom/api/resources/subscriptiontypes/AsyncSubscriptionTypesClient.java new file mode 100644 index 00000000..3293dabd --- /dev/null +++ b/src/main/java/com/intercom/api/resources/subscriptiontypes/AsyncSubscriptionTypesClient.java @@ -0,0 +1,41 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.subscriptiontypes; + +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.types.SubscriptionTypeList; +import java.util.concurrent.CompletableFuture; + +public class AsyncSubscriptionTypesClient { + protected final ClientOptions clientOptions; + + private final AsyncRawSubscriptionTypesClient rawClient; + + public AsyncSubscriptionTypesClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + this.rawClient = new AsyncRawSubscriptionTypesClient(clientOptions); + } + + /** + * Get responses with HTTP metadata like headers + */ + public AsyncRawSubscriptionTypesClient withRawResponse() { + return this.rawClient; + } + + /** + * You can list all subscription types. A list of subscription type objects will be returned. + */ + public CompletableFuture list() { + return this.rawClient.list().thenApply(response -> response.body()); + } + + /** + * You can list all subscription types. A list of subscription type objects will be returned. + */ + public CompletableFuture list(RequestOptions requestOptions) { + return this.rawClient.list(requestOptions).thenApply(response -> response.body()); + } +} diff --git a/src/main/java/com/intercom/api/resources/subscriptiontypes/RawSubscriptionTypesClient.java b/src/main/java/com/intercom/api/resources/subscriptiontypes/RawSubscriptionTypesClient.java new file mode 100644 index 00000000..4c42d558 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/subscriptiontypes/RawSubscriptionTypesClient.java @@ -0,0 +1,78 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.subscriptiontypes; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.IntercomApiException; +import com.intercom.api.core.IntercomException; +import com.intercom.api.core.IntercomHttpResponse; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.errors.UnauthorizedError; +import com.intercom.api.types.Error; +import com.intercom.api.types.SubscriptionTypeList; +import java.io.IOException; +import okhttp3.Headers; +import okhttp3.HttpUrl; +import okhttp3.OkHttpClient; +import okhttp3.Request; +import okhttp3.Response; +import okhttp3.ResponseBody; + +public class RawSubscriptionTypesClient { + protected final ClientOptions clientOptions; + + public RawSubscriptionTypesClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + } + + /** + * You can list all subscription types. A list of subscription type objects will be returned. + */ + public IntercomHttpResponse list() { + return list(null); + } + + /** + * You can list all subscription types. A list of subscription type objects will be returned. + */ + public IntercomHttpResponse list(RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("subscription_types") + .build(); + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, SubscriptionTypeList.class), response); + } + try { + if (response.code() == 401) { + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/subscriptiontypes/SubscriptionTypesClient.java b/src/main/java/com/intercom/api/resources/subscriptiontypes/SubscriptionTypesClient.java new file mode 100644 index 00000000..3864aa96 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/subscriptiontypes/SubscriptionTypesClient.java @@ -0,0 +1,40 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.subscriptiontypes; + +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.types.SubscriptionTypeList; + +public class SubscriptionTypesClient { + protected final ClientOptions clientOptions; + + private final RawSubscriptionTypesClient rawClient; + + public SubscriptionTypesClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + this.rawClient = new RawSubscriptionTypesClient(clientOptions); + } + + /** + * Get responses with HTTP metadata like headers + */ + public RawSubscriptionTypesClient withRawResponse() { + return this.rawClient; + } + + /** + * You can list all subscription types. A list of subscription type objects will be returned. + */ + public SubscriptionTypeList list() { + return this.rawClient.list().body(); + } + + /** + * You can list all subscription types. A list of subscription type objects will be returned. + */ + public SubscriptionTypeList list(RequestOptions requestOptions) { + return this.rawClient.list(requestOptions).body(); + } +} diff --git a/src/main/java/com/intercom/api/resources/subscriptiontypes/types/SubscriptionType.java b/src/main/java/com/intercom/api/resources/subscriptiontypes/types/SubscriptionType.java new file mode 100644 index 00000000..b1a13ff3 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/subscriptiontypes/types/SubscriptionType.java @@ -0,0 +1,526 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.subscriptiontypes.types; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.JsonValue; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.types.Translation; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = SubscriptionType.Builder.class) +public final class SubscriptionType { + private final Optional type; + + private final Optional id; + + private final Optional state; + + private final Optional defaultTranslation; + + private final Optional> translations; + + private final Optional consentType; + + private final Optional> contentTypes; + + private final Map additionalProperties; + + private SubscriptionType( + Optional type, + Optional id, + Optional state, + Optional defaultTranslation, + Optional> translations, + Optional consentType, + Optional> contentTypes, + Map additionalProperties) { + this.type = type; + this.id = id; + this.state = state; + this.defaultTranslation = defaultTranslation; + this.translations = translations; + this.consentType = consentType; + this.contentTypes = contentTypes; + this.additionalProperties = additionalProperties; + } + + /** + * @return The type of the object - subscription + */ + @JsonProperty("type") + public Optional getType() { + return type; + } + + /** + * @return The unique identifier representing the subscription type. + */ + @JsonProperty("id") + public Optional getId() { + return id; + } + + /** + * @return The state of the subscription type. + */ + @JsonProperty("state") + public Optional getState() { + return state; + } + + @JsonProperty("default_translation") + public Optional getDefaultTranslation() { + return defaultTranslation; + } + + /** + * @return An array of translations objects with the localised version of the subscription type in each available locale within your translation settings. + */ + @JsonProperty("translations") + public Optional> getTranslations() { + return translations; + } + + /** + * @return Describes the type of consent. + */ + @JsonProperty("consent_type") + public Optional getConsentType() { + return consentType; + } + + /** + * @return The message types that this subscription supports - can contain email or sms_message. + */ + @JsonProperty("content_types") + public Optional> getContentTypes() { + return contentTypes; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof SubscriptionType && equalTo((SubscriptionType) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(SubscriptionType other) { + return type.equals(other.type) + && id.equals(other.id) + && state.equals(other.state) + && defaultTranslation.equals(other.defaultTranslation) + && translations.equals(other.translations) + && consentType.equals(other.consentType) + && contentTypes.equals(other.contentTypes); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash( + this.type, + this.id, + this.state, + this.defaultTranslation, + this.translations, + this.consentType, + this.contentTypes); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static Builder builder() { + return new Builder(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder { + private Optional type = Optional.empty(); + + private Optional id = Optional.empty(); + + private Optional state = Optional.empty(); + + private Optional defaultTranslation = Optional.empty(); + + private Optional> translations = Optional.empty(); + + private Optional consentType = Optional.empty(); + + private Optional> contentTypes = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + public Builder from(SubscriptionType other) { + type(other.getType()); + id(other.getId()); + state(other.getState()); + defaultTranslation(other.getDefaultTranslation()); + translations(other.getTranslations()); + consentType(other.getConsentType()); + contentTypes(other.getContentTypes()); + return this; + } + + /** + *

The type of the object - subscription

+ */ + @JsonSetter(value = "type", nulls = Nulls.SKIP) + public Builder type(Optional type) { + this.type = type; + return this; + } + + public Builder type(String type) { + this.type = Optional.ofNullable(type); + return this; + } + + /** + *

The unique identifier representing the subscription type.

+ */ + @JsonSetter(value = "id", nulls = Nulls.SKIP) + public Builder id(Optional id) { + this.id = id; + return this; + } + + public Builder id(String id) { + this.id = Optional.ofNullable(id); + return this; + } + + /** + *

The state of the subscription type.

+ */ + @JsonSetter(value = "state", nulls = Nulls.SKIP) + public Builder state(Optional state) { + this.state = state; + return this; + } + + public Builder state(State state) { + this.state = Optional.ofNullable(state); + return this; + } + + @JsonSetter(value = "default_translation", nulls = Nulls.SKIP) + public Builder defaultTranslation(Optional defaultTranslation) { + this.defaultTranslation = defaultTranslation; + return this; + } + + public Builder defaultTranslation(Translation defaultTranslation) { + this.defaultTranslation = Optional.ofNullable(defaultTranslation); + return this; + } + + /** + *

An array of translations objects with the localised version of the subscription type in each available locale within your translation settings.

+ */ + @JsonSetter(value = "translations", nulls = Nulls.SKIP) + public Builder translations(Optional> translations) { + this.translations = translations; + return this; + } + + public Builder translations(List translations) { + this.translations = Optional.ofNullable(translations); + return this; + } + + /** + *

Describes the type of consent.

+ */ + @JsonSetter(value = "consent_type", nulls = Nulls.SKIP) + public Builder consentType(Optional consentType) { + this.consentType = consentType; + return this; + } + + public Builder consentType(ConsentType consentType) { + this.consentType = Optional.ofNullable(consentType); + return this; + } + + /** + *

The message types that this subscription supports - can contain email or sms_message.

+ */ + @JsonSetter(value = "content_types", nulls = Nulls.SKIP) + public Builder contentTypes(Optional> contentTypes) { + this.contentTypes = contentTypes; + return this; + } + + public Builder contentTypes(List contentTypes) { + this.contentTypes = Optional.ofNullable(contentTypes); + return this; + } + + public SubscriptionType build() { + return new SubscriptionType( + type, id, state, defaultTranslation, translations, consentType, contentTypes, additionalProperties); + } + } + + public static final class ConsentType { + public static final ConsentType OPT_IN = new ConsentType(Value.OPT_IN, "opt_in"); + + public static final ConsentType OPT_OUT = new ConsentType(Value.OPT_OUT, "opt_out"); + + private final Value value; + + private final String string; + + ConsentType(Value value, String string) { + this.value = value; + this.string = string; + } + + public Value getEnumValue() { + return value; + } + + @java.lang.Override + @JsonValue + public String toString() { + return this.string; + } + + @java.lang.Override + public boolean equals(Object other) { + return (this == other) + || (other instanceof ConsentType && this.string.equals(((ConsentType) other).string)); + } + + @java.lang.Override + public int hashCode() { + return this.string.hashCode(); + } + + public T visit(Visitor visitor) { + switch (value) { + case OPT_IN: + return visitor.visitOptIn(); + case OPT_OUT: + return visitor.visitOptOut(); + case UNKNOWN: + default: + return visitor.visitUnknown(string); + } + } + + @JsonCreator(mode = JsonCreator.Mode.DELEGATING) + public static ConsentType valueOf(String value) { + switch (value) { + case "opt_in": + return OPT_IN; + case "opt_out": + return OPT_OUT; + default: + return new ConsentType(Value.UNKNOWN, value); + } + } + + public enum Value { + OPT_OUT, + + OPT_IN, + + UNKNOWN + } + + public interface Visitor { + T visitOptOut(); + + T visitOptIn(); + + T visitUnknown(String unknownType); + } + } + + public static final class State { + public static final State LIVE = new State(Value.LIVE, "live"); + + public static final State ARCHIVED = new State(Value.ARCHIVED, "archived"); + + public static final State DRAFT = new State(Value.DRAFT, "draft"); + + private final Value value; + + private final String string; + + State(Value value, String string) { + this.value = value; + this.string = string; + } + + public Value getEnumValue() { + return value; + } + + @java.lang.Override + @JsonValue + public String toString() { + return this.string; + } + + @java.lang.Override + public boolean equals(Object other) { + return (this == other) || (other instanceof State && this.string.equals(((State) other).string)); + } + + @java.lang.Override + public int hashCode() { + return this.string.hashCode(); + } + + public T visit(Visitor visitor) { + switch (value) { + case LIVE: + return visitor.visitLive(); + case ARCHIVED: + return visitor.visitArchived(); + case DRAFT: + return visitor.visitDraft(); + case UNKNOWN: + default: + return visitor.visitUnknown(string); + } + } + + @JsonCreator(mode = JsonCreator.Mode.DELEGATING) + public static State valueOf(String value) { + switch (value) { + case "live": + return LIVE; + case "archived": + return ARCHIVED; + case "draft": + return DRAFT; + default: + return new State(Value.UNKNOWN, value); + } + } + + public enum Value { + LIVE, + + DRAFT, + + ARCHIVED, + + UNKNOWN + } + + public interface Visitor { + T visitLive(); + + T visitDraft(); + + T visitArchived(); + + T visitUnknown(String unknownType); + } + } + + public static final class ContentTypesItem { + public static final ContentTypesItem EMAIL = new ContentTypesItem(Value.EMAIL, "email"); + + public static final ContentTypesItem SMS_MESSAGE = new ContentTypesItem(Value.SMS_MESSAGE, "sms_message"); + + private final Value value; + + private final String string; + + ContentTypesItem(Value value, String string) { + this.value = value; + this.string = string; + } + + public Value getEnumValue() { + return value; + } + + @java.lang.Override + @JsonValue + public String toString() { + return this.string; + } + + @java.lang.Override + public boolean equals(Object other) { + return (this == other) + || (other instanceof ContentTypesItem && this.string.equals(((ContentTypesItem) other).string)); + } + + @java.lang.Override + public int hashCode() { + return this.string.hashCode(); + } + + public T visit(Visitor visitor) { + switch (value) { + case EMAIL: + return visitor.visitEmail(); + case SMS_MESSAGE: + return visitor.visitSmsMessage(); + case UNKNOWN: + default: + return visitor.visitUnknown(string); + } + } + + @JsonCreator(mode = JsonCreator.Mode.DELEGATING) + public static ContentTypesItem valueOf(String value) { + switch (value) { + case "email": + return EMAIL; + case "sms_message": + return SMS_MESSAGE; + default: + return new ContentTypesItem(Value.UNKNOWN, value); + } + } + + public enum Value { + EMAIL, + + SMS_MESSAGE, + + UNKNOWN + } + + public interface Visitor { + T visitEmail(); + + T visitSmsMessage(); + + T visitUnknown(String unknownType); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/tags/AsyncRawTagsClient.java b/src/main/java/com/intercom/api/resources/tags/AsyncRawTagsClient.java new file mode 100644 index 00000000..ae3102c0 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/tags/AsyncRawTagsClient.java @@ -0,0 +1,827 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.tags; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.IntercomApiException; +import com.intercom.api.core.IntercomException; +import com.intercom.api.core.IntercomHttpResponse; +import com.intercom.api.core.MediaTypes; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.errors.BadRequestError; +import com.intercom.api.errors.NotFoundError; +import com.intercom.api.errors.UnauthorizedError; +import com.intercom.api.resources.tags.requests.DeleteTagRequest; +import com.intercom.api.resources.tags.requests.FindTagRequest; +import com.intercom.api.resources.tags.requests.TagContactRequest; +import com.intercom.api.resources.tags.requests.TagConversationRequest; +import com.intercom.api.resources.tags.requests.TagTicketRequest; +import com.intercom.api.resources.tags.requests.UntagContactRequest; +import com.intercom.api.resources.tags.requests.UntagConversationRequest; +import com.intercom.api.resources.tags.requests.UntagTicketRequest; +import com.intercom.api.resources.tags.types.Tag; +import com.intercom.api.resources.tags.types.TagsCreateRequestBody; +import com.intercom.api.types.Error; +import com.intercom.api.types.TagList; +import java.io.IOException; +import java.util.concurrent.CompletableFuture; +import okhttp3.Call; +import okhttp3.Callback; +import okhttp3.Headers; +import okhttp3.HttpUrl; +import okhttp3.OkHttpClient; +import okhttp3.Request; +import okhttp3.RequestBody; +import okhttp3.Response; +import okhttp3.ResponseBody; +import org.jetbrains.annotations.NotNull; + +public class AsyncRawTagsClient { + protected final ClientOptions clientOptions; + + public AsyncRawTagsClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + } + + /** + * You can tag a specific contact. This will return a tag object for the tag that was added to the contact. + */ + public CompletableFuture> tagContact(TagContactRequest request) { + return tagContact(request, null); + } + + /** + * You can tag a specific contact. This will return a tag object for the tag that was added to the contact. + */ + public CompletableFuture> tagContact( + TagContactRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("contacts") + .addPathSegment(request.getContactId()) + .addPathSegments("tags") + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Tag.class), response)); + return; + } + try { + switch (response.code()) { + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 404: + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can remove tag from a specific contact. This will return a tag object for the tag that was removed from the contact. + */ + public CompletableFuture> untagContact(UntagContactRequest request) { + return untagContact(request, null); + } + + /** + * You can remove tag from a specific contact. This will return a tag object for the tag that was removed from the contact. + */ + public CompletableFuture> untagContact( + UntagContactRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("contacts") + .addPathSegment(request.getContactId()) + .addPathSegments("tags") + .addPathSegment(request.getTagId()) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("DELETE", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Tag.class), response)); + return; + } + try { + switch (response.code()) { + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 404: + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can tag a specific conversation. This will return a tag object for the tag that was added to the conversation. + */ + public CompletableFuture> tagConversation(TagConversationRequest request) { + return tagConversation(request, null); + } + + /** + * You can tag a specific conversation. This will return a tag object for the tag that was added to the conversation. + */ + public CompletableFuture> tagConversation( + TagConversationRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("conversations") + .addPathSegment(request.getConversationId()) + .addPathSegments("tags") + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Tag.class), response)); + return; + } + try { + switch (response.code()) { + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 404: + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can remove tag from a specific conversation. This will return a tag object for the tag that was removed from the conversation. + */ + public CompletableFuture> untagConversation(UntagConversationRequest request) { + return untagConversation(request, null); + } + + /** + * You can remove tag from a specific conversation. This will return a tag object for the tag that was removed from the conversation. + */ + public CompletableFuture> untagConversation( + UntagConversationRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("conversations") + .addPathSegment(request.getConversationId()) + .addPathSegments("tags") + .addPathSegment(request.getTagId()) + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("DELETE", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Tag.class), response)); + return; + } + try { + switch (response.code()) { + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 404: + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can fetch a list of all tags for a given workspace. + */ + public CompletableFuture> list() { + return list(null); + } + + /** + * You can fetch a list of all tags for a given workspace. + */ + public CompletableFuture> list(RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("tags") + .build(); + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, TagList.class), response)); + return; + } + try { + if (response.code() == 401) { + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can use this endpoint to perform the following operations: + *

1. Create a new tag: You can create a new tag by passing in the tag name as specified in "Create or Update Tag Request Payload" described below.

+ *

2. Update an existing tag: You can update an existing tag by passing the id of the tag as specified in "Create or Update Tag Request Payload" described below.

+ *

3. Tag Companies: You can tag single company or a list of companies. You can tag a company by passing in the tag name and the company details as specified in "Tag Company Request Payload" described below. Also, if the tag doesn't exist then a new one will be created automatically.

+ *

4. Untag Companies: You can untag a single company or a list of companies. You can untag a company by passing in the tag id and the company details as specified in "Untag Company Request Payload" described below.

+ *

5. Tag Multiple Users: You can tag a list of users. You can tag the users by passing in the tag name and the user details as specified in "Tag Users Request Payload" described below.

+ *

Each operation will return a tag object.

+ */ + public CompletableFuture> create(TagsCreateRequestBody request) { + return create(request, null); + } + + /** + * You can use this endpoint to perform the following operations: + *

1. Create a new tag: You can create a new tag by passing in the tag name as specified in "Create or Update Tag Request Payload" described below.

+ *

2. Update an existing tag: You can update an existing tag by passing the id of the tag as specified in "Create or Update Tag Request Payload" described below.

+ *

3. Tag Companies: You can tag single company or a list of companies. You can tag a company by passing in the tag name and the company details as specified in "Tag Company Request Payload" described below. Also, if the tag doesn't exist then a new one will be created automatically.

+ *

4. Untag Companies: You can untag a single company or a list of companies. You can untag a company by passing in the tag id and the company details as specified in "Untag Company Request Payload" described below.

+ *

5. Tag Multiple Users: You can tag a list of users. You can tag the users by passing in the tag name and the user details as specified in "Tag Users Request Payload" described below.

+ *

Each operation will return a tag object.

+ */ + public CompletableFuture> create( + TagsCreateRequestBody request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("tags") + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Tag.class), response)); + return; + } + try { + switch (response.code()) { + case 400: + future.completeExceptionally(new BadRequestError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 404: + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can fetch the details of tags that are on the workspace by their id. + * This will return a tag object. + */ + public CompletableFuture> find(FindTagRequest request) { + return find(request, null); + } + + /** + * You can fetch the details of tags that are on the workspace by their id. + * This will return a tag object. + */ + public CompletableFuture> find(FindTagRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("tags") + .addPathSegment(request.getTagId()) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Tag.class), response)); + return; + } + try { + switch (response.code()) { + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 404: + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can delete the details of tags that are on the workspace by passing in the id. + */ + public CompletableFuture> delete(DeleteTagRequest request) { + return delete(request, null); + } + + /** + * You can delete the details of tags that are on the workspace by passing in the id. + */ + public CompletableFuture> delete( + DeleteTagRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("tags") + .addPathSegment(request.getTagId()) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("DELETE", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>(null, response)); + return; + } + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + try { + switch (response.code()) { + case 400: + future.completeExceptionally(new BadRequestError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 404: + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can tag a specific ticket. This will return a tag object for the tag that was added to the ticket. + */ + public CompletableFuture> tagTicket(TagTicketRequest request) { + return tagTicket(request, null); + } + + /** + * You can tag a specific ticket. This will return a tag object for the tag that was added to the ticket. + */ + public CompletableFuture> tagTicket( + TagTicketRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("tickets") + .addPathSegment(request.getTicketId()) + .addPathSegments("tags") + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Tag.class), response)); + return; + } + try { + switch (response.code()) { + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 404: + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can remove tag from a specific ticket. This will return a tag object for the tag that was removed from the ticket. + */ + public CompletableFuture> untagTicket(UntagTicketRequest request) { + return untagTicket(request, null); + } + + /** + * You can remove tag from a specific ticket. This will return a tag object for the tag that was removed from the ticket. + */ + public CompletableFuture> untagTicket( + UntagTicketRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("tickets") + .addPathSegment(request.getTicketId()) + .addPathSegments("tags") + .addPathSegment(request.getTagId()) + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("DELETE", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Tag.class), response)); + return; + } + try { + switch (response.code()) { + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 404: + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } +} diff --git a/src/main/java/com/intercom/api/resources/tags/AsyncTagsClient.java b/src/main/java/com/intercom/api/resources/tags/AsyncTagsClient.java new file mode 100644 index 00000000..3eaee6e3 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/tags/AsyncTagsClient.java @@ -0,0 +1,191 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.tags; + +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.resources.tags.requests.DeleteTagRequest; +import com.intercom.api.resources.tags.requests.FindTagRequest; +import com.intercom.api.resources.tags.requests.TagContactRequest; +import com.intercom.api.resources.tags.requests.TagConversationRequest; +import com.intercom.api.resources.tags.requests.TagTicketRequest; +import com.intercom.api.resources.tags.requests.UntagContactRequest; +import com.intercom.api.resources.tags.requests.UntagConversationRequest; +import com.intercom.api.resources.tags.requests.UntagTicketRequest; +import com.intercom.api.resources.tags.types.Tag; +import com.intercom.api.resources.tags.types.TagsCreateRequestBody; +import com.intercom.api.types.TagList; +import java.util.concurrent.CompletableFuture; + +public class AsyncTagsClient { + protected final ClientOptions clientOptions; + + private final AsyncRawTagsClient rawClient; + + public AsyncTagsClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + this.rawClient = new AsyncRawTagsClient(clientOptions); + } + + /** + * Get responses with HTTP metadata like headers + */ + public AsyncRawTagsClient withRawResponse() { + return this.rawClient; + } + + /** + * You can tag a specific contact. This will return a tag object for the tag that was added to the contact. + */ + public CompletableFuture tagContact(TagContactRequest request) { + return this.rawClient.tagContact(request).thenApply(response -> response.body()); + } + + /** + * You can tag a specific contact. This will return a tag object for the tag that was added to the contact. + */ + public CompletableFuture tagContact(TagContactRequest request, RequestOptions requestOptions) { + return this.rawClient.tagContact(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can remove tag from a specific contact. This will return a tag object for the tag that was removed from the contact. + */ + public CompletableFuture untagContact(UntagContactRequest request) { + return this.rawClient.untagContact(request).thenApply(response -> response.body()); + } + + /** + * You can remove tag from a specific contact. This will return a tag object for the tag that was removed from the contact. + */ + public CompletableFuture untagContact(UntagContactRequest request, RequestOptions requestOptions) { + return this.rawClient.untagContact(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can tag a specific conversation. This will return a tag object for the tag that was added to the conversation. + */ + public CompletableFuture tagConversation(TagConversationRequest request) { + return this.rawClient.tagConversation(request).thenApply(response -> response.body()); + } + + /** + * You can tag a specific conversation. This will return a tag object for the tag that was added to the conversation. + */ + public CompletableFuture tagConversation(TagConversationRequest request, RequestOptions requestOptions) { + return this.rawClient.tagConversation(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can remove tag from a specific conversation. This will return a tag object for the tag that was removed from the conversation. + */ + public CompletableFuture untagConversation(UntagConversationRequest request) { + return this.rawClient.untagConversation(request).thenApply(response -> response.body()); + } + + /** + * You can remove tag from a specific conversation. This will return a tag object for the tag that was removed from the conversation. + */ + public CompletableFuture untagConversation(UntagConversationRequest request, RequestOptions requestOptions) { + return this.rawClient.untagConversation(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can fetch a list of all tags for a given workspace. + */ + public CompletableFuture list() { + return this.rawClient.list().thenApply(response -> response.body()); + } + + /** + * You can fetch a list of all tags for a given workspace. + */ + public CompletableFuture list(RequestOptions requestOptions) { + return this.rawClient.list(requestOptions).thenApply(response -> response.body()); + } + + /** + * You can use this endpoint to perform the following operations: + *

1. Create a new tag: You can create a new tag by passing in the tag name as specified in "Create or Update Tag Request Payload" described below.

+ *

2. Update an existing tag: You can update an existing tag by passing the id of the tag as specified in "Create or Update Tag Request Payload" described below.

+ *

3. Tag Companies: You can tag single company or a list of companies. You can tag a company by passing in the tag name and the company details as specified in "Tag Company Request Payload" described below. Also, if the tag doesn't exist then a new one will be created automatically.

+ *

4. Untag Companies: You can untag a single company or a list of companies. You can untag a company by passing in the tag id and the company details as specified in "Untag Company Request Payload" described below.

+ *

5. Tag Multiple Users: You can tag a list of users. You can tag the users by passing in the tag name and the user details as specified in "Tag Users Request Payload" described below.

+ *

Each operation will return a tag object.

+ */ + public CompletableFuture create(TagsCreateRequestBody request) { + return this.rawClient.create(request).thenApply(response -> response.body()); + } + + /** + * You can use this endpoint to perform the following operations: + *

1. Create a new tag: You can create a new tag by passing in the tag name as specified in "Create or Update Tag Request Payload" described below.

+ *

2. Update an existing tag: You can update an existing tag by passing the id of the tag as specified in "Create or Update Tag Request Payload" described below.

+ *

3. Tag Companies: You can tag single company or a list of companies. You can tag a company by passing in the tag name and the company details as specified in "Tag Company Request Payload" described below. Also, if the tag doesn't exist then a new one will be created automatically.

+ *

4. Untag Companies: You can untag a single company or a list of companies. You can untag a company by passing in the tag id and the company details as specified in "Untag Company Request Payload" described below.

+ *

5. Tag Multiple Users: You can tag a list of users. You can tag the users by passing in the tag name and the user details as specified in "Tag Users Request Payload" described below.

+ *

Each operation will return a tag object.

+ */ + public CompletableFuture create(TagsCreateRequestBody request, RequestOptions requestOptions) { + return this.rawClient.create(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can fetch the details of tags that are on the workspace by their id. + * This will return a tag object. + */ + public CompletableFuture find(FindTagRequest request) { + return this.rawClient.find(request).thenApply(response -> response.body()); + } + + /** + * You can fetch the details of tags that are on the workspace by their id. + * This will return a tag object. + */ + public CompletableFuture find(FindTagRequest request, RequestOptions requestOptions) { + return this.rawClient.find(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can delete the details of tags that are on the workspace by passing in the id. + */ + public CompletableFuture delete(DeleteTagRequest request) { + return this.rawClient.delete(request).thenApply(response -> response.body()); + } + + /** + * You can delete the details of tags that are on the workspace by passing in the id. + */ + public CompletableFuture delete(DeleteTagRequest request, RequestOptions requestOptions) { + return this.rawClient.delete(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can tag a specific ticket. This will return a tag object for the tag that was added to the ticket. + */ + public CompletableFuture tagTicket(TagTicketRequest request) { + return this.rawClient.tagTicket(request).thenApply(response -> response.body()); + } + + /** + * You can tag a specific ticket. This will return a tag object for the tag that was added to the ticket. + */ + public CompletableFuture tagTicket(TagTicketRequest request, RequestOptions requestOptions) { + return this.rawClient.tagTicket(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can remove tag from a specific ticket. This will return a tag object for the tag that was removed from the ticket. + */ + public CompletableFuture untagTicket(UntagTicketRequest request) { + return this.rawClient.untagTicket(request).thenApply(response -> response.body()); + } + + /** + * You can remove tag from a specific ticket. This will return a tag object for the tag that was removed from the ticket. + */ + public CompletableFuture untagTicket(UntagTicketRequest request, RequestOptions requestOptions) { + return this.rawClient.untagTicket(request, requestOptions).thenApply(response -> response.body()); + } +} diff --git a/src/main/java/com/intercom/api/resources/tags/RawTagsClient.java b/src/main/java/com/intercom/api/resources/tags/RawTagsClient.java new file mode 100644 index 00000000..32b8734b --- /dev/null +++ b/src/main/java/com/intercom/api/resources/tags/RawTagsClient.java @@ -0,0 +1,645 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.tags; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.IntercomApiException; +import com.intercom.api.core.IntercomException; +import com.intercom.api.core.IntercomHttpResponse; +import com.intercom.api.core.MediaTypes; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.errors.BadRequestError; +import com.intercom.api.errors.NotFoundError; +import com.intercom.api.errors.UnauthorizedError; +import com.intercom.api.resources.tags.requests.DeleteTagRequest; +import com.intercom.api.resources.tags.requests.FindTagRequest; +import com.intercom.api.resources.tags.requests.TagContactRequest; +import com.intercom.api.resources.tags.requests.TagConversationRequest; +import com.intercom.api.resources.tags.requests.TagTicketRequest; +import com.intercom.api.resources.tags.requests.UntagContactRequest; +import com.intercom.api.resources.tags.requests.UntagConversationRequest; +import com.intercom.api.resources.tags.requests.UntagTicketRequest; +import com.intercom.api.resources.tags.types.Tag; +import com.intercom.api.resources.tags.types.TagsCreateRequestBody; +import com.intercom.api.types.Error; +import com.intercom.api.types.TagList; +import java.io.IOException; +import okhttp3.Headers; +import okhttp3.HttpUrl; +import okhttp3.OkHttpClient; +import okhttp3.Request; +import okhttp3.RequestBody; +import okhttp3.Response; +import okhttp3.ResponseBody; + +public class RawTagsClient { + protected final ClientOptions clientOptions; + + public RawTagsClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + } + + /** + * You can tag a specific contact. This will return a tag object for the tag that was added to the contact. + */ + public IntercomHttpResponse tagContact(TagContactRequest request) { + return tagContact(request, null); + } + + /** + * You can tag a specific contact. This will return a tag object for the tag that was added to the contact. + */ + public IntercomHttpResponse tagContact(TagContactRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("contacts") + .addPathSegment(request.getContactId()) + .addPathSegments("tags") + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Tag.class), response); + } + try { + switch (response.code()) { + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 404: + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can remove tag from a specific contact. This will return a tag object for the tag that was removed from the contact. + */ + public IntercomHttpResponse untagContact(UntagContactRequest request) { + return untagContact(request, null); + } + + /** + * You can remove tag from a specific contact. This will return a tag object for the tag that was removed from the contact. + */ + public IntercomHttpResponse untagContact(UntagContactRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("contacts") + .addPathSegment(request.getContactId()) + .addPathSegments("tags") + .addPathSegment(request.getTagId()) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("DELETE", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Tag.class), response); + } + try { + switch (response.code()) { + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 404: + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can tag a specific conversation. This will return a tag object for the tag that was added to the conversation. + */ + public IntercomHttpResponse tagConversation(TagConversationRequest request) { + return tagConversation(request, null); + } + + /** + * You can tag a specific conversation. This will return a tag object for the tag that was added to the conversation. + */ + public IntercomHttpResponse tagConversation(TagConversationRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("conversations") + .addPathSegment(request.getConversationId()) + .addPathSegments("tags") + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Tag.class), response); + } + try { + switch (response.code()) { + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 404: + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can remove tag from a specific conversation. This will return a tag object for the tag that was removed from the conversation. + */ + public IntercomHttpResponse untagConversation(UntagConversationRequest request) { + return untagConversation(request, null); + } + + /** + * You can remove tag from a specific conversation. This will return a tag object for the tag that was removed from the conversation. + */ + public IntercomHttpResponse untagConversation( + UntagConversationRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("conversations") + .addPathSegment(request.getConversationId()) + .addPathSegments("tags") + .addPathSegment(request.getTagId()) + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("DELETE", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Tag.class), response); + } + try { + switch (response.code()) { + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 404: + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can fetch a list of all tags for a given workspace. + */ + public IntercomHttpResponse list() { + return list(null); + } + + /** + * You can fetch a list of all tags for a given workspace. + */ + public IntercomHttpResponse list(RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("tags") + .build(); + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, TagList.class), response); + } + try { + if (response.code() == 401) { + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can use this endpoint to perform the following operations: + *

1. Create a new tag: You can create a new tag by passing in the tag name as specified in "Create or Update Tag Request Payload" described below.

+ *

2. Update an existing tag: You can update an existing tag by passing the id of the tag as specified in "Create or Update Tag Request Payload" described below.

+ *

3. Tag Companies: You can tag single company or a list of companies. You can tag a company by passing in the tag name and the company details as specified in "Tag Company Request Payload" described below. Also, if the tag doesn't exist then a new one will be created automatically.

+ *

4. Untag Companies: You can untag a single company or a list of companies. You can untag a company by passing in the tag id and the company details as specified in "Untag Company Request Payload" described below.

+ *

5. Tag Multiple Users: You can tag a list of users. You can tag the users by passing in the tag name and the user details as specified in "Tag Users Request Payload" described below.

+ *

Each operation will return a tag object.

+ */ + public IntercomHttpResponse create(TagsCreateRequestBody request) { + return create(request, null); + } + + /** + * You can use this endpoint to perform the following operations: + *

1. Create a new tag: You can create a new tag by passing in the tag name as specified in "Create or Update Tag Request Payload" described below.

+ *

2. Update an existing tag: You can update an existing tag by passing the id of the tag as specified in "Create or Update Tag Request Payload" described below.

+ *

3. Tag Companies: You can tag single company or a list of companies. You can tag a company by passing in the tag name and the company details as specified in "Tag Company Request Payload" described below. Also, if the tag doesn't exist then a new one will be created automatically.

+ *

4. Untag Companies: You can untag a single company or a list of companies. You can untag a company by passing in the tag id and the company details as specified in "Untag Company Request Payload" described below.

+ *

5. Tag Multiple Users: You can tag a list of users. You can tag the users by passing in the tag name and the user details as specified in "Tag Users Request Payload" described below.

+ *

Each operation will return a tag object.

+ */ + public IntercomHttpResponse create(TagsCreateRequestBody request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("tags") + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Tag.class), response); + } + try { + switch (response.code()) { + case 400: + throw new BadRequestError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 404: + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can fetch the details of tags that are on the workspace by their id. + * This will return a tag object. + */ + public IntercomHttpResponse find(FindTagRequest request) { + return find(request, null); + } + + /** + * You can fetch the details of tags that are on the workspace by their id. + * This will return a tag object. + */ + public IntercomHttpResponse find(FindTagRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("tags") + .addPathSegment(request.getTagId()) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Tag.class), response); + } + try { + switch (response.code()) { + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 404: + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can delete the details of tags that are on the workspace by passing in the id. + */ + public IntercomHttpResponse delete(DeleteTagRequest request) { + return delete(request, null); + } + + /** + * You can delete the details of tags that are on the workspace by passing in the id. + */ + public IntercomHttpResponse delete(DeleteTagRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("tags") + .addPathSegment(request.getTagId()) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("DELETE", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + if (response.isSuccessful()) { + return new IntercomHttpResponse<>(null, response); + } + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + try { + switch (response.code()) { + case 400: + throw new BadRequestError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 404: + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can tag a specific ticket. This will return a tag object for the tag that was added to the ticket. + */ + public IntercomHttpResponse tagTicket(TagTicketRequest request) { + return tagTicket(request, null); + } + + /** + * You can tag a specific ticket. This will return a tag object for the tag that was added to the ticket. + */ + public IntercomHttpResponse tagTicket(TagTicketRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("tickets") + .addPathSegment(request.getTicketId()) + .addPathSegments("tags") + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Tag.class), response); + } + try { + switch (response.code()) { + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 404: + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can remove tag from a specific ticket. This will return a tag object for the tag that was removed from the ticket. + */ + public IntercomHttpResponse untagTicket(UntagTicketRequest request) { + return untagTicket(request, null); + } + + /** + * You can remove tag from a specific ticket. This will return a tag object for the tag that was removed from the ticket. + */ + public IntercomHttpResponse untagTicket(UntagTicketRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("tickets") + .addPathSegment(request.getTicketId()) + .addPathSegments("tags") + .addPathSegment(request.getTagId()) + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("DELETE", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Tag.class), response); + } + try { + switch (response.code()) { + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 404: + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/tags/TagsClient.java b/src/main/java/com/intercom/api/resources/tags/TagsClient.java new file mode 100644 index 00000000..e3b5d844 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/tags/TagsClient.java @@ -0,0 +1,190 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.tags; + +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.resources.tags.requests.DeleteTagRequest; +import com.intercom.api.resources.tags.requests.FindTagRequest; +import com.intercom.api.resources.tags.requests.TagContactRequest; +import com.intercom.api.resources.tags.requests.TagConversationRequest; +import com.intercom.api.resources.tags.requests.TagTicketRequest; +import com.intercom.api.resources.tags.requests.UntagContactRequest; +import com.intercom.api.resources.tags.requests.UntagConversationRequest; +import com.intercom.api.resources.tags.requests.UntagTicketRequest; +import com.intercom.api.resources.tags.types.Tag; +import com.intercom.api.resources.tags.types.TagsCreateRequestBody; +import com.intercom.api.types.TagList; + +public class TagsClient { + protected final ClientOptions clientOptions; + + private final RawTagsClient rawClient; + + public TagsClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + this.rawClient = new RawTagsClient(clientOptions); + } + + /** + * Get responses with HTTP metadata like headers + */ + public RawTagsClient withRawResponse() { + return this.rawClient; + } + + /** + * You can tag a specific contact. This will return a tag object for the tag that was added to the contact. + */ + public Tag tagContact(TagContactRequest request) { + return this.rawClient.tagContact(request).body(); + } + + /** + * You can tag a specific contact. This will return a tag object for the tag that was added to the contact. + */ + public Tag tagContact(TagContactRequest request, RequestOptions requestOptions) { + return this.rawClient.tagContact(request, requestOptions).body(); + } + + /** + * You can remove tag from a specific contact. This will return a tag object for the tag that was removed from the contact. + */ + public Tag untagContact(UntagContactRequest request) { + return this.rawClient.untagContact(request).body(); + } + + /** + * You can remove tag from a specific contact. This will return a tag object for the tag that was removed from the contact. + */ + public Tag untagContact(UntagContactRequest request, RequestOptions requestOptions) { + return this.rawClient.untagContact(request, requestOptions).body(); + } + + /** + * You can tag a specific conversation. This will return a tag object for the tag that was added to the conversation. + */ + public Tag tagConversation(TagConversationRequest request) { + return this.rawClient.tagConversation(request).body(); + } + + /** + * You can tag a specific conversation. This will return a tag object for the tag that was added to the conversation. + */ + public Tag tagConversation(TagConversationRequest request, RequestOptions requestOptions) { + return this.rawClient.tagConversation(request, requestOptions).body(); + } + + /** + * You can remove tag from a specific conversation. This will return a tag object for the tag that was removed from the conversation. + */ + public Tag untagConversation(UntagConversationRequest request) { + return this.rawClient.untagConversation(request).body(); + } + + /** + * You can remove tag from a specific conversation. This will return a tag object for the tag that was removed from the conversation. + */ + public Tag untagConversation(UntagConversationRequest request, RequestOptions requestOptions) { + return this.rawClient.untagConversation(request, requestOptions).body(); + } + + /** + * You can fetch a list of all tags for a given workspace. + */ + public TagList list() { + return this.rawClient.list().body(); + } + + /** + * You can fetch a list of all tags for a given workspace. + */ + public TagList list(RequestOptions requestOptions) { + return this.rawClient.list(requestOptions).body(); + } + + /** + * You can use this endpoint to perform the following operations: + *

1. Create a new tag: You can create a new tag by passing in the tag name as specified in "Create or Update Tag Request Payload" described below.

+ *

2. Update an existing tag: You can update an existing tag by passing the id of the tag as specified in "Create or Update Tag Request Payload" described below.

+ *

3. Tag Companies: You can tag single company or a list of companies. You can tag a company by passing in the tag name and the company details as specified in "Tag Company Request Payload" described below. Also, if the tag doesn't exist then a new one will be created automatically.

+ *

4. Untag Companies: You can untag a single company or a list of companies. You can untag a company by passing in the tag id and the company details as specified in "Untag Company Request Payload" described below.

+ *

5. Tag Multiple Users: You can tag a list of users. You can tag the users by passing in the tag name and the user details as specified in "Tag Users Request Payload" described below.

+ *

Each operation will return a tag object.

+ */ + public Tag create(TagsCreateRequestBody request) { + return this.rawClient.create(request).body(); + } + + /** + * You can use this endpoint to perform the following operations: + *

1. Create a new tag: You can create a new tag by passing in the tag name as specified in "Create or Update Tag Request Payload" described below.

+ *

2. Update an existing tag: You can update an existing tag by passing the id of the tag as specified in "Create or Update Tag Request Payload" described below.

+ *

3. Tag Companies: You can tag single company or a list of companies. You can tag a company by passing in the tag name and the company details as specified in "Tag Company Request Payload" described below. Also, if the tag doesn't exist then a new one will be created automatically.

+ *

4. Untag Companies: You can untag a single company or a list of companies. You can untag a company by passing in the tag id and the company details as specified in "Untag Company Request Payload" described below.

+ *

5. Tag Multiple Users: You can tag a list of users. You can tag the users by passing in the tag name and the user details as specified in "Tag Users Request Payload" described below.

+ *

Each operation will return a tag object.

+ */ + public Tag create(TagsCreateRequestBody request, RequestOptions requestOptions) { + return this.rawClient.create(request, requestOptions).body(); + } + + /** + * You can fetch the details of tags that are on the workspace by their id. + * This will return a tag object. + */ + public Tag find(FindTagRequest request) { + return this.rawClient.find(request).body(); + } + + /** + * You can fetch the details of tags that are on the workspace by their id. + * This will return a tag object. + */ + public Tag find(FindTagRequest request, RequestOptions requestOptions) { + return this.rawClient.find(request, requestOptions).body(); + } + + /** + * You can delete the details of tags that are on the workspace by passing in the id. + */ + public void delete(DeleteTagRequest request) { + this.rawClient.delete(request).body(); + } + + /** + * You can delete the details of tags that are on the workspace by passing in the id. + */ + public void delete(DeleteTagRequest request, RequestOptions requestOptions) { + this.rawClient.delete(request, requestOptions).body(); + } + + /** + * You can tag a specific ticket. This will return a tag object for the tag that was added to the ticket. + */ + public Tag tagTicket(TagTicketRequest request) { + return this.rawClient.tagTicket(request).body(); + } + + /** + * You can tag a specific ticket. This will return a tag object for the tag that was added to the ticket. + */ + public Tag tagTicket(TagTicketRequest request, RequestOptions requestOptions) { + return this.rawClient.tagTicket(request, requestOptions).body(); + } + + /** + * You can remove tag from a specific ticket. This will return a tag object for the tag that was removed from the ticket. + */ + public Tag untagTicket(UntagTicketRequest request) { + return this.rawClient.untagTicket(request).body(); + } + + /** + * You can remove tag from a specific ticket. This will return a tag object for the tag that was removed from the ticket. + */ + public Tag untagTicket(UntagTicketRequest request, RequestOptions requestOptions) { + return this.rawClient.untagTicket(request, requestOptions).body(); + } +} diff --git a/src/main/java/com/intercom/api/resources/tags/requests/DeleteTagRequest.java b/src/main/java/com/intercom/api/resources/tags/requests/DeleteTagRequest.java new file mode 100644 index 00000000..0fea2a0a --- /dev/null +++ b/src/main/java/com/intercom/api/resources/tags/requests/DeleteTagRequest.java @@ -0,0 +1,113 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.tags.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = DeleteTagRequest.Builder.class) +public final class DeleteTagRequest { + private final String tagId; + + private final Map additionalProperties; + + private DeleteTagRequest(String tagId, Map additionalProperties) { + this.tagId = tagId; + this.additionalProperties = additionalProperties; + } + + /** + * @return The unique identifier of a given tag + */ + @JsonProperty("tag_id") + public String getTagId() { + return tagId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof DeleteTagRequest && equalTo((DeleteTagRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(DeleteTagRequest other) { + return tagId.equals(other.tagId); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.tagId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static TagIdStage builder() { + return new Builder(); + } + + public interface TagIdStage { + /** + *

The unique identifier of a given tag

+ */ + _FinalStage tagId(@NotNull String tagId); + + Builder from(DeleteTagRequest other); + } + + public interface _FinalStage { + DeleteTagRequest build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements TagIdStage, _FinalStage { + private String tagId; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(DeleteTagRequest other) { + tagId(other.getTagId()); + return this; + } + + /** + *

The unique identifier of a given tag

+ *

The unique identifier of a given tag

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("tag_id") + public _FinalStage tagId(@NotNull String tagId) { + this.tagId = Objects.requireNonNull(tagId, "tagId must not be null"); + return this; + } + + @java.lang.Override + public DeleteTagRequest build() { + return new DeleteTagRequest(tagId, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/tags/requests/FindTagRequest.java b/src/main/java/com/intercom/api/resources/tags/requests/FindTagRequest.java new file mode 100644 index 00000000..51f6efc6 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/tags/requests/FindTagRequest.java @@ -0,0 +1,113 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.tags.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = FindTagRequest.Builder.class) +public final class FindTagRequest { + private final String tagId; + + private final Map additionalProperties; + + private FindTagRequest(String tagId, Map additionalProperties) { + this.tagId = tagId; + this.additionalProperties = additionalProperties; + } + + /** + * @return The unique identifier of a given tag + */ + @JsonProperty("tag_id") + public String getTagId() { + return tagId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof FindTagRequest && equalTo((FindTagRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(FindTagRequest other) { + return tagId.equals(other.tagId); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.tagId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static TagIdStage builder() { + return new Builder(); + } + + public interface TagIdStage { + /** + *

The unique identifier of a given tag

+ */ + _FinalStage tagId(@NotNull String tagId); + + Builder from(FindTagRequest other); + } + + public interface _FinalStage { + FindTagRequest build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements TagIdStage, _FinalStage { + private String tagId; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(FindTagRequest other) { + tagId(other.getTagId()); + return this; + } + + /** + *

The unique identifier of a given tag

+ *

The unique identifier of a given tag

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("tag_id") + public _FinalStage tagId(@NotNull String tagId) { + this.tagId = Objects.requireNonNull(tagId, "tagId must not be null"); + return this; + } + + @java.lang.Override + public FindTagRequest build() { + return new FindTagRequest(tagId, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/tags/requests/TagContactRequest.java b/src/main/java/com/intercom/api/resources/tags/requests/TagContactRequest.java new file mode 100644 index 00000000..a3c32c1d --- /dev/null +++ b/src/main/java/com/intercom/api/resources/tags/requests/TagContactRequest.java @@ -0,0 +1,146 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.tags.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = TagContactRequest.Builder.class) +public final class TagContactRequest { + private final String contactId; + + private final String tagId; + + private final Map additionalProperties; + + private TagContactRequest(String contactId, String tagId, Map additionalProperties) { + this.contactId = contactId; + this.tagId = tagId; + this.additionalProperties = additionalProperties; + } + + /** + * @return The unique identifier for the contact which is given by Intercom + */ + @JsonProperty("contact_id") + public String getContactId() { + return contactId; + } + + /** + * @return The unique identifier for the tag which is given by Intercom + */ + @JsonProperty("id") + public String getTagId() { + return tagId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof TagContactRequest && equalTo((TagContactRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(TagContactRequest other) { + return contactId.equals(other.contactId) && tagId.equals(other.tagId); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.contactId, this.tagId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static ContactIdStage builder() { + return new Builder(); + } + + public interface ContactIdStage { + /** + *

The unique identifier for the contact which is given by Intercom

+ */ + TagIdStage contactId(@NotNull String contactId); + + Builder from(TagContactRequest other); + } + + public interface TagIdStage { + /** + *

The unique identifier for the tag which is given by Intercom

+ */ + _FinalStage tagId(@NotNull String tagId); + } + + public interface _FinalStage { + TagContactRequest build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements ContactIdStage, TagIdStage, _FinalStage { + private String contactId; + + private String tagId; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(TagContactRequest other) { + contactId(other.getContactId()); + tagId(other.getTagId()); + return this; + } + + /** + *

The unique identifier for the contact which is given by Intercom

+ *

The unique identifier for the contact which is given by Intercom

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("contact_id") + public TagIdStage contactId(@NotNull String contactId) { + this.contactId = Objects.requireNonNull(contactId, "contactId must not be null"); + return this; + } + + /** + *

The unique identifier for the tag which is given by Intercom

+ *

The unique identifier for the tag which is given by Intercom

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("id") + public _FinalStage tagId(@NotNull String tagId) { + this.tagId = Objects.requireNonNull(tagId, "tagId must not be null"); + return this; + } + + @java.lang.Override + public TagContactRequest build() { + return new TagContactRequest(contactId, tagId, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/tags/requests/TagConversationRequest.java b/src/main/java/com/intercom/api/resources/tags/requests/TagConversationRequest.java new file mode 100644 index 00000000..a35679f9 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/tags/requests/TagConversationRequest.java @@ -0,0 +1,182 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.tags.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = TagConversationRequest.Builder.class) +public final class TagConversationRequest { + private final String conversationId; + + private final String tagId; + + private final String adminId; + + private final Map additionalProperties; + + private TagConversationRequest( + String conversationId, String tagId, String adminId, Map additionalProperties) { + this.conversationId = conversationId; + this.tagId = tagId; + this.adminId = adminId; + this.additionalProperties = additionalProperties; + } + + /** + * @return conversation_id + */ + @JsonProperty("conversation_id") + public String getConversationId() { + return conversationId; + } + + /** + * @return The unique identifier for the tag which is given by Intercom + */ + @JsonProperty("id") + public String getTagId() { + return tagId; + } + + /** + * @return The unique identifier for the admin which is given by Intercom. + */ + @JsonProperty("admin_id") + public String getAdminId() { + return adminId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof TagConversationRequest && equalTo((TagConversationRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(TagConversationRequest other) { + return conversationId.equals(other.conversationId) + && tagId.equals(other.tagId) + && adminId.equals(other.adminId); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.conversationId, this.tagId, this.adminId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static ConversationIdStage builder() { + return new Builder(); + } + + public interface ConversationIdStage { + /** + *

conversation_id

+ */ + TagIdStage conversationId(@NotNull String conversationId); + + Builder from(TagConversationRequest other); + } + + public interface TagIdStage { + /** + *

The unique identifier for the tag which is given by Intercom

+ */ + AdminIdStage tagId(@NotNull String tagId); + } + + public interface AdminIdStage { + /** + *

The unique identifier for the admin which is given by Intercom.

+ */ + _FinalStage adminId(@NotNull String adminId); + } + + public interface _FinalStage { + TagConversationRequest build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements ConversationIdStage, TagIdStage, AdminIdStage, _FinalStage { + private String conversationId; + + private String tagId; + + private String adminId; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(TagConversationRequest other) { + conversationId(other.getConversationId()); + tagId(other.getTagId()); + adminId(other.getAdminId()); + return this; + } + + /** + *

conversation_id

+ *

conversation_id

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("conversation_id") + public TagIdStage conversationId(@NotNull String conversationId) { + this.conversationId = Objects.requireNonNull(conversationId, "conversationId must not be null"); + return this; + } + + /** + *

The unique identifier for the tag which is given by Intercom

+ *

The unique identifier for the tag which is given by Intercom

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("id") + public AdminIdStage tagId(@NotNull String tagId) { + this.tagId = Objects.requireNonNull(tagId, "tagId must not be null"); + return this; + } + + /** + *

The unique identifier for the admin which is given by Intercom.

+ *

The unique identifier for the admin which is given by Intercom.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("admin_id") + public _FinalStage adminId(@NotNull String adminId) { + this.adminId = Objects.requireNonNull(adminId, "adminId must not be null"); + return this; + } + + @java.lang.Override + public TagConversationRequest build() { + return new TagConversationRequest(conversationId, tagId, adminId, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/tags/requests/TagTicketRequest.java b/src/main/java/com/intercom/api/resources/tags/requests/TagTicketRequest.java new file mode 100644 index 00000000..73aa957d --- /dev/null +++ b/src/main/java/com/intercom/api/resources/tags/requests/TagTicketRequest.java @@ -0,0 +1,179 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.tags.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = TagTicketRequest.Builder.class) +public final class TagTicketRequest { + private final String ticketId; + + private final String tagId; + + private final String adminId; + + private final Map additionalProperties; + + private TagTicketRequest(String ticketId, String tagId, String adminId, Map additionalProperties) { + this.ticketId = ticketId; + this.tagId = tagId; + this.adminId = adminId; + this.additionalProperties = additionalProperties; + } + + /** + * @return ticket_id + */ + @JsonProperty("ticket_id") + public String getTicketId() { + return ticketId; + } + + /** + * @return The unique identifier for the tag which is given by Intercom + */ + @JsonProperty("id") + public String getTagId() { + return tagId; + } + + /** + * @return The unique identifier for the admin which is given by Intercom. + */ + @JsonProperty("admin_id") + public String getAdminId() { + return adminId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof TagTicketRequest && equalTo((TagTicketRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(TagTicketRequest other) { + return ticketId.equals(other.ticketId) && tagId.equals(other.tagId) && adminId.equals(other.adminId); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.ticketId, this.tagId, this.adminId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static TicketIdStage builder() { + return new Builder(); + } + + public interface TicketIdStage { + /** + *

ticket_id

+ */ + TagIdStage ticketId(@NotNull String ticketId); + + Builder from(TagTicketRequest other); + } + + public interface TagIdStage { + /** + *

The unique identifier for the tag which is given by Intercom

+ */ + AdminIdStage tagId(@NotNull String tagId); + } + + public interface AdminIdStage { + /** + *

The unique identifier for the admin which is given by Intercom.

+ */ + _FinalStage adminId(@NotNull String adminId); + } + + public interface _FinalStage { + TagTicketRequest build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements TicketIdStage, TagIdStage, AdminIdStage, _FinalStage { + private String ticketId; + + private String tagId; + + private String adminId; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(TagTicketRequest other) { + ticketId(other.getTicketId()); + tagId(other.getTagId()); + adminId(other.getAdminId()); + return this; + } + + /** + *

ticket_id

+ *

ticket_id

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("ticket_id") + public TagIdStage ticketId(@NotNull String ticketId) { + this.ticketId = Objects.requireNonNull(ticketId, "ticketId must not be null"); + return this; + } + + /** + *

The unique identifier for the tag which is given by Intercom

+ *

The unique identifier for the tag which is given by Intercom

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("id") + public AdminIdStage tagId(@NotNull String tagId) { + this.tagId = Objects.requireNonNull(tagId, "tagId must not be null"); + return this; + } + + /** + *

The unique identifier for the admin which is given by Intercom.

+ *

The unique identifier for the admin which is given by Intercom.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("admin_id") + public _FinalStage adminId(@NotNull String adminId) { + this.adminId = Objects.requireNonNull(adminId, "adminId must not be null"); + return this; + } + + @java.lang.Override + public TagTicketRequest build() { + return new TagTicketRequest(ticketId, tagId, adminId, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/tags/requests/UntagContactRequest.java b/src/main/java/com/intercom/api/resources/tags/requests/UntagContactRequest.java new file mode 100644 index 00000000..6d28a6c0 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/tags/requests/UntagContactRequest.java @@ -0,0 +1,146 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.tags.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = UntagContactRequest.Builder.class) +public final class UntagContactRequest { + private final String contactId; + + private final String tagId; + + private final Map additionalProperties; + + private UntagContactRequest(String contactId, String tagId, Map additionalProperties) { + this.contactId = contactId; + this.tagId = tagId; + this.additionalProperties = additionalProperties; + } + + /** + * @return The unique identifier for the contact which is given by Intercom + */ + @JsonProperty("contact_id") + public String getContactId() { + return contactId; + } + + /** + * @return The unique identifier for the tag which is given by Intercom + */ + @JsonProperty("tag_id") + public String getTagId() { + return tagId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof UntagContactRequest && equalTo((UntagContactRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(UntagContactRequest other) { + return contactId.equals(other.contactId) && tagId.equals(other.tagId); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.contactId, this.tagId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static ContactIdStage builder() { + return new Builder(); + } + + public interface ContactIdStage { + /** + *

The unique identifier for the contact which is given by Intercom

+ */ + TagIdStage contactId(@NotNull String contactId); + + Builder from(UntagContactRequest other); + } + + public interface TagIdStage { + /** + *

The unique identifier for the tag which is given by Intercom

+ */ + _FinalStage tagId(@NotNull String tagId); + } + + public interface _FinalStage { + UntagContactRequest build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements ContactIdStage, TagIdStage, _FinalStage { + private String contactId; + + private String tagId; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(UntagContactRequest other) { + contactId(other.getContactId()); + tagId(other.getTagId()); + return this; + } + + /** + *

The unique identifier for the contact which is given by Intercom

+ *

The unique identifier for the contact which is given by Intercom

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("contact_id") + public TagIdStage contactId(@NotNull String contactId) { + this.contactId = Objects.requireNonNull(contactId, "contactId must not be null"); + return this; + } + + /** + *

The unique identifier for the tag which is given by Intercom

+ *

The unique identifier for the tag which is given by Intercom

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("tag_id") + public _FinalStage tagId(@NotNull String tagId) { + this.tagId = Objects.requireNonNull(tagId, "tagId must not be null"); + return this; + } + + @java.lang.Override + public UntagContactRequest build() { + return new UntagContactRequest(contactId, tagId, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/tags/requests/UntagConversationRequest.java b/src/main/java/com/intercom/api/resources/tags/requests/UntagConversationRequest.java new file mode 100644 index 00000000..8c3ca120 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/tags/requests/UntagConversationRequest.java @@ -0,0 +1,182 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.tags.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = UntagConversationRequest.Builder.class) +public final class UntagConversationRequest { + private final String conversationId; + + private final String tagId; + + private final String adminId; + + private final Map additionalProperties; + + private UntagConversationRequest( + String conversationId, String tagId, String adminId, Map additionalProperties) { + this.conversationId = conversationId; + this.tagId = tagId; + this.adminId = adminId; + this.additionalProperties = additionalProperties; + } + + /** + * @return conversation_id + */ + @JsonProperty("conversation_id") + public String getConversationId() { + return conversationId; + } + + /** + * @return tag_id + */ + @JsonProperty("tag_id") + public String getTagId() { + return tagId; + } + + /** + * @return The unique identifier for the admin which is given by Intercom. + */ + @JsonProperty("admin_id") + public String getAdminId() { + return adminId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof UntagConversationRequest && equalTo((UntagConversationRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(UntagConversationRequest other) { + return conversationId.equals(other.conversationId) + && tagId.equals(other.tagId) + && adminId.equals(other.adminId); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.conversationId, this.tagId, this.adminId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static ConversationIdStage builder() { + return new Builder(); + } + + public interface ConversationIdStage { + /** + *

conversation_id

+ */ + TagIdStage conversationId(@NotNull String conversationId); + + Builder from(UntagConversationRequest other); + } + + public interface TagIdStage { + /** + *

tag_id

+ */ + AdminIdStage tagId(@NotNull String tagId); + } + + public interface AdminIdStage { + /** + *

The unique identifier for the admin which is given by Intercom.

+ */ + _FinalStage adminId(@NotNull String adminId); + } + + public interface _FinalStage { + UntagConversationRequest build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements ConversationIdStage, TagIdStage, AdminIdStage, _FinalStage { + private String conversationId; + + private String tagId; + + private String adminId; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(UntagConversationRequest other) { + conversationId(other.getConversationId()); + tagId(other.getTagId()); + adminId(other.getAdminId()); + return this; + } + + /** + *

conversation_id

+ *

conversation_id

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("conversation_id") + public TagIdStage conversationId(@NotNull String conversationId) { + this.conversationId = Objects.requireNonNull(conversationId, "conversationId must not be null"); + return this; + } + + /** + *

tag_id

+ *

tag_id

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("tag_id") + public AdminIdStage tagId(@NotNull String tagId) { + this.tagId = Objects.requireNonNull(tagId, "tagId must not be null"); + return this; + } + + /** + *

The unique identifier for the admin which is given by Intercom.

+ *

The unique identifier for the admin which is given by Intercom.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("admin_id") + public _FinalStage adminId(@NotNull String adminId) { + this.adminId = Objects.requireNonNull(adminId, "adminId must not be null"); + return this; + } + + @java.lang.Override + public UntagConversationRequest build() { + return new UntagConversationRequest(conversationId, tagId, adminId, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/tags/requests/UntagTicketRequest.java b/src/main/java/com/intercom/api/resources/tags/requests/UntagTicketRequest.java new file mode 100644 index 00000000..655c0335 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/tags/requests/UntagTicketRequest.java @@ -0,0 +1,180 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.tags.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = UntagTicketRequest.Builder.class) +public final class UntagTicketRequest { + private final String ticketId; + + private final String tagId; + + private final String adminId; + + private final Map additionalProperties; + + private UntagTicketRequest( + String ticketId, String tagId, String adminId, Map additionalProperties) { + this.ticketId = ticketId; + this.tagId = tagId; + this.adminId = adminId; + this.additionalProperties = additionalProperties; + } + + /** + * @return ticket_id + */ + @JsonProperty("ticket_id") + public String getTicketId() { + return ticketId; + } + + /** + * @return The unique identifier for the tag which is given by Intercom + */ + @JsonProperty("tag_id") + public String getTagId() { + return tagId; + } + + /** + * @return The unique identifier for the admin which is given by Intercom. + */ + @JsonProperty("admin_id") + public String getAdminId() { + return adminId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof UntagTicketRequest && equalTo((UntagTicketRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(UntagTicketRequest other) { + return ticketId.equals(other.ticketId) && tagId.equals(other.tagId) && adminId.equals(other.adminId); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.ticketId, this.tagId, this.adminId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static TicketIdStage builder() { + return new Builder(); + } + + public interface TicketIdStage { + /** + *

ticket_id

+ */ + TagIdStage ticketId(@NotNull String ticketId); + + Builder from(UntagTicketRequest other); + } + + public interface TagIdStage { + /** + *

The unique identifier for the tag which is given by Intercom

+ */ + AdminIdStage tagId(@NotNull String tagId); + } + + public interface AdminIdStage { + /** + *

The unique identifier for the admin which is given by Intercom.

+ */ + _FinalStage adminId(@NotNull String adminId); + } + + public interface _FinalStage { + UntagTicketRequest build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements TicketIdStage, TagIdStage, AdminIdStage, _FinalStage { + private String ticketId; + + private String tagId; + + private String adminId; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(UntagTicketRequest other) { + ticketId(other.getTicketId()); + tagId(other.getTagId()); + adminId(other.getAdminId()); + return this; + } + + /** + *

ticket_id

+ *

ticket_id

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("ticket_id") + public TagIdStage ticketId(@NotNull String ticketId) { + this.ticketId = Objects.requireNonNull(ticketId, "ticketId must not be null"); + return this; + } + + /** + *

The unique identifier for the tag which is given by Intercom

+ *

The unique identifier for the tag which is given by Intercom

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("tag_id") + public AdminIdStage tagId(@NotNull String tagId) { + this.tagId = Objects.requireNonNull(tagId, "tagId must not be null"); + return this; + } + + /** + *

The unique identifier for the admin which is given by Intercom.

+ *

The unique identifier for the admin which is given by Intercom.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("admin_id") + public _FinalStage adminId(@NotNull String adminId) { + this.adminId = Objects.requireNonNull(adminId, "adminId must not be null"); + return this; + } + + @java.lang.Override + public UntagTicketRequest build() { + return new UntagTicketRequest(ticketId, tagId, adminId, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/tags/types/Tag.java b/src/main/java/com/intercom/api/resources/tags/types/Tag.java new file mode 100644 index 00000000..daf7bc78 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/tags/types/Tag.java @@ -0,0 +1,234 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.tags.types; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.types.Reference; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = Tag.Builder.class) +public final class Tag { + private final String id; + + private final String name; + + private final Optional appliedAt; + + private final Optional appliedBy; + + private final Map additionalProperties; + + private Tag( + String id, + String name, + Optional appliedAt, + Optional appliedBy, + Map additionalProperties) { + this.id = id; + this.name = name; + this.appliedAt = appliedAt; + this.appliedBy = appliedBy; + this.additionalProperties = additionalProperties; + } + + /** + * @return value is "tag" + */ + @JsonProperty("type") + public String getType() { + return "tag"; + } + + /** + * @return The id of the tag + */ + @JsonProperty("id") + public String getId() { + return id; + } + + /** + * @return The name of the tag + */ + @JsonProperty("name") + public String getName() { + return name; + } + + /** + * @return The time when the tag was applied to the object + */ + @JsonProperty("applied_at") + public Optional getAppliedAt() { + return appliedAt; + } + + @JsonProperty("applied_by") + public Optional getAppliedBy() { + return appliedBy; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof Tag && equalTo((Tag) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(Tag other) { + return id.equals(other.id) + && name.equals(other.name) + && appliedAt.equals(other.appliedAt) + && appliedBy.equals(other.appliedBy); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.id, this.name, this.appliedAt, this.appliedBy); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static IdStage builder() { + return new Builder(); + } + + public interface IdStage { + /** + *

The id of the tag

+ */ + NameStage id(@NotNull String id); + + Builder from(Tag other); + } + + public interface NameStage { + /** + *

The name of the tag

+ */ + _FinalStage name(@NotNull String name); + } + + public interface _FinalStage { + Tag build(); + + /** + *

The time when the tag was applied to the object

+ */ + _FinalStage appliedAt(Optional appliedAt); + + _FinalStage appliedAt(Integer appliedAt); + + _FinalStage appliedBy(Optional appliedBy); + + _FinalStage appliedBy(Reference appliedBy); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements IdStage, NameStage, _FinalStage { + private String id; + + private String name; + + private Optional appliedBy = Optional.empty(); + + private Optional appliedAt = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(Tag other) { + id(other.getId()); + name(other.getName()); + appliedAt(other.getAppliedAt()); + appliedBy(other.getAppliedBy()); + return this; + } + + /** + *

The id of the tag

+ *

The id of the tag

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("id") + public NameStage id(@NotNull String id) { + this.id = Objects.requireNonNull(id, "id must not be null"); + return this; + } + + /** + *

The name of the tag

+ *

The name of the tag

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("name") + public _FinalStage name(@NotNull String name) { + this.name = Objects.requireNonNull(name, "name must not be null"); + return this; + } + + @java.lang.Override + public _FinalStage appliedBy(Reference appliedBy) { + this.appliedBy = Optional.ofNullable(appliedBy); + return this; + } + + @java.lang.Override + @JsonSetter(value = "applied_by", nulls = Nulls.SKIP) + public _FinalStage appliedBy(Optional appliedBy) { + this.appliedBy = appliedBy; + return this; + } + + /** + *

The time when the tag was applied to the object

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage appliedAt(Integer appliedAt) { + this.appliedAt = Optional.ofNullable(appliedAt); + return this; + } + + /** + *

The time when the tag was applied to the object

+ */ + @java.lang.Override + @JsonSetter(value = "applied_at", nulls = Nulls.SKIP) + public _FinalStage appliedAt(Optional appliedAt) { + this.appliedAt = appliedAt; + return this; + } + + @java.lang.Override + public Tag build() { + return new Tag(id, name, appliedAt, appliedBy, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/tags/types/TagBasic.java b/src/main/java/com/intercom/api/resources/tags/types/TagBasic.java new file mode 100644 index 00000000..cadc71b8 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/tags/types/TagBasic.java @@ -0,0 +1,161 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.tags.types; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = TagBasic.Builder.class) +public final class TagBasic { + private final Optional type; + + private final Optional id; + + private final Optional name; + + private final Map additionalProperties; + + private TagBasic( + Optional type, + Optional id, + Optional name, + Map additionalProperties) { + this.type = type; + this.id = id; + this.name = name; + this.additionalProperties = additionalProperties; + } + + /** + * @return value is "tag" + */ + @JsonProperty("type") + public Optional getType() { + return type; + } + + /** + * @return The id of the tag + */ + @JsonProperty("id") + public Optional getId() { + return id; + } + + /** + * @return The name of the tag + */ + @JsonProperty("name") + public Optional getName() { + return name; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof TagBasic && equalTo((TagBasic) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(TagBasic other) { + return type.equals(other.type) && id.equals(other.id) && name.equals(other.name); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.type, this.id, this.name); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static Builder builder() { + return new Builder(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder { + private Optional type = Optional.empty(); + + private Optional id = Optional.empty(); + + private Optional name = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + public Builder from(TagBasic other) { + type(other.getType()); + id(other.getId()); + name(other.getName()); + return this; + } + + /** + *

value is "tag"

+ */ + @JsonSetter(value = "type", nulls = Nulls.SKIP) + public Builder type(Optional type) { + this.type = type; + return this; + } + + public Builder type(String type) { + this.type = Optional.ofNullable(type); + return this; + } + + /** + *

The id of the tag

+ */ + @JsonSetter(value = "id", nulls = Nulls.SKIP) + public Builder id(Optional id) { + this.id = id; + return this; + } + + public Builder id(String id) { + this.id = Optional.ofNullable(id); + return this; + } + + /** + *

The name of the tag

+ */ + @JsonSetter(value = "name", nulls = Nulls.SKIP) + public Builder name(Optional name) { + this.name = name; + return this; + } + + public Builder name(String name) { + this.name = Optional.ofNullable(name); + return this; + } + + public TagBasic build() { + return new TagBasic(type, id, name, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/tags/types/TagsCreateRequestBody.java b/src/main/java/com/intercom/api/resources/tags/types/TagsCreateRequestBody.java new file mode 100644 index 00000000..fcf8bdae --- /dev/null +++ b/src/main/java/com/intercom/api/resources/tags/types/TagsCreateRequestBody.java @@ -0,0 +1,123 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.tags.types; + +import com.fasterxml.jackson.annotation.JsonValue; +import com.fasterxml.jackson.core.JsonParseException; +import com.fasterxml.jackson.core.JsonParser; +import com.fasterxml.jackson.databind.DeserializationContext; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.fasterxml.jackson.databind.deser.std.StdDeserializer; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.types.CreateOrUpdateTagRequest; +import com.intercom.api.types.TagCompanyRequest; +import com.intercom.api.types.TagMultipleUsersRequest; +import com.intercom.api.types.UntagCompanyRequest; +import java.io.IOException; +import java.util.Objects; + +@JsonDeserialize(using = TagsCreateRequestBody.Deserializer.class) +public final class TagsCreateRequestBody { + private final Object value; + + private final int type; + + private TagsCreateRequestBody(Object value, int type) { + this.value = value; + this.type = type; + } + + @JsonValue + public Object get() { + return this.value; + } + + @SuppressWarnings("unchecked") + public T visit(Visitor visitor) { + if (this.type == 0) { + return visitor.visit((CreateOrUpdateTagRequest) this.value); + } else if (this.type == 1) { + return visitor.visit((TagCompanyRequest) this.value); + } else if (this.type == 2) { + return visitor.visit((UntagCompanyRequest) this.value); + } else if (this.type == 3) { + return visitor.visit((TagMultipleUsersRequest) this.value); + } + throw new IllegalStateException("Failed to visit value. This should never happen."); + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof TagsCreateRequestBody && equalTo((TagsCreateRequestBody) other); + } + + private boolean equalTo(TagsCreateRequestBody other) { + return value.equals(other.value); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.value); + } + + @java.lang.Override + public String toString() { + return this.value.toString(); + } + + public static TagsCreateRequestBody of(CreateOrUpdateTagRequest value) { + return new TagsCreateRequestBody(value, 0); + } + + public static TagsCreateRequestBody of(TagCompanyRequest value) { + return new TagsCreateRequestBody(value, 1); + } + + public static TagsCreateRequestBody of(UntagCompanyRequest value) { + return new TagsCreateRequestBody(value, 2); + } + + public static TagsCreateRequestBody of(TagMultipleUsersRequest value) { + return new TagsCreateRequestBody(value, 3); + } + + public interface Visitor { + T visit(CreateOrUpdateTagRequest value); + + T visit(TagCompanyRequest value); + + T visit(UntagCompanyRequest value); + + T visit(TagMultipleUsersRequest value); + } + + static final class Deserializer extends StdDeserializer { + Deserializer() { + super(TagsCreateRequestBody.class); + } + + @java.lang.Override + public TagsCreateRequestBody deserialize(JsonParser p, DeserializationContext context) throws IOException { + Object value = p.readValueAs(Object.class); + try { + return of(ObjectMappers.JSON_MAPPER.convertValue(value, CreateOrUpdateTagRequest.class)); + } catch (RuntimeException e) { + } + try { + return of(ObjectMappers.JSON_MAPPER.convertValue(value, TagCompanyRequest.class)); + } catch (RuntimeException e) { + } + try { + return of(ObjectMappers.JSON_MAPPER.convertValue(value, UntagCompanyRequest.class)); + } catch (RuntimeException e) { + } + try { + return of(ObjectMappers.JSON_MAPPER.convertValue(value, TagMultipleUsersRequest.class)); + } catch (RuntimeException e) { + } + throw new JsonParseException(p, "Failed to deserialize"); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/teams/AsyncRawTeamsClient.java b/src/main/java/com/intercom/api/resources/teams/AsyncRawTeamsClient.java new file mode 100644 index 00000000..7891fc26 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/teams/AsyncRawTeamsClient.java @@ -0,0 +1,169 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.teams; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.IntercomApiException; +import com.intercom.api.core.IntercomException; +import com.intercom.api.core.IntercomHttpResponse; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.errors.NotFoundError; +import com.intercom.api.errors.UnauthorizedError; +import com.intercom.api.resources.teams.requests.FindTeamRequest; +import com.intercom.api.resources.teams.types.Team; +import com.intercom.api.types.Error; +import com.intercom.api.types.TeamList; +import java.io.IOException; +import java.util.concurrent.CompletableFuture; +import okhttp3.Call; +import okhttp3.Callback; +import okhttp3.Headers; +import okhttp3.HttpUrl; +import okhttp3.OkHttpClient; +import okhttp3.Request; +import okhttp3.Response; +import okhttp3.ResponseBody; +import org.jetbrains.annotations.NotNull; + +public class AsyncRawTeamsClient { + protected final ClientOptions clientOptions; + + public AsyncRawTeamsClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + } + + /** + * This will return a list of team objects for the App. + */ + public CompletableFuture> list() { + return list(null); + } + + /** + * This will return a list of team objects for the App. + */ + public CompletableFuture> list(RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("teams") + .build(); + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, TeamList.class), response)); + return; + } + try { + if (response.code() == 401) { + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can fetch the details of a single team, containing an array of admins that belong to this team. + */ + public CompletableFuture> find(FindTeamRequest request) { + return find(request, null); + } + + /** + * You can fetch the details of a single team, containing an array of admins that belong to this team. + */ + public CompletableFuture> find(FindTeamRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("teams") + .addPathSegment(request.getTeamId()) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Team.class), response)); + return; + } + try { + switch (response.code()) { + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 404: + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } +} diff --git a/src/main/java/com/intercom/api/resources/teams/AsyncTeamsClient.java b/src/main/java/com/intercom/api/resources/teams/AsyncTeamsClient.java new file mode 100644 index 00000000..fcc78240 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/teams/AsyncTeamsClient.java @@ -0,0 +1,57 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.teams; + +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.resources.teams.requests.FindTeamRequest; +import com.intercom.api.resources.teams.types.Team; +import com.intercom.api.types.TeamList; +import java.util.concurrent.CompletableFuture; + +public class AsyncTeamsClient { + protected final ClientOptions clientOptions; + + private final AsyncRawTeamsClient rawClient; + + public AsyncTeamsClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + this.rawClient = new AsyncRawTeamsClient(clientOptions); + } + + /** + * Get responses with HTTP metadata like headers + */ + public AsyncRawTeamsClient withRawResponse() { + return this.rawClient; + } + + /** + * This will return a list of team objects for the App. + */ + public CompletableFuture list() { + return this.rawClient.list().thenApply(response -> response.body()); + } + + /** + * This will return a list of team objects for the App. + */ + public CompletableFuture list(RequestOptions requestOptions) { + return this.rawClient.list(requestOptions).thenApply(response -> response.body()); + } + + /** + * You can fetch the details of a single team, containing an array of admins that belong to this team. + */ + public CompletableFuture find(FindTeamRequest request) { + return this.rawClient.find(request).thenApply(response -> response.body()); + } + + /** + * You can fetch the details of a single team, containing an array of admins that belong to this team. + */ + public CompletableFuture find(FindTeamRequest request, RequestOptions requestOptions) { + return this.rawClient.find(request, requestOptions).thenApply(response -> response.body()); + } +} diff --git a/src/main/java/com/intercom/api/resources/teams/RawTeamsClient.java b/src/main/java/com/intercom/api/resources/teams/RawTeamsClient.java new file mode 100644 index 00000000..3028dd7e --- /dev/null +++ b/src/main/java/com/intercom/api/resources/teams/RawTeamsClient.java @@ -0,0 +1,134 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.teams; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.IntercomApiException; +import com.intercom.api.core.IntercomException; +import com.intercom.api.core.IntercomHttpResponse; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.errors.NotFoundError; +import com.intercom.api.errors.UnauthorizedError; +import com.intercom.api.resources.teams.requests.FindTeamRequest; +import com.intercom.api.resources.teams.types.Team; +import com.intercom.api.types.Error; +import com.intercom.api.types.TeamList; +import java.io.IOException; +import okhttp3.Headers; +import okhttp3.HttpUrl; +import okhttp3.OkHttpClient; +import okhttp3.Request; +import okhttp3.Response; +import okhttp3.ResponseBody; + +public class RawTeamsClient { + protected final ClientOptions clientOptions; + + public RawTeamsClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + } + + /** + * This will return a list of team objects for the App. + */ + public IntercomHttpResponse list() { + return list(null); + } + + /** + * This will return a list of team objects for the App. + */ + public IntercomHttpResponse list(RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("teams") + .build(); + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, TeamList.class), response); + } + try { + if (response.code() == 401) { + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can fetch the details of a single team, containing an array of admins that belong to this team. + */ + public IntercomHttpResponse find(FindTeamRequest request) { + return find(request, null); + } + + /** + * You can fetch the details of a single team, containing an array of admins that belong to this team. + */ + public IntercomHttpResponse find(FindTeamRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("teams") + .addPathSegment(request.getTeamId()) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Team.class), response); + } + try { + switch (response.code()) { + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 404: + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/teams/TeamsClient.java b/src/main/java/com/intercom/api/resources/teams/TeamsClient.java new file mode 100644 index 00000000..b8e5983b --- /dev/null +++ b/src/main/java/com/intercom/api/resources/teams/TeamsClient.java @@ -0,0 +1,56 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.teams; + +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.resources.teams.requests.FindTeamRequest; +import com.intercom.api.resources.teams.types.Team; +import com.intercom.api.types.TeamList; + +public class TeamsClient { + protected final ClientOptions clientOptions; + + private final RawTeamsClient rawClient; + + public TeamsClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + this.rawClient = new RawTeamsClient(clientOptions); + } + + /** + * Get responses with HTTP metadata like headers + */ + public RawTeamsClient withRawResponse() { + return this.rawClient; + } + + /** + * This will return a list of team objects for the App. + */ + public TeamList list() { + return this.rawClient.list().body(); + } + + /** + * This will return a list of team objects for the App. + */ + public TeamList list(RequestOptions requestOptions) { + return this.rawClient.list(requestOptions).body(); + } + + /** + * You can fetch the details of a single team, containing an array of admins that belong to this team. + */ + public Team find(FindTeamRequest request) { + return this.rawClient.find(request).body(); + } + + /** + * You can fetch the details of a single team, containing an array of admins that belong to this team. + */ + public Team find(FindTeamRequest request, RequestOptions requestOptions) { + return this.rawClient.find(request, requestOptions).body(); + } +} diff --git a/src/main/java/com/intercom/api/resources/teams/requests/FindTeamRequest.java b/src/main/java/com/intercom/api/resources/teams/requests/FindTeamRequest.java new file mode 100644 index 00000000..8ddf0bb0 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/teams/requests/FindTeamRequest.java @@ -0,0 +1,113 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.teams.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = FindTeamRequest.Builder.class) +public final class FindTeamRequest { + private final String teamId; + + private final Map additionalProperties; + + private FindTeamRequest(String teamId, Map additionalProperties) { + this.teamId = teamId; + this.additionalProperties = additionalProperties; + } + + /** + * @return The unique identifier of a given team. + */ + @JsonProperty("team_id") + public String getTeamId() { + return teamId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof FindTeamRequest && equalTo((FindTeamRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(FindTeamRequest other) { + return teamId.equals(other.teamId); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.teamId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static TeamIdStage builder() { + return new Builder(); + } + + public interface TeamIdStage { + /** + *

The unique identifier of a given team.

+ */ + _FinalStage teamId(@NotNull String teamId); + + Builder from(FindTeamRequest other); + } + + public interface _FinalStage { + FindTeamRequest build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements TeamIdStage, _FinalStage { + private String teamId; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(FindTeamRequest other) { + teamId(other.getTeamId()); + return this; + } + + /** + *

The unique identifier of a given team.

+ *

The unique identifier of a given team.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("team_id") + public _FinalStage teamId(@NotNull String teamId) { + this.teamId = Objects.requireNonNull(teamId, "teamId must not be null"); + return this; + } + + @java.lang.Override + public FindTeamRequest build() { + return new FindTeamRequest(teamId, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/teams/types/Team.java b/src/main/java/com/intercom/api/resources/teams/types/Team.java new file mode 100644 index 00000000..5a4b8c82 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/teams/types/Team.java @@ -0,0 +1,381 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.teams.types; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.types.AdminPriorityLevel; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = Team.Builder.class) +public final class Team { + private final String type; + + private final String id; + + private final String name; + + private final List adminIds; + + private final Optional adminPriorityLevel; + + private final Optional assignmentLimit; + + private final Optional distributionMethod; + + private final Map additionalProperties; + + private Team( + String type, + String id, + String name, + List adminIds, + Optional adminPriorityLevel, + Optional assignmentLimit, + Optional distributionMethod, + Map additionalProperties) { + this.type = type; + this.id = id; + this.name = name; + this.adminIds = adminIds; + this.adminPriorityLevel = adminPriorityLevel; + this.assignmentLimit = assignmentLimit; + this.distributionMethod = distributionMethod; + this.additionalProperties = additionalProperties; + } + + /** + * @return Value is always "team" + */ + @JsonProperty("type") + public String getType() { + return type; + } + + /** + * @return The id of the team + */ + @JsonProperty("id") + public String getId() { + return id; + } + + /** + * @return The name of the team + */ + @JsonProperty("name") + public String getName() { + return name; + } + + /** + * @return The list of admin IDs that are a part of the team. + */ + @JsonProperty("admin_ids") + public List getAdminIds() { + return adminIds; + } + + @JsonProperty("admin_priority_level") + public Optional getAdminPriorityLevel() { + return adminPriorityLevel; + } + + /** + * @return The assignment limit for the team. This field is only present when the team's distribution type is load balanced. + */ + @JsonProperty("assignment_limit") + public Optional getAssignmentLimit() { + return assignmentLimit; + } + + /** + * @return Describes how assignments are distributed among the team members + */ + @JsonProperty("distribution_method") + public Optional getDistributionMethod() { + return distributionMethod; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof Team && equalTo((Team) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(Team other) { + return type.equals(other.type) + && id.equals(other.id) + && name.equals(other.name) + && adminIds.equals(other.adminIds) + && adminPriorityLevel.equals(other.adminPriorityLevel) + && assignmentLimit.equals(other.assignmentLimit) + && distributionMethod.equals(other.distributionMethod); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash( + this.type, + this.id, + this.name, + this.adminIds, + this.adminPriorityLevel, + this.assignmentLimit, + this.distributionMethod); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static TypeStage builder() { + return new Builder(); + } + + public interface TypeStage { + /** + *

Value is always "team"

+ */ + IdStage type(@NotNull String type); + + Builder from(Team other); + } + + public interface IdStage { + /** + *

The id of the team

+ */ + NameStage id(@NotNull String id); + } + + public interface NameStage { + /** + *

The name of the team

+ */ + _FinalStage name(@NotNull String name); + } + + public interface _FinalStage { + Team build(); + + /** + *

The list of admin IDs that are a part of the team.

+ */ + _FinalStage adminIds(List adminIds); + + _FinalStage addAdminIds(Integer adminIds); + + _FinalStage addAllAdminIds(List adminIds); + + _FinalStage adminPriorityLevel(Optional adminPriorityLevel); + + _FinalStage adminPriorityLevel(AdminPriorityLevel adminPriorityLevel); + + /** + *

The assignment limit for the team. This field is only present when the team's distribution type is load balanced.

+ */ + _FinalStage assignmentLimit(Optional assignmentLimit); + + _FinalStage assignmentLimit(Integer assignmentLimit); + + /** + *

Describes how assignments are distributed among the team members

+ */ + _FinalStage distributionMethod(Optional distributionMethod); + + _FinalStage distributionMethod(String distributionMethod); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements TypeStage, IdStage, NameStage, _FinalStage { + private String type; + + private String id; + + private String name; + + private Optional distributionMethod = Optional.empty(); + + private Optional assignmentLimit = Optional.empty(); + + private Optional adminPriorityLevel = Optional.empty(); + + private List adminIds = new ArrayList<>(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(Team other) { + type(other.getType()); + id(other.getId()); + name(other.getName()); + adminIds(other.getAdminIds()); + adminPriorityLevel(other.getAdminPriorityLevel()); + assignmentLimit(other.getAssignmentLimit()); + distributionMethod(other.getDistributionMethod()); + return this; + } + + /** + *

Value is always "team"

+ *

Value is always "team"

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("type") + public IdStage type(@NotNull String type) { + this.type = Objects.requireNonNull(type, "type must not be null"); + return this; + } + + /** + *

The id of the team

+ *

The id of the team

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("id") + public NameStage id(@NotNull String id) { + this.id = Objects.requireNonNull(id, "id must not be null"); + return this; + } + + /** + *

The name of the team

+ *

The name of the team

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("name") + public _FinalStage name(@NotNull String name) { + this.name = Objects.requireNonNull(name, "name must not be null"); + return this; + } + + /** + *

Describes how assignments are distributed among the team members

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage distributionMethod(String distributionMethod) { + this.distributionMethod = Optional.ofNullable(distributionMethod); + return this; + } + + /** + *

Describes how assignments are distributed among the team members

+ */ + @java.lang.Override + @JsonSetter(value = "distribution_method", nulls = Nulls.SKIP) + public _FinalStage distributionMethod(Optional distributionMethod) { + this.distributionMethod = distributionMethod; + return this; + } + + /** + *

The assignment limit for the team. This field is only present when the team's distribution type is load balanced.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage assignmentLimit(Integer assignmentLimit) { + this.assignmentLimit = Optional.ofNullable(assignmentLimit); + return this; + } + + /** + *

The assignment limit for the team. This field is only present when the team's distribution type is load balanced.

+ */ + @java.lang.Override + @JsonSetter(value = "assignment_limit", nulls = Nulls.SKIP) + public _FinalStage assignmentLimit(Optional assignmentLimit) { + this.assignmentLimit = assignmentLimit; + return this; + } + + @java.lang.Override + public _FinalStage adminPriorityLevel(AdminPriorityLevel adminPriorityLevel) { + this.adminPriorityLevel = Optional.ofNullable(adminPriorityLevel); + return this; + } + + @java.lang.Override + @JsonSetter(value = "admin_priority_level", nulls = Nulls.SKIP) + public _FinalStage adminPriorityLevel(Optional adminPriorityLevel) { + this.adminPriorityLevel = adminPriorityLevel; + return this; + } + + /** + *

The list of admin IDs that are a part of the team.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage addAllAdminIds(List adminIds) { + if (adminIds != null) { + this.adminIds.addAll(adminIds); + } + return this; + } + + /** + *

The list of admin IDs that are a part of the team.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage addAdminIds(Integer adminIds) { + this.adminIds.add(adminIds); + return this; + } + + /** + *

The list of admin IDs that are a part of the team.

+ */ + @java.lang.Override + @JsonSetter(value = "admin_ids", nulls = Nulls.SKIP) + public _FinalStage adminIds(List adminIds) { + this.adminIds.clear(); + if (adminIds != null) { + this.adminIds.addAll(adminIds); + } + return this; + } + + @java.lang.Override + public Team build() { + return new Team( + type, + id, + name, + adminIds, + adminPriorityLevel, + assignmentLimit, + distributionMethod, + additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/tickets/AsyncRawTicketsClient.java b/src/main/java/com/intercom/api/resources/tickets/AsyncRawTicketsClient.java new file mode 100644 index 00000000..5552fb3b --- /dev/null +++ b/src/main/java/com/intercom/api/resources/tickets/AsyncRawTicketsClient.java @@ -0,0 +1,727 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.tickets; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.fasterxml.jackson.core.type.TypeReference; +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.IntercomApiException; +import com.intercom.api.core.IntercomException; +import com.intercom.api.core.IntercomHttpResponse; +import com.intercom.api.core.MediaTypes; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.core.pagination.SyncPagingIterable; +import com.intercom.api.errors.BadRequestError; +import com.intercom.api.errors.NotFoundError; +import com.intercom.api.errors.UnauthorizedError; +import com.intercom.api.resources.jobs.types.Jobs; +import com.intercom.api.resources.tickets.requests.CreateTicketRequest; +import com.intercom.api.resources.tickets.requests.DeleteTicketRequest; +import com.intercom.api.resources.tickets.requests.EnqueueCreateTicketRequest; +import com.intercom.api.resources.tickets.requests.FindTicketRequest; +import com.intercom.api.resources.tickets.requests.ReplyToTicketRequest; +import com.intercom.api.resources.tickets.requests.UpdateTicketRequest; +import com.intercom.api.resources.tickets.types.DeleteTicketResponse; +import com.intercom.api.resources.tickets.types.Ticket; +import com.intercom.api.types.CursorPages; +import com.intercom.api.types.Error; +import com.intercom.api.types.SearchRequest; +import com.intercom.api.types.StartingAfterPaging; +import com.intercom.api.types.TicketList; +import com.intercom.api.types.TicketReply; +import java.io.IOException; +import java.util.Collections; +import java.util.List; +import java.util.Optional; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.ExecutionException; +import okhttp3.Call; +import okhttp3.Callback; +import okhttp3.Headers; +import okhttp3.HttpUrl; +import okhttp3.OkHttpClient; +import okhttp3.Request; +import okhttp3.RequestBody; +import okhttp3.Response; +import okhttp3.ResponseBody; +import org.jetbrains.annotations.NotNull; + +public class AsyncRawTicketsClient { + protected final ClientOptions clientOptions; + + public AsyncRawTicketsClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + } + + /** + * You can reply to a ticket with a message from an admin or on behalf of a contact, or with a note for admins. + */ + public CompletableFuture> reply(ReplyToTicketRequest request) { + return reply(request, null); + } + + /** + * You can reply to a ticket with a message from an admin or on behalf of a contact, or with a note for admins. + */ + public CompletableFuture> reply( + ReplyToTicketRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("tickets") + .addPathSegment(request.getTicketId()) + .addPathSegments("reply") + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request.getBody()), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, TicketReply.class), response)); + return; + } + try { + switch (response.code()) { + case 400: + future.completeExceptionally(new BadRequestError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 404: + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can create a new ticket. + */ + public CompletableFuture>> create(CreateTicketRequest request) { + return create(request, null); + } + + /** + * You can create a new ticket. + */ + public CompletableFuture>> create( + CreateTicketRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("tickets") + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture>> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue( + responseBodyString, new TypeReference>() {}), + response)); + return; + } + try { + if (response.code() == 401) { + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * Enqueues ticket creation for asynchronous processing, returning if the job was enqueued successfully to be processed. We attempt to perform a best-effort validation on inputs before tasks are enqueued. If the given parameters are incorrect, we won't enqueue the job. + */ + public CompletableFuture> enqueueCreateTicket(EnqueueCreateTicketRequest request) { + return enqueueCreateTicket(request, null); + } + + /** + * Enqueues ticket creation for asynchronous processing, returning if the job was enqueued successfully to be processed. We attempt to perform a best-effort validation on inputs before tasks are enqueued. If the given parameters are incorrect, we won't enqueue the job. + */ + public CompletableFuture> enqueueCreateTicket( + EnqueueCreateTicketRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("tickets/enqueue") + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Jobs.class), response)); + return; + } + try { + switch (response.code()) { + case 400: + future.completeExceptionally(new BadRequestError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can fetch the details of a single ticket. + */ + public CompletableFuture>> get(FindTicketRequest request) { + return get(request, null); + } + + /** + * You can fetch the details of a single ticket. + */ + public CompletableFuture>> get( + FindTicketRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("tickets") + .addPathSegment(request.getTicketId()) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture>> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue( + responseBodyString, new TypeReference>() {}), + response)); + return; + } + try { + if (response.code() == 401) { + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can update a ticket. + */ + public CompletableFuture>> update(UpdateTicketRequest request) { + return update(request, null); + } + + /** + * You can update a ticket. + */ + public CompletableFuture>> update( + UpdateTicketRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("tickets") + .addPathSegment(request.getTicketId()) + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("PUT", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture>> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue( + responseBodyString, new TypeReference>() {}), + response)); + return; + } + try { + switch (response.code()) { + case 400: + future.completeExceptionally(new BadRequestError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 404: + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can delete a ticket using the Intercom provided ID. + */ + public CompletableFuture> deleteTicket(DeleteTicketRequest request) { + return deleteTicket(request, null); + } + + /** + * You can delete a ticket using the Intercom provided ID. + */ + public CompletableFuture> deleteTicket( + DeleteTicketRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("tickets") + .addPathSegment(request.getTicketId()) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("DELETE", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture> future = new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + future.complete(new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, DeleteTicketResponse.class), + response)); + return; + } + try { + switch (response.code()) { + case 401: + future.completeExceptionally(new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), + response)); + return; + case 404: + future.completeExceptionally(new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), + response)); + return; + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } + + /** + * You can search for multiple tickets by the value of their attributes in order to fetch exactly which ones you want. + *

To search for tickets, you send a POST request to https://api.intercom.io/tickets/search.

+ *

This will accept a query object in the body which will define your filters. + * {% admonition type="warning" name="Optimizing search queries" %} + * Search queries can be complex, so optimizing them can help the performance of your search. + * Use the AND and OR operators to combine multiple filters to get the exact results you need and utilize + * pagination to limit the number of results returned. The default is 20 results per page. + * See the pagination section for more details on how to use the starting_after param. + * {% /admonition %}

+ *

Nesting & Limitations

+ *

You can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4). + * There are some limitations to the amount of multiples there can be:

+ *
    + *
  • There's a limit of max 2 nested filters
    • + *
  • There's a limit of max 15 filters for each AND or OR group
    • + *
+ *

Accepted Fields

+ *

Most keys listed as part of the Ticket model are searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as created_at accepts a date, the value cannot be a string such as "foobar"). + * The source.body field is unique as the search will not be performed against the entire value, but instead against every element of the value separately. For example, when searching for a conversation with a "I need support" body - the query should contain a = operator with the value "support" for such conversation to be returned. A query with a = operator and a "need support" value will not yield a result.

+ *

| Field | Type | + * | :---------------------------------------- | :--------------------------------------------------------------------------------------- | + * | id | String | + * | created_at | Date (UNIX timestamp) | + * | updated_at | Date (UNIX timestamp) | + * | title | String | + * | description | String | + * | category | String | + * | ticket_type_id | String | + * | contact_ids | String | + * | teammate_ids | String | + * | admin_assignee_id | String | + * | team_assignee_id | String | + * | open | Boolean | + * | state | String | + * | snoozed_until | Date (UNIX timestamp) | + * | ticket_attribute.{id} | String or Boolean or Date (UNIX timestamp) or Float or Integer |

+ *

{% admonition type="info" name="Searching by Category" %} + * When searching for tickets by the category field, specific terms must be used instead of the category names:

+ *
    + *
  • For Customer category tickets, use the term request.
    • + *
  • For Back-office category tickets, use the term task.
    • + *
  • For Tracker category tickets, use the term tracker. + * {% /admonition %}
    • + *
+ *

Accepted Operators

+ *

{% admonition type="info" name="Searching based on created_at" %} + * You may use the <= or >= operators to search by created_at. + * {% /admonition %}

+ *

The table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string ("="). The operator has to be compatible with the field's type (eg. you cannot search with > for a given string value as it's only compatible for integer's and dates).

+ *

| Operator | Valid Types | Description | + * | :------- | :----------------------------- | :----------------------------------------------------------- | + * | = | All | Equals | + * | != | All | Doesn't Equal | + * | IN | All | In Shortcut for OR queries Values most be in Array | + * | NIN | All | Not In Shortcut for OR ! queries Values must be in Array | + * | > | Integer Date (UNIX Timestamp) | Greater (or equal) than | + * | < | Integer Date (UNIX Timestamp) | Lower (or equal) than | + * | ~ | String | Contains | + * | !~ | String | Doesn't Contain | + * | ^ | String | Starts With | + * | $ | String | Ends With |

+ */ + public CompletableFuture>>> search(SearchRequest request) { + return search(request, null); + } + + /** + * You can search for multiple tickets by the value of their attributes in order to fetch exactly which ones you want. + *

To search for tickets, you send a POST request to https://api.intercom.io/tickets/search.

+ *

This will accept a query object in the body which will define your filters. + * {% admonition type="warning" name="Optimizing search queries" %} + * Search queries can be complex, so optimizing them can help the performance of your search. + * Use the AND and OR operators to combine multiple filters to get the exact results you need and utilize + * pagination to limit the number of results returned. The default is 20 results per page. + * See the pagination section for more details on how to use the starting_after param. + * {% /admonition %}

+ *

Nesting & Limitations

+ *

You can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4). + * There are some limitations to the amount of multiples there can be:

+ *
    + *
  • There's a limit of max 2 nested filters
    • + *
  • There's a limit of max 15 filters for each AND or OR group
    • + *
+ *

Accepted Fields

+ *

Most keys listed as part of the Ticket model are searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as created_at accepts a date, the value cannot be a string such as "foobar"). + * The source.body field is unique as the search will not be performed against the entire value, but instead against every element of the value separately. For example, when searching for a conversation with a "I need support" body - the query should contain a = operator with the value "support" for such conversation to be returned. A query with a = operator and a "need support" value will not yield a result.

+ *

| Field | Type | + * | :---------------------------------------- | :--------------------------------------------------------------------------------------- | + * | id | String | + * | created_at | Date (UNIX timestamp) | + * | updated_at | Date (UNIX timestamp) | + * | title | String | + * | description | String | + * | category | String | + * | ticket_type_id | String | + * | contact_ids | String | + * | teammate_ids | String | + * | admin_assignee_id | String | + * | team_assignee_id | String | + * | open | Boolean | + * | state | String | + * | snoozed_until | Date (UNIX timestamp) | + * | ticket_attribute.{id} | String or Boolean or Date (UNIX timestamp) or Float or Integer |

+ *

{% admonition type="info" name="Searching by Category" %} + * When searching for tickets by the category field, specific terms must be used instead of the category names:

+ *
    + *
  • For Customer category tickets, use the term request.
    • + *
  • For Back-office category tickets, use the term task.
    • + *
  • For Tracker category tickets, use the term tracker. + * {% /admonition %}
    • + *
+ *

Accepted Operators

+ *

{% admonition type="info" name="Searching based on created_at" %} + * You may use the <= or >= operators to search by created_at. + * {% /admonition %}

+ *

The table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string ("="). The operator has to be compatible with the field's type (eg. you cannot search with > for a given string value as it's only compatible for integer's and dates).

+ *

| Operator | Valid Types | Description | + * | :------- | :----------------------------- | :----------------------------------------------------------- | + * | = | All | Equals | + * | != | All | Doesn't Equal | + * | IN | All | In Shortcut for OR queries Values most be in Array | + * | NIN | All | Not In Shortcut for OR ! queries Values must be in Array | + * | > | Integer Date (UNIX Timestamp) | Greater (or equal) than | + * | < | Integer Date (UNIX Timestamp) | Lower (or equal) than | + * | ~ | String | Contains | + * | !~ | String | Doesn't Contain | + * | ^ | String | Starts With | + * | $ | String | Ends With |

+ */ + public CompletableFuture>>> search( + SearchRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("tickets/search") + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + CompletableFuture>>> future = + new CompletableFuture<>(); + client.newCall(okhttpRequest).enqueue(new Callback() { + @Override + public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { + try (ResponseBody responseBody = response.body()) { + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + TicketList parsedResponse = + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, TicketList.class); + Optional startingAfter = parsedResponse + .getPages() + .flatMap(CursorPages::getNext) + .flatMap(StartingAfterPaging::getStartingAfter); + Optional pagination = request.getPagination() + .map((StartingAfterPaging pagination_) -> StartingAfterPaging.builder() + .from(pagination_) + .startingAfter(startingAfter) + .build()); + SearchRequest nextRequest = SearchRequest.builder() + .from(request) + .pagination(pagination) + .build(); + List> result = + parsedResponse.getTickets().orElse(Collections.emptyList()); + future.complete(new IntercomHttpResponse<>( + new SyncPagingIterable>( + startingAfter.isPresent(), result, parsedResponse, () -> { + try { + return search(nextRequest, requestOptions) + .get() + .body(); + } catch (InterruptedException | ExecutionException e) { + throw new RuntimeException(e); + } + }), + response)); + return; + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + future.completeExceptionally(new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response)); + return; + } catch (IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + } + + @Override + public void onFailure(@NotNull Call call, @NotNull IOException e) { + future.completeExceptionally(new IntercomException("Network error executing HTTP request", e)); + } + }); + return future; + } +} diff --git a/src/main/java/com/intercom/api/resources/tickets/AsyncTicketsClient.java b/src/main/java/com/intercom/api/resources/tickets/AsyncTicketsClient.java new file mode 100644 index 00000000..0d014e0c --- /dev/null +++ b/src/main/java/com/intercom/api/resources/tickets/AsyncTicketsClient.java @@ -0,0 +1,260 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.tickets; + +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.core.pagination.SyncPagingIterable; +import com.intercom.api.resources.jobs.types.Jobs; +import com.intercom.api.resources.tickets.requests.CreateTicketRequest; +import com.intercom.api.resources.tickets.requests.DeleteTicketRequest; +import com.intercom.api.resources.tickets.requests.EnqueueCreateTicketRequest; +import com.intercom.api.resources.tickets.requests.FindTicketRequest; +import com.intercom.api.resources.tickets.requests.ReplyToTicketRequest; +import com.intercom.api.resources.tickets.requests.UpdateTicketRequest; +import com.intercom.api.resources.tickets.types.DeleteTicketResponse; +import com.intercom.api.resources.tickets.types.Ticket; +import com.intercom.api.types.SearchRequest; +import com.intercom.api.types.TicketReply; +import java.util.Optional; +import java.util.concurrent.CompletableFuture; + +public class AsyncTicketsClient { + protected final ClientOptions clientOptions; + + private final AsyncRawTicketsClient rawClient; + + public AsyncTicketsClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + this.rawClient = new AsyncRawTicketsClient(clientOptions); + } + + /** + * Get responses with HTTP metadata like headers + */ + public AsyncRawTicketsClient withRawResponse() { + return this.rawClient; + } + + /** + * You can reply to a ticket with a message from an admin or on behalf of a contact, or with a note for admins. + */ + public CompletableFuture reply(ReplyToTicketRequest request) { + return this.rawClient.reply(request).thenApply(response -> response.body()); + } + + /** + * You can reply to a ticket with a message from an admin or on behalf of a contact, or with a note for admins. + */ + public CompletableFuture reply(ReplyToTicketRequest request, RequestOptions requestOptions) { + return this.rawClient.reply(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can create a new ticket. + */ + public CompletableFuture> create(CreateTicketRequest request) { + return this.rawClient.create(request).thenApply(response -> response.body()); + } + + /** + * You can create a new ticket. + */ + public CompletableFuture> create(CreateTicketRequest request, RequestOptions requestOptions) { + return this.rawClient.create(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * Enqueues ticket creation for asynchronous processing, returning if the job was enqueued successfully to be processed. We attempt to perform a best-effort validation on inputs before tasks are enqueued. If the given parameters are incorrect, we won't enqueue the job. + */ + public CompletableFuture enqueueCreateTicket(EnqueueCreateTicketRequest request) { + return this.rawClient.enqueueCreateTicket(request).thenApply(response -> response.body()); + } + + /** + * Enqueues ticket creation for asynchronous processing, returning if the job was enqueued successfully to be processed. We attempt to perform a best-effort validation on inputs before tasks are enqueued. If the given parameters are incorrect, we won't enqueue the job. + */ + public CompletableFuture enqueueCreateTicket( + EnqueueCreateTicketRequest request, RequestOptions requestOptions) { + return this.rawClient.enqueueCreateTicket(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can fetch the details of a single ticket. + */ + public CompletableFuture> get(FindTicketRequest request) { + return this.rawClient.get(request).thenApply(response -> response.body()); + } + + /** + * You can fetch the details of a single ticket. + */ + public CompletableFuture> get(FindTicketRequest request, RequestOptions requestOptions) { + return this.rawClient.get(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can update a ticket. + */ + public CompletableFuture> update(UpdateTicketRequest request) { + return this.rawClient.update(request).thenApply(response -> response.body()); + } + + /** + * You can update a ticket. + */ + public CompletableFuture> update(UpdateTicketRequest request, RequestOptions requestOptions) { + return this.rawClient.update(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can delete a ticket using the Intercom provided ID. + */ + public CompletableFuture deleteTicket(DeleteTicketRequest request) { + return this.rawClient.deleteTicket(request).thenApply(response -> response.body()); + } + + /** + * You can delete a ticket using the Intercom provided ID. + */ + public CompletableFuture deleteTicket( + DeleteTicketRequest request, RequestOptions requestOptions) { + return this.rawClient.deleteTicket(request, requestOptions).thenApply(response -> response.body()); + } + + /** + * You can search for multiple tickets by the value of their attributes in order to fetch exactly which ones you want. + *

To search for tickets, you send a POST request to https://api.intercom.io/tickets/search.

+ *

This will accept a query object in the body which will define your filters. + * {% admonition type="warning" name="Optimizing search queries" %} + * Search queries can be complex, so optimizing them can help the performance of your search. + * Use the AND and OR operators to combine multiple filters to get the exact results you need and utilize + * pagination to limit the number of results returned. The default is 20 results per page. + * See the pagination section for more details on how to use the starting_after param. + * {% /admonition %}

+ *

Nesting & Limitations

+ *

You can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4). + * There are some limitations to the amount of multiples there can be:

+ *
    + *
  • There's a limit of max 2 nested filters
    • + *
  • There's a limit of max 15 filters for each AND or OR group
    • + *
+ *

Accepted Fields

+ *

Most keys listed as part of the Ticket model are searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as created_at accepts a date, the value cannot be a string such as "foobar"). + * The source.body field is unique as the search will not be performed against the entire value, but instead against every element of the value separately. For example, when searching for a conversation with a "I need support" body - the query should contain a = operator with the value "support" for such conversation to be returned. A query with a = operator and a "need support" value will not yield a result.

+ *

| Field | Type | + * | :---------------------------------------- | :--------------------------------------------------------------------------------------- | + * | id | String | + * | created_at | Date (UNIX timestamp) | + * | updated_at | Date (UNIX timestamp) | + * | title | String | + * | description | String | + * | category | String | + * | ticket_type_id | String | + * | contact_ids | String | + * | teammate_ids | String | + * | admin_assignee_id | String | + * | team_assignee_id | String | + * | open | Boolean | + * | state | String | + * | snoozed_until | Date (UNIX timestamp) | + * | ticket_attribute.{id} | String or Boolean or Date (UNIX timestamp) or Float or Integer |

+ *

{% admonition type="info" name="Searching by Category" %} + * When searching for tickets by the category field, specific terms must be used instead of the category names:

+ *
    + *
  • For Customer category tickets, use the term request.
    • + *
  • For Back-office category tickets, use the term task.
    • + *
  • For Tracker category tickets, use the term tracker. + * {% /admonition %}
    • + *
+ *

Accepted Operators

+ *

{% admonition type="info" name="Searching based on created_at" %} + * You may use the <= or >= operators to search by created_at. + * {% /admonition %}

+ *

The table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string ("="). The operator has to be compatible with the field's type (eg. you cannot search with > for a given string value as it's only compatible for integer's and dates).

+ *

| Operator | Valid Types | Description | + * | :------- | :----------------------------- | :----------------------------------------------------------- | + * | = | All | Equals | + * | != | All | Doesn't Equal | + * | IN | All | In Shortcut for OR queries Values most be in Array | + * | NIN | All | Not In Shortcut for OR ! queries Values must be in Array | + * | > | Integer Date (UNIX Timestamp) | Greater (or equal) than | + * | < | Integer Date (UNIX Timestamp) | Lower (or equal) than | + * | ~ | String | Contains | + * | !~ | String | Doesn't Contain | + * | ^ | String | Starts With | + * | $ | String | Ends With |

+ */ + public CompletableFuture>> search(SearchRequest request) { + return this.rawClient.search(request).thenApply(response -> response.body()); + } + + /** + * You can search for multiple tickets by the value of their attributes in order to fetch exactly which ones you want. + *

To search for tickets, you send a POST request to https://api.intercom.io/tickets/search.

+ *

This will accept a query object in the body which will define your filters. + * {% admonition type="warning" name="Optimizing search queries" %} + * Search queries can be complex, so optimizing them can help the performance of your search. + * Use the AND and OR operators to combine multiple filters to get the exact results you need and utilize + * pagination to limit the number of results returned. The default is 20 results per page. + * See the pagination section for more details on how to use the starting_after param. + * {% /admonition %}

+ *

Nesting & Limitations

+ *

You can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4). + * There are some limitations to the amount of multiples there can be:

+ *
    + *
  • There's a limit of max 2 nested filters
    • + *
  • There's a limit of max 15 filters for each AND or OR group
    • + *
+ *

Accepted Fields

+ *

Most keys listed as part of the Ticket model are searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as created_at accepts a date, the value cannot be a string such as "foobar"). + * The source.body field is unique as the search will not be performed against the entire value, but instead against every element of the value separately. For example, when searching for a conversation with a "I need support" body - the query should contain a = operator with the value "support" for such conversation to be returned. A query with a = operator and a "need support" value will not yield a result.

+ *

| Field | Type | + * | :---------------------------------------- | :--------------------------------------------------------------------------------------- | + * | id | String | + * | created_at | Date (UNIX timestamp) | + * | updated_at | Date (UNIX timestamp) | + * | title | String | + * | description | String | + * | category | String | + * | ticket_type_id | String | + * | contact_ids | String | + * | teammate_ids | String | + * | admin_assignee_id | String | + * | team_assignee_id | String | + * | open | Boolean | + * | state | String | + * | snoozed_until | Date (UNIX timestamp) | + * | ticket_attribute.{id} | String or Boolean or Date (UNIX timestamp) or Float or Integer |

+ *

{% admonition type="info" name="Searching by Category" %} + * When searching for tickets by the category field, specific terms must be used instead of the category names:

+ *
    + *
  • For Customer category tickets, use the term request.
    • + *
  • For Back-office category tickets, use the term task.
    • + *
  • For Tracker category tickets, use the term tracker. + * {% /admonition %}
    • + *
+ *

Accepted Operators

+ *

{% admonition type="info" name="Searching based on created_at" %} + * You may use the <= or >= operators to search by created_at. + * {% /admonition %}

+ *

The table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string ("="). The operator has to be compatible with the field's type (eg. you cannot search with > for a given string value as it's only compatible for integer's and dates).

+ *

| Operator | Valid Types | Description | + * | :------- | :----------------------------- | :----------------------------------------------------------- | + * | = | All | Equals | + * | != | All | Doesn't Equal | + * | IN | All | In Shortcut for OR queries Values most be in Array | + * | NIN | All | Not In Shortcut for OR ! queries Values must be in Array | + * | > | Integer Date (UNIX Timestamp) | Greater (or equal) than | + * | < | Integer Date (UNIX Timestamp) | Lower (or equal) than | + * | ~ | String | Contains | + * | !~ | String | Doesn't Contain | + * | ^ | String | Starts With | + * | $ | String | Ends With |

+ */ + public CompletableFuture>> search( + SearchRequest request, RequestOptions requestOptions) { + return this.rawClient.search(request, requestOptions).thenApply(response -> response.body()); + } +} diff --git a/src/main/java/com/intercom/api/resources/tickets/RawTicketsClient.java b/src/main/java/com/intercom/api/resources/tickets/RawTicketsClient.java new file mode 100644 index 00000000..e14e2b17 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/tickets/RawTicketsClient.java @@ -0,0 +1,595 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.tickets; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.fasterxml.jackson.core.type.TypeReference; +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.IntercomApiException; +import com.intercom.api.core.IntercomException; +import com.intercom.api.core.IntercomHttpResponse; +import com.intercom.api.core.MediaTypes; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.core.pagination.SyncPagingIterable; +import com.intercom.api.errors.BadRequestError; +import com.intercom.api.errors.NotFoundError; +import com.intercom.api.errors.UnauthorizedError; +import com.intercom.api.resources.jobs.types.Jobs; +import com.intercom.api.resources.tickets.requests.CreateTicketRequest; +import com.intercom.api.resources.tickets.requests.DeleteTicketRequest; +import com.intercom.api.resources.tickets.requests.EnqueueCreateTicketRequest; +import com.intercom.api.resources.tickets.requests.FindTicketRequest; +import com.intercom.api.resources.tickets.requests.ReplyToTicketRequest; +import com.intercom.api.resources.tickets.requests.UpdateTicketRequest; +import com.intercom.api.resources.tickets.types.DeleteTicketResponse; +import com.intercom.api.resources.tickets.types.Ticket; +import com.intercom.api.types.CursorPages; +import com.intercom.api.types.Error; +import com.intercom.api.types.SearchRequest; +import com.intercom.api.types.StartingAfterPaging; +import com.intercom.api.types.TicketList; +import com.intercom.api.types.TicketReply; +import java.io.IOException; +import java.util.Collections; +import java.util.List; +import java.util.Optional; +import okhttp3.Headers; +import okhttp3.HttpUrl; +import okhttp3.OkHttpClient; +import okhttp3.Request; +import okhttp3.RequestBody; +import okhttp3.Response; +import okhttp3.ResponseBody; + +public class RawTicketsClient { + protected final ClientOptions clientOptions; + + public RawTicketsClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + } + + /** + * You can reply to a ticket with a message from an admin or on behalf of a contact, or with a note for admins. + */ + public IntercomHttpResponse reply(ReplyToTicketRequest request) { + return reply(request, null); + } + + /** + * You can reply to a ticket with a message from an admin or on behalf of a contact, or with a note for admins. + */ + public IntercomHttpResponse reply(ReplyToTicketRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("tickets") + .addPathSegment(request.getTicketId()) + .addPathSegments("reply") + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request.getBody()), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, TicketReply.class), response); + } + try { + switch (response.code()) { + case 400: + throw new BadRequestError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 404: + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can create a new ticket. + */ + public IntercomHttpResponse> create(CreateTicketRequest request) { + return create(request, null); + } + + /** + * You can create a new ticket. + */ + public IntercomHttpResponse> create(CreateTicketRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("tickets") + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue( + responseBodyString, new TypeReference>() {}), + response); + } + try { + if (response.code() == 401) { + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * Enqueues ticket creation for asynchronous processing, returning if the job was enqueued successfully to be processed. We attempt to perform a best-effort validation on inputs before tasks are enqueued. If the given parameters are incorrect, we won't enqueue the job. + */ + public IntercomHttpResponse enqueueCreateTicket(EnqueueCreateTicketRequest request) { + return enqueueCreateTicket(request, null); + } + + /** + * Enqueues ticket creation for asynchronous processing, returning if the job was enqueued successfully to be processed. We attempt to perform a best-effort validation on inputs before tasks are enqueued. If the given parameters are incorrect, we won't enqueue the job. + */ + public IntercomHttpResponse enqueueCreateTicket( + EnqueueCreateTicketRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("tickets/enqueue") + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Jobs.class), response); + } + try { + switch (response.code()) { + case 400: + throw new BadRequestError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can fetch the details of a single ticket. + */ + public IntercomHttpResponse> get(FindTicketRequest request) { + return get(request, null); + } + + /** + * You can fetch the details of a single ticket. + */ + public IntercomHttpResponse> get(FindTicketRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("tickets") + .addPathSegment(request.getTicketId()) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("GET", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue( + responseBodyString, new TypeReference>() {}), + response); + } + try { + if (response.code() == 401) { + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can update a ticket. + */ + public IntercomHttpResponse> update(UpdateTicketRequest request) { + return update(request, null); + } + + /** + * You can update a ticket. + */ + public IntercomHttpResponse> update(UpdateTicketRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("tickets") + .addPathSegment(request.getTicketId()) + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("PUT", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue( + responseBodyString, new TypeReference>() {}), + response); + } + try { + switch (response.code()) { + case 400: + throw new BadRequestError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 404: + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can delete a ticket using the Intercom provided ID. + */ + public IntercomHttpResponse deleteTicket(DeleteTicketRequest request) { + return deleteTicket(request, null); + } + + /** + * You can delete a ticket using the Intercom provided ID. + */ + public IntercomHttpResponse deleteTicket( + DeleteTicketRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("tickets") + .addPathSegment(request.getTicketId()) + .build(); + Request.Builder _requestBuilder = new Request.Builder() + .url(httpUrl) + .method("DELETE", null) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Accept", "application/json"); + Request okhttpRequest = _requestBuilder.build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + return new IntercomHttpResponse<>( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, DeleteTicketResponse.class), response); + } + try { + switch (response.code()) { + case 401: + throw new UnauthorizedError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Error.class), response); + case 404: + throw new NotFoundError( + ObjectMappers.JSON_MAPPER.readValue(responseBodyString, Object.class), response); + } + } catch (JsonProcessingException ignored) { + // unable to map error response, throwing generic error + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } + + /** + * You can search for multiple tickets by the value of their attributes in order to fetch exactly which ones you want. + *

To search for tickets, you send a POST request to https://api.intercom.io/tickets/search.

+ *

This will accept a query object in the body which will define your filters. + * {% admonition type="warning" name="Optimizing search queries" %} + * Search queries can be complex, so optimizing them can help the performance of your search. + * Use the AND and OR operators to combine multiple filters to get the exact results you need and utilize + * pagination to limit the number of results returned. The default is 20 results per page. + * See the pagination section for more details on how to use the starting_after param. + * {% /admonition %}

+ *

Nesting & Limitations

+ *

You can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4). + * There are some limitations to the amount of multiples there can be:

+ *
    + *
  • There's a limit of max 2 nested filters
    • + *
  • There's a limit of max 15 filters for each AND or OR group
    • + *
+ *

Accepted Fields

+ *

Most keys listed as part of the Ticket model are searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as created_at accepts a date, the value cannot be a string such as "foobar"). + * The source.body field is unique as the search will not be performed against the entire value, but instead against every element of the value separately. For example, when searching for a conversation with a "I need support" body - the query should contain a = operator with the value "support" for such conversation to be returned. A query with a = operator and a "need support" value will not yield a result.

+ *

| Field | Type | + * | :---------------------------------------- | :--------------------------------------------------------------------------------------- | + * | id | String | + * | created_at | Date (UNIX timestamp) | + * | updated_at | Date (UNIX timestamp) | + * | title | String | + * | description | String | + * | category | String | + * | ticket_type_id | String | + * | contact_ids | String | + * | teammate_ids | String | + * | admin_assignee_id | String | + * | team_assignee_id | String | + * | open | Boolean | + * | state | String | + * | snoozed_until | Date (UNIX timestamp) | + * | ticket_attribute.{id} | String or Boolean or Date (UNIX timestamp) or Float or Integer |

+ *

{% admonition type="info" name="Searching by Category" %} + * When searching for tickets by the category field, specific terms must be used instead of the category names:

+ *
    + *
  • For Customer category tickets, use the term request.
    • + *
  • For Back-office category tickets, use the term task.
    • + *
  • For Tracker category tickets, use the term tracker. + * {% /admonition %}
    • + *
+ *

Accepted Operators

+ *

{% admonition type="info" name="Searching based on created_at" %} + * You may use the <= or >= operators to search by created_at. + * {% /admonition %}

+ *

The table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string ("="). The operator has to be compatible with the field's type (eg. you cannot search with > for a given string value as it's only compatible for integer's and dates).

+ *

| Operator | Valid Types | Description | + * | :------- | :----------------------------- | :----------------------------------------------------------- | + * | = | All | Equals | + * | != | All | Doesn't Equal | + * | IN | All | In Shortcut for OR queries Values most be in Array | + * | NIN | All | Not In Shortcut for OR ! queries Values must be in Array | + * | > | Integer Date (UNIX Timestamp) | Greater (or equal) than | + * | < | Integer Date (UNIX Timestamp) | Lower (or equal) than | + * | ~ | String | Contains | + * | !~ | String | Doesn't Contain | + * | ^ | String | Starts With | + * | $ | String | Ends With |

+ */ + public IntercomHttpResponse>> search(SearchRequest request) { + return search(request, null); + } + + /** + * You can search for multiple tickets by the value of their attributes in order to fetch exactly which ones you want. + *

To search for tickets, you send a POST request to https://api.intercom.io/tickets/search.

+ *

This will accept a query object in the body which will define your filters. + * {% admonition type="warning" name="Optimizing search queries" %} + * Search queries can be complex, so optimizing them can help the performance of your search. + * Use the AND and OR operators to combine multiple filters to get the exact results you need and utilize + * pagination to limit the number of results returned. The default is 20 results per page. + * See the pagination section for more details on how to use the starting_after param. + * {% /admonition %}

+ *

Nesting & Limitations

+ *

You can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4). + * There are some limitations to the amount of multiples there can be:

+ *
    + *
  • There's a limit of max 2 nested filters
    • + *
  • There's a limit of max 15 filters for each AND or OR group
    • + *
+ *

Accepted Fields

+ *

Most keys listed as part of the Ticket model are searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as created_at accepts a date, the value cannot be a string such as "foobar"). + * The source.body field is unique as the search will not be performed against the entire value, but instead against every element of the value separately. For example, when searching for a conversation with a "I need support" body - the query should contain a = operator with the value "support" for such conversation to be returned. A query with a = operator and a "need support" value will not yield a result.

+ *

| Field | Type | + * | :---------------------------------------- | :--------------------------------------------------------------------------------------- | + * | id | String | + * | created_at | Date (UNIX timestamp) | + * | updated_at | Date (UNIX timestamp) | + * | title | String | + * | description | String | + * | category | String | + * | ticket_type_id | String | + * | contact_ids | String | + * | teammate_ids | String | + * | admin_assignee_id | String | + * | team_assignee_id | String | + * | open | Boolean | + * | state | String | + * | snoozed_until | Date (UNIX timestamp) | + * | ticket_attribute.{id} | String or Boolean or Date (UNIX timestamp) or Float or Integer |

+ *

{% admonition type="info" name="Searching by Category" %} + * When searching for tickets by the category field, specific terms must be used instead of the category names:

+ *
    + *
  • For Customer category tickets, use the term request.
    • + *
  • For Back-office category tickets, use the term task.
    • + *
  • For Tracker category tickets, use the term tracker. + * {% /admonition %}
    • + *
+ *

Accepted Operators

+ *

{% admonition type="info" name="Searching based on created_at" %} + * You may use the <= or >= operators to search by created_at. + * {% /admonition %}

+ *

The table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string ("="). The operator has to be compatible with the field's type (eg. you cannot search with > for a given string value as it's only compatible for integer's and dates).

+ *

| Operator | Valid Types | Description | + * | :------- | :----------------------------- | :----------------------------------------------------------- | + * | = | All | Equals | + * | != | All | Doesn't Equal | + * | IN | All | In Shortcut for OR queries Values most be in Array | + * | NIN | All | Not In Shortcut for OR ! queries Values must be in Array | + * | > | Integer Date (UNIX Timestamp) | Greater (or equal) than | + * | < | Integer Date (UNIX Timestamp) | Lower (or equal) than | + * | ~ | String | Contains | + * | !~ | String | Doesn't Contain | + * | ^ | String | Starts With | + * | $ | String | Ends With |

+ */ + public IntercomHttpResponse>> search( + SearchRequest request, RequestOptions requestOptions) { + HttpUrl httpUrl = HttpUrl.parse(this.clientOptions.environment().getUrl()) + .newBuilder() + .addPathSegments("tickets/search") + .build(); + RequestBody body; + try { + body = RequestBody.create( + ObjectMappers.JSON_MAPPER.writeValueAsBytes(request), MediaTypes.APPLICATION_JSON); + } catch (JsonProcessingException e) { + throw new IntercomException("Failed to serialize request", e); + } + Request okhttpRequest = new Request.Builder() + .url(httpUrl) + .method("POST", body) + .headers(Headers.of(clientOptions.headers(requestOptions))) + .addHeader("Content-Type", "application/json") + .addHeader("Accept", "application/json") + .build(); + OkHttpClient client = clientOptions.httpClient(); + if (requestOptions != null && requestOptions.getTimeout().isPresent()) { + client = clientOptions.httpClientWithTimeout(requestOptions); + } + try (Response response = client.newCall(okhttpRequest).execute()) { + ResponseBody responseBody = response.body(); + String responseBodyString = responseBody != null ? responseBody.string() : "{}"; + if (response.isSuccessful()) { + TicketList parsedResponse = ObjectMappers.JSON_MAPPER.readValue(responseBodyString, TicketList.class); + Optional startingAfter = parsedResponse + .getPages() + .flatMap(CursorPages::getNext) + .flatMap(StartingAfterPaging::getStartingAfter); + Optional pagination = request.getPagination() + .map((StartingAfterPaging pagination_) -> StartingAfterPaging.builder() + .from(pagination_) + .startingAfter(startingAfter) + .build()); + SearchRequest nextRequest = SearchRequest.builder() + .from(request) + .pagination(pagination) + .build(); + List> result = parsedResponse.getTickets().orElse(Collections.emptyList()); + return new IntercomHttpResponse<>( + new SyncPagingIterable>( + startingAfter.isPresent(), result, parsedResponse, () -> search( + nextRequest, requestOptions) + .body()), + response); + } + Object errorBody = ObjectMappers.parseErrorBody(responseBodyString); + throw new IntercomApiException( + "Error with status code " + response.code(), response.code(), errorBody, response); + } catch (IOException e) { + throw new IntercomException("Network error executing HTTP request", e); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/tickets/TicketsClient.java b/src/main/java/com/intercom/api/resources/tickets/TicketsClient.java new file mode 100644 index 00000000..841952fc --- /dev/null +++ b/src/main/java/com/intercom/api/resources/tickets/TicketsClient.java @@ -0,0 +1,256 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.tickets; + +import com.intercom.api.core.ClientOptions; +import com.intercom.api.core.RequestOptions; +import com.intercom.api.core.pagination.SyncPagingIterable; +import com.intercom.api.resources.jobs.types.Jobs; +import com.intercom.api.resources.tickets.requests.CreateTicketRequest; +import com.intercom.api.resources.tickets.requests.DeleteTicketRequest; +import com.intercom.api.resources.tickets.requests.EnqueueCreateTicketRequest; +import com.intercom.api.resources.tickets.requests.FindTicketRequest; +import com.intercom.api.resources.tickets.requests.ReplyToTicketRequest; +import com.intercom.api.resources.tickets.requests.UpdateTicketRequest; +import com.intercom.api.resources.tickets.types.DeleteTicketResponse; +import com.intercom.api.resources.tickets.types.Ticket; +import com.intercom.api.types.SearchRequest; +import com.intercom.api.types.TicketReply; +import java.util.Optional; + +public class TicketsClient { + protected final ClientOptions clientOptions; + + private final RawTicketsClient rawClient; + + public TicketsClient(ClientOptions clientOptions) { + this.clientOptions = clientOptions; + this.rawClient = new RawTicketsClient(clientOptions); + } + + /** + * Get responses with HTTP metadata like headers + */ + public RawTicketsClient withRawResponse() { + return this.rawClient; + } + + /** + * You can reply to a ticket with a message from an admin or on behalf of a contact, or with a note for admins. + */ + public TicketReply reply(ReplyToTicketRequest request) { + return this.rawClient.reply(request).body(); + } + + /** + * You can reply to a ticket with a message from an admin or on behalf of a contact, or with a note for admins. + */ + public TicketReply reply(ReplyToTicketRequest request, RequestOptions requestOptions) { + return this.rawClient.reply(request, requestOptions).body(); + } + + /** + * You can create a new ticket. + */ + public Optional create(CreateTicketRequest request) { + return this.rawClient.create(request).body(); + } + + /** + * You can create a new ticket. + */ + public Optional create(CreateTicketRequest request, RequestOptions requestOptions) { + return this.rawClient.create(request, requestOptions).body(); + } + + /** + * Enqueues ticket creation for asynchronous processing, returning if the job was enqueued successfully to be processed. We attempt to perform a best-effort validation on inputs before tasks are enqueued. If the given parameters are incorrect, we won't enqueue the job. + */ + public Jobs enqueueCreateTicket(EnqueueCreateTicketRequest request) { + return this.rawClient.enqueueCreateTicket(request).body(); + } + + /** + * Enqueues ticket creation for asynchronous processing, returning if the job was enqueued successfully to be processed. We attempt to perform a best-effort validation on inputs before tasks are enqueued. If the given parameters are incorrect, we won't enqueue the job. + */ + public Jobs enqueueCreateTicket(EnqueueCreateTicketRequest request, RequestOptions requestOptions) { + return this.rawClient.enqueueCreateTicket(request, requestOptions).body(); + } + + /** + * You can fetch the details of a single ticket. + */ + public Optional get(FindTicketRequest request) { + return this.rawClient.get(request).body(); + } + + /** + * You can fetch the details of a single ticket. + */ + public Optional get(FindTicketRequest request, RequestOptions requestOptions) { + return this.rawClient.get(request, requestOptions).body(); + } + + /** + * You can update a ticket. + */ + public Optional update(UpdateTicketRequest request) { + return this.rawClient.update(request).body(); + } + + /** + * You can update a ticket. + */ + public Optional update(UpdateTicketRequest request, RequestOptions requestOptions) { + return this.rawClient.update(request, requestOptions).body(); + } + + /** + * You can delete a ticket using the Intercom provided ID. + */ + public DeleteTicketResponse deleteTicket(DeleteTicketRequest request) { + return this.rawClient.deleteTicket(request).body(); + } + + /** + * You can delete a ticket using the Intercom provided ID. + */ + public DeleteTicketResponse deleteTicket(DeleteTicketRequest request, RequestOptions requestOptions) { + return this.rawClient.deleteTicket(request, requestOptions).body(); + } + + /** + * You can search for multiple tickets by the value of their attributes in order to fetch exactly which ones you want. + *

To search for tickets, you send a POST request to https://api.intercom.io/tickets/search.

+ *

This will accept a query object in the body which will define your filters. + * {% admonition type="warning" name="Optimizing search queries" %} + * Search queries can be complex, so optimizing them can help the performance of your search. + * Use the AND and OR operators to combine multiple filters to get the exact results you need and utilize + * pagination to limit the number of results returned. The default is 20 results per page. + * See the pagination section for more details on how to use the starting_after param. + * {% /admonition %}

+ *

Nesting & Limitations

+ *

You can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4). + * There are some limitations to the amount of multiples there can be:

+ *
    + *
  • There's a limit of max 2 nested filters
    • + *
  • There's a limit of max 15 filters for each AND or OR group
    • + *
+ *

Accepted Fields

+ *

Most keys listed as part of the Ticket model are searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as created_at accepts a date, the value cannot be a string such as "foobar"). + * The source.body field is unique as the search will not be performed against the entire value, but instead against every element of the value separately. For example, when searching for a conversation with a "I need support" body - the query should contain a = operator with the value "support" for such conversation to be returned. A query with a = operator and a "need support" value will not yield a result.

+ *

| Field | Type | + * | :---------------------------------------- | :--------------------------------------------------------------------------------------- | + * | id | String | + * | created_at | Date (UNIX timestamp) | + * | updated_at | Date (UNIX timestamp) | + * | title | String | + * | description | String | + * | category | String | + * | ticket_type_id | String | + * | contact_ids | String | + * | teammate_ids | String | + * | admin_assignee_id | String | + * | team_assignee_id | String | + * | open | Boolean | + * | state | String | + * | snoozed_until | Date (UNIX timestamp) | + * | ticket_attribute.{id} | String or Boolean or Date (UNIX timestamp) or Float or Integer |

+ *

{% admonition type="info" name="Searching by Category" %} + * When searching for tickets by the category field, specific terms must be used instead of the category names:

+ *
    + *
  • For Customer category tickets, use the term request.
    • + *
  • For Back-office category tickets, use the term task.
    • + *
  • For Tracker category tickets, use the term tracker. + * {% /admonition %}
    • + *
+ *

Accepted Operators

+ *

{% admonition type="info" name="Searching based on created_at" %} + * You may use the <= or >= operators to search by created_at. + * {% /admonition %}

+ *

The table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string ("="). The operator has to be compatible with the field's type (eg. you cannot search with > for a given string value as it's only compatible for integer's and dates).

+ *

| Operator | Valid Types | Description | + * | :------- | :----------------------------- | :----------------------------------------------------------- | + * | = | All | Equals | + * | != | All | Doesn't Equal | + * | IN | All | In Shortcut for OR queries Values most be in Array | + * | NIN | All | Not In Shortcut for OR ! queries Values must be in Array | + * | > | Integer Date (UNIX Timestamp) | Greater (or equal) than | + * | < | Integer Date (UNIX Timestamp) | Lower (or equal) than | + * | ~ | String | Contains | + * | !~ | String | Doesn't Contain | + * | ^ | String | Starts With | + * | $ | String | Ends With |

+ */ + public SyncPagingIterable> search(SearchRequest request) { + return this.rawClient.search(request).body(); + } + + /** + * You can search for multiple tickets by the value of their attributes in order to fetch exactly which ones you want. + *

To search for tickets, you send a POST request to https://api.intercom.io/tickets/search.

+ *

This will accept a query object in the body which will define your filters. + * {% admonition type="warning" name="Optimizing search queries" %} + * Search queries can be complex, so optimizing them can help the performance of your search. + * Use the AND and OR operators to combine multiple filters to get the exact results you need and utilize + * pagination to limit the number of results returned. The default is 20 results per page. + * See the pagination section for more details on how to use the starting_after param. + * {% /admonition %}

+ *

Nesting & Limitations

+ *

You can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4). + * There are some limitations to the amount of multiples there can be:

+ *
    + *
  • There's a limit of max 2 nested filters
    • + *
  • There's a limit of max 15 filters for each AND or OR group
    • + *
+ *

Accepted Fields

+ *

Most keys listed as part of the Ticket model are searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as created_at accepts a date, the value cannot be a string such as "foobar"). + * The source.body field is unique as the search will not be performed against the entire value, but instead against every element of the value separately. For example, when searching for a conversation with a "I need support" body - the query should contain a = operator with the value "support" for such conversation to be returned. A query with a = operator and a "need support" value will not yield a result.

+ *

| Field | Type | + * | :---------------------------------------- | :--------------------------------------------------------------------------------------- | + * | id | String | + * | created_at | Date (UNIX timestamp) | + * | updated_at | Date (UNIX timestamp) | + * | title | String | + * | description | String | + * | category | String | + * | ticket_type_id | String | + * | contact_ids | String | + * | teammate_ids | String | + * | admin_assignee_id | String | + * | team_assignee_id | String | + * | open | Boolean | + * | state | String | + * | snoozed_until | Date (UNIX timestamp) | + * | ticket_attribute.{id} | String or Boolean or Date (UNIX timestamp) or Float or Integer |

+ *

{% admonition type="info" name="Searching by Category" %} + * When searching for tickets by the category field, specific terms must be used instead of the category names:

+ *
    + *
  • For Customer category tickets, use the term request.
    • + *
  • For Back-office category tickets, use the term task.
    • + *
  • For Tracker category tickets, use the term tracker. + * {% /admonition %}
    • + *
+ *

Accepted Operators

+ *

{% admonition type="info" name="Searching based on created_at" %} + * You may use the <= or >= operators to search by created_at. + * {% /admonition %}

+ *

The table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string ("="). The operator has to be compatible with the field's type (eg. you cannot search with > for a given string value as it's only compatible for integer's and dates).

+ *

| Operator | Valid Types | Description | + * | :------- | :----------------------------- | :----------------------------------------------------------- | + * | = | All | Equals | + * | != | All | Doesn't Equal | + * | IN | All | In Shortcut for OR queries Values most be in Array | + * | NIN | All | Not In Shortcut for OR ! queries Values must be in Array | + * | > | Integer Date (UNIX Timestamp) | Greater (or equal) than | + * | < | Integer Date (UNIX Timestamp) | Lower (or equal) than | + * | ~ | String | Contains | + * | !~ | String | Doesn't Contain | + * | ^ | String | Starts With | + * | $ | String | Ends With |

+ */ + public SyncPagingIterable> search(SearchRequest request, RequestOptions requestOptions) { + return this.rawClient.search(request, requestOptions).body(); + } +} diff --git a/src/main/java/com/intercom/api/resources/tickets/requests/CreateTicketRequest.java b/src/main/java/com/intercom/api/resources/tickets/requests/CreateTicketRequest.java new file mode 100644 index 00000000..29ecd99f --- /dev/null +++ b/src/main/java/com/intercom/api/resources/tickets/requests/CreateTicketRequest.java @@ -0,0 +1,922 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.tickets.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.JsonValue; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.core.JsonParseException; +import com.fasterxml.jackson.core.JsonParser; +import com.fasterxml.jackson.databind.DeserializationContext; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.fasterxml.jackson.databind.deser.std.StdDeserializer; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.types.ICreateTicketRequestBody; +import java.io.IOException; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = CreateTicketRequest.Builder.class) +public final class CreateTicketRequest implements ICreateTicketRequestBody { + private final String ticketTypeId; + + private final List contacts; + + private final Optional conversationToLinkId; + + private final Optional companyId; + + private final Optional createdAt; + + private final Optional assignment; + + private final Optional skipNotifications; + + private final Map additionalProperties; + + private CreateTicketRequest( + String ticketTypeId, + List contacts, + Optional conversationToLinkId, + Optional companyId, + Optional createdAt, + Optional assignment, + Optional skipNotifications, + Map additionalProperties) { + this.ticketTypeId = ticketTypeId; + this.contacts = contacts; + this.conversationToLinkId = conversationToLinkId; + this.companyId = companyId; + this.createdAt = createdAt; + this.assignment = assignment; + this.skipNotifications = skipNotifications; + this.additionalProperties = additionalProperties; + } + + /** + * @return The ID of the type of ticket you want to create + */ + @JsonProperty("ticket_type_id") + public String getTicketTypeId() { + return ticketTypeId; + } + + /** + * @return The list of contacts (users or leads) affected by this ticket. Currently only one is allowed + */ + @JsonProperty("contacts") + public List getContacts() { + return contacts; + } + + /** + * @return The ID of the conversation you want to link to the ticket. Here are the valid ways of linking two tickets: + *
    + *
  • conversation | back-office ticket
    • + *
  • customer tickets | non-shared back-office ticket
    • + *
  • conversation | tracker ticket
    • + *
  • customer ticket | tracker ticket
    • + *
+ */ + @JsonProperty("conversation_to_link_id") + public Optional getConversationToLinkId() { + return conversationToLinkId; + } + + /** + * @return The ID of the company that the ticket is associated with. The unique identifier for the company which is given by Intercom + */ + @JsonProperty("company_id") + public Optional getCompanyId() { + return companyId; + } + + /** + * @return The time the ticket was created. If not provided, the current time will be used. + */ + @JsonProperty("created_at") + public Optional getCreatedAt() { + return createdAt; + } + + @JsonProperty("assignment") + public Optional getAssignment() { + return assignment; + } + + /** + * @return Option to disable notifications when a Ticket is created. + */ + @JsonProperty("skip_notifications") + public Optional getSkipNotifications() { + return skipNotifications; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof CreateTicketRequest && equalTo((CreateTicketRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(CreateTicketRequest other) { + return ticketTypeId.equals(other.ticketTypeId) + && contacts.equals(other.contacts) + && conversationToLinkId.equals(other.conversationToLinkId) + && companyId.equals(other.companyId) + && createdAt.equals(other.createdAt) + && assignment.equals(other.assignment) + && skipNotifications.equals(other.skipNotifications); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash( + this.ticketTypeId, + this.contacts, + this.conversationToLinkId, + this.companyId, + this.createdAt, + this.assignment, + this.skipNotifications); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static TicketTypeIdStage builder() { + return new Builder(); + } + + public interface TicketTypeIdStage { + /** + *

The ID of the type of ticket you want to create

+ */ + _FinalStage ticketTypeId(@NotNull String ticketTypeId); + + Builder from(CreateTicketRequest other); + } + + public interface _FinalStage { + CreateTicketRequest build(); + + /** + *

The list of contacts (users or leads) affected by this ticket. Currently only one is allowed

+ */ + _FinalStage contacts(List contacts); + + _FinalStage addContacts(ContactsItem contacts); + + _FinalStage addAllContacts(List contacts); + + /** + *

The ID of the conversation you want to link to the ticket. Here are the valid ways of linking two tickets:

+ *
    + *
  • conversation | back-office ticket
    • + *
  • customer tickets | non-shared back-office ticket
    • + *
  • conversation | tracker ticket
    • + *
  • customer ticket | tracker ticket
    • + *
+ */ + _FinalStage conversationToLinkId(Optional conversationToLinkId); + + _FinalStage conversationToLinkId(String conversationToLinkId); + + /** + *

The ID of the company that the ticket is associated with. The unique identifier for the company which is given by Intercom

+ */ + _FinalStage companyId(Optional companyId); + + _FinalStage companyId(String companyId); + + /** + *

The time the ticket was created. If not provided, the current time will be used.

+ */ + _FinalStage createdAt(Optional createdAt); + + _FinalStage createdAt(Integer createdAt); + + _FinalStage assignment(Optional assignment); + + _FinalStage assignment(Assignment assignment); + + /** + *

Option to disable notifications when a Ticket is created.

+ */ + _FinalStage skipNotifications(Optional skipNotifications); + + _FinalStage skipNotifications(Boolean skipNotifications); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements TicketTypeIdStage, _FinalStage { + private String ticketTypeId; + + private Optional skipNotifications = Optional.empty(); + + private Optional assignment = Optional.empty(); + + private Optional createdAt = Optional.empty(); + + private Optional companyId = Optional.empty(); + + private Optional conversationToLinkId = Optional.empty(); + + private List contacts = new ArrayList<>(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(CreateTicketRequest other) { + ticketTypeId(other.getTicketTypeId()); + contacts(other.getContacts()); + conversationToLinkId(other.getConversationToLinkId()); + companyId(other.getCompanyId()); + createdAt(other.getCreatedAt()); + assignment(other.getAssignment()); + skipNotifications(other.getSkipNotifications()); + return this; + } + + /** + *

The ID of the type of ticket you want to create

+ *

The ID of the type of ticket you want to create

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("ticket_type_id") + public _FinalStage ticketTypeId(@NotNull String ticketTypeId) { + this.ticketTypeId = Objects.requireNonNull(ticketTypeId, "ticketTypeId must not be null"); + return this; + } + + /** + *

Option to disable notifications when a Ticket is created.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage skipNotifications(Boolean skipNotifications) { + this.skipNotifications = Optional.ofNullable(skipNotifications); + return this; + } + + /** + *

Option to disable notifications when a Ticket is created.

+ */ + @java.lang.Override + @JsonSetter(value = "skip_notifications", nulls = Nulls.SKIP) + public _FinalStage skipNotifications(Optional skipNotifications) { + this.skipNotifications = skipNotifications; + return this; + } + + @java.lang.Override + public _FinalStage assignment(Assignment assignment) { + this.assignment = Optional.ofNullable(assignment); + return this; + } + + @java.lang.Override + @JsonSetter(value = "assignment", nulls = Nulls.SKIP) + public _FinalStage assignment(Optional assignment) { + this.assignment = assignment; + return this; + } + + /** + *

The time the ticket was created. If not provided, the current time will be used.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage createdAt(Integer createdAt) { + this.createdAt = Optional.ofNullable(createdAt); + return this; + } + + /** + *

The time the ticket was created. If not provided, the current time will be used.

+ */ + @java.lang.Override + @JsonSetter(value = "created_at", nulls = Nulls.SKIP) + public _FinalStage createdAt(Optional createdAt) { + this.createdAt = createdAt; + return this; + } + + /** + *

The ID of the company that the ticket is associated with. The unique identifier for the company which is given by Intercom

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage companyId(String companyId) { + this.companyId = Optional.ofNullable(companyId); + return this; + } + + /** + *

The ID of the company that the ticket is associated with. The unique identifier for the company which is given by Intercom

+ */ + @java.lang.Override + @JsonSetter(value = "company_id", nulls = Nulls.SKIP) + public _FinalStage companyId(Optional companyId) { + this.companyId = companyId; + return this; + } + + /** + *

The ID of the conversation you want to link to the ticket. Here are the valid ways of linking two tickets:

+ *
    + *
  • conversation | back-office ticket
    • + *
  • customer tickets | non-shared back-office ticket
    • + *
  • conversation | tracker ticket
    • + *
  • customer ticket | tracker ticket
    • + *
+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage conversationToLinkId(String conversationToLinkId) { + this.conversationToLinkId = Optional.ofNullable(conversationToLinkId); + return this; + } + + /** + *

The ID of the conversation you want to link to the ticket. Here are the valid ways of linking two tickets:

+ *
    + *
  • conversation | back-office ticket
    • + *
  • customer tickets | non-shared back-office ticket
    • + *
  • conversation | tracker ticket
    • + *
  • customer ticket | tracker ticket
    • + *
+ */ + @java.lang.Override + @JsonSetter(value = "conversation_to_link_id", nulls = Nulls.SKIP) + public _FinalStage conversationToLinkId(Optional conversationToLinkId) { + this.conversationToLinkId = conversationToLinkId; + return this; + } + + /** + *

The list of contacts (users or leads) affected by this ticket. Currently only one is allowed

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage addAllContacts(List contacts) { + if (contacts != null) { + this.contacts.addAll(contacts); + } + return this; + } + + /** + *

The list of contacts (users or leads) affected by this ticket. Currently only one is allowed

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage addContacts(ContactsItem contacts) { + this.contacts.add(contacts); + return this; + } + + /** + *

The list of contacts (users or leads) affected by this ticket. Currently only one is allowed

+ */ + @java.lang.Override + @JsonSetter(value = "contacts", nulls = Nulls.SKIP) + public _FinalStage contacts(List contacts) { + this.contacts.clear(); + if (contacts != null) { + this.contacts.addAll(contacts); + } + return this; + } + + @java.lang.Override + public CreateTicketRequest build() { + return new CreateTicketRequest( + ticketTypeId, + contacts, + conversationToLinkId, + companyId, + createdAt, + assignment, + skipNotifications, + additionalProperties); + } + } + + @JsonDeserialize(using = ContactsItem.Deserializer.class) + public static final class ContactsItem { + private final Object value; + + private final int type; + + private ContactsItem(Object value, int type) { + this.value = value; + this.type = type; + } + + @JsonValue + public Object get() { + return this.value; + } + + @SuppressWarnings("unchecked") + public T visit(Visitor visitor) { + if (this.type == 0) { + return visitor.visit((Id) this.value); + } else if (this.type == 1) { + return visitor.visit((ExternalId) this.value); + } else if (this.type == 2) { + return visitor.visit((Email) this.value); + } + throw new IllegalStateException("Failed to visit value. This should never happen."); + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof ContactsItem && equalTo((ContactsItem) other); + } + + private boolean equalTo(ContactsItem other) { + return value.equals(other.value); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.value); + } + + @java.lang.Override + public String toString() { + return this.value.toString(); + } + + public static ContactsItem of(Id value) { + return new ContactsItem(value, 0); + } + + public static ContactsItem of(ExternalId value) { + return new ContactsItem(value, 1); + } + + public static ContactsItem of(Email value) { + return new ContactsItem(value, 2); + } + + public interface Visitor { + T visit(Id value); + + T visit(ExternalId value); + + T visit(Email value); + } + + static final class Deserializer extends StdDeserializer { + Deserializer() { + super(ContactsItem.class); + } + + @java.lang.Override + public ContactsItem deserialize(JsonParser p, DeserializationContext context) throws IOException { + Object value = p.readValueAs(Object.class); + try { + return of(ObjectMappers.JSON_MAPPER.convertValue(value, Id.class)); + } catch (RuntimeException e) { + } + try { + return of(ObjectMappers.JSON_MAPPER.convertValue(value, ExternalId.class)); + } catch (RuntimeException e) { + } + try { + return of(ObjectMappers.JSON_MAPPER.convertValue(value, Email.class)); + } catch (RuntimeException e) { + } + throw new JsonParseException(p, "Failed to deserialize"); + } + } + + @JsonInclude(JsonInclude.Include.NON_ABSENT) + @JsonDeserialize(builder = ExternalId.Builder.class) + public static final class ExternalId { + private final String externalId; + + private final Map additionalProperties; + + private ExternalId(String externalId, Map additionalProperties) { + this.externalId = externalId; + this.additionalProperties = additionalProperties; + } + + /** + * @return The external_id you have defined for the contact who is being added as a participant. + */ + @JsonProperty("external_id") + public String getExternalId() { + return externalId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof ExternalId && equalTo((ExternalId) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(ExternalId other) { + return externalId.equals(other.externalId); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.externalId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static ExternalIdStage builder() { + return new Builder(); + } + + public interface ExternalIdStage { + /** + *

The external_id you have defined for the contact who is being added as a participant.

+ */ + _FinalStage externalId(@NotNull String externalId); + + Builder from(ExternalId other); + } + + public interface _FinalStage { + ExternalId build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements ExternalIdStage, _FinalStage { + private String externalId; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(ExternalId other) { + externalId(other.getExternalId()); + return this; + } + + /** + *

The external_id you have defined for the contact who is being added as a participant.

+ *

The external_id you have defined for the contact who is being added as a participant.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("external_id") + public _FinalStage externalId(@NotNull String externalId) { + this.externalId = Objects.requireNonNull(externalId, "externalId must not be null"); + return this; + } + + @java.lang.Override + public ExternalId build() { + return new ExternalId(externalId, additionalProperties); + } + } + } + + @JsonInclude(JsonInclude.Include.NON_ABSENT) + @JsonDeserialize(builder = Email.Builder.class) + public static final class Email { + private final String email; + + private final Map additionalProperties; + + private Email(String email, Map additionalProperties) { + this.email = email; + this.additionalProperties = additionalProperties; + } + + /** + * @return The email you have defined for the contact who is being added as a participant. If a contact with this email does not exist, one will be created. + */ + @JsonProperty("email") + public String getEmail() { + return email; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof Email && equalTo((Email) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(Email other) { + return email.equals(other.email); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.email); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static EmailStage builder() { + return new Builder(); + } + + public interface EmailStage { + /** + *

The email you have defined for the contact who is being added as a participant. If a contact with this email does not exist, one will be created.

+ */ + _FinalStage email(@NotNull String email); + + Builder from(Email other); + } + + public interface _FinalStage { + Email build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements EmailStage, _FinalStage { + private String email; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(Email other) { + email(other.getEmail()); + return this; + } + + /** + *

The email you have defined for the contact who is being added as a participant. If a contact with this email does not exist, one will be created.

+ *

The email you have defined for the contact who is being added as a participant. If a contact with this email does not exist, one will be created.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("email") + public _FinalStage email(@NotNull String email) { + this.email = Objects.requireNonNull(email, "email must not be null"); + return this; + } + + @java.lang.Override + public Email build() { + return new Email(email, additionalProperties); + } + } + } + + @JsonInclude(JsonInclude.Include.NON_ABSENT) + @JsonDeserialize(builder = Id.Builder.class) + public static final class Id { + private final String id; + + private final Map additionalProperties; + + private Id(String id, Map additionalProperties) { + this.id = id; + this.additionalProperties = additionalProperties; + } + + /** + * @return The identifier for the contact as given by Intercom. + */ + @JsonProperty("id") + public String getId() { + return id; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof Id && equalTo((Id) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(Id other) { + return id.equals(other.id); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.id); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static IdStage builder() { + return new Builder(); + } + + public interface IdStage { + /** + *

The identifier for the contact as given by Intercom.

+ */ + _FinalStage id(@NotNull String id); + + Builder from(Id other); + } + + public interface _FinalStage { + Id build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements IdStage, _FinalStage { + private String id; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(Id other) { + id(other.getId()); + return this; + } + + /** + *

The identifier for the contact as given by Intercom.

+ *

The identifier for the contact as given by Intercom.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("id") + public _FinalStage id(@NotNull String id) { + this.id = Objects.requireNonNull(id, "id must not be null"); + return this; + } + + @java.lang.Override + public Id build() { + return new Id(id, additionalProperties); + } + } + } + } + + @JsonInclude(JsonInclude.Include.NON_ABSENT) + @JsonDeserialize(builder = Assignment.Builder.class) + public static final class Assignment { + private final Optional adminAssigneeId; + + private final Optional teamAssigneeId; + + private final Map additionalProperties; + + private Assignment( + Optional adminAssigneeId, + Optional teamAssigneeId, + Map additionalProperties) { + this.adminAssigneeId = adminAssigneeId; + this.teamAssigneeId = teamAssigneeId; + this.additionalProperties = additionalProperties; + } + + /** + * @return The ID of the admin to which the ticket is assigned. If not provided, the ticket will be unassigned. + */ + @JsonProperty("admin_assignee_id") + public Optional getAdminAssigneeId() { + return adminAssigneeId; + } + + /** + * @return The ID of the team to which the ticket is assigned. If not provided, the ticket will be unassigned. + */ + @JsonProperty("team_assignee_id") + public Optional getTeamAssigneeId() { + return teamAssigneeId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof Assignment && equalTo((Assignment) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(Assignment other) { + return adminAssigneeId.equals(other.adminAssigneeId) && teamAssigneeId.equals(other.teamAssigneeId); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.adminAssigneeId, this.teamAssigneeId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static Builder builder() { + return new Builder(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder { + private Optional adminAssigneeId = Optional.empty(); + + private Optional teamAssigneeId = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + public Builder from(Assignment other) { + adminAssigneeId(other.getAdminAssigneeId()); + teamAssigneeId(other.getTeamAssigneeId()); + return this; + } + + /** + *

The ID of the admin to which the ticket is assigned. If not provided, the ticket will be unassigned.

+ */ + @JsonSetter(value = "admin_assignee_id", nulls = Nulls.SKIP) + public Builder adminAssigneeId(Optional adminAssigneeId) { + this.adminAssigneeId = adminAssigneeId; + return this; + } + + public Builder adminAssigneeId(String adminAssigneeId) { + this.adminAssigneeId = Optional.ofNullable(adminAssigneeId); + return this; + } + + /** + *

The ID of the team to which the ticket is assigned. If not provided, the ticket will be unassigned.

+ */ + @JsonSetter(value = "team_assignee_id", nulls = Nulls.SKIP) + public Builder teamAssigneeId(Optional teamAssigneeId) { + this.teamAssigneeId = teamAssigneeId; + return this; + } + + public Builder teamAssigneeId(String teamAssigneeId) { + this.teamAssigneeId = Optional.ofNullable(teamAssigneeId); + return this; + } + + public Assignment build() { + return new Assignment(adminAssigneeId, teamAssigneeId, additionalProperties); + } + } + } +} diff --git a/src/main/java/com/intercom/api/resources/tickets/requests/DeleteTicketRequest.java b/src/main/java/com/intercom/api/resources/tickets/requests/DeleteTicketRequest.java new file mode 100644 index 00000000..b07ea70f --- /dev/null +++ b/src/main/java/com/intercom/api/resources/tickets/requests/DeleteTicketRequest.java @@ -0,0 +1,113 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.tickets.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = DeleteTicketRequest.Builder.class) +public final class DeleteTicketRequest { + private final String ticketId; + + private final Map additionalProperties; + + private DeleteTicketRequest(String ticketId, Map additionalProperties) { + this.ticketId = ticketId; + this.additionalProperties = additionalProperties; + } + + /** + * @return The unique identifier for the ticket which is given by Intercom. + */ + @JsonProperty("ticket_id") + public String getTicketId() { + return ticketId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof DeleteTicketRequest && equalTo((DeleteTicketRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(DeleteTicketRequest other) { + return ticketId.equals(other.ticketId); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.ticketId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static TicketIdStage builder() { + return new Builder(); + } + + public interface TicketIdStage { + /** + *

The unique identifier for the ticket which is given by Intercom.

+ */ + _FinalStage ticketId(@NotNull String ticketId); + + Builder from(DeleteTicketRequest other); + } + + public interface _FinalStage { + DeleteTicketRequest build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements TicketIdStage, _FinalStage { + private String ticketId; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(DeleteTicketRequest other) { + ticketId(other.getTicketId()); + return this; + } + + /** + *

The unique identifier for the ticket which is given by Intercom.

+ *

The unique identifier for the ticket which is given by Intercom.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("ticket_id") + public _FinalStage ticketId(@NotNull String ticketId) { + this.ticketId = Objects.requireNonNull(ticketId, "ticketId must not be null"); + return this; + } + + @java.lang.Override + public DeleteTicketRequest build() { + return new DeleteTicketRequest(ticketId, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/tickets/requests/EnqueueCreateTicketRequest.java b/src/main/java/com/intercom/api/resources/tickets/requests/EnqueueCreateTicketRequest.java new file mode 100644 index 00000000..d0492c1d --- /dev/null +++ b/src/main/java/com/intercom/api/resources/tickets/requests/EnqueueCreateTicketRequest.java @@ -0,0 +1,922 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.tickets.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.JsonValue; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.core.JsonParseException; +import com.fasterxml.jackson.core.JsonParser; +import com.fasterxml.jackson.databind.DeserializationContext; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.fasterxml.jackson.databind.deser.std.StdDeserializer; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.types.ICreateTicketRequestBody; +import java.io.IOException; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = EnqueueCreateTicketRequest.Builder.class) +public final class EnqueueCreateTicketRequest implements ICreateTicketRequestBody { + private final String ticketTypeId; + + private final List contacts; + + private final Optional conversationToLinkId; + + private final Optional companyId; + + private final Optional createdAt; + + private final Optional assignment; + + private final Optional skipNotifications; + + private final Map additionalProperties; + + private EnqueueCreateTicketRequest( + String ticketTypeId, + List contacts, + Optional conversationToLinkId, + Optional companyId, + Optional createdAt, + Optional assignment, + Optional skipNotifications, + Map additionalProperties) { + this.ticketTypeId = ticketTypeId; + this.contacts = contacts; + this.conversationToLinkId = conversationToLinkId; + this.companyId = companyId; + this.createdAt = createdAt; + this.assignment = assignment; + this.skipNotifications = skipNotifications; + this.additionalProperties = additionalProperties; + } + + /** + * @return The ID of the type of ticket you want to create + */ + @JsonProperty("ticket_type_id") + public String getTicketTypeId() { + return ticketTypeId; + } + + /** + * @return The list of contacts (users or leads) affected by this ticket. Currently only one is allowed + */ + @JsonProperty("contacts") + public List getContacts() { + return contacts; + } + + /** + * @return The ID of the conversation you want to link to the ticket. Here are the valid ways of linking two tickets: + *
    + *
  • conversation | back-office ticket
    • + *
  • customer tickets | non-shared back-office ticket
    • + *
  • conversation | tracker ticket
    • + *
  • customer ticket | tracker ticket
    • + *
+ */ + @JsonProperty("conversation_to_link_id") + public Optional getConversationToLinkId() { + return conversationToLinkId; + } + + /** + * @return The ID of the company that the ticket is associated with. The unique identifier for the company which is given by Intercom + */ + @JsonProperty("company_id") + public Optional getCompanyId() { + return companyId; + } + + /** + * @return The time the ticket was created. If not provided, the current time will be used. + */ + @JsonProperty("created_at") + public Optional getCreatedAt() { + return createdAt; + } + + @JsonProperty("assignment") + public Optional getAssignment() { + return assignment; + } + + /** + * @return Option to disable notifications when a Ticket is created. + */ + @JsonProperty("skip_notifications") + public Optional getSkipNotifications() { + return skipNotifications; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof EnqueueCreateTicketRequest && equalTo((EnqueueCreateTicketRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(EnqueueCreateTicketRequest other) { + return ticketTypeId.equals(other.ticketTypeId) + && contacts.equals(other.contacts) + && conversationToLinkId.equals(other.conversationToLinkId) + && companyId.equals(other.companyId) + && createdAt.equals(other.createdAt) + && assignment.equals(other.assignment) + && skipNotifications.equals(other.skipNotifications); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash( + this.ticketTypeId, + this.contacts, + this.conversationToLinkId, + this.companyId, + this.createdAt, + this.assignment, + this.skipNotifications); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static TicketTypeIdStage builder() { + return new Builder(); + } + + public interface TicketTypeIdStage { + /** + *

The ID of the type of ticket you want to create

+ */ + _FinalStage ticketTypeId(@NotNull String ticketTypeId); + + Builder from(EnqueueCreateTicketRequest other); + } + + public interface _FinalStage { + EnqueueCreateTicketRequest build(); + + /** + *

The list of contacts (users or leads) affected by this ticket. Currently only one is allowed

+ */ + _FinalStage contacts(List contacts); + + _FinalStage addContacts(ContactsItem contacts); + + _FinalStage addAllContacts(List contacts); + + /** + *

The ID of the conversation you want to link to the ticket. Here are the valid ways of linking two tickets:

+ *
    + *
  • conversation | back-office ticket
    • + *
  • customer tickets | non-shared back-office ticket
    • + *
  • conversation | tracker ticket
    • + *
  • customer ticket | tracker ticket
    • + *
+ */ + _FinalStage conversationToLinkId(Optional conversationToLinkId); + + _FinalStage conversationToLinkId(String conversationToLinkId); + + /** + *

The ID of the company that the ticket is associated with. The unique identifier for the company which is given by Intercom

+ */ + _FinalStage companyId(Optional companyId); + + _FinalStage companyId(String companyId); + + /** + *

The time the ticket was created. If not provided, the current time will be used.

+ */ + _FinalStage createdAt(Optional createdAt); + + _FinalStage createdAt(Integer createdAt); + + _FinalStage assignment(Optional assignment); + + _FinalStage assignment(Assignment assignment); + + /** + *

Option to disable notifications when a Ticket is created.

+ */ + _FinalStage skipNotifications(Optional skipNotifications); + + _FinalStage skipNotifications(Boolean skipNotifications); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements TicketTypeIdStage, _FinalStage { + private String ticketTypeId; + + private Optional skipNotifications = Optional.empty(); + + private Optional assignment = Optional.empty(); + + private Optional createdAt = Optional.empty(); + + private Optional companyId = Optional.empty(); + + private Optional conversationToLinkId = Optional.empty(); + + private List contacts = new ArrayList<>(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(EnqueueCreateTicketRequest other) { + ticketTypeId(other.getTicketTypeId()); + contacts(other.getContacts()); + conversationToLinkId(other.getConversationToLinkId()); + companyId(other.getCompanyId()); + createdAt(other.getCreatedAt()); + assignment(other.getAssignment()); + skipNotifications(other.getSkipNotifications()); + return this; + } + + /** + *

The ID of the type of ticket you want to create

+ *

The ID of the type of ticket you want to create

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("ticket_type_id") + public _FinalStage ticketTypeId(@NotNull String ticketTypeId) { + this.ticketTypeId = Objects.requireNonNull(ticketTypeId, "ticketTypeId must not be null"); + return this; + } + + /** + *

Option to disable notifications when a Ticket is created.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage skipNotifications(Boolean skipNotifications) { + this.skipNotifications = Optional.ofNullable(skipNotifications); + return this; + } + + /** + *

Option to disable notifications when a Ticket is created.

+ */ + @java.lang.Override + @JsonSetter(value = "skip_notifications", nulls = Nulls.SKIP) + public _FinalStage skipNotifications(Optional skipNotifications) { + this.skipNotifications = skipNotifications; + return this; + } + + @java.lang.Override + public _FinalStage assignment(Assignment assignment) { + this.assignment = Optional.ofNullable(assignment); + return this; + } + + @java.lang.Override + @JsonSetter(value = "assignment", nulls = Nulls.SKIP) + public _FinalStage assignment(Optional assignment) { + this.assignment = assignment; + return this; + } + + /** + *

The time the ticket was created. If not provided, the current time will be used.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage createdAt(Integer createdAt) { + this.createdAt = Optional.ofNullable(createdAt); + return this; + } + + /** + *

The time the ticket was created. If not provided, the current time will be used.

+ */ + @java.lang.Override + @JsonSetter(value = "created_at", nulls = Nulls.SKIP) + public _FinalStage createdAt(Optional createdAt) { + this.createdAt = createdAt; + return this; + } + + /** + *

The ID of the company that the ticket is associated with. The unique identifier for the company which is given by Intercom

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage companyId(String companyId) { + this.companyId = Optional.ofNullable(companyId); + return this; + } + + /** + *

The ID of the company that the ticket is associated with. The unique identifier for the company which is given by Intercom

+ */ + @java.lang.Override + @JsonSetter(value = "company_id", nulls = Nulls.SKIP) + public _FinalStage companyId(Optional companyId) { + this.companyId = companyId; + return this; + } + + /** + *

The ID of the conversation you want to link to the ticket. Here are the valid ways of linking two tickets:

+ *
    + *
  • conversation | back-office ticket
    • + *
  • customer tickets | non-shared back-office ticket
    • + *
  • conversation | tracker ticket
    • + *
  • customer ticket | tracker ticket
    • + *
+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage conversationToLinkId(String conversationToLinkId) { + this.conversationToLinkId = Optional.ofNullable(conversationToLinkId); + return this; + } + + /** + *

The ID of the conversation you want to link to the ticket. Here are the valid ways of linking two tickets:

+ *
    + *
  • conversation | back-office ticket
    • + *
  • customer tickets | non-shared back-office ticket
    • + *
  • conversation | tracker ticket
    • + *
  • customer ticket | tracker ticket
    • + *
+ */ + @java.lang.Override + @JsonSetter(value = "conversation_to_link_id", nulls = Nulls.SKIP) + public _FinalStage conversationToLinkId(Optional conversationToLinkId) { + this.conversationToLinkId = conversationToLinkId; + return this; + } + + /** + *

The list of contacts (users or leads) affected by this ticket. Currently only one is allowed

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage addAllContacts(List contacts) { + if (contacts != null) { + this.contacts.addAll(contacts); + } + return this; + } + + /** + *

The list of contacts (users or leads) affected by this ticket. Currently only one is allowed

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage addContacts(ContactsItem contacts) { + this.contacts.add(contacts); + return this; + } + + /** + *

The list of contacts (users or leads) affected by this ticket. Currently only one is allowed

+ */ + @java.lang.Override + @JsonSetter(value = "contacts", nulls = Nulls.SKIP) + public _FinalStage contacts(List contacts) { + this.contacts.clear(); + if (contacts != null) { + this.contacts.addAll(contacts); + } + return this; + } + + @java.lang.Override + public EnqueueCreateTicketRequest build() { + return new EnqueueCreateTicketRequest( + ticketTypeId, + contacts, + conversationToLinkId, + companyId, + createdAt, + assignment, + skipNotifications, + additionalProperties); + } + } + + @JsonDeserialize(using = ContactsItem.Deserializer.class) + public static final class ContactsItem { + private final Object value; + + private final int type; + + private ContactsItem(Object value, int type) { + this.value = value; + this.type = type; + } + + @JsonValue + public Object get() { + return this.value; + } + + @SuppressWarnings("unchecked") + public T visit(Visitor visitor) { + if (this.type == 0) { + return visitor.visit((Id) this.value); + } else if (this.type == 1) { + return visitor.visit((ExternalId) this.value); + } else if (this.type == 2) { + return visitor.visit((Email) this.value); + } + throw new IllegalStateException("Failed to visit value. This should never happen."); + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof ContactsItem && equalTo((ContactsItem) other); + } + + private boolean equalTo(ContactsItem other) { + return value.equals(other.value); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.value); + } + + @java.lang.Override + public String toString() { + return this.value.toString(); + } + + public static ContactsItem of(Id value) { + return new ContactsItem(value, 0); + } + + public static ContactsItem of(ExternalId value) { + return new ContactsItem(value, 1); + } + + public static ContactsItem of(Email value) { + return new ContactsItem(value, 2); + } + + public interface Visitor { + T visit(Id value); + + T visit(ExternalId value); + + T visit(Email value); + } + + static final class Deserializer extends StdDeserializer { + Deserializer() { + super(ContactsItem.class); + } + + @java.lang.Override + public ContactsItem deserialize(JsonParser p, DeserializationContext context) throws IOException { + Object value = p.readValueAs(Object.class); + try { + return of(ObjectMappers.JSON_MAPPER.convertValue(value, Id.class)); + } catch (RuntimeException e) { + } + try { + return of(ObjectMappers.JSON_MAPPER.convertValue(value, ExternalId.class)); + } catch (RuntimeException e) { + } + try { + return of(ObjectMappers.JSON_MAPPER.convertValue(value, Email.class)); + } catch (RuntimeException e) { + } + throw new JsonParseException(p, "Failed to deserialize"); + } + } + + @JsonInclude(JsonInclude.Include.NON_ABSENT) + @JsonDeserialize(builder = ExternalId.Builder.class) + public static final class ExternalId { + private final String externalId; + + private final Map additionalProperties; + + private ExternalId(String externalId, Map additionalProperties) { + this.externalId = externalId; + this.additionalProperties = additionalProperties; + } + + /** + * @return The external_id you have defined for the contact who is being added as a participant. + */ + @JsonProperty("external_id") + public String getExternalId() { + return externalId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof ExternalId && equalTo((ExternalId) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(ExternalId other) { + return externalId.equals(other.externalId); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.externalId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static ExternalIdStage builder() { + return new Builder(); + } + + public interface ExternalIdStage { + /** + *

The external_id you have defined for the contact who is being added as a participant.

+ */ + _FinalStage externalId(@NotNull String externalId); + + Builder from(ExternalId other); + } + + public interface _FinalStage { + ExternalId build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements ExternalIdStage, _FinalStage { + private String externalId; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(ExternalId other) { + externalId(other.getExternalId()); + return this; + } + + /** + *

The external_id you have defined for the contact who is being added as a participant.

+ *

The external_id you have defined for the contact who is being added as a participant.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("external_id") + public _FinalStage externalId(@NotNull String externalId) { + this.externalId = Objects.requireNonNull(externalId, "externalId must not be null"); + return this; + } + + @java.lang.Override + public ExternalId build() { + return new ExternalId(externalId, additionalProperties); + } + } + } + + @JsonInclude(JsonInclude.Include.NON_ABSENT) + @JsonDeserialize(builder = Email.Builder.class) + public static final class Email { + private final String email; + + private final Map additionalProperties; + + private Email(String email, Map additionalProperties) { + this.email = email; + this.additionalProperties = additionalProperties; + } + + /** + * @return The email you have defined for the contact who is being added as a participant. If a contact with this email does not exist, one will be created. + */ + @JsonProperty("email") + public String getEmail() { + return email; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof Email && equalTo((Email) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(Email other) { + return email.equals(other.email); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.email); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static EmailStage builder() { + return new Builder(); + } + + public interface EmailStage { + /** + *

The email you have defined for the contact who is being added as a participant. If a contact with this email does not exist, one will be created.

+ */ + _FinalStage email(@NotNull String email); + + Builder from(Email other); + } + + public interface _FinalStage { + Email build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements EmailStage, _FinalStage { + private String email; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(Email other) { + email(other.getEmail()); + return this; + } + + /** + *

The email you have defined for the contact who is being added as a participant. If a contact with this email does not exist, one will be created.

+ *

The email you have defined for the contact who is being added as a participant. If a contact with this email does not exist, one will be created.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("email") + public _FinalStage email(@NotNull String email) { + this.email = Objects.requireNonNull(email, "email must not be null"); + return this; + } + + @java.lang.Override + public Email build() { + return new Email(email, additionalProperties); + } + } + } + + @JsonInclude(JsonInclude.Include.NON_ABSENT) + @JsonDeserialize(builder = Id.Builder.class) + public static final class Id { + private final String id; + + private final Map additionalProperties; + + private Id(String id, Map additionalProperties) { + this.id = id; + this.additionalProperties = additionalProperties; + } + + /** + * @return The identifier for the contact as given by Intercom. + */ + @JsonProperty("id") + public String getId() { + return id; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof Id && equalTo((Id) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(Id other) { + return id.equals(other.id); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.id); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static IdStage builder() { + return new Builder(); + } + + public interface IdStage { + /** + *

The identifier for the contact as given by Intercom.

+ */ + _FinalStage id(@NotNull String id); + + Builder from(Id other); + } + + public interface _FinalStage { + Id build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements IdStage, _FinalStage { + private String id; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(Id other) { + id(other.getId()); + return this; + } + + /** + *

The identifier for the contact as given by Intercom.

+ *

The identifier for the contact as given by Intercom.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("id") + public _FinalStage id(@NotNull String id) { + this.id = Objects.requireNonNull(id, "id must not be null"); + return this; + } + + @java.lang.Override + public Id build() { + return new Id(id, additionalProperties); + } + } + } + } + + @JsonInclude(JsonInclude.Include.NON_ABSENT) + @JsonDeserialize(builder = Assignment.Builder.class) + public static final class Assignment { + private final Optional adminAssigneeId; + + private final Optional teamAssigneeId; + + private final Map additionalProperties; + + private Assignment( + Optional adminAssigneeId, + Optional teamAssigneeId, + Map additionalProperties) { + this.adminAssigneeId = adminAssigneeId; + this.teamAssigneeId = teamAssigneeId; + this.additionalProperties = additionalProperties; + } + + /** + * @return The ID of the admin to which the ticket is assigned. If not provided, the ticket will be unassigned. + */ + @JsonProperty("admin_assignee_id") + public Optional getAdminAssigneeId() { + return adminAssigneeId; + } + + /** + * @return The ID of the team to which the ticket is assigned. If not provided, the ticket will be unassigned. + */ + @JsonProperty("team_assignee_id") + public Optional getTeamAssigneeId() { + return teamAssigneeId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof Assignment && equalTo((Assignment) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(Assignment other) { + return adminAssigneeId.equals(other.adminAssigneeId) && teamAssigneeId.equals(other.teamAssigneeId); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.adminAssigneeId, this.teamAssigneeId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static Builder builder() { + return new Builder(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder { + private Optional adminAssigneeId = Optional.empty(); + + private Optional teamAssigneeId = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + public Builder from(Assignment other) { + adminAssigneeId(other.getAdminAssigneeId()); + teamAssigneeId(other.getTeamAssigneeId()); + return this; + } + + /** + *

The ID of the admin to which the ticket is assigned. If not provided, the ticket will be unassigned.

+ */ + @JsonSetter(value = "admin_assignee_id", nulls = Nulls.SKIP) + public Builder adminAssigneeId(Optional adminAssigneeId) { + this.adminAssigneeId = adminAssigneeId; + return this; + } + + public Builder adminAssigneeId(String adminAssigneeId) { + this.adminAssigneeId = Optional.ofNullable(adminAssigneeId); + return this; + } + + /** + *

The ID of the team to which the ticket is assigned. If not provided, the ticket will be unassigned.

+ */ + @JsonSetter(value = "team_assignee_id", nulls = Nulls.SKIP) + public Builder teamAssigneeId(Optional teamAssigneeId) { + this.teamAssigneeId = teamAssigneeId; + return this; + } + + public Builder teamAssigneeId(String teamAssigneeId) { + this.teamAssigneeId = Optional.ofNullable(teamAssigneeId); + return this; + } + + public Assignment build() { + return new Assignment(adminAssigneeId, teamAssigneeId, additionalProperties); + } + } + } +} diff --git a/src/main/java/com/intercom/api/resources/tickets/requests/FindTicketRequest.java b/src/main/java/com/intercom/api/resources/tickets/requests/FindTicketRequest.java new file mode 100644 index 00000000..70d97e5c --- /dev/null +++ b/src/main/java/com/intercom/api/resources/tickets/requests/FindTicketRequest.java @@ -0,0 +1,113 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.tickets.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = FindTicketRequest.Builder.class) +public final class FindTicketRequest { + private final String ticketId; + + private final Map additionalProperties; + + private FindTicketRequest(String ticketId, Map additionalProperties) { + this.ticketId = ticketId; + this.additionalProperties = additionalProperties; + } + + /** + * @return The unique identifier for the ticket which is given by Intercom. + */ + @JsonProperty("ticket_id") + public String getTicketId() { + return ticketId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof FindTicketRequest && equalTo((FindTicketRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(FindTicketRequest other) { + return ticketId.equals(other.ticketId); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.ticketId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static TicketIdStage builder() { + return new Builder(); + } + + public interface TicketIdStage { + /** + *

The unique identifier for the ticket which is given by Intercom.

+ */ + _FinalStage ticketId(@NotNull String ticketId); + + Builder from(FindTicketRequest other); + } + + public interface _FinalStage { + FindTicketRequest build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements TicketIdStage, _FinalStage { + private String ticketId; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(FindTicketRequest other) { + ticketId(other.getTicketId()); + return this; + } + + /** + *

The unique identifier for the ticket which is given by Intercom.

+ *

The unique identifier for the ticket which is given by Intercom.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("ticket_id") + public _FinalStage ticketId(@NotNull String ticketId) { + this.ticketId = Objects.requireNonNull(ticketId, "ticketId must not be null"); + return this; + } + + @java.lang.Override + public FindTicketRequest build() { + return new FindTicketRequest(ticketId, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/tickets/requests/ReplyToTicketRequest.java b/src/main/java/com/intercom/api/resources/tickets/requests/ReplyToTicketRequest.java new file mode 100644 index 00000000..704faf36 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/tickets/requests/ReplyToTicketRequest.java @@ -0,0 +1,126 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.tickets.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.resources.tickets.types.TicketsReplyRequestBody; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = ReplyToTicketRequest.Builder.class) +public final class ReplyToTicketRequest { + private final String ticketId; + + private final TicketsReplyRequestBody body; + + private final Map additionalProperties; + + private ReplyToTicketRequest( + String ticketId, TicketsReplyRequestBody body, Map additionalProperties) { + this.ticketId = ticketId; + this.body = body; + this.additionalProperties = additionalProperties; + } + + @JsonProperty("ticket_id") + public String getTicketId() { + return ticketId; + } + + @JsonProperty("body") + public TicketsReplyRequestBody getBody() { + return body; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof ReplyToTicketRequest && equalTo((ReplyToTicketRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(ReplyToTicketRequest other) { + return ticketId.equals(other.ticketId) && body.equals(other.body); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.ticketId, this.body); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static TicketIdStage builder() { + return new Builder(); + } + + public interface TicketIdStage { + BodyStage ticketId(@NotNull String ticketId); + + Builder from(ReplyToTicketRequest other); + } + + public interface BodyStage { + _FinalStage body(@NotNull TicketsReplyRequestBody body); + } + + public interface _FinalStage { + ReplyToTicketRequest build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements TicketIdStage, BodyStage, _FinalStage { + private String ticketId; + + private TicketsReplyRequestBody body; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(ReplyToTicketRequest other) { + ticketId(other.getTicketId()); + body(other.getBody()); + return this; + } + + @java.lang.Override + @JsonSetter("ticket_id") + public BodyStage ticketId(@NotNull String ticketId) { + this.ticketId = Objects.requireNonNull(ticketId, "ticketId must not be null"); + return this; + } + + @java.lang.Override + @JsonSetter("body") + public _FinalStage body(@NotNull TicketsReplyRequestBody body) { + this.body = Objects.requireNonNull(body, "body must not be null"); + return this; + } + + @java.lang.Override + public ReplyToTicketRequest build() { + return new ReplyToTicketRequest(ticketId, body, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/tickets/requests/UpdateTicketRequest.java b/src/main/java/com/intercom/api/resources/tickets/requests/UpdateTicketRequest.java new file mode 100644 index 00000000..4c92a069 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/tickets/requests/UpdateTicketRequest.java @@ -0,0 +1,480 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.tickets.requests; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = UpdateTicketRequest.Builder.class) +public final class UpdateTicketRequest { + private final String ticketId; + + private final Optional> ticketAttributes; + + private final Optional ticketStateId; + + private final Optional companyId; + + private final Optional open; + + private final Optional isShared; + + private final Optional snoozedUntil; + + private final Optional adminId; + + private final Optional assigneeId; + + private final Map additionalProperties; + + private UpdateTicketRequest( + String ticketId, + Optional> ticketAttributes, + Optional ticketStateId, + Optional companyId, + Optional open, + Optional isShared, + Optional snoozedUntil, + Optional adminId, + Optional assigneeId, + Map additionalProperties) { + this.ticketId = ticketId; + this.ticketAttributes = ticketAttributes; + this.ticketStateId = ticketStateId; + this.companyId = companyId; + this.open = open; + this.isShared = isShared; + this.snoozedUntil = snoozedUntil; + this.adminId = adminId; + this.assigneeId = assigneeId; + this.additionalProperties = additionalProperties; + } + + /** + * @return The unique identifier for the ticket which is given by Intercom + */ + @JsonProperty("ticket_id") + public String getTicketId() { + return ticketId; + } + + /** + * @return The attributes set on the ticket. + */ + @JsonProperty("ticket_attributes") + public Optional> getTicketAttributes() { + return ticketAttributes; + } + + /** + * @return The ID of the ticket state associated with the ticket type. + */ + @JsonProperty("ticket_state_id") + public Optional getTicketStateId() { + return ticketStateId; + } + + /** + * @return The ID of the company that the ticket is associated with. The unique identifier for the company which is given by Intercom. Set to nil to remove company. + */ + @JsonProperty("company_id") + public Optional getCompanyId() { + return companyId; + } + + /** + * @return Specify if a ticket is open. Set to false to close a ticket. Closing a ticket will also unsnooze it. + */ + @JsonProperty("open") + public Optional getOpen() { + return open; + } + + /** + * @return Specify whether the ticket is visible to users. + */ + @JsonProperty("is_shared") + public Optional getIsShared() { + return isShared; + } + + /** + * @return The time you want the ticket to reopen. + */ + @JsonProperty("snoozed_until") + public Optional getSnoozedUntil() { + return snoozedUntil; + } + + /** + * @return The ID of the admin performing ticket update. Needed for workflows execution and attributing actions to specific admins. + */ + @JsonProperty("admin_id") + public Optional getAdminId() { + return adminId; + } + + /** + * @return The ID of the admin or team to which the ticket is assigned. Set this 0 to unassign it. + */ + @JsonProperty("assignee_id") + public Optional getAssigneeId() { + return assigneeId; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof UpdateTicketRequest && equalTo((UpdateTicketRequest) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(UpdateTicketRequest other) { + return ticketId.equals(other.ticketId) + && ticketAttributes.equals(other.ticketAttributes) + && ticketStateId.equals(other.ticketStateId) + && companyId.equals(other.companyId) + && open.equals(other.open) + && isShared.equals(other.isShared) + && snoozedUntil.equals(other.snoozedUntil) + && adminId.equals(other.adminId) + && assigneeId.equals(other.assigneeId); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash( + this.ticketId, + this.ticketAttributes, + this.ticketStateId, + this.companyId, + this.open, + this.isShared, + this.snoozedUntil, + this.adminId, + this.assigneeId); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static TicketIdStage builder() { + return new Builder(); + } + + public interface TicketIdStage { + /** + *

The unique identifier for the ticket which is given by Intercom

+ */ + _FinalStage ticketId(@NotNull String ticketId); + + Builder from(UpdateTicketRequest other); + } + + public interface _FinalStage { + UpdateTicketRequest build(); + + /** + *

The attributes set on the ticket.

+ */ + _FinalStage ticketAttributes(Optional> ticketAttributes); + + _FinalStage ticketAttributes(Map ticketAttributes); + + /** + *

The ID of the ticket state associated with the ticket type.

+ */ + _FinalStage ticketStateId(Optional ticketStateId); + + _FinalStage ticketStateId(String ticketStateId); + + /** + *

The ID of the company that the ticket is associated with. The unique identifier for the company which is given by Intercom. Set to nil to remove company.

+ */ + _FinalStage companyId(Optional companyId); + + _FinalStage companyId(String companyId); + + /** + *

Specify if a ticket is open. Set to false to close a ticket. Closing a ticket will also unsnooze it.

+ */ + _FinalStage open(Optional open); + + _FinalStage open(Boolean open); + + /** + *

Specify whether the ticket is visible to users.

+ */ + _FinalStage isShared(Optional isShared); + + _FinalStage isShared(Boolean isShared); + + /** + *

The time you want the ticket to reopen.

+ */ + _FinalStage snoozedUntil(Optional snoozedUntil); + + _FinalStage snoozedUntil(Integer snoozedUntil); + + /** + *

The ID of the admin performing ticket update. Needed for workflows execution and attributing actions to specific admins.

+ */ + _FinalStage adminId(Optional adminId); + + _FinalStage adminId(Integer adminId); + + /** + *

The ID of the admin or team to which the ticket is assigned. Set this 0 to unassign it.

+ */ + _FinalStage assigneeId(Optional assigneeId); + + _FinalStage assigneeId(String assigneeId); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements TicketIdStage, _FinalStage { + private String ticketId; + + private Optional assigneeId = Optional.empty(); + + private Optional adminId = Optional.empty(); + + private Optional snoozedUntil = Optional.empty(); + + private Optional isShared = Optional.empty(); + + private Optional open = Optional.empty(); + + private Optional companyId = Optional.empty(); + + private Optional ticketStateId = Optional.empty(); + + private Optional> ticketAttributes = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(UpdateTicketRequest other) { + ticketId(other.getTicketId()); + ticketAttributes(other.getTicketAttributes()); + ticketStateId(other.getTicketStateId()); + companyId(other.getCompanyId()); + open(other.getOpen()); + isShared(other.getIsShared()); + snoozedUntil(other.getSnoozedUntil()); + adminId(other.getAdminId()); + assigneeId(other.getAssigneeId()); + return this; + } + + /** + *

The unique identifier for the ticket which is given by Intercom

+ *

The unique identifier for the ticket which is given by Intercom

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("ticket_id") + public _FinalStage ticketId(@NotNull String ticketId) { + this.ticketId = Objects.requireNonNull(ticketId, "ticketId must not be null"); + return this; + } + + /** + *

The ID of the admin or team to which the ticket is assigned. Set this 0 to unassign it.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage assigneeId(String assigneeId) { + this.assigneeId = Optional.ofNullable(assigneeId); + return this; + } + + /** + *

The ID of the admin or team to which the ticket is assigned. Set this 0 to unassign it.

+ */ + @java.lang.Override + @JsonSetter(value = "assignee_id", nulls = Nulls.SKIP) + public _FinalStage assigneeId(Optional assigneeId) { + this.assigneeId = assigneeId; + return this; + } + + /** + *

The ID of the admin performing ticket update. Needed for workflows execution and attributing actions to specific admins.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage adminId(Integer adminId) { + this.adminId = Optional.ofNullable(adminId); + return this; + } + + /** + *

The ID of the admin performing ticket update. Needed for workflows execution and attributing actions to specific admins.

+ */ + @java.lang.Override + @JsonSetter(value = "admin_id", nulls = Nulls.SKIP) + public _FinalStage adminId(Optional adminId) { + this.adminId = adminId; + return this; + } + + /** + *

The time you want the ticket to reopen.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage snoozedUntil(Integer snoozedUntil) { + this.snoozedUntil = Optional.ofNullable(snoozedUntil); + return this; + } + + /** + *

The time you want the ticket to reopen.

+ */ + @java.lang.Override + @JsonSetter(value = "snoozed_until", nulls = Nulls.SKIP) + public _FinalStage snoozedUntil(Optional snoozedUntil) { + this.snoozedUntil = snoozedUntil; + return this; + } + + /** + *

Specify whether the ticket is visible to users.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage isShared(Boolean isShared) { + this.isShared = Optional.ofNullable(isShared); + return this; + } + + /** + *

Specify whether the ticket is visible to users.

+ */ + @java.lang.Override + @JsonSetter(value = "is_shared", nulls = Nulls.SKIP) + public _FinalStage isShared(Optional isShared) { + this.isShared = isShared; + return this; + } + + /** + *

Specify if a ticket is open. Set to false to close a ticket. Closing a ticket will also unsnooze it.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage open(Boolean open) { + this.open = Optional.ofNullable(open); + return this; + } + + /** + *

Specify if a ticket is open. Set to false to close a ticket. Closing a ticket will also unsnooze it.

+ */ + @java.lang.Override + @JsonSetter(value = "open", nulls = Nulls.SKIP) + public _FinalStage open(Optional open) { + this.open = open; + return this; + } + + /** + *

The ID of the company that the ticket is associated with. The unique identifier for the company which is given by Intercom. Set to nil to remove company.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage companyId(String companyId) { + this.companyId = Optional.ofNullable(companyId); + return this; + } + + /** + *

The ID of the company that the ticket is associated with. The unique identifier for the company which is given by Intercom. Set to nil to remove company.

+ */ + @java.lang.Override + @JsonSetter(value = "company_id", nulls = Nulls.SKIP) + public _FinalStage companyId(Optional companyId) { + this.companyId = companyId; + return this; + } + + /** + *

The ID of the ticket state associated with the ticket type.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage ticketStateId(String ticketStateId) { + this.ticketStateId = Optional.ofNullable(ticketStateId); + return this; + } + + /** + *

The ID of the ticket state associated with the ticket type.

+ */ + @java.lang.Override + @JsonSetter(value = "ticket_state_id", nulls = Nulls.SKIP) + public _FinalStage ticketStateId(Optional ticketStateId) { + this.ticketStateId = ticketStateId; + return this; + } + + /** + *

The attributes set on the ticket.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage ticketAttributes(Map ticketAttributes) { + this.ticketAttributes = Optional.ofNullable(ticketAttributes); + return this; + } + + /** + *

The attributes set on the ticket.

+ */ + @java.lang.Override + @JsonSetter(value = "ticket_attributes", nulls = Nulls.SKIP) + public _FinalStage ticketAttributes(Optional> ticketAttributes) { + this.ticketAttributes = ticketAttributes; + return this; + } + + @java.lang.Override + public UpdateTicketRequest build() { + return new UpdateTicketRequest( + ticketId, + ticketAttributes, + ticketStateId, + companyId, + open, + isShared, + snoozedUntil, + adminId, + assigneeId, + additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/tickets/types/DeleteTicketResponse.java b/src/main/java/com/intercom/api/resources/tickets/types/DeleteTicketResponse.java new file mode 100644 index 00000000..52ccea15 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/tickets/types/DeleteTicketResponse.java @@ -0,0 +1,161 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.tickets.types; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = DeleteTicketResponse.Builder.class) +public final class DeleteTicketResponse { + private final Optional id; + + private final Optional object; + + private final Optional deleted; + + private final Map additionalProperties; + + private DeleteTicketResponse( + Optional id, + Optional object, + Optional deleted, + Map additionalProperties) { + this.id = id; + this.object = object; + this.deleted = deleted; + this.additionalProperties = additionalProperties; + } + + /** + * @return The unique identifier for the ticket. + */ + @JsonProperty("id") + public Optional getId() { + return id; + } + + /** + * @return always ticket + */ + @JsonProperty("object") + public Optional getObject() { + return object; + } + + /** + * @return Whether the ticket is deleted or not. + */ + @JsonProperty("deleted") + public Optional getDeleted() { + return deleted; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof DeleteTicketResponse && equalTo((DeleteTicketResponse) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(DeleteTicketResponse other) { + return id.equals(other.id) && object.equals(other.object) && deleted.equals(other.deleted); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.id, this.object, this.deleted); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static Builder builder() { + return new Builder(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder { + private Optional id = Optional.empty(); + + private Optional object = Optional.empty(); + + private Optional deleted = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + public Builder from(DeleteTicketResponse other) { + id(other.getId()); + object(other.getObject()); + deleted(other.getDeleted()); + return this; + } + + /** + *

The unique identifier for the ticket.

+ */ + @JsonSetter(value = "id", nulls = Nulls.SKIP) + public Builder id(Optional id) { + this.id = id; + return this; + } + + public Builder id(String id) { + this.id = Optional.ofNullable(id); + return this; + } + + /** + *

always ticket

+ */ + @JsonSetter(value = "object", nulls = Nulls.SKIP) + public Builder object(Optional object) { + this.object = object; + return this; + } + + public Builder object(String object) { + this.object = Optional.ofNullable(object); + return this; + } + + /** + *

Whether the ticket is deleted or not.

+ */ + @JsonSetter(value = "deleted", nulls = Nulls.SKIP) + public Builder deleted(Optional deleted) { + this.deleted = deleted; + return this; + } + + public Builder deleted(Boolean deleted) { + this.deleted = Optional.ofNullable(deleted); + return this; + } + + public DeleteTicketResponse build() { + return new DeleteTicketResponse(id, object, deleted, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/tickets/types/Ticket.java b/src/main/java/com/intercom/api/resources/tickets/types/Ticket.java new file mode 100644 index 00000000..f55ee50f --- /dev/null +++ b/src/main/java/com/intercom/api/resources/tickets/types/Ticket.java @@ -0,0 +1,806 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.tickets.types; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.JsonValue; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.types.LinkedObjectList; +import com.intercom.api.types.TicketParts; +import java.util.HashMap; +import java.util.LinkedHashMap; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = Ticket.Builder.class) +public final class Ticket { + private final String id; + + private final String ticketId; + + private final Category category; + + private final Map ticketAttributes; + + private final Optional ticketState; + + private final Optional ticketType; + + private final TicketContacts contacts; + + private final Optional adminAssigneeId; + + private final Optional teamAssigneeId; + + private final Optional createdAt; + + private final Optional updatedAt; + + private final Optional open; + + private final Optional snoozedUntil; + + private final Optional linkedObjects; + + private final Optional ticketParts; + + private final Optional isShared; + + private final Map additionalProperties; + + private Ticket( + String id, + String ticketId, + Category category, + Map ticketAttributes, + Optional ticketState, + Optional ticketType, + TicketContacts contacts, + Optional adminAssigneeId, + Optional teamAssigneeId, + Optional createdAt, + Optional updatedAt, + Optional open, + Optional snoozedUntil, + Optional linkedObjects, + Optional ticketParts, + Optional isShared, + Map additionalProperties) { + this.id = id; + this.ticketId = ticketId; + this.category = category; + this.ticketAttributes = ticketAttributes; + this.ticketState = ticketState; + this.ticketType = ticketType; + this.contacts = contacts; + this.adminAssigneeId = adminAssigneeId; + this.teamAssigneeId = teamAssigneeId; + this.createdAt = createdAt; + this.updatedAt = updatedAt; + this.open = open; + this.snoozedUntil = snoozedUntil; + this.linkedObjects = linkedObjects; + this.ticketParts = ticketParts; + this.isShared = isShared; + this.additionalProperties = additionalProperties; + } + + /** + * @return Always ticket + */ + @JsonProperty("type") + public String getType() { + return "ticket"; + } + + /** + * @return The unique identifier for the ticket which is given by Intercom. + */ + @JsonProperty("id") + public String getId() { + return id; + } + + /** + * @return The ID of the Ticket used in the Intercom Inbox and Messenger. Do not use ticket_id for API queries. + */ + @JsonProperty("ticket_id") + public String getTicketId() { + return ticketId; + } + + /** + * @return Category of the Ticket. + */ + @JsonProperty("category") + public Category getCategory() { + return category; + } + + @JsonProperty("ticket_attributes") + public Map getTicketAttributes() { + return ticketAttributes; + } + + @JsonProperty("ticket_state") + public Optional getTicketState() { + return ticketState; + } + + @JsonProperty("ticket_type") + public Optional getTicketType() { + return ticketType; + } + + @JsonProperty("contacts") + public TicketContacts getContacts() { + return contacts; + } + + /** + * @return The id representing the admin assigned to the ticket. + */ + @JsonProperty("admin_assignee_id") + public Optional getAdminAssigneeId() { + return adminAssigneeId; + } + + /** + * @return The id representing the team assigned to the ticket. + */ + @JsonProperty("team_assignee_id") + public Optional getTeamAssigneeId() { + return teamAssigneeId; + } + + /** + * @return The time the ticket was created as a UTC Unix timestamp. + */ + @JsonProperty("created_at") + public Optional getCreatedAt() { + return createdAt; + } + + /** + * @return The last time the ticket was updated as a UTC Unix timestamp. + */ + @JsonProperty("updated_at") + public Optional getUpdatedAt() { + return updatedAt; + } + + /** + * @return Whether or not the ticket is open. If false, the ticket is closed. + */ + @JsonProperty("open") + public Optional getOpen() { + return open; + } + + /** + * @return The time the ticket will be snoozed until as a UTC Unix timestamp. If null, the ticket is not currently snoozed. + */ + @JsonProperty("snoozed_until") + public Optional getSnoozedUntil() { + return snoozedUntil; + } + + @JsonProperty("linked_objects") + public Optional getLinkedObjects() { + return linkedObjects; + } + + @JsonProperty("ticket_parts") + public Optional getTicketParts() { + return ticketParts; + } + + /** + * @return Whether or not the ticket is shared with the customer. + */ + @JsonProperty("is_shared") + public Optional getIsShared() { + return isShared; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof Ticket && equalTo((Ticket) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(Ticket other) { + return id.equals(other.id) + && ticketId.equals(other.ticketId) + && category.equals(other.category) + && ticketAttributes.equals(other.ticketAttributes) + && ticketState.equals(other.ticketState) + && ticketType.equals(other.ticketType) + && contacts.equals(other.contacts) + && adminAssigneeId.equals(other.adminAssigneeId) + && teamAssigneeId.equals(other.teamAssigneeId) + && createdAt.equals(other.createdAt) + && updatedAt.equals(other.updatedAt) + && open.equals(other.open) + && snoozedUntil.equals(other.snoozedUntil) + && linkedObjects.equals(other.linkedObjects) + && ticketParts.equals(other.ticketParts) + && isShared.equals(other.isShared); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash( + this.id, + this.ticketId, + this.category, + this.ticketAttributes, + this.ticketState, + this.ticketType, + this.contacts, + this.adminAssigneeId, + this.teamAssigneeId, + this.createdAt, + this.updatedAt, + this.open, + this.snoozedUntil, + this.linkedObjects, + this.ticketParts, + this.isShared); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static IdStage builder() { + return new Builder(); + } + + public interface IdStage { + /** + *

The unique identifier for the ticket which is given by Intercom.

+ */ + TicketIdStage id(@NotNull String id); + + Builder from(Ticket other); + } + + public interface TicketIdStage { + /** + *

The ID of the Ticket used in the Intercom Inbox and Messenger. Do not use ticket_id for API queries.

+ */ + CategoryStage ticketId(@NotNull String ticketId); + } + + public interface CategoryStage { + /** + *

Category of the Ticket.

+ */ + ContactsStage category(@NotNull Category category); + } + + public interface ContactsStage { + _FinalStage contacts(@NotNull TicketContacts contacts); + } + + public interface _FinalStage { + Ticket build(); + + _FinalStage ticketAttributes(Map ticketAttributes); + + _FinalStage putAllTicketAttributes(Map ticketAttributes); + + _FinalStage ticketAttributes(String key, Object value); + + _FinalStage ticketState(Optional ticketState); + + _FinalStage ticketState(TicketState ticketState); + + _FinalStage ticketType(Optional ticketType); + + _FinalStage ticketType(TicketType ticketType); + + /** + *

The id representing the admin assigned to the ticket.

+ */ + _FinalStage adminAssigneeId(Optional adminAssigneeId); + + _FinalStage adminAssigneeId(String adminAssigneeId); + + /** + *

The id representing the team assigned to the ticket.

+ */ + _FinalStage teamAssigneeId(Optional teamAssigneeId); + + _FinalStage teamAssigneeId(String teamAssigneeId); + + /** + *

The time the ticket was created as a UTC Unix timestamp.

+ */ + _FinalStage createdAt(Optional createdAt); + + _FinalStage createdAt(Integer createdAt); + + /** + *

The last time the ticket was updated as a UTC Unix timestamp.

+ */ + _FinalStage updatedAt(Optional updatedAt); + + _FinalStage updatedAt(Integer updatedAt); + + /** + *

Whether or not the ticket is open. If false, the ticket is closed.

+ */ + _FinalStage open(Optional open); + + _FinalStage open(Boolean open); + + /** + *

The time the ticket will be snoozed until as a UTC Unix timestamp. If null, the ticket is not currently snoozed.

+ */ + _FinalStage snoozedUntil(Optional snoozedUntil); + + _FinalStage snoozedUntil(Integer snoozedUntil); + + _FinalStage linkedObjects(Optional linkedObjects); + + _FinalStage linkedObjects(LinkedObjectList linkedObjects); + + _FinalStage ticketParts(Optional ticketParts); + + _FinalStage ticketParts(TicketParts ticketParts); + + /** + *

Whether or not the ticket is shared with the customer.

+ */ + _FinalStage isShared(Optional isShared); + + _FinalStage isShared(Boolean isShared); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements IdStage, TicketIdStage, CategoryStage, ContactsStage, _FinalStage { + private String id; + + private String ticketId; + + private Category category; + + private TicketContacts contacts; + + private Optional isShared = Optional.empty(); + + private Optional ticketParts = Optional.empty(); + + private Optional linkedObjects = Optional.empty(); + + private Optional snoozedUntil = Optional.empty(); + + private Optional open = Optional.empty(); + + private Optional updatedAt = Optional.empty(); + + private Optional createdAt = Optional.empty(); + + private Optional teamAssigneeId = Optional.empty(); + + private Optional adminAssigneeId = Optional.empty(); + + private Optional ticketType = Optional.empty(); + + private Optional ticketState = Optional.empty(); + + private Map ticketAttributes = new LinkedHashMap<>(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(Ticket other) { + id(other.getId()); + ticketId(other.getTicketId()); + category(other.getCategory()); + ticketAttributes(other.getTicketAttributes()); + ticketState(other.getTicketState()); + ticketType(other.getTicketType()); + contacts(other.getContacts()); + adminAssigneeId(other.getAdminAssigneeId()); + teamAssigneeId(other.getTeamAssigneeId()); + createdAt(other.getCreatedAt()); + updatedAt(other.getUpdatedAt()); + open(other.getOpen()); + snoozedUntil(other.getSnoozedUntil()); + linkedObjects(other.getLinkedObjects()); + ticketParts(other.getTicketParts()); + isShared(other.getIsShared()); + return this; + } + + /** + *

The unique identifier for the ticket which is given by Intercom.

+ *

The unique identifier for the ticket which is given by Intercom.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("id") + public TicketIdStage id(@NotNull String id) { + this.id = Objects.requireNonNull(id, "id must not be null"); + return this; + } + + /** + *

The ID of the Ticket used in the Intercom Inbox and Messenger. Do not use ticket_id for API queries.

+ *

The ID of the Ticket used in the Intercom Inbox and Messenger. Do not use ticket_id for API queries.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("ticket_id") + public CategoryStage ticketId(@NotNull String ticketId) { + this.ticketId = Objects.requireNonNull(ticketId, "ticketId must not be null"); + return this; + } + + /** + *

Category of the Ticket.

+ *

Category of the Ticket.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("category") + public ContactsStage category(@NotNull Category category) { + this.category = Objects.requireNonNull(category, "category must not be null"); + return this; + } + + @java.lang.Override + @JsonSetter("contacts") + public _FinalStage contacts(@NotNull TicketContacts contacts) { + this.contacts = Objects.requireNonNull(contacts, "contacts must not be null"); + return this; + } + + /** + *

Whether or not the ticket is shared with the customer.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage isShared(Boolean isShared) { + this.isShared = Optional.ofNullable(isShared); + return this; + } + + /** + *

Whether or not the ticket is shared with the customer.

+ */ + @java.lang.Override + @JsonSetter(value = "is_shared", nulls = Nulls.SKIP) + public _FinalStage isShared(Optional isShared) { + this.isShared = isShared; + return this; + } + + @java.lang.Override + public _FinalStage ticketParts(TicketParts ticketParts) { + this.ticketParts = Optional.ofNullable(ticketParts); + return this; + } + + @java.lang.Override + @JsonSetter(value = "ticket_parts", nulls = Nulls.SKIP) + public _FinalStage ticketParts(Optional ticketParts) { + this.ticketParts = ticketParts; + return this; + } + + @java.lang.Override + public _FinalStage linkedObjects(LinkedObjectList linkedObjects) { + this.linkedObjects = Optional.ofNullable(linkedObjects); + return this; + } + + @java.lang.Override + @JsonSetter(value = "linked_objects", nulls = Nulls.SKIP) + public _FinalStage linkedObjects(Optional linkedObjects) { + this.linkedObjects = linkedObjects; + return this; + } + + /** + *

The time the ticket will be snoozed until as a UTC Unix timestamp. If null, the ticket is not currently snoozed.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage snoozedUntil(Integer snoozedUntil) { + this.snoozedUntil = Optional.ofNullable(snoozedUntil); + return this; + } + + /** + *

The time the ticket will be snoozed until as a UTC Unix timestamp. If null, the ticket is not currently snoozed.

+ */ + @java.lang.Override + @JsonSetter(value = "snoozed_until", nulls = Nulls.SKIP) + public _FinalStage snoozedUntil(Optional snoozedUntil) { + this.snoozedUntil = snoozedUntil; + return this; + } + + /** + *

Whether or not the ticket is open. If false, the ticket is closed.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage open(Boolean open) { + this.open = Optional.ofNullable(open); + return this; + } + + /** + *

Whether or not the ticket is open. If false, the ticket is closed.

+ */ + @java.lang.Override + @JsonSetter(value = "open", nulls = Nulls.SKIP) + public _FinalStage open(Optional open) { + this.open = open; + return this; + } + + /** + *

The last time the ticket was updated as a UTC Unix timestamp.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage updatedAt(Integer updatedAt) { + this.updatedAt = Optional.ofNullable(updatedAt); + return this; + } + + /** + *

The last time the ticket was updated as a UTC Unix timestamp.

+ */ + @java.lang.Override + @JsonSetter(value = "updated_at", nulls = Nulls.SKIP) + public _FinalStage updatedAt(Optional updatedAt) { + this.updatedAt = updatedAt; + return this; + } + + /** + *

The time the ticket was created as a UTC Unix timestamp.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage createdAt(Integer createdAt) { + this.createdAt = Optional.ofNullable(createdAt); + return this; + } + + /** + *

The time the ticket was created as a UTC Unix timestamp.

+ */ + @java.lang.Override + @JsonSetter(value = "created_at", nulls = Nulls.SKIP) + public _FinalStage createdAt(Optional createdAt) { + this.createdAt = createdAt; + return this; + } + + /** + *

The id representing the team assigned to the ticket.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage teamAssigneeId(String teamAssigneeId) { + this.teamAssigneeId = Optional.ofNullable(teamAssigneeId); + return this; + } + + /** + *

The id representing the team assigned to the ticket.

+ */ + @java.lang.Override + @JsonSetter(value = "team_assignee_id", nulls = Nulls.SKIP) + public _FinalStage teamAssigneeId(Optional teamAssigneeId) { + this.teamAssigneeId = teamAssigneeId; + return this; + } + + /** + *

The id representing the admin assigned to the ticket.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage adminAssigneeId(String adminAssigneeId) { + this.adminAssigneeId = Optional.ofNullable(adminAssigneeId); + return this; + } + + /** + *

The id representing the admin assigned to the ticket.

+ */ + @java.lang.Override + @JsonSetter(value = "admin_assignee_id", nulls = Nulls.SKIP) + public _FinalStage adminAssigneeId(Optional adminAssigneeId) { + this.adminAssigneeId = adminAssigneeId; + return this; + } + + @java.lang.Override + public _FinalStage ticketType(TicketType ticketType) { + this.ticketType = Optional.ofNullable(ticketType); + return this; + } + + @java.lang.Override + @JsonSetter(value = "ticket_type", nulls = Nulls.SKIP) + public _FinalStage ticketType(Optional ticketType) { + this.ticketType = ticketType; + return this; + } + + @java.lang.Override + public _FinalStage ticketState(TicketState ticketState) { + this.ticketState = Optional.ofNullable(ticketState); + return this; + } + + @java.lang.Override + @JsonSetter(value = "ticket_state", nulls = Nulls.SKIP) + public _FinalStage ticketState(Optional ticketState) { + this.ticketState = ticketState; + return this; + } + + @java.lang.Override + public _FinalStage ticketAttributes(String key, Object value) { + this.ticketAttributes.put(key, value); + return this; + } + + @java.lang.Override + public _FinalStage putAllTicketAttributes(Map ticketAttributes) { + if (ticketAttributes != null) { + this.ticketAttributes.putAll(ticketAttributes); + } + return this; + } + + @java.lang.Override + @JsonSetter(value = "ticket_attributes", nulls = Nulls.SKIP) + public _FinalStage ticketAttributes(Map ticketAttributes) { + this.ticketAttributes.clear(); + if (ticketAttributes != null) { + this.ticketAttributes.putAll(ticketAttributes); + } + return this; + } + + @java.lang.Override + public Ticket build() { + return new Ticket( + id, + ticketId, + category, + ticketAttributes, + ticketState, + ticketType, + contacts, + adminAssigneeId, + teamAssigneeId, + createdAt, + updatedAt, + open, + snoozedUntil, + linkedObjects, + ticketParts, + isShared, + additionalProperties); + } + } + + public static final class Category { + public static final Category BACK_OFFICE = new Category(Value.BACK_OFFICE, "Back-office"); + + public static final Category CUSTOMER = new Category(Value.CUSTOMER, "Customer"); + + public static final Category TRACKER = new Category(Value.TRACKER, "Tracker"); + + private final Value value; + + private final String string; + + Category(Value value, String string) { + this.value = value; + this.string = string; + } + + public Value getEnumValue() { + return value; + } + + @java.lang.Override + @JsonValue + public String toString() { + return this.string; + } + + @java.lang.Override + public boolean equals(Object other) { + return (this == other) || (other instanceof Category && this.string.equals(((Category) other).string)); + } + + @java.lang.Override + public int hashCode() { + return this.string.hashCode(); + } + + public T visit(Visitor visitor) { + switch (value) { + case BACK_OFFICE: + return visitor.visitBackOffice(); + case CUSTOMER: + return visitor.visitCustomer(); + case TRACKER: + return visitor.visitTracker(); + case UNKNOWN: + default: + return visitor.visitUnknown(string); + } + } + + @JsonCreator(mode = JsonCreator.Mode.DELEGATING) + public static Category valueOf(String value) { + switch (value) { + case "Back-office": + return BACK_OFFICE; + case "Customer": + return CUSTOMER; + case "Tracker": + return TRACKER; + default: + return new Category(Value.UNKNOWN, value); + } + } + + public enum Value { + CUSTOMER, + + BACK_OFFICE, + + TRACKER, + + UNKNOWN + } + + public interface Visitor { + T visitCustomer(); + + T visitBackOffice(); + + T visitTracker(); + + T visitUnknown(String unknownType); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/tickets/types/TicketContacts.java b/src/main/java/com/intercom/api/resources/tickets/types/TicketContacts.java new file mode 100644 index 00000000..06e83ad2 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/tickets/types/TicketContacts.java @@ -0,0 +1,134 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.tickets.types; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.types.ContactReference; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = TicketContacts.Builder.class) +public final class TicketContacts { + private final Optional type; + + private final Optional> contacts; + + private final Map additionalProperties; + + private TicketContacts( + Optional type, + Optional> contacts, + Map additionalProperties) { + this.type = type; + this.contacts = contacts; + this.additionalProperties = additionalProperties; + } + + /** + * @return always contact.list + */ + @JsonProperty("type") + public Optional getType() { + return type; + } + + /** + * @return The list of contacts affected by this ticket. + */ + @JsonProperty("contacts") + public Optional> getContacts() { + return contacts; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof TicketContacts && equalTo((TicketContacts) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(TicketContacts other) { + return type.equals(other.type) && contacts.equals(other.contacts); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.type, this.contacts); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static Builder builder() { + return new Builder(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder { + private Optional type = Optional.empty(); + + private Optional> contacts = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + public Builder from(TicketContacts other) { + type(other.getType()); + contacts(other.getContacts()); + return this; + } + + /** + *

always contact.list

+ */ + @JsonSetter(value = "type", nulls = Nulls.SKIP) + public Builder type(Optional type) { + this.type = type; + return this; + } + + public Builder type(String type) { + this.type = Optional.ofNullable(type); + return this; + } + + /** + *

The list of contacts affected by this ticket.

+ */ + @JsonSetter(value = "contacts", nulls = Nulls.SKIP) + public Builder contacts(Optional> contacts) { + this.contacts = contacts; + return this; + } + + public Builder contacts(List contacts) { + this.contacts = Optional.ofNullable(contacts); + return this; + } + + public TicketContacts build() { + return new TicketContacts(type, contacts, additionalProperties); + } + } +} diff --git a/src/main/java/com/intercom/api/resources/tickets/types/TicketPart.java b/src/main/java/com/intercom/api/resources/tickets/types/TicketPart.java new file mode 100644 index 00000000..cfd1ac99 --- /dev/null +++ b/src/main/java/com/intercom/api/resources/tickets/types/TicketPart.java @@ -0,0 +1,1452 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ +package com.intercom.api.resources.tickets.types; + +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonSetter; +import com.fasterxml.jackson.annotation.JsonValue; +import com.fasterxml.jackson.annotation.Nulls; +import com.fasterxml.jackson.core.JsonParseException; +import com.fasterxml.jackson.core.JsonParser; +import com.fasterxml.jackson.core.type.TypeReference; +import com.fasterxml.jackson.databind.DeserializationContext; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import com.fasterxml.jackson.databind.deser.std.StdDeserializer; +import com.intercom.api.core.ObjectMappers; +import com.intercom.api.types.PartAttachment; +import com.intercom.api.types.Reference; +import com.intercom.api.types.TicketPartAuthor; +import java.io.IOException; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; +import org.jetbrains.annotations.NotNull; + +@JsonInclude(JsonInclude.Include.NON_ABSENT) +@JsonDeserialize(builder = TicketPart.Builder.class) +public final class TicketPart { + private final String type; + + private final String id; + + private final String partType; + + private final Optional body; + + private final Optional previousTicketState; + + private final Optional ticketState; + + private final int createdAt; + + private final int updatedAt; + + private final Optional assignedTo; + + private final TicketPartAuthor author; + + private final Optional> attachments; + + private final Optional externalId; + + private final boolean redacted; + + private final Optional appPackageCode; + + private final Optional updatedAttributeData; + + private final Map additionalProperties; + + private TicketPart( + String type, + String id, + String partType, + Optional body, + Optional previousTicketState, + Optional ticketState, + int createdAt, + int updatedAt, + Optional assignedTo, + TicketPartAuthor author, + Optional> attachments, + Optional externalId, + boolean redacted, + Optional appPackageCode, + Optional updatedAttributeData, + Map additionalProperties) { + this.type = type; + this.id = id; + this.partType = partType; + this.body = body; + this.previousTicketState = previousTicketState; + this.ticketState = ticketState; + this.createdAt = createdAt; + this.updatedAt = updatedAt; + this.assignedTo = assignedTo; + this.author = author; + this.attachments = attachments; + this.externalId = externalId; + this.redacted = redacted; + this.appPackageCode = appPackageCode; + this.updatedAttributeData = updatedAttributeData; + this.additionalProperties = additionalProperties; + } + + /** + * @return Always ticket_part + */ + @JsonProperty("type") + public String getType() { + return type; + } + + /** + * @return The id representing the ticket part. + */ + @JsonProperty("id") + public String getId() { + return id; + } + + /** + * @return The type of ticket part. + */ + @JsonProperty("part_type") + public String getPartType() { + return partType; + } + + /** + * @return The message body, which may contain HTML. + */ + @JsonProperty("body") + public Optional getBody() { + return body; + } + + /** + * @return The previous state of the ticket. + */ + @JsonProperty("previous_ticket_state") + public Optional getPreviousTicketState() { + return previousTicketState; + } + + /** + * @return The state of the ticket. + */ + @JsonProperty("ticket_state") + public Optional getTicketState() { + return ticketState; + } + + /** + * @return The time the ticket part was created. + */ + @JsonProperty("created_at") + public int getCreatedAt() { + return createdAt; + } + + /** + * @return The last time the ticket part was updated. + */ + @JsonProperty("updated_at") + public int getUpdatedAt() { + return updatedAt; + } + + /** + * @return The id of the admin that was assigned the ticket by this ticket_part (null if there has been no change in assignment.) + */ + @JsonProperty("assigned_to") + public Optional getAssignedTo() { + return assignedTo; + } + + @JsonProperty("author") + public TicketPartAuthor getAuthor() { + return author; + } + + /** + * @return A list of attachments for the part. + */ + @JsonProperty("attachments") + public Optional> getAttachments() { + return attachments; + } + + /** + * @return The external id of the ticket part + */ + @JsonProperty("external_id") + public Optional getExternalId() { + return externalId; + } + + /** + * @return Whether or not the ticket part has been redacted. + */ + @JsonProperty("redacted") + public boolean getRedacted() { + return redacted; + } + + /** + * @return The app package code if this part was created via API. Note this field won't show if the part was not created via API. + */ + @JsonProperty("app_package_code") + public Optional getAppPackageCode() { + return appPackageCode; + } + + /** + * @return The updated attribute data of the ticket part. Only present for attribute update parts. + */ + @JsonProperty("updated_attribute_data") + public Optional getUpdatedAttributeData() { + return updatedAttributeData; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof TicketPart && equalTo((TicketPart) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(TicketPart other) { + return type.equals(other.type) + && id.equals(other.id) + && partType.equals(other.partType) + && body.equals(other.body) + && previousTicketState.equals(other.previousTicketState) + && ticketState.equals(other.ticketState) + && createdAt == other.createdAt + && updatedAt == other.updatedAt + && assignedTo.equals(other.assignedTo) + && author.equals(other.author) + && attachments.equals(other.attachments) + && externalId.equals(other.externalId) + && redacted == other.redacted + && appPackageCode.equals(other.appPackageCode) + && updatedAttributeData.equals(other.updatedAttributeData); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash( + this.type, + this.id, + this.partType, + this.body, + this.previousTicketState, + this.ticketState, + this.createdAt, + this.updatedAt, + this.assignedTo, + this.author, + this.attachments, + this.externalId, + this.redacted, + this.appPackageCode, + this.updatedAttributeData); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static TypeStage builder() { + return new Builder(); + } + + public interface TypeStage { + /** + *

Always ticket_part

+ */ + IdStage type(@NotNull String type); + + Builder from(TicketPart other); + } + + public interface IdStage { + /** + *

The id representing the ticket part.

+ */ + PartTypeStage id(@NotNull String id); + } + + public interface PartTypeStage { + /** + *

The type of ticket part.

+ */ + CreatedAtStage partType(@NotNull String partType); + } + + public interface CreatedAtStage { + /** + *

The time the ticket part was created.

+ */ + UpdatedAtStage createdAt(int createdAt); + } + + public interface UpdatedAtStage { + /** + *

The last time the ticket part was updated.

+ */ + AuthorStage updatedAt(int updatedAt); + } + + public interface AuthorStage { + RedactedStage author(@NotNull TicketPartAuthor author); + } + + public interface RedactedStage { + /** + *

Whether or not the ticket part has been redacted.

+ */ + _FinalStage redacted(boolean redacted); + } + + public interface _FinalStage { + TicketPart build(); + + /** + *

The message body, which may contain HTML.

+ */ + _FinalStage body(Optional body); + + _FinalStage body(String body); + + /** + *

The previous state of the ticket.

+ */ + _FinalStage previousTicketState(Optional previousTicketState); + + _FinalStage previousTicketState(PreviousTicketState previousTicketState); + + /** + *

The state of the ticket.

+ */ + _FinalStage ticketState(Optional ticketState); + + _FinalStage ticketState(TicketState ticketState); + + /** + *

The id of the admin that was assigned the ticket by this ticket_part (null if there has been no change in assignment.)

+ */ + _FinalStage assignedTo(Optional assignedTo); + + _FinalStage assignedTo(Reference assignedTo); + + /** + *

A list of attachments for the part.

+ */ + _FinalStage attachments(Optional> attachments); + + _FinalStage attachments(List attachments); + + /** + *

The external id of the ticket part

+ */ + _FinalStage externalId(Optional externalId); + + _FinalStage externalId(String externalId); + + /** + *

The app package code if this part was created via API. Note this field won't show if the part was not created via API.

+ */ + _FinalStage appPackageCode(Optional appPackageCode); + + _FinalStage appPackageCode(String appPackageCode); + + /** + *

The updated attribute data of the ticket part. Only present for attribute update parts.

+ */ + _FinalStage updatedAttributeData(Optional updatedAttributeData); + + _FinalStage updatedAttributeData(UpdatedAttributeData updatedAttributeData); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder + implements TypeStage, + IdStage, + PartTypeStage, + CreatedAtStage, + UpdatedAtStage, + AuthorStage, + RedactedStage, + _FinalStage { + private String type; + + private String id; + + private String partType; + + private int createdAt; + + private int updatedAt; + + private TicketPartAuthor author; + + private boolean redacted; + + private Optional updatedAttributeData = Optional.empty(); + + private Optional appPackageCode = Optional.empty(); + + private Optional externalId = Optional.empty(); + + private Optional> attachments = Optional.empty(); + + private Optional assignedTo = Optional.empty(); + + private Optional ticketState = Optional.empty(); + + private Optional previousTicketState = Optional.empty(); + + private Optional body = Optional.empty(); + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(TicketPart other) { + type(other.getType()); + id(other.getId()); + partType(other.getPartType()); + body(other.getBody()); + previousTicketState(other.getPreviousTicketState()); + ticketState(other.getTicketState()); + createdAt(other.getCreatedAt()); + updatedAt(other.getUpdatedAt()); + assignedTo(other.getAssignedTo()); + author(other.getAuthor()); + attachments(other.getAttachments()); + externalId(other.getExternalId()); + redacted(other.getRedacted()); + appPackageCode(other.getAppPackageCode()); + updatedAttributeData(other.getUpdatedAttributeData()); + return this; + } + + /** + *

Always ticket_part

+ *

Always ticket_part

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("type") + public IdStage type(@NotNull String type) { + this.type = Objects.requireNonNull(type, "type must not be null"); + return this; + } + + /** + *

The id representing the ticket part.

+ *

The id representing the ticket part.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("id") + public PartTypeStage id(@NotNull String id) { + this.id = Objects.requireNonNull(id, "id must not be null"); + return this; + } + + /** + *

The type of ticket part.

+ *

The type of ticket part.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("part_type") + public CreatedAtStage partType(@NotNull String partType) { + this.partType = Objects.requireNonNull(partType, "partType must not be null"); + return this; + } + + /** + *

The time the ticket part was created.

+ *

The time the ticket part was created.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("created_at") + public UpdatedAtStage createdAt(int createdAt) { + this.createdAt = createdAt; + return this; + } + + /** + *

The last time the ticket part was updated.

+ *

The last time the ticket part was updated.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("updated_at") + public AuthorStage updatedAt(int updatedAt) { + this.updatedAt = updatedAt; + return this; + } + + @java.lang.Override + @JsonSetter("author") + public RedactedStage author(@NotNull TicketPartAuthor author) { + this.author = Objects.requireNonNull(author, "author must not be null"); + return this; + } + + /** + *

Whether or not the ticket part has been redacted.

+ *

Whether or not the ticket part has been redacted.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("redacted") + public _FinalStage redacted(boolean redacted) { + this.redacted = redacted; + return this; + } + + /** + *

The updated attribute data of the ticket part. Only present for attribute update parts.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage updatedAttributeData(UpdatedAttributeData updatedAttributeData) { + this.updatedAttributeData = Optional.ofNullable(updatedAttributeData); + return this; + } + + /** + *

The updated attribute data of the ticket part. Only present for attribute update parts.

+ */ + @java.lang.Override + @JsonSetter(value = "updated_attribute_data", nulls = Nulls.SKIP) + public _FinalStage updatedAttributeData(Optional updatedAttributeData) { + this.updatedAttributeData = updatedAttributeData; + return this; + } + + /** + *

The app package code if this part was created via API. Note this field won't show if the part was not created via API.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage appPackageCode(String appPackageCode) { + this.appPackageCode = Optional.ofNullable(appPackageCode); + return this; + } + + /** + *

The app package code if this part was created via API. Note this field won't show if the part was not created via API.

+ */ + @java.lang.Override + @JsonSetter(value = "app_package_code", nulls = Nulls.SKIP) + public _FinalStage appPackageCode(Optional appPackageCode) { + this.appPackageCode = appPackageCode; + return this; + } + + /** + *

The external id of the ticket part

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage externalId(String externalId) { + this.externalId = Optional.ofNullable(externalId); + return this; + } + + /** + *

The external id of the ticket part

+ */ + @java.lang.Override + @JsonSetter(value = "external_id", nulls = Nulls.SKIP) + public _FinalStage externalId(Optional externalId) { + this.externalId = externalId; + return this; + } + + /** + *

A list of attachments for the part.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage attachments(List attachments) { + this.attachments = Optional.ofNullable(attachments); + return this; + } + + /** + *

A list of attachments for the part.

+ */ + @java.lang.Override + @JsonSetter(value = "attachments", nulls = Nulls.SKIP) + public _FinalStage attachments(Optional> attachments) { + this.attachments = attachments; + return this; + } + + /** + *

The id of the admin that was assigned the ticket by this ticket_part (null if there has been no change in assignment.)

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage assignedTo(Reference assignedTo) { + this.assignedTo = Optional.ofNullable(assignedTo); + return this; + } + + /** + *

The id of the admin that was assigned the ticket by this ticket_part (null if there has been no change in assignment.)

+ */ + @java.lang.Override + @JsonSetter(value = "assigned_to", nulls = Nulls.SKIP) + public _FinalStage assignedTo(Optional assignedTo) { + this.assignedTo = assignedTo; + return this; + } + + /** + *

The state of the ticket.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage ticketState(TicketState ticketState) { + this.ticketState = Optional.ofNullable(ticketState); + return this; + } + + /** + *

The state of the ticket.

+ */ + @java.lang.Override + @JsonSetter(value = "ticket_state", nulls = Nulls.SKIP) + public _FinalStage ticketState(Optional ticketState) { + this.ticketState = ticketState; + return this; + } + + /** + *

The previous state of the ticket.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage previousTicketState(PreviousTicketState previousTicketState) { + this.previousTicketState = Optional.ofNullable(previousTicketState); + return this; + } + + /** + *

The previous state of the ticket.

+ */ + @java.lang.Override + @JsonSetter(value = "previous_ticket_state", nulls = Nulls.SKIP) + public _FinalStage previousTicketState(Optional previousTicketState) { + this.previousTicketState = previousTicketState; + return this; + } + + /** + *

The message body, which may contain HTML.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage body(String body) { + this.body = Optional.ofNullable(body); + return this; + } + + /** + *

The message body, which may contain HTML.

+ */ + @java.lang.Override + @JsonSetter(value = "body", nulls = Nulls.SKIP) + public _FinalStage body(Optional body) { + this.body = body; + return this; + } + + @java.lang.Override + public TicketPart build() { + return new TicketPart( + type, + id, + partType, + body, + previousTicketState, + ticketState, + createdAt, + updatedAt, + assignedTo, + author, + attachments, + externalId, + redacted, + appPackageCode, + updatedAttributeData, + additionalProperties); + } + } + + public static final class PreviousTicketState { + public static final PreviousTicketState IN_PROGRESS = new PreviousTicketState(Value.IN_PROGRESS, "in_progress"); + + public static final PreviousTicketState SUBMITTED = new PreviousTicketState(Value.SUBMITTED, "submitted"); + + public static final PreviousTicketState RESOLVED = new PreviousTicketState(Value.RESOLVED, "resolved"); + + public static final PreviousTicketState WAITING_ON_CUSTOMER = + new PreviousTicketState(Value.WAITING_ON_CUSTOMER, "waiting_on_customer"); + + private final Value value; + + private final String string; + + PreviousTicketState(Value value, String string) { + this.value = value; + this.string = string; + } + + public Value getEnumValue() { + return value; + } + + @java.lang.Override + @JsonValue + public String toString() { + return this.string; + } + + @java.lang.Override + public boolean equals(Object other) { + return (this == other) + || (other instanceof PreviousTicketState + && this.string.equals(((PreviousTicketState) other).string)); + } + + @java.lang.Override + public int hashCode() { + return this.string.hashCode(); + } + + public T visit(Visitor visitor) { + switch (value) { + case IN_PROGRESS: + return visitor.visitInProgress(); + case SUBMITTED: + return visitor.visitSubmitted(); + case RESOLVED: + return visitor.visitResolved(); + case WAITING_ON_CUSTOMER: + return visitor.visitWaitingOnCustomer(); + case UNKNOWN: + default: + return visitor.visitUnknown(string); + } + } + + @JsonCreator(mode = JsonCreator.Mode.DELEGATING) + public static PreviousTicketState valueOf(String value) { + switch (value) { + case "in_progress": + return IN_PROGRESS; + case "submitted": + return SUBMITTED; + case "resolved": + return RESOLVED; + case "waiting_on_customer": + return WAITING_ON_CUSTOMER; + default: + return new PreviousTicketState(Value.UNKNOWN, value); + } + } + + public enum Value { + SUBMITTED, + + IN_PROGRESS, + + WAITING_ON_CUSTOMER, + + RESOLVED, + + UNKNOWN + } + + public interface Visitor { + T visitSubmitted(); + + T visitInProgress(); + + T visitWaitingOnCustomer(); + + T visitResolved(); + + T visitUnknown(String unknownType); + } + } + + public static final class TicketState { + public static final TicketState IN_PROGRESS = new TicketState(Value.IN_PROGRESS, "in_progress"); + + public static final TicketState SUBMITTED = new TicketState(Value.SUBMITTED, "submitted"); + + public static final TicketState RESOLVED = new TicketState(Value.RESOLVED, "resolved"); + + public static final TicketState WAITING_ON_CUSTOMER = + new TicketState(Value.WAITING_ON_CUSTOMER, "waiting_on_customer"); + + private final Value value; + + private final String string; + + TicketState(Value value, String string) { + this.value = value; + this.string = string; + } + + public Value getEnumValue() { + return value; + } + + @java.lang.Override + @JsonValue + public String toString() { + return this.string; + } + + @java.lang.Override + public boolean equals(Object other) { + return (this == other) + || (other instanceof TicketState && this.string.equals(((TicketState) other).string)); + } + + @java.lang.Override + public int hashCode() { + return this.string.hashCode(); + } + + public T visit(Visitor visitor) { + switch (value) { + case IN_PROGRESS: + return visitor.visitInProgress(); + case SUBMITTED: + return visitor.visitSubmitted(); + case RESOLVED: + return visitor.visitResolved(); + case WAITING_ON_CUSTOMER: + return visitor.visitWaitingOnCustomer(); + case UNKNOWN: + default: + return visitor.visitUnknown(string); + } + } + + @JsonCreator(mode = JsonCreator.Mode.DELEGATING) + public static TicketState valueOf(String value) { + switch (value) { + case "in_progress": + return IN_PROGRESS; + case "submitted": + return SUBMITTED; + case "resolved": + return RESOLVED; + case "waiting_on_customer": + return WAITING_ON_CUSTOMER; + default: + return new TicketState(Value.UNKNOWN, value); + } + } + + public enum Value { + SUBMITTED, + + IN_PROGRESS, + + WAITING_ON_CUSTOMER, + + RESOLVED, + + UNKNOWN + } + + public interface Visitor { + T visitSubmitted(); + + T visitInProgress(); + + T visitWaitingOnCustomer(); + + T visitResolved(); + + T visitUnknown(String unknownType); + } + } + + @JsonInclude(JsonInclude.Include.NON_ABSENT) + @JsonDeserialize(builder = UpdatedAttributeData.Builder.class) + public static final class UpdatedAttributeData { + private final Attribute attribute; + + private final Value value; + + private final Map additionalProperties; + + private UpdatedAttributeData(Attribute attribute, Value value, Map additionalProperties) { + this.attribute = attribute; + this.value = value; + this.additionalProperties = additionalProperties; + } + + /** + * @return Information about the attribute that was updated. + */ + @JsonProperty("attribute") + public Attribute getAttribute() { + return attribute; + } + + /** + * @return The new value of the attribute. + */ + @JsonProperty("value") + public Value getValue() { + return value; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof UpdatedAttributeData && equalTo((UpdatedAttributeData) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(UpdatedAttributeData other) { + return attribute.equals(other.attribute) && value.equals(other.value); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.attribute, this.value); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static AttributeStage builder() { + return new Builder(); + } + + public interface AttributeStage { + /** + *

Information about the attribute that was updated.

+ */ + ValueStage attribute(@NotNull Attribute attribute); + + Builder from(UpdatedAttributeData other); + } + + public interface ValueStage { + /** + *

The new value of the attribute.

+ */ + _FinalStage value(@NotNull Value value); + } + + public interface _FinalStage { + UpdatedAttributeData build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements AttributeStage, ValueStage, _FinalStage { + private Attribute attribute; + + private Value value; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(UpdatedAttributeData other) { + attribute(other.getAttribute()); + value(other.getValue()); + return this; + } + + /** + *

Information about the attribute that was updated.

+ *

Information about the attribute that was updated.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("attribute") + public ValueStage attribute(@NotNull Attribute attribute) { + this.attribute = Objects.requireNonNull(attribute, "attribute must not be null"); + return this; + } + + /** + *

The new value of the attribute.

+ *

The new value of the attribute.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("value") + public _FinalStage value(@NotNull Value value) { + this.value = Objects.requireNonNull(value, "value must not be null"); + return this; + } + + @java.lang.Override + public UpdatedAttributeData build() { + return new UpdatedAttributeData(attribute, value, additionalProperties); + } + } + + @JsonInclude(JsonInclude.Include.NON_ABSENT) + @JsonDeserialize(builder = Attribute.Builder.class) + public static final class Attribute { + private final String id; + + private final String label; + + private final Map additionalProperties; + + private Attribute(String id, String label, Map additionalProperties) { + this.id = id; + this.label = label; + this.additionalProperties = additionalProperties; + } + + /** + * @return The type of the object. Always 'attribute'. + */ + @JsonProperty("type") + public String getType() { + return "attribute"; + } + + /** + * @return The unique identifier of the attribute. + */ + @JsonProperty("id") + public String getId() { + return id; + } + + /** + * @return The human-readable name of the attribute. + */ + @JsonProperty("label") + public String getLabel() { + return label; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof Attribute && equalTo((Attribute) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(Attribute other) { + return id.equals(other.id) && label.equals(other.label); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.id, this.label); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static IdStage builder() { + return new Builder(); + } + + public interface IdStage { + /** + *

The unique identifier of the attribute.

+ */ + LabelStage id(@NotNull String id); + + Builder from(Attribute other); + } + + public interface LabelStage { + /** + *

The human-readable name of the attribute.

+ */ + _FinalStage label(@NotNull String label); + } + + public interface _FinalStage { + Attribute build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements IdStage, LabelStage, _FinalStage { + private String id; + + private String label; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(Attribute other) { + id(other.getId()); + label(other.getLabel()); + return this; + } + + /** + *

The unique identifier of the attribute.

+ *

The unique identifier of the attribute.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("id") + public LabelStage id(@NotNull String id) { + this.id = Objects.requireNonNull(id, "id must not be null"); + return this; + } + + /** + *

The human-readable name of the attribute.

+ *

The human-readable name of the attribute.

+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + @JsonSetter("label") + public _FinalStage label(@NotNull String label) { + this.label = Objects.requireNonNull(label, "label must not be null"); + return this; + } + + @java.lang.Override + public Attribute build() { + return new Attribute(id, label, additionalProperties); + } + } + } + + @JsonInclude(JsonInclude.Include.NON_ABSENT) + @JsonDeserialize(builder = Value.Builder.class) + public static final class Value { + private final Id id; + + private final Label label; + + private final Map additionalProperties; + + private Value(Id id, Label label, Map additionalProperties) { + this.id = id; + this.label = label; + this.additionalProperties = additionalProperties; + } + + /** + * @return The type of the object. Always 'value'. + */ + @JsonProperty("type") + public String getType() { + return "value"; + } + + @JsonProperty("id") + public Id getId() { + return id; + } + + @JsonProperty("label") + public Label getLabel() { + return label; + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof Value && equalTo((Value) other); + } + + @JsonAnyGetter + public Map getAdditionalProperties() { + return this.additionalProperties; + } + + private boolean equalTo(Value other) { + return id.equals(other.id) && label.equals(other.label); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.id, this.label); + } + + @java.lang.Override + public String toString() { + return ObjectMappers.stringify(this); + } + + public static IdStage builder() { + return new Builder(); + } + + public interface IdStage { + LabelStage id(@NotNull Id id); + + Builder from(Value other); + } + + public interface LabelStage { + _FinalStage label(@NotNull Label label); + } + + public interface _FinalStage { + Value build(); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + public static final class Builder implements IdStage, LabelStage, _FinalStage { + private Id id; + + private Label label; + + @JsonAnySetter + private Map additionalProperties = new HashMap<>(); + + private Builder() {} + + @java.lang.Override + public Builder from(Value other) { + id(other.getId()); + label(other.getLabel()); + return this; + } + + @java.lang.Override + @JsonSetter("id") + public LabelStage id(@NotNull Id id) { + this.id = Objects.requireNonNull(id, "id must not be null"); + return this; + } + + @java.lang.Override + @JsonSetter("label") + public _FinalStage label(@NotNull Label label) { + this.label = Objects.requireNonNull(label, "label must not be null"); + return this; + } + + @java.lang.Override + public Value build() { + return new Value(id, label, additionalProperties); + } + } + + @JsonDeserialize(using = Label.Deserializer.class) + public static final class Label { + private final Object value; + + private final int type; + + private Label(Object value, int type) { + this.value = value; + this.type = type; + } + + @JsonValue + public Object get() { + return this.value; + } + + @SuppressWarnings("unchecked") + public T visit(Visitor visitor) { + if (this.type == 0) { + return visitor.visit((String) this.value); + } else if (this.type == 1) { + return visitor.visit((List) this.value); + } + throw new IllegalStateException("Failed to visit value. This should never happen."); + } + + @java.lang.Override + public boolean equals(Object other) { + if (this == other) return true; + return other instanceof Label && equalTo((Label) other); + } + + private boolean equalTo(Label other) { + return value.equals(other.value); + } + + @java.lang.Override + public int hashCode() { + return Objects.hash(this.value); + } + + @java.lang.Override + public String toString() { + return this.value.toString(); + } + + public static Label of(String value) { + return new Label(value, 0); + } + + public static Label of(List value) { + return new Label(value, 1); + } + + public interface Visitor { + T visit(String value); + + T visit(List value); + } + + static final class Deserializer extends StdDeserializer