@incomy/platform-sdk 0.6.1-beta.2501 → 0.6.1-beta.2566

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

@@ -24,9 +24,13 @@ 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 { DocumentEdit } from './models/DocumentEdit';
 export type { DocumentLinkRequest } from './models/DocumentLinkRequest';
+export type { DocumentLinkTarget } from './models/DocumentLinkTarget';
+export type { DocumentPaginatedList } from './models/DocumentPaginatedList';
 export type { DocumentUploadRequest } from './models/DocumentUploadRequest';
 export type { DocumentUploadTicket } from './models/DocumentUploadTicket';
+export type { EventDocumentsEdit } from './models/EventDocumentsEdit';
 export type { Icon } from './models/Icon';
 export type { InputFieldDefinition } from './models/InputFieldDefinition';
 export type { Label } from './models/Label';

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

@@ -1,4 +1,5 @@
 import type { BucketBreakdown } from './BucketBreakdown';
+import type { EventDocumentsEdit } from './EventDocumentsEdit';
 import type { Money } from './Money';
 import type { TemplateInfo } from './TemplateInfo';
 export type AccrualEdit = {
@@ -16,6 +17,7 @@ export type AccrualEdit = {
      * If provided, sets whether this accrual is expected to have an attached document (advisory). Null leaves it unchanged.
      */
     documentRequired?: boolean | null;
+    documents?: EventDocumentsEdit;
     /**
      * If null, the source is the Project itself.
      */

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

@@ -17,6 +17,12 @@ export type Document = {
     downloadUrl?: string | null;
     fileName: string;
     id: string;
+    /**
+     * Number of events (operations/accruals) this document is currently linked to. Populated on the project
+     * documents-library read so the UI can distinguish a linked document (> 0) from an unlinked library member
+     * (0). Not populated on the per-event list (it is always this event, so it stays 0 there).
+     */
+    linkedEventCount?: number;
     /**
      * Size of the binary in bytes.
      */

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

@@ -0,0 +1,6 @@
+/**
+ * Editable document metadata — currently just its display file name (rename).
+ */
+export type DocumentEdit = {
+    fileName: string;
+};

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

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

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

@@ -0,0 +1,10 @@
+/**
+ * One live event a document is linked to — for showing / navigating to a document's attachments. Exactly
+ * one of the two ids is set (operation XOR accrual); Incomy.Platform.Hub.Models.DocumentLinkTarget.Name is that event's display name. Trashed
+ * events are excluded (you cannot navigate to them in the logbook).
+ */
+export type DocumentLinkTarget = {
+    accrualId?: string | null;
+    name: string;
+    operationId?: string | null;
+};

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

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

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

@@ -0,0 +1,15 @@
+import type { Document } from './Document';
+export type DocumentPaginatedList = {
+    /**
+     * Results for the current query
+     */
+    items: Array<Document>;
+    /**
+     * Token item to start the next query from; Empty start from the beginning
+     */
+    next: string;
+    /**
+     * Estimated total count over all pages. -1 means the total count could not be determined.
+     */
+    totalCount?: number;
+};

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

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

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

@@ -0,0 +1,31 @@
+import type { DocumentEdit } from './DocumentEdit';
+/**
+ * Apply-on-save document changes carried inside an event edit (operation or accrual). Every member is optional and
+ * a null member leaves that aspect untouched, so an edit that omits the whole envelope changes nothing about the
+ * event's documents (backward compatible). Mirrors how a multievent carries its children in one payload: the entire
+ * set of document changes rides the single event PATCH and is applied server-side in that one request (link/unlink
+ * reconcile + rename + soft-delete), so the client never makes separate per-document calls.
+ */
+export type EventDocumentsEdit = {
+    /**
+     * Documents to soft-delete into the Trash in this save — removing them from the library everywhere, not just
+     * this event (distinct from unlink, which keeps the document). Restorable from the Trash. Null or empty deletes
+     * nothing.
+     */
+    deleted?: Array<string> | null;
+    /**
+     * The desired final set of documents linked to this event. When non-null it is authoritative: an id in the set
+     * but not yet linked is linked; a document currently linked but absent from the set is unlinked (it stays in the
+     * project library). An empty list unlinks all. Null leaves the links unchanged. Each id must belong to the
+     * project; the per-event document limit applies. Ignored for a template-backed event (its documents come from
+     * the template's documents input).
+     */
+    ids?: Array<string> | null;
+    /**
+     * Metadata edits to apply in this save: document id -> the edited metadata (currently a rename via
+     * DocumentEdit.FileName). Applied to the project-library document, so the change is visible from every event it
+     * is linked to. Modelled as a DocumentEdit (not a bare string) so future editable document properties extend the
+     * payload without a breaking wire change. Null or empty edits nothing.
+     */
+    updates?: Record<string, DocumentEdit> | null;
+};

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

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

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

@@ -2,5 +2,5 @@ export type InputFieldDefinition = {
     defaultValue?: string | null;
     id: string;
     name: string;
-    type: 'string' | 'number' | 'boolean' | 'member' | 'bucket' | 'wallet' | 'currency';
+    type: 'string' | 'number' | 'boolean' | 'member' | 'bucket' | 'wallet' | 'currency' | 'documents';
 };

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

@@ -1,4 +1,5 @@
 import type { BucketBreakdown } from './BucketBreakdown';
+import type { EventDocumentsEdit } from './EventDocumentsEdit';
 import type { Money } from './Money';
 import type { TemplateInfo } from './TemplateInfo';
 export type OperationEdit = {
@@ -11,6 +12,7 @@ export type OperationEdit = {
      * If provided, sets whether this operation is expected to have an attached document (advisory). Null leaves it unchanged.
      */
     documentRequired?: boolean | null;
+    documents?: EventDocumentsEdit;
     labelIds?: Array<string> | null;
     money?: Money;
     /**

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

@@ -2,6 +2,19 @@ import type { MoneyExpression } from './MoneyExpression';
 import type { TemplateBucketBreakdownDefinition } from './TemplateBucketBreakdownDefinition';
 export type TemplateAccrualDefinition = {
     bucketBreakdownDefinitions?: Array<TemplateBucketBreakdownDefinition> | null;
+    /**
+     * Optional expression evaluated to a bool at apply time; sets the created accrual's advisory
+     * Incomy.Platform.Hub.Models.Accrual.DocumentRequired flag. Empty/null ⇒ false. May bind a boolean input,
+     * e.g. "inputs.needsReceipt".
+     */
+    documentRequiredExpression?: string | null;
+    /**
+     * Optional expression evaluated to a list of project-document ids to attach to the created accrual at
+     * apply time, typically a bound Incomy.Platform.Hub.Models.FieldType.Documents input (e.g. "inputs.receipt"). Empty/null
+     * ⇒ none. Same upload-first-then-link flow as Incomy.Platform.Hub.Models.AccrualInsert.DocumentIds; the per-event
+     * document cap applies.
+     */
+    documentsExpression?: string | null;
     fromMemberIdExpression?: string | null;
     money: MoneyExpression;
     nameExpression: string;

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

@@ -2,6 +2,19 @@ import type { MoneyExpression } from './MoneyExpression';
 import type { TemplateBucketBreakdownDefinition } from './TemplateBucketBreakdownDefinition';
 export type TemplateOperationDefinition = {
     bucketBreakdownDefinitions?: Array<TemplateBucketBreakdownDefinition> | null;
+    /**
+     * Optional expression evaluated to a bool at apply time; sets the created operation's advisory
+     * Incomy.Platform.Hub.Models.Operation.DocumentRequired flag. Empty/null ⇒ false. May bind a boolean input,
+     * e.g. "inputs.needsReceipt".
+     */
+    documentRequiredExpression?: string | null;
+    /**
+     * Optional expression evaluated to a list of project-document ids to attach to the created operation at
+     * apply time, typically a bound Incomy.Platform.Hub.Models.FieldType.Documents input (e.g. "inputs.receipt"). Empty/null
+     * ⇒ none. Same upload-first-then-link flow as Incomy.Platform.Hub.Models.OperationInsert.DocumentIds; the per-event
+     * document cap applies.
+     */
+    documentsExpression?: string | null;
     money: MoneyExpression;
     nameExpression: string;
     originWalletIdExpression?: string | null;

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

@@ -1,19 +1,30 @@
 import type { Document } from '../models/Document';
+import type { DocumentEdit } from '../models/DocumentEdit';
 import type { DocumentLinkRequest } from '../models/DocumentLinkRequest';
+import type { DocumentLinkTarget } from '../models/DocumentLinkTarget';
+import type { DocumentPaginatedList } from '../models/DocumentPaginatedList';
 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
+     * List documents. With `operationId` OR `accrualId`: the documents attached to that event (returned as a
+     * single page). With neither: the whole project documents library, paginated and optionally filtered by a filename
+     * `query` (each item carries its `linkedEventCount`). Sorted by file name (`orderByName`) when set;
+     * otherwise by date added (`orderByDateAdded`, newest first by default). Supplying both event ids is a 400.
+     * @returns DocumentPaginatedList OK
      * @throws ApiError
      */
-    static getProjectsDocuments({ projectId, operationId, accrualId, }: {
+    static getProjectsDocuments({ projectId, operationId, accrualId, query, orderByName, orderByDateAdded, limit, next, }: {
         projectId: string;
         operationId?: string;
         accrualId?: string;
-    }): CancelablePromise<Array<Document>>;
+        query?: string;
+        orderByName?: 'Desc' | 'Asc';
+        orderByDateAdded?: 'Desc' | 'Asc';
+        limit?: number;
+        next?: string;
+    }): CancelablePromise<DocumentPaginatedList>;
     /**
      * @returns DocumentUploadTicket OK
      * @throws ApiError
@@ -40,12 +51,23 @@ export declare class ProjectDocumentsService {
         documentId: string;
     }): CancelablePromise<Document>;
     /**
+     * Edit a document's metadata (currently just its display file name).
      * @returns Document OK
      * @throws ApiError
      */
-    static postProjectsDocumentsComplete({ projectId, documentId, }: {
+    static patchProjectsDocuments({ projectId, documentId, requestBody, }: {
         projectId: string;
         documentId: string;
+        requestBody?: DocumentEdit;
+    }): CancelablePromise<Document>;
+    /**
+     * @returns Document OK
+     * @throws ApiError
+     */
+    static postProjectsDocumentsComplete({ projectId, documentId, finalize, }: {
+        projectId: string;
+        documentId: string;
+        finalize?: boolean;
     }): CancelablePromise<Document>;
     /**
      * Detach a document from one event — supply exactly one of `operationId`/`accrualId`.
@@ -58,8 +80,19 @@ export declare class ProjectDocumentsService {
         operationId?: string;
         accrualId?: string;
     }): CancelablePromise<any>;
+    /**
+     * The live events (operations/accruals) this document is linked to, with their names — for showing and
+     * navigating to a document's attachments. Trashed events are excluded.
+     * @returns DocumentLinkTarget OK
+     * @throws ApiError
+     */
+    static getProjectsDocumentsLinks({ projectId, documentId, }: {
+        projectId: string;
+        documentId: string;
+    }): CancelablePromise<Array<DocumentLinkTarget>>;
     /**
      * Attach a document to an event (many-to-many) — the body sets exactly one of the two event ids.
+     * Rejected (409) on a template-created event: its documents are managed through the template's documents input.
      * @returns any OK
      * @throws ApiError
      */

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

@@ -2,11 +2,14 @@ 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
+     * List documents. With `operationId` OR `accrualId`: the documents attached to that event (returned as a
+     * single page). With neither: the whole project documents library, paginated and optionally filtered by a filename
+     * `query` (each item carries its `linkedEventCount`). Sorted by file name (`orderByName`) when set;
+     * otherwise by date added (`orderByDateAdded`, newest first by default). Supplying both event ids is a 400.
+     * @returns DocumentPaginatedList OK
      * @throws ApiError
      */
-    static getProjectsDocuments({ projectId, operationId, accrualId, }) {
+    static getProjectsDocuments({ projectId, operationId, accrualId, query, orderByName, orderByDateAdded, limit = 50, next, }) {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/projects/{projectId}/documents',
@@ -16,6 +19,11 @@ export class ProjectDocumentsService {
             query: {
                 'operationId': operationId,
                 'accrualId': accrualId,
+                'query': query,
+                'orderByName': orderByName,
+                'orderByDateAdded': orderByDateAdded,
+                'limit': limit,
+                'next': next,
             },
         });
     }
@@ -63,11 +71,28 @@ export class ProjectDocumentsService {
             },
         });
     }
+    /**
+     * Edit a document's metadata (currently just its display file name).
+     * @returns Document OK
+     * @throws ApiError
+     */
+    static patchProjectsDocuments({ projectId, documentId, requestBody, }) {
+        return __request(OpenAPI, {
+            method: 'PATCH',
+            url: '/projects/{projectId}/documents/{documentId}',
+            path: {
+                'projectId': projectId,
+                'documentId': documentId,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
     /**
      * @returns Document OK
      * @throws ApiError
      */
-    static postProjectsDocumentsComplete({ projectId, documentId, }) {
+    static postProjectsDocumentsComplete({ projectId, documentId, finalize, }) {
         return __request(OpenAPI, {
             method: 'POST',
             url: '/projects/{projectId}/documents/{documentId}/complete',
@@ -75,6 +100,9 @@ export class ProjectDocumentsService {
                 'projectId': projectId,
                 'documentId': documentId,
             },
+            query: {
+                'finalize': finalize,
+            },
         });
     }
     /**
@@ -96,8 +124,25 @@ export class ProjectDocumentsService {
             },
         });
     }
+    /**
+     * The live events (operations/accruals) this document is linked to, with their names — for showing and
+     * navigating to a document's attachments. Trashed events are excluded.
+     * @returns DocumentLinkTarget OK
+     * @throws ApiError
+     */
+    static getProjectsDocumentsLinks({ projectId, documentId, }) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/projects/{projectId}/documents/{documentId}/links',
+            path: {
+                'projectId': projectId,
+                'documentId': documentId,
+            },
+        });
+    }
     /**
      * Attach a document to an event (many-to-many) — the body sets exactly one of the two event ids.
+     * Rejected (409) on a template-created event: its documents are managed through the template's documents input.
      * @returns any OK
      * @throws ApiError
      */

package/meta.json

@@ -1,11 +1,11 @@
 {
-  "sdkVersion": "0.6.1-beta.2501",
-  "generatedAt": "2026-07-16T21:50:08.266Z",
-  "apiCommit": "1bd63c91",
-  "pipelineUrl": "https://gitlab.com/incomy/platform/-/pipelines/2683078023",
+  "sdkVersion": "0.6.1-beta.2566",
+  "generatedAt": "2026-07-23T22:33:03.369Z",
+  "apiCommit": "75e19710",
+  "pipelineUrl": "https://gitlab.com/incomy/platform/-/pipelines/2701666425",
   "sources": {
     "hub": {
-      "sha256": "c6182e4e8a190a63fe6f9427235c7b7704cd7fbbe28950285685a571dd0a018c"
+      "sha256": "cb2bd93078ce929375c991f45fd9fc8b24d88e3515aaa88dc2447c78262f7893"
     }
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@incomy/platform-sdk",
-  "version": "0.6.1-beta.2501",
+  "version": "0.6.1-beta.2566",
   "private": false,
   "type": "module",
   "files": [