Public/Checklists.ps1
|
<# .SYNOPSIS Create a new ClickUp checklist. .DESCRIPTION Create a new ClickUp checklist. .EXAMPLE PS C:\> New-ClickUpChecklist -TaskID 9hz -Name "Checklist" Create a new checklist on ClickUp task with ID "9hz" with name "Checklist". .EXAMPLE PS C:\> New-ClickUpChecklist -TaskID CustomID -CustomTaskIDs $true -TeamID 123 -Name "Checklist" Create a new checklist on ClickUp task with custom ID "CustomID" with name "Checklist". .INPUTS None .OUTPUTS System.Object Hashtable. .NOTES See the link for information. .LINK https://jsapi.apiary.io/apis/clickup20/reference/0/checklists/create-checklist.html #> function New-ClickUpChecklist { [CmdletBinding(DefaultParameterSetName = 'TaskID')] param ( [Parameter(Mandatory = $true, ParameterSetName = 'TaskID')] [Parameter(Mandatory = $true, ParameterSetName = 'CustomTaskIDs')] [string]$TaskID, [Parameter(Mandatory = $true, ParameterSetName = 'TaskID')] [Parameter(Mandatory = $true, ParameterSetName = 'CustomTaskIDs')] [string]$Name, [Parameter(Mandatory = $true, ParameterSetName = 'CustomTaskIDs')] [bool]$CustomTaskIDs, [Parameter(Mandatory = $true, ParameterSetName = 'CustomTaskIDs')] [UInt64]$TeamID ) $Body = @{ name = $Name } if ($PSBoundParameters.ContainsKey('CustomTaskIDs')) { $QueryString = @{ custom_task_ids = $CustomTaskIDs team_id = $TeamID } } else { $QueryString = @{} } $Checklist = Invoke-ClickUpAPIGet -Arguments $QueryString -Endpoint "task/$TaskID/checklist" -Body $Body return $Checklist.checklist } <# .SYNOPSIS Update a ClickUp checklist. .DESCRIPTION Update a ClickUp checklist. .EXAMPLE PS C:\> Set-ClickUpChecklist -ChecklistID b955c4dc -Name "New checklist name." Update ClickUp checklist with ID "b955c4dc" to new name "New checklist name." .EXAMPLE PS C:\> Set-ClickUpChecklist -ChecklistID b955c4dc -Name "Update Checklist." -Position 3 Update ClickUp checklist with ID "b955c4dc" to new name "Update Checklist." and position 3. .INPUTS None .OUTPUTS System.Object Hashtable. .NOTES See the link for information. .LINK https://jsapi.apiary.io/apis/clickup20/reference/0/checklists/edit-checklist.html #> function Set-ClickUpChecklist { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [string]$ChecklistID, [Parameter()] [string]$Name, [Parameter()] [UInt64]$Position ) $Body = @{} if ($PSBoundParameters.ContainsKey('Name')) { $Body.Add('name', $Name) } if ($PSBoundParameters.ContainsKey('Position')) { $Body.Add('position', $Position) } $Checklist = Invoke-ClickUpAPIPut -Endpoint 'checklist/$ChecklistID' -Body $Body return $Checklist.checklist } <# .SYNOPSIS Delete a ClickUp checklist. .DESCRIPTION Delete a ClickUp checklist. .EXAMPLE PS C:\> Remove-ClickUpChecklist -ChecklistID b955c4dc Remove ClickUp checklist with ID "b955c4dc". .INPUTS None .OUTPUTS System.Object Hashtable. .NOTES See the link for information. .LINK https://jsapi.apiary.io/apis/clickup20/reference/0/checklists/delete-checklist.html #> function Remove-ClickUpChecklist { [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'High')] param ( [Parameter(Mandatory = $true)] [string]$ChecklistID ) if ($PSCmdlet.ShouldProcess($ChecklistID)) { Invoke-ClickUpAPIDelete -Endpoint "checklist/$CheckListID" } } <# .SYNOPSIS Create a new ClickUp checklist item. .DESCRIPTION Create a new ClickUp checklist item. .EXAMPLE PS C:\> New-ClickUpChecklist -CheckListID b955c4dc -Name "Checklist item" Create a new checklist item on ClickUp Checklist with ID "b955c4dc" with name "Checklist item". .EXAMPLE PS C:\> New-ClickUpChecklist -CheckListID b955c4dc -Name "Checklist item" -Assignee 183 Create a new checklist item on ClickUp Checklist with ID "b955c4dc" with name "Checklist item" and assign it to member with ID "183." .INPUTS None .OUTPUTS System.Object Hashtable. .NOTES See the link for information. .LINK https://jsapi.apiary.io/apis/clickup20/reference/0/checklists/create-checklist-item.html #> function New-ClickUpChecklistItem { [CmdletBinding()] param ( [Parameter(Mandatory = $True)] [string]$CheckListID, [Parameter(Mandatory = $True)] [string]$Name, [Parameter()] [UInt64]$Assignee ) $Body = @{ name = $Name } if ($PSBoundParameters.ContainsKey('Assignee')) { $Body.Add('assignee', $Assignee) } $Checklist = Invoke-ClickUpAPIPost -Endpoint "checklist/$CheckListID/checklist_item" -Body $Body $Checklist.checklist } <# .SYNOPSIS Update a ClickUp checklist item. .DESCRIPTION Update a ClickUp checklist item. .EXAMPLE PS C:\> Set-ClickUpChecklist -ChecklistID b955c4dc -ChecklistItemId 21e08dc8 -Name "New checklist item name." Update ClickUp checklist item with ID "21e08dc8" under checklist with ID "b955c4dc" to new name "New checklist item name." .EXAMPLE PS C:\> Set-ClickUpChecklist -ChecklistID b955c4dc -ChecklistItemId 21e08dc8 -Name "Update Checklist item." -Assignee 183 Update ClickUp checklist item with ID "21e08dc8" under checklist with ID "b955c4dc" to new name "Update Checklist item." and assign it to member with ID "183." .INPUTS None .OUTPUTS System.Object Hashtable. .NOTES See the link for information. .LINK https://jsapi.apiary.io/apis/clickup20/reference/0/checklists/edit-checklist-item.html #> function Set-ClickUpChecklistItem { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [string]$ChecklistID, [Parameter(Mandatory = $true)] [string]$ChecklistItemId, [Parameter()] [string]$Name, [Parameter()] [UInt64]$Assignee, [Parameter()] [bool]$Resolved, [Parameter()] [string]$Parent ) $Body = @{} if ($PSBoundParameters.ContainsKey('Name')) { $Body.Add('name', $Name) } if ($PSBoundParameters.ContainsKey('Assignee')) { $Body.Add('assignee', $Assignee) } if ($PSBoundParameters.ContainsKey('Resolved')) { $Body.Add('resolved', $Resolved) } if ($PSBoundParameters.ContainsKey('Parent')) { $Body.Add('parent', $Parent) } $Checklist = Invoke-ClickupAPIPut -Endpoint "checklist/$ChecklistID/checklist_item/$ChecklistItemId" -Body $Body $CheckList.checklist } <# .SYNOPSIS Delete a ClickUp checklist item. .DESCRIPTION Delete a ClickUp checklist item. .EXAMPLE PS C:\> Remove-ClickUpChecklist -ChecklistID b955c4dc -ChecklistItemId 21e08dc8 Remove ClickUp checklist with ID "b955c4dc". .INPUTS None .OUTPUTS System.Object Hashtable. .NOTES See the link for information. .LINK https://jsapi.apiary.io/apis/clickup20/reference/0/checklists/delete-checklist-item.html #> function Remove-ClickUpCheckListItem { [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'High')] param ( [Parameter(Mandatory = $true)] [string]$ChecklistID, [Parameter(Mandatory = $true)] [string]$ChecklistItemId ) if ($PSCmdlet.ShouldProcess($ChecklistID)) { Invoke-ClickUpAPIDelete -Endpoint "checklist/$ChecklistID/checklist_item/$ChecklistItemId" } } |