timeular-api

Welcome to the documentation of Timeular Public API v2. If you want to have a look at the older and deprecated API v1 please just click on the following link: Timeular Public API v1 You can try all requests here, in documentation, with use of Try it out button (available in each endpoint description after folding it out). Most of endpoints are secured. In order to access them you have to provide Access Token. To do so, click on Authorize button below and provide 'Bearer *your_access_token*' as a value for Authorization request header. To obtain Access Token you have to sign-in with pair of API Key and API Secret first. API Key & API Secret can be generated on Profile website or, if you have Access Token already, with POST request to /developer/api-access. Warning: authentication flow may change soon due to active development of Timeular and its API. If you have any questions, please visit Support page and ask them there. Happy API browsing!

This Python package is automatically generated by the Swagger Codegen project:

• API version: 1
• Package version: 1.0.0
• Build package: io.swagger.codegen.languages.PythonClientCodegen

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on Github, you can install directly from Github

pip install git+https://github.com/tobias-reese/timeular-api.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/tobias-reese/timeular-api.git)

Then import the package:

import timeular_api 

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import timeular_api

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import timeular_api
from timeular_api.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = timeular_api.AuthenticationApi()
api_key_and_api_secret = timeular_api.DeveloperSignInRequest() # DeveloperSignInRequest | API Key and API Secret (optional)

try:
    # Sign-in with API Key & API Secret
    api_response = api_instance.developer_sign_in(api_key_and_api_secret=api_key_and_api_secret)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthenticationApi->developer_sign_in: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.timeular.com/api/v2/

Class	Method	HTTP request	Description
AuthenticationApi	developer_sign_in	POST /developer/sign-in	Sign-in with API Key & API Secret
AuthenticationApi	generate_api_key	POST /developer/api-access	Generate new API Key & API Secret
AuthenticationApi	get_api_key	GET /developer/api-access	Fetch API Key
IntegrationsApi	get_integration	GET /integrations	List enabled Integrations
TimeTrackingActivitiesApi	archive_activity	DELETE /activities/{activityId}	Archive an Activity
TimeTrackingActivitiesApi	assign_activity_to_device_side	POST /activities/{activityId}/device-side/{deviceSide}	Assign an Activity to Device Side
TimeTrackingActivitiesApi	create_activity	POST /activities	Create an Activity
TimeTrackingActivitiesApi	edit_activity	PATCH /activities/{activityId}	Edit an Activity
TimeTrackingActivitiesApi	get_activities	GET /activities	List all Activities
TimeTrackingActivitiesApi	get_archived_activities	GET /archived-activities	List all Archived Activities
TimeTrackingActivitiesApi	unassign_activity_from_device_side	DELETE /activities/{activityId}/device-side/{deviceSide}	Unassign an Activity from a Device Side
TimeTrackingCurrentTrackingApi	edit_tracking	PATCH /tracking/{activityId}	Edit Tracking
TimeTrackingCurrentTrackingApi	get_current_tracking	GET /tracking	Show current Tracking
TimeTrackingCurrentTrackingApi	start_tracking	POST /tracking/{activityId}/start	Start Tracking
TimeTrackingCurrentTrackingApi	stop_tracking	POST /tracking/{activityId}/stop	Stop Tracking
TimeTrackingDevicesApi	activate_device	POST /devices/{deviceSerial}/active	Sets the status of a Device to active
TimeTrackingDevicesApi	deactivate_device	DELETE /devices/{deviceSerial}/active	Removes the active status from the given Device
TimeTrackingDevicesApi	disable_device	POST /devices/{deviceSerial}/disabled	Disable a Device
TimeTrackingDevicesApi	edit_device	PATCH /devices/{deviceSerial}	Edit a Device
TimeTrackingDevicesApi	enable_device	DELETE /devices/{deviceSerial}/disabled	Enable a Device
TimeTrackingDevicesApi	get_known_devices	GET /devices	List all known Devices
TimeTrackingDevicesApi	remove_device	DELETE /devices/{deviceSerial}	Remove known Device
TimeTrackingReportsApi	generate_csv_report	GET /report/{startTimestamp}/{stopTimestamp}	Generate CSV Report
TimeTrackingTagsMentionsApi	get_tags_and_mentions	GET /tags-and-mentions	Fetch Tags & Mentions
TimeTrackingTimeEntriesApi	create_time_entry	POST /time-entries	Create Time Entry
TimeTrackingTimeEntriesApi	delete_time_entry	DELETE /time-entries/{timeEntryId}	Delete a Time Entry
TimeTrackingTimeEntriesApi	edit_time_entry	PATCH /time-entries/{timeEntryId}	Edit a Time Entry
TimeTrackingTimeEntriesApi	get_time_entries_in_range	GET /time-entries/{stoppedAfter}/{startedBefore}	Find Time Entries in given range
TimeTrackingTimeEntriesApi	get_time_entry	GET /time-entries/{timeEntryId}	Find Time Entry by its ID

Documentation For Models

• ActivitiesConfigurationResponse
• ActivityConfigurationResponse
• ActivityCreationRequest
• ActivityEditionRequest
• ArchivedActivitiesResponse
• ArchivedActivityResponse
• CurrentTrackingResponse
• DeveloperApiAccessResponse
• DeveloperFullApiAccessResponse
• DeveloperSignInRequest
• DeveloperSignInResponse
• DeviceEditionRequest
• DeviceResponse
• DevicesResponse
• EditTrackingRequest
• EditTrackingResponse
• ErrorResponse
• IntegrationsResponse
• MentionResponse
• Note
• NoteMention
• NoteTag
• StartTrackingRequest
• StartedTrackingResponse
• StopTrackingRequest
• StoppedTrackingResponse
• SuccessWithIgnoredErrorsResponse
• TagResponse
• TagsAndMentionsResponse
• TimeEntriesResponse
• TimeEntryActivityResponse
• TimeEntryCreationRequest
• TimeEntryDurationResponse
• TimeEntryEditionRequest
• TimeEntryResponse
• TrackingActivityResponse
• TrackingResponse

Documentation For Authorization

AuthorizationHeader

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

Author