@azure/digital-twins-core 2.0.0-alpha.20241203.1 → 2.0.0-alpha.20241205.2

package/{types/digital-twins-core.d.ts → dist/browser/digitalTwinsClient.d.ts}

@@ -1,546 +1,270 @@
-import type { CommonClientOptions } from '@azure/core-client';
-import * as coreClient from '@azure/core-client';
-import type { OperationOptions } from '@azure/core-client';
-import type { PagedAsyncIterableIterator } from '@azure/core-paging';
-import type { TokenCredential } from '@azure/core-auth';
-
-/** Contains response data for the add operation. */
-export declare type DigitalTwinModelsAddResponse = DigitalTwinsModelData[];
-
-/** Contains response data for the getById operation. */
-export declare type DigitalTwinModelsGetByIdResponse = DigitalTwinsModelData;
-
-/** Contains response data for the list operation. */
-export declare type DigitalTwinModelsListResponse = PagedDigitalTwinsModelDataCollection;
-
-/** Defines headers for DigitalTwins_add operation. */
-export declare interface DigitalTwinsAddHeaders {
-    /** Weak Etag. */
-    etag?: string;
-}
-
-/** Optional parameters. */
-export declare interface DigitalTwinsAddOptionalParams extends coreClient.OperationOptions {
-    /** Only perform the operation if the entity does not already exist. */
-    ifNoneMatch?: string;
-}
-
-/** Defines headers for DigitalTwins_addRelationship operation. */
-export declare interface DigitalTwinsAddRelationshipHeaders {
-    /** Weak Etag. */
-    etag?: string;
-}
-
-/** Optional parameters. */
-export declare interface DigitalTwinsAddRelationshipOptionalParams extends coreClient.OperationOptions {
-    /** Only perform the operation if the entity does not already exist. */
-    ifNoneMatch?: string;
-}
-
-/** Contains response data for the addRelationship operation. */
-export declare type DigitalTwinsAddRelationshipResponse = DigitalTwinsAddRelationshipHeaders & Record<string, unknown>;
-
-/** Contains response data for the add operation. */
-export declare type DigitalTwinsAddResponse = DigitalTwinsAddHeaders & Record<string, unknown>;
-
-/**
- * Client for Azure IoT DigitalTwins API.
- */
-export declare class DigitalTwinsClient {
-    /**
-     * A reference to the auto-generated AzureDigitalTwinsAPI
-     */
-    private readonly client;
-    /**
-     * Creates an instance of AzureDigitalTwinsAPI.
-     *
-     * Example usage:
-     * ```ts
-     * const { DigitalTwinsClient, ServiceClientCredentials } = require("@azure/digital-twins-core");
-     *
-     * const client = new DigitalTwinsClient(
-     *   "<endpoint>",
-     *   new DefaultAzureCredential();
-     * );
-     * ```
-     * @param endpointUrl - The endpoint URL of the service.
-     * @param credential - Used to authenticate requests to the service.
-     * @param options - Used to configure the service client.
-     */
-    constructor(endpointUrl: string, credential: TokenCredential, options?: DigitalTwinsClientOptions);
-    /**
-     * Get a digital twin
-     *
-     * @param digitalTwinId - The Id of the digital twin.
-     * @param options - The operation options
-     * @returns The application/json digital twin.
-     */
-    getDigitalTwin(digitalTwinId: string, options?: OperationOptions): Promise<DigitalTwinsGetByIdResponse>;
-    /**
-     * Create or update a digital twin
-     *
-     * @param digitalTwinId - The Id of the digital twin to create or update.
-     * @param digitalTwinJson - The application/json digital twin to create.
-     * @param options - Extended operation options including
-     *  ifNoneMatch: Only perform the operation if the entity does not already exist.
-     * @returns The created application/json digital twin.
-     */
-    upsertDigitalTwin(digitalTwinId: string, digitalTwinJson: string, options?: DigitalTwinsAddOptionalParams): Promise<DigitalTwinsAddResponse>;
-    /**
-     * Update a digital twin using a json patch.
-     *
-     * @param digitalTwinId - The Id of the digital twin.
-     * @param jsonPatch - An update specification described by JSON Patch. Updates to property values
-     * and $model elements may happen in the same request. Operations are limited to add, replace and
-     * remove.
-     * @param options - Extended operation options including
-     *   ifMatch: Only perform the operation if the entity's etag matches one of the etags provided or * is provided.
-
-     */
-    updateDigitalTwin(digitalTwinId: string, jsonPatch: Array<Record<string, unknown>>, options?: DigitalTwinsUpdateOptionalParams): Promise<DigitalTwinsUpdateResponse>;
-    /**
-     * Delete a digital twin
-     *
-     * @param digitalTwinId - The Id of the digital twin to delete.
-     * @param options - Extended operation options including
-     *   ifMatch: Only perform the operation if the entity's etag matches one of the etags provided or * is provided.
-
-     */
-    deleteDigitalTwin(digitalTwinId: string, options?: DigitalTwinsDeleteOptionalParams): Promise<void>;
-    /**
-     * Get a component on a digital twin.
-     *
-     * @param digitalTwinId - The Id of the digital twin.
-     * @param componentName - The component being retrieved.
-     * @param options - The operation options
-     * @returns Json string representation of the component corresponding to the provided componentName.
-     */
-    getComponent(digitalTwinId: string, componentName: string, options?: OperationOptions): Promise<DigitalTwinsGetComponentResponse>;
-    /**
-     * Update properties of a component on a digital twin using a JSON patch.
-     *
-     * @param digitalTwinId - The Id of the digital twin.
-     * @param componentName - The component being updated.
-     * @param jsonPatch - The application/json-patch+json operations to be performed on the specified digital twin's component.
-     * @param enableUpdate - If true then update of an existing digital twin is enabled.
-     * @param options - Extended operation options including
-     *   ifMatch: Only perform the operation if the entity's etag matches one of the etags provided or * is provided.
-
-     */
-    updateComponent(digitalTwinId: string, componentName: string, jsonPatch: Array<Record<string, unknown>>, options?: DigitalTwinsUpdateComponentOptionalParams): Promise<DigitalTwinsUpdateComponentResponse>;
-    /**
-     * Get a relationship on a digital twin.
-     *
-     * @param digitalTwinId - The Id of the source digital twin.
-     * @param relationshipId - The Id of the relationship to retrieve.
-     * @param options - The operation options
-     * @returns The pageable list of application/json relationships belonging to the specified digital twin.
-     */
-    getRelationship(digitalTwinId: string, relationshipId: string, options?: OperationOptions): Promise<DigitalTwinsGetRelationshipByIdResponse>;
-    /**
-     * Create or update a relationship on a digital twin.
-     *
-     * @param digitalTwinId - The Id of the source digital twin.
-     * @param relationshipId - The Id of the relationship to create.
-     * @param relationship - The application/json relationship to be created.
-     * @param options - Extended operation options including
-     *  ifNoneMatch: Only perform the operation if the entity does not already exist.
-     */
-    upsertRelationship(digitalTwinId: string, relationshipId: string, relationship: Record<string, unknown>, options?: DigitalTwinsAddRelationshipOptionalParams): Promise<DigitalTwinsAddRelationshipResponse>;
-    /**
-     * Updates the properties of a relationship on a digital twin using a JSON patch.
-     *
-     * @param digitalTwinId - The Id of the digital twin to delete.
-     * @param relationshipId - The Id of the relationship to be updated.
-     * @param jsonPatch - The application/json-patch+json operations to be performed on the specified digital twin's relationship.
-     * @param options - Extended operation options
-     *   ifMatch: Only perform the operation if the entity's etag matches one of the etags provided or * is provided.
-     */
-    updateRelationship(digitalTwinId: string, relationshipId: string, jsonPatch: Array<Record<string, unknown>>, options?: DigitalTwinsUpdateRelationshipOptionalParams): Promise<DigitalTwinsUpdateRelationshipResponse>;
-    /**
-     * Delete a relationship on a digital twin.
-     *
-     * @param digitalTwinId - The Id of the source digital twin.
-     * @param relationshipId - The Id of the relationship to delete.
-     * @param options - The operation options
-     *   ifMatch: Only perform the operation if the entity's etag matches one of the etags provided or * is
-
-     */
-    deleteRelationship(digitalTwinId: string, relationshipId: string, options?: DigitalTwinsDeleteRelationshipOptionalParams): Promise<void>;
-    /**
-     * Retrieve relationships for a digital twin.
-     *
-     * @param digitalTwinId - The Id of the digital twin.
-     */
-    listRelationships(digitalTwinId: string, options?: ListRelationshipsOptions): PagedAsyncIterableIterator<Record<string, unknown>>;
-    /**
-     * Retrieve all incoming relationships for a digital twin.
-     *
-     * @param digitalTwinId - The Id of the digital twin.
-     */
-    listIncomingRelationships(digitalTwinId: string, options?: ListIncomingRelationshipsOptions): PagedAsyncIterableIterator<IncomingRelationship>;
-    /**
-     * Publish telemetry from a digital twin, which is then consumed by one or many destination endpoints (subscribers) defined under.
-     *
-     * @param digitalTwinId - The Id of the digital twin to delete.
-     * @param payload - The application/json telemetry payload to be sent.
-     * @param messageId - The message Id.
-     * @param options - The operation options
-
-     */
-    publishTelemetry(digitalTwinId: string, payload: Record<string, unknown>, messageId: string, options?: OperationOptions): Promise<void>;
-    /**
-     * Publish telemetry from a digital twin's component, which is then consumed by one or many destination endpoints (subscribers) defined under.
-     *
-     * @param digitalTwinId - The Id of the digital twin to delete.
-     * @param componentName - The name of the DTDL component.
-     * @param payload - The application/json telemetry payload to be sent.
-     * @param messageId - The message Id.
-     * @param options - The operation options
-
-     */
-    publishComponentTelemetry(digitalTwinId: string, componentName: string, payload: Record<string, unknown>, messageId: string, options?: OperationOptions): Promise<void>;
-    /**
-     * Get a model, including the model metadata and the model definition.
-     *
-     * @param modelId - The Id of the model.
-     * @param options - Options for this operation
-     * @returns The application/json model.
-     */
-    getModel(modelId: string, options?: GetModelOptions): Promise<DigitalTwinModelsGetByIdResponse>;
-    /**
-     * Get the list of models
-     *
-     * @param options - Options for listing models.
-     * @returns A pageable set of application/json models.
-     */
-    listModels(options?: ListModelsOptions): PagedAsyncIterableIterator<DigitalTwinsModelData>;
-    /**
-     * Create one or many
-     *
-     * @param dtdlModels - The set of models to create. Each string corresponds to exactly one model.
-     * @param options - The operation options
-     * @returns The created application/json models.
-     */
-    createModels(dtdlModels: Array<Record<string, unknown>>, options?: OperationOptions): Promise<DigitalTwinModelsAddResponse>;
-    /**
-     * Decommission a model using a json patch.
-     * When a model is decommissioned, new digital twins will no longer be able to be
-     * defined by this model. However, existing digital twins may continue to use this model.
-     * Once a model is decommissioned, it may not be recommissioned.
-     *
-     * @param modelId - The Id of the model to decommission.
-     * property can be replaced.
-     * @param options - The operation options
-
-     *
-     */
-    decomissionModel(modelId: string, options?: OperationOptions): Promise<void>;
-    /**
-     * Delete a model.
-     *
-     * @param modelId - The Id of the model to delete.
-     * @param options - The operation options
-
-     */
-    deleteModel(modelId: string, options?: OperationOptions): Promise<void>;
-    /**
-     * Get an event route.
-     *
-     * @param modelId - The Id of the event route.
-     * @param options - The operation options
-     * @returns The application/json event route.
-     */
-    getEventRoute(eventRouteId: string, options?: OperationOptions): Promise<EventRoutesGetByIdResponse>;
-    /**
-     * List the event routes in a digital twins instance.
-     *
-     * @param options - Options for listEventRoutes.
-     * @returns The application/json event route.
-     */
-    listEventRoutes(options?: ListEventRoutesOptions): PagedAsyncIterableIterator<EventRoute>;
-    /**
-     * Create or update an event route.
-     *
-     * @param eventRouteId - The Id of the event route to create or update.
-     * @param endpointId - The id of the endpoint this event route is bound to.
-     * @param filter - An expression which describes the events which are routed to the endpoint.
-     * @param options - The operation options
-
-     */
-    upsertEventRoute(eventRouteId: string, endpointId: string, filter: string, options?: OperationOptions): Promise<void>;
-    /**
-     * Delete an event route.
-     *
-     * @param eventRouteId - The Id of the eventRoute to delete.
-     * @param options - The operation options
-
-     */
-    deleteEventRoute(eventRouteId: string, options?: OperationOptions): Promise<void>;
-    /**
-     * Deals with the pagination of {@link query}.
-     *
-     * @param query - The query string, in SQL-like syntax.
-     * @param options - Common options for the iterative endpoints.
-     * @param continuationState - An object that indicates the position of the paginated request.
-     *
-     */
-    private queryTwinsPage;
-    /**
-     * Deals with the iteration of all the available results of {@link query}.
-     * @param query - The query string, in SQL-like syntax.
-     * @param options - Common options for the iterative endpoints.
-     */
-    private queryTwinsAll;
-    /**
-     * Query for digital twins.
-     *
-     * @param query - The query string, in SQL-like syntax.
-     * @param options - Options for the query operation.
-     * @returns The pageable list of query results.
-     */
-    queryTwins(query: string, options?: QueryTwinsOptions): PagedAsyncIterableIterator<Record<string, unknown>, QueryQueryTwinsResponse>;
-}
-
-/**
- * Options for the DigitalTwinsClient class
- */
-export declare interface DigitalTwinsClientOptions extends CommonClientOptions {
-}
-
-/** Optional parameters. */
-export declare interface DigitalTwinsDeleteOptionalParams extends coreClient.OperationOptions {
-    /** Only perform the operation if the entity's etag matches one of the etags provided or * is provided. */
-    ifMatch?: string;
-}
-
-/** Optional parameters. */
-export declare interface DigitalTwinsDeleteRelationshipOptionalParams extends coreClient.OperationOptions {
-    /** Only perform the operation if the entity's etag matches one of the etags provided or * is provided. */
-    ifMatch?: string;
-}
-
-/** Defines headers for DigitalTwins_getById operation. */
-export declare interface DigitalTwinsGetByIdHeaders {
-    /** Weak Etag. */
-    etag?: string;
-}
-
-/** Contains response data for the getById operation. */
-export declare type DigitalTwinsGetByIdResponse = DigitalTwinsGetByIdHeaders & Record<string, unknown>;
-
-/** Defines headers for DigitalTwins_getComponent operation. */
-export declare interface DigitalTwinsGetComponentHeaders {
-    /** Weak Etag. */
-    etag?: string;
-}
-
-/** Contains response data for the getComponent operation. */
-export declare type DigitalTwinsGetComponentResponse = DigitalTwinsGetComponentHeaders & Record<string, unknown>;
-
-/** Defines headers for DigitalTwins_getRelationshipById operation. */
-export declare interface DigitalTwinsGetRelationshipByIdHeaders {
-    /** Weak Etag. */
-    etag?: string;
-}
-
-/** Contains response data for the getRelationshipById operation. */
-export declare type DigitalTwinsGetRelationshipByIdResponse = DigitalTwinsGetRelationshipByIdHeaders & Record<string, unknown>;
-
-/** Contains response data for the listIncomingRelationships operation. */
-export declare type DigitalTwinsListIncomingRelationshipsResponse = IncomingRelationshipCollection;
-
-/** Contains response data for the listRelationships operation. */
-export declare type DigitalTwinsListRelationshipsResponse = RelationshipCollection;
-
-/** A model definition and metadata for that model. */
-export declare interface DigitalTwinsModelData {
-    /** A language map that contains the localized display names as specified in the model definition. */
-    displayName?: {
-        [propertyName: string]: string;
-    };
-    /** A language map that contains the localized descriptions as specified in the model definition. */
-    description?: {
-        [propertyName: string]: string;
-    };
-    /** The id of the model as specified in the model definition. */
-    id: string;
-    /** The time the model was uploaded to the service. */
-    uploadTime?: Date;
-    /** Indicates if the model is decommissioned. Decommissioned models cannot be referenced by newly created digital twins. */
-    decommissioned?: boolean;
-    /** The model definition. */
-    model?: Record<string, unknown>;
-}
-
-/** Defines headers for DigitalTwins_updateComponent operation. */
-export declare interface DigitalTwinsUpdateComponentHeaders {
-    /** Weak Etag. */
-    etag?: string;
-}
-
-/** Optional parameters. */
-export declare interface DigitalTwinsUpdateComponentOptionalParams extends coreClient.OperationOptions {
-    /** Only perform the operation if the entity's etag matches one of the etags provided or * is provided. */
-    ifMatch?: string;
-}
-
-/** Contains response data for the updateComponent operation. */
-export declare type DigitalTwinsUpdateComponentResponse = DigitalTwinsUpdateComponentHeaders;
-
-/** Defines headers for DigitalTwins_update operation. */
-export declare interface DigitalTwinsUpdateHeaders {
-    /** Weak Etag. */
-    etag?: string;
-}
-
-/** Optional parameters. */
-export declare interface DigitalTwinsUpdateOptionalParams extends coreClient.OperationOptions {
-    /** Only perform the operation if the entity's etag matches one of the etags provided or * is provided. */
-    ifMatch?: string;
-}
-
-/** Defines headers for DigitalTwins_updateRelationship operation. */
-export declare interface DigitalTwinsUpdateRelationshipHeaders {
-    /** Weak Etag. */
-    etag?: string;
-}
-
-/** Optional parameters. */
-export declare interface DigitalTwinsUpdateRelationshipOptionalParams extends coreClient.OperationOptions {
-    /** Only perform the operation if the entity's etag matches one of the etags provided or * is provided. */
-    ifMatch?: string;
-}
-
-/** Contains response data for the updateRelationship operation. */
-export declare type DigitalTwinsUpdateRelationshipResponse = DigitalTwinsUpdateRelationshipHeaders;
-
-/** Contains response data for the update operation. */
-export declare type DigitalTwinsUpdateResponse = DigitalTwinsUpdateHeaders;
-
-/** A route which directs notification and telemetry events to an endpoint. Endpoints are a destination outside of Azure Digital Twins such as an EventHub. */
-export declare interface EventRoute {
-    /**
-     * The id of the event route.
-     * NOTE: This property will not be serialized. It can only be populated by the server.
-     */
-    readonly id?: string;
-    /** The name of the endpoint this event route is bound to. */
-    endpointName: string;
-    /** An expression which describes the events which are routed to the endpoint. */
-    filter: string;
-}
-
-/** A collection of EventRoute objects. */
-export declare interface EventRouteCollection {
-    /** The EventRoute objects. */
-    value?: EventRoute[];
-    /** A URI to retrieve the next page of results. */
-    nextLink?: string;
-}
-
-/** Contains response data for the getById operation. */
-export declare type EventRoutesGetByIdResponse = EventRoute;
-
-/** Contains response data for the listNext operation. */
-export declare type EventRoutesListNextResponse = EventRouteCollection;
-
-/** Optional parameters. */
-export declare interface GetModelOptions extends coreClient.OperationOptions {
-    /** When true the model definition will be returned as part of the result. */
-    includeModelDefinition?: boolean;
-}
-
-/** An incoming relationship. */
-export declare interface IncomingRelationship {
-    /** A user-provided string representing the id of this relationship, unique in the context of the source digital twin, i.e. sourceId + relationshipId is unique in the context of the service. */
-    relationshipId?: string;
-    /** The id of the source digital twin. */
-    sourceId?: string;
-    /** The name of the relationship. */
-    relationshipName?: string;
-    /** Link to the relationship, to be used for deletion. */
-    relationshipLink?: string;
-}
-
-/** A collection of incoming relationships which relate digital twins together. */
-export declare interface IncomingRelationshipCollection {
-    value?: IncomingRelationship[];
-    /** A URI to retrieve the next page of objects. */
-    nextLink?: string;
-}
-
-/** Optional parameters. */
-export declare interface ListEventRoutesOptions extends coreClient.OperationOptions {
-    /** The maximum number of items to retrieve per request. The server may choose to return less than the requested number. */
-    resultsPerPage?: number;
-}
-
-/** Optional parameters. */
-export declare interface ListIncomingRelationshipsOptions extends coreClient.OperationOptions {
-}
-
-/** Optional parameters. */
-export declare interface ListModelsOptions extends coreClient.OperationOptions {
-    /** The set of the models which will have their dependencies retrieved. If omitted, all models are retrieved. */
-    dependenciesFor?: string[];
-    /** When true the model definition will be returned as part of the result. */
-    includeModelDefinition?: boolean;
-    /** The maximum number of items to retrieve per request. The server may choose to return less than the requested number. */
-    resultsPerPage?: number;
-}
-
-/** Optional parameters. */
-export declare interface ListRelationshipsOptions extends coreClient.OperationOptions {
-    /** The name of the relationship. */
-    relationshipName?: string;
-}
-
-/** A collection of DigitalTwinsModelData objects. */
-export declare interface PagedDigitalTwinsModelDataCollection {
-    /** The DigitalTwinsModelData objects. */
-    value?: DigitalTwinsModelData[];
-    /** A URI to retrieve the next page of objects. */
-    nextLink?: string;
-}
-
-/** Defines headers for Query_queryTwins operation. */
-export declare interface QueryQueryTwinsHeaders {
-    /** The query charge. */
-    queryCharge?: number;
-}
-
-/** Contains response data for the queryTwins operation. */
-export declare type QueryQueryTwinsResponse = QueryQueryTwinsHeaders & QueryResult;
-
-/** The results of a query operation and an optional continuation token. */
-export declare interface QueryResult {
-    /** The query results. */
-    value?: Record<string, unknown>[];
-    /** A token which can be used to construct a new QuerySpecification to retrieve the next set of results. */
-    continuationToken?: string;
-}
-
-/** A query specification containing either a query statement or a continuation token from a previous query result. */
-export declare interface QuerySpecification {
-    /** The query to execute. This value is ignored if a continuation token is provided. */
-    query?: string;
-    /** A token which is used to retrieve the next set of results from a previous query. */
-    continuationToken?: string;
-}
-
-/** Optional parameters. */
-export declare interface QueryTwinsOptions extends coreClient.OperationOptions {
-    /** The maximum number of items to retrieve per request. The server may choose to return less than the requested number. */
-    resultsPerPage?: number;
-}
-
-/** A collection of relationships which relate digital twins together. */
-export declare interface RelationshipCollection {
-    /** The relationship objects. */
-    value?: Record<string, unknown>[];
-    /** A URI to retrieve the next page of objects. */
-    nextLink?: string;
-}
-
-export { }
+import type { OperationOptions, CommonClientOptions } from "@azure/core-client";
+import type { TokenCredential } from "@azure/core-auth";
+import type { PagedAsyncIterableIterator } from "@azure/core-paging";
+import type { DigitalTwinsGetByIdResponse, DigitalTwinsAddOptionalParams, DigitalTwinsAddResponse, DigitalTwinsUpdateOptionalParams, DigitalTwinsUpdateResponse, DigitalTwinsDeleteOptionalParams, DigitalTwinsGetComponentResponse, DigitalTwinsUpdateComponentResponse, DigitalTwinsUpdateComponentOptionalParams, DigitalTwinsAddRelationshipResponse, DigitalTwinsAddRelationshipOptionalParams, DigitalTwinsUpdateRelationshipOptionalParams, DigitalTwinsUpdateRelationshipResponse, DigitalTwinsDeleteRelationshipOptionalParams, IncomingRelationship, DigitalTwinsGetRelationshipByIdResponse, DigitalTwinsModelData, DigitalTwinModelsGetByIdResponse, DigitalTwinModelsAddResponse, EventRoutesGetByIdResponse, EventRoute, QueryQueryTwinsResponse } from "./generated/models/index.js";
+import { DigitalTwinModelsGetByIdOptionalParams as GetModelOptions, DigitalTwinModelsListOptionalParams as ListModelsOptions, QueryQueryTwinsOptionalParams as QueryTwinsOptions, EventRoutesListOptionalParams as ListEventRoutesOptions, DigitalTwinsListRelationshipsOptionalParams as ListRelationshipsOptions, DigitalTwinsListIncomingRelationshipsOptionalParams as ListIncomingRelationshipsOptions } from "./generated/models/index.js";
+export { GetModelOptions, ListModelsOptions, QueryTwinsOptions, ListEventRoutesOptions, ListIncomingRelationshipsOptions, ListRelationshipsOptions, };
+/**
+ * Options for the DigitalTwinsClient class
+ */
+export interface DigitalTwinsClientOptions extends CommonClientOptions {
+}
+/**
+ * Client for Azure IoT DigitalTwins API.
+ */
+export declare class DigitalTwinsClient {
+    /**
+     * A reference to the auto-generated AzureDigitalTwinsAPI
+     */
+    private readonly client;
+    /**
+     * Creates an instance of AzureDigitalTwinsAPI.
+     *
+     * Example usage:
+     * ```ts
+     * const { DigitalTwinsClient, ServiceClientCredentials } = require("@azure/digital-twins-core");
+     *
+     * const client = new DigitalTwinsClient(
+     *   "<endpoint>",
+     *   new DefaultAzureCredential();
+     * );
+     * ```
+     * @param endpointUrl - The endpoint URL of the service.
+     * @param credential - Used to authenticate requests to the service.
+     * @param options - Used to configure the service client.
+     */
+    constructor(endpointUrl: string, credential: TokenCredential, options?: DigitalTwinsClientOptions);
+    /**
+     * Get a digital twin
+     *
+     * @param digitalTwinId - The Id of the digital twin.
+     * @param options - The operation options
+     * @returns The application/json digital twin.
+     */
+    getDigitalTwin(digitalTwinId: string, options?: OperationOptions): Promise<DigitalTwinsGetByIdResponse>;
+    /**
+     * Create or update a digital twin
+     *
+     * @param digitalTwinId - The Id of the digital twin to create or update.
+     * @param digitalTwinJson - The application/json digital twin to create.
+     * @param options - Extended operation options including
+     *  ifNoneMatch: Only perform the operation if the entity does not already exist.
+     * @returns The created application/json digital twin.
+     */
+    upsertDigitalTwin(digitalTwinId: string, digitalTwinJson: string, options?: DigitalTwinsAddOptionalParams): Promise<DigitalTwinsAddResponse>;
+    /**
+     * Update a digital twin using a json patch.
+     *
+     * @param digitalTwinId - The Id of the digital twin.
+     * @param jsonPatch - An update specification described by JSON Patch. Updates to property values
+     * and $model elements may happen in the same request. Operations are limited to add, replace and
+     * remove.
+     * @param options - Extended operation options including
+     *   ifMatch: Only perform the operation if the entity's etag matches one of the etags provided or * is provided.
+  
+     */
+    updateDigitalTwin(digitalTwinId: string, jsonPatch: Array<Record<string, unknown>>, options?: DigitalTwinsUpdateOptionalParams): Promise<DigitalTwinsUpdateResponse>;
+    /**
+     * Delete a digital twin
+     *
+     * @param digitalTwinId - The Id of the digital twin to delete.
+     * @param options - Extended operation options including
+     *   ifMatch: Only perform the operation if the entity's etag matches one of the etags provided or * is provided.
+  
+     */
+    deleteDigitalTwin(digitalTwinId: string, options?: DigitalTwinsDeleteOptionalParams): Promise<void>;
+    /**
+     * Get a component on a digital twin.
+     *
+     * @param digitalTwinId - The Id of the digital twin.
+     * @param componentName - The component being retrieved.
+     * @param options - The operation options
+     * @returns Json string representation of the component corresponding to the provided componentName.
+     */
+    getComponent(digitalTwinId: string, componentName: string, options?: OperationOptions): Promise<DigitalTwinsGetComponentResponse>;
+    /**
+     * Update properties of a component on a digital twin using a JSON patch.
+     *
+     * @param digitalTwinId - The Id of the digital twin.
+     * @param componentName - The component being updated.
+     * @param jsonPatch - The application/json-patch+json operations to be performed on the specified digital twin's component.
+     * @param enableUpdate - If true then update of an existing digital twin is enabled.
+     * @param options - Extended operation options including
+     *   ifMatch: Only perform the operation if the entity's etag matches one of the etags provided or * is provided.
+  
+     */
+    updateComponent(digitalTwinId: string, componentName: string, jsonPatch: Array<Record<string, unknown>>, options?: DigitalTwinsUpdateComponentOptionalParams): Promise<DigitalTwinsUpdateComponentResponse>;
+    /**
+     * Get a relationship on a digital twin.
+     *
+     * @param digitalTwinId - The Id of the source digital twin.
+     * @param relationshipId - The Id of the relationship to retrieve.
+     * @param options - The operation options
+     * @returns The pageable list of application/json relationships belonging to the specified digital twin.
+     */
+    getRelationship(digitalTwinId: string, relationshipId: string, options?: OperationOptions): Promise<DigitalTwinsGetRelationshipByIdResponse>;
+    /**
+     * Create or update a relationship on a digital twin.
+     *
+     * @param digitalTwinId - The Id of the source digital twin.
+     * @param relationshipId - The Id of the relationship to create.
+     * @param relationship - The application/json relationship to be created.
+     * @param options - Extended operation options including
+     *  ifNoneMatch: Only perform the operation if the entity does not already exist.
+     */
+    upsertRelationship(digitalTwinId: string, relationshipId: string, relationship: Record<string, unknown>, options?: DigitalTwinsAddRelationshipOptionalParams): Promise<DigitalTwinsAddRelationshipResponse>;
+    /**
+     * Updates the properties of a relationship on a digital twin using a JSON patch.
+     *
+     * @param digitalTwinId - The Id of the digital twin to delete.
+     * @param relationshipId - The Id of the relationship to be updated.
+     * @param jsonPatch - The application/json-patch+json operations to be performed on the specified digital twin's relationship.
+     * @param options - Extended operation options
+     *   ifMatch: Only perform the operation if the entity's etag matches one of the etags provided or * is provided.
+     */
+    updateRelationship(digitalTwinId: string, relationshipId: string, jsonPatch: Array<Record<string, unknown>>, options?: DigitalTwinsUpdateRelationshipOptionalParams): Promise<DigitalTwinsUpdateRelationshipResponse>;
+    /**
+     * Delete a relationship on a digital twin.
+     *
+     * @param digitalTwinId - The Id of the source digital twin.
+     * @param relationshipId - The Id of the relationship to delete.
+     * @param options - The operation options
+     *   ifMatch: Only perform the operation if the entity's etag matches one of the etags provided or * is
+  
+     */
+    deleteRelationship(digitalTwinId: string, relationshipId: string, options?: DigitalTwinsDeleteRelationshipOptionalParams): Promise<void>;
+    /**
+     * Retrieve relationships for a digital twin.
+     *
+     * @param digitalTwinId - The Id of the digital twin.
+     */
+    listRelationships(digitalTwinId: string, options?: ListRelationshipsOptions): PagedAsyncIterableIterator<Record<string, unknown>>;
+    /**
+     * Retrieve all incoming relationships for a digital twin.
+     *
+     * @param digitalTwinId - The Id of the digital twin.
+     */
+    listIncomingRelationships(digitalTwinId: string, options?: ListIncomingRelationshipsOptions): PagedAsyncIterableIterator<IncomingRelationship>;
+    /**
+     * Publish telemetry from a digital twin, which is then consumed by one or many destination endpoints (subscribers) defined under.
+     *
+     * @param digitalTwinId - The Id of the digital twin to delete.
+     * @param payload - The application/json telemetry payload to be sent.
+     * @param messageId - The message Id.
+     * @param options - The operation options
+  
+     */
+    publishTelemetry(digitalTwinId: string, payload: Record<string, unknown>, messageId: string, options?: OperationOptions): Promise<void>;
+    /**
+     * Publish telemetry from a digital twin's component, which is then consumed by one or many destination endpoints (subscribers) defined under.
+     *
+     * @param digitalTwinId - The Id of the digital twin to delete.
+     * @param componentName - The name of the DTDL component.
+     * @param payload - The application/json telemetry payload to be sent.
+     * @param messageId - The message Id.
+     * @param options - The operation options
+  
+     */
+    publishComponentTelemetry(digitalTwinId: string, componentName: string, payload: Record<string, unknown>, messageId: string, options?: OperationOptions): Promise<void>;
+    /**
+     * Get a model, including the model metadata and the model definition.
+     *
+     * @param modelId - The Id of the model.
+     * @param options - Options for this operation
+     * @returns The application/json model.
+     */
+    getModel(modelId: string, options?: GetModelOptions): Promise<DigitalTwinModelsGetByIdResponse>;
+    /**
+     * Get the list of models
+     *
+     * @param options - Options for listing models.
+     * @returns A pageable set of application/json models.
+     */
+    listModels(options?: ListModelsOptions): PagedAsyncIterableIterator<DigitalTwinsModelData>;
+    /**
+     * Create one or many
+     *
+     * @param dtdlModels - The set of models to create. Each string corresponds to exactly one model.
+     * @param options - The operation options
+     * @returns The created application/json models.
+     */
+    createModels(dtdlModels: Array<Record<string, unknown>>, options?: OperationOptions): Promise<DigitalTwinModelsAddResponse>;
+    /**
+     * Decommission a model using a json patch.
+     * When a model is decommissioned, new digital twins will no longer be able to be
+     * defined by this model. However, existing digital twins may continue to use this model.
+     * Once a model is decommissioned, it may not be recommissioned.
+     *
+     * @param modelId - The Id of the model to decommission.
+     * property can be replaced.
+     * @param options - The operation options
+  
+     *
+     */
+    decomissionModel(modelId: string, options?: OperationOptions): Promise<void>;
+    /**
+     * Delete a model.
+     *
+     * @param modelId - The Id of the model to delete.
+     * @param options - The operation options
+  
+     */
+    deleteModel(modelId: string, options?: OperationOptions): Promise<void>;
+    /**
+     * Get an event route.
+     *
+     * @param modelId - The Id of the event route.
+     * @param options - The operation options
+     * @returns The application/json event route.
+     */
+    getEventRoute(eventRouteId: string, options?: OperationOptions): Promise<EventRoutesGetByIdResponse>;
+    /**
+     * List the event routes in a digital twins instance.
+     *
+     * @param options - Options for listEventRoutes.
+     * @returns The application/json event route.
+     */
+    listEventRoutes(options?: ListEventRoutesOptions): PagedAsyncIterableIterator<EventRoute>;
+    /**
+     * Create or update an event route.
+     *
+     * @param eventRouteId - The Id of the event route to create or update.
+     * @param endpointId - The id of the endpoint this event route is bound to.
+     * @param filter - An expression which describes the events which are routed to the endpoint.
+     * @param options - The operation options
+  
+     */
+    upsertEventRoute(eventRouteId: string, endpointId: string, filter: string, options?: OperationOptions): Promise<void>;
+    /**
+     * Delete an event route.
+     *
+     * @param eventRouteId - The Id of the eventRoute to delete.
+     * @param options - The operation options
+  
+     */
+    deleteEventRoute(eventRouteId: string, options?: OperationOptions): Promise<void>;
+    /**
+     * Deals with the pagination of {@link query}.
+     *
+     * @param query - The query string, in SQL-like syntax.
+     * @param options - Common options for the iterative endpoints.
+     * @param continuationState - An object that indicates the position of the paginated request.
+     *
+     */
+    private queryTwinsPage;
+    /**
+     * Deals with the iteration of all the available results of {@link query}.
+     * @param query - The query string, in SQL-like syntax.
+     * @param options - Common options for the iterative endpoints.
+     */
+    private queryTwinsAll;
+    /**
+     * Query for digital twins.
+     *
+     * @param query - The query string, in SQL-like syntax.
+     * @param options - Options for the query operation.
+     * @returns The pageable list of query results.
+     */
+    queryTwins(query: string, options?: QueryTwinsOptions): PagedAsyncIterableIterator<Record<string, unknown>, QueryQueryTwinsResponse>;
+}
+//# sourceMappingURL=digitalTwinsClient.d.ts.map