@aws-sdk/client-workdocs 3.686.0 → 3.691.0
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/dist-types/models/models_0.d.ts +344 -344
- package/dist-types/ts3.4/models/models_0.d.ts +344 -344
- package/package.json +7 -7
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
2
|
import { WorkDocsServiceException as __BaseException } from "./WorkDocsServiceException";
|
|
3
3
|
export interface AbortDocumentVersionUploadRequest {
|
|
4
|
-
AuthenticationToken?: string;
|
|
4
|
+
AuthenticationToken?: string | undefined;
|
|
5
5
|
DocumentId: string | undefined;
|
|
6
6
|
VersionId: string | undefined;
|
|
7
7
|
}
|
|
8
8
|
export declare class ConcurrentModificationException extends __BaseException {
|
|
9
9
|
readonly name: "ConcurrentModificationException";
|
|
10
10
|
readonly $fault: "client";
|
|
11
|
-
Message?: string;
|
|
11
|
+
Message?: string | undefined;
|
|
12
12
|
constructor(
|
|
13
13
|
opts: __ExceptionOptionType<
|
|
14
14
|
ConcurrentModificationException,
|
|
@@ -19,8 +19,8 @@ export declare class ConcurrentModificationException extends __BaseException {
|
|
|
19
19
|
export declare class EntityNotExistsException extends __BaseException {
|
|
20
20
|
readonly name: "EntityNotExistsException";
|
|
21
21
|
readonly $fault: "client";
|
|
22
|
-
Message?: string;
|
|
23
|
-
EntityIds?: string[];
|
|
22
|
+
Message?: string | undefined;
|
|
23
|
+
EntityIds?: string[] | undefined;
|
|
24
24
|
constructor(
|
|
25
25
|
opts: __ExceptionOptionType<EntityNotExistsException, __BaseException>
|
|
26
26
|
);
|
|
@@ -28,7 +28,7 @@ export declare class EntityNotExistsException extends __BaseException {
|
|
|
28
28
|
export declare class FailedDependencyException extends __BaseException {
|
|
29
29
|
readonly name: "FailedDependencyException";
|
|
30
30
|
readonly $fault: "client";
|
|
31
|
-
Message?: string;
|
|
31
|
+
Message?: string | undefined;
|
|
32
32
|
constructor(
|
|
33
33
|
opts: __ExceptionOptionType<FailedDependencyException, __BaseException>
|
|
34
34
|
);
|
|
@@ -36,7 +36,7 @@ export declare class FailedDependencyException extends __BaseException {
|
|
|
36
36
|
export declare class ProhibitedStateException extends __BaseException {
|
|
37
37
|
readonly name: "ProhibitedStateException";
|
|
38
38
|
readonly $fault: "client";
|
|
39
|
-
Message?: string;
|
|
39
|
+
Message?: string | undefined;
|
|
40
40
|
constructor(
|
|
41
41
|
opts: __ExceptionOptionType<ProhibitedStateException, __BaseException>
|
|
42
42
|
);
|
|
@@ -44,7 +44,7 @@ export declare class ProhibitedStateException extends __BaseException {
|
|
|
44
44
|
export declare class ServiceUnavailableException extends __BaseException {
|
|
45
45
|
readonly name: "ServiceUnavailableException";
|
|
46
46
|
readonly $fault: "server";
|
|
47
|
-
Message?: string;
|
|
47
|
+
Message?: string | undefined;
|
|
48
48
|
constructor(
|
|
49
49
|
opts: __ExceptionOptionType<ServiceUnavailableException, __BaseException>
|
|
50
50
|
);
|
|
@@ -52,8 +52,8 @@ export declare class ServiceUnavailableException extends __BaseException {
|
|
|
52
52
|
export declare class UnauthorizedOperationException extends __BaseException {
|
|
53
53
|
readonly name: "UnauthorizedOperationException";
|
|
54
54
|
readonly $fault: "client";
|
|
55
|
-
Message?: string;
|
|
56
|
-
Code?: string;
|
|
55
|
+
Message?: string | undefined;
|
|
56
|
+
Code?: string | undefined;
|
|
57
57
|
constructor(
|
|
58
58
|
opts: __ExceptionOptionType<UnauthorizedOperationException, __BaseException>
|
|
59
59
|
);
|
|
@@ -61,7 +61,7 @@ export declare class UnauthorizedOperationException extends __BaseException {
|
|
|
61
61
|
export declare class UnauthorizedResourceAccessException extends __BaseException {
|
|
62
62
|
readonly name: "UnauthorizedResourceAccessException";
|
|
63
63
|
readonly $fault: "client";
|
|
64
|
-
Message?: string;
|
|
64
|
+
Message?: string | undefined;
|
|
65
65
|
constructor(
|
|
66
66
|
opts: __ExceptionOptionType<
|
|
67
67
|
UnauthorizedResourceAccessException,
|
|
@@ -71,7 +71,7 @@ export declare class UnauthorizedResourceAccessException extends __BaseException
|
|
|
71
71
|
}
|
|
72
72
|
export interface ActivateUserRequest {
|
|
73
73
|
UserId: string | undefined;
|
|
74
|
-
AuthenticationToken?: string;
|
|
74
|
+
AuthenticationToken?: string | undefined;
|
|
75
75
|
}
|
|
76
76
|
export declare const LocaleType: {
|
|
77
77
|
readonly DE: "de";
|
|
@@ -100,12 +100,12 @@ export declare const StorageType: {
|
|
|
100
100
|
};
|
|
101
101
|
export type StorageType = (typeof StorageType)[keyof typeof StorageType];
|
|
102
102
|
export interface StorageRuleType {
|
|
103
|
-
StorageAllocatedInBytes?: number;
|
|
104
|
-
StorageType?: StorageType;
|
|
103
|
+
StorageAllocatedInBytes?: number | undefined;
|
|
104
|
+
StorageType?: StorageType | undefined;
|
|
105
105
|
}
|
|
106
106
|
export interface UserStorageMetadata {
|
|
107
|
-
StorageUtilizedInBytes?: number;
|
|
108
|
-
StorageRule?: StorageRuleType;
|
|
107
|
+
StorageUtilizedInBytes?: number | undefined;
|
|
108
|
+
StorageRule?: StorageRuleType | undefined;
|
|
109
109
|
}
|
|
110
110
|
export declare const UserType: {
|
|
111
111
|
readonly ADMIN: "ADMIN";
|
|
@@ -116,24 +116,24 @@ export declare const UserType: {
|
|
|
116
116
|
};
|
|
117
117
|
export type UserType = (typeof UserType)[keyof typeof UserType];
|
|
118
118
|
export interface User {
|
|
119
|
-
Id?: string;
|
|
120
|
-
Username?: string;
|
|
121
|
-
EmailAddress?: string;
|
|
122
|
-
GivenName?: string;
|
|
123
|
-
Surname?: string;
|
|
124
|
-
OrganizationId?: string;
|
|
125
|
-
RootFolderId?: string;
|
|
126
|
-
RecycleBinFolderId?: string;
|
|
127
|
-
Status?: UserStatusType;
|
|
128
|
-
Type?: UserType;
|
|
129
|
-
CreatedTimestamp?: Date;
|
|
130
|
-
ModifiedTimestamp?: Date;
|
|
131
|
-
TimeZoneId?: string;
|
|
132
|
-
Locale?: LocaleType;
|
|
133
|
-
Storage?: UserStorageMetadata;
|
|
119
|
+
Id?: string | undefined;
|
|
120
|
+
Username?: string | undefined;
|
|
121
|
+
EmailAddress?: string | undefined;
|
|
122
|
+
GivenName?: string | undefined;
|
|
123
|
+
Surname?: string | undefined;
|
|
124
|
+
OrganizationId?: string | undefined;
|
|
125
|
+
RootFolderId?: string | undefined;
|
|
126
|
+
RecycleBinFolderId?: string | undefined;
|
|
127
|
+
Status?: UserStatusType | undefined;
|
|
128
|
+
Type?: UserType | undefined;
|
|
129
|
+
CreatedTimestamp?: Date | undefined;
|
|
130
|
+
ModifiedTimestamp?: Date | undefined;
|
|
131
|
+
TimeZoneId?: string | undefined;
|
|
132
|
+
Locale?: LocaleType | undefined;
|
|
133
|
+
Storage?: UserStorageMetadata | undefined;
|
|
134
134
|
}
|
|
135
135
|
export interface ActivateUserResponse {
|
|
136
|
-
User?: User;
|
|
136
|
+
User?: User | undefined;
|
|
137
137
|
}
|
|
138
138
|
export declare const CommentStatusType: {
|
|
139
139
|
readonly DELETED: "DELETED";
|
|
@@ -143,19 +143,19 @@ export declare const CommentStatusType: {
|
|
|
143
143
|
export type CommentStatusType =
|
|
144
144
|
(typeof CommentStatusType)[keyof typeof CommentStatusType];
|
|
145
145
|
export interface CommentMetadata {
|
|
146
|
-
CommentId?: string;
|
|
147
|
-
Contributor?: User;
|
|
148
|
-
CreatedTimestamp?: Date;
|
|
149
|
-
CommentStatus?: CommentStatusType;
|
|
150
|
-
RecipientId?: string;
|
|
151
|
-
ContributorId?: string;
|
|
146
|
+
CommentId?: string | undefined;
|
|
147
|
+
Contributor?: User | undefined;
|
|
148
|
+
CreatedTimestamp?: Date | undefined;
|
|
149
|
+
CommentStatus?: CommentStatusType | undefined;
|
|
150
|
+
RecipientId?: string | undefined;
|
|
151
|
+
ContributorId?: string | undefined;
|
|
152
152
|
}
|
|
153
153
|
export interface UserMetadata {
|
|
154
|
-
Id?: string;
|
|
155
|
-
Username?: string;
|
|
156
|
-
GivenName?: string;
|
|
157
|
-
Surname?: string;
|
|
158
|
-
EmailAddress?: string;
|
|
154
|
+
Id?: string | undefined;
|
|
155
|
+
Username?: string | undefined;
|
|
156
|
+
GivenName?: string | undefined;
|
|
157
|
+
Surname?: string | undefined;
|
|
158
|
+
EmailAddress?: string | undefined;
|
|
159
159
|
}
|
|
160
160
|
export declare const ResourceType: {
|
|
161
161
|
readonly DOCUMENT: "DOCUMENT";
|
|
@@ -163,21 +163,21 @@ export declare const ResourceType: {
|
|
|
163
163
|
};
|
|
164
164
|
export type ResourceType = (typeof ResourceType)[keyof typeof ResourceType];
|
|
165
165
|
export interface ResourceMetadata {
|
|
166
|
-
Type?: ResourceType;
|
|
167
|
-
Name?: string;
|
|
168
|
-
OriginalName?: string;
|
|
169
|
-
Id?: string;
|
|
170
|
-
VersionId?: string;
|
|
171
|
-
Owner?: UserMetadata;
|
|
172
|
-
ParentId?: string;
|
|
166
|
+
Type?: ResourceType | undefined;
|
|
167
|
+
Name?: string | undefined;
|
|
168
|
+
OriginalName?: string | undefined;
|
|
169
|
+
Id?: string | undefined;
|
|
170
|
+
VersionId?: string | undefined;
|
|
171
|
+
Owner?: UserMetadata | undefined;
|
|
172
|
+
ParentId?: string | undefined;
|
|
173
173
|
}
|
|
174
174
|
export interface GroupMetadata {
|
|
175
|
-
Id?: string;
|
|
176
|
-
Name?: string;
|
|
175
|
+
Id?: string | undefined;
|
|
176
|
+
Name?: string | undefined;
|
|
177
177
|
}
|
|
178
178
|
export interface Participants {
|
|
179
|
-
Users?: UserMetadata[];
|
|
180
|
-
Groups?: GroupMetadata[];
|
|
179
|
+
Users?: UserMetadata[] | undefined;
|
|
180
|
+
Groups?: GroupMetadata[] | undefined;
|
|
181
181
|
}
|
|
182
182
|
export declare const ActivityType: {
|
|
183
183
|
readonly DOCUMENT_ANNOTATION_ADDED: "DOCUMENT_ANNOTATION_ADDED";
|
|
@@ -216,15 +216,15 @@ export declare const ActivityType: {
|
|
|
216
216
|
};
|
|
217
217
|
export type ActivityType = (typeof ActivityType)[keyof typeof ActivityType];
|
|
218
218
|
export interface Activity {
|
|
219
|
-
Type?: ActivityType;
|
|
220
|
-
TimeStamp?: Date;
|
|
221
|
-
IsIndirectActivity?: boolean;
|
|
222
|
-
OrganizationId?: string;
|
|
223
|
-
Initiator?: UserMetadata;
|
|
224
|
-
Participants?: Participants;
|
|
225
|
-
ResourceMetadata?: ResourceMetadata;
|
|
226
|
-
OriginalParent?: ResourceMetadata;
|
|
227
|
-
CommentMetadata?: CommentMetadata;
|
|
219
|
+
Type?: ActivityType | undefined;
|
|
220
|
+
TimeStamp?: Date | undefined;
|
|
221
|
+
IsIndirectActivity?: boolean | undefined;
|
|
222
|
+
OrganizationId?: string | undefined;
|
|
223
|
+
Initiator?: UserMetadata | undefined;
|
|
224
|
+
Participants?: Participants | undefined;
|
|
225
|
+
ResourceMetadata?: ResourceMetadata | undefined;
|
|
226
|
+
OriginalParent?: ResourceMetadata | undefined;
|
|
227
|
+
CommentMetadata?: CommentMetadata | undefined;
|
|
228
228
|
}
|
|
229
229
|
export declare const AdditionalResponseFieldType: {
|
|
230
230
|
readonly WEBURL: "WEBURL";
|
|
@@ -232,8 +232,8 @@ export declare const AdditionalResponseFieldType: {
|
|
|
232
232
|
export type AdditionalResponseFieldType =
|
|
233
233
|
(typeof AdditionalResponseFieldType)[keyof typeof AdditionalResponseFieldType];
|
|
234
234
|
export interface NotificationOptions {
|
|
235
|
-
SendEmail?: boolean;
|
|
236
|
-
EmailMessage?: string;
|
|
235
|
+
SendEmail?: boolean | undefined;
|
|
236
|
+
EmailMessage?: string | undefined;
|
|
237
237
|
}
|
|
238
238
|
export declare const RoleType: {
|
|
239
239
|
readonly CONTRIBUTOR: "CONTRIBUTOR";
|
|
@@ -256,10 +256,10 @@ export interface SharePrincipal {
|
|
|
256
256
|
Role: RoleType | undefined;
|
|
257
257
|
}
|
|
258
258
|
export interface AddResourcePermissionsRequest {
|
|
259
|
-
AuthenticationToken?: string;
|
|
259
|
+
AuthenticationToken?: string | undefined;
|
|
260
260
|
ResourceId: string | undefined;
|
|
261
261
|
Principals: SharePrincipal[] | undefined;
|
|
262
|
-
NotificationOptions?: NotificationOptions;
|
|
262
|
+
NotificationOptions?: NotificationOptions | undefined;
|
|
263
263
|
}
|
|
264
264
|
export declare const ShareStatusType: {
|
|
265
265
|
readonly FAILURE: "FAILURE";
|
|
@@ -268,15 +268,15 @@ export declare const ShareStatusType: {
|
|
|
268
268
|
export type ShareStatusType =
|
|
269
269
|
(typeof ShareStatusType)[keyof typeof ShareStatusType];
|
|
270
270
|
export interface ShareResult {
|
|
271
|
-
PrincipalId?: string;
|
|
272
|
-
InviteePrincipalId?: string;
|
|
273
|
-
Role?: RoleType;
|
|
274
|
-
Status?: ShareStatusType;
|
|
275
|
-
ShareId?: string;
|
|
276
|
-
StatusMessage?: string;
|
|
271
|
+
PrincipalId?: string | undefined;
|
|
272
|
+
InviteePrincipalId?: string | undefined;
|
|
273
|
+
Role?: RoleType | undefined;
|
|
274
|
+
Status?: ShareStatusType | undefined;
|
|
275
|
+
ShareId?: string | undefined;
|
|
276
|
+
StatusMessage?: string | undefined;
|
|
277
277
|
}
|
|
278
278
|
export interface AddResourcePermissionsResponse {
|
|
279
|
-
ShareResults?: ShareResult[];
|
|
279
|
+
ShareResults?: ShareResult[] | undefined;
|
|
280
280
|
}
|
|
281
281
|
export declare const CommentVisibilityType: {
|
|
282
282
|
readonly PRIVATE: "PRIVATE";
|
|
@@ -285,33 +285,33 @@ export declare const CommentVisibilityType: {
|
|
|
285
285
|
export type CommentVisibilityType =
|
|
286
286
|
(typeof CommentVisibilityType)[keyof typeof CommentVisibilityType];
|
|
287
287
|
export interface CreateCommentRequest {
|
|
288
|
-
AuthenticationToken?: string;
|
|
288
|
+
AuthenticationToken?: string | undefined;
|
|
289
289
|
DocumentId: string | undefined;
|
|
290
290
|
VersionId: string | undefined;
|
|
291
|
-
ParentId?: string;
|
|
292
|
-
ThreadId?: string;
|
|
291
|
+
ParentId?: string | undefined;
|
|
292
|
+
ThreadId?: string | undefined;
|
|
293
293
|
Text: string | undefined;
|
|
294
|
-
Visibility?: CommentVisibilityType;
|
|
295
|
-
NotifyCollaborators?: boolean;
|
|
294
|
+
Visibility?: CommentVisibilityType | undefined;
|
|
295
|
+
NotifyCollaborators?: boolean | undefined;
|
|
296
296
|
}
|
|
297
297
|
export interface Comment {
|
|
298
298
|
CommentId: string | undefined;
|
|
299
|
-
ParentId?: string;
|
|
300
|
-
ThreadId?: string;
|
|
301
|
-
Text?: string;
|
|
302
|
-
Contributor?: User;
|
|
303
|
-
CreatedTimestamp?: Date;
|
|
304
|
-
Status?: CommentStatusType;
|
|
305
|
-
Visibility?: CommentVisibilityType;
|
|
306
|
-
RecipientId?: string;
|
|
299
|
+
ParentId?: string | undefined;
|
|
300
|
+
ThreadId?: string | undefined;
|
|
301
|
+
Text?: string | undefined;
|
|
302
|
+
Contributor?: User | undefined;
|
|
303
|
+
CreatedTimestamp?: Date | undefined;
|
|
304
|
+
Status?: CommentStatusType | undefined;
|
|
305
|
+
Visibility?: CommentVisibilityType | undefined;
|
|
306
|
+
RecipientId?: string | undefined;
|
|
307
307
|
}
|
|
308
308
|
export interface CreateCommentResponse {
|
|
309
|
-
Comment?: Comment;
|
|
309
|
+
Comment?: Comment | undefined;
|
|
310
310
|
}
|
|
311
311
|
export declare class DocumentLockedForCommentsException extends __BaseException {
|
|
312
312
|
readonly name: "DocumentLockedForCommentsException";
|
|
313
313
|
readonly $fault: "client";
|
|
314
|
-
Message?: string;
|
|
314
|
+
Message?: string | undefined;
|
|
315
315
|
constructor(
|
|
316
316
|
opts: __ExceptionOptionType<
|
|
317
317
|
DocumentLockedForCommentsException,
|
|
@@ -322,7 +322,7 @@ export declare class DocumentLockedForCommentsException extends __BaseException
|
|
|
322
322
|
export declare class InvalidCommentOperationException extends __BaseException {
|
|
323
323
|
readonly name: "InvalidCommentOperationException";
|
|
324
324
|
readonly $fault: "client";
|
|
325
|
-
Message?: string;
|
|
325
|
+
Message?: string | undefined;
|
|
326
326
|
constructor(
|
|
327
327
|
opts: __ExceptionOptionType<
|
|
328
328
|
InvalidCommentOperationException,
|
|
@@ -331,16 +331,16 @@ export declare class InvalidCommentOperationException extends __BaseException {
|
|
|
331
331
|
);
|
|
332
332
|
}
|
|
333
333
|
export interface CreateCustomMetadataRequest {
|
|
334
|
-
AuthenticationToken?: string;
|
|
334
|
+
AuthenticationToken?: string | undefined;
|
|
335
335
|
ResourceId: string | undefined;
|
|
336
|
-
VersionId?: string;
|
|
336
|
+
VersionId?: string | undefined;
|
|
337
337
|
CustomMetadata: Record<string, string> | undefined;
|
|
338
338
|
}
|
|
339
339
|
export interface CreateCustomMetadataResponse {}
|
|
340
340
|
export declare class CustomMetadataLimitExceededException extends __BaseException {
|
|
341
341
|
readonly name: "CustomMetadataLimitExceededException";
|
|
342
342
|
readonly $fault: "client";
|
|
343
|
-
Message?: string;
|
|
343
|
+
Message?: string | undefined;
|
|
344
344
|
constructor(
|
|
345
345
|
opts: __ExceptionOptionType<
|
|
346
346
|
CustomMetadataLimitExceededException,
|
|
@@ -351,14 +351,14 @@ export declare class CustomMetadataLimitExceededException extends __BaseExceptio
|
|
|
351
351
|
export declare class ConflictingOperationException extends __BaseException {
|
|
352
352
|
readonly name: "ConflictingOperationException";
|
|
353
353
|
readonly $fault: "client";
|
|
354
|
-
Message?: string;
|
|
354
|
+
Message?: string | undefined;
|
|
355
355
|
constructor(
|
|
356
356
|
opts: __ExceptionOptionType<ConflictingOperationException, __BaseException>
|
|
357
357
|
);
|
|
358
358
|
}
|
|
359
359
|
export interface CreateFolderRequest {
|
|
360
|
-
AuthenticationToken?: string;
|
|
361
|
-
Name?: string;
|
|
360
|
+
AuthenticationToken?: string | undefined;
|
|
361
|
+
Name?: string | undefined;
|
|
362
362
|
ParentFolderId: string | undefined;
|
|
363
363
|
}
|
|
364
364
|
export declare const ResourceStateType: {
|
|
@@ -370,25 +370,25 @@ export declare const ResourceStateType: {
|
|
|
370
370
|
export type ResourceStateType =
|
|
371
371
|
(typeof ResourceStateType)[keyof typeof ResourceStateType];
|
|
372
372
|
export interface FolderMetadata {
|
|
373
|
-
Id?: string;
|
|
374
|
-
Name?: string;
|
|
375
|
-
CreatorId?: string;
|
|
376
|
-
ParentFolderId?: string;
|
|
377
|
-
CreatedTimestamp?: Date;
|
|
378
|
-
ModifiedTimestamp?: Date;
|
|
379
|
-
ResourceState?: ResourceStateType;
|
|
380
|
-
Signature?: string;
|
|
381
|
-
Labels?: string[];
|
|
382
|
-
Size?: number;
|
|
383
|
-
LatestVersionSize?: number;
|
|
373
|
+
Id?: string | undefined;
|
|
374
|
+
Name?: string | undefined;
|
|
375
|
+
CreatorId?: string | undefined;
|
|
376
|
+
ParentFolderId?: string | undefined;
|
|
377
|
+
CreatedTimestamp?: Date | undefined;
|
|
378
|
+
ModifiedTimestamp?: Date | undefined;
|
|
379
|
+
ResourceState?: ResourceStateType | undefined;
|
|
380
|
+
Signature?: string | undefined;
|
|
381
|
+
Labels?: string[] | undefined;
|
|
382
|
+
Size?: number | undefined;
|
|
383
|
+
LatestVersionSize?: number | undefined;
|
|
384
384
|
}
|
|
385
385
|
export interface CreateFolderResponse {
|
|
386
|
-
Metadata?: FolderMetadata;
|
|
386
|
+
Metadata?: FolderMetadata | undefined;
|
|
387
387
|
}
|
|
388
388
|
export declare class EntityAlreadyExistsException extends __BaseException {
|
|
389
389
|
readonly name: "EntityAlreadyExistsException";
|
|
390
390
|
readonly $fault: "client";
|
|
391
|
-
Message?: string;
|
|
391
|
+
Message?: string | undefined;
|
|
392
392
|
constructor(
|
|
393
393
|
opts: __ExceptionOptionType<EntityAlreadyExistsException, __BaseException>
|
|
394
394
|
);
|
|
@@ -396,7 +396,7 @@ export declare class EntityAlreadyExistsException extends __BaseException {
|
|
|
396
396
|
export declare class LimitExceededException extends __BaseException {
|
|
397
397
|
readonly name: "LimitExceededException";
|
|
398
398
|
readonly $fault: "client";
|
|
399
|
-
Message?: string;
|
|
399
|
+
Message?: string | undefined;
|
|
400
400
|
constructor(
|
|
401
401
|
opts: __ExceptionOptionType<LimitExceededException, __BaseException>
|
|
402
402
|
);
|
|
@@ -404,13 +404,13 @@ export declare class LimitExceededException extends __BaseException {
|
|
|
404
404
|
export interface CreateLabelsRequest {
|
|
405
405
|
ResourceId: string | undefined;
|
|
406
406
|
Labels: string[] | undefined;
|
|
407
|
-
AuthenticationToken?: string;
|
|
407
|
+
AuthenticationToken?: string | undefined;
|
|
408
408
|
}
|
|
409
409
|
export interface CreateLabelsResponse {}
|
|
410
410
|
export declare class TooManyLabelsException extends __BaseException {
|
|
411
411
|
readonly name: "TooManyLabelsException";
|
|
412
412
|
readonly $fault: "client";
|
|
413
|
-
Message?: string;
|
|
413
|
+
Message?: string | undefined;
|
|
414
414
|
constructor(
|
|
415
415
|
opts: __ExceptionOptionType<TooManyLabelsException, __BaseException>
|
|
416
416
|
);
|
|
@@ -433,17 +433,17 @@ export interface CreateNotificationSubscriptionRequest {
|
|
|
433
433
|
SubscriptionType: SubscriptionType | undefined;
|
|
434
434
|
}
|
|
435
435
|
export interface Subscription {
|
|
436
|
-
SubscriptionId?: string;
|
|
437
|
-
EndPoint?: string;
|
|
438
|
-
Protocol?: SubscriptionProtocolType;
|
|
436
|
+
SubscriptionId?: string | undefined;
|
|
437
|
+
EndPoint?: string | undefined;
|
|
438
|
+
Protocol?: SubscriptionProtocolType | undefined;
|
|
439
439
|
}
|
|
440
440
|
export interface CreateNotificationSubscriptionResponse {
|
|
441
|
-
Subscription?: Subscription;
|
|
441
|
+
Subscription?: Subscription | undefined;
|
|
442
442
|
}
|
|
443
443
|
export declare class InvalidArgumentException extends __BaseException {
|
|
444
444
|
readonly name: "InvalidArgumentException";
|
|
445
445
|
readonly $fault: "client";
|
|
446
|
-
Message?: string;
|
|
446
|
+
Message?: string | undefined;
|
|
447
447
|
constructor(
|
|
448
448
|
opts: __ExceptionOptionType<InvalidArgumentException, __BaseException>
|
|
449
449
|
);
|
|
@@ -451,49 +451,49 @@ export declare class InvalidArgumentException extends __BaseException {
|
|
|
451
451
|
export declare class TooManySubscriptionsException extends __BaseException {
|
|
452
452
|
readonly name: "TooManySubscriptionsException";
|
|
453
453
|
readonly $fault: "client";
|
|
454
|
-
Message?: string;
|
|
454
|
+
Message?: string | undefined;
|
|
455
455
|
constructor(
|
|
456
456
|
opts: __ExceptionOptionType<TooManySubscriptionsException, __BaseException>
|
|
457
457
|
);
|
|
458
458
|
}
|
|
459
459
|
export interface CreateUserRequest {
|
|
460
|
-
OrganizationId?: string;
|
|
460
|
+
OrganizationId?: string | undefined;
|
|
461
461
|
Username: string | undefined;
|
|
462
|
-
EmailAddress?: string;
|
|
462
|
+
EmailAddress?: string | undefined;
|
|
463
463
|
GivenName: string | undefined;
|
|
464
464
|
Surname: string | undefined;
|
|
465
465
|
Password: string | undefined;
|
|
466
|
-
TimeZoneId?: string;
|
|
467
|
-
StorageRule?: StorageRuleType;
|
|
468
|
-
AuthenticationToken?: string;
|
|
466
|
+
TimeZoneId?: string | undefined;
|
|
467
|
+
StorageRule?: StorageRuleType | undefined;
|
|
468
|
+
AuthenticationToken?: string | undefined;
|
|
469
469
|
}
|
|
470
470
|
export interface CreateUserResponse {
|
|
471
|
-
User?: User;
|
|
471
|
+
User?: User | undefined;
|
|
472
472
|
}
|
|
473
473
|
export interface DeactivateUserRequest {
|
|
474
474
|
UserId: string | undefined;
|
|
475
|
-
AuthenticationToken?: string;
|
|
475
|
+
AuthenticationToken?: string | undefined;
|
|
476
476
|
}
|
|
477
477
|
export interface DeleteCommentRequest {
|
|
478
|
-
AuthenticationToken?: string;
|
|
478
|
+
AuthenticationToken?: string | undefined;
|
|
479
479
|
DocumentId: string | undefined;
|
|
480
480
|
VersionId: string | undefined;
|
|
481
481
|
CommentId: string | undefined;
|
|
482
482
|
}
|
|
483
483
|
export interface DeleteCustomMetadataRequest {
|
|
484
|
-
AuthenticationToken?: string;
|
|
484
|
+
AuthenticationToken?: string | undefined;
|
|
485
485
|
ResourceId: string | undefined;
|
|
486
|
-
VersionId?: string;
|
|
487
|
-
Keys?: string[];
|
|
488
|
-
DeleteAll?: boolean;
|
|
486
|
+
VersionId?: string | undefined;
|
|
487
|
+
Keys?: string[] | undefined;
|
|
488
|
+
DeleteAll?: boolean | undefined;
|
|
489
489
|
}
|
|
490
490
|
export interface DeleteCustomMetadataResponse {}
|
|
491
491
|
export interface DeleteDocumentRequest {
|
|
492
|
-
AuthenticationToken?: string;
|
|
492
|
+
AuthenticationToken?: string | undefined;
|
|
493
493
|
DocumentId: string | undefined;
|
|
494
494
|
}
|
|
495
495
|
export interface DeleteDocumentVersionRequest {
|
|
496
|
-
AuthenticationToken?: string;
|
|
496
|
+
AuthenticationToken?: string | undefined;
|
|
497
497
|
DocumentId: string | undefined;
|
|
498
498
|
VersionId: string | undefined;
|
|
499
499
|
DeletePriorVersions: boolean | undefined;
|
|
@@ -501,24 +501,24 @@ export interface DeleteDocumentVersionRequest {
|
|
|
501
501
|
export declare class InvalidOperationException extends __BaseException {
|
|
502
502
|
readonly name: "InvalidOperationException";
|
|
503
503
|
readonly $fault: "client";
|
|
504
|
-
Message?: string;
|
|
504
|
+
Message?: string | undefined;
|
|
505
505
|
constructor(
|
|
506
506
|
opts: __ExceptionOptionType<InvalidOperationException, __BaseException>
|
|
507
507
|
);
|
|
508
508
|
}
|
|
509
509
|
export interface DeleteFolderRequest {
|
|
510
|
-
AuthenticationToken?: string;
|
|
510
|
+
AuthenticationToken?: string | undefined;
|
|
511
511
|
FolderId: string | undefined;
|
|
512
512
|
}
|
|
513
513
|
export interface DeleteFolderContentsRequest {
|
|
514
|
-
AuthenticationToken?: string;
|
|
514
|
+
AuthenticationToken?: string | undefined;
|
|
515
515
|
FolderId: string | undefined;
|
|
516
516
|
}
|
|
517
517
|
export interface DeleteLabelsRequest {
|
|
518
518
|
ResourceId: string | undefined;
|
|
519
|
-
AuthenticationToken?: string;
|
|
520
|
-
Labels?: string[];
|
|
521
|
-
DeleteAll?: boolean;
|
|
519
|
+
AuthenticationToken?: string | undefined;
|
|
520
|
+
Labels?: string[] | undefined;
|
|
521
|
+
DeleteAll?: boolean | undefined;
|
|
522
522
|
}
|
|
523
523
|
export interface DeleteLabelsResponse {}
|
|
524
524
|
export interface DeleteNotificationSubscriptionRequest {
|
|
@@ -526,43 +526,43 @@ export interface DeleteNotificationSubscriptionRequest {
|
|
|
526
526
|
OrganizationId: string | undefined;
|
|
527
527
|
}
|
|
528
528
|
export interface DeleteUserRequest {
|
|
529
|
-
AuthenticationToken?: string;
|
|
529
|
+
AuthenticationToken?: string | undefined;
|
|
530
530
|
UserId: string | undefined;
|
|
531
531
|
}
|
|
532
532
|
export interface DescribeActivitiesRequest {
|
|
533
|
-
AuthenticationToken?: string;
|
|
534
|
-
StartTime?: Date;
|
|
535
|
-
EndTime?: Date;
|
|
536
|
-
OrganizationId?: string;
|
|
537
|
-
ActivityTypes?: string;
|
|
538
|
-
ResourceId?: string;
|
|
539
|
-
UserId?: string;
|
|
540
|
-
IncludeIndirectActivities?: boolean;
|
|
541
|
-
Limit?: number;
|
|
542
|
-
Marker?: string;
|
|
533
|
+
AuthenticationToken?: string | undefined;
|
|
534
|
+
StartTime?: Date | undefined;
|
|
535
|
+
EndTime?: Date | undefined;
|
|
536
|
+
OrganizationId?: string | undefined;
|
|
537
|
+
ActivityTypes?: string | undefined;
|
|
538
|
+
ResourceId?: string | undefined;
|
|
539
|
+
UserId?: string | undefined;
|
|
540
|
+
IncludeIndirectActivities?: boolean | undefined;
|
|
541
|
+
Limit?: number | undefined;
|
|
542
|
+
Marker?: string | undefined;
|
|
543
543
|
}
|
|
544
544
|
export interface DescribeActivitiesResponse {
|
|
545
|
-
UserActivities?: Activity[];
|
|
546
|
-
Marker?: string;
|
|
545
|
+
UserActivities?: Activity[] | undefined;
|
|
546
|
+
Marker?: string | undefined;
|
|
547
547
|
}
|
|
548
548
|
export interface DescribeCommentsRequest {
|
|
549
|
-
AuthenticationToken?: string;
|
|
549
|
+
AuthenticationToken?: string | undefined;
|
|
550
550
|
DocumentId: string | undefined;
|
|
551
551
|
VersionId: string | undefined;
|
|
552
|
-
Limit?: number;
|
|
553
|
-
Marker?: string;
|
|
552
|
+
Limit?: number | undefined;
|
|
553
|
+
Marker?: string | undefined;
|
|
554
554
|
}
|
|
555
555
|
export interface DescribeCommentsResponse {
|
|
556
|
-
Comments?: Comment[];
|
|
557
|
-
Marker?: string;
|
|
556
|
+
Comments?: Comment[] | undefined;
|
|
557
|
+
Marker?: string | undefined;
|
|
558
558
|
}
|
|
559
559
|
export interface DescribeDocumentVersionsRequest {
|
|
560
|
-
AuthenticationToken?: string;
|
|
560
|
+
AuthenticationToken?: string | undefined;
|
|
561
561
|
DocumentId: string | undefined;
|
|
562
|
-
Marker?: string;
|
|
563
|
-
Limit?: number;
|
|
564
|
-
Include?: string;
|
|
565
|
-
Fields?: string;
|
|
562
|
+
Marker?: string | undefined;
|
|
563
|
+
Limit?: number | undefined;
|
|
564
|
+
Include?: string | undefined;
|
|
565
|
+
Fields?: string | undefined;
|
|
566
566
|
}
|
|
567
567
|
export declare const DocumentSourceType: {
|
|
568
568
|
readonly ORIGINAL: "ORIGINAL";
|
|
@@ -584,28 +584,28 @@ export declare const DocumentThumbnailType: {
|
|
|
584
584
|
export type DocumentThumbnailType =
|
|
585
585
|
(typeof DocumentThumbnailType)[keyof typeof DocumentThumbnailType];
|
|
586
586
|
export interface DocumentVersionMetadata {
|
|
587
|
-
Id?: string;
|
|
588
|
-
Name?: string;
|
|
589
|
-
ContentType?: string;
|
|
590
|
-
Size?: number;
|
|
591
|
-
Signature?: string;
|
|
592
|
-
Status?: DocumentStatusType;
|
|
593
|
-
CreatedTimestamp?: Date;
|
|
594
|
-
ModifiedTimestamp?: Date;
|
|
595
|
-
ContentCreatedTimestamp?: Date;
|
|
596
|
-
ContentModifiedTimestamp?: Date;
|
|
597
|
-
CreatorId?: string;
|
|
598
|
-
Thumbnail?: Partial<Record<DocumentThumbnailType, string
|
|
599
|
-
Source?: Partial<Record<DocumentSourceType, string
|
|
587
|
+
Id?: string | undefined;
|
|
588
|
+
Name?: string | undefined;
|
|
589
|
+
ContentType?: string | undefined;
|
|
590
|
+
Size?: number | undefined;
|
|
591
|
+
Signature?: string | undefined;
|
|
592
|
+
Status?: DocumentStatusType | undefined;
|
|
593
|
+
CreatedTimestamp?: Date | undefined;
|
|
594
|
+
ModifiedTimestamp?: Date | undefined;
|
|
595
|
+
ContentCreatedTimestamp?: Date | undefined;
|
|
596
|
+
ContentModifiedTimestamp?: Date | undefined;
|
|
597
|
+
CreatorId?: string | undefined;
|
|
598
|
+
Thumbnail?: Partial<Record<DocumentThumbnailType, string>> | undefined;
|
|
599
|
+
Source?: Partial<Record<DocumentSourceType, string>> | undefined;
|
|
600
600
|
}
|
|
601
601
|
export interface DescribeDocumentVersionsResponse {
|
|
602
|
-
DocumentVersions?: DocumentVersionMetadata[];
|
|
603
|
-
Marker?: string;
|
|
602
|
+
DocumentVersions?: DocumentVersionMetadata[] | undefined;
|
|
603
|
+
Marker?: string | undefined;
|
|
604
604
|
}
|
|
605
605
|
export declare class InvalidPasswordException extends __BaseException {
|
|
606
606
|
readonly name: "InvalidPasswordException";
|
|
607
607
|
readonly $fault: "client";
|
|
608
|
-
Message?: string;
|
|
608
|
+
Message?: string | undefined;
|
|
609
609
|
constructor(
|
|
610
610
|
opts: __ExceptionOptionType<InvalidPasswordException, __BaseException>
|
|
611
611
|
);
|
|
@@ -629,56 +629,56 @@ export declare const FolderContentType: {
|
|
|
629
629
|
export type FolderContentType =
|
|
630
630
|
(typeof FolderContentType)[keyof typeof FolderContentType];
|
|
631
631
|
export interface DescribeFolderContentsRequest {
|
|
632
|
-
AuthenticationToken?: string;
|
|
632
|
+
AuthenticationToken?: string | undefined;
|
|
633
633
|
FolderId: string | undefined;
|
|
634
|
-
Sort?: ResourceSortType;
|
|
635
|
-
Order?: OrderType;
|
|
636
|
-
Limit?: number;
|
|
637
|
-
Marker?: string;
|
|
638
|
-
Type?: FolderContentType;
|
|
639
|
-
Include?: string;
|
|
634
|
+
Sort?: ResourceSortType | undefined;
|
|
635
|
+
Order?: OrderType | undefined;
|
|
636
|
+
Limit?: number | undefined;
|
|
637
|
+
Marker?: string | undefined;
|
|
638
|
+
Type?: FolderContentType | undefined;
|
|
639
|
+
Include?: string | undefined;
|
|
640
640
|
}
|
|
641
641
|
export interface DocumentMetadata {
|
|
642
|
-
Id?: string;
|
|
643
|
-
CreatorId?: string;
|
|
644
|
-
ParentFolderId?: string;
|
|
645
|
-
CreatedTimestamp?: Date;
|
|
646
|
-
ModifiedTimestamp?: Date;
|
|
647
|
-
LatestVersionMetadata?: DocumentVersionMetadata;
|
|
648
|
-
ResourceState?: ResourceStateType;
|
|
649
|
-
Labels?: string[];
|
|
642
|
+
Id?: string | undefined;
|
|
643
|
+
CreatorId?: string | undefined;
|
|
644
|
+
ParentFolderId?: string | undefined;
|
|
645
|
+
CreatedTimestamp?: Date | undefined;
|
|
646
|
+
ModifiedTimestamp?: Date | undefined;
|
|
647
|
+
LatestVersionMetadata?: DocumentVersionMetadata | undefined;
|
|
648
|
+
ResourceState?: ResourceStateType | undefined;
|
|
649
|
+
Labels?: string[] | undefined;
|
|
650
650
|
}
|
|
651
651
|
export interface DescribeFolderContentsResponse {
|
|
652
|
-
Folders?: FolderMetadata[];
|
|
653
|
-
Documents?: DocumentMetadata[];
|
|
654
|
-
Marker?: string;
|
|
652
|
+
Folders?: FolderMetadata[] | undefined;
|
|
653
|
+
Documents?: DocumentMetadata[] | undefined;
|
|
654
|
+
Marker?: string | undefined;
|
|
655
655
|
}
|
|
656
656
|
export interface DescribeGroupsRequest {
|
|
657
|
-
AuthenticationToken?: string;
|
|
657
|
+
AuthenticationToken?: string | undefined;
|
|
658
658
|
SearchQuery: string | undefined;
|
|
659
|
-
OrganizationId?: string;
|
|
660
|
-
Marker?: string;
|
|
661
|
-
Limit?: number;
|
|
659
|
+
OrganizationId?: string | undefined;
|
|
660
|
+
Marker?: string | undefined;
|
|
661
|
+
Limit?: number | undefined;
|
|
662
662
|
}
|
|
663
663
|
export interface DescribeGroupsResponse {
|
|
664
|
-
Groups?: GroupMetadata[];
|
|
665
|
-
Marker?: string;
|
|
664
|
+
Groups?: GroupMetadata[] | undefined;
|
|
665
|
+
Marker?: string | undefined;
|
|
666
666
|
}
|
|
667
667
|
export interface DescribeNotificationSubscriptionsRequest {
|
|
668
668
|
OrganizationId: string | undefined;
|
|
669
|
-
Marker?: string;
|
|
670
|
-
Limit?: number;
|
|
669
|
+
Marker?: string | undefined;
|
|
670
|
+
Limit?: number | undefined;
|
|
671
671
|
}
|
|
672
672
|
export interface DescribeNotificationSubscriptionsResponse {
|
|
673
|
-
Subscriptions?: Subscription[];
|
|
674
|
-
Marker?: string;
|
|
673
|
+
Subscriptions?: Subscription[] | undefined;
|
|
674
|
+
Marker?: string | undefined;
|
|
675
675
|
}
|
|
676
676
|
export interface DescribeResourcePermissionsRequest {
|
|
677
|
-
AuthenticationToken?: string;
|
|
677
|
+
AuthenticationToken?: string | undefined;
|
|
678
678
|
ResourceId: string | undefined;
|
|
679
|
-
PrincipalId?: string;
|
|
680
|
-
Limit?: number;
|
|
681
|
-
Marker?: string;
|
|
679
|
+
PrincipalId?: string | undefined;
|
|
680
|
+
Limit?: number | undefined;
|
|
681
|
+
Marker?: string | undefined;
|
|
682
682
|
}
|
|
683
683
|
export declare const RolePermissionType: {
|
|
684
684
|
readonly DIRECT: "DIRECT";
|
|
@@ -687,26 +687,26 @@ export declare const RolePermissionType: {
|
|
|
687
687
|
export type RolePermissionType =
|
|
688
688
|
(typeof RolePermissionType)[keyof typeof RolePermissionType];
|
|
689
689
|
export interface PermissionInfo {
|
|
690
|
-
Role?: RoleType;
|
|
691
|
-
Type?: RolePermissionType;
|
|
690
|
+
Role?: RoleType | undefined;
|
|
691
|
+
Type?: RolePermissionType | undefined;
|
|
692
692
|
}
|
|
693
693
|
export interface Principal {
|
|
694
|
-
Id?: string;
|
|
695
|
-
Type?: PrincipalType;
|
|
696
|
-
Roles?: PermissionInfo[];
|
|
694
|
+
Id?: string | undefined;
|
|
695
|
+
Type?: PrincipalType | undefined;
|
|
696
|
+
Roles?: PermissionInfo[] | undefined;
|
|
697
697
|
}
|
|
698
698
|
export interface DescribeResourcePermissionsResponse {
|
|
699
|
-
Principals?: Principal[];
|
|
700
|
-
Marker?: string;
|
|
699
|
+
Principals?: Principal[] | undefined;
|
|
700
|
+
Marker?: string | undefined;
|
|
701
701
|
}
|
|
702
702
|
export interface DescribeRootFoldersRequest {
|
|
703
703
|
AuthenticationToken: string | undefined;
|
|
704
|
-
Limit?: number;
|
|
705
|
-
Marker?: string;
|
|
704
|
+
Limit?: number | undefined;
|
|
705
|
+
Marker?: string | undefined;
|
|
706
706
|
}
|
|
707
707
|
export interface DescribeRootFoldersResponse {
|
|
708
|
-
Folders?: FolderMetadata[];
|
|
709
|
-
Marker?: string;
|
|
708
|
+
Folders?: FolderMetadata[] | undefined;
|
|
709
|
+
Marker?: string | undefined;
|
|
710
710
|
}
|
|
711
711
|
export declare const UserFilterType: {
|
|
712
712
|
readonly ACTIVE_PENDING: "ACTIVE_PENDING";
|
|
@@ -723,26 +723,26 @@ export declare const UserSortType: {
|
|
|
723
723
|
};
|
|
724
724
|
export type UserSortType = (typeof UserSortType)[keyof typeof UserSortType];
|
|
725
725
|
export interface DescribeUsersRequest {
|
|
726
|
-
AuthenticationToken?: string;
|
|
727
|
-
OrganizationId?: string;
|
|
728
|
-
UserIds?: string;
|
|
729
|
-
Query?: string;
|
|
730
|
-
Include?: UserFilterType;
|
|
731
|
-
Order?: OrderType;
|
|
732
|
-
Sort?: UserSortType;
|
|
733
|
-
Marker?: string;
|
|
734
|
-
Limit?: number;
|
|
735
|
-
Fields?: string;
|
|
726
|
+
AuthenticationToken?: string | undefined;
|
|
727
|
+
OrganizationId?: string | undefined;
|
|
728
|
+
UserIds?: string | undefined;
|
|
729
|
+
Query?: string | undefined;
|
|
730
|
+
Include?: UserFilterType | undefined;
|
|
731
|
+
Order?: OrderType | undefined;
|
|
732
|
+
Sort?: UserSortType | undefined;
|
|
733
|
+
Marker?: string | undefined;
|
|
734
|
+
Limit?: number | undefined;
|
|
735
|
+
Fields?: string | undefined;
|
|
736
736
|
}
|
|
737
737
|
export interface DescribeUsersResponse {
|
|
738
|
-
Users?: User[];
|
|
739
|
-
TotalNumberOfUsers?: number;
|
|
740
|
-
Marker?: string;
|
|
738
|
+
Users?: User[] | undefined;
|
|
739
|
+
TotalNumberOfUsers?: number | undefined;
|
|
740
|
+
Marker?: string | undefined;
|
|
741
741
|
}
|
|
742
742
|
export declare class RequestedEntityTooLargeException extends __BaseException {
|
|
743
743
|
readonly name: "RequestedEntityTooLargeException";
|
|
744
744
|
readonly $fault: "client";
|
|
745
|
-
Message?: string;
|
|
745
|
+
Message?: string | undefined;
|
|
746
746
|
constructor(
|
|
747
747
|
opts: __ExceptionOptionType<
|
|
748
748
|
RequestedEntityTooLargeException,
|
|
@@ -754,63 +754,63 @@ export interface GetCurrentUserRequest {
|
|
|
754
754
|
AuthenticationToken: string | undefined;
|
|
755
755
|
}
|
|
756
756
|
export interface GetCurrentUserResponse {
|
|
757
|
-
User?: User;
|
|
757
|
+
User?: User | undefined;
|
|
758
758
|
}
|
|
759
759
|
export interface GetDocumentRequest {
|
|
760
|
-
AuthenticationToken?: string;
|
|
760
|
+
AuthenticationToken?: string | undefined;
|
|
761
761
|
DocumentId: string | undefined;
|
|
762
|
-
IncludeCustomMetadata?: boolean;
|
|
762
|
+
IncludeCustomMetadata?: boolean | undefined;
|
|
763
763
|
}
|
|
764
764
|
export interface GetDocumentResponse {
|
|
765
|
-
Metadata?: DocumentMetadata;
|
|
766
|
-
CustomMetadata?: Record<string, string
|
|
765
|
+
Metadata?: DocumentMetadata | undefined;
|
|
766
|
+
CustomMetadata?: Record<string, string> | undefined;
|
|
767
767
|
}
|
|
768
768
|
export interface GetDocumentPathRequest {
|
|
769
|
-
AuthenticationToken?: string;
|
|
769
|
+
AuthenticationToken?: string | undefined;
|
|
770
770
|
DocumentId: string | undefined;
|
|
771
|
-
Limit?: number;
|
|
772
|
-
Fields?: string;
|
|
773
|
-
Marker?: string;
|
|
771
|
+
Limit?: number | undefined;
|
|
772
|
+
Fields?: string | undefined;
|
|
773
|
+
Marker?: string | undefined;
|
|
774
774
|
}
|
|
775
775
|
export interface ResourcePathComponent {
|
|
776
|
-
Id?: string;
|
|
777
|
-
Name?: string;
|
|
776
|
+
Id?: string | undefined;
|
|
777
|
+
Name?: string | undefined;
|
|
778
778
|
}
|
|
779
779
|
export interface ResourcePath {
|
|
780
|
-
Components?: ResourcePathComponent[];
|
|
780
|
+
Components?: ResourcePathComponent[] | undefined;
|
|
781
781
|
}
|
|
782
782
|
export interface GetDocumentPathResponse {
|
|
783
|
-
Path?: ResourcePath;
|
|
783
|
+
Path?: ResourcePath | undefined;
|
|
784
784
|
}
|
|
785
785
|
export interface GetDocumentVersionRequest {
|
|
786
|
-
AuthenticationToken?: string;
|
|
786
|
+
AuthenticationToken?: string | undefined;
|
|
787
787
|
DocumentId: string | undefined;
|
|
788
788
|
VersionId: string | undefined;
|
|
789
|
-
Fields?: string;
|
|
790
|
-
IncludeCustomMetadata?: boolean;
|
|
789
|
+
Fields?: string | undefined;
|
|
790
|
+
IncludeCustomMetadata?: boolean | undefined;
|
|
791
791
|
}
|
|
792
792
|
export interface GetDocumentVersionResponse {
|
|
793
|
-
Metadata?: DocumentVersionMetadata;
|
|
794
|
-
CustomMetadata?: Record<string, string
|
|
793
|
+
Metadata?: DocumentVersionMetadata | undefined;
|
|
794
|
+
CustomMetadata?: Record<string, string> | undefined;
|
|
795
795
|
}
|
|
796
796
|
export interface GetFolderRequest {
|
|
797
|
-
AuthenticationToken?: string;
|
|
797
|
+
AuthenticationToken?: string | undefined;
|
|
798
798
|
FolderId: string | undefined;
|
|
799
|
-
IncludeCustomMetadata?: boolean;
|
|
799
|
+
IncludeCustomMetadata?: boolean | undefined;
|
|
800
800
|
}
|
|
801
801
|
export interface GetFolderResponse {
|
|
802
|
-
Metadata?: FolderMetadata;
|
|
803
|
-
CustomMetadata?: Record<string, string
|
|
802
|
+
Metadata?: FolderMetadata | undefined;
|
|
803
|
+
CustomMetadata?: Record<string, string> | undefined;
|
|
804
804
|
}
|
|
805
805
|
export interface GetFolderPathRequest {
|
|
806
|
-
AuthenticationToken?: string;
|
|
806
|
+
AuthenticationToken?: string | undefined;
|
|
807
807
|
FolderId: string | undefined;
|
|
808
|
-
Limit?: number;
|
|
809
|
-
Fields?: string;
|
|
810
|
-
Marker?: string;
|
|
808
|
+
Limit?: number | undefined;
|
|
809
|
+
Fields?: string | undefined;
|
|
810
|
+
Marker?: string | undefined;
|
|
811
811
|
}
|
|
812
812
|
export interface GetFolderPathResponse {
|
|
813
|
-
Path?: ResourcePath;
|
|
813
|
+
Path?: ResourcePath | undefined;
|
|
814
814
|
}
|
|
815
815
|
export declare const ResourceCollectionType: {
|
|
816
816
|
readonly SHARED_WITH_ME: "SHARED_WITH_ME";
|
|
@@ -818,47 +818,47 @@ export declare const ResourceCollectionType: {
|
|
|
818
818
|
export type ResourceCollectionType =
|
|
819
819
|
(typeof ResourceCollectionType)[keyof typeof ResourceCollectionType];
|
|
820
820
|
export interface GetResourcesRequest {
|
|
821
|
-
AuthenticationToken?: string;
|
|
822
|
-
UserId?: string;
|
|
823
|
-
CollectionType?: ResourceCollectionType;
|
|
824
|
-
Limit?: number;
|
|
825
|
-
Marker?: string;
|
|
821
|
+
AuthenticationToken?: string | undefined;
|
|
822
|
+
UserId?: string | undefined;
|
|
823
|
+
CollectionType?: ResourceCollectionType | undefined;
|
|
824
|
+
Limit?: number | undefined;
|
|
825
|
+
Marker?: string | undefined;
|
|
826
826
|
}
|
|
827
827
|
export interface GetResourcesResponse {
|
|
828
|
-
Folders?: FolderMetadata[];
|
|
829
|
-
Documents?: DocumentMetadata[];
|
|
830
|
-
Marker?: string;
|
|
828
|
+
Folders?: FolderMetadata[] | undefined;
|
|
829
|
+
Documents?: DocumentMetadata[] | undefined;
|
|
830
|
+
Marker?: string | undefined;
|
|
831
831
|
}
|
|
832
832
|
export declare class DraftUploadOutOfSyncException extends __BaseException {
|
|
833
833
|
readonly name: "DraftUploadOutOfSyncException";
|
|
834
834
|
readonly $fault: "client";
|
|
835
|
-
Message?: string;
|
|
835
|
+
Message?: string | undefined;
|
|
836
836
|
constructor(
|
|
837
837
|
opts: __ExceptionOptionType<DraftUploadOutOfSyncException, __BaseException>
|
|
838
838
|
);
|
|
839
839
|
}
|
|
840
840
|
export interface InitiateDocumentVersionUploadRequest {
|
|
841
|
-
AuthenticationToken?: string;
|
|
842
|
-
Id?: string;
|
|
843
|
-
Name?: string;
|
|
844
|
-
ContentCreatedTimestamp?: Date;
|
|
845
|
-
ContentModifiedTimestamp?: Date;
|
|
846
|
-
ContentType?: string;
|
|
847
|
-
DocumentSizeInBytes?: number;
|
|
848
|
-
ParentFolderId?: string;
|
|
841
|
+
AuthenticationToken?: string | undefined;
|
|
842
|
+
Id?: string | undefined;
|
|
843
|
+
Name?: string | undefined;
|
|
844
|
+
ContentCreatedTimestamp?: Date | undefined;
|
|
845
|
+
ContentModifiedTimestamp?: Date | undefined;
|
|
846
|
+
ContentType?: string | undefined;
|
|
847
|
+
DocumentSizeInBytes?: number | undefined;
|
|
848
|
+
ParentFolderId?: string | undefined;
|
|
849
849
|
}
|
|
850
850
|
export interface UploadMetadata {
|
|
851
|
-
UploadUrl?: string;
|
|
852
|
-
SignedHeaders?: Record<string, string
|
|
851
|
+
UploadUrl?: string | undefined;
|
|
852
|
+
SignedHeaders?: Record<string, string> | undefined;
|
|
853
853
|
}
|
|
854
854
|
export interface InitiateDocumentVersionUploadResponse {
|
|
855
|
-
Metadata?: DocumentMetadata;
|
|
856
|
-
UploadMetadata?: UploadMetadata;
|
|
855
|
+
Metadata?: DocumentMetadata | undefined;
|
|
856
|
+
UploadMetadata?: UploadMetadata | undefined;
|
|
857
857
|
}
|
|
858
858
|
export declare class ResourceAlreadyCheckedOutException extends __BaseException {
|
|
859
859
|
readonly name: "ResourceAlreadyCheckedOutException";
|
|
860
860
|
readonly $fault: "client";
|
|
861
|
-
Message?: string;
|
|
861
|
+
Message?: string | undefined;
|
|
862
862
|
constructor(
|
|
863
863
|
opts: __ExceptionOptionType<
|
|
864
864
|
ResourceAlreadyCheckedOutException,
|
|
@@ -869,7 +869,7 @@ export declare class ResourceAlreadyCheckedOutException extends __BaseException
|
|
|
869
869
|
export declare class StorageLimitExceededException extends __BaseException {
|
|
870
870
|
readonly name: "StorageLimitExceededException";
|
|
871
871
|
readonly $fault: "client";
|
|
872
|
-
Message?: string;
|
|
872
|
+
Message?: string | undefined;
|
|
873
873
|
constructor(
|
|
874
874
|
opts: __ExceptionOptionType<StorageLimitExceededException, __BaseException>
|
|
875
875
|
);
|
|
@@ -877,7 +877,7 @@ export declare class StorageLimitExceededException extends __BaseException {
|
|
|
877
877
|
export declare class StorageLimitWillExceedException extends __BaseException {
|
|
878
878
|
readonly name: "StorageLimitWillExceedException";
|
|
879
879
|
readonly $fault: "client";
|
|
880
|
-
Message?: string;
|
|
880
|
+
Message?: string | undefined;
|
|
881
881
|
constructor(
|
|
882
882
|
opts: __ExceptionOptionType<
|
|
883
883
|
StorageLimitWillExceedException,
|
|
@@ -886,17 +886,17 @@ export declare class StorageLimitWillExceedException extends __BaseException {
|
|
|
886
886
|
);
|
|
887
887
|
}
|
|
888
888
|
export interface RemoveAllResourcePermissionsRequest {
|
|
889
|
-
AuthenticationToken?: string;
|
|
889
|
+
AuthenticationToken?: string | undefined;
|
|
890
890
|
ResourceId: string | undefined;
|
|
891
891
|
}
|
|
892
892
|
export interface RemoveResourcePermissionRequest {
|
|
893
|
-
AuthenticationToken?: string;
|
|
893
|
+
AuthenticationToken?: string | undefined;
|
|
894
894
|
ResourceId: string | undefined;
|
|
895
895
|
PrincipalId: string | undefined;
|
|
896
|
-
PrincipalType?: PrincipalType;
|
|
896
|
+
PrincipalType?: PrincipalType | undefined;
|
|
897
897
|
}
|
|
898
898
|
export interface RestoreDocumentVersionsRequest {
|
|
899
|
-
AuthenticationToken?: string;
|
|
899
|
+
AuthenticationToken?: string | undefined;
|
|
900
900
|
DocumentId: string | undefined;
|
|
901
901
|
}
|
|
902
902
|
export declare const ContentCategoryType: {
|
|
@@ -913,8 +913,8 @@ export declare const ContentCategoryType: {
|
|
|
913
913
|
export type ContentCategoryType =
|
|
914
914
|
(typeof ContentCategoryType)[keyof typeof ContentCategoryType];
|
|
915
915
|
export interface DateRangeType {
|
|
916
|
-
StartValue?: Date;
|
|
917
|
-
EndValue?: Date;
|
|
916
|
+
StartValue?: Date | undefined;
|
|
917
|
+
EndValue?: Date | undefined;
|
|
918
918
|
}
|
|
919
919
|
export declare const PrincipalRoleType: {
|
|
920
920
|
readonly CONTRIBUTOR: "CONTRIBUTOR";
|
|
@@ -926,7 +926,7 @@ export type PrincipalRoleType =
|
|
|
926
926
|
(typeof PrincipalRoleType)[keyof typeof PrincipalRoleType];
|
|
927
927
|
export interface SearchPrincipalType {
|
|
928
928
|
Id: string | undefined;
|
|
929
|
-
Roles?: PrincipalRoleType[];
|
|
929
|
+
Roles?: PrincipalRoleType[] | undefined;
|
|
930
930
|
}
|
|
931
931
|
export declare const SearchResourceType: {
|
|
932
932
|
readonly COMMENT: "COMMENT";
|
|
@@ -943,8 +943,8 @@ export declare const SearchCollectionType: {
|
|
|
943
943
|
export type SearchCollectionType =
|
|
944
944
|
(typeof SearchCollectionType)[keyof typeof SearchCollectionType];
|
|
945
945
|
export interface LongRangeType {
|
|
946
|
-
StartValue?: number;
|
|
947
|
-
EndValue?: number;
|
|
946
|
+
StartValue?: number | undefined;
|
|
947
|
+
EndValue?: number | undefined;
|
|
948
948
|
}
|
|
949
949
|
export declare const LanguageCodeType: {
|
|
950
950
|
readonly AR: "AR";
|
|
@@ -982,16 +982,16 @@ export declare const LanguageCodeType: {
|
|
|
982
982
|
export type LanguageCodeType =
|
|
983
983
|
(typeof LanguageCodeType)[keyof typeof LanguageCodeType];
|
|
984
984
|
export interface Filters {
|
|
985
|
-
TextLocales?: LanguageCodeType[];
|
|
986
|
-
ContentCategories?: ContentCategoryType[];
|
|
987
|
-
ResourceTypes?: SearchResourceType[];
|
|
988
|
-
Labels?: string[];
|
|
989
|
-
Principals?: SearchPrincipalType[];
|
|
990
|
-
AncestorIds?: string[];
|
|
991
|
-
SearchCollectionTypes?: SearchCollectionType[];
|
|
992
|
-
SizeRange?: LongRangeType;
|
|
993
|
-
CreatedRange?: DateRangeType;
|
|
994
|
-
ModifiedRange?: DateRangeType;
|
|
985
|
+
TextLocales?: LanguageCodeType[] | undefined;
|
|
986
|
+
ContentCategories?: ContentCategoryType[] | undefined;
|
|
987
|
+
ResourceTypes?: SearchResourceType[] | undefined;
|
|
988
|
+
Labels?: string[] | undefined;
|
|
989
|
+
Principals?: SearchPrincipalType[] | undefined;
|
|
990
|
+
AncestorIds?: string[] | undefined;
|
|
991
|
+
SearchCollectionTypes?: SearchCollectionType[] | undefined;
|
|
992
|
+
SizeRange?: LongRangeType | undefined;
|
|
993
|
+
CreatedRange?: DateRangeType | undefined;
|
|
994
|
+
ModifiedRange?: DateRangeType | undefined;
|
|
995
995
|
}
|
|
996
996
|
export declare const OrderByFieldType: {
|
|
997
997
|
readonly CREATED_TIMESTAMP: "CREATED_TIMESTAMP";
|
|
@@ -1008,8 +1008,8 @@ export declare const SortOrder: {
|
|
|
1008
1008
|
};
|
|
1009
1009
|
export type SortOrder = (typeof SortOrder)[keyof typeof SortOrder];
|
|
1010
1010
|
export interface SearchSortResult {
|
|
1011
|
-
Field?: OrderByFieldType;
|
|
1012
|
-
Order?: SortOrder;
|
|
1011
|
+
Field?: OrderByFieldType | undefined;
|
|
1012
|
+
Order?: SortOrder | undefined;
|
|
1013
1013
|
}
|
|
1014
1014
|
export declare const SearchQueryScopeType: {
|
|
1015
1015
|
readonly CONTENT: "CONTENT";
|
|
@@ -1018,15 +1018,15 @@ export declare const SearchQueryScopeType: {
|
|
|
1018
1018
|
export type SearchQueryScopeType =
|
|
1019
1019
|
(typeof SearchQueryScopeType)[keyof typeof SearchQueryScopeType];
|
|
1020
1020
|
export interface SearchResourcesRequest {
|
|
1021
|
-
AuthenticationToken?: string;
|
|
1022
|
-
QueryText?: string;
|
|
1023
|
-
QueryScopes?: SearchQueryScopeType[];
|
|
1024
|
-
OrganizationId?: string;
|
|
1025
|
-
AdditionalResponseFields?: AdditionalResponseFieldType[];
|
|
1026
|
-
Filters?: Filters;
|
|
1027
|
-
OrderBy?: SearchSortResult[];
|
|
1028
|
-
Limit?: number;
|
|
1029
|
-
Marker?: string;
|
|
1021
|
+
AuthenticationToken?: string | undefined;
|
|
1022
|
+
QueryText?: string | undefined;
|
|
1023
|
+
QueryScopes?: SearchQueryScopeType[] | undefined;
|
|
1024
|
+
OrganizationId?: string | undefined;
|
|
1025
|
+
AdditionalResponseFields?: AdditionalResponseFieldType[] | undefined;
|
|
1026
|
+
Filters?: Filters | undefined;
|
|
1027
|
+
OrderBy?: SearchSortResult[] | undefined;
|
|
1028
|
+
Limit?: number | undefined;
|
|
1029
|
+
Marker?: string | undefined;
|
|
1030
1030
|
}
|
|
1031
1031
|
export declare const ResponseItemType: {
|
|
1032
1032
|
readonly COMMENT: "COMMENT";
|
|
@@ -1037,23 +1037,23 @@ export declare const ResponseItemType: {
|
|
|
1037
1037
|
export type ResponseItemType =
|
|
1038
1038
|
(typeof ResponseItemType)[keyof typeof ResponseItemType];
|
|
1039
1039
|
export interface ResponseItem {
|
|
1040
|
-
ResourceType?: ResponseItemType;
|
|
1041
|
-
WebUrl?: string;
|
|
1042
|
-
DocumentMetadata?: DocumentMetadata;
|
|
1043
|
-
FolderMetadata?: FolderMetadata;
|
|
1044
|
-
CommentMetadata?: CommentMetadata;
|
|
1045
|
-
DocumentVersionMetadata?: DocumentVersionMetadata;
|
|
1040
|
+
ResourceType?: ResponseItemType | undefined;
|
|
1041
|
+
WebUrl?: string | undefined;
|
|
1042
|
+
DocumentMetadata?: DocumentMetadata | undefined;
|
|
1043
|
+
FolderMetadata?: FolderMetadata | undefined;
|
|
1044
|
+
CommentMetadata?: CommentMetadata | undefined;
|
|
1045
|
+
DocumentVersionMetadata?: DocumentVersionMetadata | undefined;
|
|
1046
1046
|
}
|
|
1047
1047
|
export interface SearchResourcesResponse {
|
|
1048
|
-
Items?: ResponseItem[];
|
|
1049
|
-
Marker?: string;
|
|
1048
|
+
Items?: ResponseItem[] | undefined;
|
|
1049
|
+
Marker?: string | undefined;
|
|
1050
1050
|
}
|
|
1051
1051
|
export interface UpdateDocumentRequest {
|
|
1052
|
-
AuthenticationToken?: string;
|
|
1052
|
+
AuthenticationToken?: string | undefined;
|
|
1053
1053
|
DocumentId: string | undefined;
|
|
1054
|
-
Name?: string;
|
|
1055
|
-
ParentFolderId?: string;
|
|
1056
|
-
ResourceState?: ResourceStateType;
|
|
1054
|
+
Name?: string | undefined;
|
|
1055
|
+
ParentFolderId?: string | undefined;
|
|
1056
|
+
ResourceState?: ResourceStateType | undefined;
|
|
1057
1057
|
}
|
|
1058
1058
|
export declare const DocumentVersionStatus: {
|
|
1059
1059
|
readonly ACTIVE: "ACTIVE";
|
|
@@ -1061,23 +1061,23 @@ export declare const DocumentVersionStatus: {
|
|
|
1061
1061
|
export type DocumentVersionStatus =
|
|
1062
1062
|
(typeof DocumentVersionStatus)[keyof typeof DocumentVersionStatus];
|
|
1063
1063
|
export interface UpdateDocumentVersionRequest {
|
|
1064
|
-
AuthenticationToken?: string;
|
|
1064
|
+
AuthenticationToken?: string | undefined;
|
|
1065
1065
|
DocumentId: string | undefined;
|
|
1066
1066
|
VersionId: string | undefined;
|
|
1067
|
-
VersionStatus?: DocumentVersionStatus;
|
|
1067
|
+
VersionStatus?: DocumentVersionStatus | undefined;
|
|
1068
1068
|
}
|
|
1069
1069
|
export interface UpdateFolderRequest {
|
|
1070
|
-
AuthenticationToken?: string;
|
|
1070
|
+
AuthenticationToken?: string | undefined;
|
|
1071
1071
|
FolderId: string | undefined;
|
|
1072
|
-
Name?: string;
|
|
1073
|
-
ParentFolderId?: string;
|
|
1074
|
-
ResourceState?: ResourceStateType;
|
|
1072
|
+
Name?: string | undefined;
|
|
1073
|
+
ParentFolderId?: string | undefined;
|
|
1074
|
+
ResourceState?: ResourceStateType | undefined;
|
|
1075
1075
|
}
|
|
1076
1076
|
export declare class DeactivatingLastSystemUserException extends __BaseException {
|
|
1077
1077
|
readonly name: "DeactivatingLastSystemUserException";
|
|
1078
1078
|
readonly $fault: "client";
|
|
1079
|
-
Message?: string;
|
|
1080
|
-
Code?: string;
|
|
1079
|
+
Message?: string | undefined;
|
|
1080
|
+
Code?: string | undefined;
|
|
1081
1081
|
constructor(
|
|
1082
1082
|
opts: __ExceptionOptionType<
|
|
1083
1083
|
DeactivatingLastSystemUserException,
|
|
@@ -1088,7 +1088,7 @@ export declare class DeactivatingLastSystemUserException extends __BaseException
|
|
|
1088
1088
|
export declare class IllegalUserStateException extends __BaseException {
|
|
1089
1089
|
readonly name: "IllegalUserStateException";
|
|
1090
1090
|
readonly $fault: "client";
|
|
1091
|
-
Message?: string;
|
|
1091
|
+
Message?: string | undefined;
|
|
1092
1092
|
constructor(
|
|
1093
1093
|
opts: __ExceptionOptionType<IllegalUserStateException, __BaseException>
|
|
1094
1094
|
);
|
|
@@ -1100,18 +1100,18 @@ export declare const BooleanEnumType: {
|
|
|
1100
1100
|
export type BooleanEnumType =
|
|
1101
1101
|
(typeof BooleanEnumType)[keyof typeof BooleanEnumType];
|
|
1102
1102
|
export interface UpdateUserRequest {
|
|
1103
|
-
AuthenticationToken?: string;
|
|
1103
|
+
AuthenticationToken?: string | undefined;
|
|
1104
1104
|
UserId: string | undefined;
|
|
1105
|
-
GivenName?: string;
|
|
1106
|
-
Surname?: string;
|
|
1107
|
-
Type?: UserType;
|
|
1108
|
-
StorageRule?: StorageRuleType;
|
|
1109
|
-
TimeZoneId?: string;
|
|
1110
|
-
Locale?: LocaleType;
|
|
1111
|
-
GrantPoweruserPrivileges?: BooleanEnumType;
|
|
1105
|
+
GivenName?: string | undefined;
|
|
1106
|
+
Surname?: string | undefined;
|
|
1107
|
+
Type?: UserType | undefined;
|
|
1108
|
+
StorageRule?: StorageRuleType | undefined;
|
|
1109
|
+
TimeZoneId?: string | undefined;
|
|
1110
|
+
Locale?: LocaleType | undefined;
|
|
1111
|
+
GrantPoweruserPrivileges?: BooleanEnumType | undefined;
|
|
1112
1112
|
}
|
|
1113
1113
|
export interface UpdateUserResponse {
|
|
1114
|
-
User?: User;
|
|
1114
|
+
User?: User | undefined;
|
|
1115
1115
|
}
|
|
1116
1116
|
export declare const AbortDocumentVersionUploadRequestFilterSensitiveLog: (
|
|
1117
1117
|
obj: AbortDocumentVersionUploadRequest
|