npm - @aws-sdk/client-workdocs - Versions diffs - 3.325.0 → 3.327.0 - Mend

@aws-sdk/client-workdocs 3.325.0 → 3.327.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 (45) hide show

package/dist-types/commands/RemoveResourcePermissionCommand.d.ts CHANGED Viewed

@@ -35,6 +35,8 @@ export interface RemoveResourcePermissionCommandOutput extends __MetadataBearer
  * };
  * const command = new RemoveResourcePermissionCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param RemoveResourcePermissionCommandInput - {@link RemoveResourcePermissionCommandInput}
@@ -57,6 +59,8 @@ export interface RemoveResourcePermissionCommandOutput extends __MetadataBearer
  * @throws {@link UnauthorizedResourceAccessException} (client fault)
  *  <p>The caller does not have access to perform the action on the resource.</p>
  *
+ * @throws {@link WorkDocsServiceException}
+ * <p>Base exception class for all service exceptions from WorkDocs service.</p>
  *
  */
 export declare class RemoveResourcePermissionCommand extends $Command<RemoveResourcePermissionCommandInput, RemoveResourcePermissionCommandOutput, WorkDocsClientResolvedConfig> {

package/dist-types/commands/RestoreDocumentVersionsCommand.d.ts CHANGED Viewed

@@ -32,6 +32,8 @@ export interface RestoreDocumentVersionsCommandOutput extends __MetadataBearer {
  * };
  * const command = new RestoreDocumentVersionsCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param RestoreDocumentVersionsCommandInput - {@link RestoreDocumentVersionsCommandInput}
@@ -66,6 +68,8 @@ export interface RestoreDocumentVersionsCommandOutput extends __MetadataBearer {
  * @throws {@link UnauthorizedResourceAccessException} (client fault)
  *  <p>The caller does not have access to perform the action on the resource.</p>
  *
+ * @throws {@link WorkDocsServiceException}
+ * <p>Base exception class for all service exceptions from WorkDocs service.</p>
  *
  */
 export declare class RestoreDocumentVersionsCommand extends $Command<RestoreDocumentVersionsCommandInput, RestoreDocumentVersionsCommandOutput, WorkDocsClientResolvedConfig> {

package/dist-types/commands/SearchResourcesCommand.d.ts CHANGED Viewed

@@ -87,6 +87,110 @@ export interface SearchResourcesCommandOutput extends SearchResourcesResponse, _
  * };
  * const command = new SearchResourcesCommand(input);
  * const response = await client.send(command);
+ * // { // SearchResourcesResponse
+ * //   Items: [ // ResponseItemsList
+ * //     { // ResponseItem
+ * //       ResourceType: "DOCUMENT" || "FOLDER" || "COMMENT" || "DOCUMENT_VERSION",
+ * //       WebUrl: "STRING_VALUE",
+ * //       DocumentMetadata: { // DocumentMetadata
+ * //         Id: "STRING_VALUE",
+ * //         CreatorId: "STRING_VALUE",
+ * //         ParentFolderId: "STRING_VALUE",
+ * //         CreatedTimestamp: new Date("TIMESTAMP"),
+ * //         ModifiedTimestamp: new Date("TIMESTAMP"),
+ * //         LatestVersionMetadata: { // DocumentVersionMetadata
+ * //           Id: "STRING_VALUE",
+ * //           Name: "STRING_VALUE",
+ * //           ContentType: "STRING_VALUE",
+ * //           Size: Number("long"),
+ * //           Signature: "STRING_VALUE",
+ * //           Status: "INITIALIZED" || "ACTIVE",
+ * //           CreatedTimestamp: new Date("TIMESTAMP"),
+ * //           ModifiedTimestamp: new Date("TIMESTAMP"),
+ * //           ContentCreatedTimestamp: new Date("TIMESTAMP"),
+ * //           ContentModifiedTimestamp: new Date("TIMESTAMP"),
+ * //           CreatorId: "STRING_VALUE",
+ * //           Thumbnail: { // DocumentThumbnailUrlMap
+ * //             "<keys>": "STRING_VALUE",
+ * //           },
+ * //           Source: { // DocumentSourceUrlMap
+ * //             "<keys>": "STRING_VALUE",
+ * //           },
+ * //         },
+ * //         ResourceState: "ACTIVE" || "RESTORING" || "RECYCLING" || "RECYCLED",
+ * //         Labels: [ // SharedLabels
+ * //           "STRING_VALUE",
+ * //         ],
+ * //       },
+ * //       FolderMetadata: { // FolderMetadata
+ * //         Id: "STRING_VALUE",
+ * //         Name: "STRING_VALUE",
+ * //         CreatorId: "STRING_VALUE",
+ * //         ParentFolderId: "STRING_VALUE",
+ * //         CreatedTimestamp: new Date("TIMESTAMP"),
+ * //         ModifiedTimestamp: new Date("TIMESTAMP"),
+ * //         ResourceState: "ACTIVE" || "RESTORING" || "RECYCLING" || "RECYCLED",
+ * //         Signature: "STRING_VALUE",
+ * //         Labels: [
+ * //           "STRING_VALUE",
+ * //         ],
+ * //         Size: Number("long"),
+ * //         LatestVersionSize: Number("long"),
+ * //       },
+ * //       CommentMetadata: { // CommentMetadata
+ * //         CommentId: "STRING_VALUE",
+ * //         Contributor: { // User
+ * //           Id: "STRING_VALUE",
+ * //           Username: "STRING_VALUE",
+ * //           EmailAddress: "STRING_VALUE",
+ * //           GivenName: "STRING_VALUE",
+ * //           Surname: "STRING_VALUE",
+ * //           OrganizationId: "STRING_VALUE",
+ * //           RootFolderId: "STRING_VALUE",
+ * //           RecycleBinFolderId: "STRING_VALUE",
+ * //           Status: "ACTIVE" || "INACTIVE" || "PENDING",
+ * //           Type: "USER" || "ADMIN" || "POWERUSER" || "MINIMALUSER" || "WORKSPACESUSER",
+ * //           CreatedTimestamp: new Date("TIMESTAMP"),
+ * //           ModifiedTimestamp: new Date("TIMESTAMP"),
+ * //           TimeZoneId: "STRING_VALUE",
+ * //           Locale: "en" || "fr" || "ko" || "de" || "es" || "ja" || "ru" || "zh_CN" || "zh_TW" || "pt_BR" || "default",
+ * //           Storage: { // UserStorageMetadata
+ * //             StorageUtilizedInBytes: Number("long"),
+ * //             StorageRule: { // StorageRuleType
+ * //               StorageAllocatedInBytes: Number("long"),
+ * //               StorageType: "UNLIMITED" || "QUOTA",
+ * //             },
+ * //           },
+ * //         },
+ * //         CreatedTimestamp: new Date("TIMESTAMP"),
+ * //         CommentStatus: "DRAFT" || "PUBLISHED" || "DELETED",
+ * //         RecipientId: "STRING_VALUE",
+ * //         ContributorId: "STRING_VALUE",
+ * //       },
+ * //       DocumentVersionMetadata: {
+ * //         Id: "STRING_VALUE",
+ * //         Name: "STRING_VALUE",
+ * //         ContentType: "STRING_VALUE",
+ * //         Size: Number("long"),
+ * //         Signature: "STRING_VALUE",
+ * //         Status: "INITIALIZED" || "ACTIVE",
+ * //         CreatedTimestamp: new Date("TIMESTAMP"),
+ * //         ModifiedTimestamp: new Date("TIMESTAMP"),
+ * //         ContentCreatedTimestamp: new Date("TIMESTAMP"),
+ * //         ContentModifiedTimestamp: new Date("TIMESTAMP"),
+ * //         CreatorId: "STRING_VALUE",
+ * //         Thumbnail: {
+ * //           "<keys>": "STRING_VALUE",
+ * //         },
+ * //         Source: {
+ * //           "<keys>": "STRING_VALUE",
+ * //         },
+ * //       },
+ * //     },
+ * //   ],
+ * //   Marker: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param SearchResourcesCommandInput - {@link SearchResourcesCommandInput}
@@ -107,6 +211,8 @@ export interface SearchResourcesCommandOutput extends SearchResourcesResponse, _
  * @throws {@link UnauthorizedResourceAccessException} (client fault)
  *  <p>The caller does not have access to perform the action on the resource.</p>
  *
+ * @throws {@link WorkDocsServiceException}
+ * <p>Base exception class for all service exceptions from WorkDocs service.</p>
  *
  */
 export declare class SearchResourcesCommand extends $Command<SearchResourcesCommandInput, SearchResourcesCommandOutput, WorkDocsClientResolvedConfig> {

package/dist-types/commands/UpdateDocumentCommand.d.ts CHANGED Viewed

@@ -36,6 +36,8 @@ export interface UpdateDocumentCommandOutput extends __MetadataBearer {
  * };
  * const command = new UpdateDocumentCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param UpdateDocumentCommandInput - {@link UpdateDocumentCommandInput}
@@ -76,6 +78,8 @@ export interface UpdateDocumentCommandOutput extends __MetadataBearer {
  * @throws {@link UnauthorizedResourceAccessException} (client fault)
  *  <p>The caller does not have access to perform the action on the resource.</p>
  *
+ * @throws {@link WorkDocsServiceException}
+ * <p>Base exception class for all service exceptions from WorkDocs service.</p>
  *
  */
 export declare class UpdateDocumentCommand extends $Command<UpdateDocumentCommandInput, UpdateDocumentCommandOutput, WorkDocsClientResolvedConfig> {

package/dist-types/commands/UpdateDocumentVersionCommand.d.ts CHANGED Viewed

@@ -37,6 +37,8 @@ export interface UpdateDocumentVersionCommandOutput extends __MetadataBearer {
  * };
  * const command = new UpdateDocumentVersionCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param UpdateDocumentVersionCommandInput - {@link UpdateDocumentVersionCommandInput}
@@ -71,6 +73,8 @@ export interface UpdateDocumentVersionCommandOutput extends __MetadataBearer {
  * @throws {@link UnauthorizedResourceAccessException} (client fault)
  *  <p>The caller does not have access to perform the action on the resource.</p>
  *
+ * @throws {@link WorkDocsServiceException}
+ * <p>Base exception class for all service exceptions from WorkDocs service.</p>
  *
  */
 export declare class UpdateDocumentVersionCommand extends $Command<UpdateDocumentVersionCommandInput, UpdateDocumentVersionCommandOutput, WorkDocsClientResolvedConfig> {

package/dist-types/commands/UpdateFolderCommand.d.ts CHANGED Viewed

@@ -36,6 +36,8 @@ export interface UpdateFolderCommandOutput extends __MetadataBearer {
  * };
  * const command = new UpdateFolderCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param UpdateFolderCommandInput - {@link UpdateFolderCommandInput}
@@ -76,6 +78,8 @@ export interface UpdateFolderCommandOutput extends __MetadataBearer {
  * @throws {@link UnauthorizedResourceAccessException} (client fault)
  *  <p>The caller does not have access to perform the action on the resource.</p>
  *
+ * @throws {@link WorkDocsServiceException}
+ * <p>Base exception class for all service exceptions from WorkDocs service.</p>
  *
  */
 export declare class UpdateFolderCommand extends $Command<UpdateFolderCommandInput, UpdateFolderCommandOutput, WorkDocsClientResolvedConfig> {

package/dist-types/commands/UpdateUserCommand.d.ts CHANGED Viewed

@@ -43,6 +43,32 @@ export interface UpdateUserCommandOutput extends UpdateUserResponse, __MetadataB
  * };
  * const command = new UpdateUserCommand(input);
  * const response = await client.send(command);
+ * // { // UpdateUserResponse
+ * //   User: { // User
+ * //     Id: "STRING_VALUE",
+ * //     Username: "STRING_VALUE",
+ * //     EmailAddress: "STRING_VALUE",
+ * //     GivenName: "STRING_VALUE",
+ * //     Surname: "STRING_VALUE",
+ * //     OrganizationId: "STRING_VALUE",
+ * //     RootFolderId: "STRING_VALUE",
+ * //     RecycleBinFolderId: "STRING_VALUE",
+ * //     Status: "ACTIVE" || "INACTIVE" || "PENDING",
+ * //     Type: "USER" || "ADMIN" || "POWERUSER" || "MINIMALUSER" || "WORKSPACESUSER",
+ * //     CreatedTimestamp: new Date("TIMESTAMP"),
+ * //     ModifiedTimestamp: new Date("TIMESTAMP"),
+ * //     TimeZoneId: "STRING_VALUE",
+ * //     Locale: "en" || "fr" || "ko" || "de" || "es" || "ja" || "ru" || "zh_CN" || "zh_TW" || "pt_BR" || "default",
+ * //     Storage: { // UserStorageMetadata
+ * //       StorageUtilizedInBytes: Number("long"),
+ * //       StorageRule: { // StorageRuleType
+ * //         StorageAllocatedInBytes: Number("long"),
+ * //         StorageType: "UNLIMITED" || "QUOTA",
+ * //       },
+ * //     },
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param UpdateUserCommandInput - {@link UpdateUserCommandInput}
@@ -80,6 +106,8 @@ export interface UpdateUserCommandOutput extends UpdateUserResponse, __MetadataB
  * @throws {@link UnauthorizedResourceAccessException} (client fault)
  *  <p>The caller does not have access to perform the action on the resource.</p>
  *
+ * @throws {@link WorkDocsServiceException}
+ * <p>Base exception class for all service exceptions from WorkDocs service.</p>
  *
  */
 export declare class UpdateUserCommand extends $Command<UpdateUserCommandInput, UpdateUserCommandOutput, WorkDocsClientResolvedConfig> {

package/package.json CHANGED Viewed

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-workdocs",
   "description": "AWS SDK for JavaScript Workdocs Client for Node.js, Browser and React Native",
-  "version": "3.325.0",
+  "version": "3.327.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,9 +21,9 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.325.0",
+    "@aws-sdk/client-sts": "3.327.0",
     "@aws-sdk/config-resolver": "3.310.0",
-    "@aws-sdk/credential-provider-node": "3.325.0",
+    "@aws-sdk/credential-provider-node": "3.327.0",
     "@aws-sdk/fetch-http-handler": "3.310.0",
     "@aws-sdk/hash-node": "3.310.0",
     "@aws-sdk/invalid-dependency": "3.310.0",
@@ -32,11 +32,11 @@
     "@aws-sdk/middleware-host-header": "3.325.0",
     "@aws-sdk/middleware-logger": "3.325.0",
     "@aws-sdk/middleware-recursion-detection": "3.325.0",
-    "@aws-sdk/middleware-retry": "3.325.0",
+    "@aws-sdk/middleware-retry": "3.327.0",
     "@aws-sdk/middleware-serde": "3.325.0",
     "@aws-sdk/middleware-signing": "3.325.0",
     "@aws-sdk/middleware-stack": "3.325.0",
-    "@aws-sdk/middleware-user-agent": "3.325.0",
+    "@aws-sdk/middleware-user-agent": "3.327.0",
     "@aws-sdk/node-config-provider": "3.310.0",
     "@aws-sdk/node-http-handler": "3.321.1",
     "@aws-sdk/protocol-http": "3.310.0",
@@ -48,8 +48,8 @@
     "@aws-sdk/util-body-length-node": "3.310.0",
     "@aws-sdk/util-defaults-mode-browser": "3.325.0",
     "@aws-sdk/util-defaults-mode-node": "3.325.0",
-    "@aws-sdk/util-endpoints": "3.319.0",
-    "@aws-sdk/util-retry": "3.310.0",
+    "@aws-sdk/util-endpoints": "3.327.0",
+    "@aws-sdk/util-retry": "3.327.0",
     "@aws-sdk/util-user-agent-browser": "3.310.0",
     "@aws-sdk/util-user-agent-node": "3.310.0",
     "@aws-sdk/util-utf8": "3.310.0",