msn/clickup-openapi

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

1.0.0 2023-11-21 13:03 UTC

This package is auto-updated.

Last update: 2024-05-21 14:09:54 UTC


README

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

Installation & Usage

Requirements

PHP 7.4 and later. Should also work with PHP 8.0.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/msn/clickup-openapi.git"
    }
  ],
  "require": {
    "msn/clickup-openapi": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/clickup/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');





$apiInstance = new Msn\Apis\Clickup\Api\AttachmentsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$attachment = "/path/to/file.txt"; // \SplFileObject

try {
    $apiInstance->apiV2TaskTaskIdAttachmentPost($attachment);
} catch (Exception $e) {
    echo 'Exception when calling AttachmentsApi->apiV2TaskTaskIdAttachmentPost: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://api.clickup.com

Class Method HTTP request Description
AttachmentsApi apiV2TaskTaskIdAttachmentPost POST /api/v2/task/task_id/attachment Create Task Attachment
AuthorizationApi apiV2OauthTokenPost POST /api/v2/oauth/token Get Access Token
AuthorizationApi apiV2UserGet GET /api/v2/user Get Authorized User
ChecklistsApi apiV2ChecklistChecklistIdChecklistItemChecklistItemIdDelete DELETE /api/v2/checklist/checklist_id/checklist_item/checklist_item_id Delete Checklist Item
ChecklistsApi apiV2ChecklistChecklistIdChecklistItemChecklistItemIdPut PUT /api/v2/checklist/checklist_id/checklist_item/checklist_item_id Edit Checklist Item
ChecklistsApi apiV2ChecklistChecklistIdChecklistItemPost POST /api/v2/checklist/checklist_id/checklist_item Create Checklist Item
ChecklistsApi apiV2ChecklistChecklistIdDelete DELETE /api/v2/checklist/checklist_id Delete Checklist
ChecklistsApi apiV2ChecklistChecklistIdPut PUT /api/v2/checklist/checklist_id Edit Checklist
ChecklistsApi apiV2TaskTaskIdChecklistPost POST /api/v2/task/task_id/checklist Create Checklist
CommentsApi apiV2CommentCommentIdDelete DELETE /api/v2/comment/comment_id Delete Comment
CommentsApi apiV2CommentCommentIdPut PUT /api/v2/comment/comment_id Update Comment
CommentsApi apiV2ListListIdCommentGet GET /api/v2/list/list_id/comment Get List Comments
CommentsApi apiV2ListListIdCommentPost POST /api/v2/list/list_id/comment Create List Comment
CommentsApi apiV2TaskTaskIdCommentGet GET /api/v2/task/task_id/comment Get Task Comments
CommentsApi apiV2TaskTaskIdCommentPost POST /api/v2/task/task_id/comment Create Task Comment
CommentsApi apiV2ViewViewIdCommentGet GET /api/v2/view/view_id/comment Get Chat View Comments
CommentsApi apiV2ViewViewIdCommentPost POST /api/v2/view/view_id/comment Create Chat View Comment
CustomFieldsApi apiV2ListListIdFieldGet GET /api/v2/list/list_id/field Get Accessible Custom Fields
CustomFieldsApi apiV2TaskTaskIdFieldFieldIdDelete DELETE /api/v2/task/task_id/field/field_id Remove Custom Field Value
CustomFieldsApi apiV2TaskTaskIdFieldFieldIdPost POST /api/v2/task/task_id/field/field_id Set Custom Field Value
DependenciesApi apiV2TaskTaskIdDependencyDelete DELETE /api/v2/task/task_id/dependency Delete Dependency
DependenciesApi apiV2TaskTaskIdDependencyPost POST /api/v2/task/task_id/dependency Add Dependency
DependenciesApi apiV2TaskTaskIdLinkLinksToDelete DELETE /api/v2/task/task_id/link/links_to Delete Task Link
DependenciesApi apiV2TaskTaskIdLinkLinksToPost POST /api/v2/task/task_id/link/links_to Add Task Link
FoldersApi apiV2FolderFolderIdDelete DELETE /api/v2/folder/folder_id Delete a Folder
FoldersApi apiV2FolderFolderIdGet GET /api/v2/folder/folder_id Get Folder
FoldersApi apiV2FolderFolderIdPut PUT /api/v2/folder/folder_id Update a Folder
FoldersApi apiV2SpaceSpaceIdFolderGet GET /api/v2/space/space_id/folder Get Folders
FoldersApi apiV2SpaceSpaceIdFolderPost POST /api/v2/space/space_id/folder Create a Folder
GoalsApi apiV2GoalGoalIdDelete DELETE /api/v2/goal/goal_id Delete a Goal
GoalsApi apiV2GoalGoalIdGet GET /api/v2/goal/goal_id Get Goal
GoalsApi apiV2GoalGoalIdKeyResultPost POST /api/v2/goal/goal_id/key_result Create a Key Result
GoalsApi apiV2GoalGoalIdPut PUT /api/v2/goal/goal_id Update a Goal
GoalsApi apiV2KeyResultKeyResultIdDelete DELETE /api/v2/key_result/key_result_id Delete a Key Result
GoalsApi apiV2KeyResultKeyResultIdPut PUT /api/v2/key_result/key_result_id Edit a Key Result
GoalsApi apiV2TeamTeamIdGoalGet GET /api/v2/team/team_id/goal Get Goals
GoalsApi apiV2TeamTeamIdGoalPost POST /api/v2/team/team_id/goal Create a Goal
GuestsApi apiV2FolderFolderIdGuestGuestIdDelete DELETE /api/v2/folder/folder_id/guest/guest_id Remove Guest from Folder
GuestsApi apiV2FolderFolderIdGuestGuestIdPost POST /api/v2/folder/folder_id/guest/guest_id Add Guest to Folder
GuestsApi apiV2ListListIdGuestGuestIdDelete DELETE /api/v2/list/list_id/guest/guest_id Remove Guest from List
GuestsApi apiV2ListListIdGuestGuestIdPost POST /api/v2/list/list_id/guest/guest_id Add Guest to List
GuestsApi apiV2TaskTaskIdGuestGuestIdDelete DELETE /api/v2/task/task_id/guest/guest_id Remove Guest from Task
GuestsApi apiV2TaskTaskIdGuestGuestIdPost POST /api/v2/task/task_id/guest/guest_id Add Guest to Task
GuestsApi apiV2TeamTeamIdGuestGuestIdDelete DELETE /api/v2/team/team_id/guest/guest_id Remove Guest from Workspace
GuestsApi apiV2TeamTeamIdGuestGuestIdGet GET /api/v2/team/team_id/guest/guest_id Get Guest
GuestsApi apiV2TeamTeamIdGuestGuestIdPut PUT /api/v2/team/team_id/guest/guest_id Edit Guest on Workspace
GuestsApi apiV2TeamTeamIdGuestPost POST /api/v2/team/team_id/guest Invite Guest to Workspace
ListsApi apiV2FolderFolderIdListGet GET /api/v2/folder/folder_id/list Get Lists
ListsApi apiV2FolderFolderIdListPost POST /api/v2/folder/folder_id/list Create a List
ListsApi apiV2ListListIdDelete DELETE /api/v2/list/list_id Delete a List
ListsApi apiV2ListListIdGet GET /api/v2/list/list_id Get List
ListsApi apiV2ListListIdPut PUT /api/v2/list/list_id Update a List
ListsApi apiV2ListListIdTaskTaskIdGet GET /api/v2/list/list_id/task/task_id Remove Task From List
ListsApi apiV2ListListIdTaskTaskIdPost POST /api/v2/list/list_id/task/task_id Add Task To List
ListsApi apiV2SpaceSpaceIdListGet GET /api/v2/space/space_id/list Get Folderless Lists
ListsApi apiV2SpaceSpaceIdListPost POST /api/v2/space/space_id/list Create Folderless List
MembersApi apiV2ListListIdMemberGet GET /api/v2/list/list_id/member Get List Members
MembersApi apiV2TaskTaskIdMemberGet GET /api/v2/task/task_id/member Get Task Members
SharedHierarchyApi apiV2TeamTeamIdSharedGet GET /api/v2/team/team_id/shared Get Shared Hierarchy
SpacesApi apiV2SpaceSpaceIdDelete DELETE /api/v2/space/space_id Delete a Space
SpacesApi apiV2SpaceSpaceIdGet GET /api/v2/space/space_id Get Space
SpacesApi apiV2SpaceSpaceIdPut PUT /api/v2/space/space_id Update a Space
SpacesApi apiV2TeamTeamIdSpaceGet GET /api/v2/team/team_id/space Get Spaces
SpacesApi apiV2TeamTeamIdSpacePost POST /api/v2/team/team_id/space Create a Space
TagsApi apiV2SpaceSpaceIdTagGet GET /api/v2/space/space_id/tag Get Space Tags
TagsApi apiV2SpaceSpaceIdTagPost POST /api/v2/space/space_id/tag Create a Space Tag
TagsApi apiV2SpaceSpaceIdTagTagNameDelete DELETE /api/v2/space/space_id/tag/tag_name Delete a Space Tag
TagsApi apiV2SpaceSpaceIdTagTagNamePut PUT /api/v2/space/space_id/tag/tag_name Edit a Space Tag
TagsApi apiV2TaskTaskIdTagTagNameDelete DELETE /api/v2/task/task_id/tag/tag_name Remove Tag From Task
TagsApi apiV2TaskTaskIdTagTagNamePost POST /api/v2/task/task_id/tag/tag_name Add Tag To Task
TaskTemplatesApi apiV2ListListIdTaskTemplateTemplateIdPost POST /api/v2/list/list_id/taskTemplate/template_id Create Task From Template
TaskTemplatesApi apiV2TeamTeamIdTaskTemplateGet GET /api/v2/team/team_id/taskTemplate Get Task Templates
TasksApi apiV2ListListIdTaskGet GET /api/v2/list/list_id/task Get Tasks
TasksApi apiV2ListListIdTaskPost POST /api/v2/list/list_id/task Create a Task
TasksApi apiV2TaskBulkTimeInStatusTaskIdsGet GET /api/v2/task/bulk_time_in_status/task_ids Get Bulk Tasks' Time in Status
TasksApi apiV2TaskTaskIdDelete DELETE /api/v2/task/task_id Delete a Task
TasksApi apiV2TaskTaskIdGet GET /api/v2/task/task_id Get Task
TasksApi apiV2TaskTaskIdPut PUT /api/v2/task/task_id Update a Task
TasksApi apiV2TaskTaskIdTimeInStatusGet GET /api/v2/task/task_id/time_in_status Get Task's Time in Status
TasksApi apiV2TeamTeamIdTaskGet GET /api/v2/team/team_id/task Get Filtered Team Tasks
TeamsUserGroupsApi apiV2GroupGet GET /api/v2/group Get Teams
TeamsUserGroupsApi apiV2GroupGroupIdDelete DELETE /api/v2/group/group_id Delete a Team
TeamsUserGroupsApi apiV2GroupGroupIdPut PUT /api/v2/group/group_id Update Team
TeamsUserGroupsApi apiV2TeamTeamIdGroupPost POST /api/v2/team/team_id/group Create a Team
TeamsWorkspacesApi apiV2TeamGet GET /api/v2/team Get Teams
TimeTracking20Api apiV2TeamTeamIdTimeEntriesCurrentGet GET /api/v2/team/team_id/time_entries/current Get Running Time Entry
TimeTracking20Api apiV2TeamTeamIdTimeEntriesGet GET /api/v2/team/team_id/time_entries Get Time Entries Within a Date Range
TimeTracking20Api apiV2TeamTeamIdTimeEntriesPost POST /api/v2/team/team_id/time_entries Create a Time Entry
TimeTracking20Api apiV2TeamTeamIdTimeEntriesStartTimerIdPost POST /api/v2/team/team_id/time_entries/start/{timer_id} Start a Time Entry
TimeTracking20Api apiV2TeamTeamIdTimeEntriesStopPost POST /api/v2/team/team_id/time_entries/stop Stop Running Time Entry
TimeTracking20Api apiV2TeamTeamIdTimeEntriesTagsDelete DELETE /api/v2/team/team_id/time_entries/tags Remove Tags From Time Entry
TimeTracking20Api apiV2TeamTeamIdTimeEntriesTagsGet GET /api/v2/team/team_id/time_entries/tags Get All Time Entry Tags
TimeTracking20Api apiV2TeamTeamIdTimeEntriesTagsPost POST /api/v2/team/team_id/time_entries/tags Add Tags to Time Entries
TimeTracking20Api apiV2TeamTeamIdTimeEntriesTagsPut PUT /api/v2/team/team_id/time_entries/tags Rename Time Entry Tags
TimeTracking20Api apiV2TeamTeamIdTimeEntriesTimeEntryIdDelete DELETE /api/v2/team/team_id/time_entries/time_entry_id Delete a Time Entry
TimeTracking20Api apiV2TeamTeamIdTimeEntriesTimeEntryIdGet GET /api/v2/team/team_id/time_entries/time_entry_id Get Singular Time Entry
TimeTracking20Api apiV2TeamTeamIdTimeEntriesTimerIdHistoryGet GET /api/v2/team/team_Id/time_entries/timer_id/history Get Time Entry History
TimeTracking20Api apiV2TeamTeamIdTimeEntriesTimerIdPut PUT /api/v2/team/team_id/time_entries/timer_id Update a Time Entry
TimeTrackingLegacyApi apiV2TaskTaskIdTimeGet GET /api/v2/task/task_id/time/ Get Time Tracked
TimeTrackingLegacyApi apiV2TaskTaskIdTimeIntervalIdDelete DELETE /api/v2/task/task_id/time/interval_id Delete Time Tracked
TimeTrackingLegacyApi apiV2TaskTaskIdTimeIntervalIdPut PUT /api/v2/task/task_id/time/interval_id Edit Time Tracked
TimeTrackingLegacyApi apiV2TaskTaskIdTimePost POST /api/v2/task/task_id/time Track Time
UsersApi apiV2TeamTeamIdUserPost POST /api/v2/team/team_id/user Invite User to Workspace
UsersApi apiV2TeamTeamIdUserUserIdDelete DELETE /api/v2/team/team_id/user/user_id Remove User From Workspace
UsersApi apiV2TeamTeamIdUserUserIdGet GET /api/v2/team/team_id/user/user_id Get User
UsersApi apiV2TeamTeamIdUserUserIdPut PUT /api/v2/team/team_id/user/user_id Edit User on Workspace
ViewsApi apiV2FolderFolderIdViewGet GET /api/v2/folder/folder_id/view Get Folder Views
ViewsApi apiV2FolderFolderIdViewPost POST /api/v2/folder/folder_id/view Create Folder View
ViewsApi apiV2ListListIdViewGet GET /api/v2/list/list_id/view Get List Views
ViewsApi apiV2ListListIdViewPost POST /api/v2/list/list_id/view Create List View
ViewsApi apiV2SpaceSpaceIdViewGet GET /api/v2/space/space_id/view Get Space Views
ViewsApi apiV2SpaceSpaceIdViewPost POST /api/v2/space/space_id/view Create Space View
ViewsApi apiV2TeamTeamIdViewGet GET /api/v2/team/team_id/view Get Team Views
ViewsApi apiV2TeamTeamIdViewPost POST /api/v2/team/team_id/view Create Team View
ViewsApi apiV2ViewViewIdDelete DELETE /api/v2/view/view_id Delete a View
ViewsApi apiV2ViewViewIdGet GET /api/v2/view/view_id Get View
ViewsApi apiV2ViewViewIdPut PUT /api/v2/view/view_id Update View
ViewsApi apiV2ViewViewIdTaskGet GET /api/v2/view/view_id/task Get View Tasks
WebhooksApi apiV2TeamTeamIdWebhookGet GET /api/v2/team/team_id/webhook Get Webhooks
WebhooksApi apiV2TeamTeamIdWebhookPost POST /api/v2/team/team_id/webhook Create a Webhook
WebhooksApi apiV2WebhookWebhookIdDelete DELETE /api/v2/webhook/webhook_id Delete a Webhook
WebhooksApi apiV2WebhookWebhookIdPut PUT /api/v2/webhook/webhook_id Update Webhook

Models

Authorization

Authentication schemes defined for the API:

apikeyAuth

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

  • API version: 1.0.0
  • Build package: org.openapitools.codegen.languages.PhpClientCodegen