@incomy/platform-sdk 0.6.0-beta.2343 → 0.6.0-beta.2408

package/dist/services/hub/index.d.ts

@@ -20,6 +20,10 @@ export type { CompanyEdit } from './models/CompanyEdit';
 export type { CompanyInsert } from './models/CompanyInsert';
 export type { CompanyPaginatedList } from './models/CompanyPaginatedList';
 export type { CurrencyInfo } from './models/CurrencyInfo';
+export type { Document } from './models/Document';
+export type { DocumentLinkRequest } from './models/DocumentLinkRequest';
+export type { DocumentUploadRequest } from './models/DocumentUploadRequest';
+export type { DocumentUploadTicket } from './models/DocumentUploadTicket';
 export type { Icon } from './models/Icon';
 export type { InputFieldDefinition } from './models/InputFieldDefinition';
 export type { Label } from './models/Label';
@@ -94,8 +98,10 @@ export { CurrenciesService } from './services/CurrenciesService';
 export { DeletedProjectsService } from './services/DeletedProjectsService';
 export { LabelsService } from './services/LabelsService';
 export { MembersService } from './services/MembersService';
+export { MockStorageService } from './services/MockStorageService';
 export { MultiEventsService } from './services/MultiEventsService';
 export { OperationsService } from './services/OperationsService';
+export { ProjectDocumentsService } from './services/ProjectDocumentsService';
 export { ProjectsService } from './services/ProjectsService';
 export { ProjectWalletsService } from './services/ProjectWalletsService';
 export { TemplatesService } from './services/TemplatesService';

package/dist/services/hub/index.js

@@ -13,8 +13,10 @@ export { CurrenciesService } from './services/CurrenciesService';
 export { DeletedProjectsService } from './services/DeletedProjectsService';
 export { LabelsService } from './services/LabelsService';
 export { MembersService } from './services/MembersService';
+export { MockStorageService } from './services/MockStorageService';
 export { MultiEventsService } from './services/MultiEventsService';
 export { OperationsService } from './services/OperationsService';
+export { ProjectDocumentsService } from './services/ProjectDocumentsService';
 export { ProjectsService } from './services/ProjectsService';
 export { ProjectWalletsService } from './services/ProjectWalletsService';
 export { TemplatesService } from './services/TemplatesService';

package/dist/services/hub/models/Accrual.d.ts

@@ -17,6 +17,16 @@ export type Accrual = {
      */
     deleteWithMultiEventRemoval?: boolean;
     description?: string | null;
+    /**
+     * Number of documents attached to this accrual (live, Ready only); 0 when none. Read-only,
+     * server-populated on read — see the document-attachments roadmap.
+     */
+    documentCount?: number;
+    /**
+     * If true, this accrual is expected to have at least one attached document. Advisory only — the UI warns
+     * when none is attached and never blocks saving. The UI auto-sets it when a company is selected.
+     */
+    documentRequired?: boolean;
     /**
      * If null, the source is the project itself.
      */

package/dist/services/hub/models/AccrualEdit.d.ts

@@ -11,6 +11,10 @@ export type AccrualEdit = {
      */
     deleteWithMultiEventRemoval?: boolean | null;
     description?: string | null;
+    /**
+     * If provided, sets whether this accrual is expected to have an attached document (advisory). Null leaves it unchanged.
+     */
+    documentRequired?: boolean | null;
     /**
      * If null, the source is the Project itself.
      */

package/dist/services/hub/models/AccrualInsert.d.ts

@@ -8,6 +8,16 @@ export type AccrualInsert = {
      */
     deleteWithMultiEventRemoval?: boolean;
     description?: string | null;
+    /**
+     * Ids of already-uploaded, still-unlinked project documents to attach to this accrual on create — the
+     * upload-first-then-link flow, so a new accrual's documents upload (with real progress) before the accrual
+     * exists and are linked here. Each must belong to the project and be unlinked; the per-item document limit applies.
+     */
+    documentIds?: Array<string> | null;
+    /**
+     * If true, this accrual is expected to have at least one attached document (advisory). Defaults to false.
+     */
+    documentRequired?: boolean;
     /**
      * If null, the source is the project itself.
      */

package/dist/services/hub/models/Document.d.ts

@@ -0,0 +1,30 @@
+/**
+ * A document (file) attached to a project and linked to any number of money items — operations and/or accruals
+ * (many-to-many; never a multievent directly). The binary lives in object storage; this is the metadata plus a
+ * freshly-minted, short-lived presigned Incomy.Platform.Hub.Models.Document.DownloadUrl (populated per read, never persisted).
+ * See docs/roadmap/document-attachments-and-object-storage.md.
+ */
+export type Document = {
+    contentType: string;
+    /**
+     * Server-assigned creation time. Read-only.
+     */
+    dateCreated: string;
+    /**
+     * A freshly-generated, short-lived presigned URL to download the binary directly from object storage.
+     * Populated on read; null on a document that is still Incomy.Platform.Hub.Models.DocumentStatus.Pending.
+     */
+    downloadUrl?: string | null;
+    fileName: string;
+    id: string;
+    /**
+     * Size of the binary in bytes.
+     */
+    sizeBytes?: number;
+    /**
+     * Lifecycle of a document's binary in object storage. A document row is created Incomy.Platform.Hub.Models.DocumentStatus.Pending when an
+     * upload is initiated (the presigned URL is handed out); it flips to Incomy.Platform.Hub.Models.DocumentStatus.Ready once the client confirms
+     * the direct upload completed. See docs/roadmap/document-attachments-and-object-storage.md.
+     */
+    status: 'pending' | 'ready';
+};

package/dist/services/hub/models/Document.js

@@ -0,0 +1 @@
+export {};

package/dist/services/hub/models/DocumentLinkRequest.d.ts

@@ -0,0 +1,7 @@
+/**
+ * The event to link a document to: exactly one of the two ids is set (operation OR accrual).
+ */
+export type DocumentLinkRequest = {
+    accrualId?: string | null;
+    operationId?: string | null;
+};

package/dist/services/hub/models/DocumentLinkRequest.js

@@ -0,0 +1 @@
+export {};

package/dist/services/hub/models/DocumentUploadRequest.d.ts

@@ -0,0 +1,8 @@
+/**
+ * The client's request to attach a document: the file metadata needed to mint an upload ticket.
+ */
+export type DocumentUploadRequest = {
+    contentType: string;
+    fileName: string;
+    sizeBytes?: number;
+};

package/dist/services/hub/models/DocumentUploadRequest.js

@@ -0,0 +1 @@
+export {};

package/dist/services/hub/models/DocumentUploadTicket.d.ts

@@ -0,0 +1,22 @@
+import type { Document } from './Document';
+/**
+ * The result of initiating an upload: the created (Incomy.Platform.Hub.Models.DocumentStatus.Pending) document plus a
+ * presigned Incomy.Platform.Hub.Models.DocumentUploadTicket.UploadUrl the client PUTs the file to directly. After the direct upload succeeds the
+ * client calls the complete endpoint to flip the document to Incomy.Platform.Hub.Models.DocumentStatus.Ready.
+ */
+export type DocumentUploadTicket = {
+    document: Document;
+    /**
+     * When the presigned Incomy.Platform.Hub.Models.DocumentUploadTicket.UploadUrl expires.
+     */
+    expiresAt: string;
+    /**
+     * Headers the client must send with the direct upload (e.g. Content-Type).
+     */
+    headers?: Record<string, string | null> | null;
+    /**
+     * HTTP method to use for the direct upload (e.g. "PUT").
+     */
+    method: string;
+    uploadUrl: string;
+};

package/dist/services/hub/models/DocumentUploadTicket.js

@@ -0,0 +1 @@
+export {};

package/dist/services/hub/models/LogAccrual.d.ts

@@ -19,6 +19,16 @@ export type LogAccrual = {
      */
     deleteWithMultiEventRemoval?: boolean;
     description?: string | null;
+    /**
+     * Number of documents attached to this accrual (live, Ready only); 0 when none. Read-only,
+     * server-populated on read — see the document-attachments roadmap.
+     */
+    documentCount?: number;
+    /**
+     * If true, this accrual is expected to have at least one attached document. Advisory only — the UI warns
+     * when none is attached and never blocks saving. The UI auto-sets it when a company is selected.
+     */
+    documentRequired?: boolean;
     /**
      * If null, the source is the project itself.
      */

package/dist/services/hub/models/LogOperation.d.ts

@@ -17,6 +17,16 @@ export type LogOperation = {
      * If set, operation will be deleted when unlined from a multievent or when linked multievent is deleted.
      */
     deleteWithMultiEventRemoval?: boolean;
+    /**
+     * Number of documents attached to this operation (live, Ready only); 0 when none. Read-only,
+     * server-populated on read — see the document-attachments roadmap.
+     */
+    documentCount?: number;
+    /**
+     * If true, this operation is expected to have at least one attached document. Advisory only — the UI warns
+     * when none is attached and never blocks saving. The UI auto-sets it when a company is selected.
+     */
+    documentRequired?: boolean;
     id: string;
     labelIds: Array<string>;
     money: Money;

package/dist/services/hub/models/Operation.d.ts

@@ -15,6 +15,16 @@ export type Operation = {
      * If set, operation will be deleted when unlined from a multievent or when linked multievent is deleted.
      */
     deleteWithMultiEventRemoval?: boolean;
+    /**
+     * Number of documents attached to this operation (live, Ready only); 0 when none. Read-only,
+     * server-populated on read — see the document-attachments roadmap.
+     */
+    documentCount?: number;
+    /**
+     * If true, this operation is expected to have at least one attached document. Advisory only — the UI warns
+     * when none is attached and never blocks saving. The UI auto-sets it when a company is selected.
+     */
+    documentRequired?: boolean;
     id: string;
     labelIds: Array<string>;
     money: Money;

package/dist/services/hub/models/OperationEdit.d.ts

@@ -6,6 +6,10 @@ export type OperationEdit = {
      * If set, operation will be deleted when unlined from a multievent or when linked multievent is deleted.
      */
     deleteWithMultiEventRemoval?: boolean | null;
+    /**
+     * If provided, sets whether this operation is expected to have an attached document (advisory). Null leaves it unchanged.
+     */
+    documentRequired?: boolean | null;
     labelIds?: Array<string> | null;
     money?: Money;
     /**

package/dist/services/hub/models/OperationInsert.d.ts

@@ -6,6 +6,16 @@ export type OperationInsert = {
      * If set, operation will be deleted when unlined from a multievent or when linked multievent is deleted.
      */
     deleteWithMultiEventRemoval?: boolean;
+    /**
+     * Ids of already-uploaded, still-unlinked project documents to attach to this operation on create — the
+     * upload-first-then-link flow, so a new operation's documents upload (with real progress) before the operation
+     * exists and are linked here. Each must belong to the project and be unlinked; the per-item document limit applies.
+     */
+    documentIds?: Array<string> | null;
+    /**
+     * If true, this operation is expected to have at least one attached document (advisory). Defaults to false.
+     */
+    documentRequired?: boolean;
     labelIds?: Array<string> | null;
     money: Money;
     multiEventId?: string | null;

package/dist/services/hub/models/TrashItem.d.ts

@@ -26,5 +26,5 @@ export type TrashItem = {
     /**
      * Entity type of the trashed item.
      */
-    type?: 'Project' | 'MultiEvent' | 'Operation' | 'Accrual' | 'Wallet' | 'Member' | 'Bucket' | 'Company' | 'Template' | 'Label';
+    type?: 'Project' | 'MultiEvent' | 'Operation' | 'Accrual' | 'Wallet' | 'Member' | 'Bucket' | 'Company' | 'Template' | 'Label' | 'Document';
 };

package/dist/services/hub/services/MockStorageService.d.ts

@@ -0,0 +1,17 @@
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class MockStorageService {
+    /**
+     * @returns any OK
+     * @throws ApiError
+     */
+    static getMockStorage({ key, }: {
+        key: string;
+    }): CancelablePromise<any>;
+    /**
+     * @returns any OK
+     * @throws ApiError
+     */
+    static putMockStorage({ key, }: {
+        key: string;
+    }): CancelablePromise<any>;
+}

package/dist/services/hub/services/MockStorageService.js

@@ -0,0 +1,30 @@
+import { OpenAPI } from '../core/OpenAPI';
+import { request as __request } from '../core/request';
+export class MockStorageService {
+    /**
+     * @returns any OK
+     * @throws ApiError
+     */
+    static getMockStorage({ key, }) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/mock-storage/{key}',
+            path: {
+                'key': key,
+            },
+        });
+    }
+    /**
+     * @returns any OK
+     * @throws ApiError
+     */
+    static putMockStorage({ key, }) {
+        return __request(OpenAPI, {
+            method: 'PUT',
+            url: '/mock-storage/{key}',
+            path: {
+                'key': key,
+            },
+        });
+    }
+}

package/dist/services/hub/services/ProjectDocumentsService.d.ts

@@ -0,0 +1,71 @@
+import type { Document } from '../models/Document';
+import type { DocumentLinkRequest } from '../models/DocumentLinkRequest';
+import type { DocumentUploadRequest } from '../models/DocumentUploadRequest';
+import type { DocumentUploadTicket } from '../models/DocumentUploadTicket';
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class ProjectDocumentsService {
+    /**
+     * Documents attached to an event — supply exactly one of `operationId`/`accrualId`.
+     * @returns Document OK
+     * @throws ApiError
+     */
+    static getProjectsDocuments({ projectId, operationId, accrualId, }: {
+        projectId: string;
+        operationId?: string;
+        accrualId?: string;
+    }): CancelablePromise<Array<Document>>;
+    /**
+     * @returns DocumentUploadTicket OK
+     * @throws ApiError
+     */
+    static postProjectsDocuments({ projectId, requestBody, }: {
+        projectId: string;
+        requestBody?: DocumentUploadRequest;
+    }): CancelablePromise<DocumentUploadTicket>;
+    /**
+     * Delete the whole document (from every event). Unlinked/Pending → hard-delete; linked, Ready → Trash.
+     * @returns any OK
+     * @throws ApiError
+     */
+    static deleteProjectsDocuments({ projectId, documentId, }: {
+        projectId: string;
+        documentId: string;
+    }): CancelablePromise<any>;
+    /**
+     * @returns Document OK
+     * @throws ApiError
+     */
+    static getProjectsDocuments1({ projectId, documentId, }: {
+        projectId: string;
+        documentId: string;
+    }): CancelablePromise<Document>;
+    /**
+     * @returns Document OK
+     * @throws ApiError
+     */
+    static postProjectsDocumentsComplete({ projectId, documentId, }: {
+        projectId: string;
+        documentId: string;
+    }): CancelablePromise<Document>;
+    /**
+     * Detach a document from one event — supply exactly one of `operationId`/`accrualId`.
+     * @returns any OK
+     * @throws ApiError
+     */
+    static deleteProjectsDocumentsLinks({ projectId, documentId, operationId, accrualId, }: {
+        projectId: string;
+        documentId: string;
+        operationId?: string;
+        accrualId?: string;
+    }): CancelablePromise<any>;
+    /**
+     * Attach a document to an event (many-to-many) — the body sets exactly one of the two event ids.
+     * @returns any OK
+     * @throws ApiError
+     */
+    static postProjectsDocumentsLinks({ projectId, documentId, requestBody, }: {
+        projectId: string;
+        documentId: string;
+        requestBody?: DocumentLinkRequest;
+    }): CancelablePromise<any>;
+}

package/dist/services/hub/services/ProjectDocumentsService.js

@@ -0,0 +1,116 @@
+import { OpenAPI } from '../core/OpenAPI';
+import { request as __request } from '../core/request';
+export class ProjectDocumentsService {
+    /**
+     * Documents attached to an event — supply exactly one of `operationId`/`accrualId`.
+     * @returns Document OK
+     * @throws ApiError
+     */
+    static getProjectsDocuments({ projectId, operationId, accrualId, }) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/projects/{projectId}/documents',
+            path: {
+                'projectId': projectId,
+            },
+            query: {
+                'operationId': operationId,
+                'accrualId': accrualId,
+            },
+        });
+    }
+    /**
+     * @returns DocumentUploadTicket OK
+     * @throws ApiError
+     */
+    static postProjectsDocuments({ projectId, requestBody, }) {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/projects/{projectId}/documents',
+            path: {
+                'projectId': projectId,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * Delete the whole document (from every event). Unlinked/Pending → hard-delete; linked, Ready → Trash.
+     * @returns any OK
+     * @throws ApiError
+     */
+    static deleteProjectsDocuments({ projectId, documentId, }) {
+        return __request(OpenAPI, {
+            method: 'DELETE',
+            url: '/projects/{projectId}/documents/{documentId}',
+            path: {
+                'projectId': projectId,
+                'documentId': documentId,
+            },
+        });
+    }
+    /**
+     * @returns Document OK
+     * @throws ApiError
+     */
+    static getProjectsDocuments1({ projectId, documentId, }) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/projects/{projectId}/documents/{documentId}',
+            path: {
+                'projectId': projectId,
+                'documentId': documentId,
+            },
+        });
+    }
+    /**
+     * @returns Document OK
+     * @throws ApiError
+     */
+    static postProjectsDocumentsComplete({ projectId, documentId, }) {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/projects/{projectId}/documents/{documentId}/complete',
+            path: {
+                'projectId': projectId,
+                'documentId': documentId,
+            },
+        });
+    }
+    /**
+     * Detach a document from one event — supply exactly one of `operationId`/`accrualId`.
+     * @returns any OK
+     * @throws ApiError
+     */
+    static deleteProjectsDocumentsLinks({ projectId, documentId, operationId, accrualId, }) {
+        return __request(OpenAPI, {
+            method: 'DELETE',
+            url: '/projects/{projectId}/documents/{documentId}/links',
+            path: {
+                'projectId': projectId,
+                'documentId': documentId,
+            },
+            query: {
+                'operationId': operationId,
+                'accrualId': accrualId,
+            },
+        });
+    }
+    /**
+     * Attach a document to an event (many-to-many) — the body sets exactly one of the two event ids.
+     * @returns any OK
+     * @throws ApiError
+     */
+    static postProjectsDocumentsLinks({ projectId, documentId, requestBody, }) {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/projects/{projectId}/documents/{documentId}/links',
+            path: {
+                'projectId': projectId,
+                'documentId': documentId,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+}

package/dist/services/hub/services/TrashService.d.ts

@@ -44,7 +44,7 @@ export declare class TrashService {
          * type list — used for the route type segment, the Trash service dispatch, and Incomy.Platform.Hub.Models.TrashItem.Type.
          * Serializes PascalCase ("Project", "MultiEvent", …); route binding is case-insensitive.
          */
-        type: 'Project' | 'MultiEvent' | 'Operation' | 'Accrual' | 'Wallet' | 'Member' | 'Bucket' | 'Company' | 'Template' | 'Label';
+        type: 'Project' | 'MultiEvent' | 'Operation' | 'Accrual' | 'Wallet' | 'Member' | 'Bucket' | 'Company' | 'Template' | 'Label' | 'Document';
         id: string;
         restoreOwners?: boolean;
     }): CancelablePromise<TrashTask>;

package/meta.json

@@ -1,11 +1,11 @@
 {
-  "sdkVersion": "0.6.0-beta.2343",
-  "generatedAt": "2026-07-08T21:14:28.072Z",
-  "apiCommit": "2d32f927",
-  "pipelineUrl": "https://gitlab.com/incomy/platform/-/pipelines/2662928133",
+  "sdkVersion": "0.6.0-beta.2408",
+  "generatedAt": "2026-07-12T19:32:41.308Z",
+  "apiCommit": "8fffd1d9",
+  "pipelineUrl": "https://gitlab.com/incomy/platform/-/pipelines/2671011355",
   "sources": {
     "hub": {
-      "sha256": "38cdf76b0972a6a7a814d7815254a3078e393abca5ed066251588c4900f21ae0"
+      "sha256": "30dae3f929ec253bba0b94e1276e72296b00952c293445bdc0347a56c4811d75"
     }
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@incomy/platform-sdk",
-  "version": "0.6.0-beta.2343",
+  "version": "0.6.0-beta.2408",
   "private": false,
   "type": "module",
   "files": [