shortcut_client_ruby 0.0.4 → 0.1.2

data/docs/Task.md

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

data/docs/ThreadedComment.md

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

data/docs/TypedStoryLink.md

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

data/docs/UnusableEntitlementError.md

@@ -1,9 +1,22 @@
 # Shortcut::UnusableEntitlementError
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**reason_tag** | **String** | The tag for violating an entitlement action. | 
-**entitlement_tag** | **String** | Short tag describing the unusable entitlement action taken by the user. | 
-**message** | **String** | Message displayed to the user on why their action failed. | 
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **reason_tag** | **String** | The tag for violating an entitlement action. |  |
+| **entitlement_tag** | **String** | Short tag describing the unusable entitlement action taken by the user. |  |
+| **message** | **String** | Message displayed to the user on why their action failed. |  |
+
+## Example
+
+```ruby
+require 'shortcut_client_ruby'
+
+instance = Shortcut::UnusableEntitlementError.new(
+  reason_tag: null,
+  entitlement_tag: null,
+  message: null
+)
+```
 

data/docs/UpdateCategory.md

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

data/docs/UpdateComment.md

@@ -1,7 +1,18 @@
 # Shortcut::UpdateComment
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**text** | **String** | The updated comment text. | 
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **text** | **String** | The updated comment text. |  |
+
+## Example
+
+```ruby
+require 'shortcut_client_ruby'
+
+instance = Shortcut::UpdateComment.new(
+  text: null
+)
+```
 

data/docs/UpdateEntityTemplate.md

@@ -1,8 +1,20 @@
 # Shortcut::UpdateEntityTemplate
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **String** | The updated template name. | [optional] 
-**story_contents** | [**UpdateStoryContents**](UpdateStoryContents.md) |  | [optional] 
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The updated template name. | [optional] |
+| **story_contents** | [**UpdateStoryContents**](UpdateStoryContents.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'shortcut_client_ruby'
+
+instance = Shortcut::UpdateEntityTemplate.new(
+  name: null,
+  story_contents: null
+)
+```
 

data/docs/UpdateEpic.md

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

data/docs/UpdateFile.md

@@ -1,12 +1,28 @@
 # Shortcut::UpdateFile
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**description** | **String** | The description of the file. | [optional] 
-**created_at** | **DateTime** | The time/date that the file was uploaded. | [optional] 
-**updated_at** | **DateTime** | The time/date that the file was last updated. | [optional] 
-**name** | **String** | The name of the file. | [optional] 
-**uploader_id** | **String** | The unique ID assigned to the Member who uploaded the file to Shortcut. | [optional] 
-**external_id** | **String** | An additional ID that you may wish to assign to the file. | [optional] 
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **description** | **String** | The description of the file. | [optional] |
+| **created_at** | **Time** | The time/date that the file was uploaded. | [optional] |
+| **updated_at** | **Time** | The time/date that the file was last updated. | [optional] |
+| **name** | **String** | The name of the file. | [optional] |
+| **uploader_id** | **String** | The unique ID assigned to the Member who uploaded the file to Shortcut. | [optional] |
+| **external_id** | **String** | An additional ID that you may wish to assign to the file. | [optional] |
+
+## Example
+
+```ruby
+require 'shortcut_client_ruby'
+
+instance = Shortcut::UpdateFile.new(
+  description: null,
+  created_at: null,
+  updated_at: null,
+  name: null,
+  uploader_id: null,
+  external_id: null
+)
+```
 

data/docs/UpdateGroup.md

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

data/docs/UpdateIteration.md

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

data/docs/UpdateLabel.md

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

data/docs/UpdateLinkedFile.md

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

data/docs/UpdateMilestone.md

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