shortcut_client_ruby 0.0.2

data/docs/DeleteStories.md

@@ -0,0 +1,7 @@
+# Shortcut::DeleteStories
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**story_ids** | **Array<Integer>** | An array of IDs of Stories to delete. | 
+

data/docs/EntityTemplate.md

@@ -0,0 +1,14 @@
+# Shortcut::EntityTemplate
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**entity_type** | **String** | A string description of this resource. | 
+**id** | **String** | The unique identifier for the entity template. | 
+**created_at** | **DateTime** | The time/date when the entity template was created. | 
+**updated_at** | **DateTime** | The time/date when the entity template was last updated. | 
+**name** | **String** | The template's name. | 
+**author_id** | **String** | The unique ID of the member who created the template. | 
+**last_used_at** | **DateTime** | The last time that someone created an entity using this template. | 
+**story_contents** | [**StoryContents**](StoryContents.md) |  | 
+

data/docs/EntityTemplateTask.md

@@ -0,0 +1,10 @@
+# Shortcut::EntityTemplateTask
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**description** | **String** | The Task description. | 
+**complete** | **BOOLEAN** | True/false boolean indicating whether the Task is completed. Defaults to false. | [optional] 
+**owner_ids** | **Array<String>** | An array of UUIDs for any members you want to add as Owners on this new 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/Epic.md

@@ -0,0 +1,44 @@
+# Shortcut::Epic
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**app_url** | **String** | The Shortcut application url for the Epic. | 
+**description** | **String** | The Epic's description. | 
+**archived** | **BOOLEAN** | True/false boolean that indicates whether the Epic is archived or not. | 
+**started** | **BOOLEAN** | A true/false boolean indicating if the Epic has been started. | 
+**entity_type** | **String** | A string description of this resource. | 
+**labels** | [**Array<LabelSlim>**](LabelSlim.md) | An array of Labels attached to the Epic. | 
+**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 Epic description. | 
+**project_ids** | **Array<Integer>** | The IDs of Projects related to this Epic. | 
+**stories_without_projects** | **Integer** | The number of stories in this epic which are not associated with a project. | 
+**completed_at_override** | **DateTime** | A manual override for the time/date the Epic was completed. | 
+**productboard_plugin_id** | **String** | The ID of the associated productboard integration. | 
+**started_at** | **DateTime** | The time/date the Epic was started. | 
+**completed_at** | **DateTime** | The time/date the Epic was completed. | 
+**name** | **String** | The name of the Epic. | 
+**completed** | **BOOLEAN** | A true/false boolean indicating if the Epic has been completed. | 
+**comments** | [**Array<ThreadedComment>**](ThreadedComment.md) | A nested array of threaded comments. | 
+**productboard_url** | **String** | The URL of the associated productboard feature. | 
+**planned_start_date** | **DateTime** | The Epic's planned start date. | 
+**state** | **String** | `Deprecated` The workflow state that the Epic is in. | 
+**milestone_id** | **Integer** | The ID of the Milestone this Epic is related to. | 
+**requested_by_id** | **String** | The ID of the Member that requested the epic. | 
+**epic_state_id** | **Integer** | The ID of the Epic State. | 
+**label_ids** | **Array<Integer>** | An array of Label ids attached to the Epic. | 
+**started_at_override** | **DateTime** | A manual override for the time/date the Epic was started. | 
+**group_id** | **String** |  | 
+**updated_at** | **DateTime** | The time/date the Epic was updated. | 
+**group_mention_ids** | **Array<String>** | An array of Group IDs that have been mentioned in the Epic description. | 
+**productboard_id** | **String** | The ID of the associated productboard feature. | 
+**follower_ids** | **Array<String>** | An array of UUIDs for any Members you want to add as Followers on this Epic. | 
+**owner_ids** | **Array<String>** | An array of UUIDs for any members you want to add as Owners on this new Epic. | 
+**external_id** | **String** | This field can be set to another unique ID. In the case that the Epic has been imported from another tool, the ID in the other tool can be indicated here. | 
+**id** | **Integer** | The unique ID of the Epic. | 
+**position** | **Integer** | The Epic's relative position in the Epic workflow state. | 
+**productboard_name** | **String** | The name of the associated productboard feature. | 
+**deadline** | **DateTime** | The Epic's deadline. | 
+**stats** | [**EpicStats**](EpicStats.md) |  | 
+**created_at** | **DateTime** | The time/date the Epic was created. | 
+

data/docs/EpicSearchResults.md

@@ -0,0 +1,10 @@
+# Shortcut::EpicSearchResults
+
+## 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<Epic>**](Epic.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/EpicSlim.md

@@ -0,0 +1,43 @@
+# Shortcut::EpicSlim
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**app_url** | **String** | The Shortcut application url for the Epic. | 
+**description** | **String** | The Epic's description. | [optional] 
+**archived** | **BOOLEAN** | True/false boolean that indicates whether the Epic is archived or not. | 
+**started** | **BOOLEAN** | A true/false boolean indicating if the Epic has been started. | 
+**entity_type** | **String** | A string description of this resource. | 
+**labels** | [**Array<LabelSlim>**](LabelSlim.md) | An array of Labels attached to the Epic. | 
+**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 Epic description. | 
+**project_ids** | **Array<Integer>** | The IDs of Projects related to this Epic. | 
+**stories_without_projects** | **Integer** | The number of stories in this epic which are not associated with a project. | 
+**completed_at_override** | **DateTime** | A manual override for the time/date the Epic was completed. | 
+**productboard_plugin_id** | **String** | The ID of the associated productboard integration. | 
+**started_at** | **DateTime** | The time/date the Epic was started. | 
+**completed_at** | **DateTime** | The time/date the Epic was completed. | 
+**name** | **String** | The name of the Epic. | 
+**completed** | **BOOLEAN** | A true/false boolean indicating if the Epic has been completed. | 
+**productboard_url** | **String** | The URL of the associated productboard feature. | 
+**planned_start_date** | **DateTime** | The Epic's planned start date. | 
+**state** | **String** | `Deprecated` The workflow state that the Epic is in. | 
+**milestone_id** | **Integer** | The ID of the Milestone this Epic is related to. | 
+**requested_by_id** | **String** | The ID of the Member that requested the epic. | 
+**epic_state_id** | **Integer** | The ID of the Epic State. | 
+**label_ids** | **Array<Integer>** | An array of Label ids attached to the Epic. | 
+**started_at_override** | **DateTime** | A manual override for the time/date the Epic was started. | 
+**group_id** | **String** |  | 
+**updated_at** | **DateTime** | The time/date the Epic was updated. | 
+**group_mention_ids** | **Array<String>** | An array of Group IDs that have been mentioned in the Epic description. | 
+**productboard_id** | **String** | The ID of the associated productboard feature. | 
+**follower_ids** | **Array<String>** | An array of UUIDs for any Members you want to add as Followers on this Epic. | 
+**owner_ids** | **Array<String>** | An array of UUIDs for any members you want to add as Owners on this new Epic. | 
+**external_id** | **String** | This field can be set to another unique ID. In the case that the Epic has been imported from another tool, the ID in the other tool can be indicated here. | 
+**id** | **Integer** | The unique ID of the Epic. | 
+**position** | **Integer** | The Epic's relative position in the Epic workflow state. | 
+**productboard_name** | **String** | The name of the associated productboard feature. | 
+**deadline** | **DateTime** | The Epic's deadline. | 
+**stats** | [**EpicStats**](EpicStats.md) |  | 
+**created_at** | **DateTime** | The time/date the Epic was created. | 
+

data/docs/EpicState.md

@@ -0,0 +1,15 @@
+# Shortcut::EpicState
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**description** | **String** | The description of what sort of Epics belong in that Epic State. | 
+**entity_type** | **String** | A string description of this resource. | 
+**color** | **String** | The hex color for this Epic State. | [optional] 
+**name** | **String** | The Epic State's name. | 
+**type** | **String** | The type of Epic State (Unstarted, Started, or Done) | 
+**updated_at** | **DateTime** | When the Epic State was last updated. | 
+**id** | **Integer** | The unique ID of the Epic State. | 
+**position** | **Integer** | The position that the Epic State is in, starting with 0 at the left. | 
+**created_at** | **DateTime** | The time/date the Epic State was created. | 
+

data/docs/EpicStats.md

@@ -0,0 +1,19 @@
+# Shortcut::EpicStats
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**num_points_done** | **Integer** | The total number of completed points in this Epic. | 
+**num_related_documents** | **Integer** | The total number of documents associated with this Epic. | 
+**average_cycle_time** | **Integer** | The average cycle time (in seconds) of completed stories in this Epic. | [optional] 
+**num_stories_unstarted** | **Integer** | The total number of unstarted Stories in this Epic. | 
+**num_stories_total** | **Integer** | The total number of Stories in this Epic. | 
+**last_story_update** | **DateTime** | The date of the last update of a Story in this Epic. | 
+**num_points_started** | **Integer** | The total number of started points in this Epic. | 
+**num_points_unstarted** | **Integer** | The total number of unstarted points in this Epic. | 
+**num_stories_started** | **Integer** | The total number of started Stories in this Epic. | 
+**num_stories_unestimated** | **Integer** | The total number of Stories with no point estimate. | 
+**average_lead_time** | **Integer** | The average lead time (in seconds) of completed stories in this Epic. | [optional] 
+**num_points** | **Integer** | The total number of points in this Epic. | 
+**num_stories_done** | **Integer** | The total number of done Stories in this Epic. | 
+

data/docs/EpicWorkflow.md

@@ -0,0 +1,12 @@
+# Shortcut::EpicWorkflow
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**entity_type** | **String** | A string description of this resource. | 
+**id** | **Integer** | The unique ID of the Epic Workflow. | 
+**created_at** | **DateTime** | The date the Epic Workflow was created. | 
+**updated_at** | **DateTime** | The date the Epic Workflow was updated. | 
+**default_epic_state_id** | **Integer** | The unique ID of the default Epic State that new Epics are assigned by default. | 
+**epic_states** | [**Array<EpicState>**](EpicState.md) | A map of the Epic States in this Epic Workflow. | 
+

data/docs/GetEpicStories.md

@@ -0,0 +1,7 @@
+# Shortcut::GetEpicStories
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**includes_description** | **BOOLEAN** | A true/false boolean indicating whether to return Stories with their descriptions. | [optional] 
+

data/docs/GetExternalLinkStoriesParams.md

@@ -0,0 +1,7 @@
+# Shortcut::GetExternalLinkStoriesParams
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**external_link** | **String** | The external link associated with one or more stories. | 
+

data/docs/GetIterationStories.md

@@ -0,0 +1,7 @@
+# Shortcut::GetIterationStories
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**includes_description** | **BOOLEAN** | A true/false boolean indicating whether to return Stories with their descriptions. | [optional] 
+

data/docs/GetLabelStories.md

@@ -0,0 +1,7 @@
+# Shortcut::GetLabelStories
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**includes_description** | **BOOLEAN** | A true/false boolean indicating whether to return Stories with their descriptions. | [optional] 
+

data/docs/GetMember.md

@@ -0,0 +1,7 @@
+# Shortcut::GetMember
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**org_public_id** | **String** | The unique ID of the Organization to limit the lookup to. | [optional] 
+

data/docs/GetProjectStories.md

@@ -0,0 +1,7 @@
+# Shortcut::GetProjectStories
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**includes_description** | **BOOLEAN** | A true/false boolean indicating whether to return Stories with their descriptions. | [optional] 
+

data/docs/Group.md

@@ -0,0 +1,22 @@
+# Shortcut::Group
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**app_url** | **String** | The Shortcut application url for the Group. | 
+**description** | **String** | The description of the Group. | 
+**archived** | **BOOLEAN** | Whether or not the Group is archived. | 
+**entity_type** | **String** | A string description of this resource. | 
+**color** | **String** | The hex color to be displayed with the Group (for example, \"#ff0000\"). | 
+**num_stories_started** | **Integer** | The number of stories assigned to the group which are in a started workflow state. | 
+**mention_name** | **String** | The mention name of the Group. | 
+**name** | **String** | The name of the Group. | 
+**color_key** | **String** | The color key to be displayed with the Group. | 
+**num_stories** | **Integer** | The total number of stories assigned ot the group. | 
+**num_epics_started** | **Integer** | The number of epics assigned to the group which are in the started workflow state. | 
+**id** | **String** | The id of the Group. | 
+**display_icon** | [**Icon**](Icon.md) |  | 
+**member_ids** | **Array<String>** | The Member IDs contain within the Group. | 
+**story_workflow_ids** | **Array<Integer>** | The Workflow IDs which have stories assigned to the group. | 
+**workflow_ids** | **Array<Integer>** | The Workflow IDs contained within the Group. | 
+

data/docs/History.md

@@ -0,0 +1,15 @@
+# Shortcut::History
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**changed_at** | **String** | The date when the change occurred. | 
+**primary_id** | **Integer** | The ID of the primary entity that has changed, if applicable. | [optional] 
+**references** | **Array<Object>** | An array of objects affected by the change. Reference objects provide basic information for the entities reference in the history actions. Some have specific fields, but they always contain an id, entity_type, and a name. | [optional] 
+**actions** | **Array<Object>** | An array of actions that were performed for the change. | 
+**member_id** | **String** | The ID of the member who performed the change. | [optional] 
+**external_id** | **String** | The ID of the webhook that handled the change. | [optional] 
+**id** | **String** | The ID representing the change for the story. | 
+**version** | **String** | The version of the change format. | 
+**webhook_id** | **String** | The ID of the webhook that handled the change. | [optional] 
+

data/docs/HistoryActionBranchCreate.md

@@ -0,0 +1,11 @@
+# Shortcut::HistoryActionBranchCreate
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | The ID of the entity referenced. | 
+**entity_type** | **String** | The type of entity referenced. | 
+**name** | **String** | The name of the VCS Branch that was pushed | 
+**url** | **String** | The URL from the provider of the VCS Branch that was pushed | 
+**action** | **String** | The action of the entity referenced. | 
+

data/docs/HistoryActionBranchMerge.md

@@ -0,0 +1,11 @@
+# Shortcut::HistoryActionBranchMerge
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | The ID of the entity referenced. | 
+**entity_type** | **String** | The type of entity referenced. | 
+**name** | **String** | The name of the VCS Branch that was pushed | 
+**url** | **String** | The URL from the provider of the VCS Branch that was pushed | 
+**action** | **String** | The action of the entity referenced. | 
+

data/docs/HistoryActionBranchPush.md

@@ -0,0 +1,11 @@
+# Shortcut::HistoryActionBranchPush
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | The ID of the entity referenced. | 
+**entity_type** | **String** | The type of entity referenced. | 
+**name** | **String** | The name of the VCS Branch that was pushed | 
+**url** | **String** | The URL from the provider of the VCS Branch that was pushed | 
+**action** | **String** | The action of the entity referenced. | 
+

data/docs/HistoryActionLabelCreate.md

@@ -0,0 +1,11 @@
+# Shortcut::HistoryActionLabelCreate
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | The ID of the entity referenced. | 
+**entity_type** | **String** | The type of entity referenced. | 
+**action** | **String** | The action of the entity referenced. | 
+**app_url** | **String** | The application URL of the Label. | 
+**name** | **String** | The name of the Label. | 
+

data/docs/HistoryActionLabelDelete.md

@@ -0,0 +1,10 @@
+# Shortcut::HistoryActionLabelDelete
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | The ID of the entity referenced. | 
+**entity_type** | **String** | The type of entity referenced. | 
+**action** | **String** | The action of the entity referenced. | 
+**name** | **String** | The name of the Label. | 
+

data/docs/HistoryActionLabelUpdate.md

@@ -0,0 +1,9 @@
+# Shortcut::HistoryActionLabelUpdate
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | The ID of the entity referenced. | 
+**entity_type** | **String** | The type of entity referenced. | 
+**action** | **String** | The action of the entity referenced. | 
+

data/docs/HistoryActionProjectUpdate.md

@@ -0,0 +1,11 @@
+# Shortcut::HistoryActionProjectUpdate
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | The ID of the entity referenced. | 
+**entity_type** | **String** | The type of entity referenced. | 
+**action** | **String** | The action of the entity referenced. | 
+**app_url** | **String** | The application URL of the Project. | 
+**name** | **String** | The name of the Project. | 
+

data/docs/HistoryActionPullRequest.md

@@ -0,0 +1,12 @@
+# Shortcut::HistoryActionPullRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | The ID of the entity referenced. | 
+**entity_type** | **String** | The type of entity referenced. | 
+**action** | **String** | The action of the entity referenced. | 
+**number** | **Integer** | The VCS Repository-specific ID for the Pull Request. | 
+**title** | **String** | The title of the Pull Request. | 
+**url** | **String** | The URL from the provider of the VCS Pull Request. | 
+

data/docs/HistoryActionStoryCommentCreate.md

@@ -0,0 +1,12 @@
+# Shortcut::HistoryActionStoryCommentCreate
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | The ID of the entity referenced. | 
+**entity_type** | **String** | The type of entity referenced. | 
+**action** | **String** | The action of the entity referenced. | 
+**app_url** | **String** | The application URL of the Story Comment. | 
+**text** | **String** | The text of the Story Comment. | 
+**author_id** | **String** | The Member ID of who created the Story Comment. | 
+

data/docs/HistoryActionStoryCreate.md

@@ -0,0 +1,30 @@
+# Shortcut::HistoryActionStoryCreate
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**app_url** | **String** | The application URL of the Story. | 
+**description** | **String** | The description of the Story. | [optional] 
+**started** | **BOOLEAN** | Whether or not the Story has been started. | [optional] 
+**entity_type** | **String** | The type of entity referenced. | 
+**task_ids** | **Array<Integer>** | An array of Task IDs on this Story. | [optional] 
+**story_type** | **String** | The type of Story; either feature, bug, or chore. | 
+**name** | **String** | The name of the Story. | 
+**completed** | **BOOLEAN** | Whether or not the Story is completed. | [optional] 
+**blocker** | **BOOLEAN** | Whether or not the Story is blocking another Story. | [optional] 
+**epic_id** | **Integer** | The Epic ID for this Story. | [optional] 
+**requested_by_id** | **String** | The ID of the Member that requested the Story. | [optional] 
+**iteration_id** | **Integer** | The Iteration ID the Story is in. | [optional] 
+**label_ids** | **Array<Integer>** | An array of Labels IDs attached to the Story. | [optional] 
+**workflow_state_id** | **Integer** | An array of Workflow State IDs attached to the Story. | [optional] 
+**object_story_link_ids** | **Array<Integer>** | An array of Story IDs that are the object of a Story Link relationship. | [optional] 
+**follower_ids** | **Array<String>** | An array of Member IDs for the followers of the Story. | [optional] 
+**owner_ids** | **Array<String>** | An array of Member IDs that are the owners of the Story. | [optional] 
+**id** | **Integer** | The ID of the entity referenced. | 
+**estimate** | **Integer** | The estimate (or point value) for the Story. | [optional] 
+**subject_story_link_ids** | **Array<Integer>** | An array of Story IDs that are the subject of a Story Link relationship. | [optional] 
+**action** | **String** | The action of the entity referenced. | 
+**blocked** | **BOOLEAN** | Whether or not the Story is blocked by another Story. | [optional] 
+**project_id** | **Integer** | The Project ID of the Story is in. | [optional] 
+**deadline** | **String** | The timestamp representing the Story's deadline. | [optional] 
+

data/docs/HistoryActionStoryDelete.md

@@ -0,0 +1,11 @@
+# Shortcut::HistoryActionStoryDelete
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | The ID of the entity referenced. | 
+**entity_type** | **String** | The type of entity referenced. | 
+**action** | **String** | The action of the entity referenced. | 
+**name** | **String** | The name of the Story. | 
+**story_type** | **String** | The type of Story; either feature, bug, or chore. | 
+

data/docs/HistoryActionStoryLinkCreate.md

@@ -0,0 +1,12 @@
+# Shortcut::HistoryActionStoryLinkCreate
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | The ID of the entity referenced. | 
+**entity_type** | **String** | The type of entity referenced. | 
+**action** | **String** | The action of the entity referenced. | 
+**verb** | **String** | The verb describing the link's relationship. | 
+**subject_id** | **Integer** | The Story ID of the subject Story. | 
+**object_id** | **Integer** | The Story ID of the object Story. | 
+

data/docs/HistoryActionStoryLinkDelete.md

@@ -0,0 +1,12 @@
+# Shortcut::HistoryActionStoryLinkDelete
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | The ID of the entity referenced. | 
+**entity_type** | **String** | The type of entity referenced. | 
+**action** | **String** | The action of the entity referenced. | 
+**verb** | **String** | The verb describing the link's relationship. | 
+**subject_id** | **Integer** | The Story ID of the subject Story. | 
+**object_id** | **Integer** | The Story ID of the object Story. | 
+

data/docs/HistoryActionStoryLinkUpdate.md

@@ -0,0 +1,13 @@
+# Shortcut::HistoryActionStoryLinkUpdate
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | The ID of the entity referenced. | 
+**entity_type** | **String** | The type of entity referenced. | 
+**action** | **String** | The action of the entity referenced. | 
+**verb** | **String** | The verb describing the link's relationship. | 
+**subject_id** | **Integer** | The Story ID of the subject Story. | 
+**object_id** | **Integer** | The Story ID of the object Story. | 
+**changes** | [**HistoryChangesStoryLink**](HistoryChangesStoryLink.md) |  | 
+

data/docs/HistoryActionStoryUpdate.md

@@ -0,0 +1,13 @@
+# Shortcut::HistoryActionStoryUpdate
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | The ID of the entity referenced. | 
+**entity_type** | **String** | The type of entity referenced. | 
+**action** | **String** | The action of the entity referenced. | 
+**app_url** | **String** | The application URL of the Story. | 
+**changes** | [**HistoryChangesStory**](HistoryChangesStory.md) |  | [optional] 
+**name** | **String** | The name of the Story. | 
+**story_type** | **String** | The type of Story; either feature, bug, or chore. | 
+

data/docs/HistoryActionTaskCreate.md

@@ -0,0 +1,15 @@
+# Shortcut::HistoryActionTaskCreate
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**description** | **String** | The description of the Task. | 
+**entity_type** | **String** | The type of entity referenced. | 
+**mention_ids** | **Array<String>** | An array of Member IDs that represent who has been mentioned in the Task. | [optional] 
+**group_mention_ids** | **Array<String>** | An array of Groups IDs that represent which have been mentioned in the Task. | [optional] 
+**owner_ids** | **Array<String>** | An array of Member IDs that represent the Task's owners. | [optional] 
+**id** | **Integer** | The ID of the entity referenced. | 
+**action** | **String** | The action of the entity referenced. | 
+**complete** | **BOOLEAN** | Whether or not the Task is complete. | 
+**deadline** | **String** | A timestamp that represent's the Task's deadline. | [optional] 
+

data/docs/HistoryActionTaskDelete.md

@@ -0,0 +1,10 @@
+# Shortcut::HistoryActionTaskDelete
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | The ID of the entity referenced. | 
+**entity_type** | **String** | The type of entity referenced. | 
+**action** | **String** | The action of the entity referenced. | 
+**description** | **String** | The description of the Task being deleted. | 
+

data/docs/HistoryActionTaskUpdate.md

@@ -0,0 +1,13 @@
+# Shortcut::HistoryActionTaskUpdate
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | The ID of the entity referenced. | 
+**entity_type** | **String** | The type of entity referenced. | 
+**action** | **String** | The action of the entity referenced. | 
+**changes** | [**HistoryChangesTask**](HistoryChangesTask.md) |  | 
+**complete** | **BOOLEAN** | Whether or not the Task is complete. | [optional] 
+**description** | **String** | The description of the Task. | 
+**story_id** | **Integer** | The Story ID that contains the Task. | 
+

data/docs/HistoryChangesStory.md

@@ -0,0 +1,30 @@
+# Shortcut::HistoryChangesStory
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**description** | [**StoryHistoryChangeOldNewStr**](StoryHistoryChangeOldNewStr.md) |  | [optional] 
+**archived** | [**StoryHistoryChangeOldNewBool**](StoryHistoryChangeOldNewBool.md) |  | [optional] 
+**started** | [**StoryHistoryChangeOldNewBool**](StoryHistoryChangeOldNewBool.md) |  | [optional] 
+**task_ids** | [**StoryHistoryChangeAddsRemovesInt**](StoryHistoryChangeAddsRemovesInt.md) |  | [optional] 
+**mention_ids** | [**StoryHistoryChangeAddsRemovesUuid**](StoryHistoryChangeAddsRemovesUuid.md) |  | [optional] 
+**story_type** | [**StoryHistoryChangeOldNewStr**](StoryHistoryChangeOldNewStr.md) |  | [optional] 
+**name** | [**StoryHistoryChangeOldNewStr**](StoryHistoryChangeOldNewStr.md) |  | [optional] 
+**completed** | [**StoryHistoryChangeOldNewBool**](StoryHistoryChangeOldNewBool.md) |  | [optional] 
+**blocker** | [**StoryHistoryChangeOldNewBool**](StoryHistoryChangeOldNewBool.md) |  | [optional] 
+**epic_id** | [**StoryHistoryChangeOldNewInt**](StoryHistoryChangeOldNewInt.md) |  | [optional] 
+**branch_ids** | [**StoryHistoryChangeAddsRemovesInt**](StoryHistoryChangeAddsRemovesInt.md) |  | [optional] 
+**commit_ids** | [**StoryHistoryChangeAddsRemovesInt**](StoryHistoryChangeAddsRemovesInt.md) |  | [optional] 
+**requested_by_id** | [**StoryHistoryChangeOldNewUuid**](StoryHistoryChangeOldNewUuid.md) |  | [optional] 
+**iteration_id** | [**StoryHistoryChangeOldNewInt**](StoryHistoryChangeOldNewInt.md) |  | [optional] 
+**label_ids** | [**StoryHistoryChangeAddsRemovesInt**](StoryHistoryChangeAddsRemovesInt.md) |  | [optional] 
+**workflow_state_id** | [**StoryHistoryChangeOldNewInt**](StoryHistoryChangeOldNewInt.md) |  | [optional] 
+**object_story_link_ids** | [**StoryHistoryChangeAddsRemovesInt**](StoryHistoryChangeAddsRemovesInt.md) |  | [optional] 
+**follower_ids** | [**StoryHistoryChangeAddsRemovesUuid**](StoryHistoryChangeAddsRemovesUuid.md) |  | [optional] 
+**owner_ids** | [**StoryHistoryChangeAddsRemovesUuid**](StoryHistoryChangeAddsRemovesUuid.md) |  | [optional] 
+**estimate** | [**StoryHistoryChangeOldNewInt**](StoryHistoryChangeOldNewInt.md) |  | [optional] 
+**subject_story_link_ids** | [**StoryHistoryChangeAddsRemovesInt**](StoryHistoryChangeAddsRemovesInt.md) |  | [optional] 
+**blocked** | [**StoryHistoryChangeOldNewBool**](StoryHistoryChangeOldNewBool.md) |  | [optional] 
+**project_id** | [**StoryHistoryChangeOldNewInt**](StoryHistoryChangeOldNewInt.md) |  | [optional] 
+**deadline** | [**StoryHistoryChangeOldNewStr**](StoryHistoryChangeOldNewStr.md) |  | [optional] 
+

data/docs/HistoryChangesStoryLink.md

@@ -0,0 +1,9 @@
+# Shortcut::HistoryChangesStoryLink
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**verb** | [**StoryHistoryChangeOldNewStr**](StoryHistoryChangeOldNewStr.md) |  | [optional] 
+**object_id** | [**StoryHistoryChangeOldNewInt**](StoryHistoryChangeOldNewInt.md) |  | [optional] 
+**subject_id** | [**StoryHistoryChangeOldNewInt**](StoryHistoryChangeOldNewInt.md) |  | [optional] 
+

data/docs/HistoryChangesTask.md

@@ -0,0 +1,10 @@
+# Shortcut::HistoryChangesTask
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**complete** | [**StoryHistoryChangeOldNewBool**](StoryHistoryChangeOldNewBool.md) |  | [optional] 
+**description** | [**StoryHistoryChangeOldNewStr**](StoryHistoryChangeOldNewStr.md) |  | [optional] 
+**mention_ids** | [**StoryHistoryChangeAddsRemovesUuid**](StoryHistoryChangeAddsRemovesUuid.md) |  | [optional] 
+**owner_ids** | [**StoryHistoryChangeAddsRemovesUuid**](StoryHistoryChangeAddsRemovesUuid.md) |  | [optional] 
+

data/docs/HistoryReferenceBranch.md

@@ -0,0 +1,10 @@
+# Shortcut::HistoryReferenceBranch
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | The ID of the entity referenced. | 
+**entity_type** | **String** | The type of entity referenced. | 
+**name** | **String** | The name of the entity referenced. | 
+**url** | **String** | The external URL for the Branch. | 
+

data/docs/HistoryReferenceCommit.md

@@ -0,0 +1,10 @@
+# Shortcut::HistoryReferenceCommit
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | The ID of the entity referenced. | 
+**entity_type** | **String** | The type of entity referenced. | 
+**message** | **String** | The message from the Commit. | 
+**url** | **String** | The external URL for the Branch. | 
+

data/docs/HistoryReferenceEpic.md

@@ -0,0 +1,10 @@
+# Shortcut::HistoryReferenceEpic
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | The ID of the entity referenced. | 
+**entity_type** | **String** | The type of entity referenced. | 
+**app_url** | **String** | The application URL of the Epic. | 
+**name** | **String** | The name of the entity referenced. | 
+