Implement v1 API

[graywolf336]

Right now the following items need to be built out, this will serve as a living issue. When building them out, we need to be sure to build out the complete model with getters and setters along with the method on the main client.

Misc

• Server Info (documentation)

Authentication

• Login (documentation)
• Logout (documentation)
• Me (documentation)

Chat Messages

• Send chat messages, with attachment support (documentation)
• Delete chat messages (documentation)

Users

• Create (documentation)
• Delete (documentation)
• Get Presence (documentation)
• Get Info (documentation)
• List (documentation)
• Set Avatar (documentation)
• Update (documentation)

Channels

• Add All (documentation)
• Archive (documentation)
• Change Type (still in the works, so no documentation)
• Clean History (documentation)
• Close (documentation)
• Create (documentation)
• Get Integrations (still in the works, so no documentation)
• History (documentation)
• Info (documentation)
• Invite (documentation)
• Kick (documentation)
• Leave (documentation)
• List Joined (documentation)
• List (documentation)
• Open (documentation)
• Rename (documentation)
• Set Description (documentation)
• Set Join Code (still in the works, so no documentation)
• Set Purpose (documentation)
• Set Read Only (still in the works, so no documentation)
• Set Topic (documentation)
• Unarchive (documentation)

Groups

• Archive (documentation)
• Change Type (still in the works, so no documentation)
• Close (documentation)
• Create (documentation)
• Get Integrations (still in the works, so no documentation)
• History (documentation)
• Info (documentation)
• Invite (documentation)
• Kick (documentation)
• Leave (documentation)
• List (documentation)
• Open (documentation)
• Rename (documentation)
• Set Description (documentation)
• Set Purpose (documentation)
• Set Read Only (still in the works, so no documentation)
• Set Topic (documentation)
• Unarchive (documentation)

Settings

• Get (documentation)
• Update (documentation)
• List (documentation)

Integrations

• Create (still in the works, so no documentation)
• List (still in the works, so no documentation)

Livechat

• Department (documentation)
• Sms Incoming (documentation)
• Users (documentation)

[graywolf336]

@rynefagin Take a look at the above, figure we might create an issue and track our progress via it.

[rynefagin]

Sounds good, just what we needed. Thanks @graywolf336

[graywolf336]

@rynefagin I'm going to start working on the chat apis, you good with that?

[rynefagin]

Yes

[graywolf336]

@rynefagin I am adding pagination to the Rocket.Chat REST API for things like GET channels.list, so we will have to add pagination support however I'm not 100% certain how we should go about doing that. Any ideas?

[rynefagin]

@graywolf336 Hmmm. One thought is to use the link header in the response which shifts the burden off of the java api to build links to the next set of results and means we don't have to include pagination data in the payload.

[graywolf336]

@rynefagin Sadly that requirement wasn't in the time frame I was allocated to build the pagination support and will be added in the future 👎

[rynefagin]

@graywolf336 any ideas? So pagination will be provided in the body?

[graywolf336]

@rynefagin After doing some work on the rest api and pagination, only a few items are going to have them and those are the ones which list everything like the channels.list. It takes two parameters:

• count - how many items you want to get, defaults to 50 but it is configurable per server.
• offset - which position in the overall list of items do you want to start from, defaults to 0. We went with offset instead of pages because it is easier for other people and also allows for more flexibility when trying to get items from the server.

Does that make sense?

[graywolf336]

@rynefagin You can an invite to collaborate on this repository, click here to see the invite. I only say this, as I would like to start making reviews on pull requests required for your review to be considered official you have to be a collaborator on this repository.

[Davide95]

Are there news about implementing v1?
For what I'm reading here send/delete messages are not supported yet. Is that true?

[sscholl]

Is the API compatible with the current version of RocketChat?
Thanks!

[orrchen]

yes it is

[col-panic]

Working on an implementation of the Settings, see https://github.com/col-panic/rocket-chat-rest-client/tree/settingsImpl for current progress. Currently building and testing seems not possible - see #33