Package com.intercom.api.resources.admins

Class AsyncAdminsClient

java.lang.Object

com.intercom.api.resources.admins.AsyncAdminsClient

public class AsyncAdminsClient
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected final ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
AsyncAdminsClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
CompletableFuture<Admin>	away(ConfigureAwayAdminRequest request)	You can set an Admin as away for the Inbox.
CompletableFuture<Admin>	away(ConfigureAwayAdminRequest request, RequestOptions requestOptions)	You can set an Admin as away for the Inbox.
CompletableFuture<Admin>	find(FindAdminRequest request)	You can retrieve the details of a single admin.
CompletableFuture<Admin>	find(FindAdminRequest request, RequestOptions requestOptions)	You can retrieve the details of a single admin.
CompletableFuture<AdminWithApp>	identify()	You can view the currently authorised admin along with the embedded app object (a "workspace" in legacy terminology).
CompletableFuture<AdminWithApp>	identify(RequestOptions requestOptions)	You can view the currently authorised admin along with the embedded app object (a "workspace" in legacy terminology).
CompletableFuture<AdminList>	list()	You can fetch a list of admins for a given workspace.
CompletableFuture<AdminList>	list(RequestOptions requestOptions)	You can fetch a list of admins for a given workspace.
CompletableFuture<ActivityLogList>	listAllActivityLogs(ListAllActivityLogsRequest request)	You can get a log of activities by all admins in an app.
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 Details

clientOptions

protected final ClientOptions clientOptions

Constructor Details

AsyncAdminsClient

public AsyncAdminsClient(ClientOptions clientOptions)

Method Details

withRawResponse

public AsyncRawAdminsClient withRawResponse()

Get responses with HTTP metadata like headers

identify

public CompletableFuture<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 CompletableFuture<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 CompletableFuture<Admin> away(ConfigureAwayAdminRequest request)

You can set an Admin as away for the Inbox.

away

public CompletableFuture<Admin> away(ConfigureAwayAdminRequest request,
 RequestOptions requestOptions)

You can set an Admin as away for the Inbox.

listAllActivityLogs

public CompletableFuture<ActivityLogList> listAllActivityLogs(ListAllActivityLogsRequest request)

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

listAllActivityLogs

public CompletableFuture<ActivityLogList> listAllActivityLogs(ListAllActivityLogsRequest request,
 RequestOptions requestOptions)

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

list

public CompletableFuture<AdminList> list()

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

list

public CompletableFuture<AdminList> list(RequestOptions requestOptions)

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

find

public CompletableFuture<Admin> find(FindAdminRequest request)

You can retrieve the details of a single admin.

find

public CompletableFuture<Admin> find(FindAdminRequest request,
 RequestOptions requestOptions)

You can retrieve the details of a single admin.