shortcut_client_ruby 0.0.4 → 0.1.2

data/docs/GetIterationStories.md

@@ -1,7 +1,18 @@
 # Shortcut::GetIterationStories
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**includes_description** | **BOOLEAN** | A true/false boolean indicating whether to return Stories with their descriptions. | [optional] 
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **includes_description** | **Boolean** | A true/false boolean indicating whether to return Stories with their descriptions. | [optional] |
+
+## Example
+
+```ruby
+require 'shortcut_client_ruby'
+
+instance = Shortcut::GetIterationStories.new(
+  includes_description: null
+)
+```
 

data/docs/GetLabelStories.md

@@ -1,7 +1,18 @@
 # Shortcut::GetLabelStories
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**includes_description** | **BOOLEAN** | A true/false boolean indicating whether to return Stories with their descriptions. | [optional] 
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **includes_description** | **Boolean** | A true/false boolean indicating whether to return Stories with their descriptions. | [optional] |
+
+## Example
+
+```ruby
+require 'shortcut_client_ruby'
+
+instance = Shortcut::GetLabelStories.new(
+  includes_description: null
+)
+```
 

data/docs/GetMember.md

@@ -1,7 +1,18 @@
 # Shortcut::GetMember
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**org_public_id** | **String** | The unique ID of the Organization to limit the lookup to. | [optional] 
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **org_public_id** | **String** | The unique ID of the Organization to limit the lookup to. | [optional] |
+
+## Example
+
+```ruby
+require 'shortcut_client_ruby'
+
+instance = Shortcut::GetMember.new(
+  org_public_id: null
+)
+```
 

data/docs/GetProjectStories.md

@@ -1,7 +1,18 @@
 # Shortcut::GetProjectStories
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**includes_description** | **BOOLEAN** | A true/false boolean indicating whether to return Stories with their descriptions. | [optional] 
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **includes_description** | **Boolean** | A true/false boolean indicating whether to return Stories with their descriptions. | [optional] |
+
+## Example
+
+```ruby
+require 'shortcut_client_ruby'
+
+instance = Shortcut::GetProjectStories.new(
+  includes_description: null
+)
+```
 

data/docs/Group.md

@@ -1,22 +1,48 @@
 # 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. | 
+
+| 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. |  |
+
+## Example
+
+```ruby
+require 'shortcut_client_ruby'
+
+instance = Shortcut::Group.new(
+  app_url: null,
+  description: null,
+  archived: null,
+  entity_type: null,
+  color: null,
+  num_stories_started: null,
+  mention_name: null,
+  name: null,
+  color_key: null,
+  num_stories: null,
+  num_epics_started: null,
+  id: null,
+  display_icon: null,
+  member_ids: null,
+  story_workflow_ids: null,
+  workflow_ids: null
+)
+```
 

data/docs/History.md

@@ -1,15 +1,34 @@
 # 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] 
+
+| 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] |
+
+## Example
+
+```ruby
+require 'shortcut_client_ruby'
+
+instance = Shortcut::History.new(
+  changed_at: null,
+  primary_id: null,
+  references: null,
+  actions: null,
+  member_id: null,
+  external_id: null,
+  id: null,
+  version: null,
+  webhook_id: null
+)
+```
 

data/docs/HistoryActionBranchCreate.md

@@ -1,11 +1,26 @@
 # 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. | 
+
+| 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. |  |
+
+## Example
+
+```ruby
+require 'shortcut_client_ruby'
+
+instance = Shortcut::HistoryActionBranchCreate.new(
+  id: null,
+  entity_type: null,
+  name: null,
+  url: null,
+  action: null
+)
+```
 

data/docs/HistoryActionBranchMerge.md

@@ -1,11 +1,26 @@
 # 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. | 
+
+| 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. |  |
+
+## Example
+
+```ruby
+require 'shortcut_client_ruby'
+
+instance = Shortcut::HistoryActionBranchMerge.new(
+  id: null,
+  entity_type: null,
+  name: null,
+  url: null,
+  action: null
+)
+```
 

data/docs/HistoryActionBranchPush.md

@@ -1,11 +1,26 @@
 # 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. | 
+
+| 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. |  |
+
+## Example
+
+```ruby
+require 'shortcut_client_ruby'
+
+instance = Shortcut::HistoryActionBranchPush.new(
+  id: null,
+  entity_type: null,
+  name: null,
+  url: null,
+  action: null
+)
+```
 

data/docs/HistoryActionLabelCreate.md

@@ -1,11 +1,26 @@
 # 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. | 
+
+| 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. |  |
+
+## Example
+
+```ruby
+require 'shortcut_client_ruby'
+
+instance = Shortcut::HistoryActionLabelCreate.new(
+  id: null,
+  entity_type: null,
+  action: null,
+  app_url: null,
+  name: null
+)
+```
 

data/docs/HistoryActionLabelDelete.md

@@ -1,10 +1,24 @@
 # 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. | 
+
+| 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. |  |
+
+## Example
+
+```ruby
+require 'shortcut_client_ruby'
+
+instance = Shortcut::HistoryActionLabelDelete.new(
+  id: null,
+  entity_type: null,
+  action: null,
+  name: null
+)
+```
 

data/docs/HistoryActionLabelUpdate.md

@@ -1,9 +1,22 @@
 # 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. | 
+
+| 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. |  |
+
+## Example
+
+```ruby
+require 'shortcut_client_ruby'
+
+instance = Shortcut::HistoryActionLabelUpdate.new(
+  id: null,
+  entity_type: null,
+  action: null
+)
+```
 

data/docs/HistoryActionProjectUpdate.md

@@ -1,11 +1,26 @@
 # 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. | 
+
+| 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. |  |
+
+## Example
+
+```ruby
+require 'shortcut_client_ruby'
+
+instance = Shortcut::HistoryActionProjectUpdate.new(
+  id: null,
+  entity_type: null,
+  action: null,
+  app_url: null,
+  name: null
+)
+```
 

data/docs/HistoryActionPullRequest.md

@@ -1,12 +1,28 @@
 # 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. | 
+
+| 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. |  |
+
+## Example
+
+```ruby
+require 'shortcut_client_ruby'
+
+instance = Shortcut::HistoryActionPullRequest.new(
+  id: null,
+  entity_type: null,
+  action: null,
+  number: null,
+  title: null,
+  url: null
+)
+```
 

data/docs/HistoryActionStoryCommentCreate.md

@@ -1,12 +1,28 @@
 # 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. | 
+
+| 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. |  |
+
+## Example
+
+```ruby
+require 'shortcut_client_ruby'
+
+instance = Shortcut::HistoryActionStoryCommentCreate.new(
+  id: null,
+  entity_type: null,
+  action: null,
+  app_url: null,
+  text: null,
+  author_id: null
+)
+```
 

data/docs/HistoryActionStoryCreate.md

@@ -1,30 +1,64 @@
 # 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] 
+
+| 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] |
+
+## Example
+
+```ruby
+require 'shortcut_client_ruby'
+
+instance = Shortcut::HistoryActionStoryCreate.new(
+  app_url: null,
+  description: null,
+  started: null,
+  entity_type: null,
+  task_ids: null,
+  story_type: null,
+  name: null,
+  completed: null,
+  blocker: null,
+  epic_id: null,
+  requested_by_id: null,
+  iteration_id: null,
+  label_ids: null,
+  workflow_state_id: null,
+  object_story_link_ids: null,
+  follower_ids: null,
+  owner_ids: null,
+  id: null,
+  estimate: null,
+  subject_story_link_ids: null,
+  action: null,
+  blocked: null,
+  project_id: null,
+  deadline: null
+)
+```