@dynatrace-sdk/client-classic-environment-v2 1.1.0 → 1.2.3

package/CHANGELOG.md

@@ -2,11 +2,40 @@
 
 @dynatrace-sdk/client-classic-environment-v2
 
+## 1.2.3
+
+### Patch Changes
+
+- Update documentation
+
+## 1.2.2
+
+### Patch Changes
+
+- Update docs.
+
+## 1.2.1
+
+### Patch Changes
+
+- Add JSDoc @example for operations.
+
+## 1.2.0
+
+### Minor Changes
+
+- Add `externalId` config option to `getSettingsObjects` in Settings Objects API.
+- Update method descriptions.
+
+### Patch Changes
+
+- Fix handling of the application/cloudevent+json content type.
+
 ## 1.1.0
 
 ### Minor Changes
 
-- 6aca01cb: Export model transformations
+- Export model transformations
 
 ## 1.0.5
 
@@ -19,14 +48,14 @@
 
 ### Patch Changes
 
-- dfc1b337: Update `@dynatrace-sdk/http-client` to `^1.0.1`
-- dfc1b337: Use parsed response body in error serializer
+- Update `@dynatrace-sdk/http-client` to `^1.0.1`
+- Use parsed response body in error serializer
 
 ## 1.0.3
 
 ### Patch Changes
 
-- 39f914be: Send response body in error serializer
+- Send response body in error serializer
 - Updated dependencies
   - @dynatrace-sdk/http-client@1.0.0
 
@@ -40,10 +69,10 @@
 
 ### Patch Changes
 
-- 8d68edf6: Fix operation method name for Business Events ingest
+- Fix operation method name for Business Events ingest
 
 ## 1.0.0
 
 ### Major Changes
 
-- Initial public release.
+- Initial public release.

package/README.md

@@ -1,61 +1,32 @@
-# Classic Environment V2
-API version: `2.0.0`.
+# @dynatrace-sdk/client-classic-environment-v2
 
+[![npm](https://img.shields.io/badge/npm-v1.2.3-blue)](https://www.npmjs.com/package/@dynatrace-sdk/client-classic-environment-v2/v/1.2.3)
+[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 
-
-
- 
-Documentation of the Dynatrace Environment API v2. Resources here generally supersede those in v1. Migration of resources from v1 is in progress. 
+Documentation of the Dynatrace Environment API v2. Resources here generally supersede those in v1. Migration of resources from v1 is in progress.
 
 If you miss a resource, consider using the Dynatrace Environment API v1. To read about use cases and examples, see [Dynatrace Documentation](https://dt-url.net/2u23k1k) .
 
 Notes about compatibility:
-* Operations marked as early adopter or preview may be changed in non-compatible ways, although we try to avoid this.
-* We may add new enum constants without incrementing the API version; thus, clients need to handle unknown enum constants gracefully.
+
+- Operations marked as early adopter or preview may be changed in non-compatible ways, although we try to avoid this.
+- We may add new enum constants without incrementing the API version; thus, clients need to handle unknown enum constants gracefully.
 
 ## Installation
 
-```
+```bash
 npm install @dynatrace-sdk/client-classic-environment-v2
 ```
 
-> **Important!** The content of this library is autogenerated.
-
-## [Experimental] Using client in nodejs/jest environment
-
-> **Important!** Node.js officially is not supported. This guide shows some workarounds to enable usage of the client in nodejs runtime.
-
-There is a possibility to use SDK clients in nodejs runtime. This may require additional setup:
-First, developer may need to polyfill `fetch` function with some library like [undici](https://github.com/nodejs/undici) or [node-fetch](https://github.com/node-fetch/node-fetch).
-Then, developer would need to provide the implementation of [HttpClient](https://bitbucket.lab.dynatrace.org/projects/APPFW/repos/dynatrace-sdk/browse/packages/http-client/src/lib/types/http-client.ts) interface. Sample code to achieve this:
-```typescript
-import { PlatformHttpClientResponse } from '@dynatrace-sdk/http-client';
-import { fetch } from 'undici';
-
-const myHttpClient = {
-    async send(options: any) {
-      return new PlatformHttpClientResponse(
-        await (fetch(`http://localhost:3000${options.url}`, { // here we would need to patch the request url to include hostname.
-          method: options.method,
-          headers: options.headers,
-          signal: options.abortSignal,
-          body: JSON.stringify(options.body), // but this will not work for form-data content-type
-        }) as any),
-      );
-    },
-  };
-```
+## API reference
 
-Then, once we have the instance of custom http client, we may instantiate the API Client instance:
+Full API reference for this SDK is available at [Dynatrace Developer](https://developer.dynatrace.com/reference/sdks/client-classic-environment-v2/).
 
-```typescript
-import {
-  SettingsObjectsClient,
-} from '@dynatrace-sdk/client-example';
+## Getting help
 
-// ...
+- Visit [SDK for Typescript](https://developer.dynatrace.com/reference/sdks/) guide in the [Dynatrace Developer](https://developer.dynatrace.com/)
+- Ask a question in the [Dynatrace Community](https://community.dynatrace.com/)
 
-const settingsObjectsClient = new SettingsObjectsClient(myHttpClient);
+## License
 
-const settings = await settingsObjectsClient.getSettings({});
-```
+This SDK is distributed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0), see LICENSE for more information.