swa.json

{"apiVersion":1,"swaggerVersion":1.2,"basePath":"https://api.cardstreams.io","description":"Cardstreams v1 API","resourcePath":"/streams","produces":["application/json"],"consumes":["application/json"],"apis":[{"path":"/v1/streams","operations":[{"method":"GET","summary":"Retrieve all Streams","notes":"Returns a list of all Streams for a given app.","type":"array","items":{"$ref":"Stream"},"nickname":"getStreams","parameters":[{"name":"X-Cardstreams-AppId","description":"The generated Application ID","type":"string","threescale_name":"app_ids","paramType":"header","required":false},{"name":"X-Cardstreams-AppKey","description":"The generated Application Key","threescale_name":"app_keys","type":"string","paramType":"header","required":false},{"name":"Authorization","description":"Authorization bearer token for access","type":"string","paramType":"header","required":false}],"responseMessages":[{"code":200,"message":"OK","responseModel":"Stream"}]},{"method":"POST","summary":"Create a new Stream.","notes":"Create a Stream.","type":"Stream","nickname":"createStream","parameters":[{"name":"body","description":"The Stream JSON object.","required":true,"type":"POST_Stream","paramType":"body"},{"name":"X-Cardstreams-AppId","description":"The generated Application ID","type":"string","threescale_name":"app_ids","paramType":"header","required":false},{"name":"X-Cardstreams-AppKey","description":"The generated Application Key","threescale_name":"app_keys","type":"string","paramType":"header","required":false},{"name":"Authorization","description":"Authorization bearer token for access","type":"string","paramType":"header","required":false}],"responseMessages":[{"code":200,"message":"OK","responseModel":"Stream"}]}]},{"path":"/v1/streams/{streamId}","operations":[{"method":"GET","summary":"Retrieve a specific Stream.","notes":"Returns a specific Stream.","type":"Stream","nickname":"getStream","parameters":[{"name":"streamId","description":"The ID of the Strim to retrieve.","required":true,"type":"string","paramType":"path"},{"name":"X-Cardstreams-AppId","description":"The generated Application ID","type":"string","threescale_name":"app_ids","paramType":"header","required":false},{"name":"X-Cardstreams-AppKey","description":"The generated Application Key","threescale_name":"app_keys","type":"string","paramType":"header","required":false},{"name":"Authorization","description":"Authorization bearer token for access","type":"string","paramType":"header","required":false}],"responseMessages":[{"code":200,"message":"OK","responseModel":"Stream"},{"code":404,"message":"Stream not found"}]},{"method":"DELETE","summary":"Deletes a Stream.","notes":"Deletes a Stream.","type":"void","nickname":"deleteStream","parameters":[{"name":"streamId","description":"The ID of the Stream to delete.","required":true,"type":"string","paramType":"path"},{"name":"X-Cardstreams-AppId","description":"The generated Application ID","type":"string","threescale_name":"app_ids","paramType":"header","required":false},{"name":"X-Cardstreams-AppKey","description":"The generated Application Key","threescale_name":"app_keys","type":"string","paramType":"header","required":false},{"name":"Authorization","description":"Authorization bearer token for access","type":"string","paramType":"header","required":false}],"responseMessages":[{"code":200,"message":"OK"},{"code":404,"message":"Stream not found"}]},{"method":"PATCH","summary":"Updates a Stream.","notes":"Updates a Stream.","type":"Stream","nickname":"updateStream","parameters":[{"name":"body","description":"The Stream JSON object.","required":true,"type":"PATCH_Stream","paramType":"body"},{"name":"streamId","description":"The ID of the Stream to retrieve.","required":true,"type":"string","paramType":"path"},{"name":"X-Cardstreams-AppId","description":"The generated Application ID","type":"string","threescale_name":"app_ids","paramType":"header","required":false},{"name":"X-Cardstreams-AppKey","description":"The generated Application Key","threescale_name":"app_keys","type":"string","paramType":"header","required":false},{"name":"Authorization","description":"Authorization bearer token for access","type":"string","paramType":"header","required":false}],"responseMessages":[{"code":200,"message":"OK","responseModel":"Stream"},{"code":404,"message":"Stream not found"}]}]},{"path":"/v1/streams/{streamId}/cards","operations":[{"method":"GET","type":"CardBatch","nickname":"getCards","summary":"Get Cards","notes":"Returns Cards for the Stream.","parameters":[{"name":"streamId","description":"The ID of the Stream to get the Cards from.","required":true,"type":"string","paramType":"path"},{"name":"ts","description":"Timestamp in milliseconds to use as a reference point for fetching Cards within the Stream. If not specified, the current timestamp is taken as the default value","type":"integer","format":"int64","paramType":"query"},{"name":"direction","description":"Direction in which Cards should be fetched from the given Stream reference","type":"string","enum":["past","around","future"],"defaultValue":"past","paramType":"query"},{"name":"limit","description":"Maximum number of cards to fetch for the request","type":"integer","format":"int32","defaultValue":20,"paramType":"query"},{"name":"q","description":"Search term to apply as a filter for fetching Cards","type":"string","paramType":"query"},{"name":"media_urls","description":"Provide active URLs that provide access to any files attached to the Card. The time the provided URLs remain active is specified by the <code>urls_ttl</code> parameter. Disabling this may improve the request latency of the operation.","type":"boolean","defaultValue":"true","paramType":"query"},{"name":"preview_urls","description":"Provide active URLs that provide access to any document previews of files attached to the Card. The time the provided URLs remain active is specified by the <code>urls_ttl</code> parameter. Disabling this may improve the request latency of the operation.","type":"boolean","defaultValue":"true","paramType":"query"},{"name":"thumb_urls","description":"Provide active URLs that provide access to any thumbnail images of files attached to the Card. The time the provided URLs remain active is specified by the <code>urls_ttl</code> parameter. Disabling this may improve the request latency of the operation.","type":"boolean","defaultValue":"true","paramType":"query"},{"name":"urls_ttl","description":"Time in seconds that the URLs remain active for accessing attached files or their representations. Once this timeout expires, attempts to access such URLs will result in 403 status responses","type":"integer","format":"int32","defaultValue":300,"paramType":"query"},{"name":"X-Cardstreams-AppId","description":"The generated Application ID","type":"string","threescale_name":"app_ids","paramType":"header","required":false},{"name":"X-Cardstreams-AppKey","description":"The generated Application Key","threescale_name":"app_keys","type":"string","paramType":"header","required":false},{"name":"Authorization","description":"Authorization bearer token for access","type":"string","paramType":"header","required":false}],"responseMessages":[{"code":200,"message":"OK","responseModel":"CardBatch"},{"code":404,"message":"Stream not found"}]},{"method":"POST","type":"Card","nickname":"postCard","summary":"Create a new Card","notes":"Creates a new Card in the Stream.<br> <br> <p>The payload consists of the properties to be saved in the card. You may include any properties in it, except any property starting with double underscore ('__') or any in the following list (which are reserved for internal use):</p> <ul> <li>'_id', 'id', 'attachments', 'cardId', 'commentCount', 'comments', 'createdAt', 'createdBy', 'deletedAt', 'description', 'displayAt', 'fullText', 'groupId', 'isDeleted', 'location', 'postAt', 'streamId', 'streamPosition', 'tags', 'title', 'updatedAt', 'urls', 'version', 'chatData', 'eventData', 'dislikes', 'likes', 'traits', 'history', 'likeData'</li> </ul> <p>Non-reserved properties may only be assigned 1) primitive types, 2) arrays containing primitive types, or 3) an array containing a combination of 1) and 2). Storage of arbitrary object structures is only allowed in a property named 'json'.</p> <p>All non-reserved properties except 'json' are indexed and can be used in query expressions when retrieving cards from a stream.</p> <p>The property 'attachments' must conform to the type defined in this spec.</p> ","parameters":[{"name":"card","description":"The Card JSON object.","required":true,"type":"POST_Card","paramType":"body"},{"name":"streamId","description":"The ID of the Stream to post the Card to.","required":true,"type":"string","paramType":"path"},{"name":"X-Cardstreams-AppId","description":"The generated Application ID","type":"string","threescale_name":"app_ids","paramType":"header","required":false},{"name":"X-Cardstreams-AppKey","description":"The generated Application Key","threescale_name":"app_keys","type":"string","paramType":"header","required":false},{"name":"Authorization","description":"Authorization bearer token for access","type":"string","paramType":"header","required":false}],"responseMessages":[{"code":200,"message":"OK","responseModel":"Card"},{"code":404,"message":"Stream not found"}]}]},{"path":"/v1/streams/{streamId}/cards/{cardId}","operations":[{"method":"GET","type":"Card","nickname":"getCard","summary":"Get a Card","notes":"Returns a Card for the given Stream.<br><br> <strong>Developer mode:</strong> allowed <br> <strong>End-user mode:</strong> allowed","parameters":[{"name":"streamId","description":"The ID of the Stream to which the Card belongs.","required":true,"type":"string","paramType":"path"},{"name":"cardId","description":"The ID of the Card to get.","required":true,"type":"string","paramType":"path"},{"name":"media_urls","description":"Provide active URLs that provide access to any files attached to the Card. The time the provided URLs remain active is specified by the <code>urls_ttl</code> parameter. Disabling this may improve the request latency of the operation.","type":"boolean","defaultValue":"true","paramType":"query"},{"name":"preview_urls","description":"Provide active URLs that provide access to any document previews of files attached to the Card. The time the provided URLs remain active is specified by the <code>urls_ttl</code> parameter. Disabling this may improve the request latency of the operation.","type":"boolean","defaultValue":"true","paramType":"query"},{"name":"thumb_urls","description":"Provide active URLs that provide access to any thumbnail images of files attached to the Card. The time the provided URLs remain active is specified by the <code>urls_ttl</code> parameter. Disabling this may improve the request latency of the operation.","type":"boolean","defaultValue":"true","paramType":"query"},{"name":"urls_ttl","description":"Time in seconds that the URLs remain active for accessing attached files or their representations. Once this timeout expires, attempts to access such URLs will result in 403 status responses","type":"integer","format":"int32","defaultValue":300,"paramType":"query"},{"name":"X-Cardstreams-AppId","description":"The generated Application ID","type":"string","threescale_name":"app_ids","paramType":"header","required":false},{"name":"X-Cardstreams-AppKey","description":"The generated Application Key","threescale_name":"app_keys","type":"string","paramType":"header","required":false},{"name":"Authorization","description":"Authorization bearer token for access","type":"string","paramType":"header","required":false}],"responseMessages":[{"code":200,"message":"OK","responseModel":"Card"},{"code":404,"message":"Stream or Card not found"}]},{"method":"PATCH","type":"Card","nickname":"updateCard","summary":"Update a Card","notes":"Updates a Card <br> <p>The payload consists of the properties to be saved in the card. You may include any properties in it, except any property starting with double underscore ('__') or any in the following list (which are reserved for internal use):</p> <ul> <li>'_id', 'id', 'attachments', 'cardId', 'commentCount', 'comments', 'createdAt', 'createdBy', 'deletedAt', 'description', 'displayAt', 'fullText', 'groupId', 'isDeleted', 'location', 'postAt', 'streamId', 'streamPosition', 'tags', 'title', 'updatedAt', 'urls', 'version', 'chatData', 'eventData', 'dislikes', 'likes', 'traits', 'history', 'likeData'</li> </ul> <p>Non-reserved properties may only be assigned 1) primitive types, 2) arrays containing primitive types, or 3) an array containing a combination of 1) and 2). Storage of arbitrary object structures is only allowed in a property named 'json'.</p> <p>All non-reserved properties except 'json' are indexed and can be used in query expressions when retrieving cards from a stream.</p> <p>The property 'attachments' must conform to the type defined in this spec.</p> ","parameters":[{"name":"updates","description":"JSON object with updates to the card","required":true,"type":"PATCH_Card","paramType":"body"},{"name":"streamId","description":"The ID of the Stream to which the Card to update belongs","required":true,"type":"string","paramType":"path"},{"name":"cardId","description":"The ID of the Card to update","required":true,"type":"string","paramType":"path"},{"name":"X-Cardstreams-AppId","description":"The generated Application ID","type":"string","threescale_name":"app_ids","paramType":"header","required":false},{"name":"X-Cardstreams-AppKey","description":"The generated Application Key","threescale_name":"app_keys","type":"string","paramType":"header","required":false},{"name":"Authorization","description":"Authorization bearer token for access","type":"string","paramType":"header","required":false}],"responseMessages":[{"code":200,"message":"OK","responseModel":"Card"},{"code":404,"message":"Stream or Card not found"}]},{"method":"DELETE","nickname":"deleteCard","summary":"Delete a Card","notes":"Deletes a Card from the Stream.","parameters":[{"name":"streamId","description":"The ID of the Stream to delete the Card from.","required":true,"type":"string","paramType":"path"},{"name":"cardId","description":"The ID of the Card to delete.","required":true,"type":"string","paramType":"path"},{"name":"X-Cardstreams-AppId","description":"The generated Application ID","type":"string","threescale_name":"app_ids","paramType":"header","required":false},{"name":"X-Cardstreams-AppKey","description":"The generated Application Key","threescale_name":"app_keys","type":"string","paramType":"header","required":false},{"name":"Authorization","description":"Authorization bearer token for access","type":"string","paramType":"header","required":false}],"responseMessages":[{"code":200,"message":"OK"},{"code":404,"message":"Stream or Card not found"}]}]},{"path":"/v1/streams/{streamId}/cards/{cardId}/attachments","operations":[{"method":"POST","type":"Card","nickname":"addAttachment","summary":"Add Attachment to Card","notes":"Returns the Card  to which the attachment was added.","parameters":[{"name":"streamId","description":"The ID of the Stream to which the Card belongs.","required":true,"type":"string","paramType":"path"},{"name":"cardId","description":"The ID of the Card to add the Attachment to.","required":true,"type":"string","paramType":"path"},{"name":"X-Cardstreams-AppId","description":"The generated Application ID","type":"string","threescale_name":"app_ids","paramType":"header","required":false},{"name":"X-Cardstreams-AppKey","description":"The generated Application Key","threescale_name":"app_keys","type":"string","paramType":"header","required":false},{"name":"Authorization","description":"Authorization bearer token for access","type":"string","paramType":"header","required":false},{"name":"Attachment","description":"Attachment to be posted","paramType":"body","type":"POST_Attachment","required":true}],"responseMessages":[{"code":200,"message":"OK","responseModel":"Card"},{"code":404,"message":"Stream or Card not found"}]}]},{"path":"/v1/streams/{streamId}/cards/{cardId}/attachments/{attachId}","operations":[{"method":"DELETE","type":"Card","nickname":"deleteAttachment","summary":"Delete Attachment from Card","notes":"Returns the Card from which the attachment was removed.","parameters":[{"name":"streamId","description":"The ID of the Stream to which the Card belongs.","required":true,"type":"string","paramType":"path"},{"name":"cardId","description":"The ID of the Card to remove the Attachment from.","required":true,"type":"string","paramType":"path"},{"name":"attachId","description":"The ID of the Attachment to remove.","required":true,"type":"string","paramType":"path"},{"name":"X-Cardstreams-AppId","description":"The generated Application ID","type":"string","threescale_name":"app_ids","paramType":"header","required":false},{"name":"X-Cardstreams-AppKey","description":"The generated Application Key","threescale_name":"app_keys","type":"string","paramType":"header","required":false},{"name":"Authorization","description":"Authorization bearer token for access","type":"string","paramType":"header","required":false}],"responseMessages":[{"code":200,"message":"OK","responseModel":"Card"},{"code":404,"message":"Stream, Card or Attachment not found"}]}]},{"path":"/v1/streams/{streamId}/cards/{cardId}/comments","operations":[{"method":"GET","type":"CommentBatch","nickname":"getComments","summary":"Get Card Comments","notes":"Returns the Card Comments.","parameters":[{"name":"streamId","description":"The ID of the Stream to which the Card to get Comments from belongs.","required":true,"type":"string","paramType":"path"},{"name":"cardId","description":"The ID of the Card to get comments from.","required":true,"type":"string","paramType":"path"},{"name":"X-Cardstreams-AppId","description":"The generated Application ID","type":"string","threescale_name":"app_ids","paramType":"header","required":false},{"name":"X-Cardstreams-AppKey","description":"The generated Application Key","threescale_name":"app_keys","type":"string","paramType":"header","required":false},{"name":"Authorization","description":"Authorization bearer token for access","type":"string","paramType":"header","required":false}],"responseMessages":[{"code":200,"message":"OK","responseModel":"CommentBatch"},{"code":404,"message":"Stream or Card not found"}]},{"method":"POST","type":"Comment","nickname":"createComment","summary":"Create Card Comment","notes":"Creates a Comment for given Card.","parameters":[{"name":"comment","description":"The Comment object","required":true,"type":"POST_Comment","paramType":"body"},{"name":"streamId","description":"The ID of the Stream which the Card to comment on belongs to.","required":true,"type":"string","paramType":"path"},{"name":"cardId","description":"The ID of the Card to comment on.","required":true,"type":"string","paramType":"path"},{"name":"X-Cardstreams-AppId","description":"The generated Application ID","type":"string","threescale_name":"app_ids","paramType":"header","required":false},{"name":"X-Cardstreams-AppKey","description":"The generated Application Key","threescale_name":"app_keys","type":"string","paramType":"header","required":false},{"name":"Authorization","description":"Authorization bearer token for access","type":"string","paramType":"header","required":false}],"responseMessages":[{"code":200,"message":"OK","responseModel":"Comment"},{"code":404,"message":"Stream or Card not found"}]}]},{"path":"/v1/streams/{streamId}/cards/{cardId}/comments/{commentId}","operations":[{"method":"GET","type":"Comment","nickname":"getComment","summary":"Return a Card Comment","notes":"Returns a given Comment.","parameters":[{"name":"streamId","description":"The ID of the Stream which the Card to get the Comment from belongs to","required":true,"type":"string","paramType":"path"},{"name":"cardId","description":"The ID of the Card to get the Comment from","required":true,"type":"string","paramType":"path"},{"name":"commentId","description":"The ID of the Comment to retrieve","required":true,"type":"string","paramType":"path"},{"name":"X-Cardstreams-AppId","description":"The generated Application ID","type":"string","threescale_name":"app_ids","paramType":"header","required":false},{"name":"X-Cardstreams-AppKey","description":"The generated Application Key","threescale_name":"app_keys","type":"string","paramType":"header","required":false},{"name":"Authorization","description":"Authorization bearer token for access","type":"string","paramType":"header","required":false}],"responseMessages":[{"code":200,"message":"OK","responseModel":"Comment"},{"code":404,"message":"Stream, Card or Comment not found"}]},{"method":"PATCH","type":"Comment","nickname":"patchComment","summary":"Modify Card Comment","notes":"Modifies a Comment for given Card.","parameters":[{"name":"comment","description":"The Comment update object","required":true,"type":"PATCH_Comment","paramType":"body"},{"name":"streamId","description":"The ID of the Stream which the Card with the Comment to modify belongs to.","required":true,"type":"string","paramType":"path"},{"name":"cardId","description":"The ID of the Card with the Comment to modify.","required":true,"type":"string","paramType":"path"},{"name":"commentId","description":"The ID of the Comment to modify","required":true,"type":"string","paramType":"path"},{"name":"X-Cardstreams-AppId","description":"The generated Application ID","type":"string","threescale_name":"app_ids","paramType":"header","required":false},{"name":"X-Cardstreams-AppKey","description":"The generated Application Key","threescale_name":"app_keys","type":"string","paramType":"header","required":false},{"name":"Authorization","description":"Authorization bearer token for access","type":"string","paramType":"header","required":false}],"responseMessages":[{"code":200,"message":"OK","responseModel":"Comment"},{"code":404,"message":"Stream, Card or Comment not found"}]},{"method":"DELETE","type":"Comment","nickname":"deleteComment","summary":"Delete Card Comment","notes":"Deletes a Comment for given Card.","parameters":[{"name":"streamId","description":"The ID of the Stream which the Card to remove the Comment from belongs to.","required":true,"type":"string","paramType":"path"},{"name":"cardId","description":"The ID of the Card to remove the Comment from","required":true,"type":"string","paramType":"path"},{"name":"commentId","description":"The ID of the Comment to remove","required":true,"type":"string","paramType":"path"},{"name":"X-Cardstreams-AppId","description":"The generated Application ID","type":"string","threescale_name":"app_ids","paramType":"header","required":false},{"name":"X-Cardstreams-AppKey","description":"The generated Application Key","threescale_name":"app_keys","type":"string","paramType":"header","required":false},{"name":"Authorization","description":"Authorization bearer token for access","type":"string","paramType":"header","required":false}],"responseMessages":[{"code":200,"message":"OK"},{"code":404,"message":"Stream, Card or Comment not found"}]}]},{"path":"/v1/events","operations":[{"method":"GET","summary":"Retrieve access token to event channels.","notes":"Returns an access token valid to access the event channels associated to the caller's Streams.<br><br><strong>Developer mode:</strong> allowed <br><strong>End-user mode:</strong> allowed <br>The tokens returned by this call are good for one hour.","type":"EventToken","nickname":"getEventToken","parameters":[{"name":"X-Cardstreams-AppId","description":"The generated Application ID","type":"string","threescale_name":"app_ids","paramType":"header","required":false},{"name":"X-Cardstreams-AppKey","description":"The generated Application Key","threescale_name":"app_keys","type":"string","paramType":"header","required":false},{"name":"Authorization","description":"Authorization bearer token for access","type":"string","paramType":"header","required":false}],"responseMessages":[{"code":200,"message":"OK"}]}]},{"path":"/v1/oauth/token","operations":[{"method":"POST","summary":"Get authentication token","notes":"Standard oauth call for obtaining a token that can be used for authorization in subsequent requests to the API.<br><br><b>Scope specification:</b><br> This consists of a series of space separated scope specifications. Each scope specification can take one of the following formats:<ul> <li>- o;&lt;origin&gt; -- only allow requests coming from specified origin (may be repeated multiple times)<li> <li>- st;&lt;streamid&gt;;&lt;op spec&gt; -- allow requests that affect the Stream with the provided id, and, optionally, conform to the given operation specification. Stream id \u2018*\u2019 is allowed, and grants access to all application\u2019s Streams. Operation specifications can be one of 'read' or 'full' </ul>","type":"oauth_token_res","nickname":"oauthGetToken","parameters":[{"name":"X-Cardstreams-AppId","description":"The generated Application ID","type":"string","threescale_name":"app_ids","paramType":"header","required":true},{"name":"X-Cardstreams-AppKey","description":"The generated Application Key","threescale_name":"app_keys","type":"string","paramType":"header","required":true},{"name":"Content-type","description":"set to application/x-www-form-urlencoded","type":"string","paramType":"header","required":true},{"name":"grant_type","description":"Required as per OAuth protocol, set to 'client_credentials'","type":"string","paramType":"form","required":true},{"name":"scope","description":"Scope of access that should be granted to the token.  ","type":"string","paramType":"form","required":true}]}]}],"models":{"Stream":{"id":"Stream","description":"A Stream object and its metadata","required":["id","name","description","createdAt"],"properties":{"id":{"type":"string","description":"The unique identity of the Stream"},"name":{"type":"string","description":"Descriptive name of the Stream"},"description":{"type":"string","description":"Detailed description of the Stream"},"createdAt":{"type":"string","format":"date-time","description":"Date and time when the Stream was created"}}},"POST_Stream":{"id":"POST_Stream","description":"Object for Stream creation","required":["name"],"properties":{"name":{"type":"string","description":"Descriptive name of the Stream"},"description":{"type":"string","description":"Detailed description of the Stream"}}},"PATCH_Stream":{"id":"PATCH_Stream","description":"Properties that can be updated in a Stream","properties":{"name":{"type":"string","description":"Descriptive name of the Stream"},"description":{"type":"string","description":"Detailed description of the Stream"}}},"CardBatch":{"id":"CardBatch","description":"A batch of Cards","required":["count","cards"],"properties":{"count":{"type":"integer","description":"Number of Cards included in the response"},"cards":{"type":"array","items":{"$ref":"Card"},"description":"Cards included in the response"}}},"Card":{"id":"Card","description":"A Card object and its metadata","required":["id","streamId","title","description","createdAt","createdBy","isDeleted","commentCount","updatedAt"],"properties":{"id":{"type":"string","description":"The unique identity of a Card"},"streamId":{"type":"string","description":"Stream to which this card belongs"},"title":{"type":"string","description":"Card title / summary"},"description":{"type":"string","description":"Card textual contents"},"createdAt":{"type":"string","format":"date-time","description":"Date and time when Card was created"},"updatedAt":{"type":"string","format":"date-time","description":"Date and time when the Card's contents were last modified"},"displayAt":{"type":"integer","format":"int64","description":"Time position where Card should be displayed in the Stream"},"streamPosition":{"type":"integer","format":"int64","description":"Fine-grained position where Card should be displayed in the Stream"},"postAt":{"type":"integer","format":"int64","description":"Assigned time position (milliseconds after epoch) where the Card should appear within the Stream"},"isDeleted":{"type":"boolean","description":"Is the Card absent from the Stream?"},"deletedAt":{"type":"string","format":"date-time","description":"The Stream when this Card was deleted."},"attachments":{"type":"array","items":{"$ref":"Attachment"},"description":"The set of file attachments to the Card."},"commentCount":{"type":"integer","format":"int32","description":"Number of Comments made to the Card"},"comments":{"type":"array","items":{"$ref":"Comment"},"description":"The Comments made to the Card."},"tags":{"type":"array","items":{"type":"string"},"description":"Tags assigned to this card."}}},"POST_Card":{"id":"POST_Card","description":"A Card object as sent in order to create Streams","properties":{"title":{"type":"string","description":"Card title / summary"},"description":{"type":"string","description":"Card textual contents"},"postAt":{"type":"integer","format":"int64","description":"Assigned time position (milliseconds after epoch) where the Card should appear within the Stream"},"attachments":{"type":"array","items":{"$ref":"POST_Attachment"},"description":"The set of file attachments to the Card (only 1 attachment supported at this point)"},"tags":{"type":"array","items":{"type":"string"},"description":"The set of tags to assign to the card"}}},"PATCH_Card":{"id":"POST_Card","description":"Updatable properties in a Card","properties":{"title":{"type":"string","description":"Card title / summary"},"description":{"type":"string","description":"Card textual contents"},"postAt":{"type":"integer","format":"int64","description":"Assigned time position (milliseconds after epoch) where the Card should appear within the Stream"},"attachments":{"type":"array","items":{"$ref":"POST_Attachment"},"description":"The set of file attachments to the Card (only 1 attachment supported at this point)"},"tags":{"type":"array","items":{"type":"string"},"description":"Tags assigned to this card."}}},"CommentBatch":{"id":"CommentBatch","description":"A batch of Comments","required":["count","comments"],"properties":{"count":{"type":"integer","description":"Number of Comments included in the response"},"comments":{"type":"array","items":{"$ref":"Comment"},"description":"Comments included in the response"}}},"Comment":{"id":"Comment","description":"A an object representing a Comment.","required":["id","createdBy","createdAt","content"],"properties":{"id":{"type":"string","description":"Unique identifier of the Comment"},"parentId":{"type":"string","description":"Identifier of another Comment which this Comment is a reply to"},"createdAt":{"type":"string","format":"date-time","description":"The timestamp when this Comment was created."},"content":{"type":"string","description":"The Comment contents"}}},"POST_Comment":{"id":"POST_Comment","description":"A an object representing Comment input data","required":["content"],"properties":{"parentId":{"type":"string","description":"Identifier of another Comment which this Comment is a reply to"},"content":{"type":"string","description":"The Comment textual contents"}}},"PATCH_Comment":{"id":"POST_Comment","description":"A an object representing Comment input data","required":["content"],"properties":{"content":{"type":"string","description":"The Comment textual contents"}}},"Attachment":{"id":"Attachment","description":"An Attachment object","required":["id","createdBy","originalUrl","metadata","control"],"properties":{"id":{"type":"string","description":"The unique id of the Attachment"},"createdBy":{"type":"string","description":"The unique id of the user who created this attachment."},"originalUrl":{"type":"string","description":"The URL from which the Attachment was originally fetched and embedded into the card"},"metadata":{"type":"AttachmentMetadata","description":"Metadata about the Attachment file"},"control":{"type":"AttachmentControlData","description":"Control data about the background process that embeds files into the Card"}}},"AttachmentMetadata":{"id":"AttachmentMetadata","description":"Metadata about an Attachment file","required":["fileName"],"properties":{"fileName":{"type":"string","description":"Name of the attached file"},"mimeType":{"type":"string","description":"MIME type of the attached file"},"fileSize":{"type":"string","description":"Size (in bytes) of the attached file"}}},"AttachmentControlData":{"id":"AttachmentControlData","description":"Control data about the background process that embeds files into the Card","required":["status"],"properties":{"status":{"type":"string","description":"Status of the process that embeds an Attachment to the card","enum":["new","processed"]},"errors":{"type":"array","items":{"type":"string"},"description":"Summary of errors occurred during the embedding process"}}},"POST_Attachment":{"id":"POST_Attachment","description":"Submitted attachment object","required":["filename","sourceUrl"],"properties":{"filename":{"type":"string","description":"File name of the attachment within the card"},"mimeType":{"type":"string","description":"MIME type of the attached file"},"sourceUrl":{"type":"string","description":"URL where the contents of the attachment are accessible"}}},"Tag":{"id":"Tag","description":"A Tag object","properties":{"content":{"type":"string","description":"The tag contents"}}},"EventToken":{"id":"EvenToken","description":"Response to an event token request","properties":{"token":{"type":"string","description":"The token that can be sent to the push service to subscribe to relevant event channels"}}},"oauth_token_res":{"id":"oauth_token_res","description":"Response to a token generation request","properties":{"access_token":{"type":"string","description":"The access token to be passed in subsequent "},"expires_in":{"type":"integer","format":"int32","description":"Seconds after which the token stops being valid"},"token_type":{"type":"string","description":"Property required by OAUth standard, always set to the value 'bearer'"}}}},"__notifications":[]}