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

Class RawGroupsClient

java.lang.Object

com.chrt.api.resources.notifications.groups.RawGroupsClient

public class RawGroupsClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
RawGroupsClient(ClientOptions clientOptions)

Method Summary

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

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

RawGroupsClient

public RawGroupsClient(ClientOptions clientOptions)

Method Detail

listByOrgV1

public ChrtApiHttpResponse<NotificationGroupListRes> listByOrgV1()

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

listByOrgV1

public ChrtApiHttpResponse<NotificationGroupListRes> listByOrgV1(GroupsListByOrgV1Request request)

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

listByOrgV1

public ChrtApiHttpResponse<NotificationGroupListRes> listByOrgV1(GroupsListByOrgV1Request request,
                                                                 RequestOptions requestOptions)

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

getForAdministratorV1

public ChrtApiHttpResponse<NotificationGroup1> getForAdministratorV1(java.lang.String groupId)

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

getForAdministratorV1

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

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

listByUserV1

public ChrtApiHttpResponse<NotificationGroupUserListRes> listByUserV1()

Lists notification groups the caller is a member of. | () -> (NotificationGroupUserListRes)

listByUserV1

public ChrtApiHttpResponse<NotificationGroupUserListRes> listByUserV1(GroupsListByUserV1Request request)

Lists notification groups the caller is a member of. | () -> (NotificationGroupUserListRes)

listByUserV1

public ChrtApiHttpResponse<NotificationGroupUserListRes> listByUserV1(GroupsListByUserV1Request request,
                                                                      RequestOptions requestOptions)

Lists notification groups the caller is a member of. | () -> (NotificationGroupUserListRes)

getForMemberV1

public ChrtApiHttpResponse<NotificationGroupLimitedForDriver1> getForMemberV1(java.lang.String groupId)

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

getForMemberV1

public ChrtApiHttpResponse<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 ChrtApiHttpResponse<java.lang.String> createV1(NotificationGroupClientCreate1 request)

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

createV1

public ChrtApiHttpResponse<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 ChrtApiHttpResponse<java.lang.Boolean> updateNameV1(java.lang.String groupId,
                                                           GroupsUpdateNameV1Request request)

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

updateNameV1

public ChrtApiHttpResponse<java.lang.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 ChrtApiHttpResponse<java.lang.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 ChrtApiHttpResponse<java.lang.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 ChrtApiHttpResponse<java.lang.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 ChrtApiHttpResponse<java.lang.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 ChrtApiHttpResponse<java.lang.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 ChrtApiHttpResponse<java.lang.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 ChrtApiHttpResponse<java.lang.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 ChrtApiHttpResponse<java.lang.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 ChrtApiHttpResponse<java.lang.Boolean> deleteV1(java.lang.String groupId)

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

deleteV1

public ChrtApiHttpResponse<java.lang.Boolean> deleteV1(java.lang.String groupId,
                                                       RequestOptions requestOptions)

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

userOptInV1

public ChrtApiHttpResponse<java.lang.Boolean> userOptInV1(java.lang.String groupId)

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

userOptInV1

public ChrtApiHttpResponse<java.lang.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 ChrtApiHttpResponse<java.lang.Boolean> userOptOutV1(java.lang.String groupId)

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

userOptOutV1

public ChrtApiHttpResponse<java.lang.Boolean> userOptOutV1(java.lang.String groupId,
                                                           RequestOptions requestOptions)

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