tuix-projects-service-client 0.18.0 → 0.19.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/docs/ClientApi.md CHANGED
@@ -5,81 +5,81 @@ All URIs are relative to *http://localhost:3000*
5
5
  | Method | HTTP request | Description |
6
6
  |------------- | ------------- | -------------|
7
7
  | [**activateEmployee**](ClientApi.md#activateemployee) | **POST** /api/employees/{userId}/activate | Activate an employee |
8
- | [**addJiraAccount**](ClientApi.md#addjiraaccount) | **POST** /jira-users/jira-accounts | Add Jira account |
8
+ | [**addJiraAccount**](ClientApi.md#addjiraaccount) | **POST** /jira-users/jira-accounts | Add a Jira account |
9
9
  | [**apiUpdateTimesheetEntry**](ClientApi.md#apiupdatetimesheetentry) | **PATCH** /api/projects/{projectId}/timesheets/{timesheetId}/entries/{entryId} | Update a timesheet entry |
10
- | [**approveAdjustedTimesheet**](ClientApi.md#approveadjustedtimesheet) | **PATCH** /projects/{projectId}/adjusted-timesheets/{timesheetId}/approve | Approve an adjustedTimesheet in a project |
10
+ | [**approveAdjustedTimesheet**](ClientApi.md#approveadjustedtimesheet) | **PATCH** /projects/{projectId}/adjusted-timesheets/{timesheetId}/approve | Approve an adjusted timesheet |
11
11
  | [**approveGlobalTimesheet**](ClientApi.md#approveglobaltimesheet) | **PATCH** /projects/{projectId}/global-timesheets/{timesheetId}/approve | Approve a global timesheet |
12
12
  | [**approveTimesheet**](ClientApi.md#approvetimesheet) | **PATCH** /projects/{projectId}/timesheets/{timesheetId}/approve | Approve a timesheet |
13
- | [**createClient**](ClientApi.md#createclient) | **POST** /clients | |
14
- | [**createCompany**](ClientApi.md#createcompany) | **POST** /companies | Creates a new company |
13
+ | [**createClient**](ClientApi.md#createclient) | **POST** /clients | Create a client |
14
+ | [**createCompany**](ClientApi.md#createcompany) | **POST** /companies | Create a company |
15
15
  | [**createEmployeeInvoice**](ClientApi.md#createemployeeinvoice) | **POST** /employees/{userId}/invoices | Create an employee invoice |
16
- | [**createGithubUser**](ClientApi.md#creategithubuser) | **POST** /github-users | Create GitHub user |
17
- | [**createHoliday**](ClientApi.md#createholiday) | **POST** /holidays | |
18
- | [**createHolidayForEmployee**](ClientApi.md#createholidayforemployee) | **POST** /employees/{userId}/holidays | |
19
- | [**createJiraUser**](ClientApi.md#createjirauser) | **POST** /jira-users | Create Jira user |
20
- | [**createProject**](ClientApi.md#createproject) | **POST** /projects | Creates a new project |
21
- | [**createSlackUser**](ClientApi.md#createslackuser) | **POST** /slackbot-users | Create Slack user |
22
- | [**createToken**](ClientApi.md#createtoken) | **POST** /pats | Create a new API token with role-based permissions |
23
- | [**deleteClient**](ClientApi.md#deleteclient) | **DELETE** /clients/{clientId} | Delete client |
16
+ | [**createGithubUser**](ClientApi.md#creategithubuser) | **POST** /github-users | Create a GitHub user |
17
+ | [**createHoliday**](ClientApi.md#createholiday) | **POST** /holidays | Create a holiday |
18
+ | [**createHolidayForEmployee**](ClientApi.md#createholidayforemployee) | **POST** /employees/{userId}/holidays | Create a holiday for an employee |
19
+ | [**createJiraUser**](ClientApi.md#createjirauser) | **POST** /jira-users | Create a Jira user |
20
+ | [**createProject**](ClientApi.md#createproject) | **POST** /projects | Create a project |
21
+ | [**createSlackUser**](ClientApi.md#createslackuser) | **POST** /slackbot-users | Create a Slack user |
22
+ | [**createToken**](ClientApi.md#createtoken) | **POST** /pats | Create an API token |
23
+ | [**deleteClient**](ClientApi.md#deleteclient) | **DELETE** /clients/{clientId} | Delete a client |
24
24
  | [**deleteCompany**](ClientApi.md#deletecompany) | **DELETE** /companies/{companyId} | Delete a company |
25
25
  | [**deleteEmployee**](ClientApi.md#deleteemployee) | **DELETE** /employees/{userId} | Delete an employee |
26
26
  | [**deleteEmployeeInvoice**](ClientApi.md#deleteemployeeinvoice) | **DELETE** /employees/{userId}/invoices/{employeeInvoiceId} | Delete an employee invoice |
27
- | [**deleteGithubUser**](ClientApi.md#deletegithubuser) | **DELETE** /github-users | Delete GitHub user |
27
+ | [**deleteGithubUser**](ClientApi.md#deletegithubuser) | **DELETE** /github-users | Delete my GitHub account |
28
28
  | [**deleteHoliday**](ClientApi.md#deleteholiday) | **DELETE** /holidays/{holidayId} | Delete a holiday |
29
29
  | [**deleteHolidayForEmployee**](ClientApi.md#deleteholidayforemployee) | **DELETE** /employees/{userId}/holidays/{holidayId} | Delete an employee\'s holiday |
30
30
  | [**deleteProject**](ClientApi.md#deleteproject) | **DELETE** /projects/{projectId} | Delete a project |
31
- | [**deleteSlackUser**](ClientApi.md#deleteslackuser) | **DELETE** /slackbot-users | Delete Slack user |
32
- | [**deleteToken**](ClientApi.md#deletetoken) | **DELETE** /pats/{tokenId} | Delete an API token by ID |
33
- | [**downloadAdjustedTimesheetPdf**](ClientApi.md#downloadadjustedtimesheetpdf) | **GET** /projects/{projectId}/adjusted-timesheets/{timesheetId}/download | Download an AdjustedTimesheet report in PDF format |
34
- | [**downloadClientInvoicePdf**](ClientApi.md#downloadclientinvoicepdf) | **GET** /clients/{clientId}/invoices/{invoiceId}/download | Download client invoice pdf |
35
- | [**downloadEmployeeInvoicePdf**](ClientApi.md#downloademployeeinvoicepdf) | **GET** /employees/{userId}/invoices/{employeeInvoiceId}/download | Download the employee invoice report in PDF format |
36
- | [**downloadGlobalTimesheetPdf**](ClientApi.md#downloadglobaltimesheetpdf) | **GET** /projects/{projectId}/global-timesheets/{timesheetId}/download | Download a global timesheet report in PDF format |
37
- | [**downloadTimesheetPdf**](ClientApi.md#downloadtimesheetpdf) | **GET** /projects/{projectId}/timesheets/{timesheetId}/download | Download a timesheet report in PDF format |
38
- | [**getAdjustedTimesheet**](ClientApi.md#getadjustedtimesheet) | **GET** /projects/{projectId}/adjusted-timesheets/{timesheetId} | Get an adjustedTimesheet |
39
- | [**getAdjustedTimesheets**](ClientApi.md#getadjustedtimesheets) | **GET** /projects/{projectId}/adjusted-timesheets | Get all adjustedTimesheets in a project |
40
- | [**getClientById**](ClientApi.md#getclientbyid) | **GET** /clients/{clientId} | |
41
- | [**getClientInvoices**](ClientApi.md#getclientinvoices) | **GET** /clients/{clientId}/invoices | Get all invoices from client |
42
- | [**getClients**](ClientApi.md#getclients) | **GET** /clients | Get all clients from company |
43
- | [**getCommitsByUserID**](ClientApi.md#getcommitsbyuserid) | **GET** /employees/{userId}/commits | Get commits by user ID |
44
- | [**getCompanies**](ClientApi.md#getcompanies) | **GET** /companies | Get all companies a user belongs to |
45
- | [**getCompany**](ClientApi.md#getcompany) | **GET** /companies/{companyId} | Get a company by ID |
46
- | [**getEmployee**](ClientApi.md#getemployee) | **GET** /employees/{userId} | Get employee info |
47
- | [**getEmployeeInvoices**](ClientApi.md#getemployeeinvoices) | **GET** /employees/{userId}/invoices | Get all employee invoices |
48
- | [**getEmployeeTimesheets**](ClientApi.md#getemployeetimesheets) | **GET** /projects/{projectId}/employee-timesheets | Get all timesheets of an employee in a project |
31
+ | [**deleteSlackUser**](ClientApi.md#deleteslackuser) | **DELETE** /slackbot-users | Delete my Slack user |
32
+ | [**deleteToken**](ClientApi.md#deletetoken) | **DELETE** /pats/{tokenId} | Delete an API token |
33
+ | [**downloadAdjustedTimesheetPdf**](ClientApi.md#downloadadjustedtimesheetpdf) | **GET** /projects/{projectId}/adjusted-timesheets/{timesheetId}/download | Download an adjusted timesheet PDF |
34
+ | [**downloadClientInvoicePdf**](ClientApi.md#downloadclientinvoicepdf) | **GET** /clients/{clientId}/invoices/{invoiceId}/download | Download a client invoice |
35
+ | [**downloadEmployeeInvoicePdf**](ClientApi.md#downloademployeeinvoicepdf) | **GET** /employees/{userId}/invoices/{employeeInvoiceId}/download | Download an employee invoice PDF |
36
+ | [**downloadGlobalTimesheetPdf**](ClientApi.md#downloadglobaltimesheetpdf) | **GET** /projects/{projectId}/global-timesheets/{timesheetId}/download | Download a global timesheet PDF |
37
+ | [**downloadTimesheetPdf**](ClientApi.md#downloadtimesheetpdf) | **GET** /projects/{projectId}/timesheets/{timesheetId}/download | Download a timesheet PDF |
38
+ | [**getAdjustedTimesheet**](ClientApi.md#getadjustedtimesheet) | **GET** /projects/{projectId}/adjusted-timesheets/{timesheetId} | Get an adjusted timesheet |
39
+ | [**getAdjustedTimesheets**](ClientApi.md#getadjustedtimesheets) | **GET** /projects/{projectId}/adjusted-timesheets | List adjusted timesheets of a project |
40
+ | [**getClientById**](ClientApi.md#getclientbyid) | **GET** /clients/{clientId} | Get a client |
41
+ | [**getClientInvoices**](ClientApi.md#getclientinvoices) | **GET** /clients/{clientId}/invoices | List client invoices |
42
+ | [**getClients**](ClientApi.md#getclients) | **GET** /clients | List clients |
43
+ | [**getCommitsByUserID**](ClientApi.md#getcommitsbyuserid) | **GET** /employees/{userId}/commits | Get commits of an employee |
44
+ | [**getCompanies**](ClientApi.md#getcompanies) | **GET** /companies | List my companies |
45
+ | [**getCompany**](ClientApi.md#getcompany) | **GET** /companies/{companyId} | Get a company |
46
+ | [**getEmployee**](ClientApi.md#getemployee) | **GET** /employees/{userId} | Get an employee |
47
+ | [**getEmployeeInvoices**](ClientApi.md#getemployeeinvoices) | **GET** /employees/{userId}/invoices | List employee invoices |
48
+ | [**getEmployeeTimesheets**](ClientApi.md#getemployeetimesheets) | **GET** /projects/{projectId}/employee-timesheets | List my timesheets in a project |
49
49
  | [**getEmployees**](ClientApi.md#getemployees) | **GET** /employees | List employees |
50
- | [**getGithubAccount**](ClientApi.md#getgithubaccount) | **GET** /github-accounts | Get GitHub account |
50
+ | [**getGithubAccount**](ClientApi.md#getgithubaccount) | **GET** /github-accounts | Get my GitHub account |
51
51
  | [**getGlobalTimesheet**](ClientApi.md#getglobaltimesheet) | **GET** /projects/{projectId}/global-timesheets/{timesheetId} | Get a global timesheet |
52
- | [**getGlobalTimesheets**](ClientApi.md#getglobaltimesheets) | **GET** /projects/{projectId}/global-timesheets | Get all global timesheets in a project |
53
- | [**getHolidays**](ClientApi.md#getholidays) | **GET** /holidays | |
54
- | [**getHolidaysByEmployee**](ClientApi.md#getholidaysbyemployee) | **GET** /employees/{userId}/holidays | |
55
- | [**getJiraAccounts**](ClientApi.md#getjiraaccounts) | **GET** /jira-users/jira-accounts | Get Jira account |
56
- | [**getJiraUser**](ClientApi.md#getjirauser) | **GET** /jira-users | Get Jira user |
57
- | [**getMyAccount**](ClientApi.md#getmyaccount) | **GET** /me | Get my account info |
52
+ | [**getGlobalTimesheets**](ClientApi.md#getglobaltimesheets) | **GET** /projects/{projectId}/global-timesheets | List global timesheets of a project |
53
+ | [**getHolidays**](ClientApi.md#getholidays) | **GET** /holidays | List my holidays |
54
+ | [**getHolidaysByEmployee**](ClientApi.md#getholidaysbyemployee) | **GET** /employees/{userId}/holidays | List an employee\'s holidays |
55
+ | [**getJiraAccounts**](ClientApi.md#getjiraaccounts) | **GET** /jira-users/jira-accounts | List my Jira accounts |
56
+ | [**getJiraUser**](ClientApi.md#getjirauser) | **GET** /jira-users | Get my Jira user |
57
+ | [**getMyAccount**](ClientApi.md#getmyaccount) | **GET** /me | Get my account |
58
58
  | [**getMyCommits**](ClientApi.md#getmycommits) | **GET** /commits | Get my commits |
59
- | [**getProjectById**](ClientApi.md#getprojectbyid) | **GET** /projects/{projectId} | Get a project by ID |
60
- | [**getProjectReportByUser**](ClientApi.md#getprojectreportbyuser) | **GET** /api/project-reports | Get all projects an employee has access to |
61
- | [**getProjects**](ClientApi.md#getprojects) | **GET** /projects | Get all projects a user or employee has access to |
62
- | [**getProjectsAsEmployee**](ClientApi.md#getprojectsasemployee) | **GET** /employee-projects | Get all projects an employee has access to |
63
- | [**getSlackUserAccount**](ClientApi.md#getslackuseraccount) | **GET** /slackbot-users | Get Slack user account |
64
- | [**getTeam**](ClientApi.md#getteam) | **GET** /projects/{projectId}/team | Get all users in a project |
59
+ | [**getProjectById**](ClientApi.md#getprojectbyid) | **GET** /projects/{projectId} | Get a project |
60
+ | [**getProjectReportByUser**](ClientApi.md#getprojectreportbyuser) | **GET** /api/project-reports | Get project report of an employee |
61
+ | [**getProjects**](ClientApi.md#getprojects) | **GET** /projects | List projects |
62
+ | [**getProjectsAsEmployee**](ClientApi.md#getprojectsasemployee) | **GET** /employee-projects | List my projects |
63
+ | [**getSlackUserAccount**](ClientApi.md#getslackuseraccount) | **GET** /slackbot-users | Get my Slack account |
64
+ | [**getTeam**](ClientApi.md#getteam) | **GET** /projects/{projectId}/team | Get a project team |
65
65
  | [**getTimesheet**](ClientApi.md#gettimesheet) | **GET** /projects/{projectId}/timesheets/{timesheetId} | Get a timesheet |
66
- | [**getTimesheets**](ClientApi.md#gettimesheets) | **GET** /projects/{projectId}/timesheets | Get all timesheets in a project without timesheet entries. |
67
- | [**getToken**](ClientApi.md#gettoken) | **GET** /pats/{tokenId} | Get a specific API token by ID |
68
- | [**getUserPermissions**](ClientApi.md#getuserpermissions) | **GET** /permissions | Get all available permissions for current user based on their role |
69
- | [**getUserTokens**](ClientApi.md#getusertokens) | **GET** /pats | Get all API tokens for current user with pagination |
70
- | [**inviteEmployee**](ClientApi.md#inviteemployee) | **POST** /employees/invite | Invite an employee to a company |
66
+ | [**getTimesheets**](ClientApi.md#gettimesheets) | **GET** /projects/{projectId}/timesheets | List timesheets of a project |
67
+ | [**getToken**](ClientApi.md#gettoken) | **GET** /pats/{tokenId} | Get an API token |
68
+ | [**getUserPermissions**](ClientApi.md#getuserpermissions) | **GET** /permissions | List my permissions |
69
+ | [**getUserTokens**](ClientApi.md#getusertokens) | **GET** /pats | List my API tokens |
70
+ | [**inviteEmployee**](ClientApi.md#inviteemployee) | **POST** /employees/invite | Invite an employee |
71
71
  | [**markEmployeeInvoiceAsPaid**](ClientApi.md#markemployeeinvoiceaspaid) | **POST** /employees/{userId}/invoices/{employeeInvoiceId}/mark-paid | Mark an employee invoice as paid |
72
- | [**markInvoiceAsPaid**](ClientApi.md#markinvoiceaspaid) | **POST** /clients/{clientId}/invoices/{invoiceId}/mark-paid | Mark a client invoice as paid with the specified date and time |
73
- | [**openSentTimesheet**](ClientApi.md#opensenttimesheet) | **PATCH** /projects/{projectId}/timesheets/{timesheetId}/open | Open a sent timesheet |
74
- | [**removeJiraAccount**](ClientApi.md#removejiraaccount) | **DELETE** /jira-users/jira-accounts/{jiraAccountId} | Remove jira account |
72
+ | [**markInvoiceAsPaid**](ClientApi.md#markinvoiceaspaid) | **POST** /clients/{clientId}/invoices/{invoiceId}/mark-paid | Mark a client invoice as paid |
73
+ | [**openSentTimesheet**](ClientApi.md#opensenttimesheet) | **PATCH** /projects/{projectId}/timesheets/{timesheetId}/open | Reopen a sent timesheet |
74
+ | [**removeJiraAccount**](ClientApi.md#removejiraaccount) | **DELETE** /jira-users/jira-accounts/{jiraAccountId} | Remove a Jira account |
75
75
  | [**sendTimesheet**](ClientApi.md#sendtimesheet) | **PATCH** /projects/{projectId}/timesheets/{timesheetId}/send | Send a timesheet |
76
76
  | [**updateAdjustedEntry**](ClientApi.md#updateadjustedentry) | **PATCH** /projects/{projectId}/adjusted-timesheets/{timesheetId}/entries/{entryId} | Update an adjusted timesheet entry |
77
- | [**updateClient**](ClientApi.md#updateclient) | **PATCH** /clients/{clientId} | |
78
- | [**updateCompany**](ClientApi.md#updatecompany) | **PATCH** /companies/{companyId} | Update a company by ID |
77
+ | [**updateClient**](ClientApi.md#updateclient) | **PATCH** /clients/{clientId} | Update a client |
78
+ | [**updateCompany**](ClientApi.md#updatecompany) | **PATCH** /companies/{companyId} | Update a company |
79
79
  | [**updateEmployeeData**](ClientApi.md#updateemployeedata) | **PATCH** /employees/{userId} | Update an employee |
80
80
  | [**updateGlobalTimesheetEntry**](ClientApi.md#updateglobaltimesheetentry) | **PATCH** /projects/{projectId}/global-timesheets/{timesheetId}/entries/{entryId} | Update a global timesheet entry |
81
- | [**updateProject**](ClientApi.md#updateproject) | **PATCH** /projects/{projectId} | Update a project by ID |
82
- | [**updateSlackUser**](ClientApi.md#updateslackuser) | **PATCH** /slackbot-users | Update Slack user |
81
+ | [**updateProject**](ClientApi.md#updateproject) | **PATCH** /projects/{projectId} | Update a project |
82
+ | [**updateSlackUser**](ClientApi.md#updateslackuser) | **PATCH** /slackbot-users | Update my Slack user |
83
83
  | [**updateTeam**](ClientApi.md#updateteam) | **PATCH** /projects/{projectId}/team | Update a project team |
84
84
  | [**updateTimesheetEntry**](ClientApi.md#updatetimesheetentry) | **PATCH** /projects/{projectId}/timesheets/{timesheetId}/entries/{entryId} | Update a timesheet entry |
85
85
 
@@ -91,7 +91,7 @@ All URIs are relative to *http://localhost:3000*
91
91
 
92
92
  Activate an employee
93
93
 
94
- Activate an employee, linking it to its Auth0 user id
94
+ Activate an invited employee by linking it to its Auth0 user. Internal endpoint.
95
95
 
96
96
  ### Example
97
97
 
@@ -111,7 +111,7 @@ async function example() {
111
111
  const api = new ClientApi(config);
112
112
 
113
113
  const body = {
114
- // string | User ID
114
+ // string | User ID of the employee
115
115
  userId: userId_example,
116
116
  // ActivateEmployeeDTO | Auth0 id and company id to activate the employee with
117
117
  activateEmployeeDTO: ...,
@@ -134,7 +134,7 @@ example().catch(console.error);
134
134
 
135
135
  | Name | Type | Description | Notes |
136
136
  |------------- | ------------- | ------------- | -------------|
137
- | **userId** | `string` | User ID | [Defaults to `undefined`] |
137
+ | **userId** | `string` | User ID of the employee | [Defaults to `undefined`] |
138
138
  | **activateEmployeeDTO** | [ActivateEmployeeDTO](ActivateEmployeeDTO.md) | Auth0 id and company id to activate the employee with | |
139
139
 
140
140
  ### Return type
@@ -167,9 +167,9 @@ example().catch(console.error);
167
167
 
168
168
  > JiraAccountDTO addJiraAccount(createJiraAccountDTO)
169
169
 
170
- Add Jira account
170
+ Add a Jira account
171
171
 
172
- Add a new Jira account for the authenticated user
172
+ Link a Jira account to the current user.
173
173
 
174
174
  ### Example
175
175
 
@@ -244,7 +244,7 @@ example().catch(console.error);
244
244
 
245
245
  Update a timesheet entry
246
246
 
247
- Update a timesheet entry
247
+ Update or change the hours of a day in an employee timesheet. Only possible while the timesheet is OPEN. Internal endpoint.
248
248
 
249
249
  ### Example
250
250
 
@@ -268,7 +268,7 @@ async function example() {
268
268
  projectId: projectId_example,
269
269
  // string | Timesheet ID
270
270
  timesheetId: timesheetId_example,
271
- // string | Entry ID
271
+ // string | Timesheet entry ID (one day of the timesheet)
272
272
  entryId: entryId_example,
273
273
  // TimesheetEntryUpdateDTO | Entry to update
274
274
  timesheetEntryUpdateDTO: ...,
@@ -293,7 +293,7 @@ example().catch(console.error);
293
293
  |------------- | ------------- | ------------- | -------------|
294
294
  | **projectId** | `string` | Project ID | [Defaults to `undefined`] |
295
295
  | **timesheetId** | `string` | Timesheet ID | [Defaults to `undefined`] |
296
- | **entryId** | `string` | Entry ID | [Defaults to `undefined`] |
296
+ | **entryId** | `string` | Timesheet entry ID (one day of the timesheet) | [Defaults to `undefined`] |
297
297
  | **timesheetEntryUpdateDTO** | [TimesheetEntryUpdateDTO](TimesheetEntryUpdateDTO.md) | Entry to update | |
298
298
 
299
299
  ### Return type
@@ -328,9 +328,9 @@ example().catch(console.error);
328
328
 
329
329
  > approveAdjustedTimesheet(projectId, timesheetId)
330
330
 
331
- Approve an adjustedTimesheet in a project
331
+ Approve an adjusted timesheet
332
332
 
333
- Approve an adjustedTimesheet in a project
333
+ Approve an OPEN adjusted timesheet. When all adjusted timesheets of the project for that month are approved, the monthly global timesheet is created automatically.
334
334
 
335
335
  ### Example
336
336
 
@@ -352,7 +352,7 @@ async function example() {
352
352
  const body = {
353
353
  // string | Project ID
354
354
  projectId: projectId_example,
355
- // string | Timesheet ID
355
+ // string | Adjusted timesheet ID
356
356
  timesheetId: timesheetId_example,
357
357
  } satisfies ApproveAdjustedTimesheetRequest;
358
358
 
@@ -374,7 +374,7 @@ example().catch(console.error);
374
374
  | Name | Type | Description | Notes |
375
375
  |------------- | ------------- | ------------- | -------------|
376
376
  | **projectId** | `string` | Project ID | [Defaults to `undefined`] |
377
- | **timesheetId** | `string` | Timesheet ID | [Defaults to `undefined`] |
377
+ | **timesheetId** | `string` | Adjusted timesheet ID | [Defaults to `undefined`] |
378
378
 
379
379
  ### Return type
380
380
 
@@ -410,7 +410,7 @@ example().catch(console.error);
410
410
 
411
411
  Approve a global timesheet
412
412
 
413
- Approve a global timesheet
413
+ Approve an OPEN global timesheet. This creates the client invoice automatically.
414
414
 
415
415
  ### Example
416
416
 
@@ -432,7 +432,7 @@ async function example() {
432
432
  const body = {
433
433
  // string | Project ID
434
434
  projectId: projectId_example,
435
- // string | Timesheet ID
435
+ // string | Global timesheet ID
436
436
  timesheetId: timesheetId_example,
437
437
  } satisfies ApproveGlobalTimesheetRequest;
438
438
 
@@ -454,7 +454,7 @@ example().catch(console.error);
454
454
  | Name | Type | Description | Notes |
455
455
  |------------- | ------------- | ------------- | -------------|
456
456
  | **projectId** | `string` | Project ID | [Defaults to `undefined`] |
457
- | **timesheetId** | `string` | Timesheet ID | [Defaults to `undefined`] |
457
+ | **timesheetId** | `string` | Global timesheet ID | [Defaults to `undefined`] |
458
458
 
459
459
  ### Return type
460
460
 
@@ -473,7 +473,7 @@ example().catch(console.error);
473
473
  ### HTTP response details
474
474
  | Status code | Description | Response headers |
475
475
  |-------------|-------------|------------------|
476
- | **204** | Approve a timesheet | - |
476
+ | **204** | Global timesheet approved and client invoice created | - |
477
477
  | **400** | Return an error if provided ID is not a valid UUID | - |
478
478
  | **401** | Return an error if the user is not authorized | - |
479
479
  | **402** | Return an error if payment is required | - |
@@ -490,7 +490,7 @@ example().catch(console.error);
490
490
 
491
491
  Approve a timesheet
492
492
 
493
- Approve a timesheet
493
+ Approve a SENT timesheet. This creates its adjusted timesheet automatically.
494
494
 
495
495
  ### Example
496
496
 
@@ -568,9 +568,9 @@ example().catch(console.error);
568
568
 
569
569
  > ClientDTO createClient(clientDTO)
570
570
 
571
+ Create a client
571
572
 
572
-
573
- Create client
573
+ Create a client (customer).
574
574
 
575
575
  ### Example
576
576
 
@@ -646,10 +646,10 @@ example().catch(console.error);
646
646
 
647
647
  > CompanyDTO createCompany(companyDTO)
648
648
 
649
- Creates a new company
650
-
651
649
  Create a company
652
650
 
651
+ Create a company and make the current user its admin.
652
+
653
653
  ### Example
654
654
 
655
655
  ```ts
@@ -723,7 +723,7 @@ example().catch(console.error);
723
723
 
724
724
  Create an employee invoice
725
725
 
726
- Create an employee invoice
726
+ Create a monthly payment invoice for an employee.
727
727
 
728
728
  ### Example
729
729
 
@@ -743,7 +743,7 @@ async function example() {
743
743
  const api = new ClientApi(config);
744
744
 
745
745
  const body = {
746
- // string | User ID
746
+ // string | User ID of the employee
747
747
  userId: userId_example,
748
748
  // CreateEmployeeInvoiceInputDTO | Input to create the employee invoice
749
749
  createEmployeeInvoiceInputDTO: ...,
@@ -766,7 +766,7 @@ example().catch(console.error);
766
766
 
767
767
  | Name | Type | Description | Notes |
768
768
  |------------- | ------------- | ------------- | -------------|
769
- | **userId** | `string` | User ID | [Defaults to `undefined`] |
769
+ | **userId** | `string` | User ID of the employee | [Defaults to `undefined`] |
770
770
  | **createEmployeeInvoiceInputDTO** | [CreateEmployeeInvoiceInputDTO](CreateEmployeeInvoiceInputDTO.md) | Input to create the employee invoice | |
771
771
 
772
772
  ### Return type
@@ -801,9 +801,9 @@ example().catch(console.error);
801
801
 
802
802
  > ClientGithubUserDTO createGithubUser(createGithubUserRequestDTO)
803
803
 
804
- Create GitHub user
804
+ Create a GitHub user
805
805
 
806
- Create a new GitHub user account
806
+ Link a GitHub account to the current user.
807
807
 
808
808
  ### Example
809
809
 
@@ -874,9 +874,9 @@ example().catch(console.error);
874
874
 
875
875
  > HolidayDTO createHoliday(holidayCreateDTO)
876
876
 
877
+ Create a holiday
877
878
 
878
-
879
- Allows a user to add a holiday
879
+ Create (book) a holiday or day off for the current user. The date must be at least 14 days in the future.
880
880
 
881
881
  ### Example
882
882
 
@@ -896,7 +896,7 @@ async function example() {
896
896
  const api = new ClientApi(config);
897
897
 
898
898
  const body = {
899
- // HolidayCreateDTO | Holiday Facts
899
+ // HolidayCreateDTO | Holiday date (date-time, e.g. 2024-10-15T00:00:00Z)
900
900
  holidayCreateDTO: ...,
901
901
  } satisfies CreateHolidayRequest;
902
902
 
@@ -917,7 +917,7 @@ example().catch(console.error);
917
917
 
918
918
  | Name | Type | Description | Notes |
919
919
  |------------- | ------------- | ------------- | -------------|
920
- | **holidayCreateDTO** | [HolidayCreateDTO](HolidayCreateDTO.md) | Holiday Facts | |
920
+ | **holidayCreateDTO** | [HolidayCreateDTO](HolidayCreateDTO.md) | Holiday date (date-time, e.g. 2024-10-15T00:00:00Z) | |
921
921
 
922
922
  ### Return type
923
923
 
@@ -936,7 +936,7 @@ example().catch(console.error);
936
936
  ### HTTP response details
937
937
  | Status code | Description | Response headers |
938
938
  |-------------|-------------|------------------|
939
- | **201** | Return the created client | - |
939
+ | **201** | Return the created holiday | - |
940
940
  | **400** | Return an error if there is a missing or invalid field | - |
941
941
  | **401** | Return an error if the user is not authorized | - |
942
942
  | **402** | Return an error if payment is required | - |
@@ -954,9 +954,9 @@ example().catch(console.error);
954
954
 
955
955
  > HolidayDTO createHolidayForEmployee(userId, holidayCreateDTO)
956
956
 
957
+ Create a holiday for an employee
957
958
 
958
-
959
- Allows an admin to add a holiday to an employee, ignoring the minimum allowed date
959
+ Create (book) a holiday or day off for an employee, without the 14-day minimum notice. Admin only.
960
960
 
961
961
  ### Example
962
962
 
@@ -976,9 +976,9 @@ async function example() {
976
976
  const api = new ClientApi(config);
977
977
 
978
978
  const body = {
979
- // string | User ID
979
+ // string | User ID of the employee
980
980
  userId: userId_example,
981
- // HolidayCreateDTO | Holiday Facts
981
+ // HolidayCreateDTO | Holiday date (date-time, e.g. 2024-10-15T00:00:00Z)
982
982
  holidayCreateDTO: ...,
983
983
  } satisfies CreateHolidayForEmployeeRequest;
984
984
 
@@ -999,8 +999,8 @@ example().catch(console.error);
999
999
 
1000
1000
  | Name | Type | Description | Notes |
1001
1001
  |------------- | ------------- | ------------- | -------------|
1002
- | **userId** | `string` | User ID | [Defaults to `undefined`] |
1003
- | **holidayCreateDTO** | [HolidayCreateDTO](HolidayCreateDTO.md) | Holiday Facts | |
1002
+ | **userId** | `string` | User ID of the employee | [Defaults to `undefined`] |
1003
+ | **holidayCreateDTO** | [HolidayCreateDTO](HolidayCreateDTO.md) | Holiday date (date-time, e.g. 2024-10-15T00:00:00Z) | |
1004
1004
 
1005
1005
  ### Return type
1006
1006
 
@@ -1037,9 +1037,9 @@ example().catch(console.error);
1037
1037
 
1038
1038
  > ClientJiraUserDTO createJiraUser(createJiraUserRequestDTO)
1039
1039
 
1040
- Create Jira user
1040
+ Create a Jira user
1041
1041
 
1042
- Create a new Jira user
1042
+ Create a Jira user for the current user.
1043
1043
 
1044
1044
  ### Example
1045
1045
 
@@ -1111,10 +1111,10 @@ example().catch(console.error);
1111
1111
 
1112
1112
  > ProjectDTO createProject(projectInputDTO)
1113
1113
 
1114
- Creates a new project
1115
-
1116
1114
  Create a project
1117
1115
 
1116
+ Create a project for a client.
1117
+
1118
1118
  ### Example
1119
1119
 
1120
1120
  ```ts
@@ -1188,9 +1188,9 @@ example().catch(console.error);
1188
1188
 
1189
1189
  > ClientSlackUserAccountDTO createSlackUser(createSlackUserRequestDTO)
1190
1190
 
1191
- Create Slack user
1191
+ Create a Slack user
1192
1192
 
1193
- Create a new Slack user account for the authenticated user
1193
+ Link a Slack account to the current user.
1194
1194
 
1195
1195
  ### Example
1196
1196
 
@@ -1261,9 +1261,9 @@ example().catch(console.error);
1261
1261
 
1262
1262
  > CreateTokenResponseDTO createToken(tokenInputDTO)
1263
1263
 
1264
- Create a new API token with role-based permissions
1264
+ Create an API token
1265
1265
 
1266
- Create a new API token
1266
+ Create a personal API token for the current user. The token value is shown only once.
1267
1267
 
1268
1268
  ### Example
1269
1269
 
@@ -1337,9 +1337,9 @@ example().catch(console.error);
1337
1337
 
1338
1338
  > deleteClient(clientId)
1339
1339
 
1340
- Delete client
1340
+ Delete a client
1341
1341
 
1342
- Delete client
1342
+ Delete a client (customer).
1343
1343
 
1344
1344
  ### Example
1345
1345
 
@@ -1416,7 +1416,7 @@ example().catch(console.error);
1416
1416
 
1417
1417
  Delete a company
1418
1418
 
1419
- Delete a company
1419
+ Delete a company and all its data: clients, projects, timesheets and employee memberships. This cannot be undone.
1420
1420
 
1421
1421
  ### Example
1422
1422
 
@@ -1493,7 +1493,7 @@ example().catch(console.error);
1493
1493
 
1494
1494
  Delete an employee
1495
1495
 
1496
- Delete an employee
1496
+ Remove an employee and delete their future timesheets.
1497
1497
 
1498
1498
  ### Example
1499
1499
 
@@ -1513,7 +1513,7 @@ async function example() {
1513
1513
  const api = new ClientApi(config);
1514
1514
 
1515
1515
  const body = {
1516
- // string | User ID
1516
+ // string | User ID of the employee
1517
1517
  userId: userId_example,
1518
1518
  } satisfies DeleteEmployeeRequest;
1519
1519
 
@@ -1534,7 +1534,7 @@ example().catch(console.error);
1534
1534
 
1535
1535
  | Name | Type | Description | Notes |
1536
1536
  |------------- | ------------- | ------------- | -------------|
1537
- | **userId** | `string` | User ID | [Defaults to `undefined`] |
1537
+ | **userId** | `string` | User ID of the employee | [Defaults to `undefined`] |
1538
1538
 
1539
1539
  ### Return type
1540
1540
 
@@ -1569,7 +1569,7 @@ example().catch(console.error);
1569
1569
 
1570
1570
  Delete an employee invoice
1571
1571
 
1572
- Delete an employee invoice
1572
+ Delete an employee invoice. Paid invoices cannot be deleted.
1573
1573
 
1574
1574
  ### Example
1575
1575
 
@@ -1589,7 +1589,7 @@ async function example() {
1589
1589
  const api = new ClientApi(config);
1590
1590
 
1591
1591
  const body = {
1592
- // string | User ID
1592
+ // string | User ID of the employee
1593
1593
  userId: userId_example,
1594
1594
  // string | Employee Invoice ID
1595
1595
  employeeInvoiceId: employeeInvoiceId_example,
@@ -1612,7 +1612,7 @@ example().catch(console.error);
1612
1612
 
1613
1613
  | Name | Type | Description | Notes |
1614
1614
  |------------- | ------------- | ------------- | -------------|
1615
- | **userId** | `string` | User ID | [Defaults to `undefined`] |
1615
+ | **userId** | `string` | User ID of the employee | [Defaults to `undefined`] |
1616
1616
  | **employeeInvoiceId** | `string` | Employee Invoice ID | [Defaults to `undefined`] |
1617
1617
 
1618
1618
  ### Return type
@@ -1632,7 +1632,7 @@ example().catch(console.error);
1632
1632
  ### HTTP response details
1633
1633
  | Status code | Description | Response headers |
1634
1634
  |-------------|-------------|------------------|
1635
- | **204** | Delete an employee | - |
1635
+ | **204** | Employee invoice deleted | - |
1636
1636
  | **400** | Return an error if the invoice is already paid | - |
1637
1637
  | **401** | Return an error if the user is not authenticated | - |
1638
1638
  | **402** | Return an error if payment is required | - |
@@ -1647,9 +1647,9 @@ example().catch(console.error);
1647
1647
 
1648
1648
  > deleteGithubUser()
1649
1649
 
1650
- Delete GitHub user
1650
+ Delete my GitHub account
1651
1651
 
1652
- Delete the authenticated user\'s GitHub account
1652
+ Unlink and delete the GitHub account of the current user.
1653
1653
 
1654
1654
  ### Example
1655
1655
 
@@ -1715,7 +1715,7 @@ This endpoint does not need any parameter.
1715
1715
 
1716
1716
  Delete a holiday
1717
1717
 
1718
- Delete a holiday
1718
+ Delete (cancel) a holiday of the current user. The date must be at least 14 days in the future.
1719
1719
 
1720
1720
  ### Example
1721
1721
 
@@ -1793,7 +1793,7 @@ example().catch(console.error);
1793
1793
 
1794
1794
  Delete an employee\'s holiday
1795
1795
 
1796
- Allows an admin to delete an employee\'s holiday, ignoring the minimum allowed date
1796
+ Delete (cancel) a holiday of an employee, without the 14-day minimum notice. Admin only.
1797
1797
 
1798
1798
  ### Example
1799
1799
 
@@ -1813,7 +1813,7 @@ async function example() {
1813
1813
  const api = new ClientApi(config);
1814
1814
 
1815
1815
  const body = {
1816
- // string | User ID
1816
+ // string | User ID of the employee
1817
1817
  userId: userId_example,
1818
1818
  // string | Holiday ID
1819
1819
  holidayId: holidayId_example,
@@ -1836,7 +1836,7 @@ example().catch(console.error);
1836
1836
 
1837
1837
  | Name | Type | Description | Notes |
1838
1838
  |------------- | ------------- | ------------- | -------------|
1839
- | **userId** | `string` | User ID | [Defaults to `undefined`] |
1839
+ | **userId** | `string` | User ID of the employee | [Defaults to `undefined`] |
1840
1840
  | **holidayId** | `string` | Holiday ID | [Defaults to `undefined`] |
1841
1841
 
1842
1842
  ### Return type
@@ -1874,7 +1874,7 @@ example().catch(console.error);
1874
1874
 
1875
1875
  Delete a project
1876
1876
 
1877
- Delete a project
1877
+ Delete a project.
1878
1878
 
1879
1879
  ### Example
1880
1880
 
@@ -1949,9 +1949,9 @@ example().catch(console.error);
1949
1949
 
1950
1950
  > deleteSlackUser()
1951
1951
 
1952
- Delete Slack user
1952
+ Delete my Slack user
1953
1953
 
1954
- Delete the authenticated user\'s Slack account
1954
+ Unlink and delete the Slack account of the current user.
1955
1955
 
1956
1956
  ### Example
1957
1957
 
@@ -2015,9 +2015,9 @@ This endpoint does not need any parameter.
2015
2015
 
2016
2016
  > deleteToken(tokenId)
2017
2017
 
2018
- Delete an API token by ID
2018
+ Delete an API token
2019
2019
 
2020
- Delete token
2020
+ Delete (revoke) a personal API token of the current user.
2021
2021
 
2022
2022
  ### Example
2023
2023
 
@@ -2091,9 +2091,9 @@ example().catch(console.error);
2091
2091
 
2092
2092
  > string downloadAdjustedTimesheetPdf(projectId, timesheetId)
2093
2093
 
2094
- Download an AdjustedTimesheet report in PDF format
2094
+ Download an adjusted timesheet PDF
2095
2095
 
2096
- Download an AdjustedTimesheet report in PDF format
2096
+ Download the PDF report of an approved adjusted timesheet.
2097
2097
 
2098
2098
  ### Example
2099
2099
 
@@ -2115,7 +2115,7 @@ async function example() {
2115
2115
  const body = {
2116
2116
  // string | Project ID
2117
2117
  projectId: projectId_example,
2118
- // string | Timesheet ID
2118
+ // string | Adjusted timesheet ID
2119
2119
  timesheetId: timesheetId_example,
2120
2120
  } satisfies DownloadAdjustedTimesheetPdfRequest;
2121
2121
 
@@ -2137,7 +2137,7 @@ example().catch(console.error);
2137
2137
  | Name | Type | Description | Notes |
2138
2138
  |------------- | ------------- | ------------- | -------------|
2139
2139
  | **projectId** | `string` | Project ID | [Defaults to `undefined`] |
2140
- | **timesheetId** | `string` | Timesheet ID | [Defaults to `undefined`] |
2140
+ | **timesheetId** | `string` | Adjusted timesheet ID | [Defaults to `undefined`] |
2141
2141
 
2142
2142
  ### Return type
2143
2143
 
@@ -2171,9 +2171,9 @@ example().catch(console.error);
2171
2171
 
2172
2172
  > string downloadClientInvoicePdf(invoiceId, clientId)
2173
2173
 
2174
- Download client invoice pdf
2174
+ Download a client invoice
2175
2175
 
2176
- Download client invoice pdf
2176
+ Download a client invoice file. Returns the signed e-invoice when available, otherwise the PDF.
2177
2177
 
2178
2178
  ### Example
2179
2179
 
@@ -2251,9 +2251,9 @@ example().catch(console.error);
2251
2251
 
2252
2252
  > string downloadEmployeeInvoicePdf(userId, employeeInvoiceId)
2253
2253
 
2254
- Download the employee invoice report in PDF format
2254
+ Download an employee invoice PDF
2255
2255
 
2256
- Download the employee invoice report in PDF format
2256
+ Download the PDF of an employee invoice.
2257
2257
 
2258
2258
  ### Example
2259
2259
 
@@ -2273,7 +2273,7 @@ async function example() {
2273
2273
  const api = new ClientApi(config);
2274
2274
 
2275
2275
  const body = {
2276
- // string | User ID
2276
+ // string | User ID of the employee
2277
2277
  userId: userId_example,
2278
2278
  // string | Employee Invoice ID
2279
2279
  employeeInvoiceId: employeeInvoiceId_example,
@@ -2296,7 +2296,7 @@ example().catch(console.error);
2296
2296
 
2297
2297
  | Name | Type | Description | Notes |
2298
2298
  |------------- | ------------- | ------------- | -------------|
2299
- | **userId** | `string` | User ID | [Defaults to `undefined`] |
2299
+ | **userId** | `string` | User ID of the employee | [Defaults to `undefined`] |
2300
2300
  | **employeeInvoiceId** | `string` | Employee Invoice ID | [Defaults to `undefined`] |
2301
2301
 
2302
2302
  ### Return type
@@ -2331,9 +2331,9 @@ example().catch(console.error);
2331
2331
 
2332
2332
  > string downloadGlobalTimesheetPdf(projectId, timesheetId)
2333
2333
 
2334
- Download a global timesheet report in PDF format
2334
+ Download a global timesheet PDF
2335
2335
 
2336
- Download a global timesheet report in PDF format
2336
+ Download the PDF report of an approved global timesheet.
2337
2337
 
2338
2338
  ### Example
2339
2339
 
@@ -2355,7 +2355,7 @@ async function example() {
2355
2355
  const body = {
2356
2356
  // string | Project ID
2357
2357
  projectId: projectId_example,
2358
- // string | Timesheet ID
2358
+ // string | Global timesheet ID
2359
2359
  timesheetId: timesheetId_example,
2360
2360
  } satisfies DownloadGlobalTimesheetPdfRequest;
2361
2361
 
@@ -2377,7 +2377,7 @@ example().catch(console.error);
2377
2377
  | Name | Type | Description | Notes |
2378
2378
  |------------- | ------------- | ------------- | -------------|
2379
2379
  | **projectId** | `string` | Project ID | [Defaults to `undefined`] |
2380
- | **timesheetId** | `string` | Timesheet ID | [Defaults to `undefined`] |
2380
+ | **timesheetId** | `string` | Global timesheet ID | [Defaults to `undefined`] |
2381
2381
 
2382
2382
  ### Return type
2383
2383
 
@@ -2411,9 +2411,9 @@ example().catch(console.error);
2411
2411
 
2412
2412
  > string downloadTimesheetPdf(projectId, timesheetId)
2413
2413
 
2414
- Download a timesheet report in PDF format
2414
+ Download a timesheet PDF
2415
2415
 
2416
- Download a timesheet report in PDF format
2416
+ Download the PDF report of an approved timesheet.
2417
2417
 
2418
2418
  ### Example
2419
2419
 
@@ -2491,9 +2491,9 @@ example().catch(console.error);
2491
2491
 
2492
2492
  > AdjustedTimesheetDTO getAdjustedTimesheet(projectId, timesheetId)
2493
2493
 
2494
- Get an adjustedTimesheet
2494
+ Get an adjusted timesheet
2495
2495
 
2496
- Get an adjustedTimesheet
2496
+ Get an adjusted timesheet of a project with its daily entries. An adjusted timesheet is the admin-reviewed copy of an approved employee timesheet.
2497
2497
 
2498
2498
  ### Example
2499
2499
 
@@ -2515,7 +2515,7 @@ async function example() {
2515
2515
  const body = {
2516
2516
  // string | Project ID
2517
2517
  projectId: projectId_example,
2518
- // string | AdjustedTimesheet ID
2518
+ // string | Adjusted timesheet ID
2519
2519
  timesheetId: timesheetId_example,
2520
2520
  } satisfies GetAdjustedTimesheetRequest;
2521
2521
 
@@ -2537,7 +2537,7 @@ example().catch(console.error);
2537
2537
  | Name | Type | Description | Notes |
2538
2538
  |------------- | ------------- | ------------- | -------------|
2539
2539
  | **projectId** | `string` | Project ID | [Defaults to `undefined`] |
2540
- | **timesheetId** | `string` | AdjustedTimesheet ID | [Defaults to `undefined`] |
2540
+ | **timesheetId** | `string` | Adjusted timesheet ID | [Defaults to `undefined`] |
2541
2541
 
2542
2542
  ### Return type
2543
2543
 
@@ -2571,9 +2571,9 @@ example().catch(console.error);
2571
2571
 
2572
2572
  > PaginatedAdjustedTimesheets getAdjustedTimesheets(projectId, page, pageSize, search)
2573
2573
 
2574
- Get all adjustedTimesheets in a project
2574
+ List adjusted timesheets of a project
2575
2575
 
2576
- Get all adjustedTimesheets in a project
2576
+ List the adjusted timesheets of a project, one per employee per month.
2577
2577
 
2578
2578
  ### Example
2579
2579
 
@@ -2657,9 +2657,9 @@ example().catch(console.error);
2657
2657
 
2658
2658
  > ClientDTO getClientById(clientId)
2659
2659
 
2660
+ Get a client
2660
2661
 
2661
-
2662
- Get client by id
2662
+ Get a client (customer) by ID.
2663
2663
 
2664
2664
  ### Example
2665
2665
 
@@ -2734,9 +2734,9 @@ example().catch(console.error);
2734
2734
 
2735
2735
  > PaginatedClientInvoices getClientInvoices(clientId, page, pageSize, search)
2736
2736
 
2737
- Get all invoices from client
2737
+ List client invoices
2738
2738
 
2739
- Get all invoices from client
2739
+ List the invoices issued to a client. Client invoices are created automatically when a global timesheet is approved.
2740
2740
 
2741
2741
  ### Example
2742
2742
 
@@ -2820,9 +2820,9 @@ example().catch(console.error);
2820
2820
 
2821
2821
  > PaginatedClients getClients(page, pageSize, search)
2822
2822
 
2823
- Get all clients from company
2823
+ List clients
2824
2824
 
2825
- Get all clients from company
2825
+ List the clients (customers).
2826
2826
 
2827
2827
  ### Example
2828
2828
 
@@ -2903,9 +2903,9 @@ example().catch(console.error);
2903
2903
 
2904
2904
  > Array<ClientGithubCommitCountDTO> getCommitsByUserID(userId, from, to, groupBy)
2905
2905
 
2906
- Get commits by user ID
2906
+ Get commits of an employee
2907
2907
 
2908
- Get commit statistics for a specific user
2908
+ Get the GitHub commit statistics of an employee for a date range.
2909
2909
 
2910
2910
  ### Example
2911
2911
 
@@ -2925,13 +2925,13 @@ async function example() {
2925
2925
  const api = new ClientApi(config);
2926
2926
 
2927
2927
  const body = {
2928
- // string | User ID
2928
+ // string | User ID of the employee
2929
2929
  userId: userId_example,
2930
2930
  // Date | Start date (YYYY-MM-DD)
2931
2931
  from: 2013-10-20,
2932
2932
  // Date | End date (YYYY-MM-DD)
2933
2933
  to: 2013-10-20,
2934
- // 'hourOfDay' | 'year' | 'month' | 'day' | Group by period (day, week, month, hourOfDay) (optional)
2934
+ // 'hourOfDay' | 'year' | 'month' | 'day' | Group commit counts by period (default: day) (optional)
2935
2935
  groupBy: groupBy_example,
2936
2936
  } satisfies GetCommitsByUserIDRequest;
2937
2937
 
@@ -2952,10 +2952,10 @@ example().catch(console.error);
2952
2952
 
2953
2953
  | Name | Type | Description | Notes |
2954
2954
  |------------- | ------------- | ------------- | -------------|
2955
- | **userId** | `string` | User ID | [Defaults to `undefined`] |
2955
+ | **userId** | `string` | User ID of the employee | [Defaults to `undefined`] |
2956
2956
  | **from** | `Date` | Start date (YYYY-MM-DD) | [Defaults to `undefined`] |
2957
2957
  | **to** | `Date` | End date (YYYY-MM-DD) | [Defaults to `undefined`] |
2958
- | **groupBy** | `hourOfDay`, `year`, `month`, `day` | Group by period (day, week, month, hourOfDay) | [Optional] [Defaults to `undefined`] [Enum: hourOfDay, year, month, day] |
2958
+ | **groupBy** | `hourOfDay`, `year`, `month`, `day` | Group commit counts by period (default: day) | [Optional] [Defaults to `undefined`] [Enum: hourOfDay, year, month, day] |
2959
2959
 
2960
2960
  ### Return type
2961
2961
 
@@ -2986,9 +2986,9 @@ example().catch(console.error);
2986
2986
 
2987
2987
  > Array<CompanyDTO> getCompanies(search)
2988
2988
 
2989
- Get all companies a user belongs to
2989
+ List my companies
2990
2990
 
2991
- Get all companies a user belongs to
2991
+ List the companies the current user belongs to.
2992
2992
 
2993
2993
  ### Example
2994
2994
 
@@ -3060,10 +3060,10 @@ example().catch(console.error);
3060
3060
 
3061
3061
  > CompanyDTO getCompany(companyId)
3062
3062
 
3063
- Get a company by ID
3064
-
3065
3063
  Get a company
3066
3064
 
3065
+ Get a company by ID.
3066
+
3067
3067
  ### Example
3068
3068
 
3069
3069
  ```ts
@@ -3137,9 +3137,9 @@ example().catch(console.error);
3137
3137
 
3138
3138
  > EmployeeDTO getEmployee(userId)
3139
3139
 
3140
- Get employee info
3140
+ Get an employee
3141
3141
 
3142
- Get employee info
3142
+ Get an employee by user ID.
3143
3143
 
3144
3144
  ### Example
3145
3145
 
@@ -3159,7 +3159,7 @@ async function example() {
3159
3159
  const api = new ClientApi(config);
3160
3160
 
3161
3161
  const body = {
3162
- // string | User ID
3162
+ // string | User ID of the employee
3163
3163
  userId: userId_example,
3164
3164
  } satisfies GetEmployeeRequest;
3165
3165
 
@@ -3180,7 +3180,7 @@ example().catch(console.error);
3180
3180
 
3181
3181
  | Name | Type | Description | Notes |
3182
3182
  |------------- | ------------- | ------------- | -------------|
3183
- | **userId** | `string` | User ID | [Defaults to `undefined`] |
3183
+ | **userId** | `string` | User ID of the employee | [Defaults to `undefined`] |
3184
3184
 
3185
3185
  ### Return type
3186
3186
 
@@ -3213,9 +3213,9 @@ example().catch(console.error);
3213
3213
 
3214
3214
  > PaginatedEmployeeInvoices getEmployeeInvoices(userId, page, pageSize, search)
3215
3215
 
3216
- Get all employee invoices
3216
+ List employee invoices
3217
3217
 
3218
- Get all employee invoices
3218
+ List the payment invoices of an employee.
3219
3219
 
3220
3220
  ### Example
3221
3221
 
@@ -3235,7 +3235,7 @@ async function example() {
3235
3235
  const api = new ClientApi(config);
3236
3236
 
3237
3237
  const body = {
3238
- // string | User ID
3238
+ // string | User ID of the employee
3239
3239
  userId: userId_example,
3240
3240
  // number | Page number for pagination (optional)
3241
3241
  page: 56,
@@ -3262,7 +3262,7 @@ example().catch(console.error);
3262
3262
 
3263
3263
  | Name | Type | Description | Notes |
3264
3264
  |------------- | ------------- | ------------- | -------------|
3265
- | **userId** | `string` | User ID | [Defaults to `undefined`] |
3265
+ | **userId** | `string` | User ID of the employee | [Defaults to `undefined`] |
3266
3266
  | **page** | `number` | Page number for pagination | [Optional] [Defaults to `undefined`] |
3267
3267
  | **pageSize** | `number` | Limit number of items per page | [Optional] [Defaults to `undefined`] |
3268
3268
  | **search** | `string` | Search employee invoices by month or month-year (e.g. \'10\', \'10-2024\', \'2024\') | [Optional] [Defaults to `undefined`] |
@@ -3298,9 +3298,9 @@ example().catch(console.error);
3298
3298
 
3299
3299
  > PaginatedTimesheets getEmployeeTimesheets(projectId, page, pageSize, search)
3300
3300
 
3301
- Get all timesheets of an employee in a project
3301
+ List my timesheets in a project
3302
3302
 
3303
- Get all timesheets of an employee in a project
3303
+ List the timesheets of the current user in a project.
3304
3304
 
3305
3305
  ### Example
3306
3306
 
@@ -3386,7 +3386,7 @@ example().catch(console.error);
3386
3386
 
3387
3387
  List employees
3388
3388
 
3389
- List employees
3389
+ List the employees.
3390
3390
 
3391
3391
  ### Example
3392
3392
 
@@ -3469,9 +3469,9 @@ example().catch(console.error);
3469
3469
 
3470
3470
  > ClientGithubAccountDTO getGithubAccount()
3471
3471
 
3472
- Get GitHub account
3472
+ Get my GitHub account
3473
3473
 
3474
- Get GitHub account for the authenticated user
3474
+ Get the GitHub account linked to the current user.
3475
3475
 
3476
3476
  ### Example
3477
3477
 
@@ -3537,7 +3537,7 @@ This endpoint does not need any parameter.
3537
3537
 
3538
3538
  Get a global timesheet
3539
3539
 
3540
- Get a global timesheet
3540
+ Get a global timesheet of a project with its entries.
3541
3541
 
3542
3542
  ### Example
3543
3543
 
@@ -3559,7 +3559,7 @@ async function example() {
3559
3559
  const body = {
3560
3560
  // string | Project ID
3561
3561
  projectId: projectId_example,
3562
- // string | Timesheet ID
3562
+ // string | Global timesheet ID
3563
3563
  timesheetId: timesheetId_example,
3564
3564
  } satisfies GetGlobalTimesheetRequest;
3565
3565
 
@@ -3581,7 +3581,7 @@ example().catch(console.error);
3581
3581
  | Name | Type | Description | Notes |
3582
3582
  |------------- | ------------- | ------------- | -------------|
3583
3583
  | **projectId** | `string` | Project ID | [Defaults to `undefined`] |
3584
- | **timesheetId** | `string` | Timesheet ID | [Defaults to `undefined`] |
3584
+ | **timesheetId** | `string` | Global timesheet ID | [Defaults to `undefined`] |
3585
3585
 
3586
3586
  ### Return type
3587
3587
 
@@ -3615,9 +3615,9 @@ example().catch(console.error);
3615
3615
 
3616
3616
  > PaginatedGlobalTimesheets getGlobalTimesheets(projectId, page, pageSize, search)
3617
3617
 
3618
- Get all global timesheets in a project
3618
+ List global timesheets of a project
3619
3619
 
3620
- Get all global timesheets in a project
3620
+ List the global timesheets of a project. A global timesheet is the monthly summary of all employees approved adjusted timesheets.
3621
3621
 
3622
3622
  ### Example
3623
3623
 
@@ -3701,9 +3701,9 @@ example().catch(console.error);
3701
3701
 
3702
3702
  > PaginatedHolidaysDTO getHolidays(page, pageSize, search)
3703
3703
 
3704
+ List my holidays
3704
3705
 
3705
-
3706
- Returns a paginated list of a user\'s holidays
3706
+ List the holidays (days off) of the current user.
3707
3707
 
3708
3708
  ### Example
3709
3709
 
@@ -3784,9 +3784,9 @@ example().catch(console.error);
3784
3784
 
3785
3785
  > PaginatedHolidaysDTO getHolidaysByEmployee(userId, page, pageSize, search)
3786
3786
 
3787
+ List an employee\'s holidays
3787
3788
 
3788
-
3789
- returns a paginated list of a user\'s holidays
3789
+ List the holidays (days off) of an employee.
3790
3790
 
3791
3791
  ### Example
3792
3792
 
@@ -3806,7 +3806,7 @@ async function example() {
3806
3806
  const api = new ClientApi(config);
3807
3807
 
3808
3808
  const body = {
3809
- // string | User ID
3809
+ // string | User ID of the employee
3810
3810
  userId: userId_example,
3811
3811
  // number | Page number for pagination (optional)
3812
3812
  page: 56,
@@ -3833,7 +3833,7 @@ example().catch(console.error);
3833
3833
 
3834
3834
  | Name | Type | Description | Notes |
3835
3835
  |------------- | ------------- | ------------- | -------------|
3836
- | **userId** | `string` | User ID | [Defaults to `undefined`] |
3836
+ | **userId** | `string` | User ID of the employee | [Defaults to `undefined`] |
3837
3837
  | **page** | `number` | Page number for pagination | [Optional] [Defaults to `undefined`] |
3838
3838
  | **pageSize** | `number` | Number of items per page | [Optional] [Defaults to `undefined`] |
3839
3839
  | **search** | `string` | Search holidays by month or month-year (e.g. \'10\', \'10-2024\', \'2024\') | [Optional] [Defaults to `undefined`] |
@@ -3870,9 +3870,9 @@ example().catch(console.error);
3870
3870
 
3871
3871
  > Array<JiraAccountDTO> getJiraAccounts()
3872
3872
 
3873
- Get Jira account
3873
+ List my Jira accounts
3874
3874
 
3875
- Get Jira account for the authenticated user
3875
+ List the Jira accounts linked to the current user.
3876
3876
 
3877
3877
  ### Example
3878
3878
 
@@ -3936,9 +3936,9 @@ This endpoint does not need any parameter.
3936
3936
 
3937
3937
  > ClientJiraUserDTO getJiraUser()
3938
3938
 
3939
- Get Jira user
3939
+ Get my Jira user
3940
3940
 
3941
- Get Jira user information for the authenticated user
3941
+ Get the Jira user of the current user.
3942
3942
 
3943
3943
  ### Example
3944
3944
 
@@ -4002,9 +4002,9 @@ This endpoint does not need any parameter.
4002
4002
 
4003
4003
  > AccountInfoDTO getMyAccount()
4004
4004
 
4005
- Get my account info
4005
+ Get my account
4006
4006
 
4007
- Get my account info
4007
+ Get the account info of the current user.
4008
4008
 
4009
4009
  ### Example
4010
4010
 
@@ -4072,7 +4072,7 @@ This endpoint does not need any parameter.
4072
4072
 
4073
4073
  Get my commits
4074
4074
 
4075
- Get commit statistics for the authenticated user
4075
+ Get the GitHub commit statistics of the current user for a date range.
4076
4076
 
4077
4077
  ### Example
4078
4078
 
@@ -4096,7 +4096,7 @@ async function example() {
4096
4096
  from: 2013-10-20,
4097
4097
  // Date | End date (YYYY-MM-DD)
4098
4098
  to: 2013-10-20,
4099
- // 'hourOfDay' | 'year' | 'month' | 'day' | Group by period (day, week, month, hourOfDay) (optional)
4099
+ // 'hourOfDay' | 'year' | 'month' | 'day' | Group commit counts by period (default: day) (optional)
4100
4100
  groupBy: groupBy_example,
4101
4101
  } satisfies GetMyCommitsRequest;
4102
4102
 
@@ -4119,7 +4119,7 @@ example().catch(console.error);
4119
4119
  |------------- | ------------- | ------------- | -------------|
4120
4120
  | **from** | `Date` | Start date (YYYY-MM-DD) | [Defaults to `undefined`] |
4121
4121
  | **to** | `Date` | End date (YYYY-MM-DD) | [Defaults to `undefined`] |
4122
- | **groupBy** | `hourOfDay`, `year`, `month`, `day` | Group by period (day, week, month, hourOfDay) | [Optional] [Defaults to `undefined`] [Enum: hourOfDay, year, month, day] |
4122
+ | **groupBy** | `hourOfDay`, `year`, `month`, `day` | Group commit counts by period (default: day) | [Optional] [Defaults to `undefined`] [Enum: hourOfDay, year, month, day] |
4123
4123
 
4124
4124
  ### Return type
4125
4125
 
@@ -4150,10 +4150,10 @@ example().catch(console.error);
4150
4150
 
4151
4151
  > ProjectDTO getProjectById(projectId)
4152
4152
 
4153
- Get a project by ID
4154
-
4155
4153
  Get a project
4156
4154
 
4155
+ Get a project by ID.
4156
+
4157
4157
  ### Example
4158
4158
 
4159
4159
  ```ts
@@ -4227,9 +4227,9 @@ example().catch(console.error);
4227
4227
 
4228
4228
  > Array<UserProjectReport> getProjectReportByUser(userId, projectId)
4229
4229
 
4230
- Get all projects an employee has access to
4230
+ Get project report of an employee
4231
4231
 
4232
- Get all projects an employee has access to
4232
+ Get the projects and current timesheets of an employee. Internal endpoint.
4233
4233
 
4234
4234
  ### Example
4235
4235
 
@@ -4306,9 +4306,9 @@ example().catch(console.error);
4306
4306
 
4307
4307
  > PaginatedProjects getProjects(page, pageSize, search)
4308
4308
 
4309
- Get all projects a user or employee has access to
4309
+ List projects
4310
4310
 
4311
- Get all projects a user or employee has access to
4311
+ List all projects.
4312
4312
 
4313
4313
  ### Example
4314
4314
 
@@ -4387,9 +4387,9 @@ example().catch(console.error);
4387
4387
 
4388
4388
  > PaginatedEmployeeProjects getProjectsAsEmployee(page, pageSize, search)
4389
4389
 
4390
- Get all projects an employee has access to
4390
+ List my projects
4391
4391
 
4392
- Get all projects an employee has access to
4392
+ List the projects the current user is assigned to.
4393
4393
 
4394
4394
  ### Example
4395
4395
 
@@ -4468,9 +4468,9 @@ example().catch(console.error);
4468
4468
 
4469
4469
  > ClientSlackUserAccountDTO getSlackUserAccount()
4470
4470
 
4471
- Get Slack user account
4471
+ Get my Slack account
4472
4472
 
4473
- Get Slack account information for the authenticated user
4473
+ Get the Slack account linked to the current user.
4474
4474
 
4475
4475
  ### Example
4476
4476
 
@@ -4534,9 +4534,9 @@ This endpoint does not need any parameter.
4534
4534
 
4535
4535
  > PaginatedUsers getTeam(projectId, page, pageSize, search)
4536
4536
 
4537
- Get all users in a project
4537
+ Get a project team
4538
4538
 
4539
- Get all users in a project
4539
+ List the employees assigned to a project.
4540
4540
 
4541
4541
  ### Example
4542
4542
 
@@ -4622,7 +4622,7 @@ example().catch(console.error);
4622
4622
 
4623
4623
  Get a timesheet
4624
4624
 
4625
- Get a timesheet
4625
+ Get an employee timesheet of a project with its daily entries.
4626
4626
 
4627
4627
  ### Example
4628
4628
 
@@ -4700,9 +4700,9 @@ example().catch(console.error);
4700
4700
 
4701
4701
  > PaginatedTimesheets getTimesheets(projectId, page, pageSize, search)
4702
4702
 
4703
- Get all timesheets in a project without timesheet entries.
4703
+ List timesheets of a project
4704
4704
 
4705
- Get all timesheets in a project without timesheet entries.
4705
+ List the timesheets of all employees in a project, one per employee per month. Do not include the daily entries of the timesheets, only the summary.
4706
4706
 
4707
4707
  ### Example
4708
4708
 
@@ -4786,9 +4786,9 @@ example().catch(console.error);
4786
4786
 
4787
4787
  > TokenDTO getToken(tokenId)
4788
4788
 
4789
- Get a specific API token by ID
4789
+ Get an API token
4790
4790
 
4791
- Get token by ID
4791
+ Get a personal API token of the current user by ID.
4792
4792
 
4793
4793
  ### Example
4794
4794
 
@@ -4862,9 +4862,9 @@ example().catch(console.error);
4862
4862
 
4863
4863
  > RolePermissionsDTO getUserPermissions()
4864
4864
 
4865
- Get all available permissions for current user based on their role
4865
+ List my permissions
4866
4866
 
4867
- Get permissions for current user
4867
+ List the permissions available to the current user based on their role.
4868
4868
 
4869
4869
  ### Example
4870
4870
 
@@ -4927,9 +4927,9 @@ This endpoint does not need any parameter.
4927
4927
 
4928
4928
  > PaginatedTokens getUserTokens(page, pageSize)
4929
4929
 
4930
- Get all API tokens for current user with pagination
4930
+ List my API tokens
4931
4931
 
4932
- Get all tokens for current user with pagination
4932
+ List the personal API tokens of the current user.
4933
4933
 
4934
4934
  ### Example
4935
4935
 
@@ -5005,9 +5005,9 @@ example().catch(console.error);
5005
5005
 
5006
5006
  > EmployeeDTO inviteEmployee(employeeDTO)
5007
5007
 
5008
- Invite an employee to a company
5008
+ Invite an employee
5009
5009
 
5010
- Invite an employee to a company
5010
+ Create or add an employee account. Sends an invitation email.
5011
5011
 
5012
5012
  ### Example
5013
5013
 
@@ -5084,7 +5084,7 @@ example().catch(console.error);
5084
5084
 
5085
5085
  Mark an employee invoice as paid
5086
5086
 
5087
- Mark an employee invoice as paid
5087
+ Mark an employee invoice as paid.
5088
5088
 
5089
5089
  ### Example
5090
5090
 
@@ -5104,7 +5104,7 @@ async function example() {
5104
5104
  const api = new ClientApi(config);
5105
5105
 
5106
5106
  const body = {
5107
- // string | Employee ID
5107
+ // string | User ID of the employee
5108
5108
  userId: userId_example,
5109
5109
  // string | Employee Invoice ID
5110
5110
  employeeInvoiceId: employeeInvoiceId_example,
@@ -5129,7 +5129,7 @@ example().catch(console.error);
5129
5129
 
5130
5130
  | Name | Type | Description | Notes |
5131
5131
  |------------- | ------------- | ------------- | -------------|
5132
- | **userId** | `string` | Employee ID | [Defaults to `undefined`] |
5132
+ | **userId** | `string` | User ID of the employee | [Defaults to `undefined`] |
5133
5133
  | **employeeInvoiceId** | `string` | Employee Invoice ID | [Defaults to `undefined`] |
5134
5134
  | **markEmployeeInvoicePaidDTO** | [MarkEmployeeInvoicePaidDTO](MarkEmployeeInvoicePaidDTO.md) | Mark invoice as paid | |
5135
5135
 
@@ -5164,10 +5164,10 @@ example().catch(console.error);
5164
5164
 
5165
5165
  > markInvoiceAsPaid(clientId, invoiceId, markInvoicePaidDTO)
5166
5166
 
5167
- Mark a client invoice as paid with the specified date and time
5168
-
5169
5167
  Mark a client invoice as paid
5170
5168
 
5169
+ Mark a client invoice as paid on a given date.
5170
+
5171
5171
  ### Example
5172
5172
 
5173
5173
  ```ts
@@ -5190,7 +5190,7 @@ async function example() {
5190
5190
  clientId: clientId_example,
5191
5191
  // string | Invoice ID
5192
5192
  invoiceId: invoiceId_example,
5193
- // MarkInvoicePaidDTO | Paid date information
5193
+ // MarkInvoicePaidDTO | Payment date (paidDate, RFC 3339 date-time)
5194
5194
  markInvoicePaidDTO: ...,
5195
5195
  } satisfies MarkInvoiceAsPaidRequest;
5196
5196
 
@@ -5213,7 +5213,7 @@ example().catch(console.error);
5213
5213
  |------------- | ------------- | ------------- | -------------|
5214
5214
  | **clientId** | `string` | Client ID | [Defaults to `undefined`] |
5215
5215
  | **invoiceId** | `string` | Invoice ID | [Defaults to `undefined`] |
5216
- | **markInvoicePaidDTO** | [MarkInvoicePaidDTO](MarkInvoicePaidDTO.md) | Paid date information | |
5216
+ | **markInvoicePaidDTO** | [MarkInvoicePaidDTO](MarkInvoicePaidDTO.md) | Payment date (paidDate, RFC 3339 date-time) | |
5217
5217
 
5218
5218
  ### Return type
5219
5219
 
@@ -5244,9 +5244,9 @@ example().catch(console.error);
5244
5244
 
5245
5245
  > openSentTimesheet(projectId, timesheetId)
5246
5246
 
5247
- Open a sent timesheet
5247
+ Reopen a sent timesheet
5248
5248
 
5249
- Open a sent timesheet
5249
+ Reopen a SENT timesheet so it can be edited again.
5250
5250
 
5251
5251
  ### Example
5252
5252
 
@@ -5324,9 +5324,9 @@ example().catch(console.error);
5324
5324
 
5325
5325
  > removeJiraAccount(jiraAccountId)
5326
5326
 
5327
- Remove jira account
5327
+ Remove a Jira account
5328
5328
 
5329
- Remove specific jira account for the current user
5329
+ Unlink a Jira account from the current user.
5330
5330
 
5331
5331
  ### Example
5332
5332
 
@@ -5401,7 +5401,7 @@ example().catch(console.error);
5401
5401
 
5402
5402
  Send a timesheet
5403
5403
 
5404
- Send a timesheet
5404
+ Send (submit) an OPEN timesheet for approval. It can no longer be edited unless it is reopened.
5405
5405
 
5406
5406
  ### Example
5407
5407
 
@@ -5481,7 +5481,7 @@ example().catch(console.error);
5481
5481
 
5482
5482
  Update an adjusted timesheet entry
5483
5483
 
5484
- Update an adjusted timesheet entry
5484
+ Update or change the hours of a day in an adjusted timesheet. Only possible while the adjusted timesheet is OPEN.
5485
5485
 
5486
5486
  ### Example
5487
5487
 
@@ -5503,9 +5503,9 @@ async function example() {
5503
5503
  const body = {
5504
5504
  // string | Project ID
5505
5505
  projectId: projectId_example,
5506
- // string | AdjustedTimesheet ID
5506
+ // string | Adjusted timesheet ID
5507
5507
  timesheetId: timesheetId_example,
5508
- // string | Entry ID
5508
+ // string | Adjusted timesheet entry ID
5509
5509
  entryId: entryId_example,
5510
5510
  // AdjustedTimesheetUpdateEntryDTO | Entry to update
5511
5511
  adjustedTimesheetUpdateEntryDTO: ...,
@@ -5529,8 +5529,8 @@ example().catch(console.error);
5529
5529
  | Name | Type | Description | Notes |
5530
5530
  |------------- | ------------- | ------------- | -------------|
5531
5531
  | **projectId** | `string` | Project ID | [Defaults to `undefined`] |
5532
- | **timesheetId** | `string` | AdjustedTimesheet ID | [Defaults to `undefined`] |
5533
- | **entryId** | `string` | Entry ID | [Defaults to `undefined`] |
5532
+ | **timesheetId** | `string` | Adjusted timesheet ID | [Defaults to `undefined`] |
5533
+ | **entryId** | `string` | Adjusted timesheet entry ID | [Defaults to `undefined`] |
5534
5534
  | **adjustedTimesheetUpdateEntryDTO** | [AdjustedTimesheetUpdateEntryDTO](AdjustedTimesheetUpdateEntryDTO.md) | Entry to update | |
5535
5535
 
5536
5536
  ### Return type
@@ -5565,9 +5565,9 @@ example().catch(console.error);
5565
5565
 
5566
5566
  > ClientDTO updateClient(clientId, clientDTO)
5567
5567
 
5568
+ Update a client
5568
5569
 
5569
-
5570
- Update client
5570
+ Update or change the data of a client (customer).
5571
5571
 
5572
5572
  ### Example
5573
5573
 
@@ -5645,10 +5645,10 @@ example().catch(console.error);
5645
5645
 
5646
5646
  > CompanyDTO updateCompany(companyId, companyDTO)
5647
5647
 
5648
- Update a company by ID
5649
-
5650
5648
  Update a company
5651
5649
 
5650
+ Update or change the data of a company.
5651
+
5652
5652
  ### Example
5653
5653
 
5654
5654
  ```ts
@@ -5727,7 +5727,7 @@ example().catch(console.error);
5727
5727
 
5728
5728
  Update an employee
5729
5729
 
5730
- Update an employee
5730
+ Update or change the data of an employee.
5731
5731
 
5732
5732
  ### Example
5733
5733
 
@@ -5747,7 +5747,7 @@ async function example() {
5747
5747
  const api = new ClientApi(config);
5748
5748
 
5749
5749
  const body = {
5750
- // string | User ID
5750
+ // string | User ID of the employee
5751
5751
  userId: userId_example,
5752
5752
  // EmployeeUpdateDTO | Employee to update
5753
5753
  employeeUpdateDTO: ...,
@@ -5770,7 +5770,7 @@ example().catch(console.error);
5770
5770
 
5771
5771
  | Name | Type | Description | Notes |
5772
5772
  |------------- | ------------- | ------------- | -------------|
5773
- | **userId** | `string` | User ID | [Defaults to `undefined`] |
5773
+ | **userId** | `string` | User ID of the employee | [Defaults to `undefined`] |
5774
5774
  | **employeeUpdateDTO** | [EmployeeUpdateDTO](EmployeeUpdateDTO.md) | Employee to update | |
5775
5775
 
5776
5776
  ### Return type
@@ -5808,7 +5808,7 @@ example().catch(console.error);
5808
5808
 
5809
5809
  Update a global timesheet entry
5810
5810
 
5811
- Update a global timesheet entry
5811
+ Update or change the hours or comments of a day in a global timesheet. Only possible while the global timesheet is OPEN.
5812
5812
 
5813
5813
  ### Example
5814
5814
 
@@ -5830,9 +5830,9 @@ async function example() {
5830
5830
  const body = {
5831
5831
  // string | Project ID
5832
5832
  projectId: projectId_example,
5833
- // string | Timesheet ID
5833
+ // string | Global timesheet ID
5834
5834
  timesheetId: timesheetId_example,
5835
- // string | Entry ID
5835
+ // string | Global timesheet entry ID
5836
5836
  entryId: entryId_example,
5837
5837
  // GlobalTimesheetEntryUpdateDTO | Entry to update
5838
5838
  globalTimesheetEntryUpdateDTO: ...,
@@ -5856,8 +5856,8 @@ example().catch(console.error);
5856
5856
  | Name | Type | Description | Notes |
5857
5857
  |------------- | ------------- | ------------- | -------------|
5858
5858
  | **projectId** | `string` | Project ID | [Defaults to `undefined`] |
5859
- | **timesheetId** | `string` | Timesheet ID | [Defaults to `undefined`] |
5860
- | **entryId** | `string` | Entry ID | [Defaults to `undefined`] |
5859
+ | **timesheetId** | `string` | Global timesheet ID | [Defaults to `undefined`] |
5860
+ | **entryId** | `string` | Global timesheet entry ID | [Defaults to `undefined`] |
5861
5861
  | **globalTimesheetEntryUpdateDTO** | [GlobalTimesheetEntryUpdateDTO](GlobalTimesheetEntryUpdateDTO.md) | Entry to update | |
5862
5862
 
5863
5863
  ### Return type
@@ -5892,10 +5892,10 @@ example().catch(console.error);
5892
5892
 
5893
5893
  > ProjectDTO updateProject(projectId, projectUpdateDTO)
5894
5894
 
5895
- Update a project by ID
5896
-
5897
5895
  Update a project
5898
5896
 
5897
+ Update or change the data of a project. Changing the end date creates or deletes the matching timesheets.
5898
+
5899
5899
  ### Example
5900
5900
 
5901
5901
  ```ts
@@ -5972,9 +5972,9 @@ example().catch(console.error);
5972
5972
 
5973
5973
  > ClientSlackUserDTO updateSlackUser(clientUpdateSlackUserDTO)
5974
5974
 
5975
- Update Slack user
5975
+ Update my Slack user
5976
5976
 
5977
- Update Slack user settings for the authenticated user
5977
+ Update or change the Slack settings of the current user.
5978
5978
 
5979
5979
  ### Example
5980
5980
 
@@ -6048,7 +6048,7 @@ example().catch(console.error);
6048
6048
 
6049
6049
  Update a project team
6050
6050
 
6051
- Update a project team
6051
+ Update or change the team of a project. The list sent replaces the whole team.
6052
6052
 
6053
6053
  ### Example
6054
6054
 
@@ -6070,7 +6070,7 @@ async function example() {
6070
6070
  const body = {
6071
6071
  // string | Project ID
6072
6072
  projectId: projectId_example,
6073
- // TeamUpdateDTO | Team to update
6073
+ // TeamUpdateDTO | Full list of users that make up the team
6074
6074
  teamUpdateDTO: ...,
6075
6075
  } satisfies UpdateTeamRequest;
6076
6076
 
@@ -6092,7 +6092,7 @@ example().catch(console.error);
6092
6092
  | Name | Type | Description | Notes |
6093
6093
  |------------- | ------------- | ------------- | -------------|
6094
6094
  | **projectId** | `string` | Project ID | [Defaults to `undefined`] |
6095
- | **teamUpdateDTO** | [TeamUpdateDTO](TeamUpdateDTO.md) | Team to update | |
6095
+ | **teamUpdateDTO** | [TeamUpdateDTO](TeamUpdateDTO.md) | Full list of users that make up the team | |
6096
6096
 
6097
6097
  ### Return type
6098
6098
 
@@ -6128,7 +6128,7 @@ example().catch(console.error);
6128
6128
 
6129
6129
  Update a timesheet entry
6130
6130
 
6131
- Update a timesheet entry
6131
+ Update or change the hours of a day in an employee timesheet. Only possible while the timesheet is OPEN.
6132
6132
 
6133
6133
  ### Example
6134
6134
 
@@ -6152,7 +6152,7 @@ async function example() {
6152
6152
  projectId: projectId_example,
6153
6153
  // string | Timesheet ID
6154
6154
  timesheetId: timesheetId_example,
6155
- // string | Entry ID
6155
+ // string | Timesheet entry ID (one day of the timesheet)
6156
6156
  entryId: entryId_example,
6157
6157
  // TimesheetEntryUpdateDTO | Entry to update
6158
6158
  timesheetEntryUpdateDTO: ...,
@@ -6177,7 +6177,7 @@ example().catch(console.error);
6177
6177
  |------------- | ------------- | ------------- | -------------|
6178
6178
  | **projectId** | `string` | Project ID | [Defaults to `undefined`] |
6179
6179
  | **timesheetId** | `string` | Timesheet ID | [Defaults to `undefined`] |
6180
- | **entryId** | `string` | Entry ID | [Defaults to `undefined`] |
6180
+ | **entryId** | `string` | Timesheet entry ID (one day of the timesheet) | [Defaults to `undefined`] |
6181
6181
  | **timesheetEntryUpdateDTO** | [TimesheetEntryUpdateDTO](TimesheetEntryUpdateDTO.md) | Entry to update | |
6182
6182
 
6183
6183
  ### Return type