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

package/dist/react-native/constants.js.map

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

package/dist/react-native/digitalTwinsClient.d.ts

@@ -0,0 +1,270 @@
+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

package/dist/react-native/digitalTwinsClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"digitalTwinsClient.d.ts","sourceRoot":"","sources":["../../src/digitalTwinsClient.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EACV,gBAAgB,EAEhB,mBAAmB,EACpB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AACxD,OAAO,KAAK,EAAgB,0BAA0B,EAAE,MAAM,oBAAoB,CAAC;AAGnF,OAAO,KAAK,EACV,2BAA2B,EAC3B,6BAA6B,EAC7B,uBAAuB,EACvB,gCAAgC,EAChC,0BAA0B,EAC1B,gCAAgC,EAChC,gCAAgC,EAChC,mCAAmC,EACnC,yCAAyC,EACzC,mCAAmC,EACnC,yCAAyC,EACzC,4CAA4C,EAC5C,sCAAsC,EACtC,4CAA4C,EAC5C,oBAAoB,EACpB,uCAAuC,EACvC,qBAAqB,EACrB,gCAAgC,EAChC,4BAA4B,EAC5B,0BAA0B,EAC1B,UAAU,EACV,uBAAuB,EACxB,MAAM,6BAA6B,CAAC;AACrC,OAAO,EACL,sCAAsC,IAAI,eAAe,EACzD,mCAAmC,IAAI,iBAAiB,EACxD,6BAA6B,IAAI,iBAAiB,EAClD,6BAA6B,IAAI,sBAAsB,EACvD,2CAA2C,IAAI,wBAAwB,EACvE,mDAAmD,IAAI,gCAAgC,EACxF,MAAM,6BAA6B,CAAC;AAGrC,OAAO,EACL,eAAe,EACf,iBAAiB,EACjB,iBAAiB,EACjB,sBAAsB,EACtB,gCAAgC,EAChC,wBAAwB,GACzB,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,mBAAmB;CAAG;AAIzE;;GAEG;AACH,qBAAa,kBAAkB;IAC7B;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAkB;IAEzC;;;;;;;;;;;;;;;OAeG;gBAED,WAAW,EAAE,MAAM,EACnB,UAAU,EAAE,eAAe,EAC3B,OAAO,GAAE,yBAA8B;IAkBzC;;;;;;OAMG;IACI,cAAc,CACnB,aAAa,EAAE,MAAM,EACrB,OAAO,GAAE,gBAAqB,GAC7B,OAAO,CAAC,2BAA2B,CAAC;IAUvC;;;;;;;;OAQG;IACI,iBAAiB,CACtB,aAAa,EAAE,MAAM,EACrB,eAAe,EAAE,MAAM,EACvB,OAAO,GAAE,6BAAkC,GAC1C,OAAO,CAAC,uBAAuB,CAAC;IAWnC;;;;;;;;;;OAUG;IACI,iBAAiB,CACtB,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,EACzC,OAAO,GAAE,gCAAqC,GAC7C,OAAO,CAAC,0BAA0B,CAAC;IAUtC;;;;;;;OAOG;IACI,iBAAiB,CACtB,aAAa,EAAE,MAAM,EACrB,OAAO,GAAE,gCAAqC,GAC7C,OAAO,CAAC,IAAI,CAAC;IAUhB;;;;;;;OAOG;IACI,YAAY,CACjB,aAAa,EAAE,MAAM,EACrB,aAAa,EAAE,MAAM,EACrB,OAAO,GAAE,gBAAqB,GAC7B,OAAO,CAAC,gCAAgC,CAAC;IAU5C;;;;;;;;;;OAUG;IACI,eAAe,CACpB,aAAa,EAAE,MAAM,EACrB,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,EACzC,OAAO,GAAE,yCAA8C,GACtD,OAAO,CAAC,mCAAmC,CAAC;IAe/C;;;;;;;OAOG;IACI,eAAe,CACpB,aAAa,EAAE,MAAM,EACrB,cAAc,EAAE,MAAM,EACtB,OAAO,GAAE,gBAAqB,GAC7B,OAAO,CAAC,uCAAuC,CAAC;IAcnD;;;;;;;;OAQG;IACI,kBAAkB,CACvB,aAAa,EAAE,MAAM,EACrB,cAAc,EAAE,MAAM,EACtB,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACrC,OAAO,GAAE,yCAA8C,GACtD,OAAO,CAAC,mCAAmC,CAAC;IAe/C;;;;;;;;OAQG;IACI,kBAAkB,CACvB,aAAa,EAAE,MAAM,EACrB,cAAc,EAAE,MAAM,EACtB,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,EACzC,OAAO,GAAE,4CAAiD,GACzD,OAAO,CAAC,sCAAsC,CAAC;IAelD;;;;;;;;OAQG;IACI,kBAAkB,CACvB,aAAa,EAAE,MAAM,EACrB,cAAc,EAAE,MAAM,EACtB,OAAO,GAAE,4CAAiD,GACzD,OAAO,CAAC,IAAI,CAAC;IAchB;;;;OAIG;IACI,iBAAiB,CACtB,aAAa,EAAE,MAAM,EACrB,OAAO,CAAC,EAAE,wBAAwB,GACjC,0BAA0B,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAItD;;;;OAIG;IACI,yBAAyB,CAC9B,aAAa,EAAE,MAAM,EACrB,OAAO,CAAC,EAAE,gCAAgC,GACzC,0BAA0B,CAAC,oBAAoB,CAAC;IAInD;;;;;;;;OAQG;IACI,gBAAgB,CACrB,aAAa,EAAE,MAAM,EACrB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAChC,SAAS,EAAE,MAAM,EACjB,OAAO,GAAE,gBAAqB,GAC7B,OAAO,CAAC,IAAI,CAAC;IAkBhB;;;;;;;;;OASG;IACI,yBAAyB,CAC9B,aAAa,EAAE,MAAM,EACrB,aAAa,EAAE,MAAM,EACrB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAChC,SAAS,EAAE,MAAM,EACjB,OAAO,GAAE,gBAAqB,GAC7B,OAAO,CAAC,IAAI,CAAC;IAgBhB;;;;;;OAMG;IACI,QAAQ,CACb,OAAO,EAAE,MAAM,EACf,OAAO,GAAE,eAAoB,GAC5B,OAAO,CAAC,gCAAgC,CAAC;IAa5C;;;;;OAKG;IACI,UAAU,CACf,OAAO,GAAE,iBAAsB,GAC9B,0BAA0B,CAAC,qBAAqB,CAAC;IAOpD;;;;;;OAMG;IACI,YAAY,CACjB,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,EAC1C,OAAO,GAAE,gBAAqB,GAC7B,OAAO,CAAC,4BAA4B,CAAC;IAaxC;;;;;;;;;;;OAWG;IACI,gBAAgB,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,GAAE,gBAAqB,GAAG,OAAO,CAAC,IAAI,CAAC;IAYvF;;;;;;OAMG;IACI,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,GAAE,gBAAqB,GAAG,OAAO,CAAC,IAAI,CAAC;IAUlF;;;;;;OAMG;IACI,aAAa,CAClB,YAAY,EAAE,MAAM,EACpB,OAAO,GAAE,gBAAqB,GAC7B,OAAO,CAAC,0BAA0B,CAAC;IAUtC;;;;;OAKG;IACI,eAAe,CAAC,OAAO,CAAC,EAAE,sBAAsB,GAAG,0BAA0B,CAAC,UAAU,CAAC;IAIhG;;;;;;;;OAQG;IACI,gBAAgB,CACrB,YAAY,EAAE,MAAM,EACpB,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,MAAM,EACd,OAAO,GAAE,gBAAqB,GAC7B,OAAO,CAAC,IAAI,CAAC;IAgBhB;;;;;;OAMG;IACI,gBAAgB,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,GAAE,gBAAqB,GAAG,OAAO,CAAC,IAAI,CAAC;IAU5F;;;;;;;OAOG;YACY,cAAc;IAkB7B;;;;OAIG;YACY,aAAa;IAW5B;;;;;;OAMG;IACI,UAAU,CACf,KAAK,EAAE,MAAM,EACb,OAAO,GAAE,iBAAsB,GAC9B,0BAA0B,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,uBAAuB,CAAC;CAahF"}