tuix-timesheets-api 0.46.0 → 0.48.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/.openapi-generator/FILES +8 -0
- package/apis/TuixTimesheetsClientApi.js +182 -0
- package/apis/TuixTimesheetsClientApi.js.map +1 -1
- package/apis/TuixTimesheetsClientApi.ts +272 -0
- package/models/ClientInvoiceDTO.js +2 -0
- package/models/ClientInvoiceDTO.js.map +1 -1
- package/models/ClientInvoiceDTO.ts +8 -0
- package/models/CreateTokenResponseDTO.js +64 -0
- package/models/CreateTokenResponseDTO.js.map +1 -0
- package/models/CreateTokenResponseDTO.ts +120 -0
- package/models/MarkInvoicePaidDTO.js +51 -0
- package/models/MarkInvoicePaidDTO.js.map +1 -0
- package/models/MarkInvoicePaidDTO.ts +66 -0
- package/models/PaginatedTokens.js +64 -0
- package/models/PaginatedTokens.js.map +1 -0
- package/models/PaginatedTokens.ts +109 -0
- package/models/PermissionDTO.js +57 -0
- package/models/PermissionDTO.js.map +1 -0
- package/models/PermissionDTO.ts +89 -0
- package/models/RolePermissionsDTO.js +54 -0
- package/models/RolePermissionsDTO.js.map +1 -0
- package/models/RolePermissionsDTO.ts +80 -0
- package/models/TokenDTO.js +64 -0
- package/models/TokenDTO.js.map +1 -0
- package/models/TokenDTO.ts +120 -0
- package/models/TokenInputDTO.js +57 -0
- package/models/TokenInputDTO.js.map +1 -0
- package/models/TokenInputDTO.ts +83 -0
- package/models/TokenValidationErrorDTO.js +60 -0
- package/models/TokenValidationErrorDTO.js.map +1 -0
- package/models/TokenValidationErrorDTO.ts +104 -0
- package/models/index.js +8 -0
- package/models/index.js.map +1 -1
- package/models/index.ts +8 -0
- package/package.json +1 -1
package/.openapi-generator/FILES
CHANGED
|
@@ -14,6 +14,7 @@ models/CreateGithubUserDto.ts
|
|
|
14
14
|
models/CreateJiraAccountDto.ts
|
|
15
15
|
models/CreateJiraUserDto.ts
|
|
16
16
|
models/CreateSubscriptionDTO.ts
|
|
17
|
+
models/CreateTokenResponseDTO.ts
|
|
17
18
|
models/CreateUserDto.ts
|
|
18
19
|
models/EmailTemplateDTO.ts
|
|
19
20
|
models/EmployeeDTO.ts
|
|
@@ -31,6 +32,7 @@ models/HolidayCreateDTO.ts
|
|
|
31
32
|
models/HolidayDTO.ts
|
|
32
33
|
models/JiraAccountDto.ts
|
|
33
34
|
models/JiraUserDto.ts
|
|
35
|
+
models/MarkInvoicePaidDTO.ts
|
|
34
36
|
models/PaginatedAdjustedTimesheets.ts
|
|
35
37
|
models/PaginatedClientInvoices.ts
|
|
36
38
|
models/PaginatedClients.ts
|
|
@@ -42,11 +44,14 @@ models/PaginatedGlobalTimesheets.ts
|
|
|
42
44
|
models/PaginatedHolidaysDTO.ts
|
|
43
45
|
models/PaginatedProjects.ts
|
|
44
46
|
models/PaginatedTimesheets.ts
|
|
47
|
+
models/PaginatedTokens.ts
|
|
45
48
|
models/PaginatedUsers.ts
|
|
46
49
|
models/PdfTemplateDTO.ts
|
|
50
|
+
models/PermissionDTO.ts
|
|
47
51
|
models/ProjectDTO.ts
|
|
48
52
|
models/ProjectInputDTO.ts
|
|
49
53
|
models/ProjectUpdateDTO.ts
|
|
54
|
+
models/RolePermissionsDTO.ts
|
|
50
55
|
models/SendNewsletterDto.ts
|
|
51
56
|
models/SlackAccountReponseDto.ts
|
|
52
57
|
models/SlackUserDto.ts
|
|
@@ -57,6 +62,9 @@ models/TeamUpdateDTO.ts
|
|
|
57
62
|
models/TimesheetDTO.ts
|
|
58
63
|
models/TimesheetEntryDTO.ts
|
|
59
64
|
models/TimesheetEntryUpdateDTO.ts
|
|
65
|
+
models/TokenDTO.ts
|
|
66
|
+
models/TokenInputDTO.ts
|
|
67
|
+
models/TokenValidationErrorDTO.ts
|
|
60
68
|
models/UpdateUserDto.ts
|
|
61
69
|
models/UserDTOSc.ts
|
|
62
70
|
models/UserEnrollDTO.ts
|
|
@@ -432,6 +432,37 @@ class TuixTimesheetsClientApi extends runtime.BaseAPI {
|
|
|
432
432
|
const response = await this.createSubscriptionRaw(requestParameters, initOverrides);
|
|
433
433
|
return await response.value();
|
|
434
434
|
}
|
|
435
|
+
/**
|
|
436
|
+
* Create a new API token
|
|
437
|
+
* Create a new API token with role-based permissions
|
|
438
|
+
*/
|
|
439
|
+
async createTokenRaw(requestParameters, initOverrides) {
|
|
440
|
+
if (requestParameters.tokenInputDTO === null || requestParameters.tokenInputDTO === undefined) {
|
|
441
|
+
throw new runtime.RequiredError('tokenInputDTO', 'Required parameter requestParameters.tokenInputDTO was null or undefined when calling createToken.');
|
|
442
|
+
}
|
|
443
|
+
const queryParameters = {};
|
|
444
|
+
const headerParameters = {};
|
|
445
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
446
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
447
|
+
headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // auth0Authorizer authentication
|
|
448
|
+
}
|
|
449
|
+
const response = await this.request({
|
|
450
|
+
path: `/pats`,
|
|
451
|
+
method: 'POST',
|
|
452
|
+
headers: headerParameters,
|
|
453
|
+
query: queryParameters,
|
|
454
|
+
body: (0, index_1.TokenInputDTOToJSON)(requestParameters.tokenInputDTO),
|
|
455
|
+
}, initOverrides);
|
|
456
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.CreateTokenResponseDTOFromJSON)(jsonValue));
|
|
457
|
+
}
|
|
458
|
+
/**
|
|
459
|
+
* Create a new API token
|
|
460
|
+
* Create a new API token with role-based permissions
|
|
461
|
+
*/
|
|
462
|
+
async createToken(requestParameters, initOverrides) {
|
|
463
|
+
const response = await this.createTokenRaw(requestParameters, initOverrides);
|
|
464
|
+
return await response.value();
|
|
465
|
+
}
|
|
435
466
|
/**
|
|
436
467
|
* Create user
|
|
437
468
|
* Create a user
|
|
@@ -670,6 +701,34 @@ class TuixTimesheetsClientApi extends runtime.BaseAPI {
|
|
|
670
701
|
async deleteSubscription(requestParameters, initOverrides) {
|
|
671
702
|
await this.deleteSubscriptionRaw(requestParameters, initOverrides);
|
|
672
703
|
}
|
|
704
|
+
/**
|
|
705
|
+
* Delete token
|
|
706
|
+
* Delete an API token by ID
|
|
707
|
+
*/
|
|
708
|
+
async deleteTokenRaw(requestParameters, initOverrides) {
|
|
709
|
+
if (requestParameters.tokenId === null || requestParameters.tokenId === undefined) {
|
|
710
|
+
throw new runtime.RequiredError('tokenId', 'Required parameter requestParameters.tokenId was null or undefined when calling deleteToken.');
|
|
711
|
+
}
|
|
712
|
+
const queryParameters = {};
|
|
713
|
+
const headerParameters = {};
|
|
714
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
715
|
+
headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // auth0Authorizer authentication
|
|
716
|
+
}
|
|
717
|
+
const response = await this.request({
|
|
718
|
+
path: `/pats/{tokenId}`.replace(`{${"tokenId"}}`, encodeURIComponent(String(requestParameters.tokenId))),
|
|
719
|
+
method: 'DELETE',
|
|
720
|
+
headers: headerParameters,
|
|
721
|
+
query: queryParameters,
|
|
722
|
+
}, initOverrides);
|
|
723
|
+
return new runtime.VoidApiResponse(response);
|
|
724
|
+
}
|
|
725
|
+
/**
|
|
726
|
+
* Delete token
|
|
727
|
+
* Delete an API token by ID
|
|
728
|
+
*/
|
|
729
|
+
async deleteToken(requestParameters, initOverrides) {
|
|
730
|
+
await this.deleteTokenRaw(requestParameters, initOverrides);
|
|
731
|
+
}
|
|
673
732
|
/**
|
|
674
733
|
* Delete user
|
|
675
734
|
* Delete a user by ID
|
|
@@ -1908,6 +1967,35 @@ class TuixTimesheetsClientApi extends runtime.BaseAPI {
|
|
|
1908
1967
|
const response = await this.getTimesheetsRaw(requestParameters, initOverrides);
|
|
1909
1968
|
return await response.value();
|
|
1910
1969
|
}
|
|
1970
|
+
/**
|
|
1971
|
+
* Get token by ID
|
|
1972
|
+
* Get a specific API token by ID
|
|
1973
|
+
*/
|
|
1974
|
+
async getTokenRaw(requestParameters, initOverrides) {
|
|
1975
|
+
if (requestParameters.tokenId === null || requestParameters.tokenId === undefined) {
|
|
1976
|
+
throw new runtime.RequiredError('tokenId', 'Required parameter requestParameters.tokenId was null or undefined when calling getToken.');
|
|
1977
|
+
}
|
|
1978
|
+
const queryParameters = {};
|
|
1979
|
+
const headerParameters = {};
|
|
1980
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
1981
|
+
headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // auth0Authorizer authentication
|
|
1982
|
+
}
|
|
1983
|
+
const response = await this.request({
|
|
1984
|
+
path: `/pats/{tokenId}`.replace(`{${"tokenId"}}`, encodeURIComponent(String(requestParameters.tokenId))),
|
|
1985
|
+
method: 'GET',
|
|
1986
|
+
headers: headerParameters,
|
|
1987
|
+
query: queryParameters,
|
|
1988
|
+
}, initOverrides);
|
|
1989
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.TokenDTOFromJSON)(jsonValue));
|
|
1990
|
+
}
|
|
1991
|
+
/**
|
|
1992
|
+
* Get token by ID
|
|
1993
|
+
* Get a specific API token by ID
|
|
1994
|
+
*/
|
|
1995
|
+
async getToken(requestParameters, initOverrides) {
|
|
1996
|
+
const response = await this.getTokenRaw(requestParameters, initOverrides);
|
|
1997
|
+
return await response.value();
|
|
1998
|
+
}
|
|
1911
1999
|
/**
|
|
1912
2000
|
* Get user by id
|
|
1913
2001
|
* Get a user by ID
|
|
@@ -1937,6 +2025,64 @@ class TuixTimesheetsClientApi extends runtime.BaseAPI {
|
|
|
1937
2025
|
const response = await this.getUserByIdRaw(requestParameters, initOverrides);
|
|
1938
2026
|
return await response.value();
|
|
1939
2027
|
}
|
|
2028
|
+
/**
|
|
2029
|
+
* Get permissions for current user
|
|
2030
|
+
* Get all available permissions for current user based on their role
|
|
2031
|
+
*/
|
|
2032
|
+
async getUserPermissionsRaw(initOverrides) {
|
|
2033
|
+
const queryParameters = {};
|
|
2034
|
+
const headerParameters = {};
|
|
2035
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
2036
|
+
headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // auth0Authorizer authentication
|
|
2037
|
+
}
|
|
2038
|
+
const response = await this.request({
|
|
2039
|
+
path: `/permissions`,
|
|
2040
|
+
method: 'GET',
|
|
2041
|
+
headers: headerParameters,
|
|
2042
|
+
query: queryParameters,
|
|
2043
|
+
}, initOverrides);
|
|
2044
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.RolePermissionsDTOFromJSON)(jsonValue));
|
|
2045
|
+
}
|
|
2046
|
+
/**
|
|
2047
|
+
* Get permissions for current user
|
|
2048
|
+
* Get all available permissions for current user based on their role
|
|
2049
|
+
*/
|
|
2050
|
+
async getUserPermissions(initOverrides) {
|
|
2051
|
+
const response = await this.getUserPermissionsRaw(initOverrides);
|
|
2052
|
+
return await response.value();
|
|
2053
|
+
}
|
|
2054
|
+
/**
|
|
2055
|
+
* Get all tokens for current user with pagination
|
|
2056
|
+
* Get all API tokens for current user with pagination
|
|
2057
|
+
*/
|
|
2058
|
+
async getUserTokensRaw(requestParameters, initOverrides) {
|
|
2059
|
+
const queryParameters = {};
|
|
2060
|
+
if (requestParameters.page !== undefined) {
|
|
2061
|
+
queryParameters['page'] = requestParameters.page;
|
|
2062
|
+
}
|
|
2063
|
+
if (requestParameters.pageSize !== undefined) {
|
|
2064
|
+
queryParameters['pageSize'] = requestParameters.pageSize;
|
|
2065
|
+
}
|
|
2066
|
+
const headerParameters = {};
|
|
2067
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
2068
|
+
headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // auth0Authorizer authentication
|
|
2069
|
+
}
|
|
2070
|
+
const response = await this.request({
|
|
2071
|
+
path: `/pats`,
|
|
2072
|
+
method: 'GET',
|
|
2073
|
+
headers: headerParameters,
|
|
2074
|
+
query: queryParameters,
|
|
2075
|
+
}, initOverrides);
|
|
2076
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PaginatedTokensFromJSON)(jsonValue));
|
|
2077
|
+
}
|
|
2078
|
+
/**
|
|
2079
|
+
* Get all tokens for current user with pagination
|
|
2080
|
+
* Get all API tokens for current user with pagination
|
|
2081
|
+
*/
|
|
2082
|
+
async getUserTokens(requestParameters = {}, initOverrides) {
|
|
2083
|
+
const response = await this.getUserTokensRaw(requestParameters, initOverrides);
|
|
2084
|
+
return await response.value();
|
|
2085
|
+
}
|
|
1940
2086
|
/**
|
|
1941
2087
|
* Get all users
|
|
1942
2088
|
* Get all users
|
|
@@ -2014,6 +2160,42 @@ class TuixTimesheetsClientApi extends runtime.BaseAPI {
|
|
|
2014
2160
|
const response = await this.inviteEmployeeRaw(requestParameters, initOverrides);
|
|
2015
2161
|
return await response.value();
|
|
2016
2162
|
}
|
|
2163
|
+
/**
|
|
2164
|
+
* Mark a client invoice as paid
|
|
2165
|
+
* Mark a client invoice as paid with the specified date and time
|
|
2166
|
+
*/
|
|
2167
|
+
async markInvoiceAsPaidRaw(requestParameters, initOverrides) {
|
|
2168
|
+
if (requestParameters.clientId === null || requestParameters.clientId === undefined) {
|
|
2169
|
+
throw new runtime.RequiredError('clientId', 'Required parameter requestParameters.clientId was null or undefined when calling markInvoiceAsPaid.');
|
|
2170
|
+
}
|
|
2171
|
+
if (requestParameters.invoiceId === null || requestParameters.invoiceId === undefined) {
|
|
2172
|
+
throw new runtime.RequiredError('invoiceId', 'Required parameter requestParameters.invoiceId was null or undefined when calling markInvoiceAsPaid.');
|
|
2173
|
+
}
|
|
2174
|
+
if (requestParameters.markInvoicePaidDTO === null || requestParameters.markInvoicePaidDTO === undefined) {
|
|
2175
|
+
throw new runtime.RequiredError('markInvoicePaidDTO', 'Required parameter requestParameters.markInvoicePaidDTO was null or undefined when calling markInvoiceAsPaid.');
|
|
2176
|
+
}
|
|
2177
|
+
const queryParameters = {};
|
|
2178
|
+
const headerParameters = {};
|
|
2179
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
2180
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
2181
|
+
headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // auth0Authorizer authentication
|
|
2182
|
+
}
|
|
2183
|
+
const response = await this.request({
|
|
2184
|
+
path: `/clients/{clientId}/invoices/{invoiceId}/mark-paid`.replace(`{${"clientId"}}`, encodeURIComponent(String(requestParameters.clientId))).replace(`{${"invoiceId"}}`, encodeURIComponent(String(requestParameters.invoiceId))),
|
|
2185
|
+
method: 'POST',
|
|
2186
|
+
headers: headerParameters,
|
|
2187
|
+
query: queryParameters,
|
|
2188
|
+
body: (0, index_1.MarkInvoicePaidDTOToJSON)(requestParameters.markInvoicePaidDTO),
|
|
2189
|
+
}, initOverrides);
|
|
2190
|
+
return new runtime.VoidApiResponse(response);
|
|
2191
|
+
}
|
|
2192
|
+
/**
|
|
2193
|
+
* Mark a client invoice as paid
|
|
2194
|
+
* Mark a client invoice as paid with the specified date and time
|
|
2195
|
+
*/
|
|
2196
|
+
async markInvoiceAsPaid(requestParameters, initOverrides) {
|
|
2197
|
+
await this.markInvoiceAsPaidRaw(requestParameters, initOverrides);
|
|
2198
|
+
}
|
|
2017
2199
|
/**
|
|
2018
2200
|
* Open a sent timesheet
|
|
2019
2201
|
* Open a sent timesheet
|