@saturation-api/js/dist/types/client.d.ts

TypeScript SDK for the Saturation API

import type * as Types from './generated/types.gen.js';
export type SaturationOptions = {
    apiKey: string;
    baseURL?: string;
} | {
    authToken: string;
    workspaceId: string;
    baseURL?: string;
};
export declare class Saturation {
    private client;
    constructor(options: SaturationOptions);
    listProjects(params?: Types.ListProjectsData['query']): Promise<{
        projects: Types.Project[];
    }>;
    getProject(projectId: string): Promise<Types.Project>;
    createProject(data: Types.CreateProjectInput): Promise<Types.Project>;
    updateProject(projectId: string, data: Types.UpdateProjectInput): Promise<Types.Project>;
    deleteProject(projectId: string): Promise<void>;
    getBudget(projectId: string, params?: Types.GetBudgetData['query']): Promise<Types.Budget>;
    createBudgetLines(projectId: string, data: Types.CreateBudgetInput): Promise<Types.Budget>;
    getBudgetLine(projectId: string, lineId: string, params?: Types.GetBudgetLineData['query']): Promise<Types.BudgetLine>;
    updateBudgetLine(projectId: string, lineId: string, data: Types.UpdateBudgetLineRequest): Promise<Types.BudgetLine>;
    deleteBudgetLine(projectId: string, lineId: string, idMode?: 'user' | 'system'): Promise<void>;
    listBudgetAccounts(projectId: string, params?: Types.ListBudgetAccountsData['query']): Promise<{
        budgetLines: Types.AccountSummary[];
    }>;
    listActuals(projectId: string, params?: Types.ListActualsData['query']): Promise<{
        actuals: Types.Actual[];
        totalAmount: number;
    }>;
    getActual(projectId: string, actualId: string, params?: Types.GetActualData['query']): Promise<Types.Actual>;
    createActual(projectId: string, actualId: string, data: Types.CreateActualInput): Promise<Types.Actual>;
    updateActual(projectId: string, actualId: string, data: Types.UpdateActualInput): Promise<Types.Actual>;
    deleteActual(projectId: string, actualId: string): Promise<void>;
    uploadActualAttachment(projectId: string, actualId: string, file: File | Blob): Promise<Types.File>;
    listPurchaseOrders(projectId: string, params?: Types.ListPurchaseOrdersData['query']): Promise<{
        purchaseOrders: Types.PurchaseOrder[];
    }>;
    getPurchaseOrder(projectId: string, purchaseOrderId: string, params?: Types.GetPurchaseOrderData['query']): Promise<Types.PurchaseOrder>;
    createPurchaseOrder(projectId: string, purchaseOrderId: string, data: Types.CreatePurchaseOrderInput): Promise<Types.PurchaseOrder>;
    updatePurchaseOrder(projectId: string, purchaseOrderId: string, data: Types.UpdatePurchaseOrderInput): Promise<Types.PurchaseOrder>;
    deletePurchaseOrder(projectId: string, purchaseOrderId: string): Promise<void>;
    uploadPurchaseOrderAttachment(projectId: string, purchaseOrderId: string, file: File | Blob): Promise<Types.File>;
    listBudgetPhases(projectId: string, idMode?: 'user' | 'system'): Promise<{
        phases: Types.Phase[];
    }>;
    getBudgetPhase(projectId: string, phaseId: string, idMode?: 'user' | 'system'): Promise<Types.Phase>;
    createBudgetPhase(projectId: string, data: Types.CreatePhaseRequest): Promise<Types.Phase>;
    updateBudgetPhase(projectId: string, phaseId: string, data: Types.UpdatePhaseRequest): Promise<Types.Phase>;
    deleteBudgetPhase(projectId: string, phaseId: string): Promise<void>;
    listBudgetFringes(projectId: string, idMode?: 'user' | 'system'): Promise<{
        fringes: Types.Fringe[];
    }>;
    getBudgetFringe(projectId: string, fringeId: string, idMode?: 'user' | 'system'): Promise<Types.Fringe>;
    createBudgetFringe(projectId: string, data: Types.CreateFringeRequest): Promise<Types.Fringe>;
    updateBudgetFringe(projectId: string, fringeId: string, data: Types.UpdateFringeRequest): Promise<Types.Fringe>;
    deleteBudgetFringe(projectId: string, fringeId: string): Promise<void>;
    listBudgetGlobals(projectId: string, idMode?: 'user' | 'system'): Promise<{
        globals: Types.Global[];
    }>;
    getBudgetGlobal(projectId: string, globalId: string, idMode?: 'user' | 'system'): Promise<Types.Global>;
    createBudgetGlobal(projectId: string, data: Types.CreateGlobalRequest): Promise<Types.Global>;
    updateBudgetGlobal(projectId: string, globalId: string, data: Types.UpdateGlobalRequest): Promise<Types.Global>;
    deleteBudgetGlobal(projectId: string, globalId: string): Promise<void>;
    listTags(projectId: string, params?: Types.ListTagsData['query']): Promise<Types.TagsResponse>;
    getTag(projectId: string, tagId: string, idMode?: 'user' | 'system'): Promise<Types.TagResponse>;
    createTag(projectId: string, data: Types.CreateTagRequest): Promise<Types.TagResponse>;
    updateTag(projectId: string, tagId: string, data: Types.UpdateTagRequest): Promise<Types.TagResponse>;
    deleteTag(projectId: string, tagId: string): Promise<void>;
    listContacts(params?: Types.ListContactsData['query']): Promise<{
        contacts: Types.Contact[];
    }>;
    getContact(contactId: string, params?: Types.GetContactData['query']): Promise<Types.Contact>;
    createContact(data: Types.CreateContactInput): Promise<Types.Contact>;
    updateContact(contactId: string, data: Types.UpdateContactInput): Promise<Types.Contact>;
    listSpaces(params?: Types.ListSpacesData['query']): Promise<{
        spaces: Types.Space[];
    }>;
    getSpace(spaceId: string, params?: Types.GetSpaceData['query']): Promise<Types.Space>;
    createSpace(data: Types.CreateSpaceInput): Promise<Types.Space>;
    updateSpace(spaceId: string, data: Types.UpdateSpaceInput): Promise<Types.Space>;
    deleteSpace(spaceId: string): Promise<void>;
    uploadFile(file: File | Blob, projectId?: string, type?: string): Promise<Types.File>;
    downloadFile(fileId: string): Promise<Blob>;
    deleteFile(fileId: string): Promise<void>;
    listComments(projectId: string, params?: Types.ListCommentsData['query']): Promise<{
        comments: Types.Comment[];
    }>;
    listWorkspaceRates(params?: Types.ListWorkspaceRatesData['query']): Promise<{
        rates: Types.Rate[];
    }>;
    createWorkspaceRate(data: Types.CreateRateInput): Promise<Types.Rate>;
    deleteWorkspaceRate(rateId: string): Promise<void>;
    updateWorkspaceRate(rateId: string, data: Types.UpdateRateInput): Promise<Types.Rate>;
    listPublicRatepacks(params?: Types.ListPublicRatepacksData['query']): Promise<{
        ratepacks: Types.PublicRatepack[];
    }>;
    getPublicRates(ratepackId: string, params?: Types.GetPublicRatesData['query']): Promise<{
        rates: Types.Rate[];
    }>;
    listTransactions(params?: Types.ListTransactionsData['query']): Promise<{
        transactions: Types.Transaction[];
    }>;
    getTransaction(transactionId: string, params?: Types.GetTransactionData['query']): Promise<Types.Transaction>;
    updateTransaction(transactionId: string, data: Types.UpdateTransactionInput): Promise<Types.Transaction>;
    uploadTransactionAttachment(transactionId: string, file: File | Blob): Promise<Types.File>;
    uploadContactTaxDocument(contactId: string, file: File | Blob): Promise<Types.File>;
    uploadContactAttachment(contactId: string, file: File | Blob): Promise<Types.File>;
}
//# sourceMappingURL=client.d.ts.map