shortcut_client_ruby 0.0.4 → 0.1.2

data/docs/StoryContents.md

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

data/docs/StoryContentsTask.md

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

data/docs/StoryHistoryChangeAddsRemovesInt.md

@@ -1,8 +1,20 @@
 # Shortcut::StoryHistoryChangeAddsRemovesInt
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**adds** | **Array<Integer>** | The values that have been added. | [optional] 
-**removes** | **Array<Integer>** | The values that have been removed | [optional] 
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **adds** | **Array<Integer>** | The values that have been added. | [optional] |
+| **removes** | **Array<Integer>** | The values that have been removed | [optional] |
+
+## Example
+
+```ruby
+require 'shortcut_client_ruby'
+
+instance = Shortcut::StoryHistoryChangeAddsRemovesInt.new(
+  adds: null,
+  removes: null
+)
+```
 

data/docs/StoryHistoryChangeAddsRemovesUuid.md

@@ -1,8 +1,20 @@
 # Shortcut::StoryHistoryChangeAddsRemovesUuid
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**adds** | **Array<String>** | The values that have been added. | [optional] 
-**removes** | **Array<String>** | The values that have been removed | [optional] 
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **adds** | **Array<String>** | The values that have been added. | [optional] |
+| **removes** | **Array<String>** | The values that have been removed | [optional] |
+
+## Example
+
+```ruby
+require 'shortcut_client_ruby'
+
+instance = Shortcut::StoryHistoryChangeAddsRemovesUuid.new(
+  adds: null,
+  removes: null
+)
+```
 

data/docs/StoryHistoryChangeOldNewBool.md

@@ -1,8 +1,20 @@
 # Shortcut::StoryHistoryChangeOldNewBool
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**old** | **BOOLEAN** | The old value. | [optional] 
-**new** | **BOOLEAN** | The new value. | [optional] 
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **old** | **Boolean** | The old value. | [optional] |
+| **new** | **Boolean** | The new value. | [optional] |
+
+## Example
+
+```ruby
+require 'shortcut_client_ruby'
+
+instance = Shortcut::StoryHistoryChangeOldNewBool.new(
+  old: null,
+  new: null
+)
+```
 

data/docs/StoryHistoryChangeOldNewInt.md

@@ -1,8 +1,20 @@
 # Shortcut::StoryHistoryChangeOldNewInt
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**old** | **Integer** | The old value. | [optional] 
-**new** | **Integer** | The new value. | [optional] 
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **old** | **Integer** | The old value. | [optional] |
+| **new** | **Integer** | The new value. | [optional] |
+
+## Example
+
+```ruby
+require 'shortcut_client_ruby'
+
+instance = Shortcut::StoryHistoryChangeOldNewInt.new(
+  old: null,
+  new: null
+)
+```
 

data/docs/StoryHistoryChangeOldNewStr.md

@@ -1,8 +1,20 @@
 # Shortcut::StoryHistoryChangeOldNewStr
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**old** | **String** | The old value. | [optional] 
-**new** | **String** | The new value. | [optional] 
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **old** | **String** | The old value. | [optional] |
+| **new** | **String** | The new value. | [optional] |
+
+## Example
+
+```ruby
+require 'shortcut_client_ruby'
+
+instance = Shortcut::StoryHistoryChangeOldNewStr.new(
+  old: null,
+  new: null
+)
+```
 

data/docs/StoryHistoryChangeOldNewUuid.md

@@ -1,8 +1,20 @@
 # Shortcut::StoryHistoryChangeOldNewUuid
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**old** | **String** | The old value. | [optional] 
-**new** | **String** | The new value. | [optional] 
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **old** | **String** | The old value. | [optional] |
+| **new** | **String** | The new value. | [optional] |
+
+## Example
+
+```ruby
+require 'shortcut_client_ruby'
+
+instance = Shortcut::StoryHistoryChangeOldNewUuid.new(
+  old: null,
+  new: null
+)
+```
 

data/docs/StoryLink.md

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

data/docs/StoryReaction.md

@@ -1,8 +1,20 @@
 # Shortcut::StoryReaction
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**emoji** | **String** | Emoji text of the reaction. | 
-**permission_ids** | **Array<String>** | Permissions who have reacted with this. | 
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **emoji** | **String** | Emoji text of the reaction. |  |
+| **permission_ids** | **Array<String>** | Permissions who have reacted with this. |  |
+
+## Example
+
+```ruby
+require 'shortcut_client_ruby'
+
+instance = Shortcut::StoryReaction.new(
+  emoji: null,
+  permission_ids: null
+)
+```
 

data/docs/StorySearchResults.md

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

data/docs/StorySlim.md

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

data/docs/StoryStats.md

@@ -1,7 +1,18 @@
 # Shortcut::StoryStats
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**num_related_documents** | **Integer** | The number of documents related to this Story. | 
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **num_related_documents** | **Integer** | The number of documents related to this Story. |  |
+
+## Example
+
+```ruby
+require 'shortcut_client_ruby'
+
+instance = Shortcut::StoryStats.new(
+  num_related_documents: null
+)
+```