tiime-cli 1.1.0

package/dist/index.d.ts

@@ -0,0 +1,554 @@
+import { $Fetch } from 'ofetch';
+
+interface AuthTokens {
+    access_token: string;
+    expires_at: number;
+}
+interface AuthConfig {
+    email: string;
+    password: string;
+}
+interface TiimeClientOptions {
+    companyId: number;
+    tokens?: AuthTokens;
+}
+interface Address {
+    street: string;
+    additional_information1: string | null;
+    additional_information2: string | null;
+    postal_code: string;
+    city: string;
+    country: Country;
+}
+interface Country {
+    id?: number;
+    name: string;
+    code: string;
+    invoicing_vat_exoneration_area?: string;
+    nationality?: string;
+}
+interface User {
+    id: number;
+    firstname: string;
+    lastname: string;
+    email: string;
+    phone: string;
+    civility: string;
+    status: string;
+    roles: string[];
+    active_company: number;
+    director: boolean;
+    has_wallet_access: boolean;
+    has_business_account: boolean;
+    address: Address;
+    created_at: string;
+    acronym: string;
+}
+interface ApeCode {
+    id: number;
+    code: string;
+    label: string;
+}
+interface VatSystem {
+    id: number;
+    code: string;
+    label: string;
+    type: string;
+}
+interface Company {
+    id: number;
+    name: string;
+    legal_form: string;
+    siret: string;
+    vat_number: string;
+    intracom_vat_number: string;
+    ape_code: ApeCode;
+    street: string;
+    address_complement: string | null;
+    postal_code: string;
+    city: string;
+    country: string;
+    share_capital: number;
+    registration_date: string;
+    activity_start_date: string;
+    vat_system: VatSystem;
+    tax_regime: string;
+    receipt_email: string;
+    payment_email: string;
+    has_invoices: boolean;
+    logo: {
+        id: number;
+    };
+    uuid: string;
+    slug: string;
+}
+interface Client {
+    id: number;
+    name: string;
+    slug: string;
+    address: string;
+    address_complement: string | null;
+    postal_code: string;
+    city: string;
+    country: Country;
+    country_code: string;
+    email: string | null;
+    phone: string | null;
+    siren_or_siret: string;
+    siret: string | null;
+    siren: string | null;
+    intracom_vat_number: string | null;
+    archived: boolean;
+    archived_at: string | null;
+    professional: boolean;
+    color: string;
+    acronym: string;
+    note: string | null;
+    bic: string | null;
+    iban: string | null;
+    invoicing_use_email: boolean;
+}
+interface Bank {
+    id: number;
+    name: string;
+    brand: string;
+    sigle: string;
+    code: string;
+    logo_url: string;
+}
+interface BankAccount {
+    id: number;
+    name: string;
+    bank: Bank;
+    bank_account_type: {
+        id: number;
+        code: string;
+        description: string;
+    };
+    iban: string;
+    bic: string;
+    enabled: boolean;
+    balance_amount: number;
+    balance_currency: string;
+    balance_date: string;
+    is_wallet: boolean;
+    closed: boolean;
+    synchronization_date: string;
+}
+interface BankTransaction {
+    id: number;
+    wording: string;
+    original_wording: string;
+    amount: number;
+    currency: string;
+    transaction_date: string;
+    realization_date: string;
+    vat_application_date: string;
+    bank_account: {
+        id: number;
+    };
+    operation_type: string;
+    status: string;
+    status_code: string;
+    comment: string | null;
+    tags: unknown[];
+    short_bank_name: string;
+    beneficiary: unknown | null;
+    merchant: unknown | null;
+    transfer_label: string | null;
+    imputations: unknown[];
+}
+interface BankTransactionsResponse {
+    metadata: {
+        has_multiple_cardholder: boolean;
+        accountant_detail_request_data: unknown[];
+        total_amount: number;
+    };
+    transactions: BankTransaction[];
+}
+interface InvoiceLine {
+    id?: number | null;
+    description: string;
+    quantity: number;
+    unit_amount: number;
+    line_amount?: number;
+    vat_type: {
+        code: string;
+    };
+    invoicing_unit?: {
+        id: number;
+        code: string;
+    } | null;
+    invoicing_category_type?: string;
+    article?: {
+        id: number;
+    } | null;
+    sequence?: number;
+    discount_description?: string;
+    discount_amount?: number | null;
+    discount_percentage?: number | null;
+}
+interface InvoiceSendParams {
+    recipients: {
+        email: string;
+    }[];
+    message?: string;
+    subject?: string;
+}
+interface InvoiceCreateParams {
+    client?: {
+        id: number;
+    } | null;
+    client_name?: string;
+    client_address?: string;
+    client_postal_code?: string;
+    client_city?: string;
+    client_country_code?: string;
+    client_siren_or_siret?: string | null;
+    client_siren_or_siret_enabled?: boolean;
+    client_intracom_vat_number?: string | null;
+    client_intracom_vat_number_enabled?: boolean;
+    emission_date: string;
+    due_date?: string;
+    due_date_mode?: string;
+    title?: string | null;
+    title_enabled?: boolean;
+    lines: InvoiceLine[];
+    text_lines?: unknown[];
+    status?: "draft" | "saved";
+    template?: string;
+    free_field?: string;
+    free_field_enabled?: boolean;
+    discount_enabled?: boolean;
+    bank_detail_enabled?: boolean;
+    payment_condition_enabled?: boolean;
+    payment_condition?: string;
+    iban?: string;
+    bic?: string;
+}
+interface Invoice {
+    id: number;
+    client_id: number | null;
+    client_name: string;
+    compiled_number: string;
+    emission_date: string;
+    number: number | null;
+    status: string;
+    title: string | null;
+    template: string;
+    total_excluding_taxes: number;
+    total_including_taxes: number;
+    due_date: string;
+    lines: InvoiceLine[];
+    type: string;
+    color: string;
+    tags: unknown[];
+    totals_per_vat_type: Record<string, {
+        total_excluding_taxes: number;
+        vat_amount: number;
+    }>;
+}
+interface Quotation {
+    id: number;
+    quotation_number: string | null;
+    date: string;
+    status: string;
+    amount_excluding_taxes: number;
+    amount_including_taxes: number;
+    client: {
+        id: number;
+        name: string;
+    } | null;
+    invoices?: Invoice[];
+}
+interface Document {
+    id: number;
+    name: string;
+    type: string;
+    source: string;
+    created_at: string;
+    metadata: {
+        date: string | null;
+        amount: number | null;
+        supplier_name: string | null;
+    };
+    file_family: string | null;
+    preview_available: boolean;
+}
+interface DocumentCategory {
+    id: number;
+    name: string;
+    code: string;
+    count: number;
+}
+interface ExpenseReport {
+    id: number;
+    name: string;
+    status: string;
+    total_amount: number | null;
+    metadata: {
+        date: string | null;
+    };
+}
+interface QuotationCreateParams {
+    client?: {
+        id: number;
+    } | null;
+    client_name?: string;
+    date: string;
+    title?: string | null;
+    lines: InvoiceLine[];
+    status?: "draft" | "saved";
+}
+interface QuotationSendParams {
+    recipients: {
+        email: string;
+    }[];
+    message?: string;
+    subject?: string;
+}
+interface ExpenseReportCreateParams {
+    name: string;
+    metadata?: {
+        date?: string;
+    };
+}
+interface Label {
+    id: number;
+    name: string;
+    color: string;
+}
+interface Tag {
+    id: number;
+    label: string;
+    tag_detail?: {
+        id: number;
+        label: string;
+    };
+}
+interface PaginatedResponse<T> {
+    items: T[];
+    total: number | null;
+    range: {
+        start: number;
+        end: number;
+    };
+}
+interface DashboardBlock {
+    id: number;
+    type: string;
+    rank: number;
+    display_group: string;
+}
+interface AccountingPeriod {
+    id: number;
+    start_date: string;
+    end_date: string;
+    status: string;
+}
+
+declare class TokenManager {
+    private tokens;
+    constructor();
+    login(email: string, password: string): Promise<AuthTokens>;
+    getValidToken(): Promise<string>;
+    isAuthenticated(): boolean;
+    logout(): void;
+    getTokenInfo(): {
+        email: string | null;
+        expiresAt: Date | null;
+    };
+    private isExpired;
+    private loadFromDisk;
+    private saveToDisk;
+}
+
+declare class BankAccountsResource {
+    private fetch;
+    private companyId;
+    constructor(fetch: $Fetch, companyId: number);
+    list(enabled?: boolean): Promise<BankAccount[]>;
+    get(bankAccountId: number): Promise<BankAccount>;
+    balance(): Promise<{
+        name: string;
+        balance_amount: number;
+        currency: string;
+    }[]>;
+}
+
+interface BankTransactionsListParams {
+    hide_refused?: boolean;
+    bank_account?: number;
+    amount_type?: "positive" | "negative";
+    operation_type?: string;
+    sorts?: string;
+    page?: number;
+    pageSize?: number;
+    from?: string;
+    to?: string;
+    search?: string;
+}
+declare class BankTransactionsResource {
+    private fetch;
+    private companyId;
+    constructor(fetch: $Fetch, companyId: number);
+    list(params?: BankTransactionsListParams): Promise<BankTransactionsResponse>;
+    listAll(params?: Omit<BankTransactionsListParams, "page">): Promise<BankTransaction[]>;
+    unimputed(): Promise<BankTransaction[]>;
+}
+
+interface ClientsListParams {
+    archived?: boolean;
+}
+interface ClientCreateParams {
+    name: string;
+    address?: string;
+    postal_code?: string;
+    city?: string;
+    country_id?: number;
+    email?: string;
+    phone?: string;
+    siren_or_siret?: string;
+    professional?: boolean;
+}
+declare class ClientsResource {
+    private fetch;
+    private companyId;
+    constructor(fetch: $Fetch, companyId: number);
+    list(params?: ClientsListParams): Promise<Client[]>;
+    get(clientId: number): Promise<Client>;
+    create(params: ClientCreateParams): Promise<Client>;
+    search(query: string): Promise<Client[]>;
+}
+
+declare class CompanyResource {
+    private fetch;
+    private companyId;
+    constructor(fetch: $Fetch, companyId: number);
+    get(): Promise<Company>;
+    users(): Promise<any>;
+    appConfig(): Promise<any>;
+    accountingPeriod(rangeYear?: number): Promise<AccountingPeriod>;
+    tiles(keys: string[]): Promise<any>;
+    dashboardBlocks(displayGroup?: string): Promise<any>;
+}
+
+interface DocumentsListParams {
+    types?: string;
+    source?: string;
+    sorts?: string;
+    accountable?: boolean;
+    page?: number;
+    pageSize?: number;
+}
+declare class DocumentsResource {
+    private fetch;
+    private companyId;
+    constructor(fetch: $Fetch, companyId: number);
+    list(params?: DocumentsListParams): Promise<Document[]>;
+    categories(): Promise<DocumentCategory[]>;
+    preview(documentId: number): Promise<any>;
+    upload(file: Uint8Array, filename: string, type?: string): Promise<Document>;
+    download(documentId: number): Promise<ArrayBuffer>;
+}
+
+declare class ExpenseReportsResource {
+    private fetch;
+    private companyId;
+    constructor(fetch: $Fetch, companyId: number);
+    list(sorts?: string): Promise<ExpenseReport[]>;
+    get(expenseReportId: number): Promise<ExpenseReport>;
+    create(params: ExpenseReportCreateParams): Promise<ExpenseReport>;
+}
+
+interface InvoicesListParams {
+    sorts?: string;
+    status?: string;
+    page?: number;
+    pageSize?: number;
+}
+declare class InvoicesResource {
+    private fetch;
+    private companyId;
+    constructor(fetch: $Fetch, companyId: number);
+    list(params?: InvoicesListParams): Promise<Invoice[]>;
+    listAll(params?: {
+        sorts?: string;
+        status?: string;
+        pageSize?: number;
+    }): Promise<Invoice[]>;
+    get(invoiceId: number): Promise<Invoice>;
+    create(params: InvoiceCreateParams): Promise<Invoice>;
+    update(invoiceId: number, params: Partial<InvoiceCreateParams>): Promise<Invoice>;
+    send(invoiceId: number, params: InvoiceSendParams): Promise<void>;
+    downloadPdf(invoiceId: number): Promise<ArrayBuffer>;
+    delete(invoiceId: number): Promise<void>;
+    duplicate(invoiceId: number, overrides?: {
+        emission_date?: string;
+        quantity?: number;
+    }): Promise<Invoice>;
+}
+
+declare class LabelsResource {
+    private fetch;
+    private companyId;
+    constructor(fetch: $Fetch, companyId: number);
+    list(): Promise<Label[]>;
+    standard(): Promise<Label[]>;
+    tags(): Promise<Tag[]>;
+}
+
+declare class QuotationsResource {
+    private fetch;
+    private companyId;
+    constructor(fetch: $Fetch, companyId: number);
+    list(expand?: string): Promise<Quotation[]>;
+    get(quotationId: number): Promise<Quotation>;
+    create(params: QuotationCreateParams): Promise<Quotation>;
+    downloadPdf(quotationId: number): Promise<ArrayBuffer>;
+    send(quotationId: number, params: QuotationSendParams): Promise<void>;
+}
+
+declare class UsersResource {
+    private fetch;
+    constructor(fetch: $Fetch);
+    me(): Promise<User>;
+    legalInformations(): Promise<any>;
+    settings(companyId: number): Promise<any>;
+}
+
+declare class TiimeClient {
+    readonly fetch: $Fetch;
+    readonly tokenManager: TokenManager;
+    readonly companyId: number;
+    constructor(options: TiimeClientOptions & {
+        tokenManager?: TokenManager;
+    });
+    listCompanies(): Promise<Company[]>;
+    get users(): UsersResource;
+    get company(): CompanyResource;
+    get clients(): ClientsResource;
+    get invoices(): InvoicesResource;
+    get quotations(): QuotationsResource;
+    get bankAccounts(): BankAccountsResource;
+    get bankTransactions(): BankTransactionsResource;
+    get documents(): DocumentsResource;
+    get expenseReports(): ExpenseReportsResource;
+    get labels(): LabelsResource;
+}
+
+declare class TiimeError extends Error {
+    status: number;
+    endpoint: string;
+    details?: unknown | undefined;
+    constructor(message: string, status: number, endpoint: string, details?: unknown | undefined);
+    toJSON(): {
+        error: string;
+        message: string;
+        status: number;
+        endpoint: string;
+        details: unknown;
+    };
+}
+
+export { type AccountingPeriod, type Address, type ApeCode, type AuthConfig, type AuthTokens, type Bank, type BankAccount, type BankTransaction, type BankTransactionsResponse, type Client, type Company, type Country, type DashboardBlock, type Document, type DocumentCategory, type ExpenseReport, type ExpenseReportCreateParams, type Invoice, type InvoiceCreateParams, type InvoiceLine, type InvoiceSendParams, type Label, type PaginatedResponse, type Quotation, type QuotationCreateParams, type QuotationSendParams, type Tag, TiimeClient, type TiimeClientOptions, TiimeError, TokenManager, type User, type VatSystem };