|
1 | 1 | # timular-api
|
2 |
| - Welcome to the documentation of 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](https://profile.timeular.com/#/app/) 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](http://support.timeular.com) and ask them there. Happy API browsing! |
| 2 | + 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](./?v=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](https://profile.timeular.com/#/app/) 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](http://support.timeular.com) and ask them there. Happy API browsing! |
3 | 3 |
|
4 | 4 | This Python package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
5 | 5 |
|
@@ -65,35 +65,34 @@ except ApiException as e:
|
65 | 65 |
|
66 | 66 | ## Documentation for API Endpoints
|
67 | 67 |
|
68 |
| -All URIs are relative to *https://api.timeular.com/api/v1/* |
| 68 | +All URIs are relative to *https://api.timeular.com/api/v2/* |
69 | 69 |
|
70 | 70 | Class | Method | HTTP request | Description
|
71 | 71 | ------------ | ------------- | ------------- | -------------
|
72 | 72 | *AuthenticationApi* | [**developer_sign_in**](docs/AuthenticationApi.md#developer_sign_in) | **POST** /developer/sign-in | Sign-in with API Key & API Secret
|
| 73 | +*AuthenticationApi* | [**generate_api_key**](docs/AuthenticationApi.md#generate_api_key) | **POST** /developer/api-access | Generate new API Key & API Secret |
73 | 74 | *AuthenticationApi* | [**get_api_key**](docs/AuthenticationApi.md#get_api_key) | **GET** /developer/api-access | Fetch API Key
|
74 |
| -*AuthenticationApi* | [**get_api_key_0**](docs/AuthenticationApi.md#get_api_key_0) | **POST** /developer/api-access | Generate new API Key & API Secret |
75 | 75 | *IntegrationsApi* | [**get_integration**](docs/IntegrationsApi.md#get_integration) | **GET** /integrations | List enabled Integrations
|
76 |
| -*ProfileApi* | [**get_profile**](docs/ProfileApi.md#get_profile) | **GET** /user/profile | Fetch User's Profile |
77 | 76 | *TimeTrackingActivitiesApi* | [**archive_activity**](docs/TimeTrackingActivitiesApi.md#archive_activity) | **DELETE** /activities/{activityId} | Archive an Activity
|
78 | 77 | *TimeTrackingActivitiesApi* | [**assign_activity_to_device_side**](docs/TimeTrackingActivitiesApi.md#assign_activity_to_device_side) | **POST** /activities/{activityId}/device-side/{deviceSide} | Assign an Activity to Device Side
|
79 | 78 | *TimeTrackingActivitiesApi* | [**create_activity**](docs/TimeTrackingActivitiesApi.md#create_activity) | **POST** /activities | Create an Activity
|
80 | 79 | *TimeTrackingActivitiesApi* | [**edit_activity**](docs/TimeTrackingActivitiesApi.md#edit_activity) | **PATCH** /activities/{activityId} | Edit an Activity
|
81 | 80 | *TimeTrackingActivitiesApi* | [**get_activities**](docs/TimeTrackingActivitiesApi.md#get_activities) | **GET** /activities | List all Activities
|
82 | 81 | *TimeTrackingActivitiesApi* | [**get_archived_activities**](docs/TimeTrackingActivitiesApi.md#get_archived_activities) | **GET** /archived-activities | List all Archived Activities
|
83 |
| -*TimeTrackingActivitiesApi* | [**get_tags_and_mentions_of_activity**](docs/TimeTrackingActivitiesApi.md#get_tags_and_mentions_of_activity) | **GET** /activities/{activityId}/tags-and-mentions | Fetch Tags & Mentions of given Activity |
84 | 82 | *TimeTrackingActivitiesApi* | [**unassign_activity_from_device_side**](docs/TimeTrackingActivitiesApi.md#unassign_activity_from_device_side) | **DELETE** /activities/{activityId}/device-side/{deviceSide} | Unassign an Activity from a Device Side
|
85 | 83 | *TimeTrackingCurrentTrackingApi* | [**edit_tracking**](docs/TimeTrackingCurrentTrackingApi.md#edit_tracking) | **PATCH** /tracking/{activityId} | Edit Tracking
|
86 | 84 | *TimeTrackingCurrentTrackingApi* | [**get_current_tracking**](docs/TimeTrackingCurrentTrackingApi.md#get_current_tracking) | **GET** /tracking | Show current Tracking
|
87 | 85 | *TimeTrackingCurrentTrackingApi* | [**start_tracking**](docs/TimeTrackingCurrentTrackingApi.md#start_tracking) | **POST** /tracking/{activityId}/start | Start Tracking
|
88 | 86 | *TimeTrackingCurrentTrackingApi* | [**stop_tracking**](docs/TimeTrackingCurrentTrackingApi.md#stop_tracking) | **POST** /tracking/{activityId}/stop | Stop Tracking
|
89 |
| -*TimeTrackingDevicesApi* | [**activate_device**](docs/TimeTrackingDevicesApi.md#activate_device) | **POST** /devices/{deviceSerial}/active | Activate a Device |
90 |
| -*TimeTrackingDevicesApi* | [**activate_device_0**](docs/TimeTrackingDevicesApi.md#activate_device_0) | **PATCH** /devices/{deviceSerial} | Edit a Device |
91 |
| -*TimeTrackingDevicesApi* | [**deactivate_device**](docs/TimeTrackingDevicesApi.md#deactivate_device) | **DELETE** /devices/{deviceSerial}/active | Deactivate a Device |
| 87 | +*TimeTrackingDevicesApi* | [**activate_device**](docs/TimeTrackingDevicesApi.md#activate_device) | **POST** /devices/{deviceSerial}/active | Sets the status of a Device to active |
| 88 | +*TimeTrackingDevicesApi* | [**deactivate_device**](docs/TimeTrackingDevicesApi.md#deactivate_device) | **DELETE** /devices/{deviceSerial}/active | Removes the active status from the given Device |
92 | 89 | *TimeTrackingDevicesApi* | [**disable_device**](docs/TimeTrackingDevicesApi.md#disable_device) | **POST** /devices/{deviceSerial}/disabled | Disable a Device
|
93 |
| -*TimeTrackingDevicesApi* | [**eanble_device**](docs/TimeTrackingDevicesApi.md#eanble_device) | **DELETE** /devices/{deviceSerial}/disabled | Enable a Device |
94 |
| -*TimeTrackingDevicesApi* | [**forget_device**](docs/TimeTrackingDevicesApi.md#forget_device) | **DELETE** /devices/{deviceSerial} | Forget known Device |
| 90 | +*TimeTrackingDevicesApi* | [**edit_device**](docs/TimeTrackingDevicesApi.md#edit_device) | **PATCH** /devices/{deviceSerial} | Edit a Device |
| 91 | +*TimeTrackingDevicesApi* | [**enable_device**](docs/TimeTrackingDevicesApi.md#enable_device) | **DELETE** /devices/{deviceSerial}/disabled | Enable a Device |
95 | 92 | *TimeTrackingDevicesApi* | [**get_known_devices**](docs/TimeTrackingDevicesApi.md#get_known_devices) | **GET** /devices | List all known Devices
|
| 93 | +*TimeTrackingDevicesApi* | [**remove_device**](docs/TimeTrackingDevicesApi.md#remove_device) | **DELETE** /devices/{deviceSerial} | Remove known Device |
96 | 94 | *TimeTrackingReportsApi* | [**generate_csv_report**](docs/TimeTrackingReportsApi.md#generate_csv_report) | **GET** /report/{startTimestamp}/{stopTimestamp} | Generate CSV Report
|
| 95 | +*TimeTrackingTagsMentionsApi* | [**get_tags_and_mentions**](docs/TimeTrackingTagsMentionsApi.md#get_tags_and_mentions) | **GET** /tags-and-mentions | Fetch Tags & Mentions |
97 | 96 | *TimeTrackingTimeEntriesApi* | [**create_time_entry**](docs/TimeTrackingTimeEntriesApi.md#create_time_entry) | **POST** /time-entries | Create Time Entry
|
98 | 97 | *TimeTrackingTimeEntriesApi* | [**delete_time_entry**](docs/TimeTrackingTimeEntriesApi.md#delete_time_entry) | **DELETE** /time-entries/{timeEntryId} | Delete a Time Entry
|
99 | 98 | *TimeTrackingTimeEntriesApi* | [**edit_time_entry**](docs/TimeTrackingTimeEntriesApi.md#edit_time_entry) | **PATCH** /time-entries/{timeEntryId} | Edit a Time Entry
|
@@ -122,7 +121,9 @@ Class | Method | HTTP request | Description
|
122 | 121 | - [ErrorResponse](docs/ErrorResponse.md)
|
123 | 122 | - [IntegrationsResponse](docs/IntegrationsResponse.md)
|
124 | 123 | - [MentionResponse](docs/MentionResponse.md)
|
125 |
| - - [ProfileResponse](docs/ProfileResponse.md) |
| 124 | + - [Note](docs/Note.md) |
| 125 | + - [NoteMention](docs/NoteMention.md) |
| 126 | + - [NoteTag](docs/NoteTag.md) |
126 | 127 | - [StartTrackingRequest](docs/StartTrackingRequest.md)
|
127 | 128 | - [StartedTrackingResponse](docs/StartedTrackingResponse.md)
|
128 | 129 | - [StopTrackingRequest](docs/StopTrackingRequest.md)
|
|
0 commit comments