@openfilz-sdk/typescript-ee 1.13.4 → 1.14.1

package/docs/TeamAdministrationApi.md

@@ -0,0 +1,62 @@
+# TeamAdministrationApi
+
+All URIs are relative to *http://localhost:8081*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**adminAddTeamMembers**](#adminaddteammembers) | **POST** /api/v1/admin/teams/{teamId}/members | Add members to a team|
+
+# **adminAddTeamMembers**
+> adminAddTeamMembers(requestBody)
+
+Idempotent for existing members. 409 TEAM_MEMBER_EXTERNAL (counts of members, owners and documents) when documents shared with the team may not be shared with a new member under the sharing policy.
+
+### Example
+
+```typescript
+import {
+    TeamAdministrationApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new TeamAdministrationApi(configuration);
+
+let teamId: string; // (default to undefined)
+let requestBody: Array<string>; //
+
+const { status, data } = await apiInstance.adminAddTeamMembers(
+    teamId,
+    requestBody
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **requestBody** | **Array<string>**|  | |
+| **teamId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: Not defined
+
+
+### 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)
+

package/docs/Violation.md

@@ -0,0 +1,42 @@
+# Violation
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**documentId** | **string** |  | [optional] [default to undefined]
+**documentName** | **string** |  | [optional] [default to undefined]
+**documentType** | **string** |  | [optional] [default to undefined]
+**masked** | **boolean** |  | [optional] [default to undefined]
+**ownerId** | **string** |  | [optional] [default to undefined]
+**ownerEmail** | **string** |  | [optional] [default to undefined]
+**recipientId** | **string** |  | [optional] [default to undefined]
+**recipientType** | **string** |  | [optional] [default to undefined]
+**recipientEmail** | **string** |  | [optional] [default to undefined]
+**inherited** | **boolean** |  | [optional] [default to undefined]
+**externalMembers** | **number** |  | [optional] [default to undefined]
+**reason** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Violation } from '@openfilz-sdk/typescript-ee';
+
+const instance: Violation = {
+    documentId,
+    documentName,
+    documentType,
+    masked,
+    ownerId,
+    ownerEmail,
+    recipientId,
+    recipientType,
+    recipientEmail,
+    inherited,
+    externalMembers,
+    reason,
+};
+```
+
+[[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/ViolationsResponse.md

@@ -0,0 +1,24 @@
+# ViolationsResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**items** | [**Array<Violation>**](Violation.md) |  | [optional] [default to undefined]
+**nextCursor** | **string** |  | [optional] [default to undefined]
+**count** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ViolationsResponse } from '@openfilz-sdk/typescript-ee';
+
+const instance: ViolationsResponse = {
+    items,
+    nextCursor,
+    count,
+};
+```
+
+[[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/graphql/document.graphqls

@@ -69,7 +69,7 @@ input ListFolderRequest {
     name : String
     "name of the elements to filter (like clause)"
     nameLike : String
-    "metadata of the elements to filter (contains clause)"
+    "metadata of the elements to filter: exact values (contains clause), or case-insensitive patterns for string values containing % or * (any characters), ? = one character, _ and backslash are literal; a bare % means the key exists. At most 10 criteria."
     metadata : JSON
     size : Long
     createdAtAfter : DateTime
@@ -100,7 +100,7 @@ input FavoriteRequest {
     name : String
     "name of the elements to filter (like clause)"
     nameLike : String
-    "metadata of the elements to filter (contains clause)"
+    "metadata of the elements to filter: exact values (contains clause), or case-insensitive patterns for string values containing % or * (any characters), ? = one character, _ and backslash are literal; a bare % means the key exists. At most 10 criteria."
     metadata : JSON
     size : Long
     createdAtAfter : DateTime

package/graphql/share.graphqls

@@ -102,6 +102,8 @@ type OrganizationUserInfo {
     status: UserStatusEnum!
     "Whether the email can be changed (false if user has verified email or logged in)"
     emailEditable: Boolean
+    "Why the caller's sharing policy refuses this recipient (a SHARE_ERR_* code), null when allowed"
+    sharePolicyBlock: String
 }
 
 """

package/models/effective-policy.ts

@@ -0,0 +1,41 @@
+/* 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 EffectivePolicy {
+    'userId'?: string;
+    'mode'?: EffectivePolicyModeEnum;
+    'allowedDomains'?: Array<string>;
+    'source'?: EffectivePolicySourceEnum;
+    'sourceIds'?: Array<string>;
+}
+
+export const EffectivePolicyModeEnum = {
+    Allow: 'ALLOW',
+    LicensedOnly: 'LICENSED_ONLY',
+    DomainsOnly: 'DOMAINS_ONLY',
+    LicensedAndDomains: 'LICENSED_AND_DOMAINS',
+} as const;
+
+export type EffectivePolicyModeEnum = typeof EffectivePolicyModeEnum[keyof typeof EffectivePolicyModeEnum];
+export const EffectivePolicySourceEnum = {
+    User: 'USER',
+    Team: 'TEAM',
+    Global: 'GLOBAL',
+} as const;
+
+export type EffectivePolicySourceEnum = typeof EffectivePolicySourceEnum[keyof typeof EffectivePolicySourceEnum];
+
+

package/models/enriched-audit-log.ts

@@ -112,6 +112,8 @@ export const EnrichedAuditLogActionEnum = {
     McpAgentTokenRevoked: 'MCP_AGENT_TOKEN_REVOKED',
     AdminSettingChanged: 'ADMIN_SETTING_CHANGED',
     OrganisationAiMaintenanceStarted: 'ORGANISATION_AI_MAINTENANCE_STARTED',
+    SharingPolicyChanged: 'SHARING_POLICY_CHANGED',
+    ShareBlockedByPolicy: 'SHARE_BLOCKED_BY_POLICY',
 } as const;
 
 export type EnrichedAuditLogActionEnum = typeof EnrichedAuditLogActionEnum[keyof typeof EnrichedAuditLogActionEnum];

package/models/global-policy.ts

@@ -0,0 +1,35 @@
+/* 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 GlobalPolicy {
+    'mode'?: GlobalPolicyModeEnum;
+    'allowedDomains'?: Array<string>;
+    'applyToSignatures'?: boolean;
+    'lockedKeys'?: Set<string>;
+    'overrides'?: number;
+    'violations'?: number;
+}
+
+export const GlobalPolicyModeEnum = {
+    Allow: 'ALLOW',
+    LicensedOnly: 'LICENSED_ONLY',
+    DomainsOnly: 'DOMAINS_ONLY',
+    LicensedAndDomains: 'LICENSED_AND_DOMAINS',
+} as const;
+
+export type GlobalPolicyModeEnum = typeof GlobalPolicyModeEnum[keyof typeof GlobalPolicyModeEnum];
+
+

package/models/index.ts

@@ -64,6 +64,7 @@ export * from './document-insight-view';
 export * from './document-integrity-record';
 export * from './document-position';
 export * from './document-version-info';
+export * from './effective-policy';
 export * from './element-info';
 export * from './embed-url-response';
 export * from './embedding-backfill-request';
@@ -87,6 +88,7 @@ export * from './folder-response';
 export * from './folder-selection-by-kind-request';
 export * from './folder-selection-by-kind-response';
 export * from './foreign-item';
+export * from './global-policy';
 export * from './ingestion-status-dto';
 export * from './insight-backfill-request';
 export * from './insight-backfill-status';
@@ -105,15 +107,19 @@ export * from './mcp-agent-token-info';
 export * from './mcp-agent-token-response';
 export * from './merge-request';
 export * from './merge-source';
+export * from './metadata-key-suggestion';
 export * from './mint-mcp-agent-token-request';
 export * from './mint-upload-token-request';
 export * from './move-audit';
 export * from './move-request';
+export * from './my-policy';
 export * from './my-storage-quota';
 export * from './my-tasks-count-dto';
 export * from './notification-dto';
 export * from './organize-request';
 export * from './output-target';
+export * from './override-request';
+export * from './override-view';
 export * from './owned-document';
 export * from './owned-documents-filter';
 export * from './ownership-consent';
@@ -146,6 +152,8 @@ export * from './replace-audit';
 export * from './response';
 export * from './restore-version-audit';
 export * from './restore-version-response';
+export * from './revoke-request';
+export * from './revoke-result';
 export * from './role-binding';
 export * from './rotate-request';
 export * from './save-ai-preferences-request';
@@ -217,6 +225,8 @@ export * from './user-privacy-dto';
 export * from './user-quota-request';
 export * from './user-registration-request';
 export * from './verify-otp-request';
+export * from './violation';
+export * from './violations-response';
 export * from './vote';
 export * from './workflow-action';
 export * from './workflow-action-failure-audit';

package/models/item.ts

@@ -16,12 +16,6 @@
 
 export interface Item {
     'documentId'?: string;
-    'name'?: string;
-    'type'?: string;
-    'currentPath'?: string;
-    'targetPath'?: string;
-    'targetExists'?: boolean;
-    'applicable'?: boolean;
-    'issue'?: string;
+    'recipientId'?: string;
 }
 

package/models/metadata-key-suggestion.ts

@@ -0,0 +1,30 @@
+/* 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.
+ */
+
+
+
+/**
+ * A metadata key found on the documents visible to the caller
+ */
+export interface MetadataKeySuggestion {
+    /**
+     * The metadata key
+     */
+    'key'?: string;
+    /**
+     * Number of visible documents carrying the key
+     */
+    'count'?: number;
+}
+

package/models/my-policy.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 MyPolicy {
+    'mode'?: MyPolicyModeEnum;
+    'allowedDomains'?: Array<string>;
+    'source'?: MyPolicySourceEnum;
+    'applyToSignatures'?: boolean;
+}
+
+export const MyPolicyModeEnum = {
+    Allow: 'ALLOW',
+    LicensedOnly: 'LICENSED_ONLY',
+    DomainsOnly: 'DOMAINS_ONLY',
+    LicensedAndDomains: 'LICENSED_AND_DOMAINS',
+} as const;
+
+export type MyPolicyModeEnum = typeof MyPolicyModeEnum[keyof typeof MyPolicyModeEnum];
+export const MyPolicySourceEnum = {
+    User: 'USER',
+    Team: 'TEAM',
+    Global: 'GLOBAL',
+} as const;
+
+export type MyPolicySourceEnum = typeof MyPolicySourceEnum[keyof typeof MyPolicySourceEnum];
+
+

package/models/notification-dto.ts

@@ -45,6 +45,7 @@ export const NotificationDTOTypeEnum = {
     OwnershipRemoved: 'OWNERSHIP_REMOVED',
     OwnershipConsentAccepted: 'OWNERSHIP_CONSENT_ACCEPTED',
     OwnershipConsentDeclined: 'OWNERSHIP_CONSENT_DECLINED',
+    ShareRevokedByPolicy: 'SHARE_REVOKED_BY_POLICY',
 } as const;
 
 export type NotificationDTOTypeEnum = typeof NotificationDTOTypeEnum[keyof typeof NotificationDTOTypeEnum];

package/models/override-request.ts

@@ -0,0 +1,30 @@
+/* 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 OverrideRequest {
+    'mode'?: OverrideRequestModeEnum;
+}
+
+export const OverrideRequestModeEnum = {
+    Allow: 'ALLOW',
+    LicensedOnly: 'LICENSED_ONLY',
+    DomainsOnly: 'DOMAINS_ONLY',
+    LicensedAndDomains: 'LICENSED_AND_DOMAINS',
+} as const;
+
+export type OverrideRequestModeEnum = typeof OverrideRequestModeEnum[keyof typeof OverrideRequestModeEnum];
+
+

package/models/override-view.ts

@@ -0,0 +1,36 @@
+/* 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 OverrideView {
+    'subjectId'?: string;
+    'type'?: string;
+    'email'?: string;
+    'name'?: string;
+    'mode'?: OverrideViewModeEnum;
+    'updatedBy'?: string;
+    'updatedAt'?: string;
+}
+
+export const OverrideViewModeEnum = {
+    Allow: 'ALLOW',
+    LicensedOnly: 'LICENSED_ONLY',
+    DomainsOnly: 'DOMAINS_ONLY',
+    LicensedAndDomains: 'LICENSED_AND_DOMAINS',
+} as const;
+
+export type OverrideViewModeEnum = typeof OverrideViewModeEnum[keyof typeof OverrideViewModeEnum];
+
+

package/models/revoke-request.ts

@@ -0,0 +1,24 @@
+/* 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.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { Item } from './item';
+
+export interface RevokeRequest {
+    'items'?: Array<Item>;
+    'all'?: boolean;
+}
+

package/models/revoke-result.ts

@@ -0,0 +1,24 @@
+/* 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 RevokeResult {
+    'status'?: string;
+    'jobId'?: string;
+    'revoked'?: number;
+    'skipped'?: number;
+    'total'?: number;
+}
+

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

@@ -125,6 +125,8 @@ export const SearchByAuditLogRequestActionEnum = {
     McpAgentTokenRevoked: 'MCP_AGENT_TOKEN_REVOKED',
     AdminSettingChanged: 'ADMIN_SETTING_CHANGED',
     OrganisationAiMaintenanceStarted: 'ORGANISATION_AI_MAINTENANCE_STARTED',
+    SharingPolicyChanged: 'SHARING_POLICY_CHANGED',
+    ShareBlockedByPolicy: 'SHARE_BLOCKED_BY_POLICY',
 } as const;
 
 export type SearchByAuditLogRequestActionEnum = typeof SearchByAuditLogRequestActionEnum[keyof typeof SearchByAuditLogRequestActionEnum];

package/models/search-by-metadata-request.ts

@@ -35,7 +35,7 @@ export interface SearchByMetadataRequest {
      */
     'rootOnly'?: boolean;
     /**
-     * Metadata key-value pairs to search for
+     * Metadata key-value pairs to search for. A string value containing % or * is a case-insensitive pattern: % or * = any characters, ? = exactly one character, _ and \\ are literal, a bare % = the key is set whatever its value (e.g. {\"project\": \"beta%\"}). Any other value is matched exactly (case-sensitive). At most 10 criteria, keys up to 100 characters, patterns up to 200.
      */
     'metadataCriteria'?: { [key: string]: any; };
 }

package/models/share-result-error.ts

@@ -28,6 +28,12 @@ export const ShareResultErrorCodeEnum = {
     ShareErrNotAlreadyShared: 'SHARE_ERR_NOT_ALREADY_SHARED',
     ShareErrOwner: 'SHARE_ERR_OWNER',
     ShareErrNotScanned: 'SHARE_ERR_NOT_SCANNED',
+    ShareErrRecipientNotLicensedPolicy: 'SHARE_ERR_RECIPIENT_NOT_LICENSED_POLICY',
+    ShareErrRecipientDomainPolicy: 'SHARE_ERR_RECIPIENT_DOMAIN_POLICY',
+    ShareErrTeamHasExternalMember: 'SHARE_ERR_TEAM_HAS_EXTERNAL_MEMBER',
+    ShareErrRecipientOtherOrg: 'SHARE_ERR_RECIPIENT_OTHER_ORG',
+    ShareErrPolicyUnavailable: 'SHARE_ERR_POLICY_UNAVAILABLE',
+    ShareErrDestinationHasExternal: 'SHARE_ERR_DESTINATION_HAS_EXTERNAL',
 } as const;
 
 export type ShareResultErrorCodeEnum = typeof ShareResultErrorCodeEnum[keyof typeof ShareResultErrorCodeEnum];

package/models/violation.ts

@@ -0,0 +1,50 @@
+/* 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 Violation {
+    'documentId'?: string;
+    'documentName'?: string;
+    'documentType'?: string;
+    'masked'?: boolean;
+    'ownerId'?: string;
+    'ownerEmail'?: string;
+    'recipientId'?: string;
+    'recipientType'?: string;
+    'recipientEmail'?: string;
+    'inherited'?: boolean;
+    'externalMembers'?: number;
+    'reason'?: ViolationReasonEnum;
+}
+
+export const ViolationReasonEnum = {
+    ShareErrUserDeactivated: 'SHARE_ERR_USER_DEACTIVATED',
+    ShareErrUserNotLicensed: 'SHARE_ERR_USER_NOT_LICENSED',
+    ShareErrParentAndChild: 'SHARE_ERR_PARENT_AND_CHILD',
+    ShareErrAlreadyExists: 'SHARE_ERR_ALREADY_EXISTS',
+    ShareErrNotAlreadyShared: 'SHARE_ERR_NOT_ALREADY_SHARED',
+    ShareErrOwner: 'SHARE_ERR_OWNER',
+    ShareErrNotScanned: 'SHARE_ERR_NOT_SCANNED',
+    ShareErrRecipientNotLicensedPolicy: 'SHARE_ERR_RECIPIENT_NOT_LICENSED_POLICY',
+    ShareErrRecipientDomainPolicy: 'SHARE_ERR_RECIPIENT_DOMAIN_POLICY',
+    ShareErrTeamHasExternalMember: 'SHARE_ERR_TEAM_HAS_EXTERNAL_MEMBER',
+    ShareErrRecipientOtherOrg: 'SHARE_ERR_RECIPIENT_OTHER_ORG',
+    ShareErrPolicyUnavailable: 'SHARE_ERR_POLICY_UNAVAILABLE',
+    ShareErrDestinationHasExternal: 'SHARE_ERR_DESTINATION_HAS_EXTERNAL',
+} as const;
+
+export type ViolationReasonEnum = typeof ViolationReasonEnum[keyof typeof ViolationReasonEnum];
+
+

package/models/violations-response.ts

@@ -0,0 +1,25 @@
+/* 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.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { Violation } from './violation';
+
+export interface ViolationsResponse {
+    'items'?: Array<Violation>;
+    'nextCursor'?: string;
+    'count'?: number;
+}
+

package/package.json

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