@aws-sdk/client-workdocs 3.296.0 → 3.297.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.
Files changed (60) hide show
  1. package/dist-types/WorkDocs.d.ts +45 -0
  2. package/dist-types/WorkDocsClient.d.ts +24 -4
  3. package/dist-types/commands/AbortDocumentVersionUploadCommand.d.ts +16 -0
  4. package/dist-types/commands/ActivateUserCommand.d.ts +16 -0
  5. package/dist-types/commands/AddResourcePermissionsCommand.d.ts +16 -0
  6. package/dist-types/commands/CreateCommentCommand.d.ts +16 -0
  7. package/dist-types/commands/CreateCustomMetadataCommand.d.ts +16 -0
  8. package/dist-types/commands/CreateFolderCommand.d.ts +16 -0
  9. package/dist-types/commands/CreateLabelsCommand.d.ts +16 -0
  10. package/dist-types/commands/CreateNotificationSubscriptionCommand.d.ts +16 -0
  11. package/dist-types/commands/CreateUserCommand.d.ts +16 -0
  12. package/dist-types/commands/DeactivateUserCommand.d.ts +16 -0
  13. package/dist-types/commands/DeleteCommentCommand.d.ts +16 -0
  14. package/dist-types/commands/DeleteCustomMetadataCommand.d.ts +16 -0
  15. package/dist-types/commands/DeleteDocumentCommand.d.ts +16 -0
  16. package/dist-types/commands/DeleteDocumentVersionCommand.d.ts +16 -0
  17. package/dist-types/commands/DeleteFolderCommand.d.ts +16 -0
  18. package/dist-types/commands/DeleteFolderContentsCommand.d.ts +16 -0
  19. package/dist-types/commands/DeleteLabelsCommand.d.ts +16 -0
  20. package/dist-types/commands/DeleteNotificationSubscriptionCommand.d.ts +16 -0
  21. package/dist-types/commands/DeleteUserCommand.d.ts +16 -0
  22. package/dist-types/commands/DescribeActivitiesCommand.d.ts +16 -0
  23. package/dist-types/commands/DescribeCommentsCommand.d.ts +16 -0
  24. package/dist-types/commands/DescribeDocumentVersionsCommand.d.ts +16 -0
  25. package/dist-types/commands/DescribeFolderContentsCommand.d.ts +16 -0
  26. package/dist-types/commands/DescribeGroupsCommand.d.ts +16 -0
  27. package/dist-types/commands/DescribeNotificationSubscriptionsCommand.d.ts +16 -0
  28. package/dist-types/commands/DescribeResourcePermissionsCommand.d.ts +16 -0
  29. package/dist-types/commands/DescribeRootFoldersCommand.d.ts +16 -0
  30. package/dist-types/commands/DescribeUsersCommand.d.ts +16 -0
  31. package/dist-types/commands/GetCurrentUserCommand.d.ts +16 -0
  32. package/dist-types/commands/GetDocumentCommand.d.ts +16 -0
  33. package/dist-types/commands/GetDocumentPathCommand.d.ts +16 -0
  34. package/dist-types/commands/GetDocumentVersionCommand.d.ts +16 -0
  35. package/dist-types/commands/GetFolderCommand.d.ts +16 -0
  36. package/dist-types/commands/GetFolderPathCommand.d.ts +16 -0
  37. package/dist-types/commands/GetResourcesCommand.d.ts +16 -0
  38. package/dist-types/commands/InitiateDocumentVersionUploadCommand.d.ts +16 -0
  39. package/dist-types/commands/RemoveAllResourcePermissionsCommand.d.ts +16 -0
  40. package/dist-types/commands/RemoveResourcePermissionCommand.d.ts +16 -0
  41. package/dist-types/commands/RestoreDocumentVersionsCommand.d.ts +16 -0
  42. package/dist-types/commands/SearchResourcesCommand.d.ts +16 -0
  43. package/dist-types/commands/UpdateDocumentCommand.d.ts +16 -0
  44. package/dist-types/commands/UpdateDocumentVersionCommand.d.ts +16 -0
  45. package/dist-types/commands/UpdateFolderCommand.d.ts +16 -0
  46. package/dist-types/commands/UpdateUserCommand.d.ts +16 -0
  47. package/dist-types/models/WorkDocsServiceException.d.ts +2 -0
  48. package/dist-types/models/models_0.d.ts +380 -0
  49. package/dist-types/pagination/DescribeActivitiesPaginator.d.ts +3 -0
  50. package/dist-types/pagination/DescribeCommentsPaginator.d.ts +3 -0
  51. package/dist-types/pagination/DescribeDocumentVersionsPaginator.d.ts +3 -0
  52. package/dist-types/pagination/DescribeFolderContentsPaginator.d.ts +3 -0
  53. package/dist-types/pagination/DescribeGroupsPaginator.d.ts +3 -0
  54. package/dist-types/pagination/DescribeNotificationSubscriptionsPaginator.d.ts +3 -0
  55. package/dist-types/pagination/DescribeResourcePermissionsPaginator.d.ts +3 -0
  56. package/dist-types/pagination/DescribeRootFoldersPaginator.d.ts +3 -0
  57. package/dist-types/pagination/DescribeUsersPaginator.d.ts +3 -0
  58. package/dist-types/pagination/Interfaces.d.ts +3 -0
  59. package/dist-types/pagination/SearchResourcesPaginator.d.ts +3 -0
  60. package/package.json +3 -3
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetDocumentPathRequest, GetDocumentPathResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, WorkDocsClientResolvedConfig } from "../WorkDocsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetDocumentPathCommand}.
8
10
  */
9
11
  export interface GetDocumentPathCommandInput extends GetDocumentPathRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetDocumentPathCommand}.
13
17
  */
14
18
  export interface GetDocumentPathCommandOutput extends GetDocumentPathResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves the path information (the hierarchy from the root folder) for the
18
23
  * requested document.</p>
19
24
  * <p>By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the
@@ -30,6 +35,8 @@ export interface GetDocumentPathCommandOutput extends GetDocumentPathResponse, _
30
35
  * const response = await client.send(command);
31
36
  * ```
32
37
  *
38
+ * @param GetDocumentPathCommandInput - {@link GetDocumentPathCommandInput}
39
+ * @returns {@link GetDocumentPathCommandOutput}
33
40
  * @see {@link GetDocumentPathCommandInput} for command's `input` shape.
34
41
  * @see {@link GetDocumentPathCommandOutput} for command's `response` shape.
35
42
  * @see {@link WorkDocsClientResolvedConfig | config} for WorkDocsClient's `config` shape.
@@ -56,11 +63,20 @@ export interface GetDocumentPathCommandOutput extends GetDocumentPathResponse, _
56
63
  export declare class GetDocumentPathCommand extends $Command<GetDocumentPathCommandInput, GetDocumentPathCommandOutput, WorkDocsClientResolvedConfig> {
57
64
  readonly input: GetDocumentPathCommandInput;
58
65
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
66
+ /**
67
+ * @public
68
+ */
59
69
  constructor(input: GetDocumentPathCommandInput);
60
70
  /**
61
71
  * @internal
62
72
  */
63
73
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkDocsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetDocumentPathCommandInput, GetDocumentPathCommandOutput>;
74
+ /**
75
+ * @internal
76
+ */
64
77
  private serialize;
78
+ /**
79
+ * @internal
80
+ */
65
81
  private deserialize;
66
82
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetDocumentVersionRequest, GetDocumentVersionResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, WorkDocsClientResolvedConfig } from "../WorkDocsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetDocumentVersionCommand}.
8
10
  */
9
11
  export interface GetDocumentVersionCommandInput extends GetDocumentVersionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetDocumentVersionCommand}.
13
17
  */
14
18
  export interface GetDocumentVersionCommandOutput extends GetDocumentVersionResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves version metadata for the specified document.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface GetDocumentVersionCommandOutput extends GetDocumentVersionRespo
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetDocumentVersionCommandInput - {@link GetDocumentVersionCommandInput}
34
+ * @returns {@link GetDocumentVersionCommandOutput}
28
35
  * @see {@link GetDocumentVersionCommandInput} for command's `input` shape.
29
36
  * @see {@link GetDocumentVersionCommandOutput} for command's `response` shape.
30
37
  * @see {@link WorkDocsClientResolvedConfig | config} for WorkDocsClient's `config` shape.
@@ -57,11 +64,20 @@ export interface GetDocumentVersionCommandOutput extends GetDocumentVersionRespo
57
64
  export declare class GetDocumentVersionCommand extends $Command<GetDocumentVersionCommandInput, GetDocumentVersionCommandOutput, WorkDocsClientResolvedConfig> {
58
65
  readonly input: GetDocumentVersionCommandInput;
59
66
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
67
+ /**
68
+ * @public
69
+ */
60
70
  constructor(input: GetDocumentVersionCommandInput);
61
71
  /**
62
72
  * @internal
63
73
  */
64
74
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkDocsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetDocumentVersionCommandInput, GetDocumentVersionCommandOutput>;
75
+ /**
76
+ * @internal
77
+ */
65
78
  private serialize;
79
+ /**
80
+ * @internal
81
+ */
66
82
  private deserialize;
67
83
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetFolderRequest, GetFolderResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, WorkDocsClientResolvedConfig } from "../WorkDocsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetFolderCommand}.
8
10
  */
9
11
  export interface GetFolderCommandInput extends GetFolderRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetFolderCommand}.
13
17
  */
14
18
  export interface GetFolderCommandOutput extends GetFolderResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves the metadata of the specified folder.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface GetFolderCommandOutput extends GetFolderResponse, __MetadataBea
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetFolderCommandInput - {@link GetFolderCommandInput}
34
+ * @returns {@link GetFolderCommandOutput}
28
35
  * @see {@link GetFolderCommandInput} for command's `input` shape.
29
36
  * @see {@link GetFolderCommandOutput} for command's `response` shape.
30
37
  * @see {@link WorkDocsClientResolvedConfig | config} for WorkDocsClient's `config` shape.
@@ -57,11 +64,20 @@ export interface GetFolderCommandOutput extends GetFolderResponse, __MetadataBea
57
64
  export declare class GetFolderCommand extends $Command<GetFolderCommandInput, GetFolderCommandOutput, WorkDocsClientResolvedConfig> {
58
65
  readonly input: GetFolderCommandInput;
59
66
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
67
+ /**
68
+ * @public
69
+ */
60
70
  constructor(input: GetFolderCommandInput);
61
71
  /**
62
72
  * @internal
63
73
  */
64
74
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkDocsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetFolderCommandInput, GetFolderCommandOutput>;
75
+ /**
76
+ * @internal
77
+ */
65
78
  private serialize;
79
+ /**
80
+ * @internal
81
+ */
66
82
  private deserialize;
67
83
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetFolderPathRequest, GetFolderPathResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, WorkDocsClientResolvedConfig } from "../WorkDocsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetFolderPathCommand}.
8
10
  */
9
11
  export interface GetFolderPathCommandInput extends GetFolderPathRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetFolderPathCommand}.
13
17
  */
14
18
  export interface GetFolderPathCommandOutput extends GetFolderPathResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves the path information (the hierarchy from the root folder) for the
18
23
  * specified folder.</p>
19
24
  * <p>By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the
@@ -30,6 +35,8 @@ export interface GetFolderPathCommandOutput extends GetFolderPathResponse, __Met
30
35
  * const response = await client.send(command);
31
36
  * ```
32
37
  *
38
+ * @param GetFolderPathCommandInput - {@link GetFolderPathCommandInput}
39
+ * @returns {@link GetFolderPathCommandOutput}
33
40
  * @see {@link GetFolderPathCommandInput} for command's `input` shape.
34
41
  * @see {@link GetFolderPathCommandOutput} for command's `response` shape.
35
42
  * @see {@link WorkDocsClientResolvedConfig | config} for WorkDocsClient's `config` shape.
@@ -56,11 +63,20 @@ export interface GetFolderPathCommandOutput extends GetFolderPathResponse, __Met
56
63
  export declare class GetFolderPathCommand extends $Command<GetFolderPathCommandInput, GetFolderPathCommandOutput, WorkDocsClientResolvedConfig> {
57
64
  readonly input: GetFolderPathCommandInput;
58
65
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
66
+ /**
67
+ * @public
68
+ */
59
69
  constructor(input: GetFolderPathCommandInput);
60
70
  /**
61
71
  * @internal
62
72
  */
63
73
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkDocsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetFolderPathCommandInput, GetFolderPathCommandOutput>;
74
+ /**
75
+ * @internal
76
+ */
64
77
  private serialize;
78
+ /**
79
+ * @internal
80
+ */
65
81
  private deserialize;
66
82
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetResourcesRequest, GetResourcesResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, WorkDocsClientResolvedConfig } from "../WorkDocsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetResourcesCommand}.
8
10
  */
9
11
  export interface GetResourcesCommandInput extends GetResourcesRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetResourcesCommand}.
13
17
  */
14
18
  export interface GetResourcesCommandOutput extends GetResourcesResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves a collection of resources, including folders and documents. The only
18
23
  * <code>CollectionType</code> supported is <code>SHARED_WITH_ME</code>.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface GetResourcesCommandOutput extends GetResourcesResponse, __Metad
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param GetResourcesCommandInput - {@link GetResourcesCommandInput}
35
+ * @returns {@link GetResourcesCommandOutput}
29
36
  * @see {@link GetResourcesCommandInput} for command's `input` shape.
30
37
  * @see {@link GetResourcesCommandOutput} for command's `response` shape.
31
38
  * @see {@link WorkDocsClientResolvedConfig | config} for WorkDocsClient's `config` shape.
@@ -52,11 +59,20 @@ export interface GetResourcesCommandOutput extends GetResourcesResponse, __Metad
52
59
  export declare class GetResourcesCommand extends $Command<GetResourcesCommandInput, GetResourcesCommandOutput, WorkDocsClientResolvedConfig> {
53
60
  readonly input: GetResourcesCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: GetResourcesCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkDocsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetResourcesCommandInput, GetResourcesCommandOutput>;
70
+ /**
71
+ * @internal
72
+ */
60
73
  private serialize;
74
+ /**
75
+ * @internal
76
+ */
61
77
  private deserialize;
62
78
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { InitiateDocumentVersionUploadRequest, InitiateDocumentVersionUploadResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, WorkDocsClientResolvedConfig } from "../WorkDocsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link InitiateDocumentVersionUploadCommand}.
8
10
  */
9
11
  export interface InitiateDocumentVersionUploadCommandInput extends InitiateDocumentVersionUploadRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link InitiateDocumentVersionUploadCommand}.
13
17
  */
14
18
  export interface InitiateDocumentVersionUploadCommandOutput extends InitiateDocumentVersionUploadResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a new document object and version object.</p>
18
23
  * <p>The client specifies the parent folder ID and name of the document to upload. The
19
24
  * ID is optionally specified when creating a new version of an existing document. This is
@@ -30,6 +35,8 @@ export interface InitiateDocumentVersionUploadCommandOutput extends InitiateDocu
30
35
  * const response = await client.send(command);
31
36
  * ```
32
37
  *
38
+ * @param InitiateDocumentVersionUploadCommandInput - {@link InitiateDocumentVersionUploadCommandInput}
39
+ * @returns {@link InitiateDocumentVersionUploadCommandOutput}
33
40
  * @see {@link InitiateDocumentVersionUploadCommandInput} for command's `input` shape.
34
41
  * @see {@link InitiateDocumentVersionUploadCommandOutput} for command's `response` shape.
35
42
  * @see {@link WorkDocsClientResolvedConfig | config} for WorkDocsClient's `config` shape.
@@ -84,11 +91,20 @@ export interface InitiateDocumentVersionUploadCommandOutput extends InitiateDocu
84
91
  export declare class InitiateDocumentVersionUploadCommand extends $Command<InitiateDocumentVersionUploadCommandInput, InitiateDocumentVersionUploadCommandOutput, WorkDocsClientResolvedConfig> {
85
92
  readonly input: InitiateDocumentVersionUploadCommandInput;
86
93
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
94
+ /**
95
+ * @public
96
+ */
87
97
  constructor(input: InitiateDocumentVersionUploadCommandInput);
88
98
  /**
89
99
  * @internal
90
100
  */
91
101
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkDocsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<InitiateDocumentVersionUploadCommandInput, InitiateDocumentVersionUploadCommandOutput>;
102
+ /**
103
+ * @internal
104
+ */
92
105
  private serialize;
106
+ /**
107
+ * @internal
108
+ */
93
109
  private deserialize;
94
110
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { RemoveAllResourcePermissionsRequest } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, WorkDocsClientResolvedConfig } from "../WorkDocsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link RemoveAllResourcePermissionsCommand}.
8
10
  */
9
11
  export interface RemoveAllResourcePermissionsCommandInput extends RemoveAllResourcePermissionsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link RemoveAllResourcePermissionsCommand}.
13
17
  */
14
18
  export interface RemoveAllResourcePermissionsCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Removes all the permissions from the specified resource.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface RemoveAllResourcePermissionsCommandOutput extends __MetadataBea
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param RemoveAllResourcePermissionsCommandInput - {@link RemoveAllResourcePermissionsCommandInput}
34
+ * @returns {@link RemoveAllResourcePermissionsCommandOutput}
28
35
  * @see {@link RemoveAllResourcePermissionsCommandInput} for command's `input` shape.
29
36
  * @see {@link RemoveAllResourcePermissionsCommandOutput} for command's `response` shape.
30
37
  * @see {@link WorkDocsClientResolvedConfig | config} for WorkDocsClient's `config` shape.
@@ -48,11 +55,20 @@ export interface RemoveAllResourcePermissionsCommandOutput extends __MetadataBea
48
55
  export declare class RemoveAllResourcePermissionsCommand extends $Command<RemoveAllResourcePermissionsCommandInput, RemoveAllResourcePermissionsCommandOutput, WorkDocsClientResolvedConfig> {
49
56
  readonly input: RemoveAllResourcePermissionsCommandInput;
50
57
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
58
+ /**
59
+ * @public
60
+ */
51
61
  constructor(input: RemoveAllResourcePermissionsCommandInput);
52
62
  /**
53
63
  * @internal
54
64
  */
55
65
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkDocsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<RemoveAllResourcePermissionsCommandInput, RemoveAllResourcePermissionsCommandOutput>;
66
+ /**
67
+ * @internal
68
+ */
56
69
  private serialize;
70
+ /**
71
+ * @internal
72
+ */
57
73
  private deserialize;
58
74
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { RemoveResourcePermissionRequest } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, WorkDocsClientResolvedConfig } from "../WorkDocsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link RemoveResourcePermissionCommand}.
8
10
  */
9
11
  export interface RemoveResourcePermissionCommandInput extends RemoveResourcePermissionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link RemoveResourcePermissionCommand}.
13
17
  */
14
18
  export interface RemoveResourcePermissionCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Removes the permission for the specified principal from the specified
18
23
  * resource.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface RemoveResourcePermissionCommandOutput extends __MetadataBearer
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param RemoveResourcePermissionCommandInput - {@link RemoveResourcePermissionCommandInput}
35
+ * @returns {@link RemoveResourcePermissionCommandOutput}
29
36
  * @see {@link RemoveResourcePermissionCommandInput} for command's `input` shape.
30
37
  * @see {@link RemoveResourcePermissionCommandOutput} for command's `response` shape.
31
38
  * @see {@link WorkDocsClientResolvedConfig | config} for WorkDocsClient's `config` shape.
@@ -49,11 +56,20 @@ export interface RemoveResourcePermissionCommandOutput extends __MetadataBearer
49
56
  export declare class RemoveResourcePermissionCommand extends $Command<RemoveResourcePermissionCommandInput, RemoveResourcePermissionCommandOutput, WorkDocsClientResolvedConfig> {
50
57
  readonly input: RemoveResourcePermissionCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: RemoveResourcePermissionCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkDocsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<RemoveResourcePermissionCommandInput, RemoveResourcePermissionCommandOutput>;
67
+ /**
68
+ * @internal
69
+ */
57
70
  private serialize;
71
+ /**
72
+ * @internal
73
+ */
58
74
  private deserialize;
59
75
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { RestoreDocumentVersionsRequest } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, WorkDocsClientResolvedConfig } from "../WorkDocsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link RestoreDocumentVersionsCommand}.
8
10
  */
9
11
  export interface RestoreDocumentVersionsCommandInput extends RestoreDocumentVersionsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link RestoreDocumentVersionsCommand}.
13
17
  */
14
18
  export interface RestoreDocumentVersionsCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Recovers a deleted version of an Amazon WorkDocs document.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface RestoreDocumentVersionsCommandOutput extends __MetadataBearer {
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param RestoreDocumentVersionsCommandInput - {@link RestoreDocumentVersionsCommandInput}
34
+ * @returns {@link RestoreDocumentVersionsCommandOutput}
28
35
  * @see {@link RestoreDocumentVersionsCommandInput} for command's `input` shape.
29
36
  * @see {@link RestoreDocumentVersionsCommandOutput} for command's `response` shape.
30
37
  * @see {@link WorkDocsClientResolvedConfig | config} for WorkDocsClient's `config` shape.
@@ -60,11 +67,20 @@ export interface RestoreDocumentVersionsCommandOutput extends __MetadataBearer {
60
67
  export declare class RestoreDocumentVersionsCommand extends $Command<RestoreDocumentVersionsCommandInput, RestoreDocumentVersionsCommandOutput, WorkDocsClientResolvedConfig> {
61
68
  readonly input: RestoreDocumentVersionsCommandInput;
62
69
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
70
+ /**
71
+ * @public
72
+ */
63
73
  constructor(input: RestoreDocumentVersionsCommandInput);
64
74
  /**
65
75
  * @internal
66
76
  */
67
77
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkDocsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<RestoreDocumentVersionsCommandInput, RestoreDocumentVersionsCommandOutput>;
78
+ /**
79
+ * @internal
80
+ */
68
81
  private serialize;
82
+ /**
83
+ * @internal
84
+ */
69
85
  private deserialize;
70
86
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { SearchResourcesRequest, SearchResourcesResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, WorkDocsClientResolvedConfig } from "../WorkDocsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link SearchResourcesCommand}.
8
10
  */
9
11
  export interface SearchResourcesCommandInput extends SearchResourcesRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link SearchResourcesCommand}.
13
17
  */
14
18
  export interface SearchResourcesCommandOutput extends SearchResourcesResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Searches metadata and the content of folders, documents, document versions, and comments.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface SearchResourcesCommandOutput extends SearchResourcesResponse, _
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param SearchResourcesCommandInput - {@link SearchResourcesCommandInput}
34
+ * @returns {@link SearchResourcesCommandOutput}
28
35
  * @see {@link SearchResourcesCommandInput} for command's `input` shape.
29
36
  * @see {@link SearchResourcesCommandOutput} for command's `response` shape.
30
37
  * @see {@link WorkDocsClientResolvedConfig | config} for WorkDocsClient's `config` shape.
@@ -46,11 +53,20 @@ export interface SearchResourcesCommandOutput extends SearchResourcesResponse, _
46
53
  export declare class SearchResourcesCommand extends $Command<SearchResourcesCommandInput, SearchResourcesCommandOutput, WorkDocsClientResolvedConfig> {
47
54
  readonly input: SearchResourcesCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: SearchResourcesCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkDocsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<SearchResourcesCommandInput, SearchResourcesCommandOutput>;
64
+ /**
65
+ * @internal
66
+ */
54
67
  private serialize;
68
+ /**
69
+ * @internal
70
+ */
55
71
  private deserialize;
56
72
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { UpdateDocumentRequest } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, WorkDocsClientResolvedConfig } from "../WorkDocsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UpdateDocumentCommand}.
8
10
  */
9
11
  export interface UpdateDocumentCommandInput extends UpdateDocumentRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UpdateDocumentCommand}.
13
17
  */
14
18
  export interface UpdateDocumentCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Updates the specified attributes of a document. The user must have access to both
18
23
  * the document and its parent folder, if applicable.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface UpdateDocumentCommandOutput extends __MetadataBearer {
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param UpdateDocumentCommandInput - {@link UpdateDocumentCommandInput}
35
+ * @returns {@link UpdateDocumentCommandOutput}
29
36
  * @see {@link UpdateDocumentCommandInput} for command's `input` shape.
30
37
  * @see {@link UpdateDocumentCommandOutput} for command's `response` shape.
31
38
  * @see {@link WorkDocsClientResolvedConfig | config} for WorkDocsClient's `config` shape.
@@ -67,11 +74,20 @@ export interface UpdateDocumentCommandOutput extends __MetadataBearer {
67
74
  export declare class UpdateDocumentCommand extends $Command<UpdateDocumentCommandInput, UpdateDocumentCommandOutput, WorkDocsClientResolvedConfig> {
68
75
  readonly input: UpdateDocumentCommandInput;
69
76
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
77
+ /**
78
+ * @public
79
+ */
70
80
  constructor(input: UpdateDocumentCommandInput);
71
81
  /**
72
82
  * @internal
73
83
  */
74
84
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkDocsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateDocumentCommandInput, UpdateDocumentCommandOutput>;
85
+ /**
86
+ * @internal
87
+ */
75
88
  private serialize;
89
+ /**
90
+ * @internal
91
+ */
76
92
  private deserialize;
77
93
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { UpdateDocumentVersionRequest } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, WorkDocsClientResolvedConfig } from "../WorkDocsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UpdateDocumentVersionCommand}.
8
10
  */
9
11
  export interface UpdateDocumentVersionCommandInput extends UpdateDocumentVersionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UpdateDocumentVersionCommand}.
13
17
  */
14
18
  export interface UpdateDocumentVersionCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Changes the status of the document version to ACTIVE. </p>
18
23
  * <p>Amazon WorkDocs also sets its document container to ACTIVE. This is the last step
19
24
  * in a document upload, after the client uploads the document to an S3-presigned URL
@@ -28,6 +33,8 @@ export interface UpdateDocumentVersionCommandOutput extends __MetadataBearer {
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param UpdateDocumentVersionCommandInput - {@link UpdateDocumentVersionCommandInput}
37
+ * @returns {@link UpdateDocumentVersionCommandOutput}
31
38
  * @see {@link UpdateDocumentVersionCommandInput} for command's `input` shape.
32
39
  * @see {@link UpdateDocumentVersionCommandOutput} for command's `response` shape.
33
40
  * @see {@link WorkDocsClientResolvedConfig | config} for WorkDocsClient's `config` shape.
@@ -63,11 +70,20 @@ export interface UpdateDocumentVersionCommandOutput extends __MetadataBearer {
63
70
  export declare class UpdateDocumentVersionCommand extends $Command<UpdateDocumentVersionCommandInput, UpdateDocumentVersionCommandOutput, WorkDocsClientResolvedConfig> {
64
71
  readonly input: UpdateDocumentVersionCommandInput;
65
72
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
73
+ /**
74
+ * @public
75
+ */
66
76
  constructor(input: UpdateDocumentVersionCommandInput);
67
77
  /**
68
78
  * @internal
69
79
  */
70
80
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkDocsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateDocumentVersionCommandInput, UpdateDocumentVersionCommandOutput>;
81
+ /**
82
+ * @internal
83
+ */
71
84
  private serialize;
85
+ /**
86
+ * @internal
87
+ */
72
88
  private deserialize;
73
89
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { UpdateFolderRequest } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, WorkDocsClientResolvedConfig } from "../WorkDocsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UpdateFolderCommand}.
8
10
  */
9
11
  export interface UpdateFolderCommandInput extends UpdateFolderRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UpdateFolderCommand}.
13
17
  */
14
18
  export interface UpdateFolderCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Updates the specified attributes of the specified folder. The user must have access
18
23
  * to both the folder and its parent folder, if applicable.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface UpdateFolderCommandOutput extends __MetadataBearer {
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param UpdateFolderCommandInput - {@link UpdateFolderCommandInput}
35
+ * @returns {@link UpdateFolderCommandOutput}
29
36
  * @see {@link UpdateFolderCommandInput} for command's `input` shape.
30
37
  * @see {@link UpdateFolderCommandOutput} for command's `response` shape.
31
38
  * @see {@link WorkDocsClientResolvedConfig | config} for WorkDocsClient's `config` shape.
@@ -67,11 +74,20 @@ export interface UpdateFolderCommandOutput extends __MetadataBearer {
67
74
  export declare class UpdateFolderCommand extends $Command<UpdateFolderCommandInput, UpdateFolderCommandOutput, WorkDocsClientResolvedConfig> {
68
75
  readonly input: UpdateFolderCommandInput;
69
76
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
77
+ /**
78
+ * @public
79
+ */
70
80
  constructor(input: UpdateFolderCommandInput);
71
81
  /**
72
82
  * @internal
73
83
  */
74
84
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkDocsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateFolderCommandInput, UpdateFolderCommandOutput>;
85
+ /**
86
+ * @internal
87
+ */
75
88
  private serialize;
89
+ /**
90
+ * @internal
91
+ */
76
92
  private deserialize;
77
93
  }