shortcut_client_ruby 0.0.4 → 0.1.2

data/Rakefile

@@ -1,3 +1,5 @@
+require "bundler/gem_tasks"
+
 begin
   require 'rspec/core/rake_task'
 

data/bin/update.rb

@@ -12,8 +12,12 @@ def next_version
   @next_version ||= begin
     major, minor, patch = config["gemVersion"].split(".")
     case ARGV[0]
-    when "major" then major = major.to_i + 1
-    when "minor" then minor = minor.to_i + 1
+    when "major"
+      major = major.to_i + 1
+      minor = patch = 0
+    when "minor"
+      minor = minor.to_i + 1
+      patch = 0
     when "patch" then patch = patch.to_i + 1
     else
       puts "you need to provide one argument: patch, minor, or major"
@@ -30,5 +34,5 @@ def rewrite_config
 end
 
 rewrite_config
-puts "run swagger codegen"
-`swagger-codegen generate -i #{SWAGGER_SOURCE} -l ruby -o . -c config.json`
+# `swagger-codegen generate --additional-properties library=faraday -i #{SWAGGER_SOURCE} -l ruby -o . -c config.json`
+`java -jar openapi-generator-cli.jar generate -g ruby -i #{SWAGGER_SOURCE} -o . -c config.json --additional-properties library=faraday`

data/config.json

@@ -1,7 +1,8 @@
 {
   "gemName": "shortcut_client_ruby",
+  "library": "faraday",
   "moduleName": "Shortcut",
-  "gemVersion": "0.0.4",
+  "gemVersion": "0.1.2",
   "gitUserId": "ngouy",
   "gitRepoId": "shortcut_client_ruby"
 }

data/docs/BasicWorkspaceInfo.md

@@ -1,8 +1,20 @@
 # Shortcut::BasicWorkspaceInfo
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**url_slug** | **String** |  | 
-**estimate_scale** | **Array<Integer>** |  | 
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **url_slug** | **String** |  |  |
+| **estimate_scale** | **Array<Integer>** |  |  |
+
+## Example
+
+```ruby
+require 'shortcut_client_ruby'
+
+instance = Shortcut::BasicWorkspaceInfo.new(
+  url_slug: null,
+  estimate_scale: null
+)
+```
 

data/docs/Branch.md

@@ -1,17 +1,38 @@
 # Shortcut::Branch
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**entity_type** | **String** | A string description of this resource. | 
-**deleted** | **BOOLEAN** | A true/false boolean indicating if the Branch has been deleted. | 
-**name** | **String** | The name of the Branch. | 
-**persistent** | **BOOLEAN** | A true/false boolean indicating if the Branch is persistent; e.g. master. | 
-**updated_at** | **DateTime** | The time/date the Branch was updated. | 
-**pull_requests** | [**Array<PullRequest>**](PullRequest.md) | An array of PullRequests attached to the Branch (there is usually only one). | 
-**merged_branch_ids** | **Array<Integer>** | The IDs of the Branches the Branch has been merged into. | 
-**id** | **Integer** | The unique ID of the Branch. | 
-**url** | **String** | The URL of the Branch. | 
-**repository_id** | **Integer** | The ID of the Repository that contains the Branch. | 
-**created_at** | **DateTime** | The time/date the Branch was created. | 
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **entity_type** | **String** | A string description of this resource. |  |
+| **deleted** | **Boolean** | A true/false boolean indicating if the Branch has been deleted. |  |
+| **name** | **String** | The name of the Branch. |  |
+| **persistent** | **Boolean** | A true/false boolean indicating if the Branch is persistent; e.g. master. |  |
+| **updated_at** | **Time** | The time/date the Branch was updated. |  |
+| **pull_requests** | [**Array<PullRequest>**](PullRequest.md) | An array of PullRequests attached to the Branch (there is usually only one). |  |
+| **merged_branch_ids** | **Array<Integer>** | The IDs of the Branches the Branch has been merged into. |  |
+| **id** | **Integer** | The unique ID of the Branch. |  |
+| **url** | **String** | The URL of the Branch. |  |
+| **repository_id** | **Integer** | The ID of the Repository that contains the Branch. |  |
+| **created_at** | **Time** | The time/date the Branch was created. |  |
+
+## Example
+
+```ruby
+require 'shortcut_client_ruby'
+
+instance = Shortcut::Branch.new(
+  entity_type: null,
+  deleted: null,
+  name: null,
+  persistent: null,
+  updated_at: null,
+  pull_requests: null,
+  merged_branch_ids: null,
+  id: null,
+  url: null,
+  repository_id: null,
+  created_at: null
+)
+```
 

data/docs/Category.md

@@ -1,15 +1,34 @@
 # Shortcut::Category
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**archived** | **BOOLEAN** | A true/false boolean indicating if the Category has been archived. | 
-**entity_type** | **String** | A string description of this resource. | 
-**color** | **String** | The hex color to be displayed with the Category (for example, \"#ff0000\"). | 
-**name** | **String** | The name of the Category. | 
-**type** | **String** | The type of entity this Category is associated with; currently Milestone is the only type of Category. | 
-**updated_at** | **DateTime** | The time/date that the Category was updated. | 
-**external_id** | **String** | This field can be set to another unique ID. In the case that the Category has been imported from another tool, the ID in the other tool can be indicated here. | 
-**id** | **Integer** | The unique ID of the Category. | 
-**created_at** | **DateTime** | The time/date that the Category was created. | 
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **archived** | **Boolean** | A true/false boolean indicating if the Category has been archived. |  |
+| **entity_type** | **String** | A string description of this resource. |  |
+| **color** | **String** | The hex color to be displayed with the Category (for example, \"#ff0000\"). |  |
+| **name** | **String** | The name of the Category. |  |
+| **type** | **String** | The type of entity this Category is associated with; currently Milestone is the only type of Category. |  |
+| **updated_at** | **Time** | The time/date that the Category was updated. |  |
+| **external_id** | **String** | This field can be set to another unique ID. In the case that the Category has been imported from another tool, the ID in the other tool can be indicated here. |  |
+| **id** | **Integer** | The unique ID of the Category. |  |
+| **created_at** | **Time** | The time/date that the Category was created. |  |
+
+## Example
+
+```ruby
+require 'shortcut_client_ruby'
+
+instance = Shortcut::Category.new(
+  archived: null,
+  entity_type: null,
+  color: null,
+  name: null,
+  type: null,
+  updated_at: null,
+  external_id: null,
+  id: null,
+  created_at: null
+)
+```
 

data/docs/Commit.md

@@ -1,19 +1,42 @@
 # Shortcut::Commit
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**entity_type** | **String** | A string description of this resource. | 
-**author_id** | **String** | The ID of the Member that authored the Commit, if known. | 
-**hash** | **String** | The Commit hash. | 
-**updated_at** | **DateTime** | The time/date the Commit was updated. | 
-**merged_branch_ids** | **Array<Integer>** | The IDs of the Branches the Commit has been merged into. | 
-**id** | **Integer** | The unique ID of the Commit. | 
-**url** | **String** | The URL of the Commit. | 
-**author_email** | **String** | The email address of the VCS user that authored the Commit. | 
-**timestamp** | **DateTime** | The time/date the Commit was pushed. | 
-**author_identity** | [**Identity**](Identity.md) |  | 
-**repository_id** | **Integer** | The ID of the Repository that contains the Commit. | 
-**created_at** | **DateTime** | The time/date the Commit was created. | 
-**message** | **String** | The Commit message. | 
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **entity_type** | **String** | A string description of this resource. |  |
+| **author_id** | **String** | The ID of the Member that authored the Commit, if known. |  |
+| **hash** | **String** | The Commit hash. |  |
+| **updated_at** | **Time** | The time/date the Commit was updated. |  |
+| **merged_branch_ids** | **Array<Integer>** | The IDs of the Branches the Commit has been merged into. |  |
+| **id** | **Integer** | The unique ID of the Commit. |  |
+| **url** | **String** | The URL of the Commit. |  |
+| **author_email** | **String** | The email address of the VCS user that authored the Commit. |  |
+| **timestamp** | **Time** | The time/date the Commit was pushed. |  |
+| **author_identity** | [**Identity**](Identity.md) |  |  |
+| **repository_id** | **Integer** | The ID of the Repository that contains the Commit. |  |
+| **created_at** | **Time** | The time/date the Commit was created. |  |
+| **message** | **String** | The Commit message. |  |
+
+## Example
+
+```ruby
+require 'shortcut_client_ruby'
+
+instance = Shortcut::Commit.new(
+  entity_type: null,
+  author_id: null,
+  hash: null,
+  updated_at: null,
+  merged_branch_ids: null,
+  id: null,
+  url: null,
+  author_email: null,
+  timestamp: null,
+  author_identity: null,
+  repository_id: null,
+  created_at: null,
+  message: null
+)
+```
 

data/docs/CreateCategory.md

@@ -1,10 +1,24 @@
 # Shortcut::CreateCategory
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **String** | The name of the new Category. | 
-**color** | **String** | The hex color to be displayed with the Category (for example, \"#ff0000\"). | [optional] 
-**external_id** | **String** | This field can be set to another unique ID. In the case that the Category has been imported from another tool, the ID in the other tool can be indicated here. | [optional] 
-**type** | **String** | The type of entity this Category is associated with; currently Milestone is the only type of Category. | 
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The name of the new Category. |  |
+| **color** | **String** | The hex color to be displayed with the Category (for example, \"#ff0000\"). | [optional] |
+| **external_id** | **String** | This field can be set to another unique ID. In the case that the Category has been imported from another tool, the ID in the other tool can be indicated here. | [optional] |
+| **type** | **String** | The type of entity this Category is associated with; currently Milestone is the only type of Category. |  |
+
+## Example
+
+```ruby
+require 'shortcut_client_ruby'
+
+instance = Shortcut::CreateCategory.new(
+  name: null,
+  color: null,
+  external_id: null,
+  type: null
+)
+```
 

data/docs/CreateCategoryParams.md

@@ -1,9 +1,22 @@
 # Shortcut::CreateCategoryParams
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **String** | The name of the new Category. | 
-**color** | **String** | The hex color to be displayed with the Category (for example, \"#ff0000\"). | [optional] 
-**external_id** | **String** | This field can be set to another unique ID. In the case that the Category has been imported from another tool, the ID in the other tool can be indicated here. | [optional] 
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The name of the new Category. |  |
+| **color** | **String** | The hex color to be displayed with the Category (for example, \"#ff0000\"). | [optional] |
+| **external_id** | **String** | This field can be set to another unique ID. In the case that the Category 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::CreateCategoryParams.new(
+  name: null,
+  color: null,
+  external_id: null
+)
+```
 

data/docs/CreateCommentComment.md

@@ -1,11 +1,26 @@
 # Shortcut::CreateCommentComment
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**text** | **String** | The comment text. | 
-**author_id** | **String** | The Member ID of the Comment's author. Defaults to the user identified by the API token. | [optional] 
-**created_at** | **DateTime** | Defaults to the time/date the comment is created, but can be set to reflect another date. | [optional] 
-**updated_at** | **DateTime** | Defaults to the time/date the comment is last updated, but can be set to reflect another date. | [optional] 
-**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. | [optional] 
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **text** | **String** | The comment text. |  |
+| **author_id** | **String** | The Member ID of the Comment's author. Defaults to the user identified by the API token. | [optional] |
+| **created_at** | **Time** | Defaults to the time/date the comment is created, but can be set to reflect another date. | [optional] |
+| **updated_at** | **Time** | Defaults to the time/date the comment is last updated, but can be set to reflect another date. | [optional] |
+| **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. | [optional] |
+
+## Example
+
+```ruby
+require 'shortcut_client_ruby'
+
+instance = Shortcut::CreateCommentComment.new(
+  text: null,
+  author_id: null,
+  created_at: null,
+  updated_at: null,
+  external_id: null
+)
+```
 

data/docs/CreateEntityTemplate.md

@@ -1,9 +1,22 @@
 # Shortcut::CreateEntityTemplate
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **String** | The name of the new entity template | 
-**author_id** | **String** | The id of the user creating this template. | [optional] 
-**story_contents** | [**CreateStoryContents**](CreateStoryContents.md) |  | 
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The name of the new entity template |  |
+| **author_id** | **String** | The id of the user creating this template. | [optional] |
+| **story_contents** | [**CreateStoryContents**](CreateStoryContents.md) |  |  |
+
+## Example
+
+```ruby
+require 'shortcut_client_ruby'
+
+instance = Shortcut::CreateEntityTemplate.new(
+  name: null,
+  author_id: null,
+  story_contents: null
+)
+```
 

data/docs/CreateEpic.md

@@ -1,23 +1,50 @@
 # Shortcut::CreateEpic
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**description** | **String** | The Epic's description. | [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. | 
-**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] 
-**updated_at** | **DateTime** | Defaults to the time/date it is created but can be set to reflect another date. | [optional] 
-**follower_ids** | **Array<String>** | An array of UUIDs for any Members you want to add as Followers on this new Epic. | [optional] 
-**owner_ids** | **Array<String>** | An array of UUIDs for any members you want to add as Owners on this new Epic. | [optional] 
-**external_id** | **String** | This field can be set to another unique ID. In the case that the Epic has been imported from another tool, the ID in the other tool can be indicated here. | [optional] 
-**deadline** | **DateTime** | The Epic's deadline. | [optional] 
-**created_at** | **DateTime** | Defaults to the time/date it is created but can be set to reflect another date. | [optional] 
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **description** | **String** | The Epic's description. | [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. |  |
+| **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] |
+| **updated_at** | **Time** | Defaults to the time/date it is created but can be set to reflect another date. | [optional] |
+| **follower_ids** | **Array<String>** | An array of UUIDs for any Members you want to add as Followers on this new Epic. | [optional] |
+| **owner_ids** | **Array<String>** | An array of UUIDs for any members you want to add as Owners on this new Epic. | [optional] |
+| **external_id** | **String** | This field can be set to another unique ID. In the case that the Epic has been imported from another tool, the ID in the other tool can be indicated here. | [optional] |
+| **deadline** | **Time** | The Epic's deadline. | [optional] |
+| **created_at** | **Time** | Defaults to the time/date it is created but can be set to reflect another date. | [optional] |
+
+## Example
+
+```ruby
+require 'shortcut_client_ruby'
+
+instance = Shortcut::CreateEpic.new(
+  description: 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,
+  updated_at: null,
+  follower_ids: null,
+  owner_ids: null,
+  external_id: null,
+  deadline: null,
+  created_at: null
+)
+```
 

data/docs/CreateEpicComment.md

@@ -1,11 +1,26 @@
 # Shortcut::CreateEpicComment
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**text** | **String** | The comment text. | 
-**author_id** | **String** | The Member ID of the Comment's author. Defaults to the user identified by the API token. | [optional] 
-**created_at** | **DateTime** | Defaults to the time/date the comment is created, but can be set to reflect another date. | [optional] 
-**updated_at** | **DateTime** | Defaults to the time/date the comment is last updated, but can be set to reflect another date. | [optional] 
-**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. | [optional] 
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **text** | **String** | The comment text. |  |
+| **author_id** | **String** | The Member ID of the Comment's author. Defaults to the user identified by the API token. | [optional] |
+| **created_at** | **Time** | Defaults to the time/date the comment is created, but can be set to reflect another date. | [optional] |
+| **updated_at** | **Time** | Defaults to the time/date the comment is last updated, but can be set to reflect another date. | [optional] |
+| **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. | [optional] |
+
+## Example
+
+```ruby
+require 'shortcut_client_ruby'
+
+instance = Shortcut::CreateEpicComment.new(
+  text: null,
+  author_id: null,
+  created_at: null,
+  updated_at: null,
+  external_id: null
+)
+```
 

data/docs/CreateGroup.md

@@ -1,14 +1,32 @@
 # Shortcut::CreateGroup
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**description** | **String** | The description of the Group. | [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** | **String** | The name of this Group. | 
-**mention_name** | **String** | The mention name of this Group. | 
-**color** | **String** | The color you wish to use for the Group in the system. | [optional] 
-**color_key** | **String** | The color key 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] 
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **description** | **String** | The description of the Group. | [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** | **String** | The name of this Group. |  |
+| **mention_name** | **String** | The mention name of this Group. |  |
+| **color** | **String** | The color you wish to use for the Group in the system. | [optional] |
+| **color_key** | **String** | The color key 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] |
+
+## Example
+
+```ruby
+require 'shortcut_client_ruby'
+
+instance = Shortcut::CreateGroup.new(
+  description: null,
+  member_ids: null,
+  workflow_ids: null,
+  name: null,
+  mention_name: null,
+  color: null,
+  color_key: null,
+  display_icon_id: null
+)
+```
 

data/docs/CreateIteration.md

@@ -1,13 +1,30 @@
 # Shortcut::CreateIteration
 
 ## 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. | 
-**start_date** | **String** | The date this Iteration begins, e.g. 2019-07-01. | 
-**end_date** | **String** | The date this Iteration ends, e.g. 2019-07-01. | 
+
+| 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. |  |
+| **start_date** | **String** | The date this Iteration begins, e.g. 2019-07-01. |  |
+| **end_date** | **String** | The date this Iteration ends, e.g. 2019-07-01. |  |
+
+## Example
+
+```ruby
+require 'shortcut_client_ruby'
+
+instance = Shortcut::CreateIteration.new(
+  follower_ids: null,
+  group_ids: null,
+  labels: null,
+  description: null,
+  name: null,
+  start_date: null,
+  end_date: null
+)
+```
 

data/docs/CreateLabelParams.md

@@ -1,10 +1,24 @@
 # Shortcut::CreateLabelParams
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **String** | The name of the new Label. | 
-**description** | **String** | The description of the new Label. | [optional] 
-**color** | **String** | The hex color to be displayed with the Label (for example, \"#ff0000\"). | [optional] 
-**external_id** | **String** | This field can be set to another unique ID. In the case that the Label has been imported from another tool, the ID in the other tool can be indicated here. | [optional] 
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The name of the new Label. |  |
+| **description** | **String** | The description of the new Label. | [optional] |
+| **color** | **String** | The hex color to be displayed with the Label (for example, \"#ff0000\"). | [optional] |
+| **external_id** | **String** | This field can be set to another unique ID. In the case that the Label has been imported from another tool, the ID in the other tool can be indicated here. | [optional] |
+
+## Example
+
+```ruby
+require 'shortcut_client_ruby'
+
+instance = Shortcut::CreateLabelParams.new(
+  name: null,
+  description: null,
+  color: null,
+  external_id: null
+)
+```