@aws-sdk/client-endusermessaging 3.1145.0

package/dist-types/auth/httpAuthSchemeProvider.d.ts

@@ -0,0 +1,75 @@
+import { AwsSdkSigV4AuthInputConfig, AwsSdkSigV4AuthResolvedConfig, AwsSdkSigV4PreviouslyResolved } from "@aws-sdk/core/httpAuthSchemes";
+import type { HandlerExecutionContext, HttpAuthScheme, HttpAuthSchemeParameters, HttpAuthSchemeParametersProvider, HttpAuthSchemeProvider, Provider } from "@smithy/types";
+import { type EndUserMessagingClientResolvedConfig } from "../EndUserMessagingClient";
+/**
+ * @internal
+ */
+export interface EndUserMessagingHttpAuthSchemeParameters extends HttpAuthSchemeParameters {
+    region?: string;
+}
+/**
+ * @internal
+ */
+export interface EndUserMessagingHttpAuthSchemeParametersProvider extends HttpAuthSchemeParametersProvider<EndUserMessagingClientResolvedConfig, HandlerExecutionContext, EndUserMessagingHttpAuthSchemeParameters, object> {
+}
+/**
+ * @internal
+ */
+export declare const defaultEndUserMessagingHttpAuthSchemeParametersProvider: (config: EndUserMessagingClientResolvedConfig, context: HandlerExecutionContext, input: object) => Promise<EndUserMessagingHttpAuthSchemeParameters>;
+/**
+ * @internal
+ */
+export interface EndUserMessagingHttpAuthSchemeProvider extends HttpAuthSchemeProvider<EndUserMessagingHttpAuthSchemeParameters> {
+}
+/**
+ * @internal
+ */
+export declare const defaultEndUserMessagingHttpAuthSchemeProvider: EndUserMessagingHttpAuthSchemeProvider;
+/**
+ * @public
+ */
+export interface HttpAuthSchemeInputConfig extends AwsSdkSigV4AuthInputConfig {
+    /**
+     * A comma-separated list of case-sensitive auth scheme names.
+     * An auth scheme name is a fully qualified auth scheme ID with the namespace prefix trimmed.
+     * For example, the auth scheme with ID aws.auth#sigv4 is named sigv4.
+     * @public
+     */
+    authSchemePreference?: string[] | Provider<string[]>;
+    /**
+     * Configuration of HttpAuthSchemes for a client which provides default identity providers and signers per auth scheme.
+     * @internal
+     */
+    httpAuthSchemes?: HttpAuthScheme[];
+    /**
+     * Configuration of an HttpAuthSchemeProvider for a client which resolves which HttpAuthScheme to use.
+     * @internal
+     */
+    httpAuthSchemeProvider?: EndUserMessagingHttpAuthSchemeProvider;
+}
+/**
+ * @internal
+ */
+export interface HttpAuthSchemeResolvedConfig extends AwsSdkSigV4AuthResolvedConfig {
+    /**
+     * A comma-separated list of case-sensitive auth scheme names.
+     * An auth scheme name is a fully qualified auth scheme ID with the namespace prefix trimmed.
+     * For example, the auth scheme with ID aws.auth#sigv4 is named sigv4.
+     * @public
+     */
+    readonly authSchemePreference: Provider<string[]>;
+    /**
+     * Configuration of HttpAuthSchemes for a client which provides default identity providers and signers per auth scheme.
+     * @internal
+     */
+    readonly httpAuthSchemes: HttpAuthScheme[];
+    /**
+     * Configuration of an HttpAuthSchemeProvider for a client which resolves which HttpAuthScheme to use.
+     * @internal
+     */
+    readonly httpAuthSchemeProvider: EndUserMessagingHttpAuthSchemeProvider;
+}
+/**
+ * @internal
+ */
+export declare const resolveHttpAuthSchemeConfig: <T>(config: T & HttpAuthSchemeInputConfig & AwsSdkSigV4PreviouslyResolved) => T & HttpAuthSchemeResolvedConfig;

package/dist-types/commandBuilder.d.ts

@@ -0,0 +1,18 @@
+import type { EndpointParameterInstructions } from "@smithy/types";
+import type { EndUserMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "./EndUserMessagingClient";
+/**
+ * @internal
+ */
+export declare const command: <I extends ServiceInputTypes, O extends ServiceOutputTypes>(added: EndpointParameterInstructions, plugins: (CommandCtor: any, clientStack: any, config: any, options: any) => import("@smithy/types").Pluggable<any, any>[], op: string, $: import("@smithy/types").StaticOperationSchema, smithyContext?: Record<string, unknown>) => {
+    new (input: I): import("@smithy/core/client").CommandImpl<I, O, EndUserMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (...[input]: import("@smithy/types").OptionalParameter<I>): import("@smithy/core/client").CommandImpl<I, O, EndUserMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): EndpointParameterInstructions;
+};
+/**
+ * @internal
+ */
+export declare const _ep0: EndpointParameterInstructions;
+/**
+ * @internal
+ */
+export declare const _mw0: (Command: any, cs: any, config: any, o: any) => never[];

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

@@ -0,0 +1,139 @@
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { CreateBrandProfileAttributesInput, CreateBrandProfileAttributesOutput } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+/**
+ * @public
+ *
+ * The input for {@link CreateBrandProfileAttributesCommand}.
+ */
+export interface CreateBrandProfileAttributesCommandInput extends CreateBrandProfileAttributesInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link CreateBrandProfileAttributesCommand}.
+ */
+export interface CreateBrandProfileAttributesCommandOutput extends CreateBrandProfileAttributesOutput, __MetadataBearer {
+}
+declare const CreateBrandProfileAttributesCommand_base: {
+    new (input: CreateBrandProfileAttributesCommandInput): import("@smithy/core/client").CommandImpl<CreateBrandProfileAttributesCommandInput, CreateBrandProfileAttributesCommandOutput, import("..").EndUserMessagingClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    new (input: CreateBrandProfileAttributesCommandInput): import("@smithy/core/client").CommandImpl<CreateBrandProfileAttributesCommandInput, CreateBrandProfileAttributesCommandOutput, import("..").EndUserMessagingClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
+};
+/**
+ * <p>Creates up to 10 attributes for a brand profile in a single request. For attributes of type IMAGE or DOCUMENT, the response includes a presigned Amazon S3 URL that you use to upload the media. This operation is atomic: either all of the attributes are created, or none of them are.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { EndUserMessagingClient, CreateBrandProfileAttributesCommand } from "@aws-sdk/client-endusermessaging"; // ES Modules import
+ * // const { EndUserMessagingClient, CreateBrandProfileAttributesCommand } = require("@aws-sdk/client-endusermessaging"); // CommonJS import
+ * // import type { EndUserMessagingClientConfig } from "@aws-sdk/client-endusermessaging";
+ * const config = {}; // type is EndUserMessagingClientConfig
+ * const client = new EndUserMessagingClient(config);
+ * const input = { // CreateBrandProfileAttributesInput
+ *   brandProfileId: "STRING_VALUE", // required
+ *   attributes: [ // BrandProfileAttributeInputList // required
+ *     { // BrandProfileAttributeInput
+ *       attributeName: "STRING_VALUE", // required
+ *       attributeType: "TEXT" || "IMAGE" || "DOCUMENT", // required
+ *       attributeValue: "STRING_VALUE",
+ *       attachmentBody: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")
+ *       description: "STRING_VALUE",
+ *       category: "STRING_VALUE",
+ *     },
+ *   ],
+ *   clientToken: "STRING_VALUE",
+ * };
+ * const command = new CreateBrandProfileAttributesCommand(input);
+ * const response = await client.send(command);
+ * // { // CreateBrandProfileAttributesOutput
+ * //   attributes: [ // BrandProfileAttributeOutputList // required
+ * //     { // BrandProfileAttributeOutput
+ * //       attributeName: "STRING_VALUE", // required
+ * //       attributeType: "TEXT" || "IMAGE" || "DOCUMENT", // required
+ * //       mediaDownloadUrl: "STRING_VALUE",
+ * //     },
+ * //   ],
+ * // };
+ *
+ * ```
+ *
+ * @param CreateBrandProfileAttributesCommandInput - {@link CreateBrandProfileAttributesCommandInput}
+ * @returns {@link CreateBrandProfileAttributesCommandOutput}
+ * @see {@link CreateBrandProfileAttributesCommandInput} for command's `input` shape.
+ * @see {@link CreateBrandProfileAttributesCommandOutput} for command's `response` shape.
+ * @see {@link EndUserMessagingClientResolvedConfig | config} for EndUserMessagingClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have sufficient access to perform this action.</p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>The request conflicts with the current state of the resource.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>An unexpected error occurred during the processing of the request.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The request references a resource that does not exist. Verify that the resource identifier is correct and try your request again.</p>
+ *
+ * @throws {@link ServiceQuotaExceededException} (client fault)
+ *  <p>The request would exceed a service quota for your account.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied because it exceeded the allowed request rate.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  A standard error for input validation failures.
+ * This should be thrown by services when a member of the input structure
+ * falls outside of the modeled or documented constraints.
+ *
+ * @throws {@link EndUserMessagingServiceException}
+ * <p>Base exception class for all service exceptions from EndUserMessaging service.</p>
+ *
+ *
+ * @example Create a text attribute on a brand profile
+ * ```javascript
+ * //
+ * const input = {
+ *   attributes: [
+ *     {
+ *       attributeName: "SupportEmail",
+ *       attributeType: "TEXT",
+ *       attributeValue: "support@example.com",
+ *       category: "CONTACT"
+ *     }
+ *   ],
+ *   brandProfileId: "bp-abc12345678901234"
+ * };
+ * const command = new CreateBrandProfileAttributesCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   attributes: [
+ *     {
+ *       attributeName: "SupportEmail",
+ *       attributeType: "TEXT"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * ```
+ *
+ * @public
+ */
+export declare class CreateBrandProfileAttributesCommand extends CreateBrandProfileAttributesCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: CreateBrandProfileAttributesInput;
+            output: CreateBrandProfileAttributesOutput;
+        };
+        sdk: {
+            input: CreateBrandProfileAttributesCommandInput;
+            output: CreateBrandProfileAttributesCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,129 @@
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { CreateBrandProfileInput, CreateBrandProfileOutput } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+/**
+ * @public
+ *
+ * The input for {@link CreateBrandProfileCommand}.
+ */
+export interface CreateBrandProfileCommandInput extends CreateBrandProfileInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link CreateBrandProfileCommand}.
+ */
+export interface CreateBrandProfileCommandOutput extends CreateBrandProfileOutput, __MetadataBearer {
+}
+declare const CreateBrandProfileCommand_base: {
+    new (input: CreateBrandProfileCommandInput): import("@smithy/core/client").CommandImpl<CreateBrandProfileCommandInput, CreateBrandProfileCommandOutput, import("..").EndUserMessagingClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    new (input: CreateBrandProfileCommandInput): import("@smithy/core/client").CommandImpl<CreateBrandProfileCommandInput, CreateBrandProfileCommandOutput, import("..").EndUserMessagingClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
+};
+/**
+ * <p>Creates a brand profile. A brand profile is a lightweight container that holds your brand identity information as flexible attributes. After you create a brand profile, use the CreateBrandProfileAttributes operation to add company information, addresses, compliance documents, and logos.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { EndUserMessagingClient, CreateBrandProfileCommand } from "@aws-sdk/client-endusermessaging"; // ES Modules import
+ * // const { EndUserMessagingClient, CreateBrandProfileCommand } = require("@aws-sdk/client-endusermessaging"); // CommonJS import
+ * // import type { EndUserMessagingClientConfig } from "@aws-sdk/client-endusermessaging";
+ * const config = {}; // type is EndUserMessagingClientConfig
+ * const client = new EndUserMessagingClient(config);
+ * const input = { // CreateBrandProfileInput
+ *   brandProfileName: "STRING_VALUE", // required
+ *   clientToken: "STRING_VALUE",
+ *   deletionProtectionEnabled: true || false,
+ *   tags: [ // TagList
+ *     { // Tag
+ *       key: "STRING_VALUE", // required
+ *       value: "STRING_VALUE", // required
+ *     },
+ *   ],
+ * };
+ * const command = new CreateBrandProfileCommand(input);
+ * const response = await client.send(command);
+ * // { // CreateBrandProfileOutput
+ * //   brandProfileId: "STRING_VALUE", // required
+ * //   brandProfileArn: "STRING_VALUE", // required
+ * //   brandProfileName: "STRING_VALUE", // required
+ * //   status: "ACTIVE" || "BLOCKED" || "PAUSED" || "CANCELLED" || "FAILED", // required
+ * //   deletionProtectionEnabled: true || false, // required
+ * //   createdAt: new Date("TIMESTAMP"), // required
+ * //   updatedAt: new Date("TIMESTAMP"), // required
+ * //   attributesCreated: Number("int"), // required
+ * // };
+ *
+ * ```
+ *
+ * @param CreateBrandProfileCommandInput - {@link CreateBrandProfileCommandInput}
+ * @returns {@link CreateBrandProfileCommandOutput}
+ * @see {@link CreateBrandProfileCommandInput} for command's `input` shape.
+ * @see {@link CreateBrandProfileCommandOutput} for command's `response` shape.
+ * @see {@link EndUserMessagingClientResolvedConfig | config} for EndUserMessagingClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have sufficient access to perform this action.</p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>The request conflicts with the current state of the resource.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>An unexpected error occurred during the processing of the request.</p>
+ *
+ * @throws {@link ServiceQuotaExceededException} (client fault)
+ *  <p>The request would exceed a service quota for your account.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied because it exceeded the allowed request rate.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  A standard error for input validation failures.
+ * This should be thrown by services when a member of the input structure
+ * falls outside of the modeled or documented constraints.
+ *
+ * @throws {@link EndUserMessagingServiceException}
+ * <p>Base exception class for all service exceptions from EndUserMessaging service.</p>
+ *
+ *
+ * @example Create a brand profile
+ * ```javascript
+ * //
+ * const input = {
+ *   brandProfileName: "AcmeCorp",
+ *   deletionProtectionEnabled: true
+ * };
+ * const command = new CreateBrandProfileCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   attributesCreated: 0,
+ *   brandProfileArn: "arn:aws:end-user-messaging:us-east-1:123456789012:brand-profile/bp-abc12345678901234",
+ *   brandProfileId: "bp-abc12345678901234",
+ *   brandProfileName: "AcmeCorp",
+ *   createdAt: 1727130000,
+ *   deletionProtectionEnabled: true,
+ *   status: "ACTIVE",
+ *   updatedAt: 1727130000
+ * }
+ * *\/
+ * ```
+ *
+ * @public
+ */
+export declare class CreateBrandProfileCommand extends CreateBrandProfileCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: CreateBrandProfileInput;
+            output: CreateBrandProfileOutput;
+        };
+        sdk: {
+            input: CreateBrandProfileCommandInput;
+            output: CreateBrandProfileCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,130 @@
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { CreateBrandProfileFromRegistrationInput, CreateBrandProfileFromRegistrationOutput } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+/**
+ * @public
+ *
+ * The input for {@link CreateBrandProfileFromRegistrationCommand}.
+ */
+export interface CreateBrandProfileFromRegistrationCommandInput extends CreateBrandProfileFromRegistrationInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link CreateBrandProfileFromRegistrationCommand}.
+ */
+export interface CreateBrandProfileFromRegistrationCommandOutput extends CreateBrandProfileFromRegistrationOutput, __MetadataBearer {
+}
+declare const CreateBrandProfileFromRegistrationCommand_base: {
+    new (input: CreateBrandProfileFromRegistrationCommandInput): import("@smithy/core/client").CommandImpl<CreateBrandProfileFromRegistrationCommandInput, CreateBrandProfileFromRegistrationCommandOutput, import("..").EndUserMessagingClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    new (input: CreateBrandProfileFromRegistrationCommandInput): import("@smithy/core/client").CommandImpl<CreateBrandProfileFromRegistrationCommandInput, CreateBrandProfileFromRegistrationCommandOutput, import("..").EndUserMessagingClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
+};
+/**
+ * <p>Creates a brand profile and populates its attributes from an existing registration. This operation runs asynchronously. Use the GetJob operation to track its progress.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { EndUserMessagingClient, CreateBrandProfileFromRegistrationCommand } from "@aws-sdk/client-endusermessaging"; // ES Modules import
+ * // const { EndUserMessagingClient, CreateBrandProfileFromRegistrationCommand } = require("@aws-sdk/client-endusermessaging"); // CommonJS import
+ * // import type { EndUserMessagingClientConfig } from "@aws-sdk/client-endusermessaging";
+ * const config = {}; // type is EndUserMessagingClientConfig
+ * const client = new EndUserMessagingClient(config);
+ * const input = { // CreateBrandProfileFromRegistrationInput
+ *   registrationId: "STRING_VALUE", // required
+ *   brandProfileName: "STRING_VALUE", // required
+ *   smartMatch: true || false,
+ *   tags: [ // TagList
+ *     { // Tag
+ *       key: "STRING_VALUE", // required
+ *       value: "STRING_VALUE", // required
+ *     },
+ *   ],
+ *   clientToken: "STRING_VALUE",
+ * };
+ * const command = new CreateBrandProfileFromRegistrationCommand(input);
+ * const response = await client.send(command);
+ * // { // CreateBrandProfileFromRegistrationOutput
+ * //   results: [ // JobResults // required
+ * //     { // JobResult
+ * //       jobId: "STRING_VALUE", // required
+ * //       resourceIdentifier: "STRING_VALUE", // required
+ * //     },
+ * //   ],
+ * // };
+ *
+ * ```
+ *
+ * @param CreateBrandProfileFromRegistrationCommandInput - {@link CreateBrandProfileFromRegistrationCommandInput}
+ * @returns {@link CreateBrandProfileFromRegistrationCommandOutput}
+ * @see {@link CreateBrandProfileFromRegistrationCommandInput} for command's `input` shape.
+ * @see {@link CreateBrandProfileFromRegistrationCommandOutput} for command's `response` shape.
+ * @see {@link EndUserMessagingClientResolvedConfig | config} for EndUserMessagingClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have sufficient access to perform this action.</p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>The request conflicts with the current state of the resource.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>An unexpected error occurred during the processing of the request.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The request references a resource that does not exist. Verify that the resource identifier is correct and try your request again.</p>
+ *
+ * @throws {@link ServiceQuotaExceededException} (client fault)
+ *  <p>The request would exceed a service quota for your account.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied because it exceeded the allowed request rate.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  A standard error for input validation failures.
+ * This should be thrown by services when a member of the input structure
+ * falls outside of the modeled or documented constraints.
+ *
+ * @throws {@link EndUserMessagingServiceException}
+ * <p>Base exception class for all service exceptions from EndUserMessaging service.</p>
+ *
+ *
+ * @example Create a brand profile from a registration
+ * ```javascript
+ * //
+ * const input = {
+ *   brandProfileName: "AcmeCorp",
+ *   registrationId: "reg-abc12345678901234",
+ *   smartMatch: true
+ * };
+ * const command = new CreateBrandProfileFromRegistrationCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   results: [
+ *     {
+ *       jobId: "job-abc12345678901234",
+ *       resourceIdentifier: "reg-abc12345678901234"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * ```
+ *
+ * @public
+ */
+export declare class CreateBrandProfileFromRegistrationCommand extends CreateBrandProfileFromRegistrationCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: CreateBrandProfileFromRegistrationInput;
+            output: CreateBrandProfileFromRegistrationOutput;
+        };
+        sdk: {
+            input: CreateBrandProfileFromRegistrationCommandInput;
+            output: CreateBrandProfileFromRegistrationCommandOutput;
+        };
+    };
+}