@timesheet/sdk 1.0.1 → 1.0.3

package/dist/index.d.ts

@@ -38,6 +38,63 @@ declare class OAuth2Auth implements Authentication {
     private parseTokenExpiry;
 }
 
+type CodeChallengeMethod = 'S256' | 'plain';
+interface PkceCodePair {
+    codeVerifier: string;
+    codeChallenge: string;
+    codeChallengeMethod: CodeChallengeMethod;
+}
+declare function generateCodeVerifier(length?: number): string;
+declare function generateCodeChallenge(codeVerifier: string, method?: CodeChallengeMethod): string;
+declare function generatePkceCodePair(method?: CodeChallengeMethod, verifierLength?: number): PkceCodePair;
+declare function isValidCodeVerifier(codeVerifier: string): boolean;
+
+interface AuthorizationUrlOptions {
+    clientId: string;
+    redirectUri: string;
+    codeChallenge: string;
+    codeChallengeMethod?: CodeChallengeMethod;
+    state?: string;
+    scope?: string;
+    resource?: string;
+}
+interface TokenExchangeOptions {
+    clientId: string;
+    clientSecret?: string;
+    authorizationCode: string;
+    redirectUri: string;
+    codeVerifier: string;
+    resource?: string;
+}
+interface OAuth21RefreshOptions {
+    clientId: string;
+    clientSecret?: string;
+    refreshToken: string;
+    resource?: string;
+}
+declare class OAuth21Auth implements Authentication {
+    private static readonly TOKEN_ENDPOINT;
+    private static readonly AUTH_ENDPOINT;
+    private accessToken;
+    private refreshToken?;
+    private readonly clientId?;
+    private readonly clientSecret?;
+    private readonly resource?;
+    private tokenExpiry?;
+    private refreshPromise?;
+    constructor(accessToken: string);
+    constructor(options: OAuth21RefreshOptions);
+    applyAuth(config: AxiosRequestConfig): void;
+    needsRefresh(): boolean;
+    refresh(): Promise<void>;
+    private performRefresh;
+    getAuthHeaders(): Promise<Record<string, string>>;
+    static fromAuthorizationCode(options: TokenExchangeOptions): Promise<OAuth21Auth>;
+    static buildAuthorizationUrl(options: AuthorizationUrlOptions): string;
+    static generatePkce(method?: CodeChallengeMethod): PkceCodePair;
+    private parseTokenExpiry;
+}
+
 declare class RetryConfig {
     readonly maxRetries: number;
     readonly initialDelay: number;
@@ -136,6 +193,15 @@ interface Team {
     image?: string;
     color?: number;
     projectSalaryVisibility?: number;
+    permission?: {
+        role: string;
+        managerOrOwner: boolean;
+        member: boolean;
+        manager: boolean;
+        owner: boolean;
+    };
+    projects: number;
+    members: number;
     created?: number;
     lastUpdate?: number;
 }
@@ -1007,6 +1073,26 @@ interface DocumentListParams extends ListParams {
     empty?: boolean;
 }
 
+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';
+declare const WebhookEvents: {
+    readonly TEAM_CREATE: "team.create";
+    readonly TEAM_UPDATE: "team.update";
+    readonly PROJECT_CREATE: "project.create";
+    readonly PROJECT_UPDATE: "project.update";
+    readonly TODO_CREATE: "todo.create";
+    readonly TODO_UPDATE: "todo.update";
+    readonly TASK_CREATE: "task.create";
+    readonly TASK_UPDATE: "task.update";
+    readonly TAG_CREATE: "tag.create";
+    readonly TAG_UPDATE: "tag.update";
+    readonly RATE_CREATE: "rate.create";
+    readonly RATE_UPDATE: "rate.update";
+    readonly TIMER_START: "timer.start";
+    readonly TIMER_STOP: "timer.stop";
+    readonly TIMER_PAUSE: "timer.pause";
+    readonly TIMER_RESUME: "timer.resume";
+};
+declare function combineWebhookEvents(...events: WebhookEventType[]): string;
 interface Webhook {
     id: string;
     target: string;
@@ -1083,15 +1169,31 @@ interface AutomationListParams extends ListParams {
 
 interface Settings {
     theme?: 'light' | 'dark' | 'system';
-    timezone?: string;
     language?: string;
+    timezone?: string;
     currency?: string;
+    distance?: string;
     dateFormat?: string;
-    timeFormat?: '12h' | '24h';
+    timeFormat?: string;
+    durationFormat?: string;
+    csvSeparator?: string;
+    slotDuration?: number;
+    snapDuration?: number;
+    entriesPerPage?: number;
     firstDay?: number;
+    defaultTaskDuration?: number;
+    defaultBreakDuration?: number;
+    showRelatives?: boolean;
+    weeklySummary?: boolean;
+    monthlySummary?: boolean;
+    lastUpdate?: number;
     timerRounding?: number;
-    timerRoundingType?: 'up' | 'down' | 'nearest';
+    timerRoundingType?: number;
+    timerEditView?: boolean;
     pauseRounding?: number;
+    pauseRoundingType?: number;
+    pauseEditView?: boolean;
+    autofillProjectSelection?: boolean;
 }
 interface SettingsUpdateRequest extends Settings {
 }
@@ -1138,6 +1240,332 @@ interface ProfileUpdateRequest {
     newsletter?: boolean;
 }
 
+interface TaskReportItem {
+    taskDate?: string;
+    taskStartTime?: string;
+    taskEndTime?: string;
+    taskTimeRange?: string;
+    taskDuration?: string;
+    taskDurationRelative?: string;
+    pauseDuration?: string;
+    taskDescription?: string;
+    taskId?: string;
+    userId?: string;
+    invoiceId?: string;
+    startDateTimeRaw?: string;
+    endDateTimeRaw?: string;
+    durationSeconds?: number;
+    durationBreakSeconds?: number;
+    taskLocation?: string;
+    taskLocationStart?: string;
+    taskLocationEnd?: string;
+    taskDistance?: string;
+    taskRateName?: string;
+    taskRate?: string;
+    taskTotal?: string;
+    taskTotalRelative?: string;
+    projectName?: string;
+    projectClient?: string;
+    projectColor?: string;
+    memberName?: string;
+    taskTags?: string;
+    taskSignature?: string;
+    quantityHours?: number;
+    unitPriceNumeric?: number;
+    lineTotalNumeric?: number;
+    salaryTotalNumeric?: number;
+    salaryBreakNumeric?: number;
+    projectId?: string;
+    memberId?: string;
+    billable?: boolean;
+    paid?: boolean;
+    expenses?: ExpenseReportItem[];
+    notes?: NoteReportItem[];
+}
+interface ExpenseReportItem {
+    expenseDate?: string;
+    expenseTime?: string;
+    expenseAmount?: string;
+    expenseDescription?: string;
+    expenseDescriptionRaw?: string;
+    expenseDateTimeRaw?: string;
+    expenseId?: string;
+    expenseUserId?: string;
+    attachmentBase64?: string;
+    expenseAuthor?: string;
+    amountNumeric?: number;
+}
+interface NoteReportItem {
+    noteDate?: string;
+    noteContent?: string;
+    attachmentBase64?: string;
+    noteType?: string;
+    noteAuthor?: string;
+}
+interface DocumentReport {
+    documentTitle?: string;
+    documentDate?: string;
+    invoiceNumber?: string;
+    customerNumber?: string;
+    paymentDate?: string;
+    paymentMethod?: string;
+    companyName?: string;
+    companyAddress1?: string;
+    companyAddress2?: string;
+    companyAddress3?: string;
+    companyAddress4?: string;
+    companyLogo?: string;
+    customerName?: string;
+    customerAddress1?: string;
+    customerAddress2?: string;
+    customerAddress3?: string;
+    customerAddress4?: string;
+    taskSubtotal?: string;
+    expenseSubtotal?: string;
+    subtotalAmount?: string;
+    taxRate?: number;
+    taxAmount?: string;
+    taxSecondRate?: number;
+    taxSecondAmount?: string;
+    discountRate?: number;
+    discountAmount?: string;
+    discountSecondRate?: number;
+    discountSecondAmount?: string;
+    totalAmount?: string;
+    totalDuration?: string;
+    paymentAmount?: string;
+    eInvoiceType?: string;
+    companyVatId?: string;
+    companyTaxNumber?: string;
+    companyRegistrationNumber?: string;
+    companyBankAccount?: string;
+    companyBankBIC?: string;
+    eInvoiceCurrency?: string;
+    deliveryDate?: string;
+    dueDate?: string;
+    paymentReference?: string;
+    orderReference?: string;
+    taxExemptionReason?: string;
+    reverseChargeRate?: number;
+    isReverseCharge?: boolean;
+    eInvoiceDocumentType?: string;
+    invoiceTypeCode?: string;
+    customerVatId?: string;
+    customerTaxNumber?: string;
+    customerOrderNumber?: string;
+    paymentTermDays?: number;
+    cashDiscountRate?: number;
+    cashDiscountDays?: number;
+    originalInvoiceNumber?: string;
+    originalInvoiceDate?: string;
+    projectReference?: string;
+    costCenter?: string;
+    isGovernmentInvoice?: boolean;
+    procurementReference?: string;
+    contractReference?: string;
+    eInvoicingEnabled?: boolean;
+    documentDescription?: string;
+    documentTerms?: string;
+    documentSignature?: string;
+    showTaskTime?: boolean;
+    showRates?: boolean;
+    showTaxes?: boolean;
+    showSecondTax?: boolean;
+    showDiscount?: boolean;
+    showSecondDiscount?: boolean;
+    includeExpenses?: boolean;
+    includeNotes?: boolean;
+    showProjectTitle?: boolean;
+    showMemberName?: boolean;
+    showTags?: boolean;
+    showQrCode?: boolean;
+    qrCodeType?: string;
+    qrCodeContent?: string;
+    qrCodeDescription?: string;
+    hideExpenseDateTime?: boolean;
+    hideSummation?: boolean;
+    useRelatives?: boolean;
+    tasks?: TaskReportItem[];
+    expenses?: ExpenseReportItem[];
+    notes?: NoteReportItem[];
+    labelDescription?: string;
+    labelRate?: string;
+    labelQuantity?: string;
+    labelTotal?: string;
+    labelTotalSum?: string;
+    labelSubtotal?: string;
+    labelTax?: string;
+    labelSecondTax?: string;
+    labelDiscount?: string;
+    labelSecondDiscount?: string;
+    labelExpenseTitle?: string;
+    labelExpenseTotal?: string;
+    templateId?: string;
+    reportType?: string;
+    language?: string;
+    currency?: string;
+    currencyCode?: string;
+}
+interface ExportedField {
+    id: string;
+    name?: string;
+    position?: number;
+    projectField?: boolean;
+    teamField?: boolean;
+    customField?: boolean;
+    customValue?: string;
+    customFormula?: string;
+    customType?: string;
+}
+interface ExportParams {
+    report: number;
+    email?: string;
+    filename?: string;
+    teamIds?: string[];
+    projectIds?: string[];
+    userIds?: string[];
+    tagIds?: string[];
+    type?: string;
+    startDate: string;
+    endDate: string;
+    format?: ExportFormat;
+    filter?: string;
+    splitTask?: boolean;
+    summarize?: boolean;
+    saveAsTemplate?: boolean;
+    templateName?: string;
+    exportedFields?: ExportedField[];
+}
+type ExportFormat = 'xlsx' | 'xlsx1904' | 'csv' | 'pdf';
+interface ExportTemplateParams {
+    templateId: string;
+    startDate: string;
+    endDate: string;
+}
+interface FileResponse {
+    url: string;
+    filename?: string;
+    contentType?: string;
+}
+interface ExportTemplate {
+    id: string;
+    user?: string;
+    deleted?: boolean;
+    lastUpdate?: number;
+    created?: number;
+    name: string;
+    report: number;
+    teamIds?: string[];
+    projectIds?: string[];
+    userIds?: string[];
+    tagIds?: string[];
+    type?: string;
+    format?: string;
+    filter?: string;
+    splitTask?: boolean;
+    summarize?: boolean;
+    email?: string;
+    filename?: string;
+    exportedFields?: ExportedField[];
+}
+interface ExportTemplateCreateRequest {
+    name: string;
+    report?: number;
+    teamIds?: string[];
+    projectIds?: string[];
+    userIds?: string[];
+    tagIds?: string[];
+    type?: string;
+    format?: string;
+    filter?: string;
+    splitTask?: boolean;
+    summarize?: boolean;
+    email?: string;
+    filename?: string;
+    exportedFields?: ExportedField[];
+}
+interface ExportTemplateUpdateRequest {
+    name?: string;
+    report?: number;
+    teamIds?: string[];
+    projectIds?: string[];
+    userIds?: string[];
+    tagIds?: string[];
+    type?: string;
+    format?: string;
+    filter?: string;
+    splitTask?: boolean;
+    summarize?: boolean;
+    email?: string;
+    filename?: string;
+    exportedFields?: ExportedField[];
+}
+interface ExportTemplateListParams {
+    sort?: 'alpha' | 'name' | 'created' | 'lastUpdate';
+    order?: 'asc' | 'desc';
+    page?: number;
+    limit?: number;
+    search?: string;
+}
+interface ExportFieldDefinition {
+    fieldId: string;
+    nameKey?: string;
+    descriptionKey?: string;
+    name: string;
+    description?: string;
+    type?: string;
+    category?: string;
+    scope?: string;
+    defaultEnabled?: boolean;
+    defaultPosition?: number;
+    customField?: boolean;
+    customType?: string;
+    customValue?: string;
+    customFormula?: string;
+}
+interface ExportFieldsResponse {
+    fields: ExportFieldDefinition[];
+}
+interface ExportReportType {
+    id: number;
+    name: string;
+    description?: string;
+    acceptsCustomFields?: boolean;
+    fieldScope?: string;
+}
+interface ExportReportsResponse {
+    reports: ExportReportType[];
+}
+interface CustomExportField {
+    id: string;
+    user?: string;
+    name: string;
+    scope: string;
+    type: string;
+    value?: string;
+    width?: number;
+    deleted?: boolean;
+    lastUpdate?: number;
+    created?: number;
+}
+interface CustomExportFieldCreateRequest {
+    name: string;
+    scope: string;
+    type: string;
+    value?: string;
+    width?: number;
+}
+interface CustomExportFieldUpdateRequest {
+    name?: string;
+    scope?: string;
+    type?: string;
+    value?: string;
+    width?: number;
+}
+interface CustomExportFieldsResponse {
+    fields: CustomExportField[];
+}
+
 interface ResourceConfig {
     basePath: string;
 }
@@ -1308,6 +1736,60 @@ declare class WebhookResource extends Resource {
     search(params: WebhookListParams): Promise<NavigablePage<Webhook>>;
 }
 
+declare class DocumentReportResource extends Resource {
+    constructor(client: ApiClient);
+    get(documentId: string): Promise<DocumentReport>;
+    getPdf(documentId: string): Promise<ArrayBuffer>;
+    getXml(documentId: string): Promise<string>;
+}
+
+declare class TaskReportResource extends Resource {
+    constructor(client: ApiClient);
+    get(taskId: string): Promise<TaskReportItem>;
+    getPdf(taskId: string): Promise<ArrayBuffer>;
+}
+
+declare class ExpenseReportResource extends Resource {
+    constructor(client: ApiClient);
+    get(expenseId: string): Promise<ExpenseReportItem>;
+    getPdf(expenseId: string): Promise<ArrayBuffer>;
+}
+
+declare class NoteReportResource extends Resource {
+    constructor(client: ApiClient);
+    get(noteId: string): Promise<NoteReportItem>;
+    getPdf(noteId: string): Promise<ArrayBuffer>;
+}
+
+declare class ExportResource extends Resource {
+    constructor(client: ApiClient);
+    generate(params: ExportParams): Promise<FileResponse>;
+    send(params: ExportParams): Promise<void>;
+    generateFromTemplate(params: ExportTemplateParams): Promise<ArrayBuffer>;
+    getFields(scope?: 'all' | 'project' | 'team'): Promise<ExportFieldsResponse>;
+    getReportTypes(): Promise<ExportReportsResponse>;
+    listTemplates(params?: ExportTemplateListParams): Promise<NavigablePage<ExportTemplate>>;
+    searchTemplates(params: ExportTemplateListParams): Promise<NavigablePage<ExportTemplate>>;
+    createTemplate(data: ExportTemplateCreateRequest): Promise<ExportTemplate>;
+    getTemplate(templateId: string): Promise<ExportTemplate>;
+    updateTemplate(templateId: string, data: ExportTemplateUpdateRequest): Promise<ExportTemplate>;
+    deleteTemplate(templateId: string): Promise<void>;
+    listCustomFields(scope?: 'TASK' | 'PROJECT' | 'TEAM'): Promise<CustomExportFieldsResponse>;
+    createCustomField(data: CustomExportFieldCreateRequest): Promise<CustomExportField>;
+    getCustomField(fieldId: string): Promise<CustomExportField>;
+    updateCustomField(fieldId: string, data: CustomExportFieldUpdateRequest): Promise<CustomExportField>;
+    deleteCustomField(fieldId: string): Promise<void>;
+}
+
+declare class ReportsClient {
+    readonly documents: DocumentReportResource;
+    readonly tasks: TaskReportResource;
+    readonly expenses: ExpenseReportResource;
+    readonly notes: NoteReportResource;
+    readonly export: ExportResource;
+    constructor(apiClient: ApiClient);
+}
+
 declare class TimesheetApiError extends Error {
     readonly statusCode?: number;
     readonly responseBody?: string;
@@ -1327,6 +1809,7 @@ declare class TimesheetRateLimitError extends TimesheetApiError {
 
 declare class TimesheetClient {
     private readonly apiClient;
+    private readonly reportsApiClient;
     readonly organizations: OrganizationResource;
     readonly teams: TeamResource;
     readonly projects: ProjectResource;
@@ -1343,6 +1826,7 @@ declare class TimesheetClient {
     readonly timer: TimerResource;
     readonly todos: TodoResource;
     readonly webhooks: WebhookResource;
+    readonly reports: ReportsClient;
     constructor(options: TimesheetClientOptions);
     private createAuthentication;
 }
@@ -1356,9 +1840,11 @@ interface TimesheetClientOptions {
     };
     authentication?: Authentication;
     baseUrl?: string;
+    reportsBaseUrl?: string;
     retryConfig?: RetryConfig;
     httpClient?: AxiosInstance;
+    reportsHttpClient?: AxiosInstance;
 }
 declare function createClient(options: TimesheetClientOptions): TimesheetClient;
 
-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 };
+export { type Activity, ApiClient, ApiKeyAuth, type Authentication, 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, 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 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, generateCodeChallenge, generateCodeVerifier, generatePkceCodePair, isValidCodeVerifier };