@openfilz-sdk/typescript-ee 1.12.20 → 1.13.1

package/dist/esm/models/ownership-consent-request.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.
+ */
+/**
+ * Ownership consent request
+ */
+export interface OwnershipConsentRequest {
+    /**
+     * Shown to the user with the request: why, and what will happen (3 to 500 characters)
+     */
+    'message': string;
+}

package/dist/esm/models/ownership-consent-request.js

@@ -0,0 +1,14 @@
+/* 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 {};

package/dist/esm/models/ownership-consent.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.
+ */
+/**
+ * A request for a user\'s consent to transfer their documents
+ */
+export interface OwnershipConsent {
+    'grantId'?: string;
+    'status'?: string;
+    'message'?: string;
+    'requestedAt'?: string;
+    'acceptDeadline'?: string;
+    'acceptedAt'?: string;
+    'useDeadline'?: string;
+}

package/dist/esm/models/ownership-consent.js

@@ -0,0 +1,14 @@
+/* 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 {};

package/dist/esm/models/ownership-eligibility.d.ts

@@ -9,6 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import type { OwnershipConsent } from './ownership-consent';
 export interface OwnershipEligibility {
     'userId'?: string;
     'userStatus'?: string;
@@ -17,4 +18,7 @@ export interface OwnershipEligibility {
     'refusal'?: string;
     'recentSignIn'?: boolean;
     'stepUpMaxAgeSeconds'?: number;
+    'via'?: string;
+    'consent'?: OwnershipConsent;
+    'consentRequestable'?: boolean;
 }

package/dist/models/create-delegated-grant-request.d.ts

@@ -18,5 +18,6 @@ export interface CreateDelegatedGrantRequest {
 export declare const CreateDelegatedGrantRequestPurposeEnum: {
     readonly WebhookSubscription: "WEBHOOK_SUBSCRIPTION";
     readonly AiFolderPick: "AI_FOLDER_PICK";
+    readonly OwnershipTransfer: "OWNERSHIP_TRANSFER";
 };
 export type CreateDelegatedGrantRequestPurposeEnum = typeof CreateDelegatedGrantRequestPurposeEnum[keyof typeof CreateDelegatedGrantRequestPurposeEnum];

package/dist/models/create-delegated-grant-request.js

@@ -17,4 +17,5 @@ exports.CreateDelegatedGrantRequestPurposeEnum = void 0;
 exports.CreateDelegatedGrantRequestPurposeEnum = {
     WebhookSubscription: 'WEBHOOK_SUBSCRIPTION',
     AiFolderPick: 'AI_FOLDER_PICK',
+    OwnershipTransfer: 'OWNERSHIP_TRANSFER',
 };

package/dist/models/delegated-grant-dto.d.ts

@@ -31,6 +31,7 @@ export interface DelegatedGrantDTO {
 export declare const DelegatedGrantDTOPurposeEnum: {
     readonly WebhookSubscription: "WEBHOOK_SUBSCRIPTION";
     readonly AiFolderPick: "AI_FOLDER_PICK";
+    readonly OwnershipTransfer: "OWNERSHIP_TRANSFER";
 };
 export type DelegatedGrantDTOPurposeEnum = typeof DelegatedGrantDTOPurposeEnum[keyof typeof DelegatedGrantDTOPurposeEnum];
 export declare const DelegatedGrantDTOStatusEnum: {

package/dist/models/delegated-grant-dto.js

@@ -17,6 +17,7 @@ exports.DelegatedGrantDTOStatusEnum = exports.DelegatedGrantDTOPurposeEnum = voi
 exports.DelegatedGrantDTOPurposeEnum = {
     WebhookSubscription: 'WEBHOOK_SUBSCRIPTION',
     AiFolderPick: 'AI_FOLDER_PICK',
+    OwnershipTransfer: 'OWNERSHIP_TRANSFER',
 };
 exports.DelegatedGrantDTOStatusEnum = {
     Pending: 'PENDING',

package/dist/models/index.d.ts

@@ -116,6 +116,8 @@ export * from './organize-request';
 export * from './output-target';
 export * from './owned-document';
 export * from './owned-documents-filter';
+export * from './ownership-consent';
+export * from './ownership-consent-request';
 export * from './ownership-eligibility';
 export * from './ownership-transfer-report';
 export * from './ownership-transfer-request';

package/dist/models/index.js

@@ -132,6 +132,8 @@ __exportStar(require("./organize-request"), exports);
 __exportStar(require("./output-target"), exports);
 __exportStar(require("./owned-document"), exports);
 __exportStar(require("./owned-documents-filter"), exports);
+__exportStar(require("./ownership-consent"), exports);
+__exportStar(require("./ownership-consent-request"), exports);
 __exportStar(require("./ownership-eligibility"), exports);
 __exportStar(require("./ownership-transfer-report"), exports);
 __exportStar(require("./ownership-transfer-request"), exports);

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

@@ -37,5 +37,7 @@ export declare const NotificationDTOTypeEnum: {
     readonly WorkflowCancelled: "WORKFLOW_CANCELLED";
     readonly OwnershipReceived: "OWNERSHIP_RECEIVED";
     readonly OwnershipRemoved: "OWNERSHIP_REMOVED";
+    readonly OwnershipConsentAccepted: "OWNERSHIP_CONSENT_ACCEPTED";
+    readonly OwnershipConsentDeclined: "OWNERSHIP_CONSENT_DECLINED";
 };
 export type NotificationDTOTypeEnum = typeof NotificationDTOTypeEnum[keyof typeof NotificationDTOTypeEnum];

package/dist/models/notification-dto.js

@@ -31,4 +31,6 @@ exports.NotificationDTOTypeEnum = {
     WorkflowCancelled: 'WORKFLOW_CANCELLED',
     OwnershipReceived: 'OWNERSHIP_RECEIVED',
     OwnershipRemoved: 'OWNERSHIP_REMOVED',
+    OwnershipConsentAccepted: 'OWNERSHIP_CONSENT_ACCEPTED',
+    OwnershipConsentDeclined: 'OWNERSHIP_CONSENT_DECLINED',
 };

package/dist/models/ownership-consent-request.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.
+ */
+/**
+ * Ownership consent request
+ */
+export interface OwnershipConsentRequest {
+    /**
+     * Shown to the user with the request: why, and what will happen (3 to 500 characters)
+     */
+    'message': string;
+}

package/dist/models/ownership-consent-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/ownership-consent.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.
+ */
+/**
+ * A request for a user\'s consent to transfer their documents
+ */
+export interface OwnershipConsent {
+    'grantId'?: string;
+    'status'?: string;
+    'message'?: string;
+    'requestedAt'?: string;
+    'acceptDeadline'?: string;
+    'acceptedAt'?: string;
+    'useDeadline'?: string;
+}

package/dist/models/ownership-consent.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/ownership-eligibility.d.ts

@@ -9,6 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import type { OwnershipConsent } from './ownership-consent';
 export interface OwnershipEligibility {
     'userId'?: string;
     'userStatus'?: string;
@@ -17,4 +18,7 @@ export interface OwnershipEligibility {
     'refusal'?: string;
     'recentSignIn'?: boolean;
     'stepUpMaxAgeSeconds'?: number;
+    'via'?: string;
+    'consent'?: OwnershipConsent;
+    'consentRequestable'?: boolean;
 }

package/docs/OwnershipApi.md

@@ -9,12 +9,14 @@ All URIs are relative to *http://localhost:8081*
 |[**adminGetOwnershipTransfer**](#admingetownershiptransfer) | **GET** /api/v1/admin/ownership/transfers/{jobId} | A transfer\'s progress and outcome|
 |[**adminListOwnedDocuments**](#adminlistowneddocuments) | **GET** /api/v1/admin/ownership/users/{userId}/documents | List the documents a user owns|
 |[**adminListOwnershipTransfers**](#adminlistownershiptransfers) | **GET** /api/v1/admin/ownership/transfers | The last 50 transfers from or to a user|
+|[**adminRequestOwnershipConsent**](#adminrequestownershipconsent) | **POST** /api/v1/admin/ownership/users/{userId}/consent | Ask the user for their consent to transfer their documents|
 |[**adminTransferOwnership**](#admintransferownership) | **POST** /api/v1/admin/ownership/transfers | Transfer documents to another user|
 |[**countOwnedDocuments**](#countowneddocuments) | **GET** /api/v1/users/ownership/users/{userId}/documents/count | Count the documents a user owns (same filter as the listing)|
 |[**getOwnershipEligibility**](#getownershipeligibility) | **GET** /api/v1/users/ownership/users/{userId}/eligibility | May the caller act on this user\'s documents now?|
 |[**getOwnershipTransfer**](#getownershiptransfer) | **GET** /api/v1/users/ownership/transfers/{jobId} | A transfer\'s progress and outcome|
 |[**listOwnedDocuments**](#listowneddocuments) | **GET** /api/v1/users/ownership/users/{userId}/documents | List the documents a user owns|
 |[**listOwnershipTransfers**](#listownershiptransfers) | **GET** /api/v1/users/ownership/transfers | The last 50 transfers from or to a user|
+|[**requestOwnershipConsent**](#requestownershipconsent) | **POST** /api/v1/users/ownership/users/{userId}/consent | Ask the user for their consent to transfer their documents|
 |[**transferOwnership**](#transferownership) | **POST** /api/v1/users/ownership/transfers | Transfer documents to another user|
 
 # **adminCountOwnedDocuments**
@@ -317,6 +319,62 @@ const { status, data } = await apiInstance.adminListOwnershipTransfers(
 
 [[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)
 
+# **adminRequestOwnershipConsent**
+> OwnershipConsent adminRequestOwnershipConsent(ownershipConsentRequest)
+
+For an active user (or under consent-bypass NEVER): the user gets a bell notification and an e-mail and answers in the web app. Once they approve, the caller (only them) may list their documents and make ONE transfer, which uses the consent up; the eligibility endpoint shows its status. 201 = request sent; 200 = the caller already has an open request to this user (pending, or approved and not used), returned as is.
+
+### Example
+
+```typescript
+import {
+    OwnershipApi,
+    Configuration,
+    OwnershipConsentRequest
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new OwnershipApi(configuration);
+
+let userId: string; // (default to undefined)
+let ownershipConsentRequest: OwnershipConsentRequest; //
+
+const { status, data } = await apiInstance.adminRequestOwnershipConsent(
+    userId,
+    ownershipConsentRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **ownershipConsentRequest** | **OwnershipConsentRequest**|  | |
+| **userId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**OwnershipConsent**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**201** | Request sent |  -  |
+|**200** | An open request already exists |  -  |
+
+[[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)
+
 # **adminTransferOwnership**
 > OwnershipTransferReport adminTransferOwnership(ownershipTransferRequest)
 
@@ -670,6 +728,62 @@ const { status, data } = await apiInstance.listOwnershipTransfers(
 
 [[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)
 
+# **requestOwnershipConsent**
+> OwnershipConsent requestOwnershipConsent(ownershipConsentRequest)
+
+For an active user (or under consent-bypass NEVER): the user gets a bell notification and an e-mail and answers in the web app. Once they approve, the caller (only them) may list their documents and make ONE transfer, which uses the consent up; the eligibility endpoint shows its status. 201 = request sent; 200 = the caller already has an open request to this user (pending, or approved and not used), returned as is.
+
+### Example
+
+```typescript
+import {
+    OwnershipApi,
+    Configuration,
+    OwnershipConsentRequest
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new OwnershipApi(configuration);
+
+let userId: string; // (default to undefined)
+let ownershipConsentRequest: OwnershipConsentRequest; //
+
+const { status, data } = await apiInstance.requestOwnershipConsent(
+    userId,
+    ownershipConsentRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **ownershipConsentRequest** | **OwnershipConsentRequest**|  | |
+| **userId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**OwnershipConsent**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**201** | Request sent |  -  |
+|**200** | An open request already exists |  -  |
+
+[[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)
+
 # **transferOwnership**
 > OwnershipTransferReport transferOwnership(ownershipTransferRequest)
 

package/docs/OwnershipConsent.md

@@ -0,0 +1,33 @@
+# OwnershipConsent
+
+A request for a user\'s consent to transfer their documents
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**grantId** | **string** |  | [optional] [default to undefined]
+**status** | **string** |  | [optional] [default to undefined]
+**message** | **string** |  | [optional] [default to undefined]
+**requestedAt** | **string** |  | [optional] [default to undefined]
+**acceptDeadline** | **string** |  | [optional] [default to undefined]
+**acceptedAt** | **string** |  | [optional] [default to undefined]
+**useDeadline** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { OwnershipConsent } from '@openfilz-sdk/typescript-ee';
+
+const instance: OwnershipConsent = {
+    grantId,
+    status,
+    message,
+    requestedAt,
+    acceptDeadline,
+    acceptedAt,
+    useDeadline,
+};
+```
+
+[[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/OwnershipConsentRequest.md

@@ -0,0 +1,21 @@
+# OwnershipConsentRequest
+
+Ownership consent request
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** | Shown to the user with the request: why, and what will happen (3 to 500 characters) | [default to undefined]
+
+## Example
+
+```typescript
+import { OwnershipConsentRequest } from '@openfilz-sdk/typescript-ee';
+
+const instance: OwnershipConsentRequest = {
+    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/OwnershipEligibility.md

@@ -12,6 +12,9 @@ Name | Type | Description | Notes
 **refusal** | **string** |  | [optional] [default to undefined]
 **recentSignIn** | **boolean** |  | [optional] [default to undefined]
 **stepUpMaxAgeSeconds** | **number** |  | [optional] [default to undefined]
+**via** | **string** |  | [optional] [default to undefined]
+**consent** | [**OwnershipConsent**](OwnershipConsent.md) |  | [optional] [default to undefined]
+**consentRequestable** | **boolean** |  | [optional] [default to undefined]
 
 ## Example
 
@@ -26,6 +29,9 @@ const instance: OwnershipEligibility = {
     refusal,
     recentSignIn,
     stepUpMaxAgeSeconds,
+    via,
+    consent,
+    consentRequestable,
 };
 ```
 

package/models/create-delegated-grant-request.ts

@@ -24,6 +24,7 @@ export interface CreateDelegatedGrantRequest {
 export const CreateDelegatedGrantRequestPurposeEnum = {
     WebhookSubscription: 'WEBHOOK_SUBSCRIPTION',
     AiFolderPick: 'AI_FOLDER_PICK',
+    OwnershipTransfer: 'OWNERSHIP_TRANSFER',
 } as const;
 
 export type CreateDelegatedGrantRequestPurposeEnum = typeof CreateDelegatedGrantRequestPurposeEnum[keyof typeof CreateDelegatedGrantRequestPurposeEnum];

package/models/delegated-grant-dto.ts

@@ -37,6 +37,7 @@ export interface DelegatedGrantDTO {
 export const DelegatedGrantDTOPurposeEnum = {
     WebhookSubscription: 'WEBHOOK_SUBSCRIPTION',
     AiFolderPick: 'AI_FOLDER_PICK',
+    OwnershipTransfer: 'OWNERSHIP_TRANSFER',
 } as const;
 
 export type DelegatedGrantDTOPurposeEnum = typeof DelegatedGrantDTOPurposeEnum[keyof typeof DelegatedGrantDTOPurposeEnum];

package/models/index.ts

@@ -116,6 +116,8 @@ export * from './organize-request';
 export * from './output-target';
 export * from './owned-document';
 export * from './owned-documents-filter';
+export * from './ownership-consent';
+export * from './ownership-consent-request';
 export * from './ownership-eligibility';
 export * from './ownership-transfer-report';
 export * from './ownership-transfer-request';

package/models/notification-dto.ts

@@ -43,6 +43,8 @@ export const NotificationDTOTypeEnum = {
     WorkflowCancelled: 'WORKFLOW_CANCELLED',
     OwnershipReceived: 'OWNERSHIP_RECEIVED',
     OwnershipRemoved: 'OWNERSHIP_REMOVED',
+    OwnershipConsentAccepted: 'OWNERSHIP_CONSENT_ACCEPTED',
+    OwnershipConsentDeclined: 'OWNERSHIP_CONSENT_DECLINED',
 } as const;
 
 export type NotificationDTOTypeEnum = typeof NotificationDTOTypeEnum[keyof typeof NotificationDTOTypeEnum];

package/models/ownership-consent-request.ts

@@ -0,0 +1,26 @@
+/* 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.
+ */
+
+
+
+/**
+ * Ownership consent request
+ */
+export interface OwnershipConsentRequest {
+    /**
+     * Shown to the user with the request: why, and what will happen (3 to 500 characters)
+     */
+    'message': string;
+}
+

package/models/ownership-consent.ts

@@ -0,0 +1,29 @@
+/* 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 request for a user\'s consent to transfer their documents
+ */
+export interface OwnershipConsent {
+    'grantId'?: string;
+    'status'?: string;
+    'message'?: string;
+    'requestedAt'?: string;
+    'acceptDeadline'?: string;
+    'acceptedAt'?: string;
+    'useDeadline'?: string;
+}
+

package/models/ownership-eligibility.ts

@@ -13,6 +13,9 @@
  */
 
 
+// May contain unused imports in some cases
+// @ts-ignore
+import type { OwnershipConsent } from './ownership-consent';
 
 export interface OwnershipEligibility {
     'userId'?: string;
@@ -22,5 +25,8 @@ export interface OwnershipEligibility {
     'refusal'?: string;
     'recentSignIn'?: boolean;
     'stepUpMaxAgeSeconds'?: number;
+    'via'?: string;
+    'consent'?: OwnershipConsent;
+    'consentRequestable'?: boolean;
 }
 

package/package.json

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