Skip to content

Commit 62b8c79

Browse files
committed
updated api
1 parent 191095b commit 62b8c79

File tree

76 files changed

+1184
-810
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

76 files changed

+1184
-810
lines changed

README.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# 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!
33

44
This Python package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
55

@@ -65,35 +65,34 @@ except ApiException as e:
6565

6666
## Documentation for API Endpoints
6767

68-
All URIs are relative to *https://api.timeular.com/api/v1/*
68+
All URIs are relative to *https://api.timeular.com/api/v2/*
6969

7070
Class | Method | HTTP request | Description
7171
------------ | ------------- | ------------- | -------------
7272
*AuthenticationApi* | [**developer_sign_in**](docs/AuthenticationApi.md#developer_sign_in) | **POST** /developer/sign-in | Sign-in with API Key &amp; API Secret
73+
*AuthenticationApi* | [**generate_api_key**](docs/AuthenticationApi.md#generate_api_key) | **POST** /developer/api-access | Generate new API Key &amp; API Secret
7374
*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 &amp; API Secret
7575
*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&#39;s Profile
7776
*TimeTrackingActivitiesApi* | [**archive_activity**](docs/TimeTrackingActivitiesApi.md#archive_activity) | **DELETE** /activities/{activityId} | Archive an Activity
7877
*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
7978
*TimeTrackingActivitiesApi* | [**create_activity**](docs/TimeTrackingActivitiesApi.md#create_activity) | **POST** /activities | Create an Activity
8079
*TimeTrackingActivitiesApi* | [**edit_activity**](docs/TimeTrackingActivitiesApi.md#edit_activity) | **PATCH** /activities/{activityId} | Edit an Activity
8180
*TimeTrackingActivitiesApi* | [**get_activities**](docs/TimeTrackingActivitiesApi.md#get_activities) | **GET** /activities | List all Activities
8281
*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 &amp; Mentions of given Activity
8482
*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
8583
*TimeTrackingCurrentTrackingApi* | [**edit_tracking**](docs/TimeTrackingCurrentTrackingApi.md#edit_tracking) | **PATCH** /tracking/{activityId} | Edit Tracking
8684
*TimeTrackingCurrentTrackingApi* | [**get_current_tracking**](docs/TimeTrackingCurrentTrackingApi.md#get_current_tracking) | **GET** /tracking | Show current Tracking
8785
*TimeTrackingCurrentTrackingApi* | [**start_tracking**](docs/TimeTrackingCurrentTrackingApi.md#start_tracking) | **POST** /tracking/{activityId}/start | Start Tracking
8886
*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
9289
*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
9592
*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
9694
*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 &amp; Mentions
9796
*TimeTrackingTimeEntriesApi* | [**create_time_entry**](docs/TimeTrackingTimeEntriesApi.md#create_time_entry) | **POST** /time-entries | Create Time Entry
9897
*TimeTrackingTimeEntriesApi* | [**delete_time_entry**](docs/TimeTrackingTimeEntriesApi.md#delete_time_entry) | **DELETE** /time-entries/{timeEntryId} | Delete a Time Entry
9998
*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
122121
- [ErrorResponse](docs/ErrorResponse.md)
123122
- [IntegrationsResponse](docs/IntegrationsResponse.md)
124123
- [MentionResponse](docs/MentionResponse.md)
125-
- [ProfileResponse](docs/ProfileResponse.md)
124+
- [Note](docs/Note.md)
125+
- [NoteMention](docs/NoteMention.md)
126+
- [NoteTag](docs/NoteTag.md)
126127
- [StartTrackingRequest](docs/StartTrackingRequest.md)
127128
- [StartedTrackingResponse](docs/StartedTrackingResponse.md)
128129
- [StopTrackingRequest](docs/StopTrackingRequest.md)

docs/AuthenticationApi.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
# timular-api.AuthenticationApi
22

3-
All URIs are relative to *https://api.timeular.com/api/v1/*
3+
All URIs are relative to *https://api.timeular.com/api/v2/*
44

55
Method | HTTP request | Description
66
------------- | ------------- | -------------
77
[**developer_sign_in**](AuthenticationApi.md#developer_sign_in) | **POST** /developer/sign-in | Sign-in with API Key &amp; API Secret
8+
[**generate_api_key**](AuthenticationApi.md#generate_api_key) | **POST** /developer/api-access | Generate new API Key &amp; API Secret
89
[**get_api_key**](AuthenticationApi.md#get_api_key) | **GET** /developer/api-access | Fetch API Key
9-
[**get_api_key_0**](AuthenticationApi.md#get_api_key_0) | **POST** /developer/api-access | Generate new API Key &amp; API Secret
1010

1111

1212
# **developer_sign_in**
1313
> DeveloperSignInResponse developer_sign_in(api_key_and_api_secret=api_key_and_api_secret)
1414
1515
Sign-in with API Key & API Secret
1616

17-
With this endpoint you can obtain Access Token required to access secured endpoints. To do so, you have to provide API Key & API Secret. They 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`.
17+
With this endpoint you can obtain Access Token required to access secured endpoints. To do so, you have to provide API Key & API Secret. They 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`. If you possess your Access Token you can now add this inside an HTTP header field `Authorization` as value `'Bearer *your_access_token*'` to access restricted endpoints.
1818

1919
### Example
2020
```python
@@ -57,12 +57,12 @@ No authorization required
5757

5858
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
5959

60-
# **get_api_key**
61-
> DeveloperApiAccessResponse get_api_key()
60+
# **generate_api_key**
61+
> DeveloperFullApiAccessResponse generate_api_key()
6262
63-
Fetch API Key
63+
Generate new API Key & API Secret
6464

65-
With this endpoint you can fetch your API Key (or `null` if you haven't generated any yet). You cannot obtain an API Secret in such way, because it's visible only once, after generation. If you have lost your API Secret, please generate a new pair of API Key & API Secret.
65+
With this endpoint you can generate a new pair of API Key & API Secret. Every time you generate a new pair, an old one becomes invalid. Your API Secret won't be accessible later, so please note it down in some secret place. If you have lost your API Secret, you can generate a new pair of API Key & API Secret here.
6666

6767
### Example
6868
```python
@@ -82,19 +82,19 @@ configuration.api_key['Authorization'] = 'YOUR_API_KEY'
8282
api_instance = timular-api.AuthenticationApi(timular-api.ApiClient(configuration))
8383

8484
try:
85-
# Fetch API Key
86-
api_response = api_instance.get_api_key()
85+
# Generate new API Key & API Secret
86+
api_response = api_instance.generate_api_key()
8787
pprint(api_response)
8888
except ApiException as e:
89-
print("Exception when calling AuthenticationApi->get_api_key: %s\n" % e)
89+
print("Exception when calling AuthenticationApi->generate_api_key: %s\n" % e)
9090
```
9191

9292
### Parameters
9393
This endpoint does not need any parameter.
9494

9595
### Return type
9696

97-
[**DeveloperApiAccessResponse**](DeveloperApiAccessResponse.md)
97+
[**DeveloperFullApiAccessResponse**](DeveloperFullApiAccessResponse.md)
9898

9999
### Authorization
100100

@@ -107,12 +107,12 @@ This endpoint does not need any parameter.
107107

108108
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
109109

110-
# **get_api_key_0**
111-
> DeveloperFullApiAccessResponse get_api_key_0()
110+
# **get_api_key**
111+
> DeveloperApiAccessResponse get_api_key()
112112
113-
Generate new API Key & API Secret
113+
Fetch API Key
114114

115-
With this endpoint you can generate new pair of API Key & API Secret. Every time you generate a new pair, an old one becomes invalid. Your API Secret won't be accessible later, so please note it down in some secret place. If you have lost your API Secret, you can generate a new pair of API Key & API Secret here.
115+
With this endpoint you can fetch your API Key (or `null` if you haven't generated any yet). You cannot obtain an API Secret in such way, because it's visible only once, after generation. If you have lost your API Secret, please generate a new pair of API Key & API Secret.
116116

117117
### Example
118118
```python
@@ -132,19 +132,19 @@ configuration.api_key['Authorization'] = 'YOUR_API_KEY'
132132
api_instance = timular-api.AuthenticationApi(timular-api.ApiClient(configuration))
133133

134134
try:
135-
# Generate new API Key & API Secret
136-
api_response = api_instance.get_api_key_0()
135+
# Fetch API Key
136+
api_response = api_instance.get_api_key()
137137
pprint(api_response)
138138
except ApiException as e:
139-
print("Exception when calling AuthenticationApi->get_api_key_0: %s\n" % e)
139+
print("Exception when calling AuthenticationApi->get_api_key: %s\n" % e)
140140
```
141141

142142
### Parameters
143143
This endpoint does not need any parameter.
144144

145145
### Return type
146146

147-
[**DeveloperFullApiAccessResponse**](DeveloperFullApiAccessResponse.md)
147+
[**DeveloperApiAccessResponse**](DeveloperApiAccessResponse.md)
148148

149149
### Authorization
150150

docs/EditTrackingRequest.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**note** | **str** | | [optional]
6+
**note** | [**Note**](Note.md) | | [optional]
77

88
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
99

docs/IntegrationsApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# timular-api.IntegrationsApi
22

3-
All URIs are relative to *https://api.timeular.com/api/v1/*
3+
All URIs are relative to *https://api.timeular.com/api/v2/*
44

55
Method | HTTP request | Description
66
------------- | ------------- | -------------

docs/Note.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Note
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**text** | **str** | | [optional]
7+
**tags** | [**list[NoteTag]**](NoteTag.md) | | [optional]
8+
**mentions** | [**list[NoteMention]**](NoteMention.md) | | [optional]
9+
10+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11+
12+

docs/NoteMention.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# NoteMention
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**indices** | **list[int]** | | [optional]
7+
**key** | **str** | | [optional]
8+
9+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10+
11+

docs/NoteTag.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# NoteTag
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**indices** | **list[int]** | | [optional]
7+
**key** | **str** | | [optional]
8+
9+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10+
11+

docs/TimeEntryCreationRequest.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
66
**activity_id** | **str** | |
77
**started_at** | **str** | |
88
**stopped_at** | **str** | |
9-
**name** | **str** | | [optional]
9+
**note** | [**Note**](Note.md) | | [optional]
1010

1111
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1212

docs/TimeEntryEditionRequest.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
66
**activity_id** | **str** | | [optional]
77
**started_at** | **str** | | [optional]
88
**stopped_at** | **str** | | [optional]
9-
**note** | **str** | | [optional]
9+
**note** | [**Note**](Note.md) | | [optional]
1010

1111
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1212

docs/TimeEntryResponse.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
66
**id** | **str** | | [optional]
77
**activity** | [**TimeEntryActivityResponse**](TimeEntryActivityResponse.md) | | [optional]
88
**duration** | [**TimeEntryDurationResponse**](TimeEntryDurationResponse.md) | | [optional]
9-
**note** | **str** | | [optional]
9+
**note** | [**Note**](Note.md) | | [optional]
1010

1111
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1212

0 commit comments

Comments
 (0)