Interface GroupService
-
- All Implemented Interfaces:
public interface GroupService
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public interfaceGroupService.WithRawResponseA view of GroupService that provides access to raw HTTP responses for each method.
-
Method Summary
Modifier and Type Method Description abstract GroupService.WithRawResponsewithRawResponse()Returns a view of this service that provides access to raw HTTP responses for each method. Groupcreate(GroupCreateParams params)Create a new group. abstract Groupcreate(GroupCreateParams params, RequestOptions requestOptions)Groupretrieve(GroupRetrieveParams params)Get a group object by its id abstract Groupretrieve(GroupRetrieveParams params, RequestOptions requestOptions)Groupupdate(GroupUpdateParams params)Partially update a group object. abstract Groupupdate(GroupUpdateParams params, RequestOptions requestOptions)GroupListPagelist()List out all groups. abstract GroupListPagelist(GroupListParams params, RequestOptions requestOptions)GroupListPagelist(GroupListParams params)GroupListPagelist(RequestOptions requestOptions)Groupdelete(GroupDeleteParams params)Delete a group object by its id abstract Groupdelete(GroupDeleteParams params, RequestOptions requestOptions)Groupreplace(GroupReplaceParams params)Create or replace group. abstract Groupreplace(GroupReplaceParams params, RequestOptions requestOptions)-
-
Method Detail
-
withRawResponse
abstract GroupService.WithRawResponse withRawResponse()
Returns a view of this service that provides access to raw HTTP responses for each method.
-
create
Group create(GroupCreateParams params)
Create a new group. If there is an existing group with the same name as the one specified in the request, will return the existing group unmodified
-
create
abstract Group create(GroupCreateParams params, RequestOptions requestOptions)
-
retrieve
Group retrieve(GroupRetrieveParams params)
Get a group object by its id
-
retrieve
abstract Group retrieve(GroupRetrieveParams params, RequestOptions requestOptions)
-
update
Group update(GroupUpdateParams params)
Partially update a group object. Specify the fields to update in the payload. Any object-type fields will be deep-merged with existing content. Currently we do not support removing fields or setting them to null.
-
update
abstract Group update(GroupUpdateParams params, RequestOptions requestOptions)
-
list
GroupListPage list()
List out all groups. The groups are sorted by creation date, with the most recently-created groups coming first
-
list
abstract GroupListPage list(GroupListParams params, RequestOptions requestOptions)
-
list
GroupListPage list(GroupListParams params)
-
list
GroupListPage list(RequestOptions requestOptions)
-
delete
Group delete(GroupDeleteParams params)
Delete a group object by its id
-
delete
abstract Group delete(GroupDeleteParams params, RequestOptions requestOptions)
-
replace
Group replace(GroupReplaceParams params)
Create or replace group. If there is an existing group with the same name as the one specified in the request, will replace the existing group with the provided fields
-
replace
abstract Group replace(GroupReplaceParams params, RequestOptions requestOptions)
-
-
-
-