@shortcut/client 1.1.0

package/lib/generated/Api.d.ts

@@ -0,0 +1,1042 @@
+import { Category, CreateCategory, CreateCommentComment, CreateEntityTemplate, CreateEpic, CreateEpicComment, CreateGroup, CreateIteration, CreateLabelParams, CreateLinkedFile, CreateMilestone, CreateOrDeleteStoryReaction, CreateProject, CreateStories, CreateStoryComment, CreateStoryLink, CreateStoryParams, CreateTask, CustomField, DeleteStories, EntityTemplate, Epic, EpicSearchResults, EpicSlim, EpicWorkflow, GetEpicStories, GetExternalLinkStoriesParams, GetIterationStories, GetLabelStories, GetMember, GetProjectStories, Group, History, Iteration, IterationSearchResults, IterationSlim, Label, LinkedFile, ListEpics, ListGroupStories, ListLabels, ListMembers, Member, MemberInfo, Milestone, MilestoneSearchResults, Project, Repository, Search, SearchResults, SearchStories, Story, StoryComment, StoryLink, StoryReaction, StorySearchResults, StorySlim, Task, ThreadedComment, UpdateCategory, UpdateComment, UpdateCustomField, UpdateEntityTemplate, UpdateEpic, UpdateFile, UpdateGroup, UpdateIteration, UpdateLabel, UpdateLinkedFile, UpdateMilestone, UpdateProject, UpdateStories, UpdateStory, UpdateStoryComment, UpdateStoryLink, UpdateTask, UploadedFile, Workflow } from './data-contracts';
+import { HttpClient, RequestParams } from './http-client';
+/**
+ * Please don't use this class directly, instead use the `ShortcutClient` class we provided which is extending this class to add headers for authorization. * @internal
+ * @private
+ */
+export declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataType> {
+    /**
+     * @description List Categories returns a list of all Categories and their attributes.
+     *
+     * @name ListCategories
+     * @summary List Categories
+     * @request GET:/api/v3/categories
+     * @secure
+     */
+    listCategories: (params?: RequestParams) => Promise<import("axios").AxiosResponse<Category[], any>>;
+    /**
+     * @description Create Category allows you to create a new Category in Shortcut.
+     *
+     * @name CreateCategory
+     * @summary Create Category
+     * @request POST:/api/v3/categories
+     * @secure
+     */
+    createCategory: (CreateCategory: CreateCategory, params?: RequestParams) => Promise<import("axios").AxiosResponse<Category, any>>;
+    /**
+     * @description Get Category returns information about the selected Category.
+     *
+     * @name GetCategory
+     * @summary Get Category
+     * @request GET:/api/v3/categories/{category-public-id}
+     * @secure
+     */
+    getCategory: (categoryPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<Category, any>>;
+    /**
+     * @description Update Category allows you to replace a Category name with another name. If you try to name a Category something that already exists, you will receive a 422 response.
+     *
+     * @name UpdateCategory
+     * @summary Update Category
+     * @request PUT:/api/v3/categories/{category-public-id}
+     * @secure
+     */
+    updateCategory: (categoryPublicId: number, UpdateCategory: UpdateCategory, params?: RequestParams) => Promise<import("axios").AxiosResponse<Category, any>>;
+    /**
+     * @description Delete Category can be used to delete any Category.
+     *
+     * @name DeleteCategory
+     * @summary Delete Category
+     * @request DELETE:/api/v3/categories/{category-public-id}
+     * @secure
+     */
+    deleteCategory: (categoryPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * @description List Category Milestones returns a list of all Milestones with the Category.
+     *
+     * @name ListCategoryMilestones
+     * @summary List Category Milestones
+     * @request GET:/api/v3/categories/{category-public-id}/milestones
+     * @secure
+     */
+    listCategoryMilestones: (categoryPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<Milestone[], any>>;
+    /**
+     * No description
+     *
+     * @name ListCustomFields
+     * @summary List Custom Fields
+     * @request GET:/api/v3/custom-fields
+     * @secure
+     */
+    listCustomFields: (params?: RequestParams) => Promise<import("axios").AxiosResponse<CustomField[], any>>;
+    /**
+     * No description
+     *
+     * @name GetCustomField
+     * @summary Get Custom Field
+     * @request GET:/api/v3/custom-fields/{custom-field-public-id}
+     * @secure
+     */
+    getCustomField: (customFieldPublicId: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<CustomField, any>>;
+    /**
+     * @description Update Custom Field can be used to update the definition of a Custom Field. The order of items in the 'values' collection is interpreted to be their ascending sort order.To delete an existing enum value, simply omit it from the 'values' collection. New enum values may be created inline by including an object in the 'values' collection having a 'value' entry with no 'id' (eg. {'value': 'myNewValue', 'color_key': 'green'}).
+     *
+     * @name UpdateCustomField
+     * @summary Update Custom Field
+     * @request PUT:/api/v3/custom-fields/{custom-field-public-id}
+     * @secure
+     */
+    updateCustomField: (customFieldPublicId: string, UpdateCustomField: UpdateCustomField, params?: RequestParams) => Promise<import("axios").AxiosResponse<CustomField, any>>;
+    /**
+     * No description
+     *
+     * @name DeleteCustomField
+     * @summary Delete Custom Field
+     * @request DELETE:/api/v3/custom-fields/{custom-field-public-id}
+     * @secure
+     */
+    deleteCustomField: (customFieldPublicId: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * @description List all the entity templates for the Workspace.
+     *
+     * @name ListEntityTemplates
+     * @summary List Entity Templates
+     * @request GET:/api/v3/entity-templates
+     * @secure
+     */
+    listEntityTemplates: (params?: RequestParams) => Promise<import("axios").AxiosResponse<EntityTemplate[], any>>;
+    /**
+     * @description Create a new entity template for the Workspace.
+     *
+     * @name CreateEntityTemplate
+     * @summary Create Entity Template
+     * @request POST:/api/v3/entity-templates
+     * @secure
+     */
+    createEntityTemplate: (CreateEntityTemplate: CreateEntityTemplate, params?: RequestParams) => Promise<import("axios").AxiosResponse<EntityTemplate, any>>;
+    /**
+     * @description Disables the Story Template feature for the Workspace.
+     *
+     * @name DisableStoryTemplates
+     * @summary Disable Story Templates
+     * @request PUT:/api/v3/entity-templates/disable
+     * @secure
+     */
+    disableStoryTemplates: (params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * @description Enables the Story Template feature for the Workspace.
+     *
+     * @name EnableStoryTemplates
+     * @summary Enable Story Templates
+     * @request PUT:/api/v3/entity-templates/enable
+     * @secure
+     */
+    enableStoryTemplates: (params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * @description Get Entity Template returns information about a given entity template.
+     *
+     * @name GetEntityTemplate
+     * @summary Get Entity Template
+     * @request GET:/api/v3/entity-templates/{entity-template-public-id}
+     * @secure
+     */
+    getEntityTemplate: (entityTemplatePublicId: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<EntityTemplate, any>>;
+    /**
+     * @description Update an entity template's name or its contents.
+     *
+     * @name UpdateEntityTemplate
+     * @summary Update Entity Template
+     * @request PUT:/api/v3/entity-templates/{entity-template-public-id}
+     * @secure
+     */
+    updateEntityTemplate: (entityTemplatePublicId: string, UpdateEntityTemplate: UpdateEntityTemplate, params?: RequestParams) => Promise<import("axios").AxiosResponse<EntityTemplate, any>>;
+    /**
+     * No description
+     *
+     * @name DeleteEntityTemplate
+     * @summary Delete Entity Template
+     * @request DELETE:/api/v3/entity-templates/{entity-template-public-id}
+     * @secure
+     */
+    deleteEntityTemplate: (entityTemplatePublicId: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * @description Returns the Epic Workflow for the Workspace.
+     *
+     * @name GetEpicWorkflow
+     * @summary Get Epic Workflow
+     * @request GET:/api/v3/epic-workflow
+     * @secure
+     */
+    getEpicWorkflow: (params?: RequestParams) => Promise<import("axios").AxiosResponse<EpicWorkflow, any>>;
+    /**
+     * @description List Epics returns a list of all Epics and their attributes.
+     *
+     * @name ListEpics
+     * @summary List Epics
+     * @request GET:/api/v3/epics
+     * @secure
+     */
+    listEpics: (ListEpics: ListEpics, params?: RequestParams) => Promise<import("axios").AxiosResponse<EpicSlim[], any>>;
+    /**
+     * @description Create Epic allows you to create a new Epic in Shortcut.
+     *
+     * @name CreateEpic
+     * @summary Create Epic
+     * @request POST:/api/v3/epics
+     * @secure
+     */
+    createEpic: (CreateEpic: CreateEpic, params?: RequestParams) => Promise<import("axios").AxiosResponse<Epic, any>>;
+    /**
+     * @description Get Epic returns information about the selected Epic.
+     *
+     * @name GetEpic
+     * @summary Get Epic
+     * @request GET:/api/v3/epics/{epic-public-id}
+     * @secure
+     */
+    getEpic: (epicPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<Epic, any>>;
+    /**
+     * @description Update Epic can be used to update numerous fields in the Epic. The only required parameter is Epic ID, which can be found in the Shortcut UI.
+     *
+     * @name UpdateEpic
+     * @summary Update Epic
+     * @request PUT:/api/v3/epics/{epic-public-id}
+     * @secure
+     */
+    updateEpic: (epicPublicId: number, UpdateEpic: UpdateEpic, params?: RequestParams) => Promise<import("axios").AxiosResponse<Epic, any>>;
+    /**
+     * @description Delete Epic can be used to delete the Epic. The only required parameter is Epic ID.
+     *
+     * @name DeleteEpic
+     * @summary Delete Epic
+     * @request DELETE:/api/v3/epics/{epic-public-id}
+     * @secure
+     */
+    deleteEpic: (epicPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * @description Get a list of all Comments on an Epic.
+     *
+     * @name ListEpicComments
+     * @summary List Epic Comments
+     * @request GET:/api/v3/epics/{epic-public-id}/comments
+     * @secure
+     */
+    listEpicComments: (epicPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<ThreadedComment[], any>>;
+    /**
+     * @description This endpoint allows you to create a threaded Comment on an Epic.
+     *
+     * @name CreateEpicComment
+     * @summary Create Epic Comment
+     * @request POST:/api/v3/epics/{epic-public-id}/comments
+     * @secure
+     */
+    createEpicComment: (epicPublicId: number, CreateEpicComment: CreateEpicComment, params?: RequestParams) => Promise<import("axios").AxiosResponse<ThreadedComment, any>>;
+    /**
+     * @description This endpoint allows you to create a nested Comment reply to an existing Epic Comment.
+     *
+     * @name CreateEpicCommentComment
+     * @summary Create Epic Comment Comment
+     * @request POST:/api/v3/epics/{epic-public-id}/comments/{comment-public-id}
+     * @secure
+     */
+    createEpicCommentComment: (epicPublicId: number, commentPublicId: number, CreateCommentComment: CreateCommentComment, params?: RequestParams) => Promise<import("axios").AxiosResponse<ThreadedComment, any>>;
+    /**
+     * @description This endpoint returns information about the selected Epic Comment.
+     *
+     * @name GetEpicComment
+     * @summary Get Epic Comment
+     * @request GET:/api/v3/epics/{epic-public-id}/comments/{comment-public-id}
+     * @secure
+     */
+    getEpicComment: (epicPublicId: number, commentPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<ThreadedComment, any>>;
+    /**
+     * @description This endpoint allows you to update a threaded Comment on an Epic.
+     *
+     * @name UpdateEpicComment
+     * @summary Update Epic Comment
+     * @request PUT:/api/v3/epics/{epic-public-id}/comments/{comment-public-id}
+     * @secure
+     */
+    updateEpicComment: (epicPublicId: number, commentPublicId: number, UpdateComment: UpdateComment, params?: RequestParams) => Promise<import("axios").AxiosResponse<ThreadedComment, any>>;
+    /**
+     * @description This endpoint allows you to delete a Comment from an Epic.
+     *
+     * @name DeleteEpicComment
+     * @summary Delete Epic Comment
+     * @request DELETE:/api/v3/epics/{epic-public-id}/comments/{comment-public-id}
+     * @secure
+     */
+    deleteEpicComment: (epicPublicId: number, commentPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * @description Get a list of all Stories in an Epic.
+     *
+     * @name ListEpicStories
+     * @summary List Epic Stories
+     * @request GET:/api/v3/epics/{epic-public-id}/stories
+     * @secure
+     */
+    listEpicStories: (epicPublicId: number, GetEpicStories: GetEpicStories, params?: RequestParams) => Promise<import("axios").AxiosResponse<StorySlim[], any>>;
+    /**
+     * @description This endpoint allows you to unlink a productboard epic.
+     *
+     * @name UnlinkProductboardFromEpic
+     * @summary Unlink Productboard from Epic
+     * @request POST:/api/v3/epics/{epic-public-id}/unlink-productboard
+     * @secure
+     */
+    unlinkProductboardFromEpic: (epicPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * @description Get Stories which have a given External Link associated with them.
+     *
+     * @name GetExternalLinkStories
+     * @summary Get External Link Stories
+     * @request GET:/api/v3/external-link/stories
+     * @secure
+     */
+    getExternalLinkStories: (GetExternalLinkStoriesParams: GetExternalLinkStoriesParams, params?: RequestParams) => Promise<import("axios").AxiosResponse<StorySlim[], any>>;
+    /**
+     * @description List Files returns a list of all UploadedFiles in the workspace.
+     *
+     * @name ListFiles
+     * @summary List Files
+     * @request GET:/api/v3/files
+     * @secure
+     */
+    listFiles: (params?: RequestParams) => Promise<import("axios").AxiosResponse<UploadedFile[], any>>;
+    /**
+     * @description Upload Files uploads one or many files and optionally associates them with a story. Use the multipart/form-data content-type to upload. Each `file` key should contain a separate file. Each UploadedFile's name comes from the Content-Disposition header "filename" directive for that field.
+     *
+     * @name UploadFiles
+     * @summary Upload Files
+     * @request POST:/api/v3/files
+     * @secure
+     */
+    uploadFiles: (data: {
+        /**
+         * The story ID that these files will be associated with.
+         * @format int64
+         */
+        story_id?: number;
+        /**
+         * A file upload. At least one is required.
+         * @format binary
+         */
+        file0: File;
+        /**
+         * Optional additional files.
+         * @format binary
+         */
+        file1?: File;
+        /**
+         * Optional additional files.
+         * @format binary
+         */
+        file2?: File;
+        /**
+         * Optional additional files.
+         * @format binary
+         */
+        file3?: File;
+    }, params?: RequestParams) => Promise<import("axios").AxiosResponse<UploadedFile[], any>>;
+    /**
+     * @description Get File returns information about the selected UploadedFile.
+     *
+     * @name GetFile
+     * @summary Get File
+     * @request GET:/api/v3/files/{file-public-id}
+     * @secure
+     */
+    getFile: (filePublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<UploadedFile, any>>;
+    /**
+     * @description Update File updates the properties of an UploadedFile (but not its content).
+     *
+     * @name UpdateFile
+     * @summary Update File
+     * @request PUT:/api/v3/files/{file-public-id}
+     * @secure
+     */
+    updateFile: (filePublicId: number, UpdateFile: UpdateFile, params?: RequestParams) => Promise<import("axios").AxiosResponse<UploadedFile, any>>;
+    /**
+     * @description Delete File deletes a previously uploaded file.
+     *
+     * @name DeleteFile
+     * @summary Delete File
+     * @request DELETE:/api/v3/files/{file-public-id}
+     * @secure
+     */
+    deleteFile: (filePublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * @description A group in our API maps to a "Team" within the Shortcut Product. A Team is a collection of Users that can be associated to Stories, Epics, and Iterations within Shortcut.
+     *
+     * @name ListGroups
+     * @summary List Groups
+     * @request GET:/api/v3/groups
+     * @secure
+     */
+    listGroups: (params?: RequestParams) => Promise<import("axios").AxiosResponse<Group[], any>>;
+    /**
+     * No description
+     *
+     * @name CreateGroup
+     * @summary Create Group
+     * @request POST:/api/v3/groups
+     * @secure
+     */
+    createGroup: (CreateGroup: CreateGroup, params?: RequestParams) => Promise<import("axios").AxiosResponse<Group, any>>;
+    /**
+     * @description Disables Groups for the current workspace2
+     *
+     * @name DisableGroups
+     * @summary Disable Groups
+     * @request PUT:/api/v3/groups/disable
+     * @secure
+     */
+    disableGroups: (params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * @description Enables Groups for the current workspace2
+     *
+     * @name EnableGroups
+     * @summary Enable Groups
+     * @request PUT:/api/v3/groups/enable
+     * @secure
+     */
+    enableGroups: (params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * No description
+     *
+     * @name GetGroup
+     * @summary Get Group
+     * @request GET:/api/v3/groups/{group-public-id}
+     * @secure
+     */
+    getGroup: (groupPublicId: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<Group, any>>;
+    /**
+     * No description
+     *
+     * @name UpdateGroup
+     * @summary Update Group
+     * @request PUT:/api/v3/groups/{group-public-id}
+     * @secure
+     */
+    updateGroup: (groupPublicId: string, UpdateGroup: UpdateGroup, params?: RequestParams) => Promise<import("axios").AxiosResponse<Group, any>>;
+    /**
+     * @description List the Stories assigned to the Group. (By default, limited to 1,000).
+     *
+     * @name ListGroupStories
+     * @summary List Group Stories
+     * @request GET:/api/v3/groups/{group-public-id}/stories
+     * @secure
+     */
+    listGroupStories: (groupPublicId: string, ListGroupStories: ListGroupStories, params?: RequestParams) => Promise<import("axios").AxiosResponse<StorySlim[], any>>;
+    /**
+     * No description
+     *
+     * @name ListIterations
+     * @summary List Iterations
+     * @request GET:/api/v3/iterations
+     * @secure
+     */
+    listIterations: (params?: RequestParams) => Promise<import("axios").AxiosResponse<IterationSlim[], any>>;
+    /**
+     * No description
+     *
+     * @name CreateIteration
+     * @summary Create Iteration
+     * @request POST:/api/v3/iterations
+     * @secure
+     */
+    createIteration: (CreateIteration: CreateIteration, params?: RequestParams) => Promise<import("axios").AxiosResponse<Iteration, any>>;
+    /**
+     * @description Disables Iterations for the current workspace
+     *
+     * @name DisableIterations
+     * @summary Disable Iterations
+     * @request PUT:/api/v3/iterations/disable
+     * @secure
+     */
+    disableIterations: (params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * @description Enables Iterations for the current workspace
+     *
+     * @name EnableIterations
+     * @summary Enable Iterations
+     * @request PUT:/api/v3/iterations/enable
+     * @secure
+     */
+    enableIterations: (params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * No description
+     *
+     * @name GetIteration
+     * @summary Get Iteration
+     * @request GET:/api/v3/iterations/{iteration-public-id}
+     * @secure
+     */
+    getIteration: (iterationPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<Iteration, any>>;
+    /**
+     * No description
+     *
+     * @name UpdateIteration
+     * @summary Update Iteration
+     * @request PUT:/api/v3/iterations/{iteration-public-id}
+     * @secure
+     */
+    updateIteration: (iterationPublicId: number, UpdateIteration: UpdateIteration, params?: RequestParams) => Promise<import("axios").AxiosResponse<Iteration, any>>;
+    /**
+     * No description
+     *
+     * @name DeleteIteration
+     * @summary Delete Iteration
+     * @request DELETE:/api/v3/iterations/{iteration-public-id}
+     * @secure
+     */
+    deleteIteration: (iterationPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * @description Get a list of all Stories in an Iteration.
+     *
+     * @name ListIterationStories
+     * @summary List Iteration Stories
+     * @request GET:/api/v3/iterations/{iteration-public-id}/stories
+     * @secure
+     */
+    listIterationStories: (iterationPublicId: number, GetIterationStories: GetIterationStories, params?: RequestParams) => Promise<import("axios").AxiosResponse<StorySlim[], any>>;
+    /**
+     * @description List Labels returns a list of all Labels and their attributes.
+     *
+     * @name ListLabels
+     * @summary List Labels
+     * @request GET:/api/v3/labels
+     * @secure
+     */
+    listLabels: (ListLabels: ListLabels, params?: RequestParams) => Promise<import("axios").AxiosResponse<Label[], any>>;
+    /**
+     * @description Create Label allows you to create a new Label in Shortcut.
+     *
+     * @name CreateLabel
+     * @summary Create Label
+     * @request POST:/api/v3/labels
+     * @secure
+     */
+    createLabel: (CreateLabelParams: CreateLabelParams, params?: RequestParams) => Promise<import("axios").AxiosResponse<Label, any>>;
+    /**
+     * @description Get Label returns information about the selected Label.
+     *
+     * @name GetLabel
+     * @summary Get Label
+     * @request GET:/api/v3/labels/{label-public-id}
+     * @secure
+     */
+    getLabel: (labelPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<Label, any>>;
+    /**
+     * @description Update Label allows you to replace a Label name with another name. If you try to name a Label something that already exists, you will receive a 422 response.
+     *
+     * @name UpdateLabel
+     * @summary Update Label
+     * @request PUT:/api/v3/labels/{label-public-id}
+     * @secure
+     */
+    updateLabel: (labelPublicId: number, UpdateLabel: UpdateLabel, params?: RequestParams) => Promise<import("axios").AxiosResponse<Label, any>>;
+    /**
+     * @description Delete Label can be used to delete any Label.
+     *
+     * @name DeleteLabel
+     * @summary Delete Label
+     * @request DELETE:/api/v3/labels/{label-public-id}
+     * @secure
+     */
+    deleteLabel: (labelPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * @description List all of the Epics with the Label.
+     *
+     * @name ListLabelEpics
+     * @summary List Label Epics
+     * @request GET:/api/v3/labels/{label-public-id}/epics
+     * @secure
+     */
+    listLabelEpics: (labelPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<EpicSlim[], any>>;
+    /**
+     * @description List all of the Stories with the Label.
+     *
+     * @name ListLabelStories
+     * @summary List Label Stories
+     * @request GET:/api/v3/labels/{label-public-id}/stories
+     * @secure
+     */
+    listLabelStories: (labelPublicId: number, GetLabelStories: GetLabelStories, params?: RequestParams) => Promise<import("axios").AxiosResponse<StorySlim[], any>>;
+    /**
+     * @description List Linked Files returns a list of all Linked-Files and their attributes.
+     *
+     * @name ListLinkedFiles
+     * @summary List Linked Files
+     * @request GET:/api/v3/linked-files
+     * @secure
+     */
+    listLinkedFiles: (params?: RequestParams) => Promise<import("axios").AxiosResponse<LinkedFile[], any>>;
+    /**
+     * @description Create Linked File allows you to create a new Linked File in Shortcut.
+     *
+     * @name CreateLinkedFile
+     * @summary Create Linked File
+     * @request POST:/api/v3/linked-files
+     * @secure
+     */
+    createLinkedFile: (CreateLinkedFile: CreateLinkedFile, params?: RequestParams) => Promise<import("axios").AxiosResponse<LinkedFile, any>>;
+    /**
+     * @description Get File returns information about the selected Linked File.
+     *
+     * @name GetLinkedFile
+     * @summary Get Linked File
+     * @request GET:/api/v3/linked-files/{linked-file-public-id}
+     * @secure
+     */
+    getLinkedFile: (linkedFilePublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<LinkedFile, any>>;
+    /**
+     * @description Updated Linked File allows you to update properties of a previously attached Linked-File.
+     *
+     * @name UpdateLinkedFile
+     * @summary Update Linked File
+     * @request PUT:/api/v3/linked-files/{linked-file-public-id}
+     * @secure
+     */
+    updateLinkedFile: (linkedFilePublicId: number, UpdateLinkedFile: UpdateLinkedFile, params?: RequestParams) => Promise<import("axios").AxiosResponse<LinkedFile, any>>;
+    /**
+     * @description Delete Linked File can be used to delete any previously attached Linked-File.
+     *
+     * @name DeleteLinkedFile
+     * @summary Delete Linked File
+     * @request DELETE:/api/v3/linked-files/{linked-file-public-id}
+     * @secure
+     */
+    deleteLinkedFile: (linkedFilePublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * @description Returns information about the authenticated member.
+     *
+     * @name GetCurrentMemberInfo
+     * @summary Get Current Member Info
+     * @request GET:/api/v3/member
+     * @secure
+     */
+    getCurrentMemberInfo: (params?: RequestParams) => Promise<import("axios").AxiosResponse<MemberInfo, any>>;
+    /**
+     * @description Returns information about members of the Workspace.
+     *
+     * @name ListMembers
+     * @summary List Members
+     * @request GET:/api/v3/members
+     * @secure
+     */
+    listMembers: (ListMembers: ListMembers, params?: RequestParams) => Promise<import("axios").AxiosResponse<Member[], any>>;
+    /**
+     * @description Returns information about a Member.
+     *
+     * @name GetMember
+     * @summary Get Member
+     * @request GET:/api/v3/members/{member-public-id}
+     * @secure
+     */
+    getMember: (memberPublicId: string, GetMember: GetMember, params?: RequestParams) => Promise<import("axios").AxiosResponse<Member, any>>;
+    /**
+     * @description List Milestones returns a list of all Milestones and their attributes.
+     *
+     * @name ListMilestones
+     * @summary List Milestones
+     * @request GET:/api/v3/milestones
+     * @secure
+     */
+    listMilestones: (params?: RequestParams) => Promise<import("axios").AxiosResponse<Milestone[], any>>;
+    /**
+     * @description Create Milestone allows you to create a new Milestone in Shortcut.
+     *
+     * @name CreateMilestone
+     * @summary Create Milestone
+     * @request POST:/api/v3/milestones
+     * @secure
+     */
+    createMilestone: (CreateMilestone: CreateMilestone, params?: RequestParams) => Promise<import("axios").AxiosResponse<Milestone, any>>;
+    /**
+     * @description Get Milestone returns information about a chosen Milestone.
+     *
+     * @name GetMilestone
+     * @summary Get Milestone
+     * @request GET:/api/v3/milestones/{milestone-public-id}
+     * @secure
+     */
+    getMilestone: (milestonePublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<Milestone, any>>;
+    /**
+     * @description Update Milestone can be used to update Milestone properties.
+     *
+     * @name UpdateMilestone
+     * @summary Update Milestone
+     * @request PUT:/api/v3/milestones/{milestone-public-id}
+     * @secure
+     */
+    updateMilestone: (milestonePublicId: number, UpdateMilestone: UpdateMilestone, params?: RequestParams) => Promise<import("axios").AxiosResponse<Milestone, any>>;
+    /**
+     * @description Delete Milestone can be used to delete any Milestone.
+     *
+     * @name DeleteMilestone
+     * @summary Delete Milestone
+     * @request DELETE:/api/v3/milestones/{milestone-public-id}
+     * @secure
+     */
+    deleteMilestone: (milestonePublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * @description List all of the Epics within the Milestone.
+     *
+     * @name ListMilestoneEpics
+     * @summary List Milestone Epics
+     * @request GET:/api/v3/milestones/{milestone-public-id}/epics
+     * @secure
+     */
+    listMilestoneEpics: (milestonePublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<EpicSlim[], any>>;
+    /**
+     * @description List Projects returns a list of all Projects and their attributes.
+     *
+     * @name ListProjects
+     * @summary List Projects
+     * @request GET:/api/v3/projects
+     * @secure
+     */
+    listProjects: (params?: RequestParams) => Promise<import("axios").AxiosResponse<Project[], any>>;
+    /**
+     * @description Create Project is used to create a new Shortcut Project.
+     *
+     * @name CreateProject
+     * @summary Create Project
+     * @request POST:/api/v3/projects
+     * @secure
+     */
+    createProject: (CreateProject: CreateProject, params?: RequestParams) => Promise<import("axios").AxiosResponse<Project, any>>;
+    /**
+     * @description Get Project returns information about the selected Project.
+     *
+     * @name GetProject
+     * @summary Get Project
+     * @request GET:/api/v3/projects/{project-public-id}
+     * @secure
+     */
+    getProject: (projectPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<Project, any>>;
+    /**
+     * @description Update Project can be used to change properties of a Project.
+     *
+     * @name UpdateProject
+     * @summary Update Project
+     * @request PUT:/api/v3/projects/{project-public-id}
+     * @secure
+     */
+    updateProject: (projectPublicId: number, UpdateProject: UpdateProject, params?: RequestParams) => Promise<import("axios").AxiosResponse<Project, any>>;
+    /**
+     * @description Delete Project can be used to delete a Project. Projects can only be deleted if all associated Stories are moved or deleted. In the case that the Project cannot be deleted, you will receive a 422 response.
+     *
+     * @name DeleteProject
+     * @summary Delete Project
+     * @request DELETE:/api/v3/projects/{project-public-id}
+     * @secure
+     */
+    deleteProject: (projectPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * @description List Stories returns a list of all Stories in a selected Project and their attributes.
+     *
+     * @name ListStories
+     * @summary List Stories
+     * @request GET:/api/v3/projects/{project-public-id}/stories
+     * @secure
+     */
+    listStories: (projectPublicId: number, GetProjectStories: GetProjectStories, params?: RequestParams) => Promise<import("axios").AxiosResponse<StorySlim[], any>>;
+    /**
+     * @description List Repositories returns a list of all Repositories and their attributes.
+     *
+     * @name ListRepositories
+     * @summary List Repositories
+     * @request GET:/api/v3/repositories
+     * @secure
+     */
+    listRepositories: (params?: RequestParams) => Promise<import("axios").AxiosResponse<Repository[], any>>;
+    /**
+     * @description Get Repository returns information about the selected Repository.
+     *
+     * @name GetRepository
+     * @summary Get Repository
+     * @request GET:/api/v3/repositories/{repo-public-id}
+     * @secure
+     */
+    getRepository: (repoPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<Repository, any>>;
+    /**
+     * @description Search lets you search Epics and Stories based on desired parameters. Since ordering of the results can change over time (due to search ranking decay, new Epics and Stories being created), the `next` value from the previous response can be used as the path and query string for the next page to ensure stable ordering.
+     *
+     * @name Search
+     * @summary Search
+     * @request GET:/api/v3/search
+     * @secure
+     */
+    search: (Search: Search, params?: RequestParams) => Promise<import("axios").AxiosResponse<SearchResults, any>>;
+    /**
+     * @description Search Epics lets you search Epics based on desired parameters. Since ordering of stories can change over time (due to search ranking decay, new Epics being created), the `next` value from the previous response can be used as the path and query string for the next page to ensure stable ordering.
+     *
+     * @name SearchEpics
+     * @summary Search Epics
+     * @request GET:/api/v3/search/epics
+     * @secure
+     */
+    searchEpics: (Search: Search, params?: RequestParams) => Promise<import("axios").AxiosResponse<EpicSearchResults, any>>;
+    /**
+     * @description Search Iterations lets you search Iterations based on desired parameters. Since ordering of results can change over time (due to search ranking decay, new Iterations being created), the `next` value from the previous response can be used as the path and query string for the next page to ensure stable ordering.
+     *
+     * @name SearchIterations
+     * @summary Search Iterations
+     * @request GET:/api/v3/search/iterations
+     * @secure
+     */
+    searchIterations: (Search: Search, params?: RequestParams) => Promise<import("axios").AxiosResponse<IterationSearchResults, any>>;
+    /**
+     * @description Search Milestones lets you search Milestones based on desired parameters. Since ordering of results can change over time (due to search ranking decay, new Milestones being created), the `next` value from the previous response can be used as the path and query string for the next page to ensure stable ordering.
+     *
+     * @name SearchMilestones
+     * @summary Search Milestones
+     * @request GET:/api/v3/search/milestones
+     * @secure
+     */
+    searchMilestones: (Search: Search, params?: RequestParams) => Promise<import("axios").AxiosResponse<MilestoneSearchResults, any>>;
+    /**
+     * @description Search Stories lets you search Stories based on desired parameters. Since ordering of stories can change over time (due to search ranking decay, new stories being created), the `next` value from the previous response can be used as the path and query string for the next page to ensure stable ordering.
+     *
+     * @name SearchStories
+     * @summary Search Stories
+     * @request GET:/api/v3/search/stories
+     * @secure
+     */
+    searchStories: (Search: Search, params?: RequestParams) => Promise<import("axios").AxiosResponse<StorySearchResults, any>>;
+    /**
+     * @description Create Story is used to add a new story to your Shortcut.
+     *
+     * @name CreateStory
+     * @summary Create Story
+     * @request POST:/api/v3/stories
+     * @secure
+     */
+    createStory: (CreateStoryParams: CreateStoryParams, params?: RequestParams) => Promise<import("axios").AxiosResponse<Story, any>>;
+    /**
+     * @description Create Multiple Stories allows you to create multiple stories in a single request using the same syntax as [Create Story](https://developer.shortcut.com/api/rest/v3#create-story).
+     *
+     * @name CreateMultipleStories
+     * @summary Create Multiple Stories
+     * @request POST:/api/v3/stories/bulk
+     * @secure
+     */
+    createMultipleStories: (CreateStories: CreateStories, params?: RequestParams) => Promise<import("axios").AxiosResponse<StorySlim[], any>>;
+    /**
+     * @description Update Multiple Stories allows you to make changes to numerous stories at once.
+     *
+     * @name UpdateMultipleStories
+     * @summary Update Multiple Stories
+     * @request PUT:/api/v3/stories/bulk
+     * @secure
+     */
+    updateMultipleStories: (UpdateStories: UpdateStories, params?: RequestParams) => Promise<import("axios").AxiosResponse<StorySlim[], any>>;
+    /**
+     * @description Delete Multiple Stories allows you to delete multiple archived stories at once.
+     *
+     * @name DeleteMultipleStories
+     * @summary Delete Multiple Stories
+     * @request DELETE:/api/v3/stories/bulk
+     * @secure
+     */
+    deleteMultipleStories: (DeleteStories: DeleteStories, params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * @description Search Stories lets you search Stories based on desired parameters.
+     *
+     * @name SearchStoriesOld
+     * @summary Search Stories (Old)
+     * @request POST:/api/v3/stories/search
+     * @secure
+     */
+    searchStoriesOld: (SearchStories: SearchStories, params?: RequestParams) => Promise<import("axios").AxiosResponse<StorySlim[], any>>;
+    /**
+     * @description Get Story returns information about a chosen Story.
+     *
+     * @name GetStory
+     * @summary Get Story
+     * @request GET:/api/v3/stories/{story-public-id}
+     * @secure
+     */
+    getStory: (storyPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<Story, any>>;
+    /**
+     * @description Update Story can be used to update Story properties.
+     *
+     * @name UpdateStory
+     * @summary Update Story
+     * @request PUT:/api/v3/stories/{story-public-id}
+     * @secure
+     */
+    updateStory: (storyPublicId: number, UpdateStory: UpdateStory, params?: RequestParams) => Promise<import("axios").AxiosResponse<Story, any>>;
+    /**
+     * @description Delete Story can be used to delete any Story.
+     *
+     * @name DeleteStory
+     * @summary Delete Story
+     * @request DELETE:/api/v3/stories/{story-public-id}
+     * @secure
+     */
+    deleteStory: (storyPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * @description Lists Comments associated with a Story
+     *
+     * @name ListStoryComment
+     * @summary List Story Comment
+     * @request GET:/api/v3/stories/{story-public-id}/comments
+     * @secure
+     */
+    listStoryComment: (storyPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<StoryComment[], any>>;
+    /**
+     * @description Create Comment allows you to create a Comment on any Story.
+     *
+     * @name CreateStoryComment
+     * @summary Create Story Comment
+     * @request POST:/api/v3/stories/{story-public-id}/comments
+     * @secure
+     */
+    createStoryComment: (storyPublicId: number, CreateStoryComment: CreateStoryComment, params?: RequestParams) => Promise<import("axios").AxiosResponse<StoryComment, any>>;
+    /**
+     * @description Get Comment is used to get Comment information.
+     *
+     * @name GetStoryComment
+     * @summary Get Story Comment
+     * @request GET:/api/v3/stories/{story-public-id}/comments/{comment-public-id}
+     * @secure
+     */
+    getStoryComment: (storyPublicId: number, commentPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<StoryComment, any>>;
+    /**
+     * @description Update Comment replaces the text of the existing Comment.
+     *
+     * @name UpdateStoryComment
+     * @summary Update Story Comment
+     * @request PUT:/api/v3/stories/{story-public-id}/comments/{comment-public-id}
+     * @secure
+     */
+    updateStoryComment: (storyPublicId: number, commentPublicId: number, UpdateStoryComment: UpdateStoryComment, params?: RequestParams) => Promise<import("axios").AxiosResponse<StoryComment, any>>;
+    /**
+     * @description Delete a Comment from any story.
+     *
+     * @name DeleteStoryComment
+     * @summary Delete Story Comment
+     * @request DELETE:/api/v3/stories/{story-public-id}/comments/{comment-public-id}
+     * @secure
+     */
+    deleteStoryComment: (storyPublicId: number, commentPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * @description Create a reaction to a story comment.
+     *
+     * @name CreateStoryReaction
+     * @summary Create Story Reaction
+     * @request POST:/api/v3/stories/{story-public-id}/comments/{comment-public-id}/reactions
+     * @secure
+     */
+    createStoryReaction: (storyPublicId: number, commentPublicId: number, CreateOrDeleteStoryReaction: CreateOrDeleteStoryReaction, params?: RequestParams) => Promise<import("axios").AxiosResponse<StoryReaction[], any>>;
+    /**
+     * @description Delete a reaction from any story comment.
+     *
+     * @name DeleteStoryReaction
+     * @summary Delete Story Reaction
+     * @request DELETE:/api/v3/stories/{story-public-id}/comments/{comment-public-id}/reactions
+     * @secure
+     */
+    deleteStoryReaction: (storyPublicId: number, commentPublicId: number, CreateOrDeleteStoryReaction: CreateOrDeleteStoryReaction, params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * No description
+     *
+     * @name StoryHistory
+     * @summary Story History
+     * @request GET:/api/v3/stories/{story-public-id}/history
+     * @secure
+     */
+    storyHistory: (storyPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<History[], any>>;
+    /**
+     * @description Create Task is used to create a new task in a Story.
+     *
+     * @name CreateTask
+     * @summary Create Task
+     * @request POST:/api/v3/stories/{story-public-id}/tasks
+     * @secure
+     */
+    createTask: (storyPublicId: number, CreateTask: CreateTask, params?: RequestParams) => Promise<import("axios").AxiosResponse<Task, any>>;
+    /**
+     * @description Returns information about a chosen Task.
+     *
+     * @name GetTask
+     * @summary Get Task
+     * @request GET:/api/v3/stories/{story-public-id}/tasks/{task-public-id}
+     * @secure
+     */
+    getTask: (storyPublicId: number, taskPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<Task, any>>;
+    /**
+     * @description Update Task can be used to update Task properties.
+     *
+     * @name UpdateTask
+     * @summary Update Task
+     * @request PUT:/api/v3/stories/{story-public-id}/tasks/{task-public-id}
+     * @secure
+     */
+    updateTask: (storyPublicId: number, taskPublicId: number, UpdateTask: UpdateTask, params?: RequestParams) => Promise<import("axios").AxiosResponse<Task, any>>;
+    /**
+     * @description Delete Task can be used to delete any previously created Task on a Story.
+     *
+     * @name DeleteTask
+     * @summary Delete Task
+     * @request DELETE:/api/v3/stories/{story-public-id}/tasks/{task-public-id}
+     * @secure
+     */
+    deleteTask: (storyPublicId: number, taskPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * @description Story Links (called Story Relationships in the UI) allow you create semantic relationships between two stories. The parameters read like an active voice grammatical sentence:  subject -> verb -> object. The subject story acts on the object Story; the object story is the direct object of the sentence. The subject story "blocks", "duplicates", or "relates to" the object story.  Examples: - "story 5 blocks story 6” -- story 6 is now "blocked" until story 5 is moved to a Done workflow state. - "story 2 duplicates story 1” -- Story 2 represents the same body of work as Story 1 (and should probably be archived). - "story 7 relates to story 3”
+     *
+     * @name CreateStoryLink
+     * @summary Create Story Link
+     * @request POST:/api/v3/story-links
+     * @secure
+     */
+    createStoryLink: (CreateStoryLink: CreateStoryLink, params?: RequestParams) => Promise<import("axios").AxiosResponse<StoryLink, any>>;
+    /**
+     * @description Returns the stories and their relationship for the given Story Link.
+     *
+     * @name GetStoryLink
+     * @summary Get Story Link
+     * @request GET:/api/v3/story-links/{story-link-public-id}
+     * @secure
+     */
+    getStoryLink: (storyLinkPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<StoryLink, any>>;
+    /**
+     * @description Updates the stories and/or the relationship for the given Story Link.
+     *
+     * @name UpdateStoryLink
+     * @summary Update Story Link
+     * @request PUT:/api/v3/story-links/{story-link-public-id}
+     * @secure
+     */
+    updateStoryLink: (storyLinkPublicId: number, UpdateStoryLink: UpdateStoryLink, params?: RequestParams) => Promise<import("axios").AxiosResponse<StoryLink, any>>;
+    /**
+     * @description Removes the relationship between the stories for the given Story Link.
+     *
+     * @name DeleteStoryLink
+     * @summary Delete Story Link
+     * @request DELETE:/api/v3/story-links/{story-link-public-id}
+     * @secure
+     */
+    deleteStoryLink: (storyLinkPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * @description Returns a list of all Workflows in the Workspace.
+     *
+     * @name ListWorkflows
+     * @summary List Workflows
+     * @request GET:/api/v3/workflows
+     * @secure
+     */
+    listWorkflows: (params?: RequestParams) => Promise<import("axios").AxiosResponse<Workflow[], any>>;
+    /**
+     * @description Get Workflow returns information about a chosen Workflow.
+     *
+     * @name GetWorkflow
+     * @summary Get Workflow
+     * @request GET:/api/v3/workflows/{workflow-public-id}
+     * @secure
+     */
+    getWorkflow: (workflowPublicId: number, params?: RequestParams) => Promise<import("axios").AxiosResponse<Workflow, any>>;
+}