GroupsApi (java-sdk 1.4 API)

```
public interface GroupsApi
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`rx.Observable<java.lang.Void>`	`addDevice(java.lang.String groupId, GroupDeviceAdd deviceIds)` Adds device to a group and returns 200 OK if successful, error otherwise.
`rx.Observable<Group>`	`createGroup(GroupCreate groupCreate)` Creates new group and returns 200 OK if group is successfully created, error otherwise.
`rx.Observable<java.lang.Void>`	`deleteDevice(java.lang.String groupId, java.lang.String deviceId)` Deletes device from a group and returns 200 OK if successful, error otherwise.
`rx.Observable<java.lang.Void>`	`deleteGroup(java.lang.String groupId)` Deletes group and returns 200 OK if group is successfully updated, error otherwise.
`rx.Observable<Group>`	`getGroup(java.lang.String groupId)` Returns group defined with groupId
`rx.Observable<java.lang.Void>`	`updateDevicePosition(java.lang.String groupId, java.lang.String deviceId, PositionUpdate update)` Updates device's position in a group and returns 200 OK if successful, error otherwise.
`rx.Observable<java.lang.Void>`	`updateGroup(GroupCreate group, java.lang.String groupId)` Updates group and returns 200 OK if group is successfully updated, error otherwise.

Method Detail

createGroup

@POST(value="/groups")
rx.Observable<Group> createGroup(@Body
                                                        GroupCreate groupCreate)

Creates new group and returns 200 OK if group is successfully created, error otherwise.

Parameters:: groupCreate - GroupCreate
Returns:: an empty Observable

getGroup

@GET(value="/groups/{groupId}")
rx.Observable<Group> getGroup(@Path(value="groupId")
                                                              java.lang.String groupId)

Returns group defined with groupId

Parameters:: groupId - Group.id
Returns:: an Observable

updateGroup

@PATCH(value="/groups/{groupId}")
rx.Observable<java.lang.Void> updateGroup(@Body
                                                                            GroupCreate group,
                                                                            @Path(value="groupId")
                                                                            java.lang.String groupId)

Updates group and returns 200 OK if group is successfully updated, error otherwise.

Parameters:: group - group object with updated fields; groupId - Group.id
Returns:: an empty Observable

addDevice

@POST(value="/groups/{groupId}")
rx.Observable<java.lang.Void> addDevice(@Path(value="groupId")
                                                                         java.lang.String groupId,
                                                                         @Body
                                                                         GroupDeviceAdd deviceIds)

Adds device to a group and returns 200 OK if successful, error otherwise.

Parameters:: groupId - Group.id; deviceIds - Device.id
Returns:: an empty Observable

deleteDevice

@DELETE(value="/groups/{groupId}/devices/{deviceId}")
rx.Observable<java.lang.Void> deleteDevice(@Path(value="groupId")
                                                                                                 java.lang.String groupId,
                                                                                                 @Path(value="deviceId")
                                                                                                 java.lang.String deviceId)

Deletes device from a group and returns 200 OK if successful, error otherwise.

Parameters:: groupId - Group.id; deviceId - Device.id
Returns:: an empty Observable

updateDevicePosition

@PATCH(value="/groups/{groupId}/devices/{deviceId}")
rx.Observable<java.lang.Void> updateDevicePosition(@Path(value="groupId")
                                                                                                        java.lang.String groupId,
                                                                                                        @Path(value="deviceId")
                                                                                                        java.lang.String deviceId,
                                                                                                        @Body
                                                                                                        PositionUpdate update)

Updates device's position in a group and returns 200 OK if successful, error otherwise.

Parameters:: groupId - Group.id; deviceId - Device.id
Returns:: an empty Observable

deleteGroup

@DELETE(value="/groups/{groupId}")
rx.Observable<java.lang.Void> deleteGroup(@Path(value="groupId")
                                                                             java.lang.String groupId)

Deletes group and returns 200 OK if group is successfully updated, error otherwise.

Parameters:: groupId - Group.id
Returns:: an empty Observable

Interface GroupsApi