README.md in ribose-0.3.0 vs README.md in ribose-0.3.1
- old
+ new
@@ -229,10 +229,16 @@
```ruby
Ribose::SpaceFile.fetch(space_id, file_id, options = {})
```
+#### Fetch a file icon
+
+```ruby
+Ribose::SpaceFile.fetch_icon(space_id, file_id, options = {})
+```
+
#### Create a file upload
```ruby
Ribose::SpaceFile.create(space_id, file: "The complete file path", **attributes)
```
@@ -247,10 +253,20 @@
```ruby
Ribose::SpaceFile.delete(space_id, file_id)
```
+### File Version
+
+#### Fetch file version
+
+```ruby
+Ribose::FileVersion.fetch(
+ space_id: space_id, file_id: file_id, version_id: version_id
+)
+```
+
### Conversations
#### Listing Space Conversations
```ruby
@@ -281,10 +297,16 @@
```ruby
Ribose::Conversation.destroy(space_id: "space_id", conversation_id: "12345")
```
+#### Mark a conversation as favorite
+
+```ruby
+Ribose::Conversation.mark_as_favorite(space_id, conversation_id)
+```
+
### Message
#### List Conversation Messages
```ruby
@@ -554,10 +576,57 @@
```ruby
Ribose::Calendar.delete(calendar_id)
```
+### Event
+
+#### List calendar events
+
+```ruby
+Ribose::Event.all(calendar_id)
+```
+
+#### Fetch a calendar event
+
+```ruby
+Ribose::Event.fetch(calendar_id, event_id)
+```
+
+#### Create a calendar event
+
+```ruby
+Ribose::Event.create(
+ calendar_id,
+ name: "Sample Event",
+ date_start: "04/04/2018",
+ time_start: "4:30pm",
+ date_finish: "04/04/2018",
+ time_finish: "5:30pm",
+ recurring_type: "not_repeat",
+ until: "never",
+ repeat_every: "1",
+ where: "Skype",
+ description: "Sample event",
+ all_day: false,
+)
+```
+
+#### Update a calendar event
+
+```ruby
+Ribose::Event.update(
+ calendar_id, event_id, new_attributes_hash, options_params
+)
+```
+
+#### Delete a calendar event
+
+```ruby
+Ribose::Event.delete(calendar_id, event_id)
+```
+
### User
#### Create a signup request
```ruby
@@ -606,9 +675,17 @@
#### Remove a wiki page
```ruby
Ribose::Wiki.delete(space_id, wiki_id)
+```
+
+### Space categories
+
+#### List space categories
+
+```ruby
+Ribose::SpaceCategory.all
```
## Development
We are following Sandi Metz's Rules for this gem, you can read the