@timesheet/sdk 1.0.2 → 1.0.4
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/CHANGELOG.md +33 -1
- package/README.md +132 -1
- package/dist/index.d.mts +548 -1
- package/dist/index.d.ts +548 -1
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +1 -1
- package/dist/index.mjs.map +1 -1
- package/package.json +3 -3
package/dist/index.d.ts
CHANGED
|
@@ -38,6 +38,149 @@ declare class OAuth2Auth implements Authentication {
|
|
|
38
38
|
private parseTokenExpiry;
|
|
39
39
|
}
|
|
40
40
|
|
|
41
|
+
type CodeChallengeMethod = 'S256' | 'plain';
|
|
42
|
+
interface PkceCodePair {
|
|
43
|
+
codeVerifier: string;
|
|
44
|
+
codeChallenge: string;
|
|
45
|
+
codeChallengeMethod: CodeChallengeMethod;
|
|
46
|
+
}
|
|
47
|
+
declare function generateCodeVerifier(length?: number): string;
|
|
48
|
+
declare function generateCodeChallenge(codeVerifier: string, method?: CodeChallengeMethod): string;
|
|
49
|
+
declare function generatePkceCodePair(method?: CodeChallengeMethod, verifierLength?: number): PkceCodePair;
|
|
50
|
+
declare function isValidCodeVerifier(codeVerifier: string): boolean;
|
|
51
|
+
|
|
52
|
+
interface AuthorizationUrlOptions {
|
|
53
|
+
clientId: string;
|
|
54
|
+
redirectUri: string;
|
|
55
|
+
codeChallenge: string;
|
|
56
|
+
codeChallengeMethod?: CodeChallengeMethod;
|
|
57
|
+
state?: string;
|
|
58
|
+
scope?: string;
|
|
59
|
+
resource?: string;
|
|
60
|
+
authorizationEndpoint?: string;
|
|
61
|
+
}
|
|
62
|
+
interface TokenExchangeOptions {
|
|
63
|
+
clientId: string;
|
|
64
|
+
clientSecret?: string;
|
|
65
|
+
authorizationCode: string;
|
|
66
|
+
redirectUri: string;
|
|
67
|
+
codeVerifier: string;
|
|
68
|
+
resource?: string;
|
|
69
|
+
tokenEndpoint?: string;
|
|
70
|
+
}
|
|
71
|
+
interface OAuth21RefreshOptions {
|
|
72
|
+
clientId: string;
|
|
73
|
+
clientSecret?: string;
|
|
74
|
+
refreshToken: string;
|
|
75
|
+
resource?: string;
|
|
76
|
+
tokenEndpoint?: string;
|
|
77
|
+
}
|
|
78
|
+
declare class OAuth21Auth implements Authentication {
|
|
79
|
+
private static readonly DEFAULT_TOKEN_ENDPOINT;
|
|
80
|
+
private static readonly DEFAULT_AUTH_ENDPOINT;
|
|
81
|
+
private accessToken;
|
|
82
|
+
private refreshToken?;
|
|
83
|
+
private readonly clientId?;
|
|
84
|
+
private readonly clientSecret?;
|
|
85
|
+
private readonly resource?;
|
|
86
|
+
private readonly tokenEndpoint;
|
|
87
|
+
private tokenExpiry?;
|
|
88
|
+
private refreshPromise?;
|
|
89
|
+
constructor(accessToken: string);
|
|
90
|
+
constructor(options: OAuth21RefreshOptions);
|
|
91
|
+
applyAuth(config: AxiosRequestConfig): void;
|
|
92
|
+
needsRefresh(): boolean;
|
|
93
|
+
refresh(): Promise<void>;
|
|
94
|
+
private performRefresh;
|
|
95
|
+
getAuthHeaders(): Promise<Record<string, string>>;
|
|
96
|
+
static fromAuthorizationCode(options: TokenExchangeOptions): Promise<OAuth21Auth>;
|
|
97
|
+
static buildAuthorizationUrl(options: AuthorizationUrlOptions): string;
|
|
98
|
+
static generatePkce(method?: CodeChallengeMethod): PkceCodePair;
|
|
99
|
+
private parseTokenExpiry;
|
|
100
|
+
}
|
|
101
|
+
|
|
102
|
+
interface AuthorizationServerMetadata {
|
|
103
|
+
issuer: string;
|
|
104
|
+
authorization_endpoint: string;
|
|
105
|
+
token_endpoint: string;
|
|
106
|
+
registration_endpoint?: string;
|
|
107
|
+
scopes_supported?: string[];
|
|
108
|
+
response_types_supported: string[];
|
|
109
|
+
grant_types_supported?: string[];
|
|
110
|
+
token_endpoint_auth_methods_supported?: string[];
|
|
111
|
+
code_challenge_methods_supported?: string[];
|
|
112
|
+
revocation_endpoint?: string;
|
|
113
|
+
revocation_endpoint_auth_methods_supported?: string[];
|
|
114
|
+
introspection_endpoint?: string;
|
|
115
|
+
introspection_endpoint_auth_methods_supported?: string[];
|
|
116
|
+
service_documentation?: string;
|
|
117
|
+
}
|
|
118
|
+
interface ProtectedResourceMetadata {
|
|
119
|
+
resource: string;
|
|
120
|
+
authorization_servers: string[];
|
|
121
|
+
scopes_supported?: string[];
|
|
122
|
+
bearer_methods_supported?: string[];
|
|
123
|
+
resource_documentation?: string;
|
|
124
|
+
resource_signing_alg_values_supported?: string[];
|
|
125
|
+
}
|
|
126
|
+
interface OpenIdConfiguration {
|
|
127
|
+
issuer: string;
|
|
128
|
+
authorization_endpoint: string;
|
|
129
|
+
token_endpoint: string;
|
|
130
|
+
userinfo_endpoint?: string;
|
|
131
|
+
jwks_uri: string;
|
|
132
|
+
registration_endpoint?: string;
|
|
133
|
+
scopes_supported?: string[];
|
|
134
|
+
response_types_supported: string[];
|
|
135
|
+
response_modes_supported?: string[];
|
|
136
|
+
grant_types_supported?: string[];
|
|
137
|
+
token_endpoint_auth_methods_supported?: string[];
|
|
138
|
+
token_endpoint_auth_signing_alg_values_supported?: string[];
|
|
139
|
+
service_documentation?: string;
|
|
140
|
+
ui_locales_supported?: string[];
|
|
141
|
+
op_policy_uri?: string;
|
|
142
|
+
op_tos_uri?: string;
|
|
143
|
+
revocation_endpoint?: string;
|
|
144
|
+
introspection_endpoint?: string;
|
|
145
|
+
code_challenge_methods_supported?: string[];
|
|
146
|
+
}
|
|
147
|
+
interface OAuthDiscoveryResult {
|
|
148
|
+
issuer: string;
|
|
149
|
+
authorizationServer: AuthorizationServerMetadata;
|
|
150
|
+
protectedResource?: ProtectedResourceMetadata;
|
|
151
|
+
openIdConfiguration?: OpenIdConfiguration;
|
|
152
|
+
fetchedAt: Date;
|
|
153
|
+
}
|
|
154
|
+
|
|
155
|
+
interface OAuthDiscoveryOptions {
|
|
156
|
+
cacheTtl?: number;
|
|
157
|
+
timeout?: number;
|
|
158
|
+
fetchOpenIdConfig?: boolean;
|
|
159
|
+
fetchProtectedResource?: boolean;
|
|
160
|
+
}
|
|
161
|
+
declare class OAuthDiscovery {
|
|
162
|
+
private static readonly DEFAULT_CACHE_TTL;
|
|
163
|
+
private static readonly DEFAULT_TIMEOUT;
|
|
164
|
+
private readonly cache;
|
|
165
|
+
private readonly options;
|
|
166
|
+
constructor(options?: OAuthDiscoveryOptions);
|
|
167
|
+
discover(issuerUrl: string): Promise<OAuthDiscoveryResult>;
|
|
168
|
+
fetchAuthorizationServerMetadata(issuerUrl: string): Promise<AuthorizationServerMetadata>;
|
|
169
|
+
fetchOpenIdConfiguration(issuerUrl: string): Promise<OpenIdConfiguration>;
|
|
170
|
+
fetchProtectedResourceMetadata(resourceUrl: string): Promise<ProtectedResourceMetadata>;
|
|
171
|
+
clearCache(): void;
|
|
172
|
+
clearCacheForIssuer(issuerUrl: string): void;
|
|
173
|
+
isCached(issuerUrl: string): boolean;
|
|
174
|
+
private normalizeIssuerUrl;
|
|
175
|
+
private getCached;
|
|
176
|
+
private setCache;
|
|
177
|
+
private validateAuthorizationServerMetadata;
|
|
178
|
+
private validateOpenIdConfiguration;
|
|
179
|
+
private validateProtectedResourceMetadata;
|
|
180
|
+
}
|
|
181
|
+
declare function getDefaultDiscovery(): OAuthDiscovery;
|
|
182
|
+
declare function discoverOAuth(issuerUrl: string, options?: OAuthDiscoveryOptions): Promise<OAuthDiscoveryResult>;
|
|
183
|
+
|
|
41
184
|
declare class RetryConfig {
|
|
42
185
|
readonly maxRetries: number;
|
|
43
186
|
readonly initialDelay: number;
|
|
@@ -1016,6 +1159,26 @@ interface DocumentListParams extends ListParams {
|
|
|
1016
1159
|
empty?: boolean;
|
|
1017
1160
|
}
|
|
1018
1161
|
|
|
1162
|
+
type WebhookEventType = 'team.create' | 'team.update' | 'project.create' | 'project.update' | 'todo.create' | 'todo.update' | 'task.create' | 'task.update' | 'tag.create' | 'tag.update' | 'rate.create' | 'rate.update' | 'timer.start' | 'timer.stop' | 'timer.pause' | 'timer.resume';
|
|
1163
|
+
declare const WebhookEvents: {
|
|
1164
|
+
readonly TEAM_CREATE: "team.create";
|
|
1165
|
+
readonly TEAM_UPDATE: "team.update";
|
|
1166
|
+
readonly PROJECT_CREATE: "project.create";
|
|
1167
|
+
readonly PROJECT_UPDATE: "project.update";
|
|
1168
|
+
readonly TODO_CREATE: "todo.create";
|
|
1169
|
+
readonly TODO_UPDATE: "todo.update";
|
|
1170
|
+
readonly TASK_CREATE: "task.create";
|
|
1171
|
+
readonly TASK_UPDATE: "task.update";
|
|
1172
|
+
readonly TAG_CREATE: "tag.create";
|
|
1173
|
+
readonly TAG_UPDATE: "tag.update";
|
|
1174
|
+
readonly RATE_CREATE: "rate.create";
|
|
1175
|
+
readonly RATE_UPDATE: "rate.update";
|
|
1176
|
+
readonly TIMER_START: "timer.start";
|
|
1177
|
+
readonly TIMER_STOP: "timer.stop";
|
|
1178
|
+
readonly TIMER_PAUSE: "timer.pause";
|
|
1179
|
+
readonly TIMER_RESUME: "timer.resume";
|
|
1180
|
+
};
|
|
1181
|
+
declare function combineWebhookEvents(...events: WebhookEventType[]): string;
|
|
1019
1182
|
interface Webhook {
|
|
1020
1183
|
id: string;
|
|
1021
1184
|
target: string;
|
|
@@ -1163,6 +1326,332 @@ interface ProfileUpdateRequest {
|
|
|
1163
1326
|
newsletter?: boolean;
|
|
1164
1327
|
}
|
|
1165
1328
|
|
|
1329
|
+
interface TaskReportItem {
|
|
1330
|
+
taskDate?: string;
|
|
1331
|
+
taskStartTime?: string;
|
|
1332
|
+
taskEndTime?: string;
|
|
1333
|
+
taskTimeRange?: string;
|
|
1334
|
+
taskDuration?: string;
|
|
1335
|
+
taskDurationRelative?: string;
|
|
1336
|
+
pauseDuration?: string;
|
|
1337
|
+
taskDescription?: string;
|
|
1338
|
+
taskId?: string;
|
|
1339
|
+
userId?: string;
|
|
1340
|
+
invoiceId?: string;
|
|
1341
|
+
startDateTimeRaw?: string;
|
|
1342
|
+
endDateTimeRaw?: string;
|
|
1343
|
+
durationSeconds?: number;
|
|
1344
|
+
durationBreakSeconds?: number;
|
|
1345
|
+
taskLocation?: string;
|
|
1346
|
+
taskLocationStart?: string;
|
|
1347
|
+
taskLocationEnd?: string;
|
|
1348
|
+
taskDistance?: string;
|
|
1349
|
+
taskRateName?: string;
|
|
1350
|
+
taskRate?: string;
|
|
1351
|
+
taskTotal?: string;
|
|
1352
|
+
taskTotalRelative?: string;
|
|
1353
|
+
projectName?: string;
|
|
1354
|
+
projectClient?: string;
|
|
1355
|
+
projectColor?: string;
|
|
1356
|
+
memberName?: string;
|
|
1357
|
+
taskTags?: string;
|
|
1358
|
+
taskSignature?: string;
|
|
1359
|
+
quantityHours?: number;
|
|
1360
|
+
unitPriceNumeric?: number;
|
|
1361
|
+
lineTotalNumeric?: number;
|
|
1362
|
+
salaryTotalNumeric?: number;
|
|
1363
|
+
salaryBreakNumeric?: number;
|
|
1364
|
+
projectId?: string;
|
|
1365
|
+
memberId?: string;
|
|
1366
|
+
billable?: boolean;
|
|
1367
|
+
paid?: boolean;
|
|
1368
|
+
expenses?: ExpenseReportItem[];
|
|
1369
|
+
notes?: NoteReportItem[];
|
|
1370
|
+
}
|
|
1371
|
+
interface ExpenseReportItem {
|
|
1372
|
+
expenseDate?: string;
|
|
1373
|
+
expenseTime?: string;
|
|
1374
|
+
expenseAmount?: string;
|
|
1375
|
+
expenseDescription?: string;
|
|
1376
|
+
expenseDescriptionRaw?: string;
|
|
1377
|
+
expenseDateTimeRaw?: string;
|
|
1378
|
+
expenseId?: string;
|
|
1379
|
+
expenseUserId?: string;
|
|
1380
|
+
attachmentBase64?: string;
|
|
1381
|
+
expenseAuthor?: string;
|
|
1382
|
+
amountNumeric?: number;
|
|
1383
|
+
}
|
|
1384
|
+
interface NoteReportItem {
|
|
1385
|
+
noteDate?: string;
|
|
1386
|
+
noteContent?: string;
|
|
1387
|
+
attachmentBase64?: string;
|
|
1388
|
+
noteType?: string;
|
|
1389
|
+
noteAuthor?: string;
|
|
1390
|
+
}
|
|
1391
|
+
interface DocumentReport {
|
|
1392
|
+
documentTitle?: string;
|
|
1393
|
+
documentDate?: string;
|
|
1394
|
+
invoiceNumber?: string;
|
|
1395
|
+
customerNumber?: string;
|
|
1396
|
+
paymentDate?: string;
|
|
1397
|
+
paymentMethod?: string;
|
|
1398
|
+
companyName?: string;
|
|
1399
|
+
companyAddress1?: string;
|
|
1400
|
+
companyAddress2?: string;
|
|
1401
|
+
companyAddress3?: string;
|
|
1402
|
+
companyAddress4?: string;
|
|
1403
|
+
companyLogo?: string;
|
|
1404
|
+
customerName?: string;
|
|
1405
|
+
customerAddress1?: string;
|
|
1406
|
+
customerAddress2?: string;
|
|
1407
|
+
customerAddress3?: string;
|
|
1408
|
+
customerAddress4?: string;
|
|
1409
|
+
taskSubtotal?: string;
|
|
1410
|
+
expenseSubtotal?: string;
|
|
1411
|
+
subtotalAmount?: string;
|
|
1412
|
+
taxRate?: number;
|
|
1413
|
+
taxAmount?: string;
|
|
1414
|
+
taxSecondRate?: number;
|
|
1415
|
+
taxSecondAmount?: string;
|
|
1416
|
+
discountRate?: number;
|
|
1417
|
+
discountAmount?: string;
|
|
1418
|
+
discountSecondRate?: number;
|
|
1419
|
+
discountSecondAmount?: string;
|
|
1420
|
+
totalAmount?: string;
|
|
1421
|
+
totalDuration?: string;
|
|
1422
|
+
paymentAmount?: string;
|
|
1423
|
+
eInvoiceType?: string;
|
|
1424
|
+
companyVatId?: string;
|
|
1425
|
+
companyTaxNumber?: string;
|
|
1426
|
+
companyRegistrationNumber?: string;
|
|
1427
|
+
companyBankAccount?: string;
|
|
1428
|
+
companyBankBIC?: string;
|
|
1429
|
+
eInvoiceCurrency?: string;
|
|
1430
|
+
deliveryDate?: string;
|
|
1431
|
+
dueDate?: string;
|
|
1432
|
+
paymentReference?: string;
|
|
1433
|
+
orderReference?: string;
|
|
1434
|
+
taxExemptionReason?: string;
|
|
1435
|
+
reverseChargeRate?: number;
|
|
1436
|
+
isReverseCharge?: boolean;
|
|
1437
|
+
eInvoiceDocumentType?: string;
|
|
1438
|
+
invoiceTypeCode?: string;
|
|
1439
|
+
customerVatId?: string;
|
|
1440
|
+
customerTaxNumber?: string;
|
|
1441
|
+
customerOrderNumber?: string;
|
|
1442
|
+
paymentTermDays?: number;
|
|
1443
|
+
cashDiscountRate?: number;
|
|
1444
|
+
cashDiscountDays?: number;
|
|
1445
|
+
originalInvoiceNumber?: string;
|
|
1446
|
+
originalInvoiceDate?: string;
|
|
1447
|
+
projectReference?: string;
|
|
1448
|
+
costCenter?: string;
|
|
1449
|
+
isGovernmentInvoice?: boolean;
|
|
1450
|
+
procurementReference?: string;
|
|
1451
|
+
contractReference?: string;
|
|
1452
|
+
eInvoicingEnabled?: boolean;
|
|
1453
|
+
documentDescription?: string;
|
|
1454
|
+
documentTerms?: string;
|
|
1455
|
+
documentSignature?: string;
|
|
1456
|
+
showTaskTime?: boolean;
|
|
1457
|
+
showRates?: boolean;
|
|
1458
|
+
showTaxes?: boolean;
|
|
1459
|
+
showSecondTax?: boolean;
|
|
1460
|
+
showDiscount?: boolean;
|
|
1461
|
+
showSecondDiscount?: boolean;
|
|
1462
|
+
includeExpenses?: boolean;
|
|
1463
|
+
includeNotes?: boolean;
|
|
1464
|
+
showProjectTitle?: boolean;
|
|
1465
|
+
showMemberName?: boolean;
|
|
1466
|
+
showTags?: boolean;
|
|
1467
|
+
showQrCode?: boolean;
|
|
1468
|
+
qrCodeType?: string;
|
|
1469
|
+
qrCodeContent?: string;
|
|
1470
|
+
qrCodeDescription?: string;
|
|
1471
|
+
hideExpenseDateTime?: boolean;
|
|
1472
|
+
hideSummation?: boolean;
|
|
1473
|
+
useRelatives?: boolean;
|
|
1474
|
+
tasks?: TaskReportItem[];
|
|
1475
|
+
expenses?: ExpenseReportItem[];
|
|
1476
|
+
notes?: NoteReportItem[];
|
|
1477
|
+
labelDescription?: string;
|
|
1478
|
+
labelRate?: string;
|
|
1479
|
+
labelQuantity?: string;
|
|
1480
|
+
labelTotal?: string;
|
|
1481
|
+
labelTotalSum?: string;
|
|
1482
|
+
labelSubtotal?: string;
|
|
1483
|
+
labelTax?: string;
|
|
1484
|
+
labelSecondTax?: string;
|
|
1485
|
+
labelDiscount?: string;
|
|
1486
|
+
labelSecondDiscount?: string;
|
|
1487
|
+
labelExpenseTitle?: string;
|
|
1488
|
+
labelExpenseTotal?: string;
|
|
1489
|
+
templateId?: string;
|
|
1490
|
+
reportType?: string;
|
|
1491
|
+
language?: string;
|
|
1492
|
+
currency?: string;
|
|
1493
|
+
currencyCode?: string;
|
|
1494
|
+
}
|
|
1495
|
+
interface ExportedField {
|
|
1496
|
+
id: string;
|
|
1497
|
+
name?: string;
|
|
1498
|
+
position?: number;
|
|
1499
|
+
projectField?: boolean;
|
|
1500
|
+
teamField?: boolean;
|
|
1501
|
+
customField?: boolean;
|
|
1502
|
+
customValue?: string;
|
|
1503
|
+
customFormula?: string;
|
|
1504
|
+
customType?: string;
|
|
1505
|
+
}
|
|
1506
|
+
interface ExportParams {
|
|
1507
|
+
report: number;
|
|
1508
|
+
email?: string;
|
|
1509
|
+
filename?: string;
|
|
1510
|
+
teamIds?: string[];
|
|
1511
|
+
projectIds?: string[];
|
|
1512
|
+
userIds?: string[];
|
|
1513
|
+
tagIds?: string[];
|
|
1514
|
+
type?: string;
|
|
1515
|
+
startDate: string;
|
|
1516
|
+
endDate: string;
|
|
1517
|
+
format?: ExportFormat;
|
|
1518
|
+
filter?: string;
|
|
1519
|
+
splitTask?: boolean;
|
|
1520
|
+
summarize?: boolean;
|
|
1521
|
+
saveAsTemplate?: boolean;
|
|
1522
|
+
templateName?: string;
|
|
1523
|
+
exportedFields?: ExportedField[];
|
|
1524
|
+
}
|
|
1525
|
+
type ExportFormat = 'xlsx' | 'xlsx1904' | 'csv' | 'pdf';
|
|
1526
|
+
interface ExportTemplateParams {
|
|
1527
|
+
templateId: string;
|
|
1528
|
+
startDate: string;
|
|
1529
|
+
endDate: string;
|
|
1530
|
+
}
|
|
1531
|
+
interface FileResponse {
|
|
1532
|
+
url: string;
|
|
1533
|
+
filename?: string;
|
|
1534
|
+
contentType?: string;
|
|
1535
|
+
}
|
|
1536
|
+
interface ExportTemplate {
|
|
1537
|
+
id: string;
|
|
1538
|
+
user?: string;
|
|
1539
|
+
deleted?: boolean;
|
|
1540
|
+
lastUpdate?: number;
|
|
1541
|
+
created?: number;
|
|
1542
|
+
name: string;
|
|
1543
|
+
report: number;
|
|
1544
|
+
teamIds?: string[];
|
|
1545
|
+
projectIds?: string[];
|
|
1546
|
+
userIds?: string[];
|
|
1547
|
+
tagIds?: string[];
|
|
1548
|
+
type?: string;
|
|
1549
|
+
format?: string;
|
|
1550
|
+
filter?: string;
|
|
1551
|
+
splitTask?: boolean;
|
|
1552
|
+
summarize?: boolean;
|
|
1553
|
+
email?: string;
|
|
1554
|
+
filename?: string;
|
|
1555
|
+
exportedFields?: ExportedField[];
|
|
1556
|
+
}
|
|
1557
|
+
interface ExportTemplateCreateRequest {
|
|
1558
|
+
name: string;
|
|
1559
|
+
report?: number;
|
|
1560
|
+
teamIds?: string[];
|
|
1561
|
+
projectIds?: string[];
|
|
1562
|
+
userIds?: string[];
|
|
1563
|
+
tagIds?: string[];
|
|
1564
|
+
type?: string;
|
|
1565
|
+
format?: string;
|
|
1566
|
+
filter?: string;
|
|
1567
|
+
splitTask?: boolean;
|
|
1568
|
+
summarize?: boolean;
|
|
1569
|
+
email?: string;
|
|
1570
|
+
filename?: string;
|
|
1571
|
+
exportedFields?: ExportedField[];
|
|
1572
|
+
}
|
|
1573
|
+
interface ExportTemplateUpdateRequest {
|
|
1574
|
+
name?: string;
|
|
1575
|
+
report?: number;
|
|
1576
|
+
teamIds?: string[];
|
|
1577
|
+
projectIds?: string[];
|
|
1578
|
+
userIds?: string[];
|
|
1579
|
+
tagIds?: string[];
|
|
1580
|
+
type?: string;
|
|
1581
|
+
format?: string;
|
|
1582
|
+
filter?: string;
|
|
1583
|
+
splitTask?: boolean;
|
|
1584
|
+
summarize?: boolean;
|
|
1585
|
+
email?: string;
|
|
1586
|
+
filename?: string;
|
|
1587
|
+
exportedFields?: ExportedField[];
|
|
1588
|
+
}
|
|
1589
|
+
interface ExportTemplateListParams {
|
|
1590
|
+
sort?: 'alpha' | 'name' | 'created' | 'lastUpdate';
|
|
1591
|
+
order?: 'asc' | 'desc';
|
|
1592
|
+
page?: number;
|
|
1593
|
+
limit?: number;
|
|
1594
|
+
search?: string;
|
|
1595
|
+
}
|
|
1596
|
+
interface ExportFieldDefinition {
|
|
1597
|
+
fieldId: string;
|
|
1598
|
+
nameKey?: string;
|
|
1599
|
+
descriptionKey?: string;
|
|
1600
|
+
name: string;
|
|
1601
|
+
description?: string;
|
|
1602
|
+
type?: string;
|
|
1603
|
+
category?: string;
|
|
1604
|
+
scope?: string;
|
|
1605
|
+
defaultEnabled?: boolean;
|
|
1606
|
+
defaultPosition?: number;
|
|
1607
|
+
customField?: boolean;
|
|
1608
|
+
customType?: string;
|
|
1609
|
+
customValue?: string;
|
|
1610
|
+
customFormula?: string;
|
|
1611
|
+
}
|
|
1612
|
+
interface ExportFieldsResponse {
|
|
1613
|
+
fields: ExportFieldDefinition[];
|
|
1614
|
+
}
|
|
1615
|
+
interface ExportReportType {
|
|
1616
|
+
id: number;
|
|
1617
|
+
name: string;
|
|
1618
|
+
description?: string;
|
|
1619
|
+
acceptsCustomFields?: boolean;
|
|
1620
|
+
fieldScope?: string;
|
|
1621
|
+
}
|
|
1622
|
+
interface ExportReportsResponse {
|
|
1623
|
+
reports: ExportReportType[];
|
|
1624
|
+
}
|
|
1625
|
+
interface CustomExportField {
|
|
1626
|
+
id: string;
|
|
1627
|
+
user?: string;
|
|
1628
|
+
name: string;
|
|
1629
|
+
scope: string;
|
|
1630
|
+
type: string;
|
|
1631
|
+
value?: string;
|
|
1632
|
+
width?: number;
|
|
1633
|
+
deleted?: boolean;
|
|
1634
|
+
lastUpdate?: number;
|
|
1635
|
+
created?: number;
|
|
1636
|
+
}
|
|
1637
|
+
interface CustomExportFieldCreateRequest {
|
|
1638
|
+
name: string;
|
|
1639
|
+
scope: string;
|
|
1640
|
+
type: string;
|
|
1641
|
+
value?: string;
|
|
1642
|
+
width?: number;
|
|
1643
|
+
}
|
|
1644
|
+
interface CustomExportFieldUpdateRequest {
|
|
1645
|
+
name?: string;
|
|
1646
|
+
scope?: string;
|
|
1647
|
+
type?: string;
|
|
1648
|
+
value?: string;
|
|
1649
|
+
width?: number;
|
|
1650
|
+
}
|
|
1651
|
+
interface CustomExportFieldsResponse {
|
|
1652
|
+
fields: CustomExportField[];
|
|
1653
|
+
}
|
|
1654
|
+
|
|
1166
1655
|
interface ResourceConfig {
|
|
1167
1656
|
basePath: string;
|
|
1168
1657
|
}
|
|
@@ -1333,6 +1822,60 @@ declare class WebhookResource extends Resource {
|
|
|
1333
1822
|
search(params: WebhookListParams): Promise<NavigablePage<Webhook>>;
|
|
1334
1823
|
}
|
|
1335
1824
|
|
|
1825
|
+
declare class DocumentReportResource extends Resource {
|
|
1826
|
+
constructor(client: ApiClient);
|
|
1827
|
+
get(documentId: string): Promise<DocumentReport>;
|
|
1828
|
+
getPdf(documentId: string): Promise<ArrayBuffer>;
|
|
1829
|
+
getXml(documentId: string): Promise<string>;
|
|
1830
|
+
}
|
|
1831
|
+
|
|
1832
|
+
declare class TaskReportResource extends Resource {
|
|
1833
|
+
constructor(client: ApiClient);
|
|
1834
|
+
get(taskId: string): Promise<TaskReportItem>;
|
|
1835
|
+
getPdf(taskId: string): Promise<ArrayBuffer>;
|
|
1836
|
+
}
|
|
1837
|
+
|
|
1838
|
+
declare class ExpenseReportResource extends Resource {
|
|
1839
|
+
constructor(client: ApiClient);
|
|
1840
|
+
get(expenseId: string): Promise<ExpenseReportItem>;
|
|
1841
|
+
getPdf(expenseId: string): Promise<ArrayBuffer>;
|
|
1842
|
+
}
|
|
1843
|
+
|
|
1844
|
+
declare class NoteReportResource extends Resource {
|
|
1845
|
+
constructor(client: ApiClient);
|
|
1846
|
+
get(noteId: string): Promise<NoteReportItem>;
|
|
1847
|
+
getPdf(noteId: string): Promise<ArrayBuffer>;
|
|
1848
|
+
}
|
|
1849
|
+
|
|
1850
|
+
declare class ExportResource extends Resource {
|
|
1851
|
+
constructor(client: ApiClient);
|
|
1852
|
+
generate(params: ExportParams): Promise<FileResponse>;
|
|
1853
|
+
send(params: ExportParams): Promise<void>;
|
|
1854
|
+
generateFromTemplate(params: ExportTemplateParams): Promise<ArrayBuffer>;
|
|
1855
|
+
getFields(scope?: 'all' | 'project' | 'team'): Promise<ExportFieldsResponse>;
|
|
1856
|
+
getReportTypes(): Promise<ExportReportsResponse>;
|
|
1857
|
+
listTemplates(params?: ExportTemplateListParams): Promise<NavigablePage<ExportTemplate>>;
|
|
1858
|
+
searchTemplates(params: ExportTemplateListParams): Promise<NavigablePage<ExportTemplate>>;
|
|
1859
|
+
createTemplate(data: ExportTemplateCreateRequest): Promise<ExportTemplate>;
|
|
1860
|
+
getTemplate(templateId: string): Promise<ExportTemplate>;
|
|
1861
|
+
updateTemplate(templateId: string, data: ExportTemplateUpdateRequest): Promise<ExportTemplate>;
|
|
1862
|
+
deleteTemplate(templateId: string): Promise<void>;
|
|
1863
|
+
listCustomFields(scope?: 'TASK' | 'PROJECT' | 'TEAM'): Promise<CustomExportFieldsResponse>;
|
|
1864
|
+
createCustomField(data: CustomExportFieldCreateRequest): Promise<CustomExportField>;
|
|
1865
|
+
getCustomField(fieldId: string): Promise<CustomExportField>;
|
|
1866
|
+
updateCustomField(fieldId: string, data: CustomExportFieldUpdateRequest): Promise<CustomExportField>;
|
|
1867
|
+
deleteCustomField(fieldId: string): Promise<void>;
|
|
1868
|
+
}
|
|
1869
|
+
|
|
1870
|
+
declare class ReportsClient {
|
|
1871
|
+
readonly documents: DocumentReportResource;
|
|
1872
|
+
readonly tasks: TaskReportResource;
|
|
1873
|
+
readonly expenses: ExpenseReportResource;
|
|
1874
|
+
readonly notes: NoteReportResource;
|
|
1875
|
+
readonly export: ExportResource;
|
|
1876
|
+
constructor(apiClient: ApiClient);
|
|
1877
|
+
}
|
|
1878
|
+
|
|
1336
1879
|
declare class TimesheetApiError extends Error {
|
|
1337
1880
|
readonly statusCode?: number;
|
|
1338
1881
|
readonly responseBody?: string;
|
|
@@ -1352,6 +1895,7 @@ declare class TimesheetRateLimitError extends TimesheetApiError {
|
|
|
1352
1895
|
|
|
1353
1896
|
declare class TimesheetClient {
|
|
1354
1897
|
private readonly apiClient;
|
|
1898
|
+
private readonly reportsApiClient;
|
|
1355
1899
|
readonly organizations: OrganizationResource;
|
|
1356
1900
|
readonly teams: TeamResource;
|
|
1357
1901
|
readonly projects: ProjectResource;
|
|
@@ -1368,6 +1912,7 @@ declare class TimesheetClient {
|
|
|
1368
1912
|
readonly timer: TimerResource;
|
|
1369
1913
|
readonly todos: TodoResource;
|
|
1370
1914
|
readonly webhooks: WebhookResource;
|
|
1915
|
+
readonly reports: ReportsClient;
|
|
1371
1916
|
constructor(options: TimesheetClientOptions);
|
|
1372
1917
|
private createAuthentication;
|
|
1373
1918
|
}
|
|
@@ -1381,9 +1926,11 @@ interface TimesheetClientOptions {
|
|
|
1381
1926
|
};
|
|
1382
1927
|
authentication?: Authentication;
|
|
1383
1928
|
baseUrl?: string;
|
|
1929
|
+
reportsBaseUrl?: string;
|
|
1384
1930
|
retryConfig?: RetryConfig;
|
|
1385
1931
|
httpClient?: AxiosInstance;
|
|
1932
|
+
reportsHttpClient?: AxiosInstance;
|
|
1386
1933
|
}
|
|
1387
1934
|
declare function createClient(options: TimesheetClientOptions): TimesheetClient;
|
|
1388
1935
|
|
|
1389
|
-
export { type Activity, ApiClient, ApiKeyAuth, type Authentication, type Automation, type AutomationCreateRequest, type AutomationList, type AutomationListParams, AutomationResource, type AutomationUpdateRequest, type ClientConfig, type Document, type DocumentCreateRequest, type DocumentList, type DocumentListParams, type DocumentPrint, DocumentResource, type DocumentUpdateRequest, type Expense, type ExpenseCreateRequest, type ExpenseList, type ExpenseListParams, ExpenseResource, type ExpenseStatus, type ExpenseUpdateRequest, type ListParams, type Member, NavigablePage, type Note, type NoteCreateRequest, type NoteList, type NoteListParams, NoteResource, type NoteUpdateRequest, OAuth2Auth, type Organization, type OrganizationCreateRequest, type OrganizationList, type OrganizationListParams, OrganizationResource, type OrganizationUpdateRequest, type Page, type PageParams, type Pause, type PauseCreateRequest, type PauseList, type PauseListParams, PauseResource, type PauseUpdateRequest, type Profile, ProfileResource, type ProfileUpdateRequest, type Project, type ProjectCreateRequest, type ProjectList, type ProjectListParams, type ProjectMember, ProjectResource, type ProjectUpdateRequest, type Rate, type RateCreateRequest, type RateList, type RateListParams, RateResource, type RateUpdateRequest, Resource, RetryConfig, type RetryConfigOptions, type Settings, SettingsResource, type SettingsUpdateRequest, type SortablePageParams, type Tag, type TagCreateRequest, type TagList, type TagListParams, TagResource, type TagUpdateRequest, type Task, type TaskCreateRequest, type TaskList, type TaskListParams, type TaskPerformance, TaskResource, type TaskStatistic, type TaskStatusUpdateRequest, type TaskTimesUpdateRequest, type TaskUpdateRequest, type Team, type TeamCreateRequest, type TeamList, type TeamListParams, type TeamMember, type TeamMemberList, type TeamMemberListParams, TeamResource, type TeamUpdateRequest, type Timer, type TimerPauseRequest, TimerResource, type TimerResumeRequest, type TimerStartRequest, type TimerStopRequest, type TimerUpdateRequest, TimesheetApiError, TimesheetAuthError, TimesheetClient, type TimesheetClientOptions, TimesheetRateLimitError, type Todo, type TodoCreateRequest, type TodoList, type TodoListParams, TodoResource, type TodoUpdateRequest, type Webhook, type WebhookCreateRequest, type WebhookList, type WebhookListParams, WebhookResource, type WebhookUpdateRequest, createClient };
|
|
1936
|
+
export { type Activity, ApiClient, ApiKeyAuth, type Authentication, type AuthorizationServerMetadata, type AuthorizationUrlOptions, type Automation, type AutomationCreateRequest, type AutomationList, type AutomationListParams, AutomationResource, type AutomationUpdateRequest, type ClientConfig, type CodeChallengeMethod, type CustomExportField, type CustomExportFieldCreateRequest, type CustomExportFieldUpdateRequest, type CustomExportFieldsResponse, type Document, type DocumentCreateRequest, type DocumentList, type DocumentListParams, type DocumentPrint, type DocumentReport, DocumentReportResource, DocumentResource, type DocumentUpdateRequest, type Expense, type ExpenseCreateRequest, type ExpenseList, type ExpenseListParams, type ExpenseReportItem, ExpenseReportResource, ExpenseResource, type ExpenseStatus, type ExpenseUpdateRequest, type ExportFieldDefinition, type ExportFieldsResponse, type ExportFormat, type ExportParams, type ExportReportType, type ExportReportsResponse, ExportResource, type ExportTemplate, type ExportTemplateCreateRequest, type ExportTemplateListParams, type ExportTemplateParams, type ExportTemplateUpdateRequest, type ExportedField, type FileResponse, type ListParams, type Member, NavigablePage, type Note, type NoteCreateRequest, type NoteList, type NoteListParams, type NoteReportItem, NoteReportResource, NoteResource, type NoteUpdateRequest, OAuth21Auth, type OAuth21RefreshOptions, OAuth2Auth, OAuthDiscovery, type OAuthDiscoveryOptions, type OAuthDiscoveryResult, type OpenIdConfiguration, type Organization, type OrganizationCreateRequest, type OrganizationList, type OrganizationListParams, OrganizationResource, type OrganizationUpdateRequest, type Page, type PageParams, type Pause, type PauseCreateRequest, type PauseList, type PauseListParams, PauseResource, type PauseUpdateRequest, type PkceCodePair, type Profile, ProfileResource, type ProfileUpdateRequest, type Project, type ProjectCreateRequest, type ProjectList, type ProjectListParams, type ProjectMember, ProjectResource, type ProjectUpdateRequest, type ProtectedResourceMetadata, type Rate, type RateCreateRequest, type RateList, type RateListParams, RateResource, type RateUpdateRequest, ReportsClient, Resource, RetryConfig, type RetryConfigOptions, type Settings, SettingsResource, type SettingsUpdateRequest, type SortablePageParams, type Tag, type TagCreateRequest, type TagList, type TagListParams, TagResource, type TagUpdateRequest, type Task, type TaskCreateRequest, type TaskList, type TaskListParams, type TaskPerformance, type TaskReportItem, TaskReportResource, TaskResource, type TaskStatistic, type TaskStatusUpdateRequest, type TaskTimesUpdateRequest, type TaskUpdateRequest, type Team, type TeamCreateRequest, type TeamList, type TeamListParams, type TeamMember, type TeamMemberList, type TeamMemberListParams, TeamResource, type TeamUpdateRequest, type Timer, type TimerPauseRequest, TimerResource, type TimerResumeRequest, type TimerStartRequest, type TimerStopRequest, type TimerUpdateRequest, TimesheetApiError, TimesheetAuthError, TimesheetClient, type TimesheetClientOptions, TimesheetRateLimitError, type Todo, type TodoCreateRequest, type TodoList, type TodoListParams, TodoResource, type TodoUpdateRequest, type TokenExchangeOptions, type Webhook, type WebhookCreateRequest, type WebhookEventType, WebhookEvents, type WebhookList, type WebhookListParams, WebhookResource, type WebhookUpdateRequest, combineWebhookEvents, createClient, discoverOAuth, generateCodeChallenge, generateCodeVerifier, generatePkceCodePair, getDefaultDiscovery, isValidCodeVerifier };
|