Skip to content

Files

Latest commit

 

History

History
42 lines (30 loc) · 3.26 KB

README.md

File metadata and controls

42 lines (30 loc) · 3.26 KB

Toggl.API

PowerShell Gallery License Build Status

PowerShell module to interact with the Toggl API.

Available Endpoints

Projects

  • Get-TogglProjects: Retrieves the list of projects for a specified workspace.
  • New-TogglProject: Creates a new project in a specified workspace.
  • Remove-TogglProject: Deletes a project in a specified workspace.

Reports

  • Search-TogglTimeEntries: Searches for time entries in detailed reports with various filters.

Tags

  • Get-TogglTags: Lists workspace tags.
  • New-TogglTag: Creates a new tag in a specified workspace.
  • Remove-TogglTag: Deletes a tag in a specified workspace.

Time Entries

  • Get-TogglTimeEntries: Lists the latest time entries.
  • Get-TogglTimeEntryById: Retrieves a time entry by its ID.
  • New-TogglTimeEntry: Creates a new time entry.
  • Update-TogglTimeEntry: Updates an existing time entry.
  • Remove-TogglTimeEntry: Deletes a time entry.

Authentication

  • Get-TogglAuthHeader: Generates the authentication header from the API token.

Development

Tests

To run tests you need to have your own API key and workspace. Once you have it create .env using .env.example as an example.

To load environment variables to current session use .\scripts\load-env.ps1

To cleanup workspace use .\scripts\cleanup-workspace.ps1

Tests load settins either from environment variables or from .\Tests\config.json