@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.
Files changed (74) hide show
  1. package/.openapi-generator/FILES +8 -0
  2. package/.openapi-generator/openfilz-api-generate-typescript-sdk.sha256 +1 -1
  3. package/README.md +8 -2
  4. package/api/access-requests-api.ts +203 -0
  5. package/api/collaboration-controller-api.ts +79 -4
  6. package/api.ts +1 -0
  7. package/dist/api/access-requests-api.d.ts +100 -0
  8. package/dist/api/access-requests-api.js +202 -0
  9. package/dist/api/collaboration-controller-api.d.ts +37 -4
  10. package/dist/api/collaboration-controller-api.js +74 -4
  11. package/dist/api.d.ts +1 -0
  12. package/dist/api.js +1 -0
  13. package/dist/esm/api/access-requests-api.d.ts +100 -0
  14. package/dist/esm/api/access-requests-api.js +195 -0
  15. package/dist/esm/api/collaboration-controller-api.d.ts +37 -4
  16. package/dist/esm/api/collaboration-controller-api.js +74 -4
  17. package/dist/esm/api.d.ts +1 -0
  18. package/dist/esm/api.js +1 -0
  19. package/dist/esm/models/access-request-input.d.ts +31 -0
  20. package/dist/esm/models/access-request-input.js +18 -0
  21. package/dist/esm/models/access-request-status.d.ts +36 -0
  22. package/dist/esm/models/access-request-status.js +24 -0
  23. package/dist/esm/models/enriched-audit-log.d.ts +1 -0
  24. package/dist/esm/models/enriched-audit-log.js +1 -0
  25. package/dist/esm/models/index.d.ts +3 -0
  26. package/dist/esm/models/index.js +3 -0
  27. package/dist/esm/models/notification-dto.d.ts +3 -0
  28. package/dist/esm/models/notification-dto.js +3 -0
  29. package/dist/esm/models/search-by-audit-log-request.d.ts +1 -0
  30. package/dist/esm/models/search-by-audit-log-request.js +1 -0
  31. package/dist/esm/models/share-expiry-request.d.ts +25 -0
  32. package/dist/esm/models/share-expiry-request.js +14 -0
  33. package/dist/esm/models/share-request.d.ts +4 -0
  34. package/dist/esm/models/share-result-error.d.ts +3 -0
  35. package/dist/esm/models/share-result-error.js +3 -0
  36. package/dist/esm/models/violation.d.ts +3 -0
  37. package/dist/esm/models/violation.js +3 -0
  38. package/dist/models/access-request-input.d.ts +31 -0
  39. package/dist/models/access-request-input.js +21 -0
  40. package/dist/models/access-request-status.d.ts +36 -0
  41. package/dist/models/access-request-status.js +27 -0
  42. package/dist/models/enriched-audit-log.d.ts +1 -0
  43. package/dist/models/enriched-audit-log.js +1 -0
  44. package/dist/models/index.d.ts +3 -0
  45. package/dist/models/index.js +3 -0
  46. package/dist/models/notification-dto.d.ts +3 -0
  47. package/dist/models/notification-dto.js +3 -0
  48. package/dist/models/search-by-audit-log-request.d.ts +1 -0
  49. package/dist/models/search-by-audit-log-request.js +1 -0
  50. package/dist/models/share-expiry-request.d.ts +25 -0
  51. package/dist/models/share-expiry-request.js +15 -0
  52. package/dist/models/share-request.d.ts +4 -0
  53. package/dist/models/share-result-error.d.ts +3 -0
  54. package/dist/models/share-result-error.js +3 -0
  55. package/dist/models/violation.d.ts +3 -0
  56. package/dist/models/violation.js +3 -0
  57. package/docs/AccessRequestInput.md +24 -0
  58. package/docs/AccessRequestStatus.md +26 -0
  59. package/docs/AccessRequestsApi.md +112 -0
  60. package/docs/CollaborationControllerApi.md +57 -1
  61. package/docs/ShareExpiryRequest.md +24 -0
  62. package/docs/ShareRequest.md +2 -0
  63. package/graphql/share.graphqls +43 -2
  64. package/models/access-request-input.ts +40 -0
  65. package/models/access-request-status.ts +46 -0
  66. package/models/enriched-audit-log.ts +1 -0
  67. package/models/index.ts +3 -0
  68. package/models/notification-dto.ts +3 -0
  69. package/models/search-by-audit-log-request.ts +1 -0
  70. package/models/share-expiry-request.ts +31 -0
  71. package/models/share-request.ts +4 -0
  72. package/models/share-result-error.ts +3 -0
  73. package/models/violation.ts +3 -0
  74. package/package.json +1 -1
@@ -45,5 +45,8 @@ export declare const NotificationDTOTypeEnum: {
45
45
  readonly TeamInvitationDeclined: "TEAM_INVITATION_DECLINED";
46
46
  readonly TeamMemberAdded: "TEAM_MEMBER_ADDED";
47
47
  readonly TeamMemberRemoved: "TEAM_MEMBER_REMOVED";
48
+ readonly AccessRequestDeclined: "ACCESS_REQUEST_DECLINED";
49
+ readonly ShareExpiring: "SHARE_EXPIRING";
50
+ readonly ShareExpired: "SHARE_EXPIRED";
48
51
  };
49
52
  export type NotificationDTOTypeEnum = typeof NotificationDTOTypeEnum[keyof typeof NotificationDTOTypeEnum];
@@ -36,4 +36,7 @@ export const NotificationDTOTypeEnum = {
36
36
  TeamInvitationDeclined: 'TEAM_INVITATION_DECLINED',
37
37
  TeamMemberAdded: 'TEAM_MEMBER_ADDED',
38
38
  TeamMemberRemoved: 'TEAM_MEMBER_REMOVED',
39
+ AccessRequestDeclined: 'ACCESS_REQUEST_DECLINED',
40
+ ShareExpiring: 'SHARE_EXPIRING',
41
+ ShareExpired: 'SHARE_EXPIRED',
39
42
  };
@@ -85,6 +85,7 @@ export declare const SearchByAuditLogRequestActionEnum: {
85
85
  readonly ShareDocumentCreate: "SHARE_DOCUMENT_CREATE";
86
86
  readonly ShareDocumentUpdate: "SHARE_DOCUMENT_UPDATE";
87
87
  readonly ShareDocumentDelete: "SHARE_DOCUMENT_DELETE";
88
+ readonly ShareDocumentExpire: "SHARE_DOCUMENT_EXPIRE";
88
89
  readonly ShareInheritanceChanged: "SHARE_INHERITANCE_CHANGED";
89
90
  readonly TeamCreated: "TEAM_CREATED";
90
91
  readonly TeamUpdated: "TEAM_UPDATED";
@@ -59,6 +59,7 @@ export const SearchByAuditLogRequestActionEnum = {
59
59
  ShareDocumentCreate: 'SHARE_DOCUMENT_CREATE',
60
60
  ShareDocumentUpdate: 'SHARE_DOCUMENT_UPDATE',
61
61
  ShareDocumentDelete: 'SHARE_DOCUMENT_DELETE',
62
+ ShareDocumentExpire: 'SHARE_DOCUMENT_EXPIRE',
62
63
  ShareInheritanceChanged: 'SHARE_INHERITANCE_CHANGED',
63
64
  TeamCreated: 'TEAM_CREATED',
64
65
  TeamUpdated: 'TEAM_UPDATED',
@@ -0,0 +1,25 @@
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
+ export interface ShareExpiryRequest {
13
+ /**
14
+ * Shared documents
15
+ */
16
+ 'documentIds': Set<string>;
17
+ /**
18
+ * Recipients (users or teams)
19
+ */
20
+ 'userIds': Set<string>;
21
+ /**
22
+ * New end of access (ISO-8601 instant), null = no end. A date in the past is refused (400).
23
+ */
24
+ 'expiresAt'?: string;
25
+ }
@@ -0,0 +1,14 @@
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
+ export {};
@@ -30,6 +30,10 @@ export interface ShareRequest {
30
30
  * false = create the shares silently: no invitation e-mail and no bell notification to the recipients (bulk imports — a migration re-creating a source system\'s permissions must not mail thousands of invitations). Absent or true = notify. Share requests addressed to a document\'s owner are always notified.
31
31
  */
32
32
  'notify'?: boolean;
33
+ /**
34
+ * Optional end of access (ISO-8601 instant): on that date the recipients lose access and the owner is told. Absent = no end. A date in the past is refused (400). On a document the caller does not own, it travels with the share request and applies once the owner accepts.
35
+ */
36
+ 'expiresAt'?: string;
33
37
  }
34
38
  export declare const ShareRequestShareModeEnum: {
35
39
  readonly Reader: "READER";
@@ -22,6 +22,9 @@ export declare const ShareResultErrorCodeEnum: {
22
22
  readonly ShareErrNotAlreadyShared: "SHARE_ERR_NOT_ALREADY_SHARED";
23
23
  readonly ShareErrOwner: "SHARE_ERR_OWNER";
24
24
  readonly ShareErrNotScanned: "SHARE_ERR_NOT_SCANNED";
25
+ readonly ShareErrDocumentNotFound: "SHARE_ERR_DOCUMENT_NOT_FOUND";
26
+ readonly ShareErrInheritedShare: "SHARE_ERR_INHERITED_SHARE";
27
+ readonly ShareErrOwnerOnly: "SHARE_ERR_OWNER_ONLY";
25
28
  readonly ShareErrRecipientNotLicensedPolicy: "SHARE_ERR_RECIPIENT_NOT_LICENSED_POLICY";
26
29
  readonly ShareErrRecipientDomainPolicy: "SHARE_ERR_RECIPIENT_DOMAIN_POLICY";
27
30
  readonly ShareErrTeamHasExternalMember: "SHARE_ERR_TEAM_HAS_EXTERNAL_MEMBER";
@@ -19,6 +19,9 @@ export const ShareResultErrorCodeEnum = {
19
19
  ShareErrNotAlreadyShared: 'SHARE_ERR_NOT_ALREADY_SHARED',
20
20
  ShareErrOwner: 'SHARE_ERR_OWNER',
21
21
  ShareErrNotScanned: 'SHARE_ERR_NOT_SCANNED',
22
+ ShareErrDocumentNotFound: 'SHARE_ERR_DOCUMENT_NOT_FOUND',
23
+ ShareErrInheritedShare: 'SHARE_ERR_INHERITED_SHARE',
24
+ ShareErrOwnerOnly: 'SHARE_ERR_OWNER_ONLY',
22
25
  ShareErrRecipientNotLicensedPolicy: 'SHARE_ERR_RECIPIENT_NOT_LICENSED_POLICY',
23
26
  ShareErrRecipientDomainPolicy: 'SHARE_ERR_RECIPIENT_DOMAIN_POLICY',
24
27
  ShareErrTeamHasExternalMember: 'SHARE_ERR_TEAM_HAS_EXTERNAL_MEMBER',
@@ -31,6 +31,9 @@ export declare const ViolationReasonEnum: {
31
31
  readonly ShareErrNotAlreadyShared: "SHARE_ERR_NOT_ALREADY_SHARED";
32
32
  readonly ShareErrOwner: "SHARE_ERR_OWNER";
33
33
  readonly ShareErrNotScanned: "SHARE_ERR_NOT_SCANNED";
34
+ readonly ShareErrDocumentNotFound: "SHARE_ERR_DOCUMENT_NOT_FOUND";
35
+ readonly ShareErrInheritedShare: "SHARE_ERR_INHERITED_SHARE";
36
+ readonly ShareErrOwnerOnly: "SHARE_ERR_OWNER_ONLY";
34
37
  readonly ShareErrRecipientNotLicensedPolicy: "SHARE_ERR_RECIPIENT_NOT_LICENSED_POLICY";
35
38
  readonly ShareErrRecipientDomainPolicy: "SHARE_ERR_RECIPIENT_DOMAIN_POLICY";
36
39
  readonly ShareErrTeamHasExternalMember: "SHARE_ERR_TEAM_HAS_EXTERNAL_MEMBER";
@@ -19,6 +19,9 @@ export const ViolationReasonEnum = {
19
19
  ShareErrNotAlreadyShared: 'SHARE_ERR_NOT_ALREADY_SHARED',
20
20
  ShareErrOwner: 'SHARE_ERR_OWNER',
21
21
  ShareErrNotScanned: 'SHARE_ERR_NOT_SCANNED',
22
+ ShareErrDocumentNotFound: 'SHARE_ERR_DOCUMENT_NOT_FOUND',
23
+ ShareErrInheritedShare: 'SHARE_ERR_INHERITED_SHARE',
24
+ ShareErrOwnerOnly: 'SHARE_ERR_OWNER_ONLY',
22
25
  ShareErrRecipientNotLicensedPolicy: 'SHARE_ERR_RECIPIENT_NOT_LICENSED_POLICY',
23
26
  ShareErrRecipientDomainPolicy: 'SHARE_ERR_RECIPIENT_DOMAIN_POLICY',
24
27
  ShareErrTeamHasExternalMember: 'SHARE_ERR_TEAM_HAS_EXTERNAL_MEMBER',
@@ -0,0 +1,31 @@
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
+ export interface AccessRequestInput {
13
+ /**
14
+ * The document (file or folder) the caller asks access to
15
+ */
16
+ 'documentId': string;
17
+ /**
18
+ * The access asked for; READER when absent
19
+ */
20
+ 'shareMode'?: AccessRequestInputShareModeEnum;
21
+ /**
22
+ * Optional note to the owner
23
+ */
24
+ 'message'?: string;
25
+ }
26
+ export declare const AccessRequestInputShareModeEnum: {
27
+ readonly Reader: "READER";
28
+ readonly Commenter: "COMMENTER";
29
+ readonly Editor: "EDITOR";
30
+ };
31
+ export type AccessRequestInputShareModeEnum = typeof AccessRequestInputShareModeEnum[keyof typeof AccessRequestInputShareModeEnum];
@@ -0,0 +1,21 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * openfilz-api
6
+ * API for Document Management System
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.AccessRequestInputShareModeEnum = void 0;
17
+ exports.AccessRequestInputShareModeEnum = {
18
+ Reader: 'READER',
19
+ Commenter: 'COMMENTER',
20
+ Editor: 'EDITOR',
21
+ };
@@ -0,0 +1,36 @@
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
+ export interface AccessRequestStatus {
13
+ 'documentId'?: string;
14
+ 'state'?: AccessRequestStatusStateEnum;
15
+ /**
16
+ * PENDING: the access asked for
17
+ */
18
+ 'requestedMode'?: AccessRequestStatusRequestedModeEnum;
19
+ /**
20
+ * PENDING: when the owner was last asked
21
+ */
22
+ 'requestedAt'?: string;
23
+ }
24
+ export declare const AccessRequestStatusStateEnum: {
25
+ readonly HasAccess: "HAS_ACCESS";
26
+ readonly NoAccess: "NO_ACCESS";
27
+ readonly Pending: "PENDING";
28
+ readonly OwnerCannotShare: "OWNER_CANNOT_SHARE";
29
+ };
30
+ export type AccessRequestStatusStateEnum = typeof AccessRequestStatusStateEnum[keyof typeof AccessRequestStatusStateEnum];
31
+ export declare const AccessRequestStatusRequestedModeEnum: {
32
+ readonly Reader: "READER";
33
+ readonly Commenter: "COMMENTER";
34
+ readonly Editor: "EDITOR";
35
+ };
36
+ export type AccessRequestStatusRequestedModeEnum = typeof AccessRequestStatusRequestedModeEnum[keyof typeof AccessRequestStatusRequestedModeEnum];
@@ -0,0 +1,27 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * openfilz-api
6
+ * API for Document Management System
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.AccessRequestStatusRequestedModeEnum = exports.AccessRequestStatusStateEnum = void 0;
17
+ exports.AccessRequestStatusStateEnum = {
18
+ HasAccess: 'HAS_ACCESS',
19
+ NoAccess: 'NO_ACCESS',
20
+ Pending: 'PENDING',
21
+ OwnerCannotShare: 'OWNER_CANNOT_SHARE',
22
+ };
23
+ exports.AccessRequestStatusRequestedModeEnum = {
24
+ Reader: 'READER',
25
+ Commenter: 'COMMENTER',
26
+ Editor: 'EDITOR',
27
+ };
@@ -69,6 +69,7 @@ export declare const EnrichedAuditLogActionEnum: {
69
69
  readonly ShareDocumentCreate: "SHARE_DOCUMENT_CREATE";
70
70
  readonly ShareDocumentUpdate: "SHARE_DOCUMENT_UPDATE";
71
71
  readonly ShareDocumentDelete: "SHARE_DOCUMENT_DELETE";
72
+ readonly ShareDocumentExpire: "SHARE_DOCUMENT_EXPIRE";
72
73
  readonly ShareInheritanceChanged: "SHARE_INHERITANCE_CHANGED";
73
74
  readonly TeamCreated: "TEAM_CREATED";
74
75
  readonly TeamUpdated: "TEAM_UPDATED";
@@ -58,6 +58,7 @@ exports.EnrichedAuditLogActionEnum = {
58
58
  ShareDocumentCreate: 'SHARE_DOCUMENT_CREATE',
59
59
  ShareDocumentUpdate: 'SHARE_DOCUMENT_UPDATE',
60
60
  ShareDocumentDelete: 'SHARE_DOCUMENT_DELETE',
61
+ ShareDocumentExpire: 'SHARE_DOCUMENT_EXPIRE',
61
62
  ShareInheritanceChanged: 'SHARE_INHERITANCE_CHANGED',
62
63
  TeamCreated: 'TEAM_CREATED',
63
64
  TeamUpdated: 'TEAM_UPDATED',
@@ -1,3 +1,5 @@
1
+ export * from './access-request-input';
2
+ export * from './access-request-status';
1
3
  export * from './add-team-owner-request';
2
4
  export * from './ai-analytics-view';
3
5
  export * from './ai-chat-conversation';
@@ -176,6 +178,7 @@ export * from './search-by-metadata-request';
176
178
  export * from './search-metadata-request';
177
179
  export * from './setting-dto';
178
180
  export * from './settings';
181
+ export * from './share-expiry-request';
179
182
  export * from './share-inheritance';
180
183
  export * from './share-inheritance-request';
181
184
  export * from './share-request';
@@ -14,6 +14,8 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
14
  for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
15
  };
16
16
  Object.defineProperty(exports, "__esModule", { value: true });
17
+ __exportStar(require("./access-request-input"), exports);
18
+ __exportStar(require("./access-request-status"), exports);
17
19
  __exportStar(require("./add-team-owner-request"), exports);
18
20
  __exportStar(require("./ai-analytics-view"), exports);
19
21
  __exportStar(require("./ai-chat-conversation"), exports);
@@ -192,6 +194,7 @@ __exportStar(require("./search-by-metadata-request"), exports);
192
194
  __exportStar(require("./search-metadata-request"), exports);
193
195
  __exportStar(require("./setting-dto"), exports);
194
196
  __exportStar(require("./settings"), exports);
197
+ __exportStar(require("./share-expiry-request"), exports);
195
198
  __exportStar(require("./share-inheritance"), exports);
196
199
  __exportStar(require("./share-inheritance-request"), exports);
197
200
  __exportStar(require("./share-request"), exports);
@@ -45,5 +45,8 @@ export declare const NotificationDTOTypeEnum: {
45
45
  readonly TeamInvitationDeclined: "TEAM_INVITATION_DECLINED";
46
46
  readonly TeamMemberAdded: "TEAM_MEMBER_ADDED";
47
47
  readonly TeamMemberRemoved: "TEAM_MEMBER_REMOVED";
48
+ readonly AccessRequestDeclined: "ACCESS_REQUEST_DECLINED";
49
+ readonly ShareExpiring: "SHARE_EXPIRING";
50
+ readonly ShareExpired: "SHARE_EXPIRED";
48
51
  };
49
52
  export type NotificationDTOTypeEnum = typeof NotificationDTOTypeEnum[keyof typeof NotificationDTOTypeEnum];
@@ -39,4 +39,7 @@ exports.NotificationDTOTypeEnum = {
39
39
  TeamInvitationDeclined: 'TEAM_INVITATION_DECLINED',
40
40
  TeamMemberAdded: 'TEAM_MEMBER_ADDED',
41
41
  TeamMemberRemoved: 'TEAM_MEMBER_REMOVED',
42
+ AccessRequestDeclined: 'ACCESS_REQUEST_DECLINED',
43
+ ShareExpiring: 'SHARE_EXPIRING',
44
+ ShareExpired: 'SHARE_EXPIRED',
42
45
  };
@@ -85,6 +85,7 @@ export declare const SearchByAuditLogRequestActionEnum: {
85
85
  readonly ShareDocumentCreate: "SHARE_DOCUMENT_CREATE";
86
86
  readonly ShareDocumentUpdate: "SHARE_DOCUMENT_UPDATE";
87
87
  readonly ShareDocumentDelete: "SHARE_DOCUMENT_DELETE";
88
+ readonly ShareDocumentExpire: "SHARE_DOCUMENT_EXPIRE";
88
89
  readonly ShareInheritanceChanged: "SHARE_INHERITANCE_CHANGED";
89
90
  readonly TeamCreated: "TEAM_CREATED";
90
91
  readonly TeamUpdated: "TEAM_UPDATED";
@@ -62,6 +62,7 @@ exports.SearchByAuditLogRequestActionEnum = {
62
62
  ShareDocumentCreate: 'SHARE_DOCUMENT_CREATE',
63
63
  ShareDocumentUpdate: 'SHARE_DOCUMENT_UPDATE',
64
64
  ShareDocumentDelete: 'SHARE_DOCUMENT_DELETE',
65
+ ShareDocumentExpire: 'SHARE_DOCUMENT_EXPIRE',
65
66
  ShareInheritanceChanged: 'SHARE_INHERITANCE_CHANGED',
66
67
  TeamCreated: 'TEAM_CREATED',
67
68
  TeamUpdated: 'TEAM_UPDATED',
@@ -0,0 +1,25 @@
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
+ export interface ShareExpiryRequest {
13
+ /**
14
+ * Shared documents
15
+ */
16
+ 'documentIds': Set<string>;
17
+ /**
18
+ * Recipients (users or teams)
19
+ */
20
+ 'userIds': Set<string>;
21
+ /**
22
+ * New end of access (ISO-8601 instant), null = no end. A date in the past is refused (400).
23
+ */
24
+ 'expiresAt'?: string;
25
+ }
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * openfilz-api
6
+ * API for Document Management System
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -30,6 +30,10 @@ export interface ShareRequest {
30
30
  * false = create the shares silently: no invitation e-mail and no bell notification to the recipients (bulk imports — a migration re-creating a source system\'s permissions must not mail thousands of invitations). Absent or true = notify. Share requests addressed to a document\'s owner are always notified.
31
31
  */
32
32
  'notify'?: boolean;
33
+ /**
34
+ * Optional end of access (ISO-8601 instant): on that date the recipients lose access and the owner is told. Absent = no end. A date in the past is refused (400). On a document the caller does not own, it travels with the share request and applies once the owner accepts.
35
+ */
36
+ 'expiresAt'?: string;
33
37
  }
34
38
  export declare const ShareRequestShareModeEnum: {
35
39
  readonly Reader: "READER";
@@ -22,6 +22,9 @@ export declare const ShareResultErrorCodeEnum: {
22
22
  readonly ShareErrNotAlreadyShared: "SHARE_ERR_NOT_ALREADY_SHARED";
23
23
  readonly ShareErrOwner: "SHARE_ERR_OWNER";
24
24
  readonly ShareErrNotScanned: "SHARE_ERR_NOT_SCANNED";
25
+ readonly ShareErrDocumentNotFound: "SHARE_ERR_DOCUMENT_NOT_FOUND";
26
+ readonly ShareErrInheritedShare: "SHARE_ERR_INHERITED_SHARE";
27
+ readonly ShareErrOwnerOnly: "SHARE_ERR_OWNER_ONLY";
25
28
  readonly ShareErrRecipientNotLicensedPolicy: "SHARE_ERR_RECIPIENT_NOT_LICENSED_POLICY";
26
29
  readonly ShareErrRecipientDomainPolicy: "SHARE_ERR_RECIPIENT_DOMAIN_POLICY";
27
30
  readonly ShareErrTeamHasExternalMember: "SHARE_ERR_TEAM_HAS_EXTERNAL_MEMBER";
@@ -22,6 +22,9 @@ exports.ShareResultErrorCodeEnum = {
22
22
  ShareErrNotAlreadyShared: 'SHARE_ERR_NOT_ALREADY_SHARED',
23
23
  ShareErrOwner: 'SHARE_ERR_OWNER',
24
24
  ShareErrNotScanned: 'SHARE_ERR_NOT_SCANNED',
25
+ ShareErrDocumentNotFound: 'SHARE_ERR_DOCUMENT_NOT_FOUND',
26
+ ShareErrInheritedShare: 'SHARE_ERR_INHERITED_SHARE',
27
+ ShareErrOwnerOnly: 'SHARE_ERR_OWNER_ONLY',
25
28
  ShareErrRecipientNotLicensedPolicy: 'SHARE_ERR_RECIPIENT_NOT_LICENSED_POLICY',
26
29
  ShareErrRecipientDomainPolicy: 'SHARE_ERR_RECIPIENT_DOMAIN_POLICY',
27
30
  ShareErrTeamHasExternalMember: 'SHARE_ERR_TEAM_HAS_EXTERNAL_MEMBER',
@@ -31,6 +31,9 @@ export declare const ViolationReasonEnum: {
31
31
  readonly ShareErrNotAlreadyShared: "SHARE_ERR_NOT_ALREADY_SHARED";
32
32
  readonly ShareErrOwner: "SHARE_ERR_OWNER";
33
33
  readonly ShareErrNotScanned: "SHARE_ERR_NOT_SCANNED";
34
+ readonly ShareErrDocumentNotFound: "SHARE_ERR_DOCUMENT_NOT_FOUND";
35
+ readonly ShareErrInheritedShare: "SHARE_ERR_INHERITED_SHARE";
36
+ readonly ShareErrOwnerOnly: "SHARE_ERR_OWNER_ONLY";
34
37
  readonly ShareErrRecipientNotLicensedPolicy: "SHARE_ERR_RECIPIENT_NOT_LICENSED_POLICY";
35
38
  readonly ShareErrRecipientDomainPolicy: "SHARE_ERR_RECIPIENT_DOMAIN_POLICY";
36
39
  readonly ShareErrTeamHasExternalMember: "SHARE_ERR_TEAM_HAS_EXTERNAL_MEMBER";
@@ -22,6 +22,9 @@ exports.ViolationReasonEnum = {
22
22
  ShareErrNotAlreadyShared: 'SHARE_ERR_NOT_ALREADY_SHARED',
23
23
  ShareErrOwner: 'SHARE_ERR_OWNER',
24
24
  ShareErrNotScanned: 'SHARE_ERR_NOT_SCANNED',
25
+ ShareErrDocumentNotFound: 'SHARE_ERR_DOCUMENT_NOT_FOUND',
26
+ ShareErrInheritedShare: 'SHARE_ERR_INHERITED_SHARE',
27
+ ShareErrOwnerOnly: 'SHARE_ERR_OWNER_ONLY',
25
28
  ShareErrRecipientNotLicensedPolicy: 'SHARE_ERR_RECIPIENT_NOT_LICENSED_POLICY',
26
29
  ShareErrRecipientDomainPolicy: 'SHARE_ERR_RECIPIENT_DOMAIN_POLICY',
27
30
  ShareErrTeamHasExternalMember: 'SHARE_ERR_TEAM_HAS_EXTERNAL_MEMBER',
@@ -0,0 +1,24 @@
1
+ # AccessRequestInput
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **documentId** | **string** | The document (file or folder) the caller asks access to | [default to undefined]
9
+ **shareMode** | **string** | The access asked for; READER when absent | [optional] [default to undefined]
10
+ **message** | **string** | Optional note to the owner | [optional] [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { AccessRequestInput } from '@openfilz-sdk/typescript-ee';
16
+
17
+ const instance: AccessRequestInput = {
18
+ documentId,
19
+ shareMode,
20
+ message,
21
+ };
22
+ ```
23
+
24
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,26 @@
1
+ # AccessRequestStatus
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **documentId** | **string** | | [optional] [default to undefined]
9
+ **state** | **string** | | [optional] [default to undefined]
10
+ **requestedMode** | **string** | PENDING: the access asked for | [optional] [default to undefined]
11
+ **requestedAt** | **string** | PENDING: when the owner was last asked | [optional] [default to undefined]
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import { AccessRequestStatus } from '@openfilz-sdk/typescript-ee';
17
+
18
+ const instance: AccessRequestStatus = {
19
+ documentId,
20
+ state,
21
+ requestedMode,
22
+ requestedAt,
23
+ };
24
+ ```
25
+
26
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,112 @@
1
+ # AccessRequestsApi
2
+
3
+ All URIs are relative to *http://localhost:8081*
4
+
5
+ |Method | HTTP request | Description|
6
+ |------------- | ------------- | -------------|
7
+ |[**myAccessToDocument**](#myaccesstodocument) | **GET** /api/v1/users/me/access-requests/{documentId} | Can I open this document, or ask for it?|
8
+ |[**requestAccess**](#requestaccess) | **POST** /api/v1/users/me/access-requests | Ask the owner for access|
9
+
10
+ # **myAccessToDocument**
11
+ > AccessRequestStatus myAccessToDocument()
12
+
13
+ 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.
14
+
15
+ ### Example
16
+
17
+ ```typescript
18
+ import {
19
+ AccessRequestsApi,
20
+ Configuration
21
+ } from '@openfilz-sdk/typescript-ee';
22
+
23
+ const configuration = new Configuration();
24
+ const apiInstance = new AccessRequestsApi(configuration);
25
+
26
+ let documentId: string; // (default to undefined)
27
+
28
+ const { status, data } = await apiInstance.myAccessToDocument(
29
+ documentId
30
+ );
31
+ ```
32
+
33
+ ### Parameters
34
+
35
+ |Name | Type | Description | Notes|
36
+ |------------- | ------------- | ------------- | -------------|
37
+ | **documentId** | [**string**] | | defaults to undefined|
38
+
39
+
40
+ ### Return type
41
+
42
+ **AccessRequestStatus**
43
+
44
+ ### Authorization
45
+
46
+ [keycloak_auth](../README.md#keycloak_auth)
47
+
48
+ ### HTTP request headers
49
+
50
+ - **Content-Type**: Not defined
51
+ - **Accept**: */*
52
+
53
+
54
+ ### HTTP response details
55
+ | Status code | Description | Response headers |
56
+ |-------------|-------------|------------------|
57
+ |**200** | OK | - |
58
+
59
+ [[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)
60
+
61
+ # **requestAccess**
62
+ > AccessRequestStatus requestAccess(accessRequestInput)
63
+
64
+ 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.
65
+
66
+ ### Example
67
+
68
+ ```typescript
69
+ import {
70
+ AccessRequestsApi,
71
+ Configuration,
72
+ AccessRequestInput
73
+ } from '@openfilz-sdk/typescript-ee';
74
+
75
+ const configuration = new Configuration();
76
+ const apiInstance = new AccessRequestsApi(configuration);
77
+
78
+ let accessRequestInput: AccessRequestInput; //
79
+
80
+ const { status, data } = await apiInstance.requestAccess(
81
+ accessRequestInput
82
+ );
83
+ ```
84
+
85
+ ### Parameters
86
+
87
+ |Name | Type | Description | Notes|
88
+ |------------- | ------------- | ------------- | -------------|
89
+ | **accessRequestInput** | **AccessRequestInput**| | |
90
+
91
+
92
+ ### Return type
93
+
94
+ **AccessRequestStatus**
95
+
96
+ ### Authorization
97
+
98
+ [keycloak_auth](../README.md#keycloak_auth)
99
+
100
+ ### HTTP request headers
101
+
102
+ - **Content-Type**: application/json
103
+ - **Accept**: */*
104
+
105
+
106
+ ### HTTP response details
107
+ | Status code | Description | Response headers |
108
+ |-------------|-------------|------------------|
109
+ |**200** | OK | - |
110
+
111
+ [[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)
112
+