Skip to content

Latest commit

 

History

History
135 lines (110 loc) · 3.76 KB

README.MD

File metadata and controls

135 lines (110 loc) · 3.76 KB
Raw

KToggl

KToggl is Kotlin client for the Toggl API v8 and the Toggl Reports API v2

Project is under heavy development and its API (packages, classes, methods names) may change without warning.

Build

Project is designed to work on JVM and AndroidRuntime, that's why contains ktoggl-jvm and ktoggl-android modules that extends ktoggl-core.

Building ktoggl-android required Android SDK installed on OS. If you do not need ktoggl-android, you can use following command to build:

mvn -pl '!ktoggl-android' clean install

To build all ktoggl modules you have to:

  1. Install Android SDK
  2. Set ANDROID_HOME environment variable
  3. Install Android SDK Platform for 28 API Level
  4. Run
mvn clean install

Skipped endpoints

Some Toggl API endpoints was skipped in current implementation because of its low importance (based on my opinion). Eventually all the endpoints should find itself in KToggl.

If you think that something should be added faster, feel free to create an issue.

API implementation status:

  1. Authentication

    1. HTTP Basic Auth with e-mail and password - NO
    2. HTTP Basic Auth with API token - YES
    3. Authentication with a session cookie - NO
    4. Destroy the session - NO

  2. Clients

    1. Create a client - NO
    2. Get client details - NO
    3. Update a client - NO
    4. Delete a client - NO
    5. Get clients visible to user - NO
    6. Get client projects - NO

  3. CORS whitelists

    1. Create an entry - NO
    2. Get entries for current user - NO
    3. Delete an entry - NO

  4. Dashboard

    1. Get Dashboard data - NO

  5. Groups

    1. Create a group - NO
    2. Update a group - NO
    3. Delete a group - NO

  6. Project users

    1. Create a project user - NO
    2. Update a project user - NO
    3. Delete a project user - NO
    4. Get list of project users in a Workspace - NO
    5. Create multiple project users for single project - NO
    6. Mass update for project users - NO
    7. Delete multiple project users - NO

  7. Projects

    1. Create project - NO
    2. Get project data - NO
    3. Update project data - NO
    4. Delete a project - NO
    5. Get project users - NO
    6. Get project tasks - NO
    7. Delete multiple projects - NO

  8. Tags

    1. Create tag - YES
    2. Update a tag - YES
    3. Delete a tag - YES

  9. Tasks

    1. Create a task - NO
    2. Get task details - NO
    3. Update a task - NO
    4. Delete a task - NO
    5. Update multiple tasks - NO
    6. Delete multiple tasks - NO

  10. Time Entries

    1. Create a time entry - YES
    2. Start a time entry - YES
    3. Stop a time entry - YES
    4. Get time entry details - YES
    5. Get running time entry - YES
    6. Update a time entry - YES
    7. Delete a time entry - YES
    8. Get time entries started in a specific time range - YES
    9. Bulk update time entries tags - YES

  11. Users

    1. Get current user data without related - YES
    2. Get current user data with related - NO
    3. Update user data - YES
    4. Update user password - YES
    5. Reset API token - NO
    6. Sign up new user - NO

  12. Workspace Users

    1. Invite users to workspace - NO
    2. Update workspace user - NO
    3. Delete workspace user - NO
    4. Get workspace users - NO

  13. Workspaces

    1. Get workspaces - YES
    2. Get single workspace - YES
    3. Update workspace - YES
    4. Get workspace users - NO
    5. Get workspace clients - NO
    6. Get workspace groups - NO
    7. Get workspace projects - YES
    8. Get workspace tasks - NO
    9. Get workspace tags - YES

Report API implementation status:

  1. Detailed report - YES
  2. Project dashboard - NO
  3. Summary report - NO
  4. Weekly report - NO