@openfilz-sdk/typescript-ee 1.14.6 → 1.14.8

package/dist/models/access-request-input.d.ts

@@ -0,0 +1,31 @@
+/**
+ * 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 declare const AccessRequestInputShareModeEnum: {
+    readonly Reader: "READER";
+    readonly Commenter: "COMMENTER";
+    readonly Editor: "EDITOR";
+};
+export type AccessRequestInputShareModeEnum = typeof AccessRequestInputShareModeEnum[keyof typeof AccessRequestInputShareModeEnum];

package/dist/models/access-request-input.js

@@ -0,0 +1,21 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AccessRequestInputShareModeEnum = void 0;
+exports.AccessRequestInputShareModeEnum = {
+    Reader: 'READER',
+    Commenter: 'COMMENTER',
+    Editor: 'EDITOR',
+};

package/dist/models/access-request-status.d.ts

@@ -0,0 +1,36 @@
+/**
+ * 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 declare const AccessRequestStatusStateEnum: {
+    readonly HasAccess: "HAS_ACCESS";
+    readonly NoAccess: "NO_ACCESS";
+    readonly Pending: "PENDING";
+    readonly OwnerCannotShare: "OWNER_CANNOT_SHARE";
+};
+export type AccessRequestStatusStateEnum = typeof AccessRequestStatusStateEnum[keyof typeof AccessRequestStatusStateEnum];
+export declare const AccessRequestStatusRequestedModeEnum: {
+    readonly Reader: "READER";
+    readonly Commenter: "COMMENTER";
+    readonly Editor: "EDITOR";
+};
+export type AccessRequestStatusRequestedModeEnum = typeof AccessRequestStatusRequestedModeEnum[keyof typeof AccessRequestStatusRequestedModeEnum];

package/dist/models/access-request-status.js

@@ -0,0 +1,27 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AccessRequestStatusRequestedModeEnum = exports.AccessRequestStatusStateEnum = void 0;
+exports.AccessRequestStatusStateEnum = {
+    HasAccess: 'HAS_ACCESS',
+    NoAccess: 'NO_ACCESS',
+    Pending: 'PENDING',
+    OwnerCannotShare: 'OWNER_CANNOT_SHARE',
+};
+exports.AccessRequestStatusRequestedModeEnum = {
+    Reader: 'READER',
+    Commenter: 'COMMENTER',
+    Editor: 'EDITOR',
+};

package/dist/models/enriched-audit-log.d.ts

@@ -69,6 +69,7 @@ export declare const EnrichedAuditLogActionEnum: {
     readonly ShareDocumentCreate: "SHARE_DOCUMENT_CREATE";
     readonly ShareDocumentUpdate: "SHARE_DOCUMENT_UPDATE";
     readonly ShareDocumentDelete: "SHARE_DOCUMENT_DELETE";
+    readonly ShareDocumentExpire: "SHARE_DOCUMENT_EXPIRE";
     readonly ShareInheritanceChanged: "SHARE_INHERITANCE_CHANGED";
     readonly TeamCreated: "TEAM_CREATED";
     readonly TeamUpdated: "TEAM_UPDATED";

package/dist/models/enriched-audit-log.js

@@ -58,6 +58,7 @@ exports.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/dist/models/index.d.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';
@@ -109,6 +111,9 @@ export * from './list-ai-models-request';
 export * from './mcp-agent-token-config';
 export * from './mcp-agent-token-info';
 export * from './mcp-agent-token-response';
+export * from './mention-access-item';
+export * from './mention-access-preview';
+export * from './mention-access-request';
 export * from './merge-request';
 export * from './merge-source';
 export * from './metadata-key-suggestion';
@@ -173,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/dist/models/index.js

@@ -14,6 +14,8 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./access-request-input"), exports);
+__exportStar(require("./access-request-status"), exports);
 __exportStar(require("./add-team-owner-request"), exports);
 __exportStar(require("./ai-analytics-view"), exports);
 __exportStar(require("./ai-chat-conversation"), exports);
@@ -125,6 +127,9 @@ __exportStar(require("./list-ai-models-request"), exports);
 __exportStar(require("./mcp-agent-token-config"), exports);
 __exportStar(require("./mcp-agent-token-info"), exports);
 __exportStar(require("./mcp-agent-token-response"), exports);
+__exportStar(require("./mention-access-item"), exports);
+__exportStar(require("./mention-access-preview"), exports);
+__exportStar(require("./mention-access-request"), exports);
 __exportStar(require("./merge-request"), exports);
 __exportStar(require("./merge-source"), exports);
 __exportStar(require("./metadata-key-suggestion"), exports);
@@ -189,6 +194,7 @@ __exportStar(require("./search-by-metadata-request"), exports);
 __exportStar(require("./search-metadata-request"), exports);
 __exportStar(require("./setting-dto"), exports);
 __exportStar(require("./settings"), exports);
+__exportStar(require("./share-expiry-request"), exports);
 __exportStar(require("./share-inheritance"), exports);
 __exportStar(require("./share-inheritance-request"), exports);
 __exportStar(require("./share-request"), exports);

package/dist/models/mention-access-item.d.ts

@@ -0,0 +1,29 @@
+/**
+ * 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 MentionAccessItem {
+    'docId'?: string;
+    'docName'?: string;
+    'userId'?: string;
+    'userName'?: string;
+    'userEmail'?: string;
+    'canRead'?: boolean;
+    'action'?: MentionAccessItemActionEnum;
+}
+export declare const MentionAccessItemActionEnum: {
+    readonly Share: "SHARE";
+    readonly Upgrade: "UPGRADE";
+    readonly RequestShare: "REQUEST_SHARE";
+    readonly RequestUpgrade: "REQUEST_UPGRADE";
+    readonly NotLicensed: "NOT_LICENSED";
+    readonly NotAllowed: "NOT_ALLOWED";
+};
+export type MentionAccessItemActionEnum = typeof MentionAccessItemActionEnum[keyof typeof MentionAccessItemActionEnum];

package/dist/models/mention-access-item.js

@@ -0,0 +1,24 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MentionAccessItemActionEnum = void 0;
+exports.MentionAccessItemActionEnum = {
+    Share: 'SHARE',
+    Upgrade: 'UPGRADE',
+    RequestShare: 'REQUEST_SHARE',
+    RequestUpgrade: 'REQUEST_UPGRADE',
+    NotLicensed: 'NOT_LICENSED',
+    NotAllowed: 'NOT_ALLOWED',
+};

package/dist/models/mention-access-preview.d.ts

@@ -0,0 +1,15 @@
+/**
+ * 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.
+ */
+import type { MentionAccessItem } from './mention-access-item';
+export interface MentionAccessPreview {
+    'items'?: Array<MentionAccessItem>;
+}

package/dist/models/mention-access-preview.js

@@ -0,0 +1,15 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/mention-access-request.d.ts

@@ -0,0 +1,21 @@
+/**
+ * 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 MentionAccessRequest {
+    /**
+     * Document IDs the comment is saved on (at most 200)
+     */
+    'docIds': Set<string>;
+    /**
+     * User IDs mentioned in the comment (at most 100)
+     */
+    'mentionedUserIds': Set<string>;
+}

package/dist/models/mention-access-request.js

@@ -0,0 +1,15 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/notification-dto.d.ts

@@ -45,5 +45,8 @@ export declare const NotificationDTOTypeEnum: {
     readonly TeamInvitationDeclined: "TEAM_INVITATION_DECLINED";
     readonly TeamMemberAdded: "TEAM_MEMBER_ADDED";
     readonly TeamMemberRemoved: "TEAM_MEMBER_REMOVED";
+    readonly AccessRequestDeclined: "ACCESS_REQUEST_DECLINED";
+    readonly ShareExpiring: "SHARE_EXPIRING";
+    readonly ShareExpired: "SHARE_EXPIRED";
 };
 export type NotificationDTOTypeEnum = typeof NotificationDTOTypeEnum[keyof typeof NotificationDTOTypeEnum];

package/dist/models/notification-dto.js

@@ -39,4 +39,7 @@ exports.NotificationDTOTypeEnum = {
     TeamInvitationDeclined: 'TEAM_INVITATION_DECLINED',
     TeamMemberAdded: 'TEAM_MEMBER_ADDED',
     TeamMemberRemoved: 'TEAM_MEMBER_REMOVED',
+    AccessRequestDeclined: 'ACCESS_REQUEST_DECLINED',
+    ShareExpiring: 'SHARE_EXPIRING',
+    ShareExpired: 'SHARE_EXPIRED',
 };

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

@@ -85,6 +85,7 @@ export declare const SearchByAuditLogRequestActionEnum: {
     readonly ShareDocumentCreate: "SHARE_DOCUMENT_CREATE";
     readonly ShareDocumentUpdate: "SHARE_DOCUMENT_UPDATE";
     readonly ShareDocumentDelete: "SHARE_DOCUMENT_DELETE";
+    readonly ShareDocumentExpire: "SHARE_DOCUMENT_EXPIRE";
     readonly ShareInheritanceChanged: "SHARE_INHERITANCE_CHANGED";
     readonly TeamCreated: "TEAM_CREATED";
     readonly TeamUpdated: "TEAM_UPDATED";

package/dist/models/search-by-audit-log-request.js

@@ -62,6 +62,7 @@ exports.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/dist/models/share-expiry-request.d.ts

@@ -0,0 +1,25 @@
+/**
+ * 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/dist/models/share-expiry-request.js

@@ -0,0 +1,15 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/share-request.d.ts

@@ -30,6 +30,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 declare const ShareRequestShareModeEnum: {
     readonly Reader: "READER";

package/dist/models/share-result-error.d.ts

@@ -22,6 +22,9 @@ export declare const ShareResultErrorCodeEnum: {
     readonly ShareErrNotAlreadyShared: "SHARE_ERR_NOT_ALREADY_SHARED";
     readonly ShareErrOwner: "SHARE_ERR_OWNER";
     readonly ShareErrNotScanned: "SHARE_ERR_NOT_SCANNED";
+    readonly ShareErrDocumentNotFound: "SHARE_ERR_DOCUMENT_NOT_FOUND";
+    readonly ShareErrInheritedShare: "SHARE_ERR_INHERITED_SHARE";
+    readonly ShareErrOwnerOnly: "SHARE_ERR_OWNER_ONLY";
     readonly ShareErrRecipientNotLicensedPolicy: "SHARE_ERR_RECIPIENT_NOT_LICENSED_POLICY";
     readonly ShareErrRecipientDomainPolicy: "SHARE_ERR_RECIPIENT_DOMAIN_POLICY";
     readonly ShareErrTeamHasExternalMember: "SHARE_ERR_TEAM_HAS_EXTERNAL_MEMBER";

package/dist/models/share-result-error.js

@@ -22,6 +22,9 @@ exports.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/dist/models/violation.d.ts

@@ -31,6 +31,9 @@ export declare const ViolationReasonEnum: {
     readonly ShareErrNotAlreadyShared: "SHARE_ERR_NOT_ALREADY_SHARED";
     readonly ShareErrOwner: "SHARE_ERR_OWNER";
     readonly ShareErrNotScanned: "SHARE_ERR_NOT_SCANNED";
+    readonly ShareErrDocumentNotFound: "SHARE_ERR_DOCUMENT_NOT_FOUND";
+    readonly ShareErrInheritedShare: "SHARE_ERR_INHERITED_SHARE";
+    readonly ShareErrOwnerOnly: "SHARE_ERR_OWNER_ONLY";
     readonly ShareErrRecipientNotLicensedPolicy: "SHARE_ERR_RECIPIENT_NOT_LICENSED_POLICY";
     readonly ShareErrRecipientDomainPolicy: "SHARE_ERR_RECIPIENT_DOMAIN_POLICY";
     readonly ShareErrTeamHasExternalMember: "SHARE_ERR_TEAM_HAS_EXTERNAL_MEMBER";

package/dist/models/violation.js

@@ -22,6 +22,9 @@ exports.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/docs/AccessRequestInput.md

@@ -0,0 +1,24 @@
+# AccessRequestInput
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**documentId** | **string** | The document (file or folder) the caller asks access to | [default to undefined]
+**shareMode** | **string** | The access asked for; READER when absent | [optional] [default to undefined]
+**message** | **string** | Optional note to the owner | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AccessRequestInput } from '@openfilz-sdk/typescript-ee';
+
+const instance: AccessRequestInput = {
+    documentId,
+    shareMode,
+    message,
+};
+```
+
+[[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/AccessRequestStatus.md

@@ -0,0 +1,26 @@
+# AccessRequestStatus
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**documentId** | **string** |  | [optional] [default to undefined]
+**state** | **string** |  | [optional] [default to undefined]
+**requestedMode** | **string** | PENDING: the access asked for | [optional] [default to undefined]
+**requestedAt** | **string** | PENDING: when the owner was last asked | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AccessRequestStatus } from '@openfilz-sdk/typescript-ee';
+
+const instance: AccessRequestStatus = {
+    documentId,
+    state,
+    requestedMode,
+    requestedAt,
+};
+```
+
+[[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/AccessRequestsApi.md

@@ -0,0 +1,112 @@
+# AccessRequestsApi
+
+All URIs are relative to *http://localhost:8081*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**myAccessToDocument**](#myaccesstodocument) | **GET** /api/v1/users/me/access-requests/{documentId} | Can I open this document, or ask for it?|
+|[**requestAccess**](#requestaccess) | **POST** /api/v1/users/me/access-requests | Ask the owner for access|
+
+# **myAccessToDocument**
+> AccessRequestStatus myAccessToDocument()
+
+HAS_ACCESS, PENDING (asked, not answered), NO_ACCESS, or OWNER_CANNOT_SHARE (the owner may not share documents, so a request would reach nobody). 404 when the document does not exist or is in the recycle bin; never returns its name or owner. 429 past the hourly limit.
+
+### Example
+
+```typescript
+import {
+    AccessRequestsApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new AccessRequestsApi(configuration);
+
+let documentId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.myAccessToDocument(
+    documentId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **documentId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**AccessRequestStatus**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+
+[[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)
+
+# **requestAccess**
+> AccessRequestStatus requestAccess(accessRequestInput)
+
+Creates a share request to the owner, who answers it on Share requests (bell + e-mail). Asking again for the same access within a day does not notify the owner again. 404 no such document; 409 ACCESS_ALREADY_GRANTED, OWNER_CANNOT_SHARE, or a SHARE_ERR_* code when the owner could not grant it (licence for the mode, sharing policy); 429 ACCESS_REQUEST_RATE_LIMITED.
+
+### Example
+
+```typescript
+import {
+    AccessRequestsApi,
+    Configuration,
+    AccessRequestInput
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new AccessRequestsApi(configuration);
+
+let accessRequestInput: AccessRequestInput; //
+
+const { status, data } = await apiInstance.requestAccess(
+    accessRequestInput
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **accessRequestInput** | **AccessRequestInput**|  | |
+
+
+### Return type
+
+**AccessRequestStatus**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+
+[[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)
+