Package com.intercom.api.resources.admins

Class AsyncAdminsClient

java.lang.Object

com.intercom.api.resources.admins.AsyncAdminsClient

public class AsyncAdminsClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
AsyncAdminsClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
java.util.concurrent.CompletableFuture<java.util.Optional<Admin>>	away(ConfigureAwayAdminRequest request)	You can set an Admin as away for the Inbox.
java.util.concurrent.CompletableFuture<java.util.Optional<Admin>>	away(ConfigureAwayAdminRequest request, RequestOptions requestOptions)	You can set an Admin as away for the Inbox.
java.util.concurrent.CompletableFuture<java.util.Optional<Admin>>	find(FindAdminRequest request)	You can retrieve the details of a single admin.
java.util.concurrent.CompletableFuture<java.util.Optional<Admin>>	find(FindAdminRequest request, RequestOptions requestOptions)	You can retrieve the details of a single admin.
java.util.concurrent.CompletableFuture<java.util.Optional<AdminWithApp>>	identify()	You can view the currently authorised admin along with the embedded app object (a "workspace" in legacy terminology).
java.util.concurrent.CompletableFuture<java.util.Optional<AdminWithApp>>	identify(RequestOptions requestOptions)	You can view the currently authorised admin along with the embedded app object (a "workspace" in legacy terminology).
java.util.concurrent.CompletableFuture<AdminList>	list()	You can fetch a list of admins for a given workspace.
java.util.concurrent.CompletableFuture<AdminList>	list(RequestOptions requestOptions)	You can fetch a list of admins for a given workspace.
java.util.concurrent.CompletableFuture<ActivityLogList>	listAllActivityLogs(ListAllActivityLogsRequest request)	You can get a log of activities by all admins in an app.
java.util.concurrent.CompletableFuture<ActivityLogList>	listAllActivityLogs(ListAllActivityLogsRequest request, RequestOptions requestOptions)	You can get a log of activities by all admins in an app.
AsyncRawAdminsClient	withRawResponse()	Get responses with HTTP metadata like headers

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

clientOptions

protected final ClientOptions clientOptions

Constructor Detail

AsyncAdminsClient

public AsyncAdminsClient(ClientOptions clientOptions)

Method Detail

withRawResponse

public AsyncRawAdminsClient withRawResponse()

Get responses with HTTP metadata like headers

identify

public java.util.concurrent.CompletableFuture<java.util.Optional<AdminWithApp>> identify()

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.

identify

public java.util.concurrent.CompletableFuture<java.util.Optional<AdminWithApp>> identify(RequestOptions requestOptions)

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.

away

public java.util.concurrent.CompletableFuture<java.util.Optional<Admin>> away(ConfigureAwayAdminRequest request)

You can set an Admin as away for the Inbox.

away

public java.util.concurrent.CompletableFuture<java.util.Optional<Admin>> away(ConfigureAwayAdminRequest request,
                                                                              RequestOptions requestOptions)

You can set an Admin as away for the Inbox.

listAllActivityLogs

public java.util.concurrent.CompletableFuture<ActivityLogList> listAllActivityLogs(ListAllActivityLogsRequest request)

You can get a log of activities by all admins in an app.

listAllActivityLogs

public java.util.concurrent.CompletableFuture<ActivityLogList> listAllActivityLogs(ListAllActivityLogsRequest request,
                                                                                   RequestOptions requestOptions)

You can get a log of activities by all admins in an app.

list

public java.util.concurrent.CompletableFuture<AdminList> list()

You can fetch a list of admins for a given workspace.

list

public java.util.concurrent.CompletableFuture<AdminList> list(RequestOptions requestOptions)

You can fetch a list of admins for a given workspace.

find

public java.util.concurrent.CompletableFuture<java.util.Optional<Admin>> find(FindAdminRequest request)

You can retrieve the details of a single admin.

find

public java.util.concurrent.CompletableFuture<java.util.Optional<Admin>> find(FindAdminRequest request,
                                                                              RequestOptions requestOptions)

You can retrieve the details of a single admin.