@azure-rest/communication-messages 2.0.1-alpha.20241119.1 → 2.0.1-alpha.20241203.1

package/dist/commonjs/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.47.11"
+      "packageVersion": "7.48.0"
     }
   ]
 }

package/package.json

@@ -2,7 +2,7 @@
   "name": "@azure-rest/communication-messages",
   "sdk-type": "client",
   "author": "Microsoft Corporation",
-  "version": "2.0.1-alpha.20241119.1",
+  "version": "2.0.1-alpha.20241203.1",
   "description": "Azure client library for Azure Communication Messages services",
   "keywords": [
     "node",

package/dist/communication-messages.d.ts

@@ -1,513 +0,0 @@
-import { Client } from '@azure-rest/core-client';
-import { ClientOptions } from '@azure-rest/core-client';
-import { ErrorResponse } from '@azure-rest/core-client';
-import { HttpResponse } from '@azure-rest/core-client';
-import type { KeyCredential } from '@azure/core-auth';
-import { Paged } from '@azure/core-paging';
-import { PagedAsyncIterableIterator } from '@azure/core-paging';
-import { PathUncheckedResponse } from '@azure-rest/core-client';
-import { RawHttpHeaders } from '@azure/core-rest-pipeline';
-import { RawHttpHeadersInput } from '@azure/core-rest-pipeline';
-import { RequestParameters } from '@azure-rest/core-client';
-import { StreamableMethod } from '@azure-rest/core-client';
-import type { TokenCredential } from '@azure/core-auth';
-
-/** A request to send an audio notification. */
-export declare interface AudioNotificationContent extends NotificationContentParent {
-    /** Message notification type is audio. */
-    kind: "audio";
-    /** A media url for the file. Required if the type is one of the supported media types, e.g. image */
-    mediaUri: string;
-}
-
-/** Alias for CommunicationMessageKind */
-export declare type CommunicationMessageKind = string;
-
-/** Alias for CommunicationMessagesChannelOutput */
-export declare type CommunicationMessagesChannelOutput = string;
-
-/**
- * Initialize a new instance of `MessagesServiceClient`
- * @param connectionString - The connectionString or url of your Communication Services resource.
- * @param options - the parameter for all optional parameters
- */
-declare function createClient(connectionString: string, options?: ClientOptions): MessagesServiceClient;
-
-/**
- * Initialize a new instance of `MessagesServiceClient`
- * @param endpoint - The endpoint of your Communication Services resource.
- * @param credential - The key or token credential.
- * @param options - the parameter for all optional parameters
- */
-declare function createClient(endpoint: string, credential: KeyCredential | TokenCredential, options?: ClientOptions): MessagesServiceClient;
-export default createClient;
-
-/** A request to send a document notification. */
-export declare interface DocumentNotificationContent extends NotificationContentParent {
-    /** Message notification type is image. */
-    kind: "document";
-    /** Optional text content. */
-    caption?: string;
-    /** Optional name for the file. */
-    fileName?: string;
-    /** A media url for the file. Required if the type is one of the supported media types, e.g. image */
-    mediaUri: string;
-}
-
-/**
- * Helper type to extract the type of an array
- */
-export declare type GetArrayType<T> = T extends Array<infer TData> ? TData : never;
-
-export declare interface GetMedia {
-    /** Download the Media payload from a User to Business message. */
-    get(options?: GetMediaParameters): StreamableMethod<GetMedia200Response | GetMediaDefaultResponse>;
-}
-
-export declare interface GetMedia200Headers {
-    /** An opaque, globally-unique, client-generated string identifier for the request. */
-    "x-ms-client-request-id"?: string;
-    /** The stream content type. */
-    "content-type": "application/octet-stream";
-}
-
-/** The request has succeeded. */
-export declare interface GetMedia200Response extends HttpResponse {
-    status: "200";
-    /** Value may contain any sequence of octets */
-    body: Uint8Array;
-    headers: RawHttpHeaders & GetMedia200Headers;
-}
-
-export declare interface GetMediaDefaultHeaders {
-    /** String error code indicating what went wrong. */
-    "x-ms-error-code"?: string;
-}
-
-export declare interface GetMediaDefaultResponse extends HttpResponse {
-    status: string;
-    body: ErrorResponse;
-    headers: RawHttpHeaders & GetMediaDefaultHeaders;
-}
-
-export declare interface GetMediaHeaderParam {
-    headers?: RawHttpHeadersInput & GetMediaHeaders;
-}
-
-export declare interface GetMediaHeaders {
-    /** An opaque, globally-unique, client-generated string identifier for the request. */
-    "x-ms-client-request-id"?: string;
-}
-
-export declare type GetMediaParameters = GetMediaHeaderParam & RequestParameters;
-
-/**
- * The type of a custom function that defines how to get a page and a link to the next one if any.
- */
-export declare type GetPage<TPage> = (pageLink: string, maxPageSize?: number) => Promise<{
-    page: TPage;
-    nextPageLink?: string;
-}>;
-
-/** A request to send an image notification. */
-export declare interface ImageNotificationContent extends NotificationContentParent {
-    /** Message notification type is image. */
-    kind: "image";
-    /** Optional text content. */
-    caption?: string;
-    /** A media url for the file. Required if the type is one of the supported media types, e.g. image */
-    mediaUri: string;
-}
-
-export declare function isUnexpected(response: GetMedia200Response | GetMediaDefaultResponse): response is GetMediaDefaultResponse;
-
-export declare function isUnexpected(response: Send202Response | SendDefaultResponse): response is SendDefaultResponse;
-
-export declare function isUnexpected(response: ListTemplates200Response | ListTemplatesDefaultResponse): response is ListTemplatesDefaultResponse;
-
-export declare interface ListTemplates {
-    /** List all templates for given Azure Communication Services channel */
-    get(options?: ListTemplatesParameters): StreamableMethod<ListTemplates200Response | ListTemplatesDefaultResponse>;
-}
-
-export declare interface ListTemplates200Headers {
-    /** An opaque, globally-unique, client-generated string identifier for the request. */
-    "x-ms-client-request-id"?: string;
-}
-
-/** The request has succeeded. */
-export declare interface ListTemplates200Response extends HttpResponse {
-    status: "200";
-    body: PagedMessageTemplateItemOutput;
-    headers: RawHttpHeaders & ListTemplates200Headers;
-}
-
-export declare interface ListTemplatesDefaultHeaders {
-    /** String error code indicating what went wrong. */
-    "x-ms-error-code"?: string;
-}
-
-export declare interface ListTemplatesDefaultResponse extends HttpResponse {
-    status: string;
-    body: ErrorResponse;
-    headers: RawHttpHeaders & ListTemplatesDefaultHeaders;
-}
-
-export declare interface ListTemplatesHeaderParam {
-    headers?: RawHttpHeadersInput & ListTemplatesHeaders;
-}
-
-export declare interface ListTemplatesHeaders {
-    /** An opaque, globally-unique, client-generated string identifier for the request. */
-    "x-ms-client-request-id"?: string;
-}
-
-export declare type ListTemplatesParameters = ListTemplatesQueryParam & ListTemplatesHeaderParam & RequestParameters;
-
-export declare interface ListTemplatesQueryParam {
-    queryParameters?: ListTemplatesQueryParamProperties;
-}
-
-export declare interface ListTemplatesQueryParamProperties {
-    /** Number of objects to return per page. */
-    maxpagesize?: number;
-}
-
-/** @deprecated A request to send an image notification. */
-export declare interface MediaNotificationContent extends NotificationContentParent {
-    /** Message notification type is image. */
-    kind: "image_v0";
-    /** Optional text content. */
-    content?: string;
-    /** A media url for the file. Required if the type is one of the supported media types, e.g. image */
-    mediaUri: string;
-}
-
-/** Receipt of the sending one message. */
-export declare interface MessageReceiptOutput {
-    /** The message id. */
-    messageId: string;
-    /** The native external platform user identifier of the recipient. */
-    to: string;
-}
-
-export declare type MessagesServiceClient = Client & {
-    path: Routes;
-};
-
-/** The optional parameters for the client */
-export declare interface MessagesServiceClientOptions extends ClientOptions {
-    /** The api version option of the client */
-    apiVersion?: string;
-}
-
-/** The template object used to create templates. */
-export declare interface MessageTemplate {
-    /** Name of the template. */
-    name: string;
-    /** The template's language, in the ISO 639 format, consist of a two-letter language code followed by an optional two-letter country code, e.g., 'en' or 'en_US'. */
-    language: string;
-    /** The template values. */
-    values?: Array<MessageTemplateValue>;
-    /** The binding object to link values to the template specific locations */
-    bindings?: MessageTemplateBindings;
-}
-
-/** The binding object to link values to the template specific locations */
-export declare type MessageTemplateBindings = MessageTemplateBindingsParent | WhatsAppMessageTemplateBindings;
-
-/** Alias for MessageTemplateBindingsKind */
-export declare type MessageTemplateBindingsKind = string;
-
-/** The binding object to link values to the template specific locations */
-export declare interface MessageTemplateBindingsParent {
-    kind: MessageTemplateBindingsKind;
-}
-
-/** The message template's document value information. */
-export declare interface MessageTemplateDocument extends MessageTemplateValueParent {
-    /** Message parameter type is document. */
-    kind: "document";
-    /** The (public) URL of the media. */
-    url: string;
-    /** The [optional] caption of the media object. */
-    caption?: string;
-    /** The [optional] filename of the media file. */
-    fileName?: string;
-}
-
-/** The message template's image value information. */
-export declare interface MessageTemplateImage extends MessageTemplateValueParent {
-    /** Message parameter type is image. */
-    kind: "image";
-    /** The (public) URL of the media. */
-    url: string;
-    /** The [optional] caption of the media object. */
-    caption?: string;
-    /** The [optional] filename of the media file. */
-    fileName?: string;
-}
-
-/** The message template as returned from the service. */
-export declare type MessageTemplateItemOutput = MessageTemplateItemOutputParent | WhatsAppMessageTemplateItemOutput;
-
-/** The message template as returned from the service. */
-export declare interface MessageTemplateItemOutputParent {
-    /** The template's name. */
-    readonly name: string;
-    /** The template's language, in the ISO 639 format, consist of a two-letter language code followed by an optional two-letter country code, e.g., 'en' or 'en_US'. */
-    language: string;
-    /**
-     * The aggregated template status.
-     *
-     * Possible values: "approved", "rejected", "pending", "paused"
-     */
-    status: MessageTemplateStatusOutput;
-    kind: CommunicationMessagesChannelOutput;
-}
-
-/** The message template's location value information. */
-export declare interface MessageTemplateLocation extends MessageTemplateValueParent {
-    /** Message parameter type is location. */
-    kind: "location";
-    /** The [Optional] name of the location. */
-    locationName?: string;
-    /** The [Optional] address of the location. */
-    address?: string;
-    /** The latitude of the location. */
-    latitude: number;
-    /** The longitude of the location. */
-    longitude: number;
-}
-
-/** The message template's quick action value information. */
-export declare interface MessageTemplateQuickAction extends MessageTemplateValueParent {
-    /** Message parameter type is quick action. */
-    kind: "quickAction";
-    /** The [Optional] quick action text */
-    text?: string;
-    /** The [Optional] quick action payload */
-    payload?: string;
-}
-
-/** Alias for MessageTemplateStatusOutput */
-export declare type MessageTemplateStatusOutput = string;
-
-/** The message template's text value information. */
-export declare interface MessageTemplateText extends MessageTemplateValueParent {
-    /** Message parameter type is text. */
-    kind: "text";
-    /** The text value. */
-    text: string;
-}
-
-/** The class describes a parameter of a template. */
-export declare type MessageTemplateValue = MessageTemplateValueParent | MessageTemplateText | MessageTemplateImage | MessageTemplateDocument | MessageTemplateVideo | MessageTemplateLocation | MessageTemplateQuickAction;
-
-/** Alias for MessageTemplateValueKind */
-export declare type MessageTemplateValueKind = string;
-
-/** The class describes a parameter of a template. */
-export declare interface MessageTemplateValueParent {
-    /** Template binding reference name */
-    name: string;
-    kind: MessageTemplateValueKind;
-}
-
-/** The message template's video value information. */
-export declare interface MessageTemplateVideo extends MessageTemplateValueParent {
-    /** Message parameter type is video. */
-    kind: "video";
-    /** The (public) URL of the media. */
-    url: string;
-    /** The [optional] caption of the media object. */
-    caption?: string;
-    /** The [optional] filename of the media file. */
-    fileName?: string;
-}
-
-/** Details of the message to send. */
-export declare type NotificationContent = NotificationContentParent | TextNotificationContent | MediaNotificationContent | ImageNotificationContent | DocumentNotificationContent | VideoNotificationContent | AudioNotificationContent | TemplateNotificationContent;
-
-/** Details of the message to send. */
-export declare interface NotificationContentParent {
-    /** The Channel Registration ID for the Business Identifier. */
-    channelRegistrationId: string;
-    /** The native external platform user identifiers of the recipient. */
-    to: string[];
-    kind: CommunicationMessageKind;
-}
-
-/** Paged collection of MessageTemplateItem items */
-export declare type PagedMessageTemplateItemOutput = Paged<MessageTemplateItemOutput>;
-
-/**
- * Helper to paginate results from an initial response that follows the specification of Autorest `x-ms-pageable` extension
- * @param client - Client to use for sending the next page requests
- * @param initialResponse - Initial response containing the nextLink and current page of elements
- * @param customGetPage - Optional - Function to define how to extract the page and next link to be used to paginate the results
- * @returns - PagedAsyncIterableIterator to iterate the elements
- */
-export declare function paginate<TResponse extends PathUncheckedResponse>(client: Client, initialResponse: TResponse, options?: PagingOptions<TResponse>): PagedAsyncIterableIterator<PaginateReturn<TResponse>>;
-
-/**
- * Helper type to infer the Type of the paged elements from the response type
- * This type is generated based on the swagger information for x-ms-pageable
- * specifically on the itemName property which indicates the property of the response
- * where the page items are found. The default value is `value`.
- * This type will allow us to provide strongly typed Iterator based on the response we get as second parameter
- */
-export declare type PaginateReturn<TResult> = TResult extends {
-    body: {
-        value?: infer TPage;
-    };
-} ? GetArrayType<TPage> : Array<unknown>;
-
-/**
- * Options for the paging helper
- */
-export declare interface PagingOptions<TResponse> {
-    /**
-     * Custom function to extract pagination details for crating the PagedAsyncIterableIterator
-     */
-    customGetPage?: GetPage<PaginateReturn<TResponse>[]>;
-}
-
-/** Alias for RepeatabilityResultOutput */
-export declare type RepeatabilityResultOutput = "accepted" | "rejected";
-
-export declare interface Routes {
-    /** Resource for '/messages/streams/\{id\}' has methods for the following verbs: get */
-    (path: "/messages/streams/{id}", id: string): GetMedia;
-    /** Resource for '/messages/notifications:send' has methods for the following verbs: post */
-    (path: "/messages/notifications:send"): Send;
-    /** Resource for '/messages/channels/\{channelId\}/templates' has methods for the following verbs: get */
-    (path: "/messages/channels/{channelId}/templates", channelId: string): ListTemplates;
-}
-
-export declare interface Send {
-    /** Sends a notification message from Business to User. */
-    post(options: SendParameters): StreamableMethod<Send202Response | SendDefaultResponse>;
-}
-
-export declare interface Send202Headers {
-    /** Indicates whether the repeatable request was accepted or rejected. */
-    "repeatability-result"?: RepeatabilityResultOutput;
-    /** An opaque, globally-unique, client-generated string identifier for the request. */
-    "x-ms-client-request-id"?: string;
-}
-
-/** The request has been accepted for processing, but processing has not yet completed. */
-export declare interface Send202Response extends HttpResponse {
-    status: "202";
-    body: SendMessageResultOutput;
-    headers: RawHttpHeaders & Send202Headers;
-}
-
-export declare interface SendBodyParam {
-    /** Details of the message to send. */
-    body: NotificationContent;
-}
-
-export declare interface SendDefaultHeaders {
-    /** String error code indicating what went wrong. */
-    "x-ms-error-code"?: string;
-}
-
-export declare interface SendDefaultResponse extends HttpResponse {
-    status: string;
-    body: ErrorResponse;
-    headers: RawHttpHeaders & SendDefaultHeaders;
-}
-
-export declare interface SendHeaderParam {
-    headers?: RawHttpHeadersInput & SendHeaders;
-}
-
-export declare interface SendHeaders {
-    /** An opaque, globally-unique, client-generated string identifier for the request. */
-    "Repeatability-Request-ID"?: string;
-    /** Specifies the date and time at which the request was first created. */
-    "Repeatability-First-Sent"?: string;
-    /** An opaque, globally-unique, client-generated string identifier for the request. */
-    "x-ms-client-request-id"?: string;
-}
-
-/** Result of the send message operation. */
-export declare interface SendMessageResultOutput {
-    /** Receipts of the send message operation. */
-    receipts: Array<MessageReceiptOutput>;
-}
-
-export declare type SendParameters = SendHeaderParam & SendBodyParam & RequestParameters;
-
-/** A request to send a template notification. */
-export declare interface TemplateNotificationContent extends NotificationContentParent {
-    /** Message notification type is template. */
-    kind: "template";
-    /** The template object used to create templates. */
-    template: MessageTemplate;
-}
-
-/** A request to send a text notification. */
-export declare interface TextNotificationContent extends NotificationContentParent {
-    /** Message notification type is text. */
-    kind: "text";
-    /** Message content. */
-    content: string;
-}
-
-/** A request to send a video notification. */
-export declare interface VideoNotificationContent extends NotificationContentParent {
-    /** Message notification type is image. */
-    kind: "video";
-    /** Optional text content. */
-    caption?: string;
-    /** A media url for the file. Required if the type is one of the supported media types, e.g. image */
-    mediaUri: string;
-}
-
-/** Alias for WhatsAppMessageButtonSubType */
-export declare type WhatsAppMessageButtonSubType = string;
-
-/** The template bindings for WhatsApp */
-export declare interface WhatsAppMessageTemplateBindings extends MessageTemplateBindingsParent {
-    /** MessageTemplateBindings is whatsApp */
-    kind: "whatsApp";
-    /** The header template bindings */
-    header?: Array<WhatsAppMessageTemplateBindingsComponent>;
-    /** The body template bindings */
-    body?: Array<WhatsAppMessageTemplateBindingsComponent>;
-    /** The footer template bindings */
-    footer?: Array<WhatsAppMessageTemplateBindingsComponent>;
-    /** The button template bindings */
-    buttons?: Array<WhatsAppMessageTemplateBindingsButton>;
-}
-
-/** The template bindings component button for WhatsApp */
-export declare interface WhatsAppMessageTemplateBindingsButton {
-    /**
-     * The WhatsApp button sub type
-     *
-     * Possible values: "quickReply", "url"
-     */
-    subType: WhatsAppMessageButtonSubType;
-    /** The name of the referenced item in the template values. */
-    refValue: string;
-}
-
-/** The template bindings component for WhatsApp */
-export declare interface WhatsAppMessageTemplateBindingsComponent {
-    /** The name of the referenced item in the template values. */
-    refValue: string;
-}
-
-/** The WhatsApp-specific template response contract */
-export declare interface WhatsAppMessageTemplateItemOutput extends MessageTemplateItemOutputParent {
-    /** WhatsApp platform's template content. This is the payload returned from WhatsApp API. */
-    content?: any;
-    /** Message template response type is whatsApp. */
-    kind: "whatsApp";
-}
-
-export { }