@azure/communication-email 1.0.0-alpha.20220524.1 → 1.0.0-alpha.20220630.1

package/types/communication-email.d.ts

@@ -1,48 +1,65 @@
+import { CommonClientOptions } from '@azure/core-client';
 import { KeyCredential } from '@azure/core-auth';
-import { PipelineOptions } from '@azure/core-http';
 
-/**
- * An object representing the email address and its display name
- */
+/** An object representing the email address and its display name */
 export declare interface EmailAddress {
-    /**
-     * Email address.
-     */
+    /** Email address. */
     email: string;
-    /**
-     * Email display name.
-     */
+    /** Email display name. */
     displayName?: string;
 }
 
-/**
- * Attachment to the email.
- */
+/** Attachment to the email. */
 export declare interface EmailAttachment {
-    /**
-     * Name of the attachment
-     */
+    /** Name of the attachment */
     name: string;
-    /**
-     * The type of attachment file.
-     */
+    /** The type of attachment file. */
     attachmentType: EmailAttachmentType;
-    /**
-     * Base64 encoded contents of the attachment
-     */
+    /** Base64 encoded contents of the attachment */
     contentBytesBase64: string;
 }
 
 /**
- * Defines values for EmailAttachmentType.
+ * 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 = "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.
  */
 export declare class EmailClient {
-    private readonly api;
+    private readonly generatedClient;
     /**
      * Initializes a new instance of the EmailClient class.
      * @param connectionString - Connection string to connect to an Azure Communication Service resource.
@@ -72,100 +89,66 @@ export declare class EmailClient {
 /**
  * Client options used to configure SMS Client API requests.
  */
-export declare interface EmailClientOptions extends PipelineOptions {
+export declare interface EmailClientOptions extends CommonClientOptions {
 }
 
-/**
- * Content of the email.
- */
+/** Content of the email. */
 export declare interface EmailContent {
-    /**
-     * Subject of the email message
-     */
+    /** Subject of the email message */
     subject: string;
-    /**
-     * Plain text version of the email message.
-     */
+    /** Plain text version of the email message. */
     plainText?: string;
-    /**
-     * Html version of the email message.
-     */
+    /** Html version of the email message. */
     html?: string;
 }
 
-/**
- * Custom header for email.
- */
+/** Custom header for email. */
 export declare interface EmailCustomHeader {
-    /**
-     * Header name.
-     */
+    /** Header name. */
     name: string;
-    /**
-     * Header value.
-     */
+    /** Header value. */
     value: string;
 }
 
 /**
- * Defines values for EmailImportance.
+ * 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 = "high" | "normal" | "low";
+export declare type EmailImportance = string;
 
-/**
- * Message payload for sending an email
- */
+/** Message payload for sending an email */
 export declare interface EmailMessage {
-    /**
-     * Custom email headers to be passed.
-     */
+    /** Custom email headers to be passed. */
     customHeaders?: EmailCustomHeader[];
-    /**
-     * Sender email address from a verified domain.
-     */
+    /** Sender email address from a verified domain. */
     sender: string;
-    /**
-     * Email content to be sent.
-     */
+    /** Email content to be sent. */
     content: EmailContent;
-    /**
-     * The importance type for the email.
-     */
+    /** The importance type for the email. */
     importance?: EmailImportance;
-    /**
-     * Recipients for the email.
-     */
+    /** Recipients for the email. */
     recipients: EmailRecipients;
-    /**
-     * list of attachments
-     */
+    /** list of attachments */
     attachments?: EmailAttachment[];
-    /**
-     * Email addresses where recipients' replies will be sent to.
-     */
+    /** 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.
-     */
+    /** 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. */
     disableUserEngagementTracking?: boolean;
 }
 
-/**
- * Recipients of the email
- */
+/** Recipients of the email */
 export declare interface EmailRecipients {
-    /**
-     * Email to recipients
-     */
+    /** Email To recipients */
     to: EmailAddress[];
-    /**
-     * Email cc recipients
-     */
-    cC?: EmailAddress[];
-    /**
-     * Email bcc recipients
-     */
-    bCC?: EmailAddress[];
+    /** Email CC recipients */
+    cc?: EmailAddress[];
+    /** Email BCC recipients */
+    bcc?: EmailAddress[];
 }
 
 /**
@@ -179,21 +162,21 @@ export declare interface SendEmailResult {
 }
 
 /**
- * Defines values for SendStatus.
+ * 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 = "queued" | "outForDelivery" | "dropped";
+export declare type SendStatus = string;
 
-/**
- * Status of an email message that was sent previously.
- */
+/** Status of an email message that was sent previously. */
 export declare interface SendStatusResult {
-    /**
-     * System generated id of an email message sent.
-     */
+    /** System generated id of an email message sent. */
     messageId: string;
-    /**
-     * The type indicating the status of a request.
-     */
+    /** The type indicating the status of a request. */
     status: SendStatus;
 }
 

package/dist-esm/src/constants.js

@@ -1,4 +0,0 @@
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-export const SDK_VERSION = "1.0.0-beta.1";
-//# sourceMappingURL=constants.js.map

package/dist-esm/src/constants.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,MAAM,CAAC,MAAM,WAAW,GAAW,cAAc,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nexport const SDK_VERSION: string = \"1.0.0-beta.1\";\n"]}

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

@@ -1,38 +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 * as coreHttp from "@azure/core-http";
-const packageName = "@azure/communication-email";
-const packageVersion = "1.0.0-beta.1";
-export class EmailRestApiClientContext extends coreHttp.ServiceClient {
-    /**
-     * Initializes a new instance of the EmailRestApiClientContext class.
-     * @param endpoint The communication resource, for example https://my-resource.communication.azure.com
-     * @param options The parameter options
-     */
-    constructor(endpoint, options) {
-        if (endpoint === undefined) {
-            throw new Error("'endpoint' cannot be null");
-        }
-        // Initializing default values for options
-        if (!options) {
-            options = {};
-        }
-        if (!options.userAgent) {
-            const defaultUserAgent = coreHttp.getDefaultUserAgentValue();
-            options.userAgent = `${packageName}/${packageVersion} ${defaultUserAgent}`;
-        }
-        super(undefined, options);
-        this.requestContentType = "application/json; charset=utf-8";
-        this.baseUri = options.endpoint || "{endpoint}";
-        // Parameter assignments
-        this.endpoint = endpoint;
-        // Assigning values to Constant parameters
-        this.apiVersion = options.apiVersion || "2021-10-01-preview";
-    }
-}
-//# sourceMappingURL=emailRestApiClientContext.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"emailRestApiClientContext.js","sourceRoot":"","sources":["../../../../src/generated/src/emailRestApiClientContext.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,KAAK,QAAQ,MAAM,kBAAkB,CAAC;AAG7C,MAAM,WAAW,GAAG,4BAA4B,CAAC;AACjD,MAAM,cAAc,GAAG,cAAc,CAAC;AAEtC,MAAM,OAAO,yBAA0B,SAAQ,QAAQ,CAAC,aAAa;IAInE;;;;OAIG;IACH,YAAY,QAAgB,EAAE,OAA0C;QACtE,IAAI,QAAQ,KAAK,SAAS,EAAE;YAC1B,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;SAC9C;QAED,0CAA0C;QAC1C,IAAI,CAAC,OAAO,EAAE;YACZ,OAAO,GAAG,EAAE,CAAC;SACd;QAED,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE;YACtB,MAAM,gBAAgB,GAAG,QAAQ,CAAC,wBAAwB,EAAE,CAAC;YAC7D,OAAO,CAAC,SAAS,GAAG,GAAG,WAAW,IAAI,cAAc,IAAI,gBAAgB,EAAE,CAAC;SAC5E;QAED,KAAK,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;QAE1B,IAAI,CAAC,kBAAkB,GAAG,iCAAiC,CAAC;QAE5D,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,QAAQ,IAAI,YAAY,CAAC;QAEhD,wBAAwB;QACxB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QAEzB,0CAA0C;QAC1C,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,oBAAoB,CAAC;IAC/D,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 * as coreHttp from \"@azure/core-http\";\nimport { EmailRestApiClientOptionalParams } from \"./models\";\n\nconst packageName = \"@azure/communication-email\";\nconst packageVersion = \"1.0.0-beta.1\";\n\nexport class EmailRestApiClientContext extends coreHttp.ServiceClient {\n  endpoint: string;\n  apiVersion: string;\n\n  /**\n   * Initializes a new instance of the EmailRestApiClientContext class.\n   * @param endpoint The communication resource, for example https://my-resource.communication.azure.com\n   * @param options The parameter options\n   */\n  constructor(endpoint: string, options?: EmailRestApiClientOptionalParams) {\n    if (endpoint === undefined) {\n      throw new Error(\"'endpoint' cannot be null\");\n    }\n\n    // Initializing default values for options\n    if (!options) {\n      options = {};\n    }\n\n    if (!options.userAgent) {\n      const defaultUserAgent = coreHttp.getDefaultUserAgentValue();\n      options.userAgent = `${packageName}/${packageVersion} ${defaultUserAgent}`;\n    }\n\n    super(undefined, options);\n\n    this.requestContentType = \"application/json; charset=utf-8\";\n\n    this.baseUri = options.endpoint || \"{endpoint}\";\n\n    // Parameter assignments\n    this.endpoint = endpoint;\n\n    // Assigning values to Constant parameters\n    this.apiVersion = options.apiVersion || \"2021-10-01-preview\";\n  }\n}\n"]}