Package com.intercom.api.resources.unstable.admins

Class RawAdminsClient

java.lang.Object

com.intercom.api.resources.unstable.admins.RawAdminsClient

public class RawAdminsClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
RawAdminsClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
IntercomHttpResponse<java.util.Optional<AdminWithApp>>	identifyAdmin()	You can view the currently authorised admin along with the embedded app object (a "workspace" in legacy terminology).
IntercomHttpResponse<java.util.Optional<AdminWithApp>>	identifyAdmin(RequestOptions requestOptions)	You can view the currently authorised admin along with the embedded app object (a "workspace" in legacy terminology).
IntercomHttpResponse<ActivityLogList>	listActivityLogs(ListActivityLogsRequest request)	You can get a log of activities by all admins in an app.
IntercomHttpResponse<ActivityLogList>	listActivityLogs(ListActivityLogsRequest request, RequestOptions requestOptions)	You can get a log of activities by all admins in an app.
IntercomHttpResponse<AdminList>	listAdmins()	You can fetch a list of admins for a given workspace.
IntercomHttpResponse<AdminList>	listAdmins(RequestOptions requestOptions)	You can fetch a list of admins for a given workspace.
IntercomHttpResponse<java.util.Optional<Admin>>	retrieveAdmin(RetrieveAdminRequest request)	You can retrieve the details of a single admin.
IntercomHttpResponse<java.util.Optional<Admin>>	retrieveAdmin(RetrieveAdminRequest request, RequestOptions requestOptions)	You can retrieve the details of a single admin.
IntercomHttpResponse<java.util.Optional<Admin>>	setAwayAdmin(SetAwayAdminRequest request)	You can set an Admin as away for the Inbox.
IntercomHttpResponse<java.util.Optional<Admin>>	setAwayAdmin(SetAwayAdminRequest request, RequestOptions requestOptions)	You can set an Admin as away for the Inbox.

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

RawAdminsClient

public RawAdminsClient(ClientOptions clientOptions)

Method Detail

identifyAdmin

public IntercomHttpResponse<java.util.Optional<AdminWithApp>> identifyAdmin()

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.

identifyAdmin

public IntercomHttpResponse<java.util.Optional<AdminWithApp>> identifyAdmin(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.

setAwayAdmin

public IntercomHttpResponse<java.util.Optional<Admin>> setAwayAdmin(SetAwayAdminRequest request)

You can set an Admin as away for the Inbox.

setAwayAdmin

public IntercomHttpResponse<java.util.Optional<Admin>> setAwayAdmin(SetAwayAdminRequest request,
                                                                    RequestOptions requestOptions)

You can set an Admin as away for the Inbox.

listActivityLogs

public IntercomHttpResponse<ActivityLogList> listActivityLogs(ListActivityLogsRequest request)

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

listActivityLogs

public IntercomHttpResponse<ActivityLogList> listActivityLogs(ListActivityLogsRequest request,
                                                              RequestOptions requestOptions)

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

listAdmins

public IntercomHttpResponse<AdminList> listAdmins()

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

listAdmins

public IntercomHttpResponse<AdminList> listAdmins(RequestOptions requestOptions)

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

retrieveAdmin

public IntercomHttpResponse<java.util.Optional<Admin>> retrieveAdmin(RetrieveAdminRequest request)

You can retrieve the details of a single admin.

retrieveAdmin

public IntercomHttpResponse<java.util.Optional<Admin>> retrieveAdmin(RetrieveAdminRequest request,
                                                                     RequestOptions requestOptions)

You can retrieve the details of a single admin.