shortcut_client_ruby 0.0.4 → 0.1.2

data/docs/LinkedFile.md

@@ -1,22 +1,48 @@
 # 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. | 
+
+| 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** | **Time** | 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** | **Time** | The time/date the LinkedFile was created. |  |
+
+## Example
+
+```ruby
+require 'shortcut_client_ruby'
+
+instance = Shortcut::LinkedFile.new(
+  description: null,
+  entity_type: null,
+  story_ids: null,
+  mention_ids: null,
+  member_mention_ids: null,
+  name: null,
+  thumbnail_url: null,
+  type: null,
+  size: null,
+  uploader_id: null,
+  content_type: null,
+  updated_at: null,
+  group_mention_ids: null,
+  id: null,
+  url: null,
+  created_at: null
+)
+```
 

data/docs/ListEpics.md

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

data/docs/ListGroupStories.md

@@ -1,8 +1,20 @@
 # 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] 
+
+| 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] |
+
+## Example
+
+```ruby
+require 'shortcut_client_ruby'
+
+instance = Shortcut::ListGroupStories.new(
+  limit: null,
+  offset: null
+)
+```
 

data/docs/ListLabels.md

@@ -1,7 +1,18 @@
 # 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] 
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **slim** | **Boolean** | A true/false boolean indicating if the slim versions of the Label should be returned. | [optional] |
+
+## Example
+
+```ruby
+require 'shortcut_client_ruby'
+
+instance = Shortcut::ListLabels.new(
+  slim: null
+)
+```
 

data/docs/ListMembers.md

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

data/docs/MaxSearchResultsExceededError.md

@@ -1,9 +1,22 @@
 # 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` | 
+
+| 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` |  |
+
+## Example
+
+```ruby
+require 'shortcut_client_ruby'
+
+instance = Shortcut::MaxSearchResultsExceededError.new(
+  error: null,
+  message: null,
+  maximum_results: null
+)
+```
 

data/docs/Member.md

@@ -1,17 +1,38 @@
 # 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] 
+
+| 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** | **Time** | 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** | **Time** | The time/date the Member was created. |  |
+| **replaced_by** | **String** | The id of the member that replaces this one when merged. | [optional] |
+
+## Example
+
+```ruby
+require 'shortcut_client_ruby'
+
+instance = Shortcut::Member.new(
+  role: null,
+  entity_type: null,
+  disabled: null,
+  state: null,
+  updated_at: null,
+  created_without_invite: null,
+  group_ids: null,
+  id: null,
+  profile: null,
+  created_at: null,
+  replaced_by: null
+)
+```
 

data/docs/MemberInfo.md

@@ -1,10 +1,24 @@
 # Shortcut::MemberInfo
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** |  | 
-**name** | **String** |  | 
-**mention_name** | **String** |  | 
-**workspace2** | [**BasicWorkspaceInfo**](BasicWorkspaceInfo.md) |  | 
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **name** | **String** |  |  |
+| **mention_name** | **String** |  |  |
+| **workspace2** | [**BasicWorkspaceInfo**](BasicWorkspaceInfo.md) |  |  |
+
+## Example
+
+```ruby
+require 'shortcut_client_ruby'
+
+instance = Shortcut::MemberInfo.new(
+  id: null,
+  name: null,
+  mention_name: null,
+  workspace2: null
+)
+```
 

data/docs/Milestone.md

@@ -1,23 +1,50 @@
 # 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. | 
+
+| 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** | **Time** | A manual override for the time/date the Milestone was completed. |  |
+| **started_at** | **Time** | The time/date the Milestone was started. |  |
+| **completed_at** | **Time** | 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** | **Time** | A manual override for the time/date the Milestone was started. |  |
+| **updated_at** | **Time** | 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** | **Time** | The time/date the Milestone was created. |  |
+
+## Example
+
+```ruby
+require 'shortcut_client_ruby'
+
+instance = Shortcut::Milestone.new(
+  app_url: null,
+  description: null,
+  started: null,
+  entity_type: null,
+  completed_at_override: null,
+  started_at: null,
+  completed_at: null,
+  name: null,
+  completed: null,
+  state: null,
+  started_at_override: null,
+  updated_at: null,
+  categories: null,
+  id: null,
+  position: null,
+  stats: null,
+  created_at: null
+)
+```
 

data/docs/MilestoneStats.md

@@ -1,9 +1,22 @@
 # 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. | 
+
+| 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. |  |
+
+## Example
+
+```ruby
+require 'shortcut_client_ruby'
+
+instance = Shortcut::MilestoneStats.new(
+  average_cycle_time: null,
+  average_lead_time: null,
+  num_related_documents: null
+)
+```
 

data/docs/Profile.md

@@ -1,15 +1,34 @@
 # 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. | 
+
+| 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. |  |
+
+## Example
+
+```ruby
+require 'shortcut_client_ruby'
+
+instance = Shortcut::Profile.new(
+  entity_type: null,
+  deactivated: null,
+  two_factor_auth_activated: null,
+  mention_name: null,
+  name: null,
+  gravatar_hash: null,
+  id: null,
+  display_icon: null,
+  email_address: null
+)
+```
 

data/docs/Project.md

@@ -1,25 +1,54 @@
 # 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. | 
+
+| 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** | **Time** | The date at which the Project was started. |  |
+| **updated_at** | **Time** | 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** | **Time** | The time/date that the Project was created. |  |
+
+## Example
+
+```ruby
+require 'shortcut_client_ruby'
+
+instance = Shortcut::Project.new(
+  app_url: null,
+  description: null,
+  archived: null,
+  entity_type: null,
+  days_to_thermometer: null,
+  color: null,
+  workflow_id: null,
+  name: null,
+  start_time: null,
+  updated_at: null,
+  follower_ids: null,
+  external_id: null,
+  id: null,
+  show_thermometer: null,
+  team_id: null,
+  iteration_length: null,
+  abbreviation: null,
+  stats: null,
+  created_at: null
+)
+```
 

data/docs/ProjectStats.md

@@ -1,9 +1,22 @@
 # 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 | 
+
+| 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 |  |
+
+## Example
+
+```ruby
+require 'shortcut_client_ruby'
+
+instance = Shortcut::ProjectStats.new(
+  num_stories: null,
+  num_points: null,
+  num_related_documents: null
+)
+```