@openfilz-sdk/typescript-ee 1.14.4 → 1.14.6

package/dist/models/team-details.d.ts

@@ -0,0 +1,28 @@
+/**
+ * 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 { TeamPendingInvitee } from './team-pending-invitee';
+import type { TeamPerson } from './team-person';
+export interface TeamDetails {
+    'id'?: string;
+    'name'?: string;
+    'kind'?: TeamDetailsKindEnum;
+    'owner'?: boolean;
+    'canManage'?: boolean;
+    'owners'?: Array<TeamPerson>;
+    'members'?: Array<TeamPerson>;
+    'pendingInvitations'?: Array<TeamPendingInvitee>;
+}
+export declare const TeamDetailsKindEnum: {
+    readonly Organisation: "ORGANISATION";
+    readonly Collaborative: "COLLABORATIVE";
+};
+export type TeamDetailsKindEnum = typeof TeamDetailsKindEnum[keyof typeof TeamDetailsKindEnum];

package/dist/models/team-details.js

@@ -0,0 +1,20 @@
+"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.TeamDetailsKindEnum = void 0;
+exports.TeamDetailsKindEnum = {
+    Organisation: 'ORGANISATION',
+    Collaborative: 'COLLABORATIVE',
+};

package/dist/models/team-invitation-view.d.ts

@@ -0,0 +1,20 @@
+/**
+ * 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 TeamInvitationView {
+    'id'?: string;
+    'teamId'?: string;
+    'teamName'?: string;
+    'invitedByName'?: string;
+    'invitedByEmail'?: string;
+    'createdAt'?: string;
+    'expiresAt'?: string;
+}

package/dist/models/team-invitation-view.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/team-invite-result.d.ts

@@ -0,0 +1,23 @@
+/**
+ * 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 TeamInviteResult {
+    'email'?: string;
+    'outcome'?: TeamInviteResultOutcomeEnum;
+}
+export declare const TeamInviteResultOutcomeEnum: {
+    readonly Invited: "INVITED";
+    readonly AlreadyMember: "ALREADY_MEMBER";
+    readonly AlreadyInvited: "ALREADY_INVITED";
+    readonly NotFound: "NOT_FOUND";
+    readonly BlockedByPolicy: "BLOCKED_BY_POLICY";
+};
+export type TeamInviteResultOutcomeEnum = typeof TeamInviteResultOutcomeEnum[keyof typeof TeamInviteResultOutcomeEnum];

package/dist/models/team-invite-result.js

@@ -0,0 +1,23 @@
+"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.TeamInviteResultOutcomeEnum = void 0;
+exports.TeamInviteResultOutcomeEnum = {
+    Invited: 'INVITED',
+    AlreadyMember: 'ALREADY_MEMBER',
+    AlreadyInvited: 'ALREADY_INVITED',
+    NotFound: 'NOT_FOUND',
+    BlockedByPolicy: 'BLOCKED_BY_POLICY',
+};

package/dist/models/team-kind-view.d.ts

@@ -0,0 +1,23 @@
+/**
+ * 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 { TeamOwnerView } from './team-owner-view';
+export interface TeamKindView {
+    'teamId'?: string;
+    'name'?: string;
+    'kind'?: TeamKindViewKindEnum;
+    'owners'?: Array<TeamOwnerView>;
+}
+export declare const TeamKindViewKindEnum: {
+    readonly Organisation: "ORGANISATION";
+    readonly Collaborative: "COLLABORATIVE";
+};
+export type TeamKindViewKindEnum = typeof TeamKindViewKindEnum[keyof typeof TeamKindViewKindEnum];

package/dist/models/team-kind-view.js

@@ -0,0 +1,20 @@
+"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.TeamKindViewKindEnum = void 0;
+exports.TeamKindViewKindEnum = {
+    Organisation: 'ORGANISATION',
+    Collaborative: 'COLLABORATIVE',
+};

package/dist/models/team-owner-view.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 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 TeamOwnerView {
+    'id'?: string;
+    'email'?: string;
+    'name'?: string;
+}

package/dist/models/team-owner-view.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/team-pending-invitee.d.ts

@@ -0,0 +1,19 @@
+/**
+ * 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 TeamPendingInvitee {
+    'id'?: string;
+    'userId'?: string;
+    'email'?: string;
+    'name'?: string;
+    'createdAt'?: string;
+    'expiresAt'?: string;
+}

package/dist/models/team-pending-invitee.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/team-person.d.ts

@@ -0,0 +1,17 @@
+/**
+ * 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 TeamPerson {
+    'id'?: string;
+    'email'?: string;
+    'name'?: string;
+    'status'?: string;
+}

package/dist/models/team-person.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/update-user-privacy-request.d.ts

@@ -10,5 +10,7 @@
  * Do not edit the class manually.
  */
 export interface UpdateUserPrivacyRequest {
-    'adminMonitoringOptOut': boolean;
+    'adminMonitoringOptOut'?: boolean;
+    'directoryOptIn'?: boolean;
+    'anyFlagSet'?: boolean;
 }

package/dist/models/user-privacy-dto.d.ts

@@ -11,4 +11,12 @@
  */
 export interface UserPrivacyDTO {
     'adminMonitoringOptOut'?: boolean;
+    'directoryOptIn'?: boolean;
+    'directoryMode'?: UserPrivacyDTODirectoryModeEnum;
+    'directoryHidden'?: boolean;
 }
+export declare const UserPrivacyDTODirectoryModeEnum: {
+    readonly Public: "PUBLIC";
+    readonly UserChoice: "USER_CHOICE";
+};
+export type UserPrivacyDTODirectoryModeEnum = typeof UserPrivacyDTODirectoryModeEnum[keyof typeof UserPrivacyDTODirectoryModeEnum];

package/dist/models/user-privacy-dto.js

@@ -13,3 +13,8 @@
  * Do not edit the class manually.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.UserPrivacyDTODirectoryModeEnum = void 0;
+exports.UserPrivacyDTODirectoryModeEnum = {
+    Public: 'PUBLIC',
+    UserChoice: 'USER_CHOICE',
+};

package/docs/AddTeamOwnerRequest.md

@@ -0,0 +1,20 @@
+# AddTeamOwnerRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**userId** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AddTeamOwnerRequest } from '@openfilz-sdk/typescript-ee';
+
+const instance: AddTeamOwnerRequest = {
+    userId,
+};
+```
+
+[[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/CollaborationControllerApi.md

@@ -74,7 +74,7 @@ const { status, data } = await apiInstance.acceptShareRequest(
 # **addTeamMembers**
 > addTeamMembers(requestBody)
 
-Adds users to a team. Requires ADMIN_USERS role.
+Adds users to a team, each told by a notification and an e-mail. Sends invitations instead for a collaborative team, or when openfilz.teams.admin-add-requires-consent is on. Requires ADMIN_USERS role.
 
 ### Example
 
@@ -389,7 +389,7 @@ const { status, data } = await apiInstance.deleteSharedDocuments(
 # **deleteTeam**
 > deleteTeam()
 
-Deletes a team. Requires ADMIN_USERS role.
+Deletes a team of any kind; its members are told by a notification. Requires ADMIN_USERS role.
 
 ### Example
 
@@ -586,7 +586,7 @@ void (empty response body)
 # **removeTeamMembers**
 > removeTeamMembers(requestBody)
 
-Removes users from a team. Requires ADMIN_USERS role.
+Removes users from a team; each is told by a notification. Requires ADMIN_USERS role.
 
 ### Example
 

package/docs/CreateCollaborativeTeamRequest.md

@@ -0,0 +1,20 @@
+# CreateCollaborativeTeamRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreateCollaborativeTeamRequest } from '@openfilz-sdk/typescript-ee';
+
+const instance: CreateCollaborativeTeamRequest = {
+    name,
+};
+```
+
+[[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/DirectoryAdministrationApi.md

@@ -0,0 +1,107 @@
+# DirectoryAdministrationApi
+
+All URIs are relative to *http://localhost:8081*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**adminListDirectoryHidden**](#adminlistdirectoryhidden) | **GET** /api/v1/admin/users/directory-hidden | Ids of the users hidden from the directory|
+|[**adminSetDirectoryHidden**](#adminsetdirectoryhidden) | **PUT** /api/v1/admin/users/{userId}/directory-hidden | Hide a user from the directory, or show them again|
+
+# **adminListDirectoryHidden**
+> Array<string> adminListDirectoryHidden()
+
+
+### Example
+
+```typescript
+import {
+    DirectoryAdministrationApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new DirectoryAdministrationApi(configuration);
+
+const { status, data } = await apiInstance.adminListDirectoryHidden();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Array<string>**
+
+### 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)
+
+# **adminSetDirectoryHidden**
+> adminSetDirectoryHidden(directoryHiddenRequest)
+
+Idempotent; audited DIRECTORY_HIDDEN_CHANGED only when the value changes. 404 for an unknown user or a team.
+
+### Example
+
+```typescript
+import {
+    DirectoryAdministrationApi,
+    Configuration,
+    DirectoryHiddenRequest
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new DirectoryAdministrationApi(configuration);
+
+let userId: string; // (default to undefined)
+let directoryHiddenRequest: DirectoryHiddenRequest; //
+
+const { status, data } = await apiInstance.adminSetDirectoryHidden(
+    userId,
+    directoryHiddenRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **directoryHiddenRequest** | **DirectoryHiddenRequest**|  | |
+| **userId** | [**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/DirectoryHiddenRequest.md

@@ -0,0 +1,20 @@
+# DirectoryHiddenRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**hidden** | **boolean** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { DirectoryHiddenRequest } from '@openfilz-sdk/typescript-ee';
+
+const instance: DirectoryHiddenRequest = {
+    hidden,
+};
+```
+
+[[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/InviteToTeamRequest.md

@@ -0,0 +1,20 @@
+# InviteToTeamRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**emails** | **Array<string>** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { InviteToTeamRequest } from '@openfilz-sdk/typescript-ee';
+
+const instance: InviteToTeamRequest = {
+    emails,
+};
+```
+
+[[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/MyTeam.md

@@ -0,0 +1,28 @@
+# MyTeam
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**kind** | **string** |  | [optional] [default to undefined]
+**owner** | **boolean** |  | [optional] [default to undefined]
+**memberCount** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { MyTeam } from '@openfilz-sdk/typescript-ee';
+
+const instance: MyTeam = {
+    id,
+    name,
+    kind,
+    owner,
+    memberCount,
+};
+```
+
+[[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/NotificationsApi.md

@@ -4,7 +4,7 @@ All URIs are relative to *http://localhost:8081*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
-|[**getNotifications**](#getnotifications) | **GET** /api/v1/notifications | Get all notifications|
+|[**getNotifications**](#getnotifications) | **GET** /api/v1/notifications | Get notifications|
 |[**getUnreadCount**](#getunreadcount) | **GET** /api/v1/notifications/unread/count | Get unread notification count|
 |[**markAllAsRead**](#markallasread) | **PUT** /api/v1/notifications/read-all | Mark all notifications as read|
 |[**markAsRead**](#markasread) | **PUT** /api/v1/notifications/{id}/read | Mark notification as read|
@@ -13,7 +13,7 @@ All URIs are relative to *http://localhost:8081*
 # **getNotifications**
 > Array<NotificationDTO> getNotifications()
 
-Retrieve all notifications for the authenticated user
+The most recent notifications of the authenticated user, newest first (100 by default, 500 at most)
 
 ### Example
 

package/docs/RenameTeamRequest.md

@@ -0,0 +1,20 @@
+# RenameTeamRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { RenameTeamRequest } from '@openfilz-sdk/typescript-ee';
+
+const instance: RenameTeamRequest = {
+    name,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)