timeular_public_api_unofficial

v1.0.0

Published

3 years ago

Welcome_to_the_documentation_of_Timeular_Public_API_v1_You_can_try_all_requests_here_in_documentation_with_use_ofTry_it_out_button__available_in_each_endpoint_description_after_folding_it_out_Most_of_endpoints_are_secured__In_order_to_access_them_you_have

Downloads

0High
0Medium
0Low

basster

timeular_public_api

TimeularPublicApi - JavaScript client for timeular_public_api 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 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 SDK is automatically generated by the Swagger Codegen project:

API version: 1
Package version: 1
Build package: io.swagger.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install timeular_public_api --save

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

Finally, switch to the directory you want to use your timeular_public_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('timeular_public_api') in javascript files from the directory you ran the last command above from.

git

If the library is hosted at a git repository, e.g. https://github.com/YOUR_USERNAME/timeular_public_api then install it via:

    npm install YOUR_USERNAME/timeular_public_api --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually use this library):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var TimeularPublicApi = require('timeular_public_api');

var api = new TimeularPublicApi.AuthenticationApi()

var opts = { 
  'aPIKeyAndAPISecret': new TimeularPublicApi.DeveloperSignInRequest() // {DeveloperSignInRequest} API Key and API Secret
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.developerSignIn(opts, callback);

Documentation for API Endpoints

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

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- TimeularPublicApi.AuthenticationApi | developerSignIn | POST /developer/sign-in | Sign-in with API Key & API Secret TimeularPublicApi.AuthenticationApi | getApiKey | GET /developer/api-access | Fetch API Key TimeularPublicApi.AuthenticationApi | getApiKey_0 | POST /developer/api-access | Generate new API Key & API Secret TimeularPublicApi.IntegrationsApi | getIntegration | GET /integrations | List enabled Integrations TimeularPublicApi.ProfileApi | getProfile | GET /user/profile | Fetch User's Profile TimeularPublicApi.TimeTrackingActivitiesApi | archiveActivity | DELETE /activities/{activityId} | Archive an Activity TimeularPublicApi.TimeTrackingActivitiesApi | assignActivityToDeviceSide | POST /activities/{activityId}/device-side/{deviceSide} | Assign an Activity to Device Side TimeularPublicApi.TimeTrackingActivitiesApi | createActivity | POST /activities | Create an Activity TimeularPublicApi.TimeTrackingActivitiesApi | editActivity | PATCH /activities/{activityId} | Edit an Activity TimeularPublicApi.TimeTrackingActivitiesApi | getActivities | GET /activities | List all Activities TimeularPublicApi.TimeTrackingActivitiesApi | getArchivedActivities | GET /archived-activities | List all Archived Activities TimeularPublicApi.TimeTrackingActivitiesApi | getTagsAndMentionsOfActivity | GET /activities/{activityId}/tags-and-mentions | Fetch Tags & Mentions of given Activity TimeularPublicApi.TimeTrackingActivitiesApi | unassignActivityFromDeviceSide | DELETE /activities/{activityId}/device-side/{deviceSide} | Unassign an Activity from a Device Side TimeularPublicApi.TimeTrackingCurrentTrackingApi | editTracking | PATCH /tracking/{activityId} | Edit Tracking TimeularPublicApi.TimeTrackingCurrentTrackingApi | getCurrentTracking | GET /tracking | Show current Tracking TimeularPublicApi.TimeTrackingCurrentTrackingApi | startTracking | POST /tracking/{activityId}/start | Start Tracking TimeularPublicApi.TimeTrackingCurrentTrackingApi | stopTracking | POST /tracking/{activityId}/stop | Stop Tracking TimeularPublicApi.TimeTrackingDevicesApi | activateDevice | POST /devices/{deviceSerial}/active | Activate a Device TimeularPublicApi.TimeTrackingDevicesApi | activateDevice_0 | PATCH /devices/{deviceSerial} | Edit a Device TimeularPublicApi.TimeTrackingDevicesApi | deactivateDevice | DELETE /devices/{deviceSerial}/active | Deactivate a Device TimeularPublicApi.TimeTrackingDevicesApi | disableDevice | POST /devices/{deviceSerial}/disabled | Disable a Device TimeularPublicApi.TimeTrackingDevicesApi | eanbleDevice | DELETE /devices/{deviceSerial}/disabled | Enable a Device TimeularPublicApi.TimeTrackingDevicesApi | forgetDevice | DELETE /devices/{deviceSerial} | Forget known Device TimeularPublicApi.TimeTrackingDevicesApi | getKnownDevices | GET /devices | List all known Devices TimeularPublicApi.TimeTrackingReportsApi | generateCsvReport | GET /report/{startTimestamp}/{stopTimestamp} | Generate CSV Report TimeularPublicApi.TimeTrackingTimeEntriesApi | createTimeEntry | POST /time-entries | Create Time Entry TimeularPublicApi.TimeTrackingTimeEntriesApi | deleteTimeEntry | DELETE /time-entries/{timeEntryId} | Delete a Time Entry TimeularPublicApi.TimeTrackingTimeEntriesApi | editTimeEntry | PATCH /time-entries/{timeEntryId} | Edit a Time Entry TimeularPublicApi.TimeTrackingTimeEntriesApi | getTimeEntriesInRange | GET /time-entries/{stoppedAfter}/{startedBefore} | Find Time Entries in given range TimeularPublicApi.TimeTrackingTimeEntriesApi | getTimeEntry | GET /time-entries/{timeEntryId} | Find Time Entry by its ID

Documentation for Models

Documentation for Authorization

AuthorizationHeader

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