@aws-sdk/client-partnercentral-selling 3.1069.0 → 3.1070.0

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

@@ -0,0 +1,114 @@
+import { Command as $Command } from "@smithy/core/client";
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { ListProspectingFromEngagementTasksRequest, ListProspectingFromEngagementTasksResponse } from "../models/models_0";
+import type { PartnerCentralSellingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PartnerCentralSellingClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListProspectingFromEngagementTasksCommand}.
+ */
+export interface ListProspectingFromEngagementTasksCommandInput extends ListProspectingFromEngagementTasksRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListProspectingFromEngagementTasksCommand}.
+ */
+export interface ListProspectingFromEngagementTasksCommandOutput extends ListProspectingFromEngagementTasksResponse, __MetadataBearer {
+}
+declare const ListProspectingFromEngagementTasksCommand_base: {
+    new (input: ListProspectingFromEngagementTasksCommandInput): import("@smithy/core/client").CommandImpl<ListProspectingFromEngagementTasksCommandInput, ListProspectingFromEngagementTasksCommandOutput, PartnerCentralSellingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: ListProspectingFromEngagementTasksCommandInput): import("@smithy/core/client").CommandImpl<ListProspectingFromEngagementTasksCommandInput, ListProspectingFromEngagementTasksCommandOutput, PartnerCentralSellingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): {
+        [x: string]: unknown;
+    };
+};
+/**
+ * <p>Lists all prospecting tasks initiated by the caller's account. Supports optional filters by task identifier, task name, or start time range. Results can be sorted using configurable options. The response is paginated. Use the <code>NextToken</code> value from each response to retrieve subsequent pages.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { PartnerCentralSellingClient, ListProspectingFromEngagementTasksCommand } from "@aws-sdk/client-partnercentral-selling"; // ES Modules import
+ * // const { PartnerCentralSellingClient, ListProspectingFromEngagementTasksCommand } = require("@aws-sdk/client-partnercentral-selling"); // CommonJS import
+ * // import type { PartnerCentralSellingClientConfig } from "@aws-sdk/client-partnercentral-selling";
+ * const config = {}; // type is PartnerCentralSellingClientConfig
+ * const client = new PartnerCentralSellingClient(config);
+ * const input = { // ListProspectingFromEngagementTasksRequest
+ *   Catalog: "STRING_VALUE", // required
+ *   MaxResults: Number("int"),
+ *   NextToken: "STRING_VALUE",
+ *   TaskIdentifier: [ // TaskIdentifierList
+ *     "STRING_VALUE",
+ *   ],
+ *   TaskName: [ // TaskNameList
+ *     "STRING_VALUE",
+ *   ],
+ *   StartAfter: new Date("TIMESTAMP"),
+ *   StartBefore: new Date("TIMESTAMP"),
+ *   Sort: { // ProspectingFromEngagementTaskSort
+ *     SortOrder: "ASCENDING" || "DESCENDING", // required
+ *     SortBy: "StartTime" || "TaskName" || "FailedEngagementCount", // required
+ *   },
+ * };
+ * const command = new ListProspectingFromEngagementTasksCommand(input);
+ * const response = await client.send(command);
+ * // { // ListProspectingFromEngagementTasksResponse
+ * //   NextToken: "STRING_VALUE",
+ * //   TaskSummaries: [ // ProspectingTaskSummaryList // required
+ * //     { // ProspectingTaskSummary
+ * //       TaskId: "STRING_VALUE", // required
+ * //       TaskArn: "STRING_VALUE", // required
+ * //       TaskName: "STRING_VALUE", // required
+ * //       StartTime: new Date("TIMESTAMP"), // required
+ * //       EndTime: new Date("TIMESTAMP"),
+ * //       TotalEngagementCount: Number("int"), // required
+ * //       CompletedEngagementCount: Number("int"), // required
+ * //       FailedEngagementCount: Number("int"), // required
+ * //     },
+ * //   ],
+ * // };
+ *
+ * ```
+ *
+ * @param ListProspectingFromEngagementTasksCommandInput - {@link ListProspectingFromEngagementTasksCommandInput}
+ * @returns {@link ListProspectingFromEngagementTasksCommandOutput}
+ * @see {@link ListProspectingFromEngagementTasksCommandInput} for command's `input` shape.
+ * @see {@link ListProspectingFromEngagementTasksCommandOutput} for command's `response` shape.
+ * @see {@link PartnerCentralSellingClientResolvedConfig | config} for PartnerCentralSellingClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>This error occurs when you don't have permission to perform the requested action.</p> <p>You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.</p> <p>Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.</p> <p>This error occurs when there are too many requests sent. Review the provided <a href="https://docs.aws.amazon.com/partner-central/latest/selling-api/quotas.html">Quotas</a> and retry after the provided delay.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input fails to satisfy the constraints specified by the service or business validation rules.</p> <p>Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.</p>
+ *
+ * @throws {@link PartnerCentralSellingServiceException}
+ * <p>Base exception class for all service exceptions from PartnerCentralSelling service.</p>
+ *
+ *
+ * @public
+ */
+export declare class ListProspectingFromEngagementTasksCommand extends ListProspectingFromEngagementTasksCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: ListProspectingFromEngagementTasksRequest;
+            output: ListProspectingFromEngagementTasksResponse;
+        };
+        sdk: {
+            input: ListProspectingFromEngagementTasksCommandInput;
+            output: ListProspectingFromEngagementTasksCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,108 @@
+import { Command as $Command } from "@smithy/core/client";
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { StartProspectingFromEngagementTaskRequest, StartProspectingFromEngagementTaskResponse } from "../models/models_0";
+import type { PartnerCentralSellingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PartnerCentralSellingClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link StartProspectingFromEngagementTaskCommand}.
+ */
+export interface StartProspectingFromEngagementTaskCommandInput extends StartProspectingFromEngagementTaskRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link StartProspectingFromEngagementTaskCommand}.
+ */
+export interface StartProspectingFromEngagementTaskCommandOutput extends StartProspectingFromEngagementTaskResponse, __MetadataBearer {
+}
+declare const StartProspectingFromEngagementTaskCommand_base: {
+    new (input: StartProspectingFromEngagementTaskCommandInput): import("@smithy/core/client").CommandImpl<StartProspectingFromEngagementTaskCommandInput, StartProspectingFromEngagementTaskCommandOutput, PartnerCentralSellingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: StartProspectingFromEngagementTaskCommandInput): import("@smithy/core/client").CommandImpl<StartProspectingFromEngagementTaskCommandInput, StartProspectingFromEngagementTaskCommandOutput, PartnerCentralSellingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): {
+        [x: string]: unknown;
+    };
+};
+/**
+ * <p>Starts a task to convert one or more engagement contexts into new prospecting leads. The task runs asynchronously. To poll for status, use <code>GetProspectingFromEngagementTask</code>, or use <code>ListProspectingFromEngagementTasks</code> to monitor multiple tasks.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { PartnerCentralSellingClient, StartProspectingFromEngagementTaskCommand } from "@aws-sdk/client-partnercentral-selling"; // ES Modules import
+ * // const { PartnerCentralSellingClient, StartProspectingFromEngagementTaskCommand } = require("@aws-sdk/client-partnercentral-selling"); // CommonJS import
+ * // import type { PartnerCentralSellingClientConfig } from "@aws-sdk/client-partnercentral-selling";
+ * const config = {}; // type is PartnerCentralSellingClientConfig
+ * const client = new PartnerCentralSellingClient(config);
+ * const input = { // StartProspectingFromEngagementTaskRequest
+ *   Catalog: "STRING_VALUE", // required
+ *   Identifiers: [ // EngagementIdentifierList // required
+ *     "STRING_VALUE",
+ *   ],
+ *   TaskName: "STRING_VALUE", // required
+ *   ClientToken: "STRING_VALUE", // required
+ * };
+ * const command = new StartProspectingFromEngagementTaskCommand(input);
+ * const response = await client.send(command);
+ * // { // StartProspectingFromEngagementTaskResponse
+ * //   Identifiers: [ // EngagementIdentifierList // required
+ * //     "STRING_VALUE",
+ * //   ],
+ * //   TaskName: "STRING_VALUE", // required
+ * //   Message: "STRING_VALUE",
+ * //   ReasonCode: "STRING_VALUE",
+ * //   StartTime: new Date("TIMESTAMP"), // required
+ * //   TaskId: "STRING_VALUE",
+ * //   TaskArn: "STRING_VALUE",
+ * //   TaskStatus: "PENDING" || "IN_PROGRESS" || "COMPLETED" || "FAILED", // required
+ * // };
+ *
+ * ```
+ *
+ * @param StartProspectingFromEngagementTaskCommandInput - {@link StartProspectingFromEngagementTaskCommandInput}
+ * @returns {@link StartProspectingFromEngagementTaskCommandOutput}
+ * @see {@link StartProspectingFromEngagementTaskCommandInput} for command's `input` shape.
+ * @see {@link StartProspectingFromEngagementTaskCommandOutput} for command's `response` shape.
+ * @see {@link PartnerCentralSellingClientResolvedConfig | config} for PartnerCentralSellingClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>This error occurs when you don't have permission to perform the requested action.</p> <p>You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.</p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>This error occurs when the request can’t be processed due to a conflict with the target resource's current state, which could result from updating or deleting the resource.</p> <p>Suggested action: Fetch the latest state of the resource, verify the state, and retry the request.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.</p> <p>Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.</p> <p>Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.</p> <p>This error occurs when there are too many requests sent. Review the provided <a href="https://docs.aws.amazon.com/partner-central/latest/selling-api/quotas.html">Quotas</a> and retry after the provided delay.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input fails to satisfy the constraints specified by the service or business validation rules.</p> <p>Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.</p>
+ *
+ * @throws {@link PartnerCentralSellingServiceException}
+ * <p>Base exception class for all service exceptions from PartnerCentralSelling service.</p>
+ *
+ *
+ * @public
+ */
+export declare class StartProspectingFromEngagementTaskCommand extends StartProspectingFromEngagementTaskCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: StartProspectingFromEngagementTaskRequest;
+            output: StartProspectingFromEngagementTaskResponse;
+        };
+        sdk: {
+            input: StartProspectingFromEngagementTaskCommandInput;
+            output: StartProspectingFromEngagementTaskCommandOutput;
+        };
+    };
+}

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

@@ -43,7 +43,7 @@ declare const UpdateEngagementContextCommand_base: {
  *   EngagementIdentifier: "STRING_VALUE", // required
  *   ContextIdentifier: "STRING_VALUE", // required
  *   EngagementLastModifiedAt: new Date("TIMESTAMP"), // required
- *   Type: "CustomerProject" || "Lead", // required
+ *   Type: "CustomerProject" || "Lead" || "ProspectingResult", // required
  *   Payload: { // UpdateEngagementContextPayload Union: only one key present
  *     Lead: { // UpdateLeadContext
  *       QualificationStatus: "STRING_VALUE",
@@ -76,6 +76,9 @@ declare const UpdateEngagementContextCommand_base: {
  *           Phone: "STRING_VALUE",
  *         },
  *       },
+ *       Insights: { // LeadInsights
+ *         LeadReadinessScore: "STRING_VALUE",
+ *       },
  *     },
  *     CustomerProject: { // CustomerProjectsContext
  *       Customer: { // EngagementCustomer
@@ -90,6 +93,36 @@ declare const UpdateEngagementContextCommand_base: {
  *         TargetCompletionDate: "STRING_VALUE", // required
  *       },
  *     },
+ *     ProspectingResult: { // ProspectingResult
+ *       Aws: { // ProspectingResultAws
+ *         StartTime: new Date("TIMESTAMP"),
+ *         EndTime: new Date("TIMESTAMP"),
+ *         TaskId: "STRING_VALUE",
+ *         TaskArn: "STRING_VALUE",
+ *         TaskName: "STRING_VALUE",
+ *         Customer: { // ProspectingResultCustomer
+ *           AccountName: "STRING_VALUE",
+ *           Geo: "STRING_VALUE",
+ *           Region: "STRING_VALUE",
+ *           SubRegion: "STRING_VALUE",
+ *           Country: "US" || "AF" || "AX" || "AL" || "DZ" || "AS" || "AD" || "AO" || "AI" || "AQ" || "AG" || "AR" || "AM" || "AW" || "AU" || "AT" || "AZ" || "BS" || "BH" || "BD" || "BB" || "BY" || "BE" || "BZ" || "BJ" || "BM" || "BT" || "BO" || "BQ" || "BA" || "BW" || "BV" || "BR" || "IO" || "BN" || "BG" || "BF" || "BI" || "KH" || "CM" || "CA" || "CV" || "KY" || "CF" || "TD" || "CL" || "CN" || "CX" || "CC" || "CO" || "KM" || "CG" || "CK" || "CR" || "CI" || "HR" || "CU" || "CW" || "CY" || "CZ" || "CD" || "DK" || "DJ" || "DM" || "DO" || "EC" || "EG" || "SV" || "GQ" || "ER" || "EE" || "ET" || "FK" || "FO" || "FJ" || "FI" || "FR" || "GF" || "PF" || "TF" || "GA" || "GM" || "GE" || "DE" || "GH" || "GI" || "GR" || "GL" || "GD" || "GP" || "GU" || "GT" || "GG" || "GN" || "GW" || "GY" || "HT" || "HM" || "VA" || "HN" || "HK" || "HU" || "IS" || "IN" || "ID" || "IR" || "IQ" || "IE" || "IM" || "IL" || "IT" || "JM" || "JP" || "JE" || "JO" || "KZ" || "KE" || "KI" || "KR" || "KW" || "KG" || "LA" || "LV" || "LB" || "LS" || "LR" || "LY" || "LI" || "LT" || "LU" || "MO" || "MK" || "MG" || "MW" || "MY" || "MV" || "ML" || "MT" || "MH" || "MQ" || "MR" || "MU" || "YT" || "MX" || "FM" || "MD" || "MC" || "MN" || "ME" || "MS" || "MA" || "MZ" || "MM" || "NA" || "NR" || "NP" || "NL" || "AN" || "NC" || "NZ" || "NI" || "NE" || "NG" || "NU" || "NF" || "MP" || "NO" || "OM" || "PK" || "PW" || "PS" || "PA" || "PG" || "PY" || "PE" || "PH" || "PN" || "PL" || "PT" || "PR" || "QA" || "RE" || "RO" || "RU" || "RW" || "BL" || "SH" || "KN" || "LC" || "MF" || "PM" || "VC" || "WS" || "SM" || "ST" || "SA" || "SN" || "RS" || "SC" || "SL" || "SG" || "SX" || "SK" || "SI" || "SB" || "SO" || "ZA" || "GS" || "SS" || "ES" || "LK" || "SD" || "SR" || "SJ" || "SZ" || "SE" || "CH" || "SY" || "TW" || "TJ" || "TZ" || "TH" || "TL" || "TG" || "TK" || "TO" || "TT" || "TN" || "TR" || "TM" || "TC" || "TV" || "UG" || "UA" || "AE" || "GB" || "UM" || "UY" || "UZ" || "VU" || "VE" || "VN" || "VG" || "VI" || "WF" || "EH" || "YE" || "ZM" || "ZW",
+ *           Industry: "Aerospace" || "Agriculture" || "Automotive" || "Computers and Electronics" || "Consumer Goods" || "Education" || "Energy - Oil and Gas" || "Energy - Power and Utilities" || "Financial Services" || "Gaming" || "Government" || "Healthcare" || "Hospitality" || "Life Sciences" || "Manufacturing" || "Marketing and Advertising" || "Media and Entertainment" || "Mining" || "Non-Profit Organization" || "Professional Services" || "Real Estate and Construction" || "Retail" || "Software and Internet" || "Telecommunications" || "Transportation and Logistics" || "Travel" || "Wholesale and Distribution" || "Other",
+ *           SubIndustry: "STRING_VALUE",
+ *           Segment: "STRING_VALUE",
+ *           CompanySize: "STRING_VALUE",
+ *           EligiblePrograms: [ // EligibleProgramsList
+ *             "STRING_VALUE",
+ *           ],
+ *           PublicProfileSummary: "STRING_VALUE",
+ *         },
+ *         Insights: { // ProspectingInsights
+ *           MarketplaceEngagementScore: "STRING_VALUE",
+ *           SolutionScore: "STRING_VALUE",
+ *           SolutionCategory: "STRING_VALUE",
+ *           SolutionSubCategory: "STRING_VALUE",
+ *         },
+ *       },
+ *     },
  *   },
  * };
  * const command = new UpdateEngagementContextCommand(input);

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

@@ -13,6 +13,7 @@ export * from "./GetAwsOpportunitySummaryCommand";
 export * from "./GetEngagementCommand";
 export * from "./GetEngagementInvitationCommand";
 export * from "./GetOpportunityCommand";
+export * from "./GetProspectingFromEngagementTaskCommand";
 export * from "./GetResourceSnapshotCommand";
 export * from "./GetResourceSnapshotJobCommand";
 export * from "./GetSellingSystemSettingsCommand";
@@ -24,6 +25,7 @@ export * from "./ListEngagementResourceAssociationsCommand";
 export * from "./ListEngagementsCommand";
 export * from "./ListOpportunitiesCommand";
 export * from "./ListOpportunityFromEngagementTasksCommand";
+export * from "./ListProspectingFromEngagementTasksCommand";
 export * from "./ListResourceSnapshotJobsCommand";
 export * from "./ListResourceSnapshotsCommand";
 export * from "./ListSolutionsCommand";
@@ -33,6 +35,7 @@ export * from "./RejectEngagementInvitationCommand";
 export * from "./StartEngagementByAcceptingInvitationTaskCommand";
 export * from "./StartEngagementFromOpportunityTaskCommand";
 export * from "./StartOpportunityFromEngagementTaskCommand";
+export * from "./StartProspectingFromEngagementTaskCommand";
 export * from "./StartResourceSnapshotJobCommand";
 export * from "./StopResourceSnapshotJobCommand";
 export * from "./SubmitOpportunityCommand";

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

@@ -758,6 +758,7 @@ export type MarketSegment = (typeof MarketSegment)[keyof typeof MarketSegment];
 export declare const EngagementContextType: {
     readonly CUSTOMER_PROJECT: "CustomerProject";
     readonly LEAD: "Lead";
+    readonly PROSPECTING_RESULT: "ProspectingResult";
 };
 /**
  * @public
@@ -1144,6 +1145,33 @@ export declare const OpportunitySortName: {
  * @public
  */
 export type OpportunitySortName = (typeof OpportunitySortName)[keyof typeof OpportunitySortName];
+/**
+ * @public
+ * @enum
+ */
+export declare const ProspectingTaskStatus: {
+    readonly COMPLETED: "COMPLETED";
+    readonly FAILED: "FAILED";
+    readonly IN_PROGRESS: "IN_PROGRESS";
+    readonly PENDING: "PENDING";
+};
+/**
+ * @public
+ */
+export type ProspectingTaskStatus = (typeof ProspectingTaskStatus)[keyof typeof ProspectingTaskStatus];
+/**
+ * @public
+ * @enum
+ */
+export declare const ProspectingFromEngagementTaskSortName: {
+    readonly FailedEngagementCount: "FailedEngagementCount";
+    readonly StartTime: "StartTime";
+    readonly TaskName: "TaskName";
+};
+/**
+ * @public
+ */
+export type ProspectingFromEngagementTaskSortName = (typeof ProspectingFromEngagementTaskSortName)[keyof typeof ProspectingFromEngagementTaskSortName];
 /**
  * @public
  * @enum