@azure/eventgrid-namespaces 1.0.1-alpha.20241129.1 → 1.0.1-alpha.20241202.5

package/types/eventgrid-namespaces.d.ts

@@ -1,305 +0,0 @@
-import { AzureKeyCredential } from '@azure/core-auth';
-import type { ClientOptions } from '@azure-rest/core-client';
-import type { ErrorModel } from '@azure-rest/core-client';
-import { OperationOptions } from '@azure-rest/core-client';
-import type { TokenCredential } from '@azure/core-auth';
-
-export declare interface AcknowledgeEventsOptionalParams extends OperationOptions {
-}
-
-/** Acknowledge Events Options */
-export declare interface AcknowledgeEventsOptions extends AcknowledgeEventsOptionalParams {
-}
-
-/** The result of the Acknowledge operation. */
-export declare interface AcknowledgeResult {
-    /** Array of FailedLockToken for failed cloud events. Each FailedLockToken includes the lock token along with the related error information (namely, the error code and description). */
-    failedLockTokens: FailedLockToken[];
-    /** Array of lock tokens for the successfully acknowledged cloud events. */
-    succeededLockTokens: string[];
-}
-
-export { AzureKeyCredential }
-
-/** Properties of the Event Broker operation. */
-export declare interface BrokerProperties {
-    /** The token of the lock on the event. */
-    lockToken: string;
-    /** The attempt count for delivering the event. */
-    deliveryCount: number;
-}
-
-/**
- * An event in the Cloud Event 1.0 schema.
- */
-export declare interface CloudEvent<T> {
-    /**
-     * Type of event related to the originating occurrence.
-     */
-    type: string;
-    /**
-     * Identifies the context in which an event happened. The combination of id and source must be unique for each distinct event.
-     */
-    source: string;
-    /**
-     * An identifier for the event. The combination of id and source must be unique for each distinct event.
-     */
-    id: string;
-    /**
-     * The time the event was generated.
-     */
-    time?: Date;
-    /**
-     * Identifies the schema that data adheres to.
-     */
-    dataSchema?: string;
-    /**
-     * Content type of data value.
-     */
-    dataContentType?: string;
-    /**
-     * Event data specific to the event type.
-     */
-    data?: T;
-    /**
-     * This describes the subject of the event in the context of the event producer (identified by source).
-     */
-    subject?: string;
-    /**
-     * Additional context attributes for the event. The Cloud Event specification refers to these as "extension attributes".
-     */
-    extensionAttributes?: Record<string, unknown>;
-    /**
-     * The version of the CloudEvents specification which the event uses.
-     */
-    specVersion?: string | "1.0";
-}
-
-export declare interface EventGridClientOptions extends ClientOptions {
-    /** The API version to use for this operation. */
-    apiVersion?: string;
-}
-
-/**
- * EventGridDeserializer is used to aid in processing events delivered by EventGrid. It can deserialize a JSON encoded payload
- * of either a single event or batch of events as well as be used to convert the result of `JSON.parse` into an
- * `EventGridEvent` or `CloudEvent` like object.
- *
- * Unlike normal JSON deseralization, EventGridDeserializer does some additional conversions:
- *
- * - The consumer parses the event time property into a `Date` object, for ease of use.
- * - When deserializing an event in the CloudEvent schema, if the event contains binary data, it is base64 decoded
- *   and returned as an instance of the `Uint8Array` type.
- */
-export declare class EventGridDeserializer {
-    /**
-     * Deserializes events encoded in the Cloud Events 1.0 schema.
-     *
-     * @param encodedEvents - the JSON encoded representation of either a single event or an array of
-     * events, encoded in the Cloud Events 1.0 Schema.
-     */
-    deserializeCloudEvents(encodedEvents: string): Promise<CloudEvent<unknown>[]>;
-    /**
-     * Deserializes events encoded in the Cloud Events 1.0 schema.
-     *
-     * @param encodedEvents - an object representing a single event, encoded in the Cloud Events 1.0 schema.
-     */
-    deserializeCloudEvents(encodedEvents: Record<string, unknown>): Promise<CloudEvent<unknown>[]>;
-}
-
-/**
- * Event Grid Namespaces Client
- */
-export declare class EventGridReceiverClient {
-    private _client;
-    private _topicName;
-    private _subscriptionName;
-    /** Azure Messaging EventGrid Client */
-    constructor(endpoint: string, credential: AzureKeyCredential | TokenCredential, topicName: string, subscriptionName: string, options?: EventGridReceiverClientOptions);
-    /**
-     * Receive Batch of Cloud Events from the Event Subscription.
-     *
-     * @param options - Options to receive
-     *
-     */
-    receiveEvents<T>(options?: ReceiveEventsOptions): Promise<ReceiveResult<T>>;
-    /**
-     * Acknowledge batch of Cloud Events. The server responds with an HTTP 200 status code if at least one
-     * event is successfully acknowledged. The response body will include the set of successfully acknowledged
-     * lockTokens, along with other failed lockTokens with their corresponding error information. Successfully
-     * acknowledged events will no longer be available to any consumer.
-     *
-     * @param lockTokens - Lock Tokens
-     * @param options - Options to Acknowledge
-     *
-     */
-    acknowledgeEvents(lockTokens: string[], options?: AcknowledgeEventsOptions): Promise<AcknowledgeResult>;
-    /**
-     * Release batch of Cloud Events. The server responds with an HTTP 200 status code if at least one event is
-     * successfully released. The response body will include the set of successfully released lockTokens, along
-     * with other failed lockTokens with their corresponding error information.
-     *
-     * @param lockTokens - Lock Tokens
-     * @param options - Options to release
-     *
-     */
-    releaseEvents(lockTokens: string[], options?: ReleaseEventsOptions): Promise<ReleaseResult>;
-    /**
-     * Reject batch of Cloud Events.
-     *
-     * @param lockTokens - Lock Tokens
-     * @param options - Options to reject
-     *
-     */
-    rejectEvents(lockTokens: string[], options?: RejectEventsOptions): Promise<RejectResult>;
-    /**
-     * Renew lock for batch of Cloud Events.
-     *
-     * @param lockTokens - Lock Tokens
-     * @param options - Options to renew
-     */
-    renewEventLocks(lockTokens: string[], options?: RenewEventLocksOptions): Promise<RenewLocksResult>;
-}
-
-/** Event Grid Receiver Client Options */
-export declare interface EventGridReceiverClientOptions extends EventGridClientOptions {
-}
-
-/**
- * Event Grid Namespaces Client
- */
-export declare class EventGridSenderClient {
-    private _client;
-    private _topicName;
-    /** Azure Messaging EventGrid Client */
-    constructor(endpoint: string, credential: AzureKeyCredential | TokenCredential, topicName: string, options?: EventGridSenderClientOptions);
-    /**
-     * Publish Cloud Events to namespace topic. In case of success, the server responds with an HTTP 200
-     * status code with an empty JSON object in response. Otherwise, the server can return various error codes.
-     * For example, 401: which indicates authorization failure, 403: which indicates quota exceeded or message
-     * is too large, 410: which indicates that specific topic is not found, 400: for bad request, and 500: for
-     * internal server error.
-     *
-     * @param events - Events to publish
-     * @param options - Options to publish
-     *
-     */
-    sendEvents<T>(events: CloudEvent<T>[] | CloudEvent<T>, options?: SendEventsOptions): Promise<void>;
-}
-
-/** Event Grid Sender Client Options */
-export declare interface EventGridSenderClientOptions extends EventGridClientOptions {
-}
-
-/** Failed LockToken information. */
-export declare interface FailedLockToken {
-    /** The lock token of an entry in the request. */
-    lockToken: string;
-    /** Error information of the failed operation result for the lock token in the request. */
-    error: ErrorModel;
-}
-
-/** Known values of {@link ReleaseDelay} that the service accepts. */
-export declare enum KnownReleaseDelay {
-    /** Ten Minutes */
-    TenMinutes = "600",
-    /** One Minute */
-    OneMinute = "60",
-    /** Ten Seconds */
-    TenSeconds = "10",
-    /** One Hour */
-    OneHour = "3600",
-    /** No Delay */
-    NoDelay = "0"
-}
-
-export { OperationOptions }
-
-/** Receive operation details per Cloud Event. */
-export declare interface ReceiveDetails<T> {
-    /** The Event Broker details. */
-    brokerProperties: BrokerProperties;
-    /** Cloud Event details. */
-    event: CloudEvent<T>;
-}
-
-export declare interface ReceiveEventsOptionalParams extends OperationOptions {
-    /** Max Events count to be received. Minimum value is 1, while maximum value is 100 events. If not specified, the default value is 1. */
-    maxEvents?: number;
-    /** Max wait time value for receive operation in Seconds. It is the time in seconds that the server approximately waits for the availability of an event and responds to the request. If an event is available, the broker responds immediately to the client. Minimum value is 10 seconds, while maximum value is 120 seconds. If not specified, the default value is 60 seconds. */
-    maxWaitTime?: number;
-}
-
-/** Receive Events Options */
-export declare interface ReceiveEventsOptions extends ReceiveEventsOptionalParams {
-}
-
-/** Details of the Receive operation response. */
-export declare interface ReceiveResult<T> {
-    /** Array of receive responses, one per cloud event. */
-    details: ReceiveDetails<T>[];
-}
-
-export declare interface RejectEventsOptionalParams extends OperationOptions {
-}
-
-/** Reject Events Options */
-export declare interface RejectEventsOptions extends RejectEventsOptionalParams {
-}
-
-/** The result of the Reject operation. */
-export declare interface RejectResult {
-    /** Array of FailedLockToken for failed cloud events. Each FailedLockToken includes the lock token along with the related error information (namely, the error code and description). */
-    failedLockTokens: FailedLockToken[];
-    /** Array of lock tokens for the successfully rejected cloud events. */
-    succeededLockTokens: string[];
-}
-
-/** Supported delays for release operation. */
-/** "0", "10", "60", "600", "3600" */
-export declare type ReleaseDelay = string;
-
-/** Release Events Options */
-export declare interface ReleaseEventsOptions extends OperationOptions {
-    /** Release events with the specified delay in seconds. */
-    releaseDelay?: ReleaseDelay;
-}
-
-/** The result of the Release operation. */
-export declare interface ReleaseResult {
-    /** Array of FailedLockToken for failed cloud events. Each FailedLockToken includes the lock token along with the related error information (namely, the error code and description). */
-    failedLockTokens: FailedLockToken[];
-    /** Array of lock tokens for the successfully released cloud events. */
-    succeededLockTokens: string[];
-}
-
-export declare interface RenewEventLocksOptionalParams extends OperationOptions {
-}
-
-/** Renew Event Locks Options */
-export declare interface RenewEventLocksOptions extends RenewEventLocksOptionalParams {
-}
-
-/** The result of the RenewLock operation. */
-export declare interface RenewLocksResult {
-    /** Array of FailedLockToken for failed cloud events. Each FailedLockToken includes the lock token along with the related error information (namely, the error code and description). */
-    failedLockTokens: FailedLockToken[];
-    /** Array of lock tokens for the successfully renewed locks. */
-    succeededLockTokens: string[];
-}
-
-export declare interface SendEventOptionalParams extends OperationOptions {
-    /** content type */
-    contentType?: string;
-}
-
-export declare interface SendEventsOptionalParams extends OperationOptions {
-    /** content type */
-    contentType?: string;
-}
-
-/** Send Events Options */
-export declare interface SendEventsOptions extends SendEventOptionalParams {
-}
-
-export { }