[SDK release] Generated SDK code based on data-link 0.4.4-alpha.3 API changes

src/README.md

@@ -1,71 +1,46 @@
-## Databox
+## [email protected]
 
-This package is designed to consume the Databox Push API functionality via TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The package is compatible with the following environments:
+This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The generated Node module can be used in the following environments:
 
 Environment
 * Node.js
 * Webpack
 * Browserify
 
 Language level
-* ES5 - You must have a Promises/A+ library installed
+* ES5 - you must have a Promises/A+ library installed
 * ES6
 
 Module system
 * CommonJS
 * ES6 module system
 
-The package can be used with both TypeScript and JavaScript. In TypeScript, the definitions will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)).
+It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html))
 
-### Installing
+### Building
 
+To build and compile the typescript sources to javascript use:
 ```
-npm install databox --save
+npm install
+npm run build
 ```
 
-### Prerequisites
-In use the Databox Push API functionality, please refer to [Databox Developers Page](https://developers.databox.com/), specifically the **Quick Guide** section, where you will learn how to create a **Databox Push API token** which is required for pushing your data.
+### Publishing
 
-### Example
-The basic example of pushing data to Databox is provided below:
-```TypeScript
-import {
-  ApiResponse,
-  Configuration,
-  DataPostRequest,
-  DefaultApi,
-} from "databox";
+First build the package then run `npm publish`
 
-const config: Configuration = new Configuration({
-  basePath: "https://push.databox.com",
-  username: "<Your_Databox_API_Token>",
-  headers: {
-    Accept: "application/vnd.databox.v2+json",
-  },
-});
+### Consuming
 
-const dataPostRequest: DataPostRequest = {
-  pushData: [
-    {
-      key: "<Metric_name>",
-      value: 123,
-      date: "<Date_in_ISO8601>",
-      unit: "<Unit>", // Optional
-      attributes: [{ key: "<Dimension_name>", value: "<Dimension_value>" }], // Optional
-    },
-  ],
-};
+navigate to the folder of your consuming project and run one of the following commands.
 
-const api = new DefaultApi(config);
+_published:_
 
-try {
-  api
-    .dataPostRaw(dataPostRequest)
-    .then((response: ApiResponse<void>) => response.raw.json())
-    .then((responseBody) => {
-      console.log("Response data", responseBody);
-    });
-} catch (error) {
-  console.log("Error: ", error);
-}
-```
+```
+npm install [email protected] --save
+```
+
+_unPublished (not recommended):_
+
+```
+npm install PATH_TO_GENERATED_PACKAGE --save
+```

src/package.json

@@ -5,7 +5,7 @@
   "author": "OpenAPI-Generator",
   "repository": {
     "type": "git",
-    "url": "https://github.com/databox/databox-js.git"
+    "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
   },
   "main": "./dist/index.js",
   "typings": "./dist/index.d.ts",
@@ -15,5 +15,8 @@
   },
   "devDependencies": {
     "typescript": "^4.0 || ^5.0"
+  },
+  "publishConfig": {
+    "registry": "https://github.com/databox/databox-js.git"
   }
 }

src/src/apis/DefaultApi.ts

@@ -4,7 +4,7 @@
  * Static OpenAPI document of Push API resource
  * Push API resources Open API documentation
  *
- * The version of the OpenAPI document: 0.4.3
+ * The version of the OpenAPI document: 0.4.4-alpha.3
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

src/src/models/ModelApiResponse.ts

@@ -4,7 +4,7 @@
  * Static OpenAPI document of Push API resource
  * Push API resources Open API documentation
  *
- * The version of the OpenAPI document: 0.4.3
+ * The version of the OpenAPI document: 0.4.4-alpha.3
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

src/src/models/PushData.ts

@@ -4,7 +4,7 @@
  * Static OpenAPI document of Push API resource
  * Push API resources Open API documentation
  *
- * The version of the OpenAPI document: 0.4.3
+ * The version of the OpenAPI document: 0.4.4-alpha.3
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

src/src/models/PushDataAttribute.ts

@@ -4,7 +4,7 @@
  * Static OpenAPI document of Push API resource
  * Push API resources Open API documentation
  *
- * The version of the OpenAPI document: 0.4.3
+ * The version of the OpenAPI document: 0.4.4-alpha.3
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

src/src/models/State.ts

@@ -4,7 +4,7 @@
  * Static OpenAPI document of Push API resource
  * Push API resources Open API documentation
  *
- * The version of the OpenAPI document: 0.4.3
+ * The version of the OpenAPI document: 0.4.4-alpha.3
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

src/src/runtime.ts

@@ -4,7 +4,7 @@
  * Static OpenAPI document of Push API resource
  * Push API resources Open API documentation
  *
- * The version of the OpenAPI document: 0.4.3
+ * The version of the OpenAPI document: 0.4.4-alpha.3
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).