@timetac/js-client-library

TimeTac Client Library

TimeTac Client Library is a thin wrapper for client to make api request. For more information please visit our documentation.

Installation

Use the package manager yarn or npm to install TimeTac Client Library.

Using yarn:

yarn add @timetac/js-client-library

Using npm:

npm install @timetac/js-client-library

Usage

import Api from "@timetac/js-client-library"
//Only account name is required.
const environment = {
  host: 'go.timetac.com',
  account: <ACCOUNT_NAME>,
  version: '3'
}

const authCredentials = {
  grant_type: 'password',
  client_id: <CLIENT_ID>,
  client_secret: <CLIENT_SECRET>,
  username: <USER_NAME>,
  password: <PASSWORD>
}

const api = new Api(environment);

async() => {
  await api.authentication.login(authCredentials);

  api.timeTrackings.read()
    .then(timetrackings => {
      console.log(timetrackings)
    });

  api.users.getMe().then(meData => {
    console.log(meData);
  });

  api.absenceDays.read(
    new RequestParams<AbsenceDay>()
    .eq('user_id', '1')
    .gteq('date', '2020-01-01')
  );

  api.absenceDay.read({
    user_id: '1',
    date: '2020-01-01',
    _op__date: 'gteq'
  })
}

List of supported endpoints

• authentication
• absenceDays
• absenceBans
• absences
• absenceMultistageResponsibilities
• absenceTypes
• absenceTypesRestrictToCountries
• accessCredentials
• changeTimeTrackingRequests
• checkpoints
• checkpointTrackings
• clients
• countries
• deltaSync
• departments
• files
• generalSettingsChangeLog
• generalSettings
• geofences
• geofenceToNodes
• invoices
• jobParams
• jobQueues
• messages
• nfcTransponders
• notifications
• notificationsTypeHtml
• notificationUrls
• offlineSyncErrors
• permissionsRelatedEndpoints
• projects
• recentTasks
• salutations
• schedulings
• serverCommunication
• serverEvents
• serverTime
• skills
• surveys
• surveyAnswers
• surveySubmits
• surveyQuestions
• surveyQuestionDefinitions
• tasks
• teamMembers
• teams
• timetrackings
• timesheetAccounting
• timesheetAccountingSummaries
• timetrackingChangelogs
• timezones
• todoTasks
• translations
• users
• userStatusOverview
• zohoSubscriptions

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

Apache License 2.0