@aws-sdk/client-marketplace-commerce-analytics 3.296.0 → 3.297.0

package/dist-types/MarketplaceCommerceAnalytics.d.ts

@@ -3,14 +3,16 @@ import { GenerateDataSetCommandInput, GenerateDataSetCommandOutput } from "./com
 import { StartSupportDataExportCommandInput, StartSupportDataExportCommandOutput } from "./commands/StartSupportDataExportCommand";
 import { MarketplaceCommerceAnalyticsClient } from "./MarketplaceCommerceAnalyticsClient";
 /**
+ * @public
  * Provides AWS Marketplace business intelligence data on-demand.
  */
 export declare class MarketplaceCommerceAnalytics extends MarketplaceCommerceAnalyticsClient {
     /**
+     * @public
      * Given a data set type and data set publication date, asynchronously publishes the requested data set to the specified
      *         S3 bucket and notifies the specified SNS topic once the data is available. Returns a unique request identifier that
      *         can be used to correlate requests with notifications from the SNS topic.
-     *         Data sets will be published in comma-separated values (CSV) format with the file name {data_set_type}_YYYY-MM-DD.csv.
+     *         Data sets will be published in comma-separated values (CSV) format with the file name \{data_set_type\}_YYYY-MM-DD.csv.
      *         If a file with the same name already exists (e.g. if the same data set is requested twice), the original file will
      *         be overwritten by the new file.
      *         Requires a Role with an attached permissions policy providing Allow permissions for the following actions:
@@ -20,10 +22,11 @@ export declare class MarketplaceCommerceAnalytics extends MarketplaceCommerceAna
     generateDataSet(args: GenerateDataSetCommandInput, cb: (err: any, data?: GenerateDataSetCommandOutput) => void): void;
     generateDataSet(args: GenerateDataSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GenerateDataSetCommandOutput) => void): void;
     /**
+     * @public
      * Given a data set type and a from date, asynchronously publishes the requested customer support data
      *         to the specified S3 bucket and notifies the specified SNS topic once the data is available. Returns a unique request
      *         identifier that can be used to correlate requests with notifications from the SNS topic.
-     *         Data sets will be published in comma-separated values (CSV) format with the file name {data_set_type}_YYYY-MM-DD'T'HH-mm-ss'Z'.csv.
+     *         Data sets will be published in comma-separated values (CSV) format with the file name \{data_set_type\}_YYYY-MM-DD'T'HH-mm-ss'Z'.csv.
      *         If a file with the same name already exists (e.g. if the same data set is requested twice), the original file will
      *         be overwritten by the new file.
      *         Requires a Role with an attached permissions policy providing Allow permissions for the following actions:

package/dist-types/MarketplaceCommerceAnalyticsClient.d.ts

@@ -10,15 +10,24 @@ import { BodyLengthCalculator as __BodyLengthCalculator, ChecksumConstructor as
 import { GenerateDataSetCommandInput, GenerateDataSetCommandOutput } from "./commands/GenerateDataSetCommand";
 import { StartSupportDataExportCommandInput, StartSupportDataExportCommandOutput } from "./commands/StartSupportDataExportCommand";
 import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
+/**
+ * @public
+ */
 export type ServiceInputTypes = GenerateDataSetCommandInput | StartSupportDataExportCommandInput;
+/**
+ * @public
+ */
 export type ServiceOutputTypes = GenerateDataSetCommandOutput | StartSupportDataExportCommandOutput;
+/**
+ * @public
+ */
 export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
     /**
      * The HTTP handler to use. Fetch in browser and Https in Nodejs.
      */
     requestHandler?: __HttpHandler;
     /**
-     * A constructor for a class implementing the {@link __Checksum} interface
+     * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
      * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
      * @internal
      */
@@ -108,23 +117,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
      */
     logger?: __Logger;
     /**
-     * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
+     * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
      */
     defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
 }
+/**
+ * @public
+ */
 type MarketplaceCommerceAnalyticsClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
 /**
- * The configuration interface of MarketplaceCommerceAnalyticsClient class constructor that set the region, credentials and other options.
+ * @public
+ *
+ *  The configuration interface of MarketplaceCommerceAnalyticsClient class constructor that set the region, credentials and other options.
  */
 export interface MarketplaceCommerceAnalyticsClientConfig extends MarketplaceCommerceAnalyticsClientConfigType {
 }
+/**
+ * @public
+ */
 type MarketplaceCommerceAnalyticsClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
 /**
- * The resolved configuration interface of MarketplaceCommerceAnalyticsClient class. This is resolved and normalized from the {@link MarketplaceCommerceAnalyticsClientConfig | constructor configuration interface}.
+ * @public
+ *
+ *  The resolved configuration interface of MarketplaceCommerceAnalyticsClient class. This is resolved and normalized from the {@link MarketplaceCommerceAnalyticsClientConfig | constructor configuration interface}.
  */
 export interface MarketplaceCommerceAnalyticsClientResolvedConfig extends MarketplaceCommerceAnalyticsClientResolvedConfigType {
 }
 /**
+ * @public
  * Provides AWS Marketplace business intelligence data on-demand.
  */
 export declare class MarketplaceCommerceAnalyticsClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, MarketplaceCommerceAnalyticsClientResolvedConfig> {

package/dist-types/commands/GenerateDataSetCommand.d.ts

@@ -4,20 +4,25 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { MarketplaceCommerceAnalyticsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../MarketplaceCommerceAnalyticsClient";
 import { GenerateDataSetRequest, GenerateDataSetResult } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link GenerateDataSetCommand}.
  */
 export interface GenerateDataSetCommandInput extends GenerateDataSetRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link GenerateDataSetCommand}.
  */
 export interface GenerateDataSetCommandOutput extends GenerateDataSetResult, __MetadataBearer {
 }
 /**
+ * @public
  * Given a data set type and data set publication date, asynchronously publishes the requested data set to the specified
  *         S3 bucket and notifies the specified SNS topic once the data is available. Returns a unique request identifier that
  *         can be used to correlate requests with notifications from the SNS topic.
- *         Data sets will be published in comma-separated values (CSV) format with the file name {data_set_type}_YYYY-MM-DD.csv.
+ *         Data sets will be published in comma-separated values (CSV) format with the file name \{data_set_type\}_YYYY-MM-DD.csv.
  *         If a file with the same name already exists (e.g. if the same data set is requested twice), the original file will
  *         be overwritten by the new file.
  *         Requires a Role with an attached permissions policy providing Allow permissions for the following actions:
@@ -32,6 +37,8 @@ export interface GenerateDataSetCommandOutput extends GenerateDataSetResult, __M
  * const response = await client.send(command);
  * ```
  *
+ * @param GenerateDataSetCommandInput - {@link GenerateDataSetCommandInput}
+ * @returns {@link GenerateDataSetCommandOutput}
  * @see {@link GenerateDataSetCommandInput} for command's `input` shape.
  * @see {@link GenerateDataSetCommandOutput} for command's `response` shape.
  * @see {@link MarketplaceCommerceAnalyticsClientResolvedConfig | config} for MarketplaceCommerceAnalyticsClient's `config` shape.
@@ -44,11 +51,20 @@ export interface GenerateDataSetCommandOutput extends GenerateDataSetResult, __M
 export declare class GenerateDataSetCommand extends $Command<GenerateDataSetCommandInput, GenerateDataSetCommandOutput, MarketplaceCommerceAnalyticsClientResolvedConfig> {
     readonly input: GenerateDataSetCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: GenerateDataSetCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: MarketplaceCommerceAnalyticsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GenerateDataSetCommandInput, GenerateDataSetCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/StartSupportDataExportCommand.d.ts

@@ -4,20 +4,25 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { MarketplaceCommerceAnalyticsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../MarketplaceCommerceAnalyticsClient";
 import { StartSupportDataExportRequest, StartSupportDataExportResult } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link StartSupportDataExportCommand}.
  */
 export interface StartSupportDataExportCommandInput extends StartSupportDataExportRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link StartSupportDataExportCommand}.
  */
 export interface StartSupportDataExportCommandOutput extends StartSupportDataExportResult, __MetadataBearer {
 }
 /**
+ * @public
  * Given a data set type and a from date, asynchronously publishes the requested customer support data
  *         to the specified S3 bucket and notifies the specified SNS topic once the data is available. Returns a unique request
  *         identifier that can be used to correlate requests with notifications from the SNS topic.
- *         Data sets will be published in comma-separated values (CSV) format with the file name {data_set_type}_YYYY-MM-DD'T'HH-mm-ss'Z'.csv.
+ *         Data sets will be published in comma-separated values (CSV) format with the file name \{data_set_type\}_YYYY-MM-DD'T'HH-mm-ss'Z'.csv.
  *         If a file with the same name already exists (e.g. if the same data set is requested twice), the original file will
  *         be overwritten by the new file.
  *         Requires a Role with an attached permissions policy providing Allow permissions for the following actions:
@@ -32,6 +37,8 @@ export interface StartSupportDataExportCommandOutput extends StartSupportDataExp
  * const response = await client.send(command);
  * ```
  *
+ * @param StartSupportDataExportCommandInput - {@link StartSupportDataExportCommandInput}
+ * @returns {@link StartSupportDataExportCommandOutput}
  * @see {@link StartSupportDataExportCommandInput} for command's `input` shape.
  * @see {@link StartSupportDataExportCommandOutput} for command's `response` shape.
  * @see {@link MarketplaceCommerceAnalyticsClientResolvedConfig | config} for MarketplaceCommerceAnalyticsClient's `config` shape.
@@ -44,11 +51,20 @@ export interface StartSupportDataExportCommandOutput extends StartSupportDataExp
 export declare class StartSupportDataExportCommand extends $Command<StartSupportDataExportCommandInput, StartSupportDataExportCommandOutput, MarketplaceCommerceAnalyticsClientResolvedConfig> {
     readonly input: StartSupportDataExportCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: StartSupportDataExportCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: MarketplaceCommerceAnalyticsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartSupportDataExportCommandInput, StartSupportDataExportCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/models/MarketplaceCommerceAnalyticsServiceException.d.ts

@@ -1,5 +1,7 @@
 import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
 /**
+ * @public
+ *
  * Base exception class for all service exceptions from MarketplaceCommerceAnalytics service.
  */
 export declare class MarketplaceCommerceAnalyticsServiceException extends __ServiceException {

package/dist-types/models/models_0.d.ts

@@ -1,5 +1,8 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
 import { MarketplaceCommerceAnalyticsServiceException as __BaseException } from "./MarketplaceCommerceAnalyticsServiceException";
+/**
+ * @public
+ */
 export declare enum DataSetType {
     CUSTOMER_PROFILE_BY_GEOGRAPHY = "customer_profile_by_geography",
     CUSTOMER_PROFILE_BY_INDUSTRY = "customer_profile_by_industry",
@@ -28,6 +31,7 @@ export declare enum DataSetType {
     US_SALES_AND_USE_TAX_RECORDS = "us_sales_and_use_tax_records"
 }
 /**
+ * @public
  * Container for the parameters to the GenerateDataSet operation.
  */
 export interface GenerateDataSetRequest {
@@ -177,6 +181,7 @@ export interface GenerateDataSetRequest {
     customerDefinedValues?: Record<string, string>;
 }
 /**
+ * @public
  * Container for the result of the GenerateDataSet operation.
  */
 export interface GenerateDataSetResult {
@@ -187,6 +192,7 @@ export interface GenerateDataSetResult {
     dataSetRequestId?: string;
 }
 /**
+ * @public
  * This exception is thrown when an internal service error occurs.
  */
 export declare class MarketplaceCommerceAnalyticsException extends __BaseException {
@@ -197,8 +203,12 @@ export declare class MarketplaceCommerceAnalyticsException extends __BaseExcepti
      */
     constructor(opts: __ExceptionOptionType<MarketplaceCommerceAnalyticsException, __BaseException>);
 }
+/**
+ * @public
+ */
 export type SupportDataSetType = "customer_support_contacts_data" | "test_customer_support_contacts_data";
 /**
+ * @public
  * Container for the parameters to the StartSupportDataExport operation.
  */
 export interface StartSupportDataExportRequest {
@@ -250,6 +260,7 @@ export interface StartSupportDataExportRequest {
     customerDefinedValues?: Record<string, string>;
 }
 /**
+ * @public
  * Container for the result of the StartSupportDataExport operation.
  */
 export interface StartSupportDataExportResult {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-marketplace-commerce-analytics",
   "description": "AWS SDK for JavaScript Marketplace Commerce Analytics Client for Node.js, Browser and React Native",
-  "version": "3.296.0",
+  "version": "3.297.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -20,9 +20,9 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.296.0",
+    "@aws-sdk/client-sts": "3.297.0",
     "@aws-sdk/config-resolver": "3.296.0",
-    "@aws-sdk/credential-provider-node": "3.296.0",
+    "@aws-sdk/credential-provider-node": "3.297.0",
     "@aws-sdk/fetch-http-handler": "3.296.0",
     "@aws-sdk/hash-node": "3.296.0",
     "@aws-sdk/invalid-dependency": "3.296.0",