shortcut_client_ruby 0.0.2

data/docs/StoryComment.md

@@ -0,0 +1,20 @@
+# Shortcut::StoryComment
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**app_url** | **String** | The Shortcut application url for the Comment. | 
+**entity_type** | **String** | A string description of this resource. | 
+**story_id** | **Integer** | The ID of the Story on which the Comment appears. | 
+**mention_ids** | **Array<String>** | Deprecated: use member_mention_ids. | 
+**author_id** | **String** | The unique ID of the Member who is the Comment's author. | 
+**member_mention_ids** | **Array<String>** | The unique IDs of the Member who are mentioned in the Comment. | 
+**updated_at** | **DateTime** | The time/date when the Comment was updated. | 
+**group_mention_ids** | **Array<String>** | The unique IDs of the Group who are mentioned in the Comment. | 
+**external_id** | **String** | This field can be set to another unique ID. In the case that the Comment has been imported from another tool, the ID in the other tool can be indicated here. | 
+**id** | **Integer** | The unique ID of the Comment. | 
+**position** | **Integer** | The Comments numerical position in the list from oldest to newest. | 
+**reactions** | [**Array<StoryReaction>**](StoryReaction.md) | A set of Reactions to this Comment. | 
+**created_at** | **DateTime** | The time/date when the Comment was created. | 
+**text** | **String** | The text of the Comment. | 
+

data/docs/StoryContents.md

@@ -0,0 +1,25 @@
+# Shortcut::StoryContents
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**description** | **String** | The description of the story. | [optional] 
+**entity_type** | **String** | A string description of this resource. | [optional] 
+**labels** | [**Array<LabelSlim>**](LabelSlim.md) | An array of labels attached to the story. | [optional] 
+**story_type** | **String** | The type of story (feature, bug, chore). | [optional] 
+**linked_files** | [**Array<LinkedFile>**](LinkedFile.md) | An array of linked files attached to the story. | [optional] 
+**name** | **String** | The name of the story. | [optional] 
+**epic_id** | **Integer** | The ID of the epic the story belongs to. | [optional] 
+**external_links** | **Array<String>** | An array of external links connected to the story. | [optional] 
+**iteration_id** | **Integer** | The ID of the iteration the story belongs to. | [optional] 
+**tasks** | [**Array<StoryContentsTask>**](StoryContentsTask.md) | An array of tasks connected to the story. | [optional] 
+**label_ids** | **Array<Integer>** | An array of label ids attached to the story. | [optional] 
+**group_id** | **String** | The ID of the group to which the story is assigned. | [optional] 
+**workflow_state_id** | **Integer** | The ID of the workflow state the story is currently in. | [optional] 
+**follower_ids** | **Array<String>** | An array of UUIDs for any Members listed as Followers. | [optional] 
+**owner_ids** | **Array<String>** | An array of UUIDs of the owners of this story. | [optional] 
+**estimate** | **Integer** | The numeric point estimate of the story. Can also be null, which means unestimated. | [optional] 
+**files** | [**Array<UploadedFile>**](UploadedFile.md) | An array of files attached to the story. | [optional] 
+**project_id** | **Integer** | The ID of the project the story belongs to. | [optional] 
+**deadline** | **DateTime** | The due date of the story. | [optional] 
+

data/docs/StoryContentsTask.md

@@ -0,0 +1,11 @@
+# Shortcut::StoryContentsTask
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**description** | **String** | Full text of the Task. | 
+**position** | **Integer** | The number corresponding to the Task's position within a list of Tasks on a Story. | [optional] 
+**complete** | **BOOLEAN** | True/false boolean indicating whether the Task has been completed. | [optional] 
+**owner_ids** | **Array<String>** | An array of UUIDs of the Owners of this Task. | [optional] 
+**external_id** | **String** | This field can be set to another unique ID. In the case that the Task has been imported from another tool, the ID in the other tool can be indicated here. | [optional] 
+

data/docs/StoryHistoryChangeAddsRemovesInt.md

@@ -0,0 +1,8 @@
+# Shortcut::StoryHistoryChangeAddsRemovesInt
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**adds** | **Array<Integer>** | The values that have been added. | [optional] 
+**removes** | **Array<Integer>** | The values that have been removed | [optional] 
+

data/docs/StoryHistoryChangeAddsRemovesUuid.md

@@ -0,0 +1,8 @@
+# Shortcut::StoryHistoryChangeAddsRemovesUuid
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**adds** | **Array<String>** | The values that have been added. | [optional] 
+**removes** | **Array<String>** | The values that have been removed | [optional] 
+

data/docs/StoryHistoryChangeOldNewBool.md

@@ -0,0 +1,8 @@
+# Shortcut::StoryHistoryChangeOldNewBool
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**old** | **BOOLEAN** | The old value. | [optional] 
+**new** | **BOOLEAN** | The new value. | [optional] 
+

data/docs/StoryHistoryChangeOldNewInt.md

@@ -0,0 +1,8 @@
+# Shortcut::StoryHistoryChangeOldNewInt
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**old** | **Integer** | The old value. | [optional] 
+**new** | **Integer** | The new value. | [optional] 
+

data/docs/StoryHistoryChangeOldNewStr.md

@@ -0,0 +1,8 @@
+# Shortcut::StoryHistoryChangeOldNewStr
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**old** | **String** | The old value. | [optional] 
+**new** | **String** | The new value. | [optional] 
+

data/docs/StoryHistoryChangeOldNewUuid.md

@@ -0,0 +1,8 @@
+# Shortcut::StoryHistoryChangeOldNewUuid
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**old** | **String** | The old value. | [optional] 
+**new** | **String** | The new value. | [optional] 
+

data/docs/StoryLink.md

@@ -0,0 +1,14 @@
+# Shortcut::StoryLink
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**entity_type** | **String** | A string description of this resource. | 
+**id** | **Integer** | The unique identifier of the Story Link. | 
+**subject_id** | **Integer** | The ID of the subject Story. | 
+**subject_workflow_state_id** | **Integer** | The workflow state of the \"subject\" story. | 
+**verb** | **String** | How the subject Story acts on the object Story. This can be \"blocks\", \"duplicates\", or \"relates to\". | 
+**object_id** | **Integer** | The ID of the object Story. | 
+**created_at** | **DateTime** | The time/date when the Story Link was created. | 
+**updated_at** | **DateTime** | The time/date when the Story Link was last updated. | 
+

data/docs/StoryReaction.md

@@ -0,0 +1,8 @@
+# Shortcut::StoryReaction
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**emoji** | **String** | Emoji text of the reaction. | 
+**permission_ids** | **Array<String>** | Permissions who have reacted with this. | 
+

data/docs/StorySearchResults.md

@@ -0,0 +1,10 @@
+# Shortcut::StorySearchResults
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total** | **Integer** | The total number of matches for the search query. The first 1000 matches can be paged through via the API. | 
+**data** | [**Array<Story>**](Story.md) | A list of search results. | 
+**_next** | **String** | The URL path and query string for the next page of search results. | 
+**cursors** | **Array<String>** |  | [optional] 
+

data/docs/StorySlim.md

@@ -0,0 +1,54 @@
+# Shortcut::StorySlim
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**app_url** | **String** | The Shortcut application url for the Story. | 
+**description** | **String** | The description of the Story. | [optional] 
+**archived** | **BOOLEAN** | True if the story has been archived or not. | 
+**started** | **BOOLEAN** | A true/false boolean indicating if the Story has been started. | 
+**story_links** | [**Array<TypedStoryLink>**](TypedStoryLink.md) | An array of story links attached to the Story. | 
+**entity_type** | **String** | A string description of this resource. | 
+**labels** | [**Array<LabelSlim>**](LabelSlim.md) | An array of labels attached to the story. | 
+**task_ids** | **Array<Integer>** | An array of IDs of Tasks attached to the story. | 
+**mention_ids** | **Array<String>** | Deprecated: use member_mention_ids. | 
+**member_mention_ids** | **Array<String>** | An array of Member IDs that have been mentioned in the Story description. | 
+**story_type** | **String** | The type of story (feature, bug, chore). | 
+**file_ids** | **Array<Integer>** | An array of IDs of Files attached to the story. | 
+**num_tasks_completed** | **Integer** | The number of tasks on the story which are complete. | 
+**workflow_id** | **Integer** | The ID of the workflow the story belongs to. | 
+**completed_at_override** | **DateTime** | A manual override for the time/date the Story was completed. | 
+**started_at** | **DateTime** | The time/date the Story was started. | 
+**completed_at** | **DateTime** | The time/date the Story was completed. | 
+**name** | **String** | The name of the story. | 
+**completed** | **BOOLEAN** | A true/false boolean indicating if the Story has been completed. | 
+**blocker** | **BOOLEAN** | A true/false boolean indicating if the Story is currently a blocker of another story. | 
+**epic_id** | **Integer** | The ID of the epic the story belongs to. | 
+**story_template_id** | **String** | The ID of the story template used to create this story, or null if not created using a template. | 
+**external_links** | **Array<String>** | An array of external links (strings) associated with a Story | 
+**previous_iteration_ids** | **Array<Integer>** | The IDs of the iteration the story belongs to. | 
+**requested_by_id** | **String** | The ID of the Member that requested the story. | 
+**iteration_id** | **Integer** | The ID of the iteration the story belongs to. | 
+**label_ids** | **Array<Integer>** | An array of label ids attached to the story. | 
+**started_at_override** | **DateTime** | A manual override for the time/date the Story was started. | 
+**group_id** | **String** | The ID of the group associated with the story. | 
+**workflow_state_id** | **Integer** | The ID of the workflow state the story is currently in. | 
+**updated_at** | **DateTime** | The time/date the Story was updated. | 
+**group_mention_ids** | **Array<String>** | An array of Group IDs that have been mentioned in the Story description. | 
+**follower_ids** | **Array<String>** | An array of UUIDs for any Members listed as Followers. | 
+**owner_ids** | **Array<String>** | An array of UUIDs of the owners of this story. | 
+**external_id** | **String** | This field can be set to another unique ID. In the case that the Story has been imported from another tool, the ID in the other tool can be indicated here. | 
+**id** | **Integer** | The unique ID of the Story. | 
+**lead_time** | **Integer** | The lead time (in seconds) of this story when complete. | [optional] 
+**estimate** | **Integer** | The numeric point estimate of the story. Can also be null, which means unestimated. | 
+**position** | **Integer** | A number representing the position of the story in relation to every other story in the current project. | 
+**blocked** | **BOOLEAN** | A true/false boolean indicating if the Story is currently blocked. | 
+**project_id** | **Integer** | The ID of the project the story belongs to. | 
+**linked_file_ids** | **Array<Integer>** | An array of IDs of LinkedFiles attached to the story. | 
+**deadline** | **DateTime** | The due date of the story. | 
+**stats** | [**StoryStats**](StoryStats.md) |  | 
+**comment_ids** | **Array<Integer>** | An array of IDs of Comments attached to the story. | 
+**cycle_time** | **Integer** | The cycle time (in seconds) of this story when complete. | [optional] 
+**created_at** | **DateTime** | The time/date the Story was created. | 
+**moved_at** | **DateTime** | The time/date the Story was last changed workflow-state. | 
+

data/docs/StoryStats.md

@@ -0,0 +1,7 @@
+# Shortcut::StoryStats
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**num_related_documents** | **Integer** | The number of documents related to this Story. | 
+

data/docs/Task.md

@@ -0,0 +1,20 @@
+# Shortcut::Task
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**description** | **String** | Full text of the Task. | 
+**entity_type** | **String** | A string description of this resource. | 
+**story_id** | **Integer** | The unique identifier of the parent Story. | 
+**mention_ids** | **Array<String>** | Deprecated: use member_mention_ids. | 
+**member_mention_ids** | **Array<String>** | An array of UUIDs of Members mentioned in this Task. | 
+**completed_at** | **DateTime** | The time/date the Task was completed. | 
+**updated_at** | **DateTime** | The time/date the Task was updated. | 
+**group_mention_ids** | **Array<String>** | An array of UUIDs of Groups mentioned in this Task. | 
+**owner_ids** | **Array<String>** | An array of UUIDs of the Owners of this Task. | 
+**external_id** | **String** | This field can be set to another unique ID. In the case that the Task has been imported from another tool, the ID in the other tool can be indicated here. | 
+**id** | **Integer** | The unique ID of the Task. | 
+**position** | **Integer** | The number corresponding to the Task's position within a list of Tasks on a Story. | 
+**complete** | **BOOLEAN** | True/false boolean indicating whether the Task has been completed. | 
+**created_at** | **DateTime** | The time/date the Task was created. | 
+

data/docs/ThreadedComment.md

@@ -0,0 +1,19 @@
+# Shortcut::ThreadedComment
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**app_url** | **String** | The Shortcut application url for the Comment. | 
+**entity_type** | **String** | A string description of this resource. | 
+**deleted** | **BOOLEAN** | True/false boolean indicating whether the Comment is deleted. | 
+**mention_ids** | **Array<String>** | Deprecated: use member_mention_ids. | 
+**author_id** | **String** | The unique ID of the Member that authored the Comment. | 
+**member_mention_ids** | **Array<String>** | An array of Member IDs that have been mentioned in this Comment. | 
+**comments** | [**Array<ThreadedComment>**](ThreadedComment.md) | A nested array of threaded comments. | 
+**updated_at** | **DateTime** | The time/date the Comment was updated. | 
+**group_mention_ids** | **Array<String>** | An array of Group IDs that have been mentioned in this Comment. | 
+**external_id** | **String** | This field can be set to another unique ID. In the case that the Comment has been imported from another tool, the ID in the other tool can be indicated here. | 
+**id** | **Integer** | The unique ID of the Comment. | 
+**created_at** | **DateTime** | The time/date the Comment was created. | 
+**text** | **String** | The text of the Comment. | 
+

data/docs/TypedStoryLink.md

@@ -0,0 +1,15 @@
+# Shortcut::TypedStoryLink
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**entity_type** | **String** | A string description of this resource. | 
+**object_id** | **Integer** | The ID of the object Story. | 
+**verb** | **String** | How the subject Story acts on the object Story. This can be \"blocks\", \"duplicates\", or \"relates to\". | 
+**type** | **String** | This indicates whether the Story is the subject or object in the Story Link. | 
+**updated_at** | **DateTime** | The time/date when the Story Link was last updated. | 
+**id** | **Integer** | The unique identifier of the Story Link. | 
+**subject_id** | **Integer** | The ID of the subject Story. | 
+**subject_workflow_state_id** | **Integer** | The workflow state of the \"subject\" story. | 
+**created_at** | **DateTime** | The time/date when the Story Link was created. | 
+

data/docs/UnusableEntitlementError.md

@@ -0,0 +1,9 @@
+# Shortcut::UnusableEntitlementError
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**reason_tag** | **String** | The tag for violating an entitlement action. | 
+**entitlement_tag** | **String** | Short tag describing the unusable entitlement action taken by the user. | 
+**message** | **String** | Message displayed to the user on why their action failed. | 
+

data/docs/UpdateCategory.md

@@ -0,0 +1,9 @@
+# Shortcut::UpdateCategory
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The new name of the Category. | [optional] 
+**color** | **String** | The hex color to be displayed with the Category (for example, \"#ff0000\"). | [optional] 
+**archived** | **BOOLEAN** | A true/false boolean indicating if the Category has been archived. | [optional] 
+

data/docs/UpdateComment.md

@@ -0,0 +1,7 @@
+# Shortcut::UpdateComment
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**text** | **String** | The updated comment text. | 
+

data/docs/UpdateEntityTemplate.md

@@ -0,0 +1,8 @@
+# Shortcut::UpdateEntityTemplate
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The updated template name. | [optional] 
+**story_contents** | [**UpdateStoryContents**](UpdateStoryContents.md) |  | [optional] 
+

data/docs/UpdateEpic.md

@@ -0,0 +1,23 @@
+# Shortcut::UpdateEpic
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**description** | **String** | The Epic's description. | [optional] 
+**archived** | **BOOLEAN** | A true/false boolean indicating whether the Epic is in archived state. | [optional] 
+**labels** | [**Array<CreateLabelParams>**](CreateLabelParams.md) | An array of Labels attached to the Epic. | [optional] 
+**completed_at_override** | **DateTime** | A manual override for the time/date the Epic was completed. | [optional] 
+**name** | **String** | The Epic's name. | [optional] 
+**planned_start_date** | **DateTime** | The Epic's planned start date. | [optional] 
+**state** | **String** | `Deprecated` The Epic's state (to do, in progress, or done); will be ignored when `epic_state_id` is set. | [optional] 
+**milestone_id** | **Integer** | The ID of the Milestone this Epic is related to. | [optional] 
+**requested_by_id** | **String** | The ID of the member that requested the epic. | [optional] 
+**epic_state_id** | **Integer** | The ID of the Epic State. | [optional] 
+**started_at_override** | **DateTime** | A manual override for the time/date the Epic was started. | [optional] 
+**group_id** | **String** | The ID of the group to associate with the epic. | [optional] 
+**follower_ids** | **Array<String>** | An array of UUIDs for any Members you want to add as Followers on this Epic. | [optional] 
+**owner_ids** | **Array<String>** | An array of UUIDs for any members you want to add as Owners on this Epic. | [optional] 
+**before_id** | **Integer** | The ID of the Epic we want to move this Epic before. | [optional] 
+**after_id** | **Integer** | The ID of the Epic we want to move this Epic after. | [optional] 
+**deadline** | **DateTime** | The Epic's deadline. | [optional] 
+

data/docs/UpdateFile.md

@@ -0,0 +1,12 @@
+# Shortcut::UpdateFile
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**description** | **String** | The description of the file. | [optional] 
+**created_at** | **DateTime** | The time/date that the file was uploaded. | [optional] 
+**updated_at** | **DateTime** | The time/date that the file was last updated. | [optional] 
+**name** | **String** | The name of the file. | [optional] 
+**uploader_id** | **String** | The unique ID assigned to the Member who uploaded the file to Shortcut. | [optional] 
+**external_id** | **String** | An additional ID that you may wish to assign to the file. | [optional] 
+

data/docs/UpdateGroup.md

@@ -0,0 +1,15 @@
+# Shortcut::UpdateGroup
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**description** | **String** | The description of this Group. | [optional] 
+**archived** | **BOOLEAN** | Whether or not this Group is archived. | [optional] 
+**color** | **String** | The color you wish to use for the Group in the system. | [optional] 
+**display_icon_id** | **String** | The Icon id for the avatar of this Group. | [optional] 
+**mention_name** | **String** | The mention name of this Group. | [optional] 
+**name** | **String** | The name of this Group. | [optional] 
+**color_key** | **String** | The color key you wish to use for the Group in the system. | [optional] 
+**member_ids** | **Array<String>** | The Member ids to add to this Group. | [optional] 
+**workflow_ids** | **Array<Integer>** | The Workflow ids to add to the Group. | [optional] 
+

data/docs/UpdateIteration.md

@@ -0,0 +1,13 @@
+# Shortcut::UpdateIteration
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**follower_ids** | **Array<String>** | An array of UUIDs for any Members you want to add as Followers. | [optional] 
+**group_ids** | **Array<String>** | An array of UUIDs for any Groups you want to add as Followers. Currently, only one Group association is presented in our web UI. | [optional] 
+**labels** | [**Array<CreateLabelParams>**](CreateLabelParams.md) | An array of Labels attached to the Iteration. | [optional] 
+**description** | **String** | The description of the Iteration. | [optional] 
+**name** | **String** | The name of this Iteration | [optional] 
+**start_date** | **String** | The date this Iteration begins, e.g. 2019-07-01 | [optional] 
+**end_date** | **String** | The date this Iteration ends, e.g. 2019-07-05. | [optional] 
+

data/docs/UpdateLabel.md

@@ -0,0 +1,10 @@
+# Shortcut::UpdateLabel
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The new name of the label. | [optional] 
+**description** | **String** | The new description of the label. | [optional] 
+**color** | **String** | The hex color to be displayed with the Label (for example, \"#ff0000\"). | [optional] 
+**archived** | **BOOLEAN** | A true/false boolean indicating if the Label has been archived. | [optional] 
+

data/docs/UpdateLinkedFile.md

@@ -0,0 +1,14 @@
+# Shortcut::UpdateLinkedFile
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**description** | **String** | The description of the file. | [optional] 
+**story_id** | **Integer** | The ID of the linked story. | [optional] 
+**name** | **String** | The name of the file. | [optional] 
+**thumbnail_url** | **String** | The URL of the thumbnail, if the integration provided it. | [optional] 
+**type** | **String** | The integration type of the file (e.g. google, dropbox, box). | [optional] 
+**size** | **Integer** | The filesize, if the integration provided it. | [optional] 
+**uploader_id** | **String** | The UUID of the member that uploaded the file. | [optional] 
+**url** | **String** | The URL of linked file. | [optional] 
+

data/docs/UpdateMilestone.md

@@ -0,0 +1,14 @@
+# Shortcut::UpdateMilestone
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**description** | **String** | The Milestone's description. | [optional] 
+**completed_at_override** | **DateTime** | A manual override for the time/date the Milestone was completed. | [optional] 
+**name** | **String** | The name of the Milestone. | [optional] 
+**state** | **String** | The workflow state that the Milestone is in. | [optional] 
+**started_at_override** | **DateTime** | A manual override for the time/date the Milestone was started. | [optional] 
+**categories** | [**Array<CreateCategoryParams>**](CreateCategoryParams.md) | An array of IDs of Categories attached to the Milestone. | [optional] 
+**before_id** | **Integer** | The ID of the Milestone we want to move this Milestone before. | [optional] 
+**after_id** | **Integer** | The ID of the Milestone we want to move this Milestone after. | [optional] 
+

data/docs/UpdateProject.md

@@ -0,0 +1,15 @@
+# Shortcut::UpdateProject
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**description** | **String** | The Project's description. | [optional] 
+**archived** | **BOOLEAN** | A true/false boolean indicating whether the Story is in archived state. | [optional] 
+**days_to_thermometer** | **Integer** | The number of days before the thermometer appears in the Story summary. | [optional] 
+**color** | **String** | The color that represents the Project in the UI. | [optional] 
+**name** | **String** | The Project's name. | [optional] 
+**follower_ids** | **Array<String>** | An array of UUIDs for any Members you want to add as Followers. | [optional] 
+**show_thermometer** | **BOOLEAN** | Configuration to enable or disable thermometers in the Story summary. | [optional] 
+**team_id** | **Integer** | The ID of the team the project belongs to. | [optional] 
+**abbreviation** | **String** | The Project abbreviation used in Story summaries. Should be kept to 3 characters at most. | [optional] 
+

data/docs/UpdateStories.md

@@ -0,0 +1,27 @@
+# Shortcut::UpdateStories
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**archived** | **BOOLEAN** | If the Stories should be archived or not. | [optional] 
+**story_ids** | **Array<Integer>** | The Ids of the Stories you wish to update. | 
+**story_type** | **String** | The type of story (feature, bug, chore). | [optional] 
+**move_to** | **String** | One of \"first\" or \"last\". This can be used to move the given story to the first or last position in the workflow state. | [optional] 
+**follower_ids_add** | **Array<String>** | The UUIDs of the new followers to be added. | [optional] 
+**epic_id** | **Integer** | The ID of the epic the story belongs to. | [optional] 
+**external_links** | **Array<String>** | An array of External Links associated with this story. | [optional] 
+**follower_ids_remove** | **Array<String>** | The UUIDs of the followers to be removed. | [optional] 
+**requested_by_id** | **String** | The ID of the member that requested the story. | [optional] 
+**iteration_id** | **Integer** | The ID of the iteration the story belongs to. | [optional] 
+**labels_add** | [**Array<CreateLabelParams>**](CreateLabelParams.md) | An array of labels to be added. | [optional] 
+**group_id** | **String** | The Id of the Group the Stories should belong to. | [optional] 
+**workflow_state_id** | **Integer** | The ID of the workflow state to put the stories in. | [optional] 
+**before_id** | **Integer** | The ID of the story that the stories are to be moved before. | [optional] 
+**estimate** | **Integer** | The numeric point estimate of the story. Can also be null, which means unestimated. | [optional] 
+**after_id** | **Integer** | The ID of the story that the stories are to be moved below. | [optional] 
+**owner_ids_remove** | **Array<String>** | The UUIDs of the owners to be removed. | [optional] 
+**project_id** | **Integer** | The ID of the Project the Stories should belong to. | [optional] 
+**labels_remove** | [**Array<CreateLabelParams>**](CreateLabelParams.md) | An array of labels to be removed. | [optional] 
+**deadline** | **DateTime** | The due date of the story. | [optional] 
+**owner_ids_add** | **Array<String>** | The UUIDs of the new owners to be added. | [optional] 
+

data/docs/UpdateStory.md

@@ -0,0 +1,32 @@
+# Shortcut::UpdateStory
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**description** | **String** | The description of the story. | [optional] 
+**archived** | **BOOLEAN** | True if the story is archived, otherwise false. | [optional] 
+**labels** | [**Array<CreateLabelParams>**](CreateLabelParams.md) | An array of labels attached to the story. | [optional] 
+**pull_request_ids** | **Array<Integer>** | An array of IDs of Pull/Merge Requests attached to the story. | [optional] 
+**story_type** | **String** | The type of story (feature, bug, chore). | [optional] 
+**move_to** | **String** | One of \"first\" or \"last\". This can be used to move the given story to the first or last position in the workflow state. | [optional] 
+**file_ids** | **Array<Integer>** | An array of IDs of files attached to the story. | [optional] 
+**completed_at_override** | **DateTime** | A manual override for the time/date the Story was completed. | [optional] 
+**name** | **String** | The title of the story. | [optional] 
+**epic_id** | **Integer** | The ID of the epic the story belongs to. | [optional] 
+**external_links** | **Array<String>** | An array of External Links associated with this story. | [optional] 
+**branch_ids** | **Array<Integer>** | An array of IDs of Branches attached to the story. | [optional] 
+**commit_ids** | **Array<Integer>** | An array of IDs of Commits attached to the story. | [optional] 
+**requested_by_id** | **String** | The ID of the member that requested the story. | [optional] 
+**iteration_id** | **Integer** | The ID of the iteration the story belongs to. | [optional] 
+**started_at_override** | **DateTime** | A manual override for the time/date the Story was started. | [optional] 
+**group_id** | **String** | The ID of the group to associate with this story | [optional] 
+**workflow_state_id** | **Integer** | The ID of the workflow state to put the story in. | [optional] 
+**follower_ids** | **Array<String>** | An array of UUIDs of the followers of this story. | [optional] 
+**owner_ids** | **Array<String>** | An array of UUIDs of the owners of this story. | [optional] 
+**before_id** | **Integer** | The ID of the story we want to move this story before. | [optional] 
+**estimate** | **Integer** | The numeric point estimate of the story. Can also be null, which means unestimated. | [optional] 
+**after_id** | **Integer** | The ID of the story we want to move this story after. | [optional] 
+**project_id** | **Integer** | The ID of the project the story belongs to. | [optional] 
+**linked_file_ids** | **Array<Integer>** | An array of IDs of linked files attached to the story. | [optional] 
+**deadline** | **DateTime** | The due date of the story. | [optional] 
+

data/docs/UpdateStoryComment.md

@@ -0,0 +1,7 @@
+# Shortcut::UpdateStoryComment
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**text** | **String** | The updated comment text. | 
+

data/docs/UpdateStoryContents.md

@@ -0,0 +1,27 @@
+# Shortcut::UpdateStoryContents
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**description** | **String** | The description of the story. | [optional] 
+**entity_type** | **String** | A string description of this resource. | [optional] 
+**labels** | [**Array<CreateLabelParams>**](CreateLabelParams.md) | An array of labels to be populated by the template. | [optional] 
+**story_type** | **String** | The type of story (feature, bug, chore). | [optional] 
+**linked_files** | [**Array<LinkedFile>**](LinkedFile.md) | An array of linked files attached to the story. | [optional] 
+**file_ids** | **Array<Integer>** | An array of the attached file IDs to be populated. | [optional] 
+**name** | **String** | The name of the story. | [optional] 
+**epic_id** | **Integer** | The ID of the epic the to be populated. | [optional] 
+**external_links** | **Array<String>** | An array of external links to be populated. | [optional] 
+**iteration_id** | **Integer** | The ID of the iteration the to be populated. | [optional] 
+**tasks** | [**Array<EntityTemplateTask>**](EntityTemplateTask.md) | An array of tasks to be populated by the template. | [optional] 
+**label_ids** | **Array<Integer>** | An array of label ids attached to the story. | [optional] 
+**group_id** | **String** | The ID of the group to be populated. | [optional] 
+**workflow_state_id** | **Integer** | The ID of the workflow state the story is currently in. | [optional] 
+**follower_ids** | **Array<String>** | An array of UUIDs for any Members listed as Followers. | [optional] 
+**owner_ids** | **Array<String>** | An array of UUIDs of the owners of this story. | [optional] 
+**estimate** | **Integer** | The numeric point estimate to be populated. | [optional] 
+**files** | [**Array<UploadedFile>**](UploadedFile.md) | An array of files attached to the story. | [optional] 
+**project_id** | **Integer** | The ID of the project the story belongs to. | [optional] 
+**linked_file_ids** | **Array<Integer>** | An array of the linked file IDs to be populated. | [optional] 
+**deadline** | **DateTime** | The due date of the story. | [optional] 
+

data/docs/UpdateStoryLink.md

@@ -0,0 +1,9 @@
+# Shortcut::UpdateStoryLink
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**verb** | **String** | The type of link. | [optional] 
+**subject_id** | **Integer** | The ID of the subject Story. | [optional] 
+**object_id** | **Integer** | The ID of the object Story. | [optional] 
+

data/docs/UpdateTask.md

@@ -0,0 +1,11 @@
+# Shortcut::UpdateTask
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**description** | **String** | The Task's description. | [optional] 
+**owner_ids** | **Array<String>** | An array of UUIDs of the owners of this story. | [optional] 
+**complete** | **BOOLEAN** | A true/false boolean indicating whether the task is complete. | [optional] 
+**before_id** | **Integer** | Move task before this task ID. | [optional] 
+**after_id** | **Integer** | Move task after this task ID. | [optional] 
+

data/docs/UploadedFile.md

@@ -0,0 +1,23 @@
+# Shortcut::UploadedFile
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**description** | **String** | The description of the file. | 
+**entity_type** | **String** | A string description of this resource. | 
+**story_ids** | **Array<Integer>** | The unique IDs of the Stories associated with this file. | 
+**mention_ids** | **Array<String>** | Deprecated: use member_mention_ids. | 
+**member_mention_ids** | **Array<String>** | The unique IDs of the Members who are mentioned in the file description. | 
+**name** | **String** | The optional User-specified name of the file. | 
+**thumbnail_url** | **String** | The url where the thumbnail of the file can be found in Shortcut. | 
+**size** | **Integer** | The size of the file. | 
+**uploader_id** | **String** | The unique ID of the Member who uploaded the file. | 
+**content_type** | **String** | Free form string corresponding to a text or image file. | 
+**updated_at** | **DateTime** | The time/date that the file was updated. | 
+**filename** | **String** | The name assigned to the file in Shortcut upon upload. | 
+**group_mention_ids** | **Array<String>** | The unique IDs of the Groups who are mentioned in the file description. | 
+**external_id** | **String** | This field can be set to another unique ID. In the case that the File has been imported from another tool, the ID in the other tool can be indicated here. | 
+**id** | **Integer** | The unique ID for the file. | 
+**url** | **String** | The URL for the file. | 
+**created_at** | **DateTime** | The time/date that the file was created. | 
+

data/docs/V3FilesBody.md

@@ -0,0 +1,11 @@
+# Shortcut::V3FilesBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**story_id** | **Integer** | The story ID that these files will be associated with. | [optional] 
+**file0** | **String** | A file upload. At least one is required. | 
+**file1** | **String** | Optional additional files. | [optional] 
+**file2** | **String** | Optional additional files. | [optional] 
+**file3** | **String** | Optional additional files. | [optional] 
+