Add inbox Attachment docs #295
Conversation
|
@Azdaroth do you need a screenshot or some sort of screencast to review this? |
|
@adamgrad No, I trust that you checked it, since you know how it's supposed to look like |
|
@adamgrad it will be better to have all docs for Inbox in one PR, we can't just release docs for one endpoint |
|
@Azdaroth it's done, could you give it a look? |
| @@ -0,0 +1,30 @@ | |||
| { | |||
| "links": { | |||
| "attachments.account": "http://test.host/api/v3/accounts/{attachments.account}", | |||
There was a problem hiding this comment.
would be good to replace test.host with www.bookingsync.com everywhere
| "conversation": 3, | ||
| "member": { | ||
| "id": 5, | ||
| "type": "Host" |
There was a problem hiding this comment.
hmm, in that case we need docs for /hosts endpoint but that could be a separate PR
| closed_at | [Time](/reference/enums#formats) | Read | Time when Converstation has been closed at. | ||
| deadline_response_at | [Time](/reference/enums#formats) | Read | Conversation's deadline response time. | ||
| last_message_at | [Time](/reference/enums#formats) | Read | Conversation's last message time. | ||
| marked_as_spam_at | [Time](/reference/enums#formats) | Read | Time when Conversation has been marked as spam. |
There was a problem hiding this comment.
has been -> was, since we know the exact time
| ---------------------|---------|------------|------------ | ||
| created_at | [Time](/reference/enums#formats) | Read | Conversation's create time. | ||
| updated_at | [Time](/reference/enums#formats) | Read | Conversation's update time. | ||
| closed_at | [Time](/reference/enums#formats) | Read | Time when Converstation has been closed at. |
There was a problem hiding this comment.
has been -> was, we know the exact time
| ---------------------|---------|------------|------------ | ||
| id | Integer | Read | Message's id. | ||
| ---------------------|---------|------------|------------ | ||
| channel | String | Read | Message's channel. |
There was a problem hiding this comment.
this should link to some whitelisted channels
| channel | String | Read | Message's channel. | ||
| content | Text | Read | Message's content. | ||
| origin | String | Read | Message's origin. | ||
| visibility | String | Read | Message's visibility. |
There was a problem hiding this comment.
this should link to some whitelisted visibility options
| ---------------------|---------|------------|------------ | ||
| created_at | [Time](/reference/enums#formats) | Read | Message's create time. | ||
| updated_at | [Time](/reference/enums#formats) | Read | Message's update time. | ||
| sent_at | [Time](/reference/enums#formats) | Read | Time when Message has been sent at. |
There was a problem hiding this comment.
has been -> was, we know exact time
| ---------------------|---------|------------|------------ | ||
| created_at | [Time](/reference/enums#formats) | Read | Message's create time. | ||
| updated_at | [Time](/reference/enums#formats) | Read | Message's update time. | ||
| sent_at | [Time](/reference/enums#formats) | Read/Write | Time when Message has been sent at. |
There was a problem hiding this comment.
has been -> was, we know the exact time
| conversation_id | String | Write | Message's conversation id. | ||
| sender_id | String | Write | Message's sender id. | ||
| ---------------------|---------|------------|------------ | ||
| channel | String | Read/Write | Message's channel. |
There was a problem hiding this comment.
channel, origin and visibility should link to some enums
| member_id | Integer | Read/Write | Participant's Member id. | ||
| conversation_id | Integer | Read/Write | Participant's Conversation id. | ||
| ---------------------|---------|------------|------------ | ||
| read | Boolean | Read/Write | Is related to Participant's read_at attribute. |
There was a problem hiding this comment.
read is write only, read_at is both read/write, but read is really the same as sending read_at with Time.current
|
@Azdaroth feedback is here. I'll submit hosts endpoint in separate PR as you suggested |
content/reference/enums.md
Outdated
| bookingsync_inbox | BookingSync Inbox | ||
| airbnb_message | Airbnb message | ||
| airbnb_email | Airbnb email | ||
| booking-com | booking.com |
There was a problem hiding this comment.
Booking.com in the origin should be capitalised, especially if it's one our more biggest partners :P
|
@Azdaroth fixed and resolved conflicts |
No description provided.