@openfilz-sdk/typescript-ee 1.12.20 → 1.13.1

package/.openapi-generator/FILES

@@ -215,6 +215,8 @@ docs/OutputTarget.md
 docs/OwnedDocument.md
 docs/OwnedDocumentsFilter.md
 docs/OwnershipApi.md
+docs/OwnershipConsent.md
+docs/OwnershipConsentRequest.md
 docs/OwnershipEligibility.md
 docs/OwnershipTransferReport.md
 docs/OwnershipTransferRequest.md
@@ -469,6 +471,8 @@ models/organize-request.ts
 models/output-target.ts
 models/owned-document.ts
 models/owned-documents-filter.ts
+models/ownership-consent-request.ts
+models/ownership-consent.ts
 models/ownership-eligibility.ts
 models/ownership-transfer-report.ts
 models/ownership-transfer-request.ts

package/.openapi-generator/openfilz-api-generate-typescript-sdk.sha256

@@ -1 +1 @@
-a491f2ec6f09824af727e90b29e5e2dde27244ba2a8e8f7ade37bf92407106c6
+ae3c397c412a95f8b9ddbb0f68c8969895766d32fc3970a10b011b92a8300634

package/README.md

@@ -1,4 +1,4 @@
-## @openfilz-sdk/typescript-ee@1.12.20
+## @openfilz-sdk/typescript-ee@1.13.1
 
 This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install @openfilz-sdk/typescript-ee@1.12.20 --save
+npm install @openfilz-sdk/typescript-ee@1.13.1 --save
 ```
 
 _unPublished (not recommended):_
@@ -234,12 +234,14 @@ Class | Method | HTTP request | Description
 *OwnershipApi* | [**adminGetOwnershipTransfer**](docs/OwnershipApi.md#admingetownershiptransfer) | **GET** /api/v1/admin/ownership/transfers/{jobId} | A transfer\'s progress and outcome
 *OwnershipApi* | [**adminListOwnedDocuments**](docs/OwnershipApi.md#adminlistowneddocuments) | **GET** /api/v1/admin/ownership/users/{userId}/documents | List the documents a user owns
 *OwnershipApi* | [**adminListOwnershipTransfers**](docs/OwnershipApi.md#adminlistownershiptransfers) | **GET** /api/v1/admin/ownership/transfers | The last 50 transfers from or to a user
+*OwnershipApi* | [**adminRequestOwnershipConsent**](docs/OwnershipApi.md#adminrequestownershipconsent) | **POST** /api/v1/admin/ownership/users/{userId}/consent | Ask the user for their consent to transfer their documents
 *OwnershipApi* | [**adminTransferOwnership**](docs/OwnershipApi.md#admintransferownership) | **POST** /api/v1/admin/ownership/transfers | Transfer documents to another user
 *OwnershipApi* | [**countOwnedDocuments**](docs/OwnershipApi.md#countowneddocuments) | **GET** /api/v1/users/ownership/users/{userId}/documents/count | Count the documents a user owns (same filter as the listing)
 *OwnershipApi* | [**getOwnershipEligibility**](docs/OwnershipApi.md#getownershipeligibility) | **GET** /api/v1/users/ownership/users/{userId}/eligibility | May the caller act on this user\'s documents now?
 *OwnershipApi* | [**getOwnershipTransfer**](docs/OwnershipApi.md#getownershiptransfer) | **GET** /api/v1/users/ownership/transfers/{jobId} | A transfer\'s progress and outcome
 *OwnershipApi* | [**listOwnedDocuments**](docs/OwnershipApi.md#listowneddocuments) | **GET** /api/v1/users/ownership/users/{userId}/documents | List the documents a user owns
 *OwnershipApi* | [**listOwnershipTransfers**](docs/OwnershipApi.md#listownershiptransfers) | **GET** /api/v1/users/ownership/transfers | The last 50 transfers from or to a user
+*OwnershipApi* | [**requestOwnershipConsent**](docs/OwnershipApi.md#requestownershipconsent) | **POST** /api/v1/users/ownership/users/{userId}/consent | Ask the user for their consent to transfer their documents
 *OwnershipApi* | [**transferOwnership**](docs/OwnershipApi.md#transferownership) | **POST** /api/v1/users/ownership/transfers | Transfer documents to another user
 *PDFToolsApi* | [**info**](docs/PDFToolsApi.md#info) | **GET** /api/v1/pdf/{documentId}/info | Describe a stored PDF
 *PDFToolsApi* | [**merge**](docs/PDFToolsApi.md#merge) | **POST** /api/v1/pdf/merge | Merge PDFs
@@ -444,6 +446,8 @@ Class | Method | HTTP request | Description
  - [OutputTarget](docs/OutputTarget.md)
  - [OwnedDocument](docs/OwnedDocument.md)
  - [OwnedDocumentsFilter](docs/OwnedDocumentsFilter.md)
+ - [OwnershipConsent](docs/OwnershipConsent.md)
+ - [OwnershipConsentRequest](docs/OwnershipConsentRequest.md)
  - [OwnershipEligibility](docs/OwnershipEligibility.md)
  - [OwnershipTransferReport](docs/OwnershipTransferReport.md)
  - [OwnershipTransferRequest](docs/OwnershipTransferRequest.md)

package/api/ownership-api.ts

@@ -24,6 +24,10 @@ import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError
 // @ts-ignore
 import type { OwnedDocument } from '../models';
 // @ts-ignore
+import type { OwnershipConsent } from '../models';
+// @ts-ignore
+import type { OwnershipConsentRequest } from '../models';
+// @ts-ignore
 import type { OwnershipEligibility } from '../models';
 // @ts-ignore
 import type { OwnershipTransferReport } from '../models';
@@ -313,6 +317,49 @@ export const OwnershipApiAxiosParamCreator = function (configuration?: Configura
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * 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.
+         * @summary Ask the user for their consent to transfer their documents
+         * @param {string} userId 
+         * @param {OwnershipConsentRequest} ownershipConsentRequest 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        adminRequestOwnershipConsent: async (userId: string, ownershipConsentRequest: OwnershipConsentRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'userId' is not null or undefined
+            assertParamExists('adminRequestOwnershipConsent', 'userId', userId)
+            // verify required parameter 'ownershipConsentRequest' is not null or undefined
+            assertParamExists('adminRequestOwnershipConsent', 'ownershipConsentRequest', ownershipConsentRequest)
+            const localVarPath = `/api/v1/admin/ownership/users/{userId}/consent`
+                .replace('{userId}', encodeURIComponent(String(userId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication keycloak_auth required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            localVarHeaderParameter['Accept'] = '*/*';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(ownershipConsentRequest, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * dryRun=true reports what would happen. Otherwise 200 with status DONE, or 202 with status RUNNING for a large scope (poll GET …/transfers/{jobId}). 409 QUOTA_EXCEEDED carries usedBytes, transferBytes, limitBytes.
          * @summary Transfer documents to another user
@@ -631,6 +678,49 @@ export const OwnershipApiAxiosParamCreator = function (configuration?: Configura
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * 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.
+         * @summary Ask the user for their consent to transfer their documents
+         * @param {string} userId 
+         * @param {OwnershipConsentRequest} ownershipConsentRequest 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        requestOwnershipConsent: async (userId: string, ownershipConsentRequest: OwnershipConsentRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'userId' is not null or undefined
+            assertParamExists('requestOwnershipConsent', 'userId', userId)
+            // verify required parameter 'ownershipConsentRequest' is not null or undefined
+            assertParamExists('requestOwnershipConsent', 'ownershipConsentRequest', ownershipConsentRequest)
+            const localVarPath = `/api/v1/users/ownership/users/{userId}/consent`
+                .replace('{userId}', encodeURIComponent(String(userId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication keycloak_auth required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            localVarHeaderParameter['Accept'] = '*/*';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(ownershipConsentRequest, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * dryRun=true reports what would happen. Otherwise 200 with status DONE, or 202 with status RUNNING for a large scope (poll GET …/transfers/{jobId}). 409 QUOTA_EXCEEDED carries usedBytes, transferBytes, limitBytes.
          * @summary Transfer documents to another user
@@ -760,6 +850,20 @@ export const OwnershipApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['OwnershipApi.adminListOwnershipTransfers']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * 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.
+         * @summary Ask the user for their consent to transfer their documents
+         * @param {string} userId 
+         * @param {OwnershipConsentRequest} ownershipConsentRequest 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async adminRequestOwnershipConsent(userId: string, ownershipConsentRequest: OwnershipConsentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OwnershipConsent>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.adminRequestOwnershipConsent(userId, ownershipConsentRequest, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['OwnershipApi.adminRequestOwnershipConsent']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * dryRun=true reports what would happen. Otherwise 200 with status DONE, or 202 with status RUNNING for a large scope (poll GET …/transfers/{jobId}). 409 QUOTA_EXCEEDED carries usedBytes, transferBytes, limitBytes.
          * @summary Transfer documents to another user
@@ -854,6 +958,20 @@ export const OwnershipApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['OwnershipApi.listOwnershipTransfers']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * 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.
+         * @summary Ask the user for their consent to transfer their documents
+         * @param {string} userId 
+         * @param {OwnershipConsentRequest} ownershipConsentRequest 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async requestOwnershipConsent(userId: string, ownershipConsentRequest: OwnershipConsentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OwnershipConsent>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.requestOwnershipConsent(userId, ownershipConsentRequest, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['OwnershipApi.requestOwnershipConsent']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * dryRun=true reports what would happen. Otherwise 200 with status DONE, or 202 with status RUNNING for a large scope (poll GET …/transfers/{jobId}). 409 QUOTA_EXCEEDED carries usedBytes, transferBytes, limitBytes.
          * @summary Transfer documents to another user
@@ -942,6 +1060,17 @@ export const OwnershipApiFactory = function (configuration?: Configuration, base
         adminListOwnershipTransfers(userId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<OwnershipTransferReport>> {
             return localVarFp.adminListOwnershipTransfers(userId, options).then((request) => request(axios, basePath));
         },
+        /**
+         * 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.
+         * @summary Ask the user for their consent to transfer their documents
+         * @param {string} userId 
+         * @param {OwnershipConsentRequest} ownershipConsentRequest 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        adminRequestOwnershipConsent(userId: string, ownershipConsentRequest: OwnershipConsentRequest, options?: RawAxiosRequestConfig): AxiosPromise<OwnershipConsent> {
+            return localVarFp.adminRequestOwnershipConsent(userId, ownershipConsentRequest, options).then((request) => request(axios, basePath));
+        },
         /**
          * dryRun=true reports what would happen. Otherwise 200 with status DONE, or 202 with status RUNNING for a large scope (poll GET …/transfers/{jobId}). 409 QUOTA_EXCEEDED carries usedBytes, transferBytes, limitBytes.
          * @summary Transfer documents to another user
@@ -1018,6 +1147,17 @@ export const OwnershipApiFactory = function (configuration?: Configuration, base
         listOwnershipTransfers(userId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<OwnershipTransferReport>> {
             return localVarFp.listOwnershipTransfers(userId, options).then((request) => request(axios, basePath));
         },
+        /**
+         * 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.
+         * @summary Ask the user for their consent to transfer their documents
+         * @param {string} userId 
+         * @param {OwnershipConsentRequest} ownershipConsentRequest 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        requestOwnershipConsent(userId: string, ownershipConsentRequest: OwnershipConsentRequest, options?: RawAxiosRequestConfig): AxiosPromise<OwnershipConsent> {
+            return localVarFp.requestOwnershipConsent(userId, ownershipConsentRequest, options).then((request) => request(axios, basePath));
+        },
         /**
          * dryRun=true reports what would happen. Otherwise 200 with status DONE, or 202 with status RUNNING for a large scope (poll GET …/transfers/{jobId}). 409 QUOTA_EXCEEDED carries usedBytes, transferBytes, limitBytes.
          * @summary Transfer documents to another user
@@ -1106,6 +1246,18 @@ export class OwnershipApi extends BaseAPI {
         return OwnershipApiFp(this.configuration).adminListOwnershipTransfers(userId, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * 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.
+     * @summary Ask the user for their consent to transfer their documents
+     * @param {string} userId 
+     * @param {OwnershipConsentRequest} ownershipConsentRequest 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public adminRequestOwnershipConsent(userId: string, ownershipConsentRequest: OwnershipConsentRequest, options?: RawAxiosRequestConfig) {
+        return OwnershipApiFp(this.configuration).adminRequestOwnershipConsent(userId, ownershipConsentRequest, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * dryRun=true reports what would happen. Otherwise 200 with status DONE, or 202 with status RUNNING for a large scope (poll GET …/transfers/{jobId}). 409 QUOTA_EXCEEDED carries usedBytes, transferBytes, limitBytes.
      * @summary Transfer documents to another user
@@ -1188,6 +1340,18 @@ export class OwnershipApi extends BaseAPI {
         return OwnershipApiFp(this.configuration).listOwnershipTransfers(userId, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * 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.
+     * @summary Ask the user for their consent to transfer their documents
+     * @param {string} userId 
+     * @param {OwnershipConsentRequest} ownershipConsentRequest 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public requestOwnershipConsent(userId: string, ownershipConsentRequest: OwnershipConsentRequest, options?: RawAxiosRequestConfig) {
+        return OwnershipApiFp(this.configuration).requestOwnershipConsent(userId, ownershipConsentRequest, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * dryRun=true reports what would happen. Otherwise 200 with status DONE, or 202 with status RUNNING for a large scope (poll GET …/transfers/{jobId}). 409 QUOTA_EXCEEDED carries usedBytes, transferBytes, limitBytes.
      * @summary Transfer documents to another user

package/dist/api/ownership-api.d.ts

@@ -13,6 +13,8 @@ import type { Configuration } from '../configuration';
 import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
 import { type RequestArgs, BaseAPI } from '../base';
 import type { OwnedDocument } from '../models';
+import type { OwnershipConsent } from '../models';
+import type { OwnershipConsentRequest } from '../models';
 import type { OwnershipEligibility } from '../models';
 import type { OwnershipTransferReport } from '../models';
 import type { OwnershipTransferRequest } from '../models';
@@ -76,6 +78,15 @@ export declare const OwnershipApiAxiosParamCreator: (configuration?: Configurati
      * @throws {RequiredError}
      */
     adminListOwnershipTransfers: (userId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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.
+     * @summary Ask the user for their consent to transfer their documents
+     * @param {string} userId
+     * @param {OwnershipConsentRequest} ownershipConsentRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    adminRequestOwnershipConsent: (userId: string, ownershipConsentRequest: OwnershipConsentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * dryRun=true reports what would happen. Otherwise 200 with status DONE, or 202 with status RUNNING for a large scope (poll GET …/transfers/{jobId}). 409 QUOTA_EXCEEDED carries usedBytes, transferBytes, limitBytes.
      * @summary Transfer documents to another user
@@ -140,6 +151,15 @@ export declare const OwnershipApiAxiosParamCreator: (configuration?: Configurati
      * @throws {RequiredError}
      */
     listOwnershipTransfers: (userId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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.
+     * @summary Ask the user for their consent to transfer their documents
+     * @param {string} userId
+     * @param {OwnershipConsentRequest} ownershipConsentRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    requestOwnershipConsent: (userId: string, ownershipConsentRequest: OwnershipConsentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * dryRun=true reports what would happen. Otherwise 200 with status DONE, or 202 with status RUNNING for a large scope (poll GET …/transfers/{jobId}). 409 QUOTA_EXCEEDED carries usedBytes, transferBytes, limitBytes.
      * @summary Transfer documents to another user
@@ -209,6 +229,15 @@ export declare const OwnershipApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     adminListOwnershipTransfers(userId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OwnershipTransferReport>>>;
+    /**
+     * 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.
+     * @summary Ask the user for their consent to transfer their documents
+     * @param {string} userId
+     * @param {OwnershipConsentRequest} ownershipConsentRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    adminRequestOwnershipConsent(userId: string, ownershipConsentRequest: OwnershipConsentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OwnershipConsent>>;
     /**
      * dryRun=true reports what would happen. Otherwise 200 with status DONE, or 202 with status RUNNING for a large scope (poll GET …/transfers/{jobId}). 409 QUOTA_EXCEEDED carries usedBytes, transferBytes, limitBytes.
      * @summary Transfer documents to another user
@@ -273,6 +302,15 @@ export declare const OwnershipApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     listOwnershipTransfers(userId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OwnershipTransferReport>>>;
+    /**
+     * 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.
+     * @summary Ask the user for their consent to transfer their documents
+     * @param {string} userId
+     * @param {OwnershipConsentRequest} ownershipConsentRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    requestOwnershipConsent(userId: string, ownershipConsentRequest: OwnershipConsentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OwnershipConsent>>;
     /**
      * dryRun=true reports what would happen. Otherwise 200 with status DONE, or 202 with status RUNNING for a large scope (poll GET …/transfers/{jobId}). 409 QUOTA_EXCEEDED carries usedBytes, transferBytes, limitBytes.
      * @summary Transfer documents to another user
@@ -342,6 +380,15 @@ export declare const OwnershipApiFactory: (configuration?: Configuration, basePa
      * @throws {RequiredError}
      */
     adminListOwnershipTransfers(userId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<OwnershipTransferReport>>;
+    /**
+     * 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.
+     * @summary Ask the user for their consent to transfer their documents
+     * @param {string} userId
+     * @param {OwnershipConsentRequest} ownershipConsentRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    adminRequestOwnershipConsent(userId: string, ownershipConsentRequest: OwnershipConsentRequest, options?: RawAxiosRequestConfig): AxiosPromise<OwnershipConsent>;
     /**
      * dryRun=true reports what would happen. Otherwise 200 with status DONE, or 202 with status RUNNING for a large scope (poll GET …/transfers/{jobId}). 409 QUOTA_EXCEEDED carries usedBytes, transferBytes, limitBytes.
      * @summary Transfer documents to another user
@@ -406,6 +453,15 @@ export declare const OwnershipApiFactory: (configuration?: Configuration, basePa
      * @throws {RequiredError}
      */
     listOwnershipTransfers(userId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<OwnershipTransferReport>>;
+    /**
+     * 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.
+     * @summary Ask the user for their consent to transfer their documents
+     * @param {string} userId
+     * @param {OwnershipConsentRequest} ownershipConsentRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    requestOwnershipConsent(userId: string, ownershipConsentRequest: OwnershipConsentRequest, options?: RawAxiosRequestConfig): AxiosPromise<OwnershipConsent>;
     /**
      * dryRun=true reports what would happen. Otherwise 200 with status DONE, or 202 with status RUNNING for a large scope (poll GET …/transfers/{jobId}). 409 QUOTA_EXCEEDED carries usedBytes, transferBytes, limitBytes.
      * @summary Transfer documents to another user
@@ -475,6 +531,15 @@ export declare class OwnershipApi extends BaseAPI {
      * @throws {RequiredError}
      */
     adminListOwnershipTransfers(userId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OwnershipTransferReport[], any, {}, any>>;
+    /**
+     * 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.
+     * @summary Ask the user for their consent to transfer their documents
+     * @param {string} userId
+     * @param {OwnershipConsentRequest} ownershipConsentRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    adminRequestOwnershipConsent(userId: string, ownershipConsentRequest: OwnershipConsentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OwnershipConsent, any, {}, any>>;
     /**
      * dryRun=true reports what would happen. Otherwise 200 with status DONE, or 202 with status RUNNING for a large scope (poll GET …/transfers/{jobId}). 409 QUOTA_EXCEEDED carries usedBytes, transferBytes, limitBytes.
      * @summary Transfer documents to another user
@@ -539,6 +604,15 @@ export declare class OwnershipApi extends BaseAPI {
      * @throws {RequiredError}
      */
     listOwnershipTransfers(userId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OwnershipTransferReport[], any, {}, any>>;
+    /**
+     * 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.
+     * @summary Ask the user for their consent to transfer their documents
+     * @param {string} userId
+     * @param {OwnershipConsentRequest} ownershipConsentRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    requestOwnershipConsent(userId: string, ownershipConsentRequest: OwnershipConsentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OwnershipConsent, any, {}, any>>;
     /**
      * dryRun=true reports what would happen. Otherwise 200 with status DONE, or 202 with status RUNNING for a large scope (poll GET …/transfers/{jobId}). 409 QUOTA_EXCEEDED carries usedBytes, transferBytes, limitBytes.
      * @summary Transfer documents to another user