Package com.chrt.api.resources.notifications.groups

Class GroupsClient

java.lang.Object

com.chrt.api.resources.notifications.groups.GroupsClient

public class GroupsClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
GroupsClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
boolean	addEventV1(java.lang.String groupId, NotificationChannelsEnum channel, NotificationEventsForOrgsEnum event)	Adds a notification event to a channel for a group.
boolean	addEventV1(java.lang.String groupId, NotificationChannelsEnum channel, NotificationEventsForOrgsEnum event, RequestOptions requestOptions)	Adds a notification event to a channel for a group.
boolean	addUserV1(java.lang.String groupId, java.lang.String userId)	Adds a user to a notification group.
boolean	addUserV1(java.lang.String groupId, java.lang.String userId, RequestOptions requestOptions)	Adds a user to a notification group.
java.lang.String	createV1(NotificationGroupClientCreate1 request)	Creates a new notification group for the organization.
java.lang.String	createV1(NotificationGroupClientCreate1 request, RequestOptions requestOptions)	Creates a new notification group for the organization.
boolean	deleteV1(java.lang.String groupId)	Deletes a notification group.
boolean	deleteV1(java.lang.String groupId, RequestOptions requestOptions)	Deletes a notification group.
NotificationGroup1	getForAdministratorV1(java.lang.String groupId)	Retrieves full notification group details including user membership.
NotificationGroup1	getForAdministratorV1(java.lang.String groupId, RequestOptions requestOptions)	Retrieves full notification group details including user membership.
NotificationGroupLimitedForDriver1	getForMemberV1(java.lang.String groupId)	Retrieves limited notification group details for a group the caller is a member of.
NotificationGroupLimitedForDriver1	getForMemberV1(java.lang.String groupId, RequestOptions requestOptions)	Retrieves limited notification group details for a group the caller is a member of.
java.util.List<NotificationGroup1>	listByOrgV1()	Lists all notification groups for the caller's organization.
java.util.List<NotificationGroup1>	listByOrgV1(RequestOptions requestOptions)	Lists all notification groups for the caller's organization.
java.util.List<NotificationGroupLimitedForDriver1>	listByUserV1()	Lists notification groups the caller is a member of.
java.util.List<NotificationGroupLimitedForDriver1>	listByUserV1(RequestOptions requestOptions)	Lists notification groups the caller is a member of.
boolean	removeEventV1(java.lang.String groupId, NotificationChannelsEnum channel, NotificationEventsForOrgsEnum event)	Removes a notification event from a channel for a group.
boolean	removeEventV1(java.lang.String groupId, NotificationChannelsEnum channel, NotificationEventsForOrgsEnum event, RequestOptions requestOptions)	Removes a notification event from a channel for a group.
boolean	removeUserV1(java.lang.String groupId, java.lang.String userId)	Removes a user from a notification group.
boolean	removeUserV1(java.lang.String groupId, java.lang.String userId, RequestOptions requestOptions)	Removes a user from a notification group.
boolean	updateNameV1(java.lang.String groupId, GroupsUpdateNameV1Request request)	Updates the name of a notification group.
boolean	updateNameV1(java.lang.String groupId, GroupsUpdateNameV1Request request, RequestOptions requestOptions)	Updates the name of a notification group.
boolean	userOptInV1(java.lang.String groupId)	Opts the caller back into notifications for a group they were opted out of.
boolean	userOptInV1(java.lang.String groupId, RequestOptions requestOptions)	Opts the caller back into notifications for a group they were opted out of.
boolean	userOptOutV1(java.lang.String groupId)	Opts the caller out of notifications for a group.
boolean	userOptOutV1(java.lang.String groupId, RequestOptions requestOptions)	Opts the caller out of notifications for a group.
RawGroupsClient	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

GroupsClient

public GroupsClient(ClientOptions clientOptions)

Method Detail

withRawResponse

public RawGroupsClient withRawResponse()

Get responses with HTTP metadata like headers

listByOrgV1

public java.util.List<NotificationGroup1> listByOrgV1()

Lists all notification groups for the caller's organization. | authz: min_org_role=operator | () -> (list[NotificationGroup1])

listByOrgV1

public java.util.List<NotificationGroup1> listByOrgV1(RequestOptions requestOptions)

Lists all notification groups for the caller's organization. | authz: min_org_role=operator | () -> (list[NotificationGroup1])

getForAdministratorV1

public NotificationGroup1 getForAdministratorV1(java.lang.String groupId)

Retrieves full notification group details including user membership. | authz: min_org_role=operator | () -> (NotificationGroup1)

getForAdministratorV1

public NotificationGroup1 getForAdministratorV1(java.lang.String groupId,
                                                RequestOptions requestOptions)

Retrieves full notification group details including user membership. | authz: min_org_role=operator | () -> (NotificationGroup1)

listByUserV1

public java.util.List<NotificationGroupLimitedForDriver1> listByUserV1()

Lists notification groups the caller is a member of. | () -> (list[NotificationGroupLimitedForDriver1])

listByUserV1

public java.util.List<NotificationGroupLimitedForDriver1> listByUserV1(RequestOptions requestOptions)

Lists notification groups the caller is a member of. | () -> (list[NotificationGroupLimitedForDriver1])

getForMemberV1

public NotificationGroupLimitedForDriver1 getForMemberV1(java.lang.String groupId)

Retrieves limited notification group details for a group the caller is a member of. | () -> (NotificationGroupLimitedForDriver1)

getForMemberV1

public NotificationGroupLimitedForDriver1 getForMemberV1(java.lang.String groupId,
                                                         RequestOptions requestOptions)

Retrieves limited notification group details for a group the caller is a member of. | () -> (NotificationGroupLimitedForDriver1)

createV1

public java.lang.String createV1(NotificationGroupClientCreate1 request)

Creates a new notification group for the organization. | authz: min_org_role=administrator | (NotificationGroupClientCreate1) -> (PydanticObjectId)

createV1

public java.lang.String createV1(NotificationGroupClientCreate1 request,
                                 RequestOptions requestOptions)

Creates a new notification group for the organization. | authz: min_org_role=administrator | (NotificationGroupClientCreate1) -> (PydanticObjectId)

updateNameV1

public boolean updateNameV1(java.lang.String groupId,
                            GroupsUpdateNameV1Request request)

Updates the name of a notification group. | authz: min_org_role=administrator | () -> (bool)

updateNameV1

public boolean updateNameV1(java.lang.String groupId,
                            GroupsUpdateNameV1Request request,
                            RequestOptions requestOptions)

Updates the name of a notification group. | authz: min_org_role=administrator | () -> (bool)

addEventV1

public boolean addEventV1(java.lang.String groupId,
                          NotificationChannelsEnum channel,
                          NotificationEventsForOrgsEnum event)

Adds a notification event to a channel for a group. | authz: min_org_role=administrator | () -> (bool)

addEventV1

public boolean addEventV1(java.lang.String groupId,
                          NotificationChannelsEnum channel,
                          NotificationEventsForOrgsEnum event,
                          RequestOptions requestOptions)

Adds a notification event to a channel for a group. | authz: min_org_role=administrator | () -> (bool)

removeEventV1

public boolean removeEventV1(java.lang.String groupId,
                             NotificationChannelsEnum channel,
                             NotificationEventsForOrgsEnum event)

Removes a notification event from a channel for a group. | authz: min_org_role=administrator | () -> (bool)

removeEventV1

public boolean removeEventV1(java.lang.String groupId,
                             NotificationChannelsEnum channel,
                             NotificationEventsForOrgsEnum event,
                             RequestOptions requestOptions)

Removes a notification event from a channel for a group. | authz: min_org_role=administrator | () -> (bool)

addUserV1

public boolean addUserV1(java.lang.String groupId,
                         java.lang.String userId)

Adds a user to a notification group. | authz: min_org_role=administrator | () -> (bool)

addUserV1

public boolean addUserV1(java.lang.String groupId,
                         java.lang.String userId,
                         RequestOptions requestOptions)

Adds a user to a notification group. | authz: min_org_role=administrator | () -> (bool)

removeUserV1

public boolean removeUserV1(java.lang.String groupId,
                            java.lang.String userId)

Removes a user from a notification group. | authz: min_org_role=administrator | () -> (bool)

removeUserV1

public boolean removeUserV1(java.lang.String groupId,
                            java.lang.String userId,
                            RequestOptions requestOptions)

Removes a user from a notification group. | authz: min_org_role=administrator | () -> (bool)

deleteV1

public boolean deleteV1(java.lang.String groupId)

Deletes a notification group. | authz: min_org_role=administrator | () -> (bool)

deleteV1

public boolean deleteV1(java.lang.String groupId,
                        RequestOptions requestOptions)

Deletes a notification group. | authz: min_org_role=administrator | () -> (bool)

userOptInV1

public boolean userOptInV1(java.lang.String groupId)

Opts the caller back into notifications for a group they were opted out of. | () -> (bool)

userOptInV1

public boolean userOptInV1(java.lang.String groupId,
                           RequestOptions requestOptions)

Opts the caller back into notifications for a group they were opted out of. | () -> (bool)

userOptOutV1

public boolean userOptOutV1(java.lang.String groupId)

Opts the caller out of notifications for a group. | () -> (bool)

userOptOutV1

public boolean userOptOutV1(java.lang.String groupId,
                            RequestOptions requestOptions)

Opts the caller out of notifications for a group. | () -> (bool)