@azure/communication-email 1.0.0-alpha.20230303.2 → 1.0.0-alpha.20230303.3

package/types/communication-email.d.ts

@@ -1,14 +1,11 @@
 import { CommonClientOptions } from '@azure/core-client';
 import { KeyCredential } from '@azure/core-auth';
-import { OperationOptions } from '@azure/core-client';
-import { PollerLike } from '@azure/core-lro';
-import { PollOperationState } from '@azure/core-lro';
 import { TokenCredential } from '@azure/core-auth';
 
 /** An object representing the email address and its display name */
 export declare interface EmailAddress {
     /** Email address. */
-    address: string;
+    email: string;
     /** Email display name. */
     displayName?: string;
 }
@@ -17,12 +14,48 @@ export declare interface EmailAddress {
 export declare interface EmailAttachment {
     /** Name of the attachment */
     name: string;
-    /** MIME type of the content being attached. */
-    contentType: string;
+    /** The type of attachment file. */
+    attachmentType: EmailAttachmentType;
     /** Base64 encoded contents of the attachment */
-    contentInBase64: string;
+    contentBytesBase64: string;
 }
 
+/**
+ * Defines values for EmailAttachmentType. \
+ * {@link KnownEmailAttachmentType} can be used interchangeably with EmailAttachmentType,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **avi** \
+ * **bmp** \
+ * **doc** \
+ * **docm** \
+ * **docx** \
+ * **gif** \
+ * **jpeg** \
+ * **mp3** \
+ * **one** \
+ * **pdf** \
+ * **png** \
+ * **ppsm** \
+ * **ppsx** \
+ * **ppt** \
+ * **pptm** \
+ * **pptx** \
+ * **pub** \
+ * **rpmsg** \
+ * **rtf** \
+ * **tif** \
+ * **txt** \
+ * **vsd** \
+ * **wav** \
+ * **wma** \
+ * **xls** \
+ * **xlsb** \
+ * **xlsm** \
+ * **xlsx**
+ */
+export declare type EmailAttachmentType = string;
+
 /**
  *  The Email service client.
  */
@@ -41,42 +74,79 @@ export declare class EmailClient {
      * @param credential - An object that is used to authenticate requests to the service. Use the Azure KeyCredential or `@azure/identity` to create a credential.
      * @param options - Optional. Options to configure the HTTP pipeline.
      */
-    constructor(endpoint: string, credential: KeyCredential | TokenCredential, options?: EmailClientOptions);
+    constructor(endpoint: string, credential: KeyCredential, options?: EmailClientOptions);
+    /**
+     * Initializes a new instance of the EmailClient class using a TokenCredential.
+     * @param endpoint - The endpoint of the service (ex: https://contoso.eastus.communications.azure.net).
+     * @param credential - TokenCredential that is used to authenticate requests to the service. Use the Azure KeyCredential or `@azure/identity` to create a credential.
+     * @param options - Optional. Options to configure the HTTP pipeline.
+     */
+    constructor(endpoint: string, credential: TokenCredential, options?: EmailClientOptions);
     /**
      * Queues an email message to be sent to one or more recipients
-     * @param message - Message payload for sending an email
-     * @param options - The options parameters.
+     * @param emailMessage - Message payload for sending an email
      */
-    beginSend(message: EmailMessage, options?: EmailSendOptionalParams): Promise<PollerLike<PollOperationState<EmailSendResponse>, EmailSendResponse>>;
+    send(emailMessage: EmailMessage): Promise<SendEmailResult>;
+    /**
+     * Gets the status of a message sent previously.
+     * @param messageId - System generated message id (GUID) returned from a previous call to send email
+     */
+    getSendStatus(messageId: string): Promise<SendStatusResult>;
 }
 
 /**
- * Client options used to configure Email Client API requests.
+ * Client options used to configure SMS Client API requests.
  */
 export declare interface EmailClientOptions extends CommonClientOptions {
 }
 
 /** Content of the email. */
-export declare type EmailContent = HtmlEmailContent | PlainTextEmailContent;
+export declare interface EmailContent {
+    /** Subject of the email message */
+    subject: string;
+    /** Plain text version of the email message. */
+    plainText?: string;
+    /** Html version of the email message. */
+    html?: string;
+}
+
+/** Custom header for email. */
+export declare interface EmailCustomHeader {
+    /** Header name. */
+    name: string;
+    /** Header value. */
+    value: string;
+}
+
+/**
+ * Defines values for EmailImportance. \
+ * {@link KnownEmailImportance} can be used interchangeably with EmailImportance,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **high** \
+ * **normal** \
+ * **low**
+ */
+export declare type EmailImportance = string;
 
 /** Message payload for sending an email */
 export declare interface EmailMessage {
     /** Custom email headers to be passed. */
-    headers?: {
-        [propertyName: string]: string;
-    };
+    customHeaders?: EmailCustomHeader[];
     /** Sender email address from a verified domain. */
-    senderAddress: string;
+    sender: string;
     /** Email content to be sent. */
     content: EmailContent;
+    /** The importance type for the email. */
+    importance?: EmailImportance;
     /** Recipients for the email. */
     recipients: EmailRecipients;
-    /** List of attachments. Please note that we limit the total size of an email request (which includes attachments) to 10MB. */
+    /** list of attachments */
     attachments?: EmailAttachment[];
     /** Email addresses where recipients' replies will be sent to. */
     replyTo?: EmailAddress[];
     /** Indicates whether user engagement tracking should be disabled for this request if the resource-level user engagement tracking setting was already enabled in the control plane. */
-    userEngagementTrackingDisabled?: boolean;
+    disableUserEngagementTracking?: boolean;
 }
 
 /** Recipients of the email */
@@ -89,125 +159,33 @@ export declare interface EmailRecipients {
     bcc?: EmailAddress[];
 }
 
-/** Defines headers for Email_send operation. */
-export declare interface EmailSendHeaders {
-    /** Location url of where to poll the status of this operation from. */
-    operationLocation?: string;
-    /** This header will only be present when the operation status is a non-terminal status. It indicates the minimum amount of time in seconds to wait before polling for operation status again. */
-    retryAfter?: number;
-}
-
-/** Optional parameters for the beginSend method. */
-export declare interface EmailSendOptionalParams extends OperationOptions {
-    /** This is the ID used by the status monitor for this long running operation. */
-    operationId?: string;
-    /** Delay to wait until next poll, in milliseconds. */
-    updateIntervalInMs?: number;
-    /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
-    resumeFrom?: string;
-}
-
-/** Contains response data for the send operation. */
-export declare type EmailSendResponse = EmailSendHeaders & EmailSendResult;
-
-/** Status of the long running operation */
-export declare interface EmailSendResult {
-    /** The unique id of the operation. Use a UUID. */
-    id: string;
-    /** Status of operation. */
-    status: EmailSendStatus;
-    /** Error details when status is a non-success terminal state. */
-    error?: ErrorDetail;
-}
-
 /**
- * Defines values for EmailSendStatus. \
- * {@link KnownEmailSendStatus} can be used interchangeably with EmailSendStatus,
- *  this enum contains the known values that the service supports.
- * ### Known values supported by the service
- * **NotStarted** \
- * **Running** \
- * **Succeeded** \
- * **Failed** \
- * **Canceled**
+ * Results of a sent email.
  */
-export declare type EmailSendStatus = string;
-
-/** The resource management error additional info. */
-export declare interface ErrorAdditionalInfo {
+export declare interface SendEmailResult {
     /**
-     * The additional info type.
-     * NOTE: This property will not be serialized. It can only be populated by the server.
+     * MessageId of the sent email.
      */
-    readonly type?: string;
-    /**
-     * The additional info.
-     * NOTE: This property will not be serialized. It can only be populated by the server.
-     */
-    readonly info?: Record<string, unknown>;
-}
-
-/** The error detail. */
-export declare interface ErrorDetail {
-    /**
-     * The error code.
-     * NOTE: This property will not be serialized. It can only be populated by the server.
-     */
-    readonly code?: string;
-    /**
-     * The error message.
-     * NOTE: This property will not be serialized. It can only be populated by the server.
-     */
-    readonly message?: string;
-    /**
-     * The error target.
-     * NOTE: This property will not be serialized. It can only be populated by the server.
-     */
-    readonly target?: string;
-    /**
-     * The error details.
-     * NOTE: This property will not be serialized. It can only be populated by the server.
-     */
-    readonly details?: ErrorDetail[];
-    /**
-     * The error additional info.
-     * NOTE: This property will not be serialized. It can only be populated by the server.
-     */
-    readonly additionalInfo?: ErrorAdditionalInfo[];
-}
-
-/** Content of the email with a required html property. */
-export declare interface HtmlEmailContent {
-    /** Subject of the email message */
-    subject: string;
-    /** Plain text version of the email message. */
-    plainText?: string;
-    /** Html version of the email message. */
-    html: string;
-}
-
-/** Known values of {@link EmailSendStatus} that the service accepts. */
-export declare enum KnownEmailSendStatus {
-    /** NotStarted */
-    NotStarted = "NotStarted",
-    /** Running */
-    Running = "Running",
-    /** Succeeded */
-    Succeeded = "Succeeded",
-    /** Failed */
-    Failed = "Failed",
-    /** Canceled */
-    Canceled = "Canceled"
+    messageId: string;
 }
 
-/** Content of the email with a required plainText property. */
-export declare interface PlainTextEmailContent {
-    /** Subject of the email message */
-    subject: string;
-    /** Plain text version of the email message. */
-    plainText: string;
-    /** Html version of the email message. */
-    html?: string;
+/**
+ * Defines values for SendStatus. \
+ * {@link KnownSendStatus} can be used interchangeably with SendStatus,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **queued**: The message has passed basic validations and has been queued to be processed further. \
+ * **outForDelivery**: The message has been processed and is now out for delivery. \
+ * **dropped**: The message could not be processed and was dropped.
+ */
+export declare type SendStatus = string;
+
+/** Status of an email message that was sent previously. */
+export declare interface SendStatusResult {
+    /** System generated id of an email message sent. */
+    messageId: string;
+    /** The type indicating the status of a request. */
+    status: SendStatus;
 }
 
 export { }

package/dist-esm/src/generated/src/lroImpl.js

@@ -1,25 +0,0 @@
-/*
- * Copyright (c) Microsoft Corporation.
- * Licensed under the MIT License.
- *
- * Code generated by Microsoft (R) AutoRest Code Generator.
- * Changes may cause incorrect behavior and will be lost if the code is regenerated.
- */
-import { __rest } from "tslib";
-export class LroImpl {
-    constructor(sendOperationFn, args, spec, requestPath = spec.path, requestMethod = spec.httpMethod) {
-        this.sendOperationFn = sendOperationFn;
-        this.args = args;
-        this.spec = spec;
-        this.requestPath = requestPath;
-        this.requestMethod = requestMethod;
-    }
-    async sendInitialRequest() {
-        return this.sendOperationFn(this.args, this.spec);
-    }
-    async sendPollRequest(path) {
-        const _a = this.spec, { requestBody } = _a, restSpec = __rest(_a, ["requestBody"]);
-        return this.sendOperationFn(this.args, Object.assign(Object.assign({}, restSpec), { path, httpMethod: "GET" }));
-    }
-}
-//# sourceMappingURL=lroImpl.js.map

package/dist-esm/src/generated/src/lroImpl.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"lroImpl.js","sourceRoot":"","sources":["../../../../src/generated/src/lroImpl.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;;AAIH,MAAM,OAAO,OAAO;IAClB,YACU,eAAkE,EAClE,IAA6B,EAC7B,IAIe,EAChB,cAAsB,IAAI,CAAC,IAAK,EAChC,gBAAwB,IAAI,CAAC,UAAU;QARtC,oBAAe,GAAf,eAAe,CAAmD;QAClE,SAAI,GAAJ,IAAI,CAAyB;QAC7B,SAAI,GAAJ,IAAI,CAIW;QAChB,gBAAW,GAAX,WAAW,CAAqB;QAChC,kBAAa,GAAb,aAAa,CAA0B;IAC7C,CAAC;IACG,KAAK,CAAC,kBAAkB;QAC7B,OAAO,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;IACpD,CAAC;IACM,KAAK,CAAC,eAAe,CAAC,IAAY;QACvC,MAAM,KAA+B,IAAI,CAAC,IAAI,EAAxC,EAAE,WAAW,OAA2B,EAAtB,QAAQ,cAA1B,eAA4B,CAAY,CAAC;QAC/C,OAAO,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,kCAChC,QAAQ,KACX,IAAI,EACJ,UAAU,EAAE,KAAK,IACjB,CAAC;IACL,CAAC;CACF","sourcesContent":["/*\n * Copyright (c) Microsoft Corporation.\n * Licensed under the MIT License.\n *\n * Code generated by Microsoft (R) AutoRest Code Generator.\n * Changes may cause incorrect behavior and will be lost if the code is regenerated.\n */\n\nimport { LongRunningOperation, LroResponse } from \"@azure/core-lro\";\n\nexport class LroImpl<T> implements LongRunningOperation<T> {\n  constructor(\n    private sendOperationFn: (args: any, spec: any) => Promise<LroResponse<T>>,\n    private args: Record<string, unknown>,\n    private spec: {\n      readonly requestBody?: unknown;\n      readonly path?: string;\n      readonly httpMethod: string;\n    } & Record<string, any>,\n    public requestPath: string = spec.path!,\n    public requestMethod: string = spec.httpMethod\n  ) {}\n  public async sendInitialRequest(): Promise<LroResponse<T>> {\n    return this.sendOperationFn(this.args, this.spec);\n  }\n  public async sendPollRequest(path: string): Promise<LroResponse<T>> {\n    const { requestBody, ...restSpec } = this.spec;\n    return this.sendOperationFn(this.args, {\n      ...restSpec,\n      path,\n      httpMethod: \"GET\"\n    });\n  }\n}\n"]}