https://github.com/semperos/shortcutclient.jl
Julia client for Shortcut's REST API v3
https://github.com/semperos/shortcutclient.jl
api-client julia julia-language openapi project-management shortcut-api shortcut-app
Last synced: 5 months ago
JSON representation
Julia client for Shortcut's REST API v3
- Host: GitHub
- URL: https://github.com/semperos/shortcutclient.jl
- Owner: semperos
- License: mit
- Created: 2024-12-28T06:50:19.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-12-30T21:12:27.000Z (6 months ago)
- Last Synced: 2025-02-19T02:49:29.365Z (5 months ago)
- Topics: api-client, julia, julia-language, openapi, project-management, shortcut-api, shortcut-app
- Language: Julia
- Homepage: https://juliahub.com/ui/Packages/General/ShortcutClient
- Size: 219 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ShortcutClient.jl—API Client for Shortcut's REST API v3
This client has been automatically generated using version 7.10.0 of the [openapi-generator](https://github.com/OpenAPITools/openapi-generator). See the [generate.sh](./generate.sh) script for details.
## Getting Started
Add `ShortcutClient` as a dependency to your Julia project:
```shell
$ julia --project
julia> ]
pkg> add ShortcutClient
```
Take the API for a spin:
```julia
import OpenAPI.Clients: Client
using ShortcutClient
api_token = ENV["SHORTCUT_API_TOKEN"]
client = Client("https://api.app.shortcut.com", headers=Dict("Shortcut-Token" => api_token))
api = DefaultApi(client)
# Example: Get info about owner of the token used to make API requests.
(member_info, resp) = get_current_member_info(api)
println("Member: $(member_info)")
```
## Rate Limiting
This library does not implement rate limiting. As of this writing, Shortcut warns that its rate limit is 200 requests per minute, after which point HTTP 429 responses will be returned.
## Resources
- [Shortcut REST API v3](https://developer.shortcut.com/api/rest/v3)
- [OpenAPI.jl](https://juliacomputing.github.io/OpenAPI.jl/stable/userguide/)
## API Endpoints
| Class | Method |
| ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| _DefaultApi_ | [**create_category**](docs/DefaultApi.md#create_category)
**POST** /api/v3/categories
Create Category |
| _DefaultApi_ | [**create_entity_template**](docs/DefaultApi.md#create_entity_template)
**POST** /api/v3/entity-templates
Create Entity Template |
| _DefaultApi_ | [**create_epic**](docs/DefaultApi.md#create_epic)
**POST** /api/v3/epics
Create Epic |
| _DefaultApi_ | [**create_epic_comment**](docs/DefaultApi.md#create_epic_comment)
**POST** /api/v3/epics/{epic-public-id}/comments
Create Epic Comment |
| _DefaultApi_ | [**create_epic_comment_comment**](docs/DefaultApi.md#create_epic_comment_comment)
**POST** /api/v3/epics/{epic-public-id}/comments/{comment-public-id}
Create Epic Comment Comment |
| _DefaultApi_ | [**create_group**](docs/DefaultApi.md#create_group)
**POST** /api/v3/groups
Create Group |
| _DefaultApi_ | [**create_iteration**](docs/DefaultApi.md#create_iteration)
**POST** /api/v3/iterations
Create Iteration |
| _DefaultApi_ | [**create_label**](docs/DefaultApi.md#create_label)
**POST** /api/v3/labels
Create Label |
| _DefaultApi_ | [**create_linked_file**](docs/DefaultApi.md#create_linked_file)
**POST** /api/v3/linked-files
Create Linked File |
| _DefaultApi_ | [**create_milestone**](docs/DefaultApi.md#create_milestone)
**POST** /api/v3/milestones
Create Milestone |
| _DefaultApi_ | [**create_multiple_stories**](docs/DefaultApi.md#create_multiple_stories)
**POST** /api/v3/stories/bulk
Create Multiple Stories |
| _DefaultApi_ | [**create_objective**](docs/DefaultApi.md#create_objective)
**POST** /api/v3/objectives
Create Objective |
| _DefaultApi_ | [**create_project**](docs/DefaultApi.md#create_project)
**POST** /api/v3/projects
Create Project |
| _DefaultApi_ | [**create_story**](docs/DefaultApi.md#create_story)
**POST** /api/v3/stories
Create Story |
| _DefaultApi_ | [**create_story_comment**](docs/DefaultApi.md#create_story_comment)
**POST** /api/v3/stories/{story-public-id}/comments
Create Story Comment |
| _DefaultApi_ | [**create_story_from_template**](docs/DefaultApi.md#create_story_from_template)
**POST** /api/v3/stories/from-template
Create Story From Template |
| _DefaultApi_ | [**create_story_link**](docs/DefaultApi.md#create_story_link)
**POST** /api/v3/story-links
Create Story Link |
| _DefaultApi_ | [**create_story_reaction**](docs/DefaultApi.md#create_story_reaction)
**POST** /api/v3/stories/{story-public-id}/comments/{comment-public-id}/reactions
Create Story Reaction |
| _DefaultApi_ | [**create_task**](docs/DefaultApi.md#create_task)
**POST** /api/v3/stories/{story-public-id}/tasks
Create Task |
| _DefaultApi_ | [**delete_category**](docs/DefaultApi.md#delete_category)
**DELETE** /api/v3/categories/{category-public-id}
Delete Category |
| _DefaultApi_ | [**delete_custom_field**](docs/DefaultApi.md#delete_custom_field)
**DELETE** /api/v3/custom-fields/{custom-field-public-id}
Delete Custom Field |
| _DefaultApi_ | [**delete_entity_template**](docs/DefaultApi.md#delete_entity_template)
**DELETE** /api/v3/entity-templates/{entity-template-public-id}
Delete Entity Template |
| _DefaultApi_ | [**delete_epic**](docs/DefaultApi.md#delete_epic)
**DELETE** /api/v3/epics/{epic-public-id}
Delete Epic |
| _DefaultApi_ | [**delete_epic_comment**](docs/DefaultApi.md#delete_epic_comment)
**DELETE** /api/v3/epics/{epic-public-id}/comments/{comment-public-id}
Delete Epic Comment |
| _DefaultApi_ | [**delete_file**](docs/DefaultApi.md#delete_file)
**DELETE** /api/v3/files/{file-public-id}
Delete File |
| _DefaultApi_ | [**delete_iteration**](docs/DefaultApi.md#delete_iteration)
**DELETE** /api/v3/iterations/{iteration-public-id}
Delete Iteration |
| _DefaultApi_ | [**delete_label**](docs/DefaultApi.md#delete_label)
**DELETE** /api/v3/labels/{label-public-id}
Delete Label |
| _DefaultApi_ | [**delete_linked_file**](docs/DefaultApi.md#delete_linked_file)
**DELETE** /api/v3/linked-files/{linked-file-public-id}
Delete Linked File |
| _DefaultApi_ | [**delete_milestone**](docs/DefaultApi.md#delete_milestone)
**DELETE** /api/v3/milestones/{milestone-public-id}
Delete Milestone |
| _DefaultApi_ | [**delete_multiple_stories**](docs/DefaultApi.md#delete_multiple_stories)
**DELETE** /api/v3/stories/bulk
Delete Multiple Stories |
| _DefaultApi_ | [**delete_objective**](docs/DefaultApi.md#delete_objective)
**DELETE** /api/v3/objectives/{objective-public-id}
Delete Objective |
| _DefaultApi_ | [**delete_project**](docs/DefaultApi.md#delete_project)
**DELETE** /api/v3/projects/{project-public-id}
Delete Project |
| _DefaultApi_ | [**delete_story**](docs/DefaultApi.md#delete_story)
**DELETE** /api/v3/stories/{story-public-id}
Delete Story |
| _DefaultApi_ | [**delete_story_comment**](docs/DefaultApi.md#delete_story_comment)
**DELETE** /api/v3/stories/{story-public-id}/comments/{comment-public-id}
Delete Story Comment |
| _DefaultApi_ | [**delete_story_link**](docs/DefaultApi.md#delete_story_link)
**DELETE** /api/v3/story-links/{story-link-public-id}
Delete Story Link |
| _DefaultApi_ | [**delete_story_reaction**](docs/DefaultApi.md#delete_story_reaction)
**DELETE** /api/v3/stories/{story-public-id}/comments/{comment-public-id}/reactions
Delete Story Reaction |
| _DefaultApi_ | [**delete_task**](docs/DefaultApi.md#delete_task)
**DELETE** /api/v3/stories/{story-public-id}/tasks/{task-public-id}
Delete Task |
| _DefaultApi_ | [**disable_iterations**](docs/DefaultApi.md#disable_iterations)
**PUT** /api/v3/iterations/disable
Disable Iterations |
| _DefaultApi_ | [**disable_story_templates**](docs/DefaultApi.md#disable_story_templates)
**PUT** /api/v3/entity-templates/disable
Disable Story Templates |
| _DefaultApi_ | [**enable_iterations**](docs/DefaultApi.md#enable_iterations)
**PUT** /api/v3/iterations/enable
Enable Iterations |
| _DefaultApi_ | [**enable_story_templates**](docs/DefaultApi.md#enable_story_templates)
**PUT** /api/v3/entity-templates/enable
Enable Story Templates |
| _DefaultApi_ | [**get_category**](docs/DefaultApi.md#get_category)
**GET** /api/v3/categories/{category-public-id}
Get Category |
| _DefaultApi_ | [**get_current_member_info**](docs/DefaultApi.md#get_current_member_info)
**GET** /api/v3/member
Get Current Member Info |
| _DefaultApi_ | [**get_custom_field**](docs/DefaultApi.md#get_custom_field)
**GET** /api/v3/custom-fields/{custom-field-public-id}
Get Custom Field |
| _DefaultApi_ | [**get_entity_template**](docs/DefaultApi.md#get_entity_template)
**GET** /api/v3/entity-templates/{entity-template-public-id}
Get Entity Template |
| _DefaultApi_ | [**get_epic**](docs/DefaultApi.md#get_epic)
**GET** /api/v3/epics/{epic-public-id}
Get Epic |
| _DefaultApi_ | [**get_epic_comment**](docs/DefaultApi.md#get_epic_comment)
**GET** /api/v3/epics/{epic-public-id}/comments/{comment-public-id}
Get Epic Comment |
| _DefaultApi_ | [**get_epic_workflow**](docs/DefaultApi.md#get_epic_workflow)
**GET** /api/v3/epic-workflow
Get Epic Workflow |
| _DefaultApi_ | [**get_external_link_stories**](docs/DefaultApi.md#get_external_link_stories)
**GET** /api/v3/external-link/stories
Get External Link Stories |
| _DefaultApi_ | [**get_file**](docs/DefaultApi.md#get_file)
**GET** /api/v3/files/{file-public-id}
Get File |
| _DefaultApi_ | [**get_group**](docs/DefaultApi.md#get_group)
**GET** /api/v3/groups/{group-public-id}
Get Group |
| _DefaultApi_ | [**get_iteration**](docs/DefaultApi.md#get_iteration)
**GET** /api/v3/iterations/{iteration-public-id}
Get Iteration |
| _DefaultApi_ | [**get_key_result**](docs/DefaultApi.md#get_key_result)
**GET** /api/v3/key-results/{key-result-public-id}
Get Key Result |
| _DefaultApi_ | [**get_label**](docs/DefaultApi.md#get_label)
**GET** /api/v3/labels/{label-public-id}
Get Label |
| _DefaultApi_ | [**get_linked_file**](docs/DefaultApi.md#get_linked_file)
**GET** /api/v3/linked-files/{linked-file-public-id}
Get Linked File |
| _DefaultApi_ | [**get_member**](docs/DefaultApi.md#get_member)
**GET** /api/v3/members/{member-public-id}
Get Member |
| _DefaultApi_ | [**get_milestone**](docs/DefaultApi.md#get_milestone)
**GET** /api/v3/milestones/{milestone-public-id}
Get Milestone |
| _DefaultApi_ | [**get_objective**](docs/DefaultApi.md#get_objective)
**GET** /api/v3/objectives/{objective-public-id}
Get Objective |
| _DefaultApi_ | [**get_project**](docs/DefaultApi.md#get_project)
**GET** /api/v3/projects/{project-public-id}
Get Project |
| _DefaultApi_ | [**get_repository**](docs/DefaultApi.md#get_repository)
**GET** /api/v3/repositories/{repo-public-id}
Get Repository |
| _DefaultApi_ | [**get_story**](docs/DefaultApi.md#get_story)
**GET** /api/v3/stories/{story-public-id}
Get Story |
| _DefaultApi_ | [**get_story_comment**](docs/DefaultApi.md#get_story_comment)
**GET** /api/v3/stories/{story-public-id}/comments/{comment-public-id}
Get Story Comment |
| _DefaultApi_ | [**get_story_link**](docs/DefaultApi.md#get_story_link)
**GET** /api/v3/story-links/{story-link-public-id}
Get Story Link |
| _DefaultApi_ | [**get_task**](docs/DefaultApi.md#get_task)
**GET** /api/v3/stories/{story-public-id}/tasks/{task-public-id}
Get Task |
| _DefaultApi_ | [**get_workflow**](docs/DefaultApi.md#get_workflow)
**GET** /api/v3/workflows/{workflow-public-id}
Get Workflow |
| _DefaultApi_ | [**list_categories**](docs/DefaultApi.md#list_categories)
**GET** /api/v3/categories
List Categories |
| _DefaultApi_ | [**list_category_milestones**](docs/DefaultApi.md#list_category_milestones)
**GET** /api/v3/categories/{category-public-id}/milestones
List Category Milestones |
| _DefaultApi_ | [**list_category_objectives**](docs/DefaultApi.md#list_category_objectives)
**GET** /api/v3/categories/{category-public-id}/objectives
List Category Objectives |
| _DefaultApi_ | [**list_custom_fields**](docs/DefaultApi.md#list_custom_fields)
**GET** /api/v3/custom-fields
List Custom Fields |
| _DefaultApi_ | [**list_entity_templates**](docs/DefaultApi.md#list_entity_templates)
**GET** /api/v3/entity-templates
List Entity Templates |
| _DefaultApi_ | [**list_epic_comments**](docs/DefaultApi.md#list_epic_comments)
**GET** /api/v3/epics/{epic-public-id}/comments
List Epic Comments |
| _DefaultApi_ | [**list_epic_stories**](docs/DefaultApi.md#list_epic_stories)
**GET** /api/v3/epics/{epic-public-id}/stories
List Epic Stories |
| _DefaultApi_ | [**list_epics**](docs/DefaultApi.md#list_epics)
**GET** /api/v3/epics
List Epics |
| _DefaultApi_ | [**list_files**](docs/DefaultApi.md#list_files)
**GET** /api/v3/files
List Files |
| _DefaultApi_ | [**list_group_stories**](docs/DefaultApi.md#list_group_stories)
**GET** /api/v3/groups/{group-public-id}/stories
List Group Stories |
| _DefaultApi_ | [**list_groups**](docs/DefaultApi.md#list_groups)
**GET** /api/v3/groups
List Groups |
| _DefaultApi_ | [**list_iteration_stories**](docs/DefaultApi.md#list_iteration_stories)
**GET** /api/v3/iterations/{iteration-public-id}/stories
List Iteration Stories |
| _DefaultApi_ | [**list_iterations**](docs/DefaultApi.md#list_iterations)
**GET** /api/v3/iterations
List Iterations |
| _DefaultApi_ | [**list_label_epics**](docs/DefaultApi.md#list_label_epics)
**GET** /api/v3/labels/{label-public-id}/epics
List Label Epics |
| _DefaultApi_ | [**list_label_stories**](docs/DefaultApi.md#list_label_stories)
**GET** /api/v3/labels/{label-public-id}/stories
List Label Stories |
| _DefaultApi_ | [**list_labels**](docs/DefaultApi.md#list_labels)
**GET** /api/v3/labels
List Labels |
| _DefaultApi_ | [**list_linked_files**](docs/DefaultApi.md#list_linked_files)
**GET** /api/v3/linked-files
List Linked Files |
| _DefaultApi_ | [**list_members**](docs/DefaultApi.md#list_members)
**GET** /api/v3/members
List Members |
| _DefaultApi_ | [**list_milestone_epics**](docs/DefaultApi.md#list_milestone_epics)
**GET** /api/v3/milestones/{milestone-public-id}/epics
List Milestone Epics |
| _DefaultApi_ | [**list_milestones**](docs/DefaultApi.md#list_milestones)
**GET** /api/v3/milestones
List Milestones |
| _DefaultApi_ | [**list_objective_epics**](docs/DefaultApi.md#list_objective_epics)
**GET** /api/v3/objectives/{objective-public-id}/epics
List Objective Epics |
| _DefaultApi_ | [**list_objectives**](docs/DefaultApi.md#list_objectives)
**GET** /api/v3/objectives
List Objectives |
| _DefaultApi_ | [**list_projects**](docs/DefaultApi.md#list_projects)
**GET** /api/v3/projects
List Projects |
| _DefaultApi_ | [**list_repositories**](docs/DefaultApi.md#list_repositories)
**GET** /api/v3/repositories
List Repositories |
| _DefaultApi_ | [**list_stories**](docs/DefaultApi.md#list_stories)
**GET** /api/v3/projects/{project-public-id}/stories
List Stories |
| _DefaultApi_ | [**list_story_comment**](docs/DefaultApi.md#list_story_comment)
**GET** /api/v3/stories/{story-public-id}/comments
List Story Comment |
| _DefaultApi_ | [**list_workflows**](docs/DefaultApi.md#list_workflows)
**GET** /api/v3/workflows
List Workflows |
| _DefaultApi_ | [**search**](docs/DefaultApi.md#search)
**GET** /api/v3/search
Search |
| _DefaultApi_ | [**search_epics**](docs/DefaultApi.md#search_epics)
**GET** /api/v3/search/epics
Search Epics |
| _DefaultApi_ | [**search_iterations**](docs/DefaultApi.md#search_iterations)
**GET** /api/v3/search/iterations
Search Iterations |
| _DefaultApi_ | [**search_milestones**](docs/DefaultApi.md#search_milestones)
**GET** /api/v3/search/milestones
Search Milestones |
| _DefaultApi_ | [**search_objectives**](docs/DefaultApi.md#search_objectives)
**GET** /api/v3/search/objectives
Search Objectives |
| _DefaultApi_ | [**search_stories**](docs/DefaultApi.md#search_stories)
**GET** /api/v3/search/stories
Search Stories |
| _DefaultApi_ | [**search_stories_old**](docs/DefaultApi.md#search_stories_old)
**POST** /api/v3/stories/search
Search Stories (Old) |
| _DefaultApi_ | [**story_history**](docs/DefaultApi.md#story_history)
**GET** /api/v3/stories/{story-public-id}/history
Story History |
| _DefaultApi_ | [**unlink_comment_thread_from_slack**](docs/DefaultApi.md#unlink_comment_thread_from_slack)
**POST** /api/v3/stories/{story-public-id}/comments/{comment-public-id}/unlink-from-slack
Unlink Comment thread from Slack |
| _DefaultApi_ | [**unlink_productboard_from_epic**](docs/DefaultApi.md#unlink_productboard_from_epic)
**POST** /api/v3/epics/{epic-public-id}/unlink-productboard
Unlink Productboard from Epic |
| _DefaultApi_ | [**update_category**](docs/DefaultApi.md#update_category)
**PUT** /api/v3/categories/{category-public-id}
Update Category |
| _DefaultApi_ | [**update_custom_field**](docs/DefaultApi.md#update_custom_field)
**PUT** /api/v3/custom-fields/{custom-field-public-id}
Update Custom Field |
| _DefaultApi_ | [**update_entity_template**](docs/DefaultApi.md#update_entity_template)
**PUT** /api/v3/entity-templates/{entity-template-public-id}
Update Entity Template |
| _DefaultApi_ | [**update_epic**](docs/DefaultApi.md#update_epic)
**PUT** /api/v3/epics/{epic-public-id}
Update Epic |
| _DefaultApi_ | [**update_epic_comment**](docs/DefaultApi.md#update_epic_comment)
**PUT** /api/v3/epics/{epic-public-id}/comments/{comment-public-id}
Update Epic Comment |
| _DefaultApi_ | [**update_file**](docs/DefaultApi.md#update_file)
**PUT** /api/v3/files/{file-public-id}
Update File |
| _DefaultApi_ | [**update_group**](docs/DefaultApi.md#update_group)
**PUT** /api/v3/groups/{group-public-id}
Update Group |
| _DefaultApi_ | [**update_iteration**](docs/DefaultApi.md#update_iteration)
**PUT** /api/v3/iterations/{iteration-public-id}
Update Iteration |
| _DefaultApi_ | [**update_key_result**](docs/DefaultApi.md#update_key_result)
**PUT** /api/v3/key-results/{key-result-public-id}
Update Key Result |
| _DefaultApi_ | [**update_label**](docs/DefaultApi.md#update_label)
**PUT** /api/v3/labels/{label-public-id}
Update Label |
| _DefaultApi_ | [**update_linked_file**](docs/DefaultApi.md#update_linked_file)
**PUT** /api/v3/linked-files/{linked-file-public-id}
Update Linked File |
| _DefaultApi_ | [**update_milestone**](docs/DefaultApi.md#update_milestone)
**PUT** /api/v3/milestones/{milestone-public-id}
Update Milestone |
| _DefaultApi_ | [**update_multiple_stories**](docs/DefaultApi.md#update_multiple_stories)
**PUT** /api/v3/stories/bulk
Update Multiple Stories |
| _DefaultApi_ | [**update_objective**](docs/DefaultApi.md#update_objective)
**PUT** /api/v3/objectives/{objective-public-id}
Update Objective |
| _DefaultApi_ | [**update_project**](docs/DefaultApi.md#update_project)
**PUT** /api/v3/projects/{project-public-id}
Update Project |
| _DefaultApi_ | [**update_story**](docs/DefaultApi.md#update_story)
**PUT** /api/v3/stories/{story-public-id}
Update Story |
| _DefaultApi_ | [**update_story_comment**](docs/DefaultApi.md#update_story_comment)
**PUT** /api/v3/stories/{story-public-id}/comments/{comment-public-id}
Update Story Comment |
| _DefaultApi_ | [**update_story_link**](docs/DefaultApi.md#update_story_link)
**PUT** /api/v3/story-links/{story-link-public-id}
Update Story Link |
| _DefaultApi_ | [**update_task**](docs/DefaultApi.md#update_task)
**PUT** /api/v3/stories/{story-public-id}/tasks/{task-public-id}
Update Task |
| _DefaultApi_ | [**upload_files**](docs/DefaultApi.md#upload_files)
**POST** /api/v3/files
Upload Files |
## Models
- [BaseTaskParams](docs/BaseTaskParams.md)
- [BasicWorkspaceInfo](docs/BasicWorkspaceInfo.md)
- [Branch](docs/Branch.md)
- [Category](docs/Category.md)
- [Commit](docs/Commit.md)
- [CreateCategory](docs/CreateCategory.md)
- [CreateCategoryParams](docs/CreateCategoryParams.md)
- [CreateCommentComment](docs/CreateCommentComment.md)
- [CreateEntityTemplate](docs/CreateEntityTemplate.md)
- [CreateEpic](docs/CreateEpic.md)
- [CreateEpicComment](docs/CreateEpicComment.md)
- [CreateGroup](docs/CreateGroup.md)
- [CreateIteration](docs/CreateIteration.md)
- [CreateLabelParams](docs/CreateLabelParams.md)
- [CreateLinkedFile](docs/CreateLinkedFile.md)
- [CreateMilestone](docs/CreateMilestone.md)
- [CreateObjective](docs/CreateObjective.md)
- [CreateOrDeleteStoryReaction](docs/CreateOrDeleteStoryReaction.md)
- [CreateProject](docs/CreateProject.md)
- [CreateStories](docs/CreateStories.md)
- [CreateStoryComment](docs/CreateStoryComment.md)
- [CreateStoryCommentParams](docs/CreateStoryCommentParams.md)
- [CreateStoryContents](docs/CreateStoryContents.md)
- [CreateStoryFromTemplateParams](docs/CreateStoryFromTemplateParams.md)
- [CreateStoryLink](docs/CreateStoryLink.md)
- [CreateStoryLinkParams](docs/CreateStoryLinkParams.md)
- [CreateStoryParams](docs/CreateStoryParams.md)
- [CreateSubTaskParams](docs/CreateSubTaskParams.md)
- [CreateTask](docs/CreateTask.md)
- [CreateTaskParams](docs/CreateTaskParams.md)
- [CustomField](docs/CustomField.md)
- [CustomFieldEnumValue](docs/CustomFieldEnumValue.md)
- [CustomFieldValueParams](docs/CustomFieldValueParams.md)
- [DataConflictError](docs/DataConflictError.md)
- [DeleteStories](docs/DeleteStories.md)
- [EntityTemplate](docs/EntityTemplate.md)
- [Epic](docs/Epic.md)
- [EpicAssociatedGroup](docs/EpicAssociatedGroup.md)
- [EpicSearchResult](docs/EpicSearchResult.md)
- [EpicSearchResults](docs/EpicSearchResults.md)
- [EpicSlim](docs/EpicSlim.md)
- [EpicState](docs/EpicState.md)
- [EpicStats](docs/EpicStats.md)
- [EpicWorkflow](docs/EpicWorkflow.md)
- [Group](docs/Group.md)
- [History](docs/History.md)
- [HistoryActionBranchCreate](docs/HistoryActionBranchCreate.md)
- [HistoryActionBranchMerge](docs/HistoryActionBranchMerge.md)
- [HistoryActionBranchPush](docs/HistoryActionBranchPush.md)
- [HistoryActionLabelCreate](docs/HistoryActionLabelCreate.md)
- [HistoryActionLabelDelete](docs/HistoryActionLabelDelete.md)
- [HistoryActionLabelUpdate](docs/HistoryActionLabelUpdate.md)
- [HistoryActionProjectUpdate](docs/HistoryActionProjectUpdate.md)
- [HistoryActionPullRequest](docs/HistoryActionPullRequest.md)
- [HistoryActionStoryCommentCreate](docs/HistoryActionStoryCommentCreate.md)
- [HistoryActionStoryCreate](docs/HistoryActionStoryCreate.md)
- [HistoryActionStoryDelete](docs/HistoryActionStoryDelete.md)
- [HistoryActionStoryLinkCreate](docs/HistoryActionStoryLinkCreate.md)
- [HistoryActionStoryLinkDelete](docs/HistoryActionStoryLinkDelete.md)
- [HistoryActionStoryLinkUpdate](docs/HistoryActionStoryLinkUpdate.md)
- [HistoryActionStoryUpdate](docs/HistoryActionStoryUpdate.md)
- [HistoryActionTaskCreate](docs/HistoryActionTaskCreate.md)
- [HistoryActionTaskDelete](docs/HistoryActionTaskDelete.md)
- [HistoryActionTaskUpdate](docs/HistoryActionTaskUpdate.md)
- [HistoryActionWorkspace2BulkUpdate](docs/HistoryActionWorkspace2BulkUpdate.md)
- [HistoryChangesStory](docs/HistoryChangesStory.md)
- [HistoryChangesStoryLink](docs/HistoryChangesStoryLink.md)
- [HistoryChangesTask](docs/HistoryChangesTask.md)
- [HistoryReferenceBranch](docs/HistoryReferenceBranch.md)
- [HistoryReferenceCommit](docs/HistoryReferenceCommit.md)
- [HistoryReferenceCustomFieldEnumValue](docs/HistoryReferenceCustomFieldEnumValue.md)
- [HistoryReferenceEpic](docs/HistoryReferenceEpic.md)
- [HistoryReferenceGeneral](docs/HistoryReferenceGeneral.md)
- [HistoryReferenceGroup](docs/HistoryReferenceGroup.md)
- [HistoryReferenceIteration](docs/HistoryReferenceIteration.md)
- [HistoryReferenceLabel](docs/HistoryReferenceLabel.md)
- [HistoryReferenceProject](docs/HistoryReferenceProject.md)
- [HistoryReferenceStory](docs/HistoryReferenceStory.md)
- [HistoryReferenceStoryTask](docs/HistoryReferenceStoryTask.md)
- [HistoryReferenceWorkflowState](docs/HistoryReferenceWorkflowState.md)
- [Icon](docs/Icon.md)
- [Identity](docs/Identity.md)
- [Iteration](docs/Iteration.md)
- [IterationAssociatedGroup](docs/IterationAssociatedGroup.md)
- [IterationSearchResults](docs/IterationSearchResults.md)
- [IterationSlim](docs/IterationSlim.md)
- [IterationStats](docs/IterationStats.md)
- [KeyResult](docs/KeyResult.md)
- [KeyResultValue](docs/KeyResultValue.md)
- [Label](docs/Label.md)
- [LabelSlim](docs/LabelSlim.md)
- [LabelStats](docs/LabelStats.md)
- [LinkedFile](docs/LinkedFile.md)
- [MaxSearchResultsExceededError](docs/MaxSearchResultsExceededError.md)
- [Member](docs/Member.md)
- [MemberInfo](docs/MemberInfo.md)
- [Milestone](docs/Milestone.md)
- [MilestoneStats](docs/MilestoneStats.md)
- [Objective](docs/Objective.md)
- [ObjectiveSearchResult](docs/ObjectiveSearchResult.md)
- [ObjectiveSearchResults](docs/ObjectiveSearchResults.md)
- [ObjectiveStats](docs/ObjectiveStats.md)
- [Profile](docs/Profile.md)
- [Project](docs/Project.md)
- [ProjectStats](docs/ProjectStats.md)
- [PullRequest](docs/PullRequest.md)
- [PullRequestLabel](docs/PullRequestLabel.md)
- [RemoveCustomFieldParams](docs/RemoveCustomFieldParams.md)
- [RemoveLabelParams](docs/RemoveLabelParams.md)
- [Repository](docs/Repository.md)
- [SearchResults](docs/SearchResults.md)
- [SearchStories](docs/SearchStories.md)
- [Story](docs/Story.md)
- [StoryComment](docs/StoryComment.md)
- [StoryContents](docs/StoryContents.md)
- [StoryContentsTask](docs/StoryContentsTask.md)
- [StoryCustomField](docs/StoryCustomField.md)
- [StoryHistoryChangeAddsRemovesInt](docs/StoryHistoryChangeAddsRemovesInt.md)
- [StoryHistoryChangeAddsRemovesUuid](docs/StoryHistoryChangeAddsRemovesUuid.md)
- [StoryHistoryChangeOldNewBool](docs/StoryHistoryChangeOldNewBool.md)
- [StoryHistoryChangeOldNewInt](docs/StoryHistoryChangeOldNewInt.md)
- [StoryHistoryChangeOldNewStr](docs/StoryHistoryChangeOldNewStr.md)
- [StoryHistoryChangeOldNewUuid](docs/StoryHistoryChangeOldNewUuid.md)
- [StoryLink](docs/StoryLink.md)
- [StoryReaction](docs/StoryReaction.md)
- [StorySearchResult](docs/StorySearchResult.md)
- [StorySearchResults](docs/StorySearchResults.md)
- [StorySlim](docs/StorySlim.md)
- [StoryStats](docs/StoryStats.md)
- [SyncedItem](docs/SyncedItem.md)
- [Task](docs/Task.md)
- [ThreadedComment](docs/ThreadedComment.md)
- [TypedStoryLink](docs/TypedStoryLink.md)
- [UnusableEntitlementError](docs/UnusableEntitlementError.md)
- [UpdateCategory](docs/UpdateCategory.md)
- [UpdateComment](docs/UpdateComment.md)
- [UpdateCustomField](docs/UpdateCustomField.md)
- [UpdateCustomFieldEnumValue](docs/UpdateCustomFieldEnumValue.md)
- [UpdateEntityTemplate](docs/UpdateEntityTemplate.md)
- [UpdateEpic](docs/UpdateEpic.md)
- [UpdateFile](docs/UpdateFile.md)
- [UpdateGroup](docs/UpdateGroup.md)
- [UpdateIteration](docs/UpdateIteration.md)
- [UpdateKeyResult](docs/UpdateKeyResult.md)
- [UpdateLabel](docs/UpdateLabel.md)
- [UpdateLinkedFile](docs/UpdateLinkedFile.md)
- [UpdateMilestone](docs/UpdateMilestone.md)
- [UpdateObjective](docs/UpdateObjective.md)
- [UpdateProject](docs/UpdateProject.md)
- [UpdateStories](docs/UpdateStories.md)
- [UpdateStory](docs/UpdateStory.md)
- [UpdateStoryComment](docs/UpdateStoryComment.md)
- [UpdateStoryContents](docs/UpdateStoryContents.md)
- [UpdateStoryLink](docs/UpdateStoryLink.md)
- [UpdateTask](docs/UpdateTask.md)
- [UploadedFile](docs/UploadedFile.md)
- [Workflow](docs/Workflow.md)
- [WorkflowState](docs/WorkflowState.md)
## License
Copyright 2024–2025 Daniel Gregoire
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.