@openfilz-sdk/typescript-ee 1.14.7 → 1.14.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +8 -0
- package/.openapi-generator/openfilz-api-generate-typescript-sdk.sha256 +1 -1
- package/README.md +8 -2
- package/api/access-requests-api.ts +203 -0
- package/api/collaboration-controller-api.ts +79 -4
- package/api.ts +1 -0
- package/dist/api/access-requests-api.d.ts +100 -0
- package/dist/api/access-requests-api.js +202 -0
- package/dist/api/collaboration-controller-api.d.ts +37 -4
- package/dist/api/collaboration-controller-api.js +74 -4
- package/dist/api.d.ts +1 -0
- package/dist/api.js +1 -0
- package/dist/esm/api/access-requests-api.d.ts +100 -0
- package/dist/esm/api/access-requests-api.js +195 -0
- package/dist/esm/api/collaboration-controller-api.d.ts +37 -4
- package/dist/esm/api/collaboration-controller-api.js +74 -4
- package/dist/esm/api.d.ts +1 -0
- package/dist/esm/api.js +1 -0
- package/dist/esm/models/access-request-input.d.ts +31 -0
- package/dist/esm/models/access-request-input.js +18 -0
- package/dist/esm/models/access-request-status.d.ts +36 -0
- package/dist/esm/models/access-request-status.js +24 -0
- package/dist/esm/models/enriched-audit-log.d.ts +1 -0
- package/dist/esm/models/enriched-audit-log.js +1 -0
- package/dist/esm/models/index.d.ts +3 -0
- package/dist/esm/models/index.js +3 -0
- package/dist/esm/models/notification-dto.d.ts +3 -0
- package/dist/esm/models/notification-dto.js +3 -0
- package/dist/esm/models/search-by-audit-log-request.d.ts +1 -0
- package/dist/esm/models/search-by-audit-log-request.js +1 -0
- package/dist/esm/models/share-expiry-request.d.ts +25 -0
- package/dist/esm/models/share-expiry-request.js +14 -0
- package/dist/esm/models/share-request.d.ts +4 -0
- package/dist/esm/models/share-result-error.d.ts +3 -0
- package/dist/esm/models/share-result-error.js +3 -0
- package/dist/esm/models/violation.d.ts +3 -0
- package/dist/esm/models/violation.js +3 -0
- package/dist/models/access-request-input.d.ts +31 -0
- package/dist/models/access-request-input.js +21 -0
- package/dist/models/access-request-status.d.ts +36 -0
- package/dist/models/access-request-status.js +27 -0
- package/dist/models/enriched-audit-log.d.ts +1 -0
- package/dist/models/enriched-audit-log.js +1 -0
- package/dist/models/index.d.ts +3 -0
- package/dist/models/index.js +3 -0
- package/dist/models/notification-dto.d.ts +3 -0
- package/dist/models/notification-dto.js +3 -0
- package/dist/models/search-by-audit-log-request.d.ts +1 -0
- package/dist/models/search-by-audit-log-request.js +1 -0
- package/dist/models/share-expiry-request.d.ts +25 -0
- package/dist/models/share-expiry-request.js +15 -0
- package/dist/models/share-request.d.ts +4 -0
- package/dist/models/share-result-error.d.ts +3 -0
- package/dist/models/share-result-error.js +3 -0
- package/dist/models/violation.d.ts +3 -0
- package/dist/models/violation.js +3 -0
- package/docs/AccessRequestInput.md +24 -0
- package/docs/AccessRequestStatus.md +26 -0
- package/docs/AccessRequestsApi.md +112 -0
- package/docs/CollaborationControllerApi.md +57 -1
- package/docs/ShareExpiryRequest.md +24 -0
- package/docs/ShareRequest.md +2 -0
- package/graphql/share.graphqls +43 -2
- package/models/access-request-input.ts +40 -0
- package/models/access-request-status.ts +46 -0
- package/models/enriched-audit-log.ts +1 -0
- package/models/index.ts +3 -0
- package/models/notification-dto.ts +3 -0
- package/models/search-by-audit-log-request.ts +1 -0
- package/models/share-expiry-request.ts +31 -0
- package/models/share-request.ts +4 -0
- package/models/share-result-error.ts +3 -0
- package/models/violation.ts +3 -0
- package/package.json +1 -1
package/.openapi-generator/FILES
CHANGED
|
@@ -3,6 +3,7 @@
|
|
|
3
3
|
.openapi-generator-ignore
|
|
4
4
|
README.md
|
|
5
5
|
api.ts
|
|
6
|
+
api/access-requests-api.ts
|
|
6
7
|
api/ai-analytics-admin-controller-api.ts
|
|
7
8
|
api/ai-archiving-admin-controller-api.ts
|
|
8
9
|
api/ai-cloud-usage-admin-controller-api.ts
|
|
@@ -73,6 +74,9 @@ docs/AIMaintenanceApi.md
|
|
|
73
74
|
docs/AISettingsApi.md
|
|
74
75
|
docs/AITaxonomyApi.md
|
|
75
76
|
docs/AITeamInboxesApi.md
|
|
77
|
+
docs/AccessRequestInput.md
|
|
78
|
+
docs/AccessRequestStatus.md
|
|
79
|
+
docs/AccessRequestsApi.md
|
|
76
80
|
docs/AddTeamOwnerRequest.md
|
|
77
81
|
docs/AiAnalyticsAdminControllerApi.md
|
|
78
82
|
docs/AiAnalyticsView.md
|
|
@@ -289,6 +293,7 @@ docs/SearchMetadataRequest.md
|
|
|
289
293
|
docs/SettingDto.md
|
|
290
294
|
docs/Settings.md
|
|
291
295
|
docs/SettingsApi.md
|
|
296
|
+
docs/ShareExpiryRequest.md
|
|
292
297
|
docs/ShareInheritance.md
|
|
293
298
|
docs/ShareInheritanceRequest.md
|
|
294
299
|
docs/ShareRequest.md
|
|
@@ -389,6 +394,8 @@ docs/WorkflowValidationResult.md
|
|
|
389
394
|
docs/WorkflowsApi.md
|
|
390
395
|
git_push.sh
|
|
391
396
|
index.ts
|
|
397
|
+
models/access-request-input.ts
|
|
398
|
+
models/access-request-status.ts
|
|
392
399
|
models/add-team-owner-request.ts
|
|
393
400
|
models/ai-analytics-view.ts
|
|
394
401
|
models/ai-chat-conversation.ts
|
|
@@ -568,6 +575,7 @@ models/search-by-metadata-request.ts
|
|
|
568
575
|
models/search-metadata-request.ts
|
|
569
576
|
models/setting-dto.ts
|
|
570
577
|
models/settings.ts
|
|
578
|
+
models/share-expiry-request.ts
|
|
571
579
|
models/share-inheritance-request.ts
|
|
572
580
|
models/share-inheritance.ts
|
|
573
581
|
models/share-request.ts
|
|
@@ -1 +1 @@
|
|
|
1
|
-
|
|
1
|
+
0f1dd9555c4a1b901e8dc298db0616c09c78ad4c3fa765d9ccdd1cdb0a335937
|
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @openfilz-sdk/typescript-ee@1.14.
|
|
1
|
+
## @openfilz-sdk/typescript-ee@1.14.8
|
|
2
2
|
|
|
3
3
|
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:
|
|
4
4
|
|
|
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
|
|
|
36
36
|
_published:_
|
|
37
37
|
|
|
38
38
|
```
|
|
39
|
-
npm install @openfilz-sdk/typescript-ee@1.14.
|
|
39
|
+
npm install @openfilz-sdk/typescript-ee@1.14.8 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -91,6 +91,8 @@ Class | Method | HTTP request | Description
|
|
|
91
91
|
*AITeamInboxesApi* | [**list3**](docs/AITeamInboxesApi.md#list3) | **GET** /api/v1/admin/ai/team-inboxes | List the team inboxes
|
|
92
92
|
*AITeamInboxesApi* | [**run**](docs/AITeamInboxesApi.md#run) | **POST** /api/v1/admin/ai/team-inboxes/{id}/run | File the inbox now
|
|
93
93
|
*AITeamInboxesApi* | [**update3**](docs/AITeamInboxesApi.md#update3) | **PUT** /api/v1/admin/ai/team-inboxes/{id} | Replace a team inbox
|
|
94
|
+
*AccessRequestsApi* | [**myAccessToDocument**](docs/AccessRequestsApi.md#myaccesstodocument) | **GET** /api/v1/users/me/access-requests/{documentId} | Can I open this document, or ask for it?
|
|
95
|
+
*AccessRequestsApi* | [**requestAccess**](docs/AccessRequestsApi.md#requestaccess) | **POST** /api/v1/users/me/access-requests | Ask the owner for access
|
|
94
96
|
*AiAnalyticsAdminControllerApi* | [**analytics**](docs/AiAnalyticsAdminControllerApi.md#analytics) | **GET** /api/v1/admin/ai/analytics | Tenant-wide AI insights and smart-filing analytics (admin only)
|
|
95
97
|
*AiArchivingAdminControllerApi* | [**create4**](docs/AiArchivingAdminControllerApi.md#create4) | **POST** /api/v1/admin/ai/archiving/schedules | Create an archiving schedule
|
|
96
98
|
*AiArchivingAdminControllerApi* | [**delete3**](docs/AiArchivingAdminControllerApi.md#delete3) | **DELETE** /api/v1/admin/ai/archiving/schedules/{id} | Delete an archiving schedule
|
|
@@ -121,6 +123,7 @@ Class | Method | HTTP request | Description
|
|
|
121
123
|
*CollaborationControllerApi* | [**getUserStatus**](docs/CollaborationControllerApi.md#getuserstatus) | **GET** /api/v1/users/me/status | Check user status
|
|
122
124
|
*CollaborationControllerApi* | [**rejectShareRequest**](docs/CollaborationControllerApi.md#rejectsharerequest) | **DELETE** /api/v1/users/share-requests/{id} | Reject a share request
|
|
123
125
|
*CollaborationControllerApi* | [**removeTeamMembers**](docs/CollaborationControllerApi.md#removeteammembers) | **DELETE** /api/v1/users/teams/{teamId}/members | Remove team members
|
|
126
|
+
*CollaborationControllerApi* | [**updateShareExpiry**](docs/CollaborationControllerApi.md#updateshareexpiry) | **PUT** /api/v1/users/share/expiry | Set, change or remove the end date of share(s)
|
|
124
127
|
*CollaborationControllerApi* | [**updateSharedDocuments**](docs/CollaborationControllerApi.md#updateshareddocuments) | **PUT** /api/v1/users/share | Update Share for document(s)
|
|
125
128
|
*CollaborationControllerApi* | [**updateTeam**](docs/CollaborationControllerApi.md#updateteam) | **PUT** /api/v1/users/teams/{teamId} | Update a team
|
|
126
129
|
*CollaborationControllerApi* | [**updateUser**](docs/CollaborationControllerApi.md#updateuser) | **PUT** /api/v1/users/{userId} | Update a user
|
|
@@ -370,6 +373,8 @@ Class | Method | HTTP request | Description
|
|
|
370
373
|
|
|
371
374
|
### Documentation For Models
|
|
372
375
|
|
|
376
|
+
- [AccessRequestInput](docs/AccessRequestInput.md)
|
|
377
|
+
- [AccessRequestStatus](docs/AccessRequestStatus.md)
|
|
373
378
|
- [AddTeamOwnerRequest](docs/AddTeamOwnerRequest.md)
|
|
374
379
|
- [AiAnalyticsView](docs/AiAnalyticsView.md)
|
|
375
380
|
- [AiChatConversation](docs/AiChatConversation.md)
|
|
@@ -548,6 +553,7 @@ Class | Method | HTTP request | Description
|
|
|
548
553
|
- [SearchMetadataRequest](docs/SearchMetadataRequest.md)
|
|
549
554
|
- [SettingDto](docs/SettingDto.md)
|
|
550
555
|
- [Settings](docs/Settings.md)
|
|
556
|
+
- [ShareExpiryRequest](docs/ShareExpiryRequest.md)
|
|
551
557
|
- [ShareInheritance](docs/ShareInheritance.md)
|
|
552
558
|
- [ShareInheritanceRequest](docs/ShareInheritanceRequest.md)
|
|
553
559
|
- [ShareRequest](docs/ShareRequest.md)
|
|
@@ -0,0 +1,203 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* openfilz-api
|
|
5
|
+
* API for Document Management System
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
import type { Configuration } from '../configuration';
|
|
17
|
+
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
18
|
+
import globalAxios from 'axios';
|
|
19
|
+
// Some imports not used depending on template conditions
|
|
20
|
+
// @ts-ignore
|
|
21
|
+
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction, replaceWithSerializableTypeIfNeeded } from '../common';
|
|
22
|
+
// @ts-ignore
|
|
23
|
+
import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
|
|
24
|
+
// @ts-ignore
|
|
25
|
+
import type { AccessRequestInput } from '../models';
|
|
26
|
+
// @ts-ignore
|
|
27
|
+
import type { AccessRequestStatus } from '../models';
|
|
28
|
+
/**
|
|
29
|
+
* AccessRequestsApi - axios parameter creator
|
|
30
|
+
*/
|
|
31
|
+
export const AccessRequestsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
32
|
+
return {
|
|
33
|
+
/**
|
|
34
|
+
* HAS_ACCESS, PENDING (asked, not answered), NO_ACCESS, or OWNER_CANNOT_SHARE (the owner may not share documents, so a request would reach nobody). 404 when the document does not exist or is in the recycle bin; never returns its name or owner. 429 past the hourly limit.
|
|
35
|
+
* @summary Can I open this document, or ask for it?
|
|
36
|
+
* @param {string} documentId
|
|
37
|
+
* @param {*} [options] Override http request option.
|
|
38
|
+
* @throws {RequiredError}
|
|
39
|
+
*/
|
|
40
|
+
myAccessToDocument: async (documentId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
41
|
+
// verify required parameter 'documentId' is not null or undefined
|
|
42
|
+
assertParamExists('myAccessToDocument', 'documentId', documentId)
|
|
43
|
+
const localVarPath = `/api/v1/users/me/access-requests/{documentId}`
|
|
44
|
+
.replace('{documentId}', encodeURIComponent(String(documentId)));
|
|
45
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
46
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
47
|
+
let baseOptions;
|
|
48
|
+
if (configuration) {
|
|
49
|
+
baseOptions = configuration.baseOptions;
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
53
|
+
const localVarHeaderParameter = {} as any;
|
|
54
|
+
const localVarQueryParameter = {} as any;
|
|
55
|
+
|
|
56
|
+
// authentication keycloak_auth required
|
|
57
|
+
// http bearer authentication required
|
|
58
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
59
|
+
|
|
60
|
+
localVarHeaderParameter['Accept'] = '*/*';
|
|
61
|
+
|
|
62
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
63
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
64
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
65
|
+
|
|
66
|
+
return {
|
|
67
|
+
url: toPathString(localVarUrlObj),
|
|
68
|
+
options: localVarRequestOptions,
|
|
69
|
+
};
|
|
70
|
+
},
|
|
71
|
+
/**
|
|
72
|
+
* Creates a share request to the owner, who answers it on Share requests (bell + e-mail). Asking again for the same access within a day does not notify the owner again. 404 no such document; 409 ACCESS_ALREADY_GRANTED, OWNER_CANNOT_SHARE, or a SHARE_ERR_* code when the owner could not grant it (licence for the mode, sharing policy); 429 ACCESS_REQUEST_RATE_LIMITED.
|
|
73
|
+
* @summary Ask the owner for access
|
|
74
|
+
* @param {AccessRequestInput} accessRequestInput
|
|
75
|
+
* @param {*} [options] Override http request option.
|
|
76
|
+
* @throws {RequiredError}
|
|
77
|
+
*/
|
|
78
|
+
requestAccess: async (accessRequestInput: AccessRequestInput, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
79
|
+
// verify required parameter 'accessRequestInput' is not null or undefined
|
|
80
|
+
assertParamExists('requestAccess', 'accessRequestInput', accessRequestInput)
|
|
81
|
+
const localVarPath = `/api/v1/users/me/access-requests`;
|
|
82
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
83
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
84
|
+
let baseOptions;
|
|
85
|
+
if (configuration) {
|
|
86
|
+
baseOptions = configuration.baseOptions;
|
|
87
|
+
}
|
|
88
|
+
|
|
89
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
90
|
+
const localVarHeaderParameter = {} as any;
|
|
91
|
+
const localVarQueryParameter = {} as any;
|
|
92
|
+
|
|
93
|
+
// authentication keycloak_auth required
|
|
94
|
+
// http bearer authentication required
|
|
95
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
96
|
+
|
|
97
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
98
|
+
localVarHeaderParameter['Accept'] = '*/*';
|
|
99
|
+
|
|
100
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
101
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
102
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
103
|
+
localVarRequestOptions.data = serializeDataIfNeeded(accessRequestInput, localVarRequestOptions, configuration)
|
|
104
|
+
|
|
105
|
+
return {
|
|
106
|
+
url: toPathString(localVarUrlObj),
|
|
107
|
+
options: localVarRequestOptions,
|
|
108
|
+
};
|
|
109
|
+
},
|
|
110
|
+
}
|
|
111
|
+
};
|
|
112
|
+
|
|
113
|
+
/**
|
|
114
|
+
* AccessRequestsApi - functional programming interface
|
|
115
|
+
*/
|
|
116
|
+
export const AccessRequestsApiFp = function(configuration?: Configuration) {
|
|
117
|
+
const localVarAxiosParamCreator = AccessRequestsApiAxiosParamCreator(configuration)
|
|
118
|
+
return {
|
|
119
|
+
/**
|
|
120
|
+
* HAS_ACCESS, PENDING (asked, not answered), NO_ACCESS, or OWNER_CANNOT_SHARE (the owner may not share documents, so a request would reach nobody). 404 when the document does not exist or is in the recycle bin; never returns its name or owner. 429 past the hourly limit.
|
|
121
|
+
* @summary Can I open this document, or ask for it?
|
|
122
|
+
* @param {string} documentId
|
|
123
|
+
* @param {*} [options] Override http request option.
|
|
124
|
+
* @throws {RequiredError}
|
|
125
|
+
*/
|
|
126
|
+
async myAccessToDocument(documentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccessRequestStatus>> {
|
|
127
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.myAccessToDocument(documentId, options);
|
|
128
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
129
|
+
const localVarOperationServerBasePath = operationServerMap['AccessRequestsApi.myAccessToDocument']?.[localVarOperationServerIndex]?.url;
|
|
130
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
131
|
+
},
|
|
132
|
+
/**
|
|
133
|
+
* Creates a share request to the owner, who answers it on Share requests (bell + e-mail). Asking again for the same access within a day does not notify the owner again. 404 no such document; 409 ACCESS_ALREADY_GRANTED, OWNER_CANNOT_SHARE, or a SHARE_ERR_* code when the owner could not grant it (licence for the mode, sharing policy); 429 ACCESS_REQUEST_RATE_LIMITED.
|
|
134
|
+
* @summary Ask the owner for access
|
|
135
|
+
* @param {AccessRequestInput} accessRequestInput
|
|
136
|
+
* @param {*} [options] Override http request option.
|
|
137
|
+
* @throws {RequiredError}
|
|
138
|
+
*/
|
|
139
|
+
async requestAccess(accessRequestInput: AccessRequestInput, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccessRequestStatus>> {
|
|
140
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.requestAccess(accessRequestInput, options);
|
|
141
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
142
|
+
const localVarOperationServerBasePath = operationServerMap['AccessRequestsApi.requestAccess']?.[localVarOperationServerIndex]?.url;
|
|
143
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
144
|
+
},
|
|
145
|
+
}
|
|
146
|
+
};
|
|
147
|
+
|
|
148
|
+
/**
|
|
149
|
+
* AccessRequestsApi - factory interface
|
|
150
|
+
*/
|
|
151
|
+
export const AccessRequestsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
152
|
+
const localVarFp = AccessRequestsApiFp(configuration)
|
|
153
|
+
return {
|
|
154
|
+
/**
|
|
155
|
+
* HAS_ACCESS, PENDING (asked, not answered), NO_ACCESS, or OWNER_CANNOT_SHARE (the owner may not share documents, so a request would reach nobody). 404 when the document does not exist or is in the recycle bin; never returns its name or owner. 429 past the hourly limit.
|
|
156
|
+
* @summary Can I open this document, or ask for it?
|
|
157
|
+
* @param {string} documentId
|
|
158
|
+
* @param {*} [options] Override http request option.
|
|
159
|
+
* @throws {RequiredError}
|
|
160
|
+
*/
|
|
161
|
+
myAccessToDocument(documentId: string, options?: RawAxiosRequestConfig): AxiosPromise<AccessRequestStatus> {
|
|
162
|
+
return localVarFp.myAccessToDocument(documentId, options).then((request) => request(axios, basePath));
|
|
163
|
+
},
|
|
164
|
+
/**
|
|
165
|
+
* Creates a share request to the owner, who answers it on Share requests (bell + e-mail). Asking again for the same access within a day does not notify the owner again. 404 no such document; 409 ACCESS_ALREADY_GRANTED, OWNER_CANNOT_SHARE, or a SHARE_ERR_* code when the owner could not grant it (licence for the mode, sharing policy); 429 ACCESS_REQUEST_RATE_LIMITED.
|
|
166
|
+
* @summary Ask the owner for access
|
|
167
|
+
* @param {AccessRequestInput} accessRequestInput
|
|
168
|
+
* @param {*} [options] Override http request option.
|
|
169
|
+
* @throws {RequiredError}
|
|
170
|
+
*/
|
|
171
|
+
requestAccess(accessRequestInput: AccessRequestInput, options?: RawAxiosRequestConfig): AxiosPromise<AccessRequestStatus> {
|
|
172
|
+
return localVarFp.requestAccess(accessRequestInput, options).then((request) => request(axios, basePath));
|
|
173
|
+
},
|
|
174
|
+
};
|
|
175
|
+
};
|
|
176
|
+
|
|
177
|
+
/**
|
|
178
|
+
* AccessRequestsApi - object-oriented interface
|
|
179
|
+
*/
|
|
180
|
+
export class AccessRequestsApi extends BaseAPI {
|
|
181
|
+
/**
|
|
182
|
+
* HAS_ACCESS, PENDING (asked, not answered), NO_ACCESS, or OWNER_CANNOT_SHARE (the owner may not share documents, so a request would reach nobody). 404 when the document does not exist or is in the recycle bin; never returns its name or owner. 429 past the hourly limit.
|
|
183
|
+
* @summary Can I open this document, or ask for it?
|
|
184
|
+
* @param {string} documentId
|
|
185
|
+
* @param {*} [options] Override http request option.
|
|
186
|
+
* @throws {RequiredError}
|
|
187
|
+
*/
|
|
188
|
+
public myAccessToDocument(documentId: string, options?: RawAxiosRequestConfig) {
|
|
189
|
+
return AccessRequestsApiFp(this.configuration).myAccessToDocument(documentId, options).then((request) => request(this.axios, this.basePath));
|
|
190
|
+
}
|
|
191
|
+
|
|
192
|
+
/**
|
|
193
|
+
* Creates a share request to the owner, who answers it on Share requests (bell + e-mail). Asking again for the same access within a day does not notify the owner again. 404 no such document; 409 ACCESS_ALREADY_GRANTED, OWNER_CANNOT_SHARE, or a SHARE_ERR_* code when the owner could not grant it (licence for the mode, sharing policy); 429 ACCESS_REQUEST_RATE_LIMITED.
|
|
194
|
+
* @summary Ask the owner for access
|
|
195
|
+
* @param {AccessRequestInput} accessRequestInput
|
|
196
|
+
* @param {*} [options] Override http request option.
|
|
197
|
+
* @throws {RequiredError}
|
|
198
|
+
*/
|
|
199
|
+
public requestAccess(accessRequestInput: AccessRequestInput, options?: RawAxiosRequestConfig) {
|
|
200
|
+
return AccessRequestsApiFp(this.configuration).requestAccess(accessRequestInput, options).then((request) => request(this.axios, this.basePath));
|
|
201
|
+
}
|
|
202
|
+
}
|
|
203
|
+
|
|
@@ -26,6 +26,8 @@ import type { CreateTeamRequest } from '../models';
|
|
|
26
26
|
// @ts-ignore
|
|
27
27
|
import type { DeleteShareRequest } from '../models';
|
|
28
28
|
// @ts-ignore
|
|
29
|
+
import type { ShareExpiryRequest } from '../models';
|
|
30
|
+
// @ts-ignore
|
|
29
31
|
import type { ShareRequest } from '../models';
|
|
30
32
|
// @ts-ignore
|
|
31
33
|
import type { ShareResultResponse } from '../models';
|
|
@@ -123,7 +125,7 @@ export const CollaborationControllerApiAxiosParamCreator = function (configurati
|
|
|
123
125
|
};
|
|
124
126
|
},
|
|
125
127
|
/**
|
|
126
|
-
* Creates new Shared document(s) with users. Returns 200 when all items are processed successfully. Returns 207 when there is a mix of successes, share requests, and/or errors. Error codes in response: - SHARE_ERR_USER_DEACTIVATED: Cannot share with a deactivated user in read-only mode - SHARE_ERR_USER_NOT_LICENSED: User must have a license to be shared with in editor or commenter mode - SHARE_ERR_PARENT_AND_CHILD: A folder and its children cannot both be in the share list - SHARE_ERR_ALREADY_EXISTS: A share already exists for this document and user
|
|
128
|
+
* Creates new Shared document(s) with users. Returns 200 when all items are processed successfully. Returns 207 when there is a mix of successes, share requests, and/or errors. Error codes in response: - SHARE_ERR_USER_DEACTIVATED: Cannot share with a deactivated user in read-only mode - SHARE_ERR_USER_NOT_LICENSED: User must have a license to be shared with in editor or commenter mode - SHARE_ERR_PARENT_AND_CHILD: A folder and its children cannot both be in the share list - SHARE_ERR_ALREADY_EXISTS: A share already exists for this document and user Optional `expiresAt` (ISO-8601 instant): the recipients lose access on that date. A date that is not in the future is refused with 400.
|
|
127
129
|
* @summary Create Share for document(s)
|
|
128
130
|
* @param {ShareRequest} shareRequest
|
|
129
131
|
* @param {*} [options] Override http request option.
|
|
@@ -502,6 +504,45 @@ export const CollaborationControllerApiAxiosParamCreator = function (configurati
|
|
|
502
504
|
options: localVarRequestOptions,
|
|
503
505
|
};
|
|
504
506
|
},
|
|
507
|
+
/**
|
|
508
|
+
* Sets the end of access of existing shares, `expiresAt: null` = no end. Only on shares granted on the documents themselves, by their owner (or a SHARE_ADMIN). Returns 200 when all items are processed successfully, 207 otherwise. Error codes in response: - SHARE_ERR_NOT_ALREADY_SHARED: No existing share found for this document and user - SHARE_ERR_INHERITED_SHARE: The share comes from a folder: change the date on the folder - SHARE_ERR_OWNER_ONLY: Only the document\'s owner changes the end date - SHARE_ERR_DOCUMENT_NOT_FOUND: The caller cannot see this document
|
|
509
|
+
* @summary Set, change or remove the end date of share(s)
|
|
510
|
+
* @param {ShareExpiryRequest} shareExpiryRequest
|
|
511
|
+
* @param {*} [options] Override http request option.
|
|
512
|
+
* @throws {RequiredError}
|
|
513
|
+
*/
|
|
514
|
+
updateShareExpiry: async (shareExpiryRequest: ShareExpiryRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
515
|
+
// verify required parameter 'shareExpiryRequest' is not null or undefined
|
|
516
|
+
assertParamExists('updateShareExpiry', 'shareExpiryRequest', shareExpiryRequest)
|
|
517
|
+
const localVarPath = `/api/v1/users/share/expiry`;
|
|
518
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
519
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
520
|
+
let baseOptions;
|
|
521
|
+
if (configuration) {
|
|
522
|
+
baseOptions = configuration.baseOptions;
|
|
523
|
+
}
|
|
524
|
+
|
|
525
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
|
|
526
|
+
const localVarHeaderParameter = {} as any;
|
|
527
|
+
const localVarQueryParameter = {} as any;
|
|
528
|
+
|
|
529
|
+
// authentication keycloak_auth required
|
|
530
|
+
// http bearer authentication required
|
|
531
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
532
|
+
|
|
533
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
534
|
+
localVarHeaderParameter['Accept'] = '*/*';
|
|
535
|
+
|
|
536
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
537
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
538
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
539
|
+
localVarRequestOptions.data = serializeDataIfNeeded(shareExpiryRequest, localVarRequestOptions, configuration)
|
|
540
|
+
|
|
541
|
+
return {
|
|
542
|
+
url: toPathString(localVarUrlObj),
|
|
543
|
+
options: localVarRequestOptions,
|
|
544
|
+
};
|
|
545
|
+
},
|
|
505
546
|
/**
|
|
506
547
|
* Updates existing Shared document(s) with users. Returns 200 when all items are processed successfully. Returns 207 when there is a mix of successes, share requests, and/or errors. Error codes in response: - SHARE_ERR_USER_DEACTIVATED: Cannot share with a deactivated user in read-only mode - SHARE_ERR_USER_NOT_LICENSED: User must have a license to be shared with in editor or commenter mode - SHARE_ERR_PARENT_AND_CHILD: A folder and its children cannot both be in the share list - SHARE_ERR_NOT_ALREADY_SHARED: No existing share found for this document and user
|
|
507
548
|
* @summary Update Share for document(s)
|
|
@@ -662,7 +703,7 @@ export const CollaborationControllerApiFp = function(configuration?: Configurati
|
|
|
662
703
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
663
704
|
},
|
|
664
705
|
/**
|
|
665
|
-
* Creates new Shared document(s) with users. Returns 200 when all items are processed successfully. Returns 207 when there is a mix of successes, share requests, and/or errors. Error codes in response: - SHARE_ERR_USER_DEACTIVATED: Cannot share with a deactivated user in read-only mode - SHARE_ERR_USER_NOT_LICENSED: User must have a license to be shared with in editor or commenter mode - SHARE_ERR_PARENT_AND_CHILD: A folder and its children cannot both be in the share list - SHARE_ERR_ALREADY_EXISTS: A share already exists for this document and user
|
|
706
|
+
* Creates new Shared document(s) with users. Returns 200 when all items are processed successfully. Returns 207 when there is a mix of successes, share requests, and/or errors. Error codes in response: - SHARE_ERR_USER_DEACTIVATED: Cannot share with a deactivated user in read-only mode - SHARE_ERR_USER_NOT_LICENSED: User must have a license to be shared with in editor or commenter mode - SHARE_ERR_PARENT_AND_CHILD: A folder and its children cannot both be in the share list - SHARE_ERR_ALREADY_EXISTS: A share already exists for this document and user Optional `expiresAt` (ISO-8601 instant): the recipients lose access on that date. A date that is not in the future is refused with 400.
|
|
666
707
|
* @summary Create Share for document(s)
|
|
667
708
|
* @param {ShareRequest} shareRequest
|
|
668
709
|
* @param {*} [options] Override http request option.
|
|
@@ -791,6 +832,19 @@ export const CollaborationControllerApiFp = function(configuration?: Configurati
|
|
|
791
832
|
const localVarOperationServerBasePath = operationServerMap['CollaborationControllerApi.removeTeamMembers']?.[localVarOperationServerIndex]?.url;
|
|
792
833
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
793
834
|
},
|
|
835
|
+
/**
|
|
836
|
+
* Sets the end of access of existing shares, `expiresAt: null` = no end. Only on shares granted on the documents themselves, by their owner (or a SHARE_ADMIN). Returns 200 when all items are processed successfully, 207 otherwise. Error codes in response: - SHARE_ERR_NOT_ALREADY_SHARED: No existing share found for this document and user - SHARE_ERR_INHERITED_SHARE: The share comes from a folder: change the date on the folder - SHARE_ERR_OWNER_ONLY: Only the document\'s owner changes the end date - SHARE_ERR_DOCUMENT_NOT_FOUND: The caller cannot see this document
|
|
837
|
+
* @summary Set, change or remove the end date of share(s)
|
|
838
|
+
* @param {ShareExpiryRequest} shareExpiryRequest
|
|
839
|
+
* @param {*} [options] Override http request option.
|
|
840
|
+
* @throws {RequiredError}
|
|
841
|
+
*/
|
|
842
|
+
async updateShareExpiry(shareExpiryRequest: ShareExpiryRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShareResultResponse>> {
|
|
843
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.updateShareExpiry(shareExpiryRequest, options);
|
|
844
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
845
|
+
const localVarOperationServerBasePath = operationServerMap['CollaborationControllerApi.updateShareExpiry']?.[localVarOperationServerIndex]?.url;
|
|
846
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
847
|
+
},
|
|
794
848
|
/**
|
|
795
849
|
* Updates existing Shared document(s) with users. Returns 200 when all items are processed successfully. Returns 207 when there is a mix of successes, share requests, and/or errors. Error codes in response: - SHARE_ERR_USER_DEACTIVATED: Cannot share with a deactivated user in read-only mode - SHARE_ERR_USER_NOT_LICENSED: User must have a license to be shared with in editor or commenter mode - SHARE_ERR_PARENT_AND_CHILD: A folder and its children cannot both be in the share list - SHARE_ERR_NOT_ALREADY_SHARED: No existing share found for this document and user
|
|
796
850
|
* @summary Update Share for document(s)
|
|
@@ -863,7 +917,7 @@ export const CollaborationControllerApiFactory = function (configuration?: Confi
|
|
|
863
917
|
return localVarFp.addTeamMembers(teamId, requestBody, options).then((request) => request(axios, basePath));
|
|
864
918
|
},
|
|
865
919
|
/**
|
|
866
|
-
* Creates new Shared document(s) with users. Returns 200 when all items are processed successfully. Returns 207 when there is a mix of successes, share requests, and/or errors. Error codes in response: - SHARE_ERR_USER_DEACTIVATED: Cannot share with a deactivated user in read-only mode - SHARE_ERR_USER_NOT_LICENSED: User must have a license to be shared with in editor or commenter mode - SHARE_ERR_PARENT_AND_CHILD: A folder and its children cannot both be in the share list - SHARE_ERR_ALREADY_EXISTS: A share already exists for this document and user
|
|
920
|
+
* Creates new Shared document(s) with users. Returns 200 when all items are processed successfully. Returns 207 when there is a mix of successes, share requests, and/or errors. Error codes in response: - SHARE_ERR_USER_DEACTIVATED: Cannot share with a deactivated user in read-only mode - SHARE_ERR_USER_NOT_LICENSED: User must have a license to be shared with in editor or commenter mode - SHARE_ERR_PARENT_AND_CHILD: A folder and its children cannot both be in the share list - SHARE_ERR_ALREADY_EXISTS: A share already exists for this document and user Optional `expiresAt` (ISO-8601 instant): the recipients lose access on that date. A date that is not in the future is refused with 400.
|
|
867
921
|
* @summary Create Share for document(s)
|
|
868
922
|
* @param {ShareRequest} shareRequest
|
|
869
923
|
* @param {*} [options] Override http request option.
|
|
@@ -962,6 +1016,16 @@ export const CollaborationControllerApiFactory = function (configuration?: Confi
|
|
|
962
1016
|
removeTeamMembers(teamId: string, requestBody: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
963
1017
|
return localVarFp.removeTeamMembers(teamId, requestBody, options).then((request) => request(axios, basePath));
|
|
964
1018
|
},
|
|
1019
|
+
/**
|
|
1020
|
+
* Sets the end of access of existing shares, `expiresAt: null` = no end. Only on shares granted on the documents themselves, by their owner (or a SHARE_ADMIN). Returns 200 when all items are processed successfully, 207 otherwise. Error codes in response: - SHARE_ERR_NOT_ALREADY_SHARED: No existing share found for this document and user - SHARE_ERR_INHERITED_SHARE: The share comes from a folder: change the date on the folder - SHARE_ERR_OWNER_ONLY: Only the document\'s owner changes the end date - SHARE_ERR_DOCUMENT_NOT_FOUND: The caller cannot see this document
|
|
1021
|
+
* @summary Set, change or remove the end date of share(s)
|
|
1022
|
+
* @param {ShareExpiryRequest} shareExpiryRequest
|
|
1023
|
+
* @param {*} [options] Override http request option.
|
|
1024
|
+
* @throws {RequiredError}
|
|
1025
|
+
*/
|
|
1026
|
+
updateShareExpiry(shareExpiryRequest: ShareExpiryRequest, options?: RawAxiosRequestConfig): AxiosPromise<ShareResultResponse> {
|
|
1027
|
+
return localVarFp.updateShareExpiry(shareExpiryRequest, options).then((request) => request(axios, basePath));
|
|
1028
|
+
},
|
|
965
1029
|
/**
|
|
966
1030
|
* Updates existing Shared document(s) with users. Returns 200 when all items are processed successfully. Returns 207 when there is a mix of successes, share requests, and/or errors. Error codes in response: - SHARE_ERR_USER_DEACTIVATED: Cannot share with a deactivated user in read-only mode - SHARE_ERR_USER_NOT_LICENSED: User must have a license to be shared with in editor or commenter mode - SHARE_ERR_PARENT_AND_CHILD: A folder and its children cannot both be in the share list - SHARE_ERR_NOT_ALREADY_SHARED: No existing share found for this document and user
|
|
967
1031
|
* @summary Update Share for document(s)
|
|
@@ -1025,7 +1089,7 @@ export class CollaborationControllerApi extends BaseAPI {
|
|
|
1025
1089
|
}
|
|
1026
1090
|
|
|
1027
1091
|
/**
|
|
1028
|
-
* Creates new Shared document(s) with users. Returns 200 when all items are processed successfully. Returns 207 when there is a mix of successes, share requests, and/or errors. Error codes in response: - SHARE_ERR_USER_DEACTIVATED: Cannot share with a deactivated user in read-only mode - SHARE_ERR_USER_NOT_LICENSED: User must have a license to be shared with in editor or commenter mode - SHARE_ERR_PARENT_AND_CHILD: A folder and its children cannot both be in the share list - SHARE_ERR_ALREADY_EXISTS: A share already exists for this document and user
|
|
1092
|
+
* Creates new Shared document(s) with users. Returns 200 when all items are processed successfully. Returns 207 when there is a mix of successes, share requests, and/or errors. Error codes in response: - SHARE_ERR_USER_DEACTIVATED: Cannot share with a deactivated user in read-only mode - SHARE_ERR_USER_NOT_LICENSED: User must have a license to be shared with in editor or commenter mode - SHARE_ERR_PARENT_AND_CHILD: A folder and its children cannot both be in the share list - SHARE_ERR_ALREADY_EXISTS: A share already exists for this document and user Optional `expiresAt` (ISO-8601 instant): the recipients lose access on that date. A date that is not in the future is refused with 400.
|
|
1029
1093
|
* @summary Create Share for document(s)
|
|
1030
1094
|
* @param {ShareRequest} shareRequest
|
|
1031
1095
|
* @param {*} [options] Override http request option.
|
|
@@ -1134,6 +1198,17 @@ export class CollaborationControllerApi extends BaseAPI {
|
|
|
1134
1198
|
return CollaborationControllerApiFp(this.configuration).removeTeamMembers(teamId, requestBody, options).then((request) => request(this.axios, this.basePath));
|
|
1135
1199
|
}
|
|
1136
1200
|
|
|
1201
|
+
/**
|
|
1202
|
+
* Sets the end of access of existing shares, `expiresAt: null` = no end. Only on shares granted on the documents themselves, by their owner (or a SHARE_ADMIN). Returns 200 when all items are processed successfully, 207 otherwise. Error codes in response: - SHARE_ERR_NOT_ALREADY_SHARED: No existing share found for this document and user - SHARE_ERR_INHERITED_SHARE: The share comes from a folder: change the date on the folder - SHARE_ERR_OWNER_ONLY: Only the document\'s owner changes the end date - SHARE_ERR_DOCUMENT_NOT_FOUND: The caller cannot see this document
|
|
1203
|
+
* @summary Set, change or remove the end date of share(s)
|
|
1204
|
+
* @param {ShareExpiryRequest} shareExpiryRequest
|
|
1205
|
+
* @param {*} [options] Override http request option.
|
|
1206
|
+
* @throws {RequiredError}
|
|
1207
|
+
*/
|
|
1208
|
+
public updateShareExpiry(shareExpiryRequest: ShareExpiryRequest, options?: RawAxiosRequestConfig) {
|
|
1209
|
+
return CollaborationControllerApiFp(this.configuration).updateShareExpiry(shareExpiryRequest, options).then((request) => request(this.axios, this.basePath));
|
|
1210
|
+
}
|
|
1211
|
+
|
|
1137
1212
|
/**
|
|
1138
1213
|
* Updates existing Shared document(s) with users. Returns 200 when all items are processed successfully. Returns 207 when there is a mix of successes, share requests, and/or errors. Error codes in response: - SHARE_ERR_USER_DEACTIVATED: Cannot share with a deactivated user in read-only mode - SHARE_ERR_USER_NOT_LICENSED: User must have a license to be shared with in editor or commenter mode - SHARE_ERR_PARENT_AND_CHILD: A folder and its children cannot both be in the share list - SHARE_ERR_NOT_ALREADY_SHARED: No existing share found for this document and user
|
|
1139
1214
|
* @summary Update Share for document(s)
|
package/api.ts
CHANGED
|
@@ -23,6 +23,7 @@ export * from './api/aimaintenance-api';
|
|
|
23
23
|
export * from './api/aisettings-api';
|
|
24
24
|
export * from './api/aitaxonomy-api';
|
|
25
25
|
export * from './api/aiteam-inboxes-api';
|
|
26
|
+
export * from './api/access-requests-api';
|
|
26
27
|
export * from './api/ai-analytics-admin-controller-api';
|
|
27
28
|
export * from './api/ai-archiving-admin-controller-api';
|
|
28
29
|
export * from './api/ai-cloud-usage-admin-controller-api';
|
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* openfilz-api
|
|
3
|
+
* API for Document Management System
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { Configuration } from '../configuration';
|
|
13
|
+
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
14
|
+
import { type RequestArgs, BaseAPI } from '../base';
|
|
15
|
+
import type { AccessRequestInput } from '../models';
|
|
16
|
+
import type { AccessRequestStatus } from '../models';
|
|
17
|
+
/**
|
|
18
|
+
* AccessRequestsApi - axios parameter creator
|
|
19
|
+
*/
|
|
20
|
+
export declare const AccessRequestsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
21
|
+
/**
|
|
22
|
+
* HAS_ACCESS, PENDING (asked, not answered), NO_ACCESS, or OWNER_CANNOT_SHARE (the owner may not share documents, so a request would reach nobody). 404 when the document does not exist or is in the recycle bin; never returns its name or owner. 429 past the hourly limit.
|
|
23
|
+
* @summary Can I open this document, or ask for it?
|
|
24
|
+
* @param {string} documentId
|
|
25
|
+
* @param {*} [options] Override http request option.
|
|
26
|
+
* @throws {RequiredError}
|
|
27
|
+
*/
|
|
28
|
+
myAccessToDocument: (documentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
29
|
+
/**
|
|
30
|
+
* Creates a share request to the owner, who answers it on Share requests (bell + e-mail). Asking again for the same access within a day does not notify the owner again. 404 no such document; 409 ACCESS_ALREADY_GRANTED, OWNER_CANNOT_SHARE, or a SHARE_ERR_* code when the owner could not grant it (licence for the mode, sharing policy); 429 ACCESS_REQUEST_RATE_LIMITED.
|
|
31
|
+
* @summary Ask the owner for access
|
|
32
|
+
* @param {AccessRequestInput} accessRequestInput
|
|
33
|
+
* @param {*} [options] Override http request option.
|
|
34
|
+
* @throws {RequiredError}
|
|
35
|
+
*/
|
|
36
|
+
requestAccess: (accessRequestInput: AccessRequestInput, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
37
|
+
};
|
|
38
|
+
/**
|
|
39
|
+
* AccessRequestsApi - functional programming interface
|
|
40
|
+
*/
|
|
41
|
+
export declare const AccessRequestsApiFp: (configuration?: Configuration) => {
|
|
42
|
+
/**
|
|
43
|
+
* HAS_ACCESS, PENDING (asked, not answered), NO_ACCESS, or OWNER_CANNOT_SHARE (the owner may not share documents, so a request would reach nobody). 404 when the document does not exist or is in the recycle bin; never returns its name or owner. 429 past the hourly limit.
|
|
44
|
+
* @summary Can I open this document, or ask for it?
|
|
45
|
+
* @param {string} documentId
|
|
46
|
+
* @param {*} [options] Override http request option.
|
|
47
|
+
* @throws {RequiredError}
|
|
48
|
+
*/
|
|
49
|
+
myAccessToDocument(documentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccessRequestStatus>>;
|
|
50
|
+
/**
|
|
51
|
+
* Creates a share request to the owner, who answers it on Share requests (bell + e-mail). Asking again for the same access within a day does not notify the owner again. 404 no such document; 409 ACCESS_ALREADY_GRANTED, OWNER_CANNOT_SHARE, or a SHARE_ERR_* code when the owner could not grant it (licence for the mode, sharing policy); 429 ACCESS_REQUEST_RATE_LIMITED.
|
|
52
|
+
* @summary Ask the owner for access
|
|
53
|
+
* @param {AccessRequestInput} accessRequestInput
|
|
54
|
+
* @param {*} [options] Override http request option.
|
|
55
|
+
* @throws {RequiredError}
|
|
56
|
+
*/
|
|
57
|
+
requestAccess(accessRequestInput: AccessRequestInput, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccessRequestStatus>>;
|
|
58
|
+
};
|
|
59
|
+
/**
|
|
60
|
+
* AccessRequestsApi - factory interface
|
|
61
|
+
*/
|
|
62
|
+
export declare const AccessRequestsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
63
|
+
/**
|
|
64
|
+
* HAS_ACCESS, PENDING (asked, not answered), NO_ACCESS, or OWNER_CANNOT_SHARE (the owner may not share documents, so a request would reach nobody). 404 when the document does not exist or is in the recycle bin; never returns its name or owner. 429 past the hourly limit.
|
|
65
|
+
* @summary Can I open this document, or ask for it?
|
|
66
|
+
* @param {string} documentId
|
|
67
|
+
* @param {*} [options] Override http request option.
|
|
68
|
+
* @throws {RequiredError}
|
|
69
|
+
*/
|
|
70
|
+
myAccessToDocument(documentId: string, options?: RawAxiosRequestConfig): AxiosPromise<AccessRequestStatus>;
|
|
71
|
+
/**
|
|
72
|
+
* Creates a share request to the owner, who answers it on Share requests (bell + e-mail). Asking again for the same access within a day does not notify the owner again. 404 no such document; 409 ACCESS_ALREADY_GRANTED, OWNER_CANNOT_SHARE, or a SHARE_ERR_* code when the owner could not grant it (licence for the mode, sharing policy); 429 ACCESS_REQUEST_RATE_LIMITED.
|
|
73
|
+
* @summary Ask the owner for access
|
|
74
|
+
* @param {AccessRequestInput} accessRequestInput
|
|
75
|
+
* @param {*} [options] Override http request option.
|
|
76
|
+
* @throws {RequiredError}
|
|
77
|
+
*/
|
|
78
|
+
requestAccess(accessRequestInput: AccessRequestInput, options?: RawAxiosRequestConfig): AxiosPromise<AccessRequestStatus>;
|
|
79
|
+
};
|
|
80
|
+
/**
|
|
81
|
+
* AccessRequestsApi - object-oriented interface
|
|
82
|
+
*/
|
|
83
|
+
export declare class AccessRequestsApi extends BaseAPI {
|
|
84
|
+
/**
|
|
85
|
+
* HAS_ACCESS, PENDING (asked, not answered), NO_ACCESS, or OWNER_CANNOT_SHARE (the owner may not share documents, so a request would reach nobody). 404 when the document does not exist or is in the recycle bin; never returns its name or owner. 429 past the hourly limit.
|
|
86
|
+
* @summary Can I open this document, or ask for it?
|
|
87
|
+
* @param {string} documentId
|
|
88
|
+
* @param {*} [options] Override http request option.
|
|
89
|
+
* @throws {RequiredError}
|
|
90
|
+
*/
|
|
91
|
+
myAccessToDocument(documentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AccessRequestStatus, any, {}, any>>;
|
|
92
|
+
/**
|
|
93
|
+
* Creates a share request to the owner, who answers it on Share requests (bell + e-mail). Asking again for the same access within a day does not notify the owner again. 404 no such document; 409 ACCESS_ALREADY_GRANTED, OWNER_CANNOT_SHARE, or a SHARE_ERR_* code when the owner could not grant it (licence for the mode, sharing policy); 429 ACCESS_REQUEST_RATE_LIMITED.
|
|
94
|
+
* @summary Ask the owner for access
|
|
95
|
+
* @param {AccessRequestInput} accessRequestInput
|
|
96
|
+
* @param {*} [options] Override http request option.
|
|
97
|
+
* @throws {RequiredError}
|
|
98
|
+
*/
|
|
99
|
+
requestAccess(accessRequestInput: AccessRequestInput, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AccessRequestStatus, any, {}, any>>;
|
|
100
|
+
}
|