@aws-sdk/client-workdocs 3.296.0 → 3.298.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 (109) hide show
  1. package/dist-cjs/commands/AbortDocumentVersionUploadCommand.js +1 -1
  2. package/dist-cjs/commands/CreateCustomMetadataCommand.js +1 -1
  3. package/dist-cjs/commands/CreateLabelsCommand.js +1 -1
  4. package/dist-cjs/commands/CreateNotificationSubscriptionCommand.js +2 -3
  5. package/dist-cjs/commands/DeactivateUserCommand.js +1 -1
  6. package/dist-cjs/commands/DeleteCommentCommand.js +1 -1
  7. package/dist-cjs/commands/DeleteCustomMetadataCommand.js +1 -1
  8. package/dist-cjs/commands/DeleteDocumentCommand.js +1 -1
  9. package/dist-cjs/commands/DeleteDocumentVersionCommand.js +1 -1
  10. package/dist-cjs/commands/DeleteFolderCommand.js +1 -1
  11. package/dist-cjs/commands/DeleteFolderContentsCommand.js +1 -1
  12. package/dist-cjs/commands/DeleteLabelsCommand.js +1 -1
  13. package/dist-cjs/commands/DeleteNotificationSubscriptionCommand.js +2 -3
  14. package/dist-cjs/commands/DeleteUserCommand.js +1 -1
  15. package/dist-cjs/commands/DescribeGroupsCommand.js +1 -1
  16. package/dist-cjs/commands/DescribeNotificationSubscriptionsCommand.js +2 -3
  17. package/dist-cjs/commands/DescribeResourcePermissionsCommand.js +1 -1
  18. package/dist-cjs/commands/RemoveAllResourcePermissionsCommand.js +1 -1
  19. package/dist-cjs/commands/RemoveResourcePermissionCommand.js +1 -1
  20. package/dist-cjs/commands/RestoreDocumentVersionsCommand.js +1 -1
  21. package/dist-cjs/commands/UpdateDocumentCommand.js +1 -1
  22. package/dist-cjs/commands/UpdateDocumentVersionCommand.js +1 -1
  23. package/dist-cjs/commands/UpdateFolderCommand.js +1 -1
  24. package/dist-cjs/models/models_0.js +2 -95
  25. package/dist-es/commands/AbortDocumentVersionUploadCommand.js +1 -1
  26. package/dist-es/commands/CreateCustomMetadataCommand.js +2 -2
  27. package/dist-es/commands/CreateLabelsCommand.js +2 -2
  28. package/dist-es/commands/CreateNotificationSubscriptionCommand.js +2 -3
  29. package/dist-es/commands/DeactivateUserCommand.js +1 -1
  30. package/dist-es/commands/DeleteCommentCommand.js +1 -1
  31. package/dist-es/commands/DeleteCustomMetadataCommand.js +2 -2
  32. package/dist-es/commands/DeleteDocumentCommand.js +1 -1
  33. package/dist-es/commands/DeleteDocumentVersionCommand.js +1 -1
  34. package/dist-es/commands/DeleteFolderCommand.js +1 -1
  35. package/dist-es/commands/DeleteFolderContentsCommand.js +1 -1
  36. package/dist-es/commands/DeleteLabelsCommand.js +2 -2
  37. package/dist-es/commands/DeleteNotificationSubscriptionCommand.js +2 -3
  38. package/dist-es/commands/DeleteUserCommand.js +1 -1
  39. package/dist-es/commands/DescribeGroupsCommand.js +2 -2
  40. package/dist-es/commands/DescribeNotificationSubscriptionsCommand.js +2 -3
  41. package/dist-es/commands/DescribeResourcePermissionsCommand.js +2 -2
  42. package/dist-es/commands/RemoveAllResourcePermissionsCommand.js +1 -1
  43. package/dist-es/commands/RemoveResourcePermissionCommand.js +1 -1
  44. package/dist-es/commands/RestoreDocumentVersionsCommand.js +1 -1
  45. package/dist-es/commands/UpdateDocumentCommand.js +1 -1
  46. package/dist-es/commands/UpdateDocumentVersionCommand.js +1 -1
  47. package/dist-es/commands/UpdateFolderCommand.js +1 -1
  48. package/dist-es/models/models_0.js +0 -69
  49. package/dist-types/WorkDocs.d.ts +45 -0
  50. package/dist-types/WorkDocsClient.d.ts +24 -4
  51. package/dist-types/commands/AbortDocumentVersionUploadCommand.d.ts +16 -0
  52. package/dist-types/commands/ActivateUserCommand.d.ts +16 -0
  53. package/dist-types/commands/AddResourcePermissionsCommand.d.ts +16 -0
  54. package/dist-types/commands/CreateCommentCommand.d.ts +16 -0
  55. package/dist-types/commands/CreateCustomMetadataCommand.d.ts +16 -0
  56. package/dist-types/commands/CreateFolderCommand.d.ts +16 -0
  57. package/dist-types/commands/CreateLabelsCommand.d.ts +16 -0
  58. package/dist-types/commands/CreateNotificationSubscriptionCommand.d.ts +16 -0
  59. package/dist-types/commands/CreateUserCommand.d.ts +16 -0
  60. package/dist-types/commands/DeactivateUserCommand.d.ts +16 -0
  61. package/dist-types/commands/DeleteCommentCommand.d.ts +16 -0
  62. package/dist-types/commands/DeleteCustomMetadataCommand.d.ts +16 -0
  63. package/dist-types/commands/DeleteDocumentCommand.d.ts +16 -0
  64. package/dist-types/commands/DeleteDocumentVersionCommand.d.ts +16 -0
  65. package/dist-types/commands/DeleteFolderCommand.d.ts +16 -0
  66. package/dist-types/commands/DeleteFolderContentsCommand.d.ts +16 -0
  67. package/dist-types/commands/DeleteLabelsCommand.d.ts +16 -0
  68. package/dist-types/commands/DeleteNotificationSubscriptionCommand.d.ts +16 -0
  69. package/dist-types/commands/DeleteUserCommand.d.ts +16 -0
  70. package/dist-types/commands/DescribeActivitiesCommand.d.ts +16 -0
  71. package/dist-types/commands/DescribeCommentsCommand.d.ts +16 -0
  72. package/dist-types/commands/DescribeDocumentVersionsCommand.d.ts +16 -0
  73. package/dist-types/commands/DescribeFolderContentsCommand.d.ts +16 -0
  74. package/dist-types/commands/DescribeGroupsCommand.d.ts +16 -0
  75. package/dist-types/commands/DescribeNotificationSubscriptionsCommand.d.ts +16 -0
  76. package/dist-types/commands/DescribeResourcePermissionsCommand.d.ts +16 -0
  77. package/dist-types/commands/DescribeRootFoldersCommand.d.ts +16 -0
  78. package/dist-types/commands/DescribeUsersCommand.d.ts +16 -0
  79. package/dist-types/commands/GetCurrentUserCommand.d.ts +16 -0
  80. package/dist-types/commands/GetDocumentCommand.d.ts +16 -0
  81. package/dist-types/commands/GetDocumentPathCommand.d.ts +16 -0
  82. package/dist-types/commands/GetDocumentVersionCommand.d.ts +16 -0
  83. package/dist-types/commands/GetFolderCommand.d.ts +16 -0
  84. package/dist-types/commands/GetFolderPathCommand.d.ts +16 -0
  85. package/dist-types/commands/GetResourcesCommand.d.ts +16 -0
  86. package/dist-types/commands/InitiateDocumentVersionUploadCommand.d.ts +16 -0
  87. package/dist-types/commands/RemoveAllResourcePermissionsCommand.d.ts +16 -0
  88. package/dist-types/commands/RemoveResourcePermissionCommand.d.ts +16 -0
  89. package/dist-types/commands/RestoreDocumentVersionsCommand.d.ts +16 -0
  90. package/dist-types/commands/SearchResourcesCommand.d.ts +16 -0
  91. package/dist-types/commands/UpdateDocumentCommand.d.ts +16 -0
  92. package/dist-types/commands/UpdateDocumentVersionCommand.d.ts +16 -0
  93. package/dist-types/commands/UpdateFolderCommand.d.ts +16 -0
  94. package/dist-types/commands/UpdateUserCommand.d.ts +16 -0
  95. package/dist-types/models/WorkDocsServiceException.d.ts +2 -0
  96. package/dist-types/models/models_0.d.ts +380 -92
  97. package/dist-types/pagination/DescribeActivitiesPaginator.d.ts +3 -0
  98. package/dist-types/pagination/DescribeCommentsPaginator.d.ts +3 -0
  99. package/dist-types/pagination/DescribeDocumentVersionsPaginator.d.ts +3 -0
  100. package/dist-types/pagination/DescribeFolderContentsPaginator.d.ts +3 -0
  101. package/dist-types/pagination/DescribeGroupsPaginator.d.ts +3 -0
  102. package/dist-types/pagination/DescribeNotificationSubscriptionsPaginator.d.ts +3 -0
  103. package/dist-types/pagination/DescribeResourcePermissionsPaginator.d.ts +3 -0
  104. package/dist-types/pagination/DescribeRootFoldersPaginator.d.ts +3 -0
  105. package/dist-types/pagination/DescribeUsersPaginator.d.ts +3 -0
  106. package/dist-types/pagination/Interfaces.d.ts +3 -0
  107. package/dist-types/pagination/SearchResourcesPaginator.d.ts +3 -0
  108. package/dist-types/ts3.4/models/models_0.d.ts +0 -63
  109. package/package.json +4 -3
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DescribeNotificationSubscriptionsRequest, DescribeNotificationSubscriptionsResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, WorkDocsClientResolvedConfig } from "../WorkDocsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeNotificationSubscriptionsCommand}.
8
10
  */
9
11
  export interface DescribeNotificationSubscriptionsCommandInput extends DescribeNotificationSubscriptionsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeNotificationSubscriptionsCommand}.
13
17
  */
14
18
  export interface DescribeNotificationSubscriptionsCommandOutput extends DescribeNotificationSubscriptionsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Lists the specified notification subscriptions.</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 DescribeNotificationSubscriptionsCommandOutput extends Describe
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribeNotificationSubscriptionsCommandInput - {@link DescribeNotificationSubscriptionsCommandInput}
34
+ * @returns {@link DescribeNotificationSubscriptionsCommandOutput}
28
35
  * @see {@link DescribeNotificationSubscriptionsCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribeNotificationSubscriptionsCommandOutput} for command's `response` shape.
30
37
  * @see {@link WorkDocsClientResolvedConfig | config} for WorkDocsClient's `config` shape.
@@ -43,11 +50,20 @@ export interface DescribeNotificationSubscriptionsCommandOutput extends Describe
43
50
  export declare class DescribeNotificationSubscriptionsCommand extends $Command<DescribeNotificationSubscriptionsCommandInput, DescribeNotificationSubscriptionsCommandOutput, WorkDocsClientResolvedConfig> {
44
51
  readonly input: DescribeNotificationSubscriptionsCommandInput;
45
52
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
53
+ /**
54
+ * @public
55
+ */
46
56
  constructor(input: DescribeNotificationSubscriptionsCommandInput);
47
57
  /**
48
58
  * @internal
49
59
  */
50
60
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkDocsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeNotificationSubscriptionsCommandInput, DescribeNotificationSubscriptionsCommandOutput>;
61
+ /**
62
+ * @internal
63
+ */
51
64
  private serialize;
65
+ /**
66
+ * @internal
67
+ */
52
68
  private deserialize;
53
69
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DescribeResourcePermissionsRequest, DescribeResourcePermissionsResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, WorkDocsClientResolvedConfig } from "../WorkDocsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeResourcePermissionsCommand}.
8
10
  */
9
11
  export interface DescribeResourcePermissionsCommandInput extends DescribeResourcePermissionsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeResourcePermissionsCommand}.
13
17
  */
14
18
  export interface DescribeResourcePermissionsCommandOutput extends DescribeResourcePermissionsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Describes the permissions of a 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 DescribeResourcePermissionsCommandOutput extends DescribeResour
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribeResourcePermissionsCommandInput - {@link DescribeResourcePermissionsCommandInput}
34
+ * @returns {@link DescribeResourcePermissionsCommandOutput}
28
35
  * @see {@link DescribeResourcePermissionsCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribeResourcePermissionsCommandOutput} for command's `response` shape.
30
37
  * @see {@link WorkDocsClientResolvedConfig | config} for WorkDocsClient's `config` shape.
@@ -51,11 +58,20 @@ export interface DescribeResourcePermissionsCommandOutput extends DescribeResour
51
58
  export declare class DescribeResourcePermissionsCommand extends $Command<DescribeResourcePermissionsCommandInput, DescribeResourcePermissionsCommandOutput, WorkDocsClientResolvedConfig> {
52
59
  readonly input: DescribeResourcePermissionsCommandInput;
53
60
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
61
+ /**
62
+ * @public
63
+ */
54
64
  constructor(input: DescribeResourcePermissionsCommandInput);
55
65
  /**
56
66
  * @internal
57
67
  */
58
68
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkDocsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeResourcePermissionsCommandInput, DescribeResourcePermissionsCommandOutput>;
69
+ /**
70
+ * @internal
71
+ */
59
72
  private serialize;
73
+ /**
74
+ * @internal
75
+ */
60
76
  private deserialize;
61
77
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DescribeRootFoldersRequest, DescribeRootFoldersResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, WorkDocsClientResolvedConfig } from "../WorkDocsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeRootFoldersCommand}.
8
10
  */
9
11
  export interface DescribeRootFoldersCommandInput extends DescribeRootFoldersRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeRootFoldersCommand}.
13
17
  */
14
18
  export interface DescribeRootFoldersCommandOutput extends DescribeRootFoldersResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Describes the current user's special folders; the <code>RootFolder</code> and the
18
23
  * <code>RecycleBin</code>. <code>RootFolder</code> is the root of user's files and
19
24
  * folders and <code>RecycleBin</code> is the root of recycled items. This is not a valid
@@ -33,6 +38,8 @@ export interface DescribeRootFoldersCommandOutput extends DescribeRootFoldersRes
33
38
  * const response = await client.send(command);
34
39
  * ```
35
40
  *
41
+ * @param DescribeRootFoldersCommandInput - {@link DescribeRootFoldersCommandInput}
42
+ * @returns {@link DescribeRootFoldersCommandOutput}
36
43
  * @see {@link DescribeRootFoldersCommandInput} for command's `input` shape.
37
44
  * @see {@link DescribeRootFoldersCommandOutput} for command's `response` shape.
38
45
  * @see {@link WorkDocsClientResolvedConfig | config} for WorkDocsClient's `config` shape.
@@ -59,11 +66,20 @@ export interface DescribeRootFoldersCommandOutput extends DescribeRootFoldersRes
59
66
  export declare class DescribeRootFoldersCommand extends $Command<DescribeRootFoldersCommandInput, DescribeRootFoldersCommandOutput, WorkDocsClientResolvedConfig> {
60
67
  readonly input: DescribeRootFoldersCommandInput;
61
68
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
69
+ /**
70
+ * @public
71
+ */
62
72
  constructor(input: DescribeRootFoldersCommandInput);
63
73
  /**
64
74
  * @internal
65
75
  */
66
76
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkDocsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeRootFoldersCommandInput, DescribeRootFoldersCommandOutput>;
77
+ /**
78
+ * @internal
79
+ */
67
80
  private serialize;
81
+ /**
82
+ * @internal
83
+ */
68
84
  private deserialize;
69
85
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DescribeUsersRequest, DescribeUsersResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, WorkDocsClientResolvedConfig } from "../WorkDocsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeUsersCommand}.
8
10
  */
9
11
  export interface DescribeUsersCommandInput extends DescribeUsersRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeUsersCommand}.
13
17
  */
14
18
  export interface DescribeUsersCommandOutput extends DescribeUsersResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Describes the specified users. You can describe all users or filter the results
18
23
  * (for example, by status or organization).</p>
19
24
  * <p>By default, Amazon WorkDocs returns the first 24 active or pending users. If there
@@ -29,6 +34,8 @@ export interface DescribeUsersCommandOutput extends DescribeUsersResponse, __Met
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param DescribeUsersCommandInput - {@link DescribeUsersCommandInput}
38
+ * @returns {@link DescribeUsersCommandOutput}
32
39
  * @see {@link DescribeUsersCommandInput} for command's `input` shape.
33
40
  * @see {@link DescribeUsersCommandOutput} for command's `response` shape.
34
41
  * @see {@link WorkDocsClientResolvedConfig | config} for WorkDocsClient's `config` shape.
@@ -61,11 +68,20 @@ export interface DescribeUsersCommandOutput extends DescribeUsersResponse, __Met
61
68
  export declare class DescribeUsersCommand extends $Command<DescribeUsersCommandInput, DescribeUsersCommandOutput, WorkDocsClientResolvedConfig> {
62
69
  readonly input: DescribeUsersCommandInput;
63
70
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
71
+ /**
72
+ * @public
73
+ */
64
74
  constructor(input: DescribeUsersCommandInput);
65
75
  /**
66
76
  * @internal
67
77
  */
68
78
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkDocsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeUsersCommandInput, DescribeUsersCommandOutput>;
79
+ /**
80
+ * @internal
81
+ */
69
82
  private serialize;
83
+ /**
84
+ * @internal
85
+ */
70
86
  private deserialize;
71
87
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetCurrentUserRequest, GetCurrentUserResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, WorkDocsClientResolvedConfig } from "../WorkDocsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetCurrentUserCommand}.
8
10
  */
9
11
  export interface GetCurrentUserCommandInput extends GetCurrentUserRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetCurrentUserCommand}.
13
17
  */
14
18
  export interface GetCurrentUserCommandOutput extends GetCurrentUserResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves details of the current user for whom the authentication token was
18
23
  * generated. This is not a valid action for SigV4 (administrative API) clients.</p>
19
24
  * <p>This action requires an authentication token. To get an authentication token,
@@ -31,6 +36,8 @@ export interface GetCurrentUserCommandOutput extends GetCurrentUserResponse, __M
31
36
  * const response = await client.send(command);
32
37
  * ```
33
38
  *
39
+ * @param GetCurrentUserCommandInput - {@link GetCurrentUserCommandInput}
40
+ * @returns {@link GetCurrentUserCommandOutput}
34
41
  * @see {@link GetCurrentUserCommandInput} for command's `input` shape.
35
42
  * @see {@link GetCurrentUserCommandOutput} for command's `response` shape.
36
43
  * @see {@link WorkDocsClientResolvedConfig | config} for WorkDocsClient's `config` shape.
@@ -57,11 +64,20 @@ export interface GetCurrentUserCommandOutput extends GetCurrentUserResponse, __M
57
64
  export declare class GetCurrentUserCommand extends $Command<GetCurrentUserCommandInput, GetCurrentUserCommandOutput, WorkDocsClientResolvedConfig> {
58
65
  readonly input: GetCurrentUserCommandInput;
59
66
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
67
+ /**
68
+ * @public
69
+ */
60
70
  constructor(input: GetCurrentUserCommandInput);
61
71
  /**
62
72
  * @internal
63
73
  */
64
74
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkDocsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetCurrentUserCommandInput, GetCurrentUserCommandOutput>;
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 { GetDocumentRequest, GetDocumentResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, WorkDocsClientResolvedConfig } from "../WorkDocsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetDocumentCommand}.
8
10
  */
9
11
  export interface GetDocumentCommandInput extends GetDocumentRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetDocumentCommand}.
13
17
  */
14
18
  export interface GetDocumentCommandOutput extends GetDocumentResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves details of a 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 GetDocumentCommandOutput extends GetDocumentResponse, __Metadat
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetDocumentCommandInput - {@link GetDocumentCommandInput}
34
+ * @returns {@link GetDocumentCommandOutput}
28
35
  * @see {@link GetDocumentCommandInput} for command's `input` shape.
29
36
  * @see {@link GetDocumentCommandOutput} for command's `response` shape.
30
37
  * @see {@link WorkDocsClientResolvedConfig | config} for WorkDocsClient's `config` shape.
@@ -57,11 +64,20 @@ export interface GetDocumentCommandOutput extends GetDocumentResponse, __Metadat
57
64
  export declare class GetDocumentCommand extends $Command<GetDocumentCommandInput, GetDocumentCommandOutput, WorkDocsClientResolvedConfig> {
58
65
  readonly input: GetDocumentCommandInput;
59
66
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
67
+ /**
68
+ * @public
69
+ */
60
70
  constructor(input: GetDocumentCommandInput);
61
71
  /**
62
72
  * @internal
63
73
  */
64
74
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WorkDocsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetDocumentCommandInput, GetDocumentCommandOutput>;
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 { 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
  }