shortcut_client_ruby 0.0.2

data/docs/HistoryReferenceGeneral.md

@@ -0,0 +1,9 @@
+# Shortcut::HistoryReferenceGeneral
+
+## 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. | 
+

data/docs/HistoryReferenceGroup.md

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

data/docs/HistoryReferenceIteration.md

@@ -0,0 +1,10 @@
+# Shortcut::HistoryReferenceIteration
+
+## 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 Iteration. | 
+**name** | **String** | The name of the entity referenced. | 
+

data/docs/HistoryReferenceLabel.md

@@ -0,0 +1,10 @@
+# Shortcut::HistoryReferenceLabel
+
+## 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 Label. | 
+**name** | **String** | The name of the entity referenced. | 
+

data/docs/HistoryReferenceProject.md

@@ -0,0 +1,10 @@
+# Shortcut::HistoryReferenceProject
+
+## 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 Project. | 
+**name** | **String** | The name of the entity referenced. | 
+

data/docs/HistoryReferenceStory.md

@@ -0,0 +1,11 @@
+# Shortcut::HistoryReferenceStory
+
+## 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 Story. | 
+**name** | **String** | The name of the entity referenced. | 
+**story_type** | **String** | If the referenced entity is a Story, either \"bug\", \"chore\", or \"feature\". | 
+

data/docs/HistoryReferenceStoryTask.md

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

data/docs/HistoryReferenceWorkflowState.md

@@ -0,0 +1,10 @@
+# Shortcut::HistoryReferenceWorkflowState
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | The ID of the entity referenced. | 
+**entity_type** | **String** | The type of entity referenced. | 
+**type** | **String** | Either \"unstarted\", \"started\", or \"done\". | 
+**name** | **String** | The name of the entity referenced. | 
+

data/docs/Icon.md

@@ -0,0 +1,11 @@
+# Shortcut::Icon
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**entity_type** | **String** | A string description of this resource. | 
+**id** | **String** | The unique ID of the Icon. | 
+**created_at** | **DateTime** | The time/date that the Icon was created. | 
+**updated_at** | **DateTime** | The time/date that the Icon was updated. | 
+**url** | **String** | The URL of the Icon. | 
+

data/docs/Identity.md

@@ -0,0 +1,9 @@
+# Shortcut::Identity
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**entity_type** | **String** | A string description of this resource. | 
+**name** | **String** | This is your login in VCS. | 
+**type** | **String** | The type of Identity; currently only type is github. | 
+

data/docs/Iteration.md

@@ -0,0 +1,24 @@
+# Shortcut::Iteration
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**app_url** | **String** | The Shortcut application url for the Iteration. | 
+**description** | **String** | The description of the iteration. | 
+**entity_type** | **String** | A string description of this resource | 
+**labels** | [**Array<Label>**](Label.md) | An array of labels attached to the iteration. | 
+**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. | 
+**name** | **String** | The name of the iteration. | 
+**label_ids** | **Array<Integer>** | An array of label ids attached to the iteration. | 
+**updated_at** | **DateTime** | The instant when this iteration was last updated. | 
+**group_mention_ids** | **Array<String>** | An array of Group IDs that have been mentioned in the Story description. | 
+**end_date** | **DateTime** | The date this iteration begins. | 
+**follower_ids** | **Array<String>** | An array of UUIDs for any Members listed as Followers. | 
+**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. | 
+**start_date** | **DateTime** | The date this iteration begins. | 
+**status** | **String** | The status of the iteration. Values are either \"unstarted\", \"started\", or \"done\". | 
+**id** | **Integer** | The ID of the iteration. | 
+**stats** | [**IterationStats**](IterationStats.md) |  | 
+**created_at** | **DateTime** | The instant when this iteration was created. | 
+

data/docs/IterationSlim.md

@@ -0,0 +1,23 @@
+# Shortcut::IterationSlim
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**app_url** | **String** | The Shortcut application url for the Iteration. | 
+**entity_type** | **String** | A string description of this resource | 
+**labels** | [**Array<Label>**](Label.md) | An array of labels attached to the iteration. | 
+**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. | 
+**name** | **String** | The name of the iteration. | 
+**label_ids** | **Array<Integer>** | An array of label ids attached to the iteration. | 
+**updated_at** | **DateTime** | The instant when this iteration was last updated. | 
+**group_mention_ids** | **Array<String>** | An array of Group IDs that have been mentioned in the Story description. | 
+**end_date** | **DateTime** | The date this iteration begins. | 
+**follower_ids** | **Array<String>** | An array of UUIDs for any Members listed as Followers. | 
+**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. | 
+**start_date** | **DateTime** | The date this iteration begins. | 
+**status** | **String** | The status of the iteration. Values are either \"unstarted\", \"started\", or \"done\". | 
+**id** | **Integer** | The ID of the iteration. | 
+**stats** | [**IterationStats**](IterationStats.md) |  | 
+**created_at** | **DateTime** | The instant when this iteration was created. | 
+

data/docs/IterationStats.md

@@ -0,0 +1,17 @@
+# Shortcut::IterationStats
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**num_points_done** | **Integer** | The total number of completed points in this Iteration. | 
+**num_related_documents** | **Integer** | The total number of documents related to an Iteration | 
+**average_cycle_time** | **Integer** | The average cycle time (in seconds) of completed stories in this Iteration. | [optional] 
+**num_stories_unstarted** | **Integer** | The total number of unstarted Stories in this Iteration. | 
+**num_points_started** | **Integer** | The total number of started points in this Iteration. | 
+**num_points_unstarted** | **Integer** | The total number of unstarted points in this Iteration. | 
+**num_stories_started** | **Integer** | The total number of started Stories in this Iteration. | 
+**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 Iteration. | [optional] 
+**num_points** | **Integer** | The total number of points in this Iteration. | 
+**num_stories_done** | **Integer** | The total number of done Stories in this Iteration. | 
+

data/docs/Label.md

@@ -0,0 +1,17 @@
+# Shortcut::Label
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**app_url** | **String** | The Shortcut application url for the Label. | 
+**description** | **String** | The description of the Label. | 
+**archived** | **BOOLEAN** | A true/false boolean indicating if the Label has been archived. | 
+**entity_type** | **String** | A string description of this resource. | 
+**color** | **String** | The hex color to be displayed with the Label (for example, \"#ff0000\"). | 
+**name** | **String** | The name of the Label. | 
+**updated_at** | **DateTime** | The time/date that the Label was updated. | 
+**external_id** | **String** | This field can be set to another unique ID. In the case that the Label has been imported from another tool, the ID in the other tool can be indicated here. | 
+**id** | **Integer** | The unique ID of the Label. | 
+**stats** | [**LabelStats**](LabelStats.md) |  | [optional] 
+**created_at** | **DateTime** | The time/date that the Label was created. | 
+

data/docs/LabelSlim.md

@@ -0,0 +1,16 @@
+# Shortcut::LabelSlim
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**app_url** | **String** | The Shortcut application url for the Label. | 
+**description** | **String** | The description of the Label. | 
+**archived** | **BOOLEAN** | A true/false boolean indicating if the Label has been archived. | 
+**entity_type** | **String** | A string description of this resource. | 
+**color** | **String** | The hex color to be displayed with the Label (for example, \"#ff0000\"). | 
+**name** | **String** | The name of the Label. | 
+**updated_at** | **DateTime** | The time/date that the Label was updated. | 
+**external_id** | **String** | This field can be set to another unique ID. In the case that the Label has been imported from another tool, the ID in the other tool can be indicated here. | 
+**id** | **Integer** | The unique ID of the Label. | 
+**created_at** | **DateTime** | The time/date that the Label was created. | 
+

data/docs/LabelStats.md

@@ -0,0 +1,21 @@
+# Shortcut::LabelStats
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**num_related_documents** | **Integer** | The total number of Documents associated this Label. | 
+**num_epics** | **Integer** | The total number of Epics with this Label. | 
+**num_stories_unstarted** | **Integer** | The total number of stories unstarted Stories with this Label. | 
+**num_stories_total** | **Integer** | The total number of Stories with this Label. | 
+**num_epics_unstarted** | **Integer** | The number of unstarted epics assoicated with this label. | 
+**num_epics_in_progress** | **Integer** | The number of in progress epics assoicated with this label. | 
+**num_points_unstarted** | **Integer** | The total number of unstarted points with this Label. | 
+**num_stories_unestimated** | **Integer** | The total number of Stories with no point estimate with this Label. | 
+**num_points_in_progress** | **Integer** | The total number of in-progress points with this Label. | 
+**num_epics_total** | **Integer** | The total number of Epics assoicated with this Label. | 
+**num_stories_completed** | **Integer** | The total number of completed Stories with this Label. | 
+**num_points_completed** | **Integer** | The total number of completed points with this Label. | 
+**num_points_total** | **Integer** | The total number of points with this Label. | 
+**num_stories_in_progress** | **Integer** | The total number of in-progress Stories with this Label. | 
+**num_epics_completed** | **Integer** | The number of completed Epics assoicated with this Label. | 
+

data/docs/LinkedFile.md

@@ -0,0 +1,22 @@
+# Shortcut::LinkedFile
+
+## 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 IDs of the stories this file is attached to. | 
+**mention_ids** | **Array<String>** | Deprecated: use member_mention_ids. | 
+**member_mention_ids** | **Array<String>** | The members that are mentioned in the description of the file. | 
+**name** | **String** | The name of the linked file. | 
+**thumbnail_url** | **String** | The URL of the file thumbnail, if the integration provided it. | 
+**type** | **String** | The integration type (e.g. google, dropbox, box). | 
+**size** | **Integer** | The filesize, if the integration provided it. | 
+**uploader_id** | **String** | The UUID of the member that uploaded the file. | 
+**content_type** | **String** | The content type of the image (e.g. txt/plain). | 
+**updated_at** | **DateTime** | The time/date the LinkedFile was updated. | 
+**group_mention_ids** | **Array<String>** | The groups that are mentioned in the description of the file. | 
+**id** | **Integer** | The unique identifier for the file. | 
+**url** | **String** | The URL of the file. | 
+**created_at** | **DateTime** | The time/date the LinkedFile was created. | 
+

data/docs/ListEpics.md

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

data/docs/ListGroupStories.md

@@ -0,0 +1,8 @@
+# Shortcut::ListGroupStories
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**limit** | **Integer** | The maximum number of results to return. (Defaults to 1000, max 1000) | [optional] 
+**offset** | **Integer** | The offset at which to begin returning results. (Defaults to 0) | [optional] 
+

data/docs/ListLabels.md

@@ -0,0 +1,7 @@
+# Shortcut::ListLabels
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**slim** | **BOOLEAN** | A true/false boolean indicating if the slim versions of the Label should be returned. | [optional] 
+

data/docs/ListMembers.md

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

data/docs/MaxSearchResultsExceededError.md

@@ -0,0 +1,9 @@
+# Shortcut::MaxSearchResultsExceededError
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**error** | **String** | The name for this type of error, `maximum-results-exceeded` | 
+**message** | **String** | An explanatory message: \"A maximum of 1000 search results are supported.\" | 
+**maximum_results** | **Integer** | The maximum number of search results supported, `1000` | 
+

data/docs/Member.md

@@ -0,0 +1,17 @@
+# Shortcut::Member
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**role** | **String** | The Member's role in the Shortcut organization. | 
+**entity_type** | **String** | A string description of this resource. | 
+**disabled** | **BOOLEAN** | True/false boolean indicating whether the Member has been disabled within this Organization. | 
+**state** | **String** | The user state, one of partial, full, disabled, or imported.  A partial            user is disabled, has no means to log in, and is not an import user.  A full            user is enabled and has a means to log in.  A disabled user is disabled and has            a means to log in.  An import user is disabled, has no means to log in, and is            marked as an import user. | 
+**updated_at** | **DateTime** | The time/date the Member was last updated. | 
+**created_without_invite** | **BOOLEAN** | Whether this member was created as a placeholder entity. | 
+**group_ids** | **Array<String>** | The Member's group ids | 
+**id** | **String** | The Member's ID in Shortcut. | 
+**profile** | [**Profile**](Profile.md) |  | 
+**created_at** | **DateTime** | The time/date the Member was created. | 
+**replaced_by** | **String** | The id of the member that replaces this one when merged. | [optional] 
+

data/docs/MemberInfo.md

@@ -0,0 +1,10 @@
+# Shortcut::MemberInfo
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | 
+**name** | **String** |  | 
+**mention_name** | **String** |  | 
+**workspace2** | [**BasicWorkspaceInfo**](BasicWorkspaceInfo.md) |  | 
+

data/docs/Milestone.md

@@ -0,0 +1,23 @@
+# Shortcut::Milestone
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**app_url** | **String** | The Shortcut application url for the Milestone. | 
+**description** | **String** | The Milestone's description. | 
+**started** | **BOOLEAN** | A true/false boolean indicating if the Milestone has been started. | 
+**entity_type** | **String** | A string description of this resource. | 
+**completed_at_override** | **DateTime** | A manual override for the time/date the Milestone was completed. | 
+**started_at** | **DateTime** | The time/date the Milestone was started. | 
+**completed_at** | **DateTime** | The time/date the Milestone was completed. | 
+**name** | **String** | The name of the Milestone. | 
+**completed** | **BOOLEAN** | A true/false boolean indicating if the Milestone has been completed. | 
+**state** | **String** | The workflow state that the Milestone is in. | 
+**started_at_override** | **DateTime** | A manual override for the time/date the Milestone was started. | 
+**updated_at** | **DateTime** | The time/date the Milestone was updated. | 
+**categories** | [**Array<Category>**](Category.md) | An array of Categories attached to the Milestone. | 
+**id** | **Integer** | The unique ID of the Milestone. | 
+**position** | **Integer** | A number representing the position of the Milestone in relation to every other Milestone within the Organization. | 
+**stats** | [**MilestoneStats**](MilestoneStats.md) |  | [optional] 
+**created_at** | **DateTime** | The time/date the Milestone was created. | 
+

data/docs/MilestoneStats.md

@@ -0,0 +1,9 @@
+# Shortcut::MilestoneStats
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**average_cycle_time** | **Integer** | The average cycle time (in seconds) of completed stories in this Milestone. | [optional] 
+**average_lead_time** | **Integer** | The average lead time (in seconds) of completed stories in this Milestone. | [optional] 
+**num_related_documents** | **Integer** | The number of related documents tp this Milestone. | 
+

data/docs/Profile.md

@@ -0,0 +1,15 @@
+# Shortcut::Profile
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**entity_type** | **String** | A string description of this resource. | 
+**deactivated** | **BOOLEAN** | A true/false boolean indicating whether the Member has been deactivated within Shortcut. | 
+**two_factor_auth_activated** | **BOOLEAN** | If Two Factor Authentication is activated for this User. | [optional] 
+**mention_name** | **String** | The Member's username within the Organization. | 
+**name** | **String** | The Member's name within the Organization. | 
+**gravatar_hash** | **String** | This is the gravatar hash associated with email_address. | 
+**id** | **String** | The unique identifier of the profile. | 
+**display_icon** | [**Icon**](Icon.md) |  | 
+**email_address** | **String** | The primary email address of the Member with the Organization. | 
+

data/docs/Project.md

@@ -0,0 +1,25 @@
+# Shortcut::Project
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**app_url** | **String** | The Shortcut application url for the Project. | 
+**description** | **String** | The description of the Project. | 
+**archived** | **BOOLEAN** | True/false boolean indicating whether the Project is in an Archived state. | 
+**entity_type** | **String** | A string description of this resource. | 
+**days_to_thermometer** | **Integer** | The number of days before the thermometer appears in the Story summary. | 
+**color** | **String** | The color associated with the Project in the Shortcut member interface. | 
+**workflow_id** | **Integer** | The ID of the workflow the project belongs to. | 
+**name** | **String** | The name of the Project | 
+**start_time** | **DateTime** | The date at which the Project was started. | 
+**updated_at** | **DateTime** | The time/date that the Project was last updated. | 
+**follower_ids** | **Array<String>** | An array of UUIDs for any Members listed as Followers. | 
+**external_id** | **String** | This field can be set to another unique ID. In the case that the Project has been imported from another tool, the ID in the other tool can be indicated here. | 
+**id** | **Integer** | The unique ID of the Project. | 
+**show_thermometer** | **BOOLEAN** | Configuration to enable or disable thermometers in the Story summary. | 
+**team_id** | **Integer** | The ID of the team the project belongs to. | 
+**iteration_length** | **Integer** | The number of weeks per iteration in this Project. | 
+**abbreviation** | **String** | The Project abbreviation used in Story summaries. Should be kept to 3 characters at most. | 
+**stats** | [**ProjectStats**](ProjectStats.md) |  | 
+**created_at** | **DateTime** | The time/date that the Project was created. | 
+

data/docs/ProjectStats.md

@@ -0,0 +1,9 @@
+# Shortcut::ProjectStats
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**num_stories** | **Integer** | The total number of stories in this Project. | 
+**num_points** | **Integer** | The total number of points in this Project. | 
+**num_related_documents** | **Integer** | The total number of documents related to this Project | 
+

data/docs/PullRequest.md

@@ -0,0 +1,28 @@
+# Shortcut::PullRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**entity_type** | **String** | A string description of this resource. | 
+**closed** | **BOOLEAN** | True/False boolean indicating whether the VCS pull request has been closed. | 
+**merged** | **BOOLEAN** | True/False boolean indicating whether the VCS pull request has been merged. | 
+**num_added** | **Integer** | Number of lines added in the pull request, according to VCS. | 
+**branch_id** | **Integer** | The ID of the branch for the particular pull request. | 
+**number** | **Integer** | The pull request's unique number ID in VCS. | 
+**branch_name** | **String** | The name of the branch for the particular pull request. | 
+**target_branch_name** | **String** | The name of the target branch for the particular pull request. | 
+**num_commits** | **Integer** | The number of commits on the pull request. | 
+**title** | **String** | The title of the pull request. | 
+**updated_at** | **DateTime** | The time/date the pull request was created. | 
+**draft** | **BOOLEAN** | True/False boolean indicating whether the VCS pull request is in the draft state. | 
+**id** | **Integer** | The unique ID associated with the pull request in Shortcut. | 
+**vcs_labels** | [**Array<PullRequestLabel>**](PullRequestLabel.md) | An array of PullRequestLabels attached to the PullRequest. | [optional] 
+**url** | **String** | The URL for the pull request. | 
+**num_removed** | **Integer** | Number of lines removed in the pull request, according to VCS. | 
+**review_status** | **String** | The status of the review for the pull request. | [optional] 
+**num_modified** | **Integer** | Number of lines modified in the pull request, according to VCS. | 
+**build_status** | **String** | The status of the Continuous Integration workflow for the pull request. | [optional] 
+**target_branch_id** | **Integer** | The ID of the target branch for the particular pull request. | 
+**repository_id** | **Integer** | The ID of the repository for the particular pull request. | 
+**created_at** | **DateTime** | The time/date the pull request was created. | 
+

data/docs/PullRequestLabel.md

@@ -0,0 +1,11 @@
+# Shortcut::PullRequestLabel
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**entity_type** | **String** | A string description of this resource. | 
+**id** | **Integer** | The unique ID of the VCS Label. | 
+**color** | **String** | The color of the VCS label. | 
+**description** | **String** | The description of the VCS label. | [optional] 
+**name** | **String** | The name of the VCS label. | 
+

data/docs/Repository.md

@@ -0,0 +1,15 @@
+# Shortcut::Repository
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**entity_type** | **String** | A string description of this resource. | 
+**name** | **String** | The shorthand name of the VCS repository. | 
+**type** | **String** | The type of Repository. Currently this can only be \"github\". | 
+**updated_at** | **DateTime** | The time/date the Repository was updated. | 
+**external_id** | **String** | The VCS unique identifier for the Repository. | 
+**id** | **Integer** | The ID associated to the VCS repository in Shortcut. | 
+**url** | **String** | The URL of the Repository. | 
+**full_name** | **String** | The full name of the VCS repository. | 
+**created_at** | **DateTime** | The time/date the Repository was created. | 
+

data/docs/Search.md

@@ -0,0 +1,10 @@
+# Shortcut::Search
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**query** | **String** | See our help center article on [search operators](https://help.shortcut.com/hc/en-us/articles/360000046646-Search-Operators) | 
+**page_size** | **Integer** | The number of search results to include in a page. Minimum of 1 and maximum of 25. | [optional] 
+**_next** | **String** | The next page token. | [optional] 
+**include** | **String** |  | [optional] 
+

data/docs/SearchResults.md

@@ -0,0 +1,8 @@
+# Shortcut::SearchResults
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**epics** | [**EpicSearchResults**](EpicSearchResults.md) |  | 
+**stories** | [**StorySearchResults**](StorySearchResults.md) |  | 
+

data/docs/SearchStories.md

@@ -0,0 +1,34 @@
+# Shortcut::SearchStories
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**archived** | **BOOLEAN** | A true/false boolean indicating whether the Story is in archived state. | [optional] 
+**owner_id** | **String** | An array of UUIDs for any Users who may be Owners of the Stories. | [optional] 
+**story_type** | **String** | The type of Stories that you want returned. | [optional] 
+**epic_ids** | **Array<Integer>** | The Epic IDs that may be associated with the Stories. | [optional] 
+**project_ids** | **Array<Integer>** | The IDs for the Projects the Stories may be assigned to. | [optional] 
+**updated_at_end** | **DateTime** | Stories should have been updated before this date. | [optional] 
+**completed_at_end** | **DateTime** | Stories should have been completed before this date. | [optional] 
+**workflow_state_types** | **Array<String>** | The type of Workflow State the Stories may be in. | [optional] 
+**deadline_end** | **DateTime** | Stories should have a deadline before this date. | [optional] 
+**created_at_start** | **DateTime** | Stories should have been created after this date. | [optional] 
+**epic_id** | **Integer** | The Epic IDs that may be associated with the Stories. | [optional] 
+**label_name** | **String** | The name of any associated Labels. | [optional] 
+**requested_by_id** | **String** | The UUID of any Users who may have requested the Stories. | [optional] 
+**iteration_id** | **Integer** | The Iteration ID that may be associated with the Stories. | [optional] 
+**label_ids** | **Array<Integer>** | The Label IDs that may be associated with the Stories. | [optional] 
+**group_id** | **String** | The Group ID that is associated with the Stories | [optional] 
+**workflow_state_id** | **Integer** | The unique IDs of the specific Workflow States that the Stories should be in. | [optional] 
+**iteration_ids** | **Array<Integer>** | The Iteration IDs that may be associated with the Stories. | [optional] 
+**created_at_end** | **DateTime** | Stories should have been created before this date. | [optional] 
+**deadline_start** | **DateTime** | Stories should have a deadline after this date. | [optional] 
+**group_ids** | **Array<String>** | The Group IDs that are associated with the Stories | [optional] 
+**owner_ids** | **Array<String>** | An array of UUIDs for any Users who may be Owners of the Stories. | [optional] 
+**external_id** | **String** | An ID or URL that references an external resource. Useful during imports. | [optional] 
+**includes_description** | **BOOLEAN** | Whether to include the story description in the response. | [optional] 
+**estimate** | **Integer** | The number of estimate points associate with the Stories. | [optional] 
+**project_id** | **Integer** | The IDs for the Projects the Stories may be assigned to. | [optional] 
+**completed_at_start** | **DateTime** | Stories should have been competed after this date. | [optional] 
+**updated_at_start** | **DateTime** | Stories should have been updated after this date. | [optional] 
+

data/docs/Story.md

@@ -0,0 +1,56 @@
+# Shortcut::Story
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**app_url** | **String** | The Shortcut application url for the Story. | 
+**description** | **String** | The description of the story. | 
+**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. | 
+**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). | 
+**linked_files** | [**Array<LinkedFile>**](LinkedFile.md) | An array of linked files attached to the story. | 
+**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. | 
+**comments** | [**Array<StoryComment>**](StoryComment.md) | An array of comments attached to the story. | 
+**blocker** | **BOOLEAN** | A true/false boolean indicating if the Story is currently a blocker of another story. | 
+**branches** | [**Array<Branch>**](Branch.md) | An array of Git branches attached to the 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. | 
+**tasks** | [**Array<Task>**](Task.md) | An array of tasks connected to the story. | 
+**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. | 
+**pull_requests** | [**Array<PullRequest>**](PullRequest.md) | An array of Pull/Merge Requests attached to the story. | 
+**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. | 
+**commits** | [**Array<Commit>**](Commit.md) | An array of commits attached to the story. | 
+**files** | [**Array<UploadedFile>**](UploadedFile.md) | An array of files attached to the story. | 
+**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. | 
+**deadline** | **DateTime** | The due date of the story. | 
+**stats** | [**StoryStats**](StoryStats.md) |  | 
+**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. | 
+