@openfilz-sdk/typescript-ee 1.14.7 → 1.14.8

package/docs/CollaborationControllerApi.md

@@ -16,6 +16,7 @@ All URIs are relative to *http://localhost:8081*
 |[**getUserStatus**](#getuserstatus) | **GET** /api/v1/users/me/status | Check user status|
 |[**rejectShareRequest**](#rejectsharerequest) | **DELETE** /api/v1/users/share-requests/{id} | Reject a share request|
 |[**removeTeamMembers**](#removeteammembers) | **DELETE** /api/v1/users/teams/{teamId}/members | Remove team members|
+|[**updateShareExpiry**](#updateshareexpiry) | **PUT** /api/v1/users/share/expiry | Set, change or remove the end date of share(s)|
 |[**updateSharedDocuments**](#updateshareddocuments) | **PUT** /api/v1/users/share | Update Share for document(s)|
 |[**updateTeam**](#updateteam) | **PUT** /api/v1/users/teams/{teamId} | Update a team|
 |[**updateUser**](#updateuser) | **PUT** /api/v1/users/{userId} | Update a user|
@@ -128,7 +129,7 @@ void (empty response body)
 # **createSharedDocuments**
 > ShareResultResponse createSharedDocuments(shareRequest)
 
-Creates new Shared document(s) with users. Returns 200 when all items are processed successfully. Returns 207 when there is a mix of successes, share requests, and/or errors.  Error codes in response: - SHARE_ERR_USER_DEACTIVATED: Cannot share with a deactivated user in read-only mode - SHARE_ERR_USER_NOT_LICENSED: User must have a license to be shared with in editor or commenter mode - SHARE_ERR_PARENT_AND_CHILD: A folder and its children cannot both be in the share list - SHARE_ERR_ALREADY_EXISTS: A share already exists for this document and user 
+Creates new Shared document(s) with users. Returns 200 when all items are processed successfully. Returns 207 when there is a mix of successes, share requests, and/or errors.  Error codes in response: - SHARE_ERR_USER_DEACTIVATED: Cannot share with a deactivated user in read-only mode - SHARE_ERR_USER_NOT_LICENSED: User must have a license to be shared with in editor or commenter mode - SHARE_ERR_PARENT_AND_CHILD: A folder and its children cannot both be in the share list - SHARE_ERR_ALREADY_EXISTS: A share already exists for this document and user  Optional `expiresAt` (ISO-8601 instant): the recipients lose access on that date. A date that is not in the future is refused with 400. 
 
 ### Example
 
@@ -175,6 +176,7 @@ const { status, data } = await apiInstance.createSharedDocuments(
 |-------------|-------------|------------------|
 |**200** | All shares created successfully |  -  |
 |**207** | Partial success: some shares created, some sent as requests, some failed |  -  |
+|**400** | expiresAt is not in the future |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
@@ -637,6 +639,60 @@ void (empty response body)
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
+# **updateShareExpiry**
+> ShareResultResponse updateShareExpiry(shareExpiryRequest)
+
+Sets the end of access of existing shares, `expiresAt: null` = no end. Only on shares granted on the documents themselves, by their owner (or a SHARE_ADMIN). Returns 200 when all items are processed successfully, 207 otherwise.  Error codes in response: - SHARE_ERR_NOT_ALREADY_SHARED: No existing share found for this document and user - SHARE_ERR_INHERITED_SHARE: The share comes from a folder: change the date on the folder - SHARE_ERR_OWNER_ONLY: Only the document\'s owner changes the end date - SHARE_ERR_DOCUMENT_NOT_FOUND: The caller cannot see this document 
+
+### Example
+
+```typescript
+import {
+    CollaborationControllerApi,
+    Configuration,
+    ShareExpiryRequest
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new CollaborationControllerApi(configuration);
+
+let shareExpiryRequest: ShareExpiryRequest; //
+
+const { status, data } = await apiInstance.updateShareExpiry(
+    shareExpiryRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **shareExpiryRequest** | **ShareExpiryRequest**|  | |
+
+
+### Return type
+
+**ShareResultResponse**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | All end dates changed |  -  |
+|**207** | Partial success: some items failed |  -  |
+|**400** | expiresAt is not in the future |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
 # **updateSharedDocuments**
 > ShareResultResponse updateSharedDocuments(shareRequest)
 

package/docs/ShareExpiryRequest.md

@@ -0,0 +1,24 @@
+# ShareExpiryRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**documentIds** | **Set<string>** | Shared documents | [default to undefined]
+**userIds** | **Set<string>** | Recipients (users or teams) | [default to undefined]
+**expiresAt** | **string** | New end of access (ISO-8601 instant), null = no end. A date in the past is refused (400). | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ShareExpiryRequest } from '@openfilz-sdk/typescript-ee';
+
+const instance: ShareExpiryRequest = {
+    documentIds,
+    userIds,
+    expiresAt,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ShareRequest.md

@@ -10,6 +10,7 @@ Name | Type | Description | Notes
 **userIds** | **Set<string>** | User IDs to share with | [default to undefined]
 **message** | **string** | Optional message to include in the share notification | [optional] [default to undefined]
 **notify** | **boolean** | false = create the shares silently: no invitation e-mail and no bell notification to the recipients (bulk imports — a migration re-creating a source system\'s permissions must not mail thousands of invitations). Absent or true = notify. Share requests addressed to a document\'s owner are always notified. | [optional] [default to undefined]
+**expiresAt** | **string** | Optional end of access (ISO-8601 instant): on that date the recipients lose access and the owner is told. Absent = no end. A date in the past is refused (400). On a document the caller does not own, it travels with the share request and applies once the owner accepts. | [optional] [default to undefined]
 
 ## Example
 
@@ -22,6 +23,7 @@ const instance: ShareRequest = {
     userIds,
     message,
     notify,
+    expiresAt,
 };
 ```
 

package/graphql/share.graphqls

@@ -1,13 +1,28 @@
 extend type Query {
     listOwned(request: ListFolderRequest!): [FolderElementInfo]
     countOwned(request: ListFolderRequest): Long
-    listSharedWithMe(request: ListFolderRequest!): [FolderElementInfo]
-    countSharedWithMe(request: ListFolderRequest): Long
+    "Root shares reaching the caller (directly or through a team), or the content of a shared folder (request id)"
+    listSharedWithMe(request: ListFolderRequest!,
+        """
+        Keep the items reaching the caller through one of these grantees: the caller's own id (direct shares)
+        and/or ids of teams the caller belongs to. Absent or empty = every share. Any other id is refused.
+        Applies to the root listing (no request id).
+        """
+        sharedThrough: [UUID!]): [FolderElementInfo]
+    countSharedWithMe(request: ListFolderRequest,
+        """
+        Keep the items reaching the caller through one of these grantees: the caller's own id (direct shares)
+        and/or ids of teams the caller belongs to. Absent or empty = every share. Any other id is refused.
+        Applies to the root listing (no request id).
+        """
+        sharedThrough: [UUID!]): Long
     listSharedByMe(request: ListFolderRequest!, sharedWithUserId: UUID): [FolderElementInfo]
     countSharedByMe(request: ListFolderRequest, sharedWithUserId: UUID): Long
     listDocShares(docId: UUID!): [SharedWith]
     "Lists the teams the connected user belongs to"
     listMyTeams: [TeamInfo!]!
+    "The connected user's own id: the grantee id of their direct shares (listSharedWithMe sharedThrough)"
+    myUserId: UUID!
     """
     Lists all users in the connected user's organization.
     Access restricted to LICENSED users only.
@@ -46,6 +61,11 @@ extend type DocumentInfo {
 }
 
 extend type FolderElementInfo {
+    """
+    End of access: on a document the caller owns, the earliest end date among its shares; on a document shared
+    with the caller, the end of their own share (direct or through a team). Null = no end.
+    """
+    shareExpiresAt : DateTime
     "Whether this document is shared with the current user in editor mode"
     sharedEdit : Boolean
     "Whether this document is shared with the current user in commenter mode"
@@ -54,6 +74,12 @@ extend type FolderElementInfo {
     rootShare : Boolean
     "The team ID through which this document is shared with the current user, null if shared directly"
     sharedTeamId : UUID
+    """
+    Every grantee this item reaches the caller through: the caller's own id (direct share) first, then the ids of
+    the caller's teams holding a share on it. Null when no share reaches the caller (e.g. an item they own).
+    Resolved per page from the rows' ids: select `id` with it.
+    """
+    sharedThrough : [UUID!]
 }
 
 type SharedWith {
@@ -63,6 +89,10 @@ type SharedWith {
     status: UserStatusEnum
     rootOwner: Boolean
     type: UserTypeEnum
+    "The share was granted on this document itself, not inherited from a folder: only these carry an end date"
+    root: Boolean
+    "End of access, null = no end (set on root shares only)"
+    expiresAt: DateTime
 }
 
 enum ShareMode {
@@ -150,6 +180,17 @@ type ShareRequestInfo {
     sharedUserEmail: String
     shareMode: ShareMode!
     createdAt: DateTime!
+    "ACCESS = the requester asks for access for themself (requester = recipient)"
+    requestType: ShareRequestType!
+    "The requester's note to the owner (ACCESS requests)"
+    message: String
+}
+
+"""
+What a share request asks for
+"""
+enum ShareRequestType {
+    CREATE, UPDATE, DELETE, ACCESS
 }
 
 """

package/models/access-request-input.ts

@@ -0,0 +1,40 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+export interface AccessRequestInput {
+    /**
+     * The document (file or folder) the caller asks access to
+     */
+    'documentId': string;
+    /**
+     * The access asked for; READER when absent
+     */
+    'shareMode'?: AccessRequestInputShareModeEnum;
+    /**
+     * Optional note to the owner
+     */
+    'message'?: string;
+}
+
+export const AccessRequestInputShareModeEnum = {
+    Reader: 'READER',
+    Commenter: 'COMMENTER',
+    Editor: 'EDITOR',
+} as const;
+
+export type AccessRequestInputShareModeEnum = typeof AccessRequestInputShareModeEnum[keyof typeof AccessRequestInputShareModeEnum];
+
+

package/models/access-request-status.ts

@@ -0,0 +1,46 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+export interface AccessRequestStatus {
+    'documentId'?: string;
+    'state'?: AccessRequestStatusStateEnum;
+    /**
+     * PENDING: the access asked for
+     */
+    'requestedMode'?: AccessRequestStatusRequestedModeEnum;
+    /**
+     * PENDING: when the owner was last asked
+     */
+    'requestedAt'?: string;
+}
+
+export const AccessRequestStatusStateEnum = {
+    HasAccess: 'HAS_ACCESS',
+    NoAccess: 'NO_ACCESS',
+    Pending: 'PENDING',
+    OwnerCannotShare: 'OWNER_CANNOT_SHARE',
+} as const;
+
+export type AccessRequestStatusStateEnum = typeof AccessRequestStatusStateEnum[keyof typeof AccessRequestStatusStateEnum];
+export const AccessRequestStatusRequestedModeEnum = {
+    Reader: 'READER',
+    Commenter: 'COMMENTER',
+    Editor: 'EDITOR',
+} as const;
+
+export type AccessRequestStatusRequestedModeEnum = typeof AccessRequestStatusRequestedModeEnum[keyof typeof AccessRequestStatusRequestedModeEnum];
+
+

package/models/enriched-audit-log.ts

@@ -77,6 +77,7 @@ export const EnrichedAuditLogActionEnum = {
     ShareDocumentCreate: 'SHARE_DOCUMENT_CREATE',
     ShareDocumentUpdate: 'SHARE_DOCUMENT_UPDATE',
     ShareDocumentDelete: 'SHARE_DOCUMENT_DELETE',
+    ShareDocumentExpire: 'SHARE_DOCUMENT_EXPIRE',
     ShareInheritanceChanged: 'SHARE_INHERITANCE_CHANGED',
     TeamCreated: 'TEAM_CREATED',
     TeamUpdated: 'TEAM_UPDATED',

package/models/index.ts

@@ -1,3 +1,5 @@
+export * from './access-request-input';
+export * from './access-request-status';
 export * from './add-team-owner-request';
 export * from './ai-analytics-view';
 export * from './ai-chat-conversation';
@@ -176,6 +178,7 @@ export * from './search-by-metadata-request';
 export * from './search-metadata-request';
 export * from './setting-dto';
 export * from './settings';
+export * from './share-expiry-request';
 export * from './share-inheritance';
 export * from './share-inheritance-request';
 export * from './share-request';

package/models/notification-dto.ts

@@ -51,6 +51,9 @@ export const NotificationDTOTypeEnum = {
     TeamInvitationDeclined: 'TEAM_INVITATION_DECLINED',
     TeamMemberAdded: 'TEAM_MEMBER_ADDED',
     TeamMemberRemoved: 'TEAM_MEMBER_REMOVED',
+    AccessRequestDeclined: 'ACCESS_REQUEST_DECLINED',
+    ShareExpiring: 'SHARE_EXPIRING',
+    ShareExpired: 'SHARE_EXPIRED',
 } as const;
 
 export type NotificationDTOTypeEnum = typeof NotificationDTOTypeEnum[keyof typeof NotificationDTOTypeEnum];

package/models/search-by-audit-log-request.ts

@@ -90,6 +90,7 @@ export const SearchByAuditLogRequestActionEnum = {
     ShareDocumentCreate: 'SHARE_DOCUMENT_CREATE',
     ShareDocumentUpdate: 'SHARE_DOCUMENT_UPDATE',
     ShareDocumentDelete: 'SHARE_DOCUMENT_DELETE',
+    ShareDocumentExpire: 'SHARE_DOCUMENT_EXPIRE',
     ShareInheritanceChanged: 'SHARE_INHERITANCE_CHANGED',
     TeamCreated: 'TEAM_CREATED',
     TeamUpdated: 'TEAM_UPDATED',

package/models/share-expiry-request.ts

@@ -0,0 +1,31 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+export interface ShareExpiryRequest {
+    /**
+     * Shared documents
+     */
+    'documentIds': Set<string>;
+    /**
+     * Recipients (users or teams)
+     */
+    'userIds': Set<string>;
+    /**
+     * New end of access (ISO-8601 instant), null = no end. A date in the past is refused (400).
+     */
+    'expiresAt'?: string;
+}
+

package/models/share-request.ts

@@ -35,6 +35,10 @@ export interface ShareRequest {
      * false = create the shares silently: no invitation e-mail and no bell notification to the recipients (bulk imports — a migration re-creating a source system\'s permissions must not mail thousands of invitations). Absent or true = notify. Share requests addressed to a document\'s owner are always notified.
      */
     'notify'?: boolean;
+    /**
+     * Optional end of access (ISO-8601 instant): on that date the recipients lose access and the owner is told. Absent = no end. A date in the past is refused (400). On a document the caller does not own, it travels with the share request and applies once the owner accepts.
+     */
+    'expiresAt'?: string;
 }
 
 export const ShareRequestShareModeEnum = {

package/models/share-result-error.ts

@@ -28,6 +28,9 @@ export const ShareResultErrorCodeEnum = {
     ShareErrNotAlreadyShared: 'SHARE_ERR_NOT_ALREADY_SHARED',
     ShareErrOwner: 'SHARE_ERR_OWNER',
     ShareErrNotScanned: 'SHARE_ERR_NOT_SCANNED',
+    ShareErrDocumentNotFound: 'SHARE_ERR_DOCUMENT_NOT_FOUND',
+    ShareErrInheritedShare: 'SHARE_ERR_INHERITED_SHARE',
+    ShareErrOwnerOnly: 'SHARE_ERR_OWNER_ONLY',
     ShareErrRecipientNotLicensedPolicy: 'SHARE_ERR_RECIPIENT_NOT_LICENSED_POLICY',
     ShareErrRecipientDomainPolicy: 'SHARE_ERR_RECIPIENT_DOMAIN_POLICY',
     ShareErrTeamHasExternalMember: 'SHARE_ERR_TEAM_HAS_EXTERNAL_MEMBER',

package/models/violation.ts

@@ -37,6 +37,9 @@ export const ViolationReasonEnum = {
     ShareErrNotAlreadyShared: 'SHARE_ERR_NOT_ALREADY_SHARED',
     ShareErrOwner: 'SHARE_ERR_OWNER',
     ShareErrNotScanned: 'SHARE_ERR_NOT_SCANNED',
+    ShareErrDocumentNotFound: 'SHARE_ERR_DOCUMENT_NOT_FOUND',
+    ShareErrInheritedShare: 'SHARE_ERR_INHERITED_SHARE',
+    ShareErrOwnerOnly: 'SHARE_ERR_OWNER_ONLY',
     ShareErrRecipientNotLicensedPolicy: 'SHARE_ERR_RECIPIENT_NOT_LICENSED_POLICY',
     ShareErrRecipientDomainPolicy: 'SHARE_ERR_RECIPIENT_DOMAIN_POLICY',
     ShareErrTeamHasExternalMember: 'SHARE_ERR_TEAM_HAS_EXTERNAL_MEMBER',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfilz-sdk/typescript-ee",
-  "version": "1.14.7",
+  "version": "1.14.8",
   "description": "OpenAPI client for @openfilz-sdk/typescript-ee",
   "author": "OpenAPI-Generator Contributors",
   "repository": {