Feat: Changed README

Author: homewardgamer

README.md

@@ -1,7 +1,4 @@
-# sendx-javascript-sdk
-
-sendx - JavaScript client for sendx-javascript-sdk
-# SendX REST API Documentation
+# SendX JavaScript SDK
 
 ## 🚀 Introduction
 
@@ -52,9 +49,9 @@ SendX uses encrypted IDs for security and better developer experience:
 **Example:**
 ```json
 {
-  \"id\": \"contact_BnKjkbBBS500CoBCP0oChQ\",
-  \"lists\": [\"list_OcuxJHdiAvujmwQVJfd3ss\", \"list_0tOFLp5RgV7s3LNiHrjGYs\"],
-  \"tags\": [\"tag_UhsDkjL772Qbj5lWtT62VK\", \"tag_fL7t9lsnZ9swvx2HrtQ9wM\"]
+  "id": "contact_BnKjkbBBS500CoBCP0oChQ",
+  "lists": ["list_OcuxJHdiAvujmwQVJfd3ss", "list_0tOFLp5RgV7s3LNiHrjGYs"],
+  "tags": ["tag_UhsDkjL772Qbj5lWtT62VK", "tag_fL7t9lsnZ9swvx2HrtQ9wM"]
 }
 ```
 
@@ -115,119 +112,49 @@ Need help? Contact us:
 
 [<img src=\"https://run.pstmn.io/button.svg\" alt=\"Run In Postman\" style=\"width: 128px; height: 32px;\">](https://god.gw.postman.com/run-collection/33476323-44b198b0-5219-4619-a01f-cfc24d573885?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D33476323-44b198b0-5219-4619-a01f-cfc24d573885%26entityType%3Dcollection%26workspaceId%3D6b1e4f65-96a9-4136-9512-6266c852517e)
 
-This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
-
-- API version: 1.0.0
-- Package version: 1.0.0
-- Generator version: 7.13.0
-- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
-For more information, please visit [https://sendx.io](https://sendx.io)
 
 ## Installation
 
 ### For [Node.js](https://nodejs.org/)
 
 #### npm
 
-To publish the library as a [npm](https://www.npmjs.com/), please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).
-
-Then install it via:
-
-```shell
-npm install sendx-javascript-sdk --save
-```
-
-Finally, you need to build the module:
-
-```shell
-npm run build
-```
-
-##### Local development
-
-To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing `package.json` (and this README). Let's call this `JAVASCRIPT_CLIENT_DIR`. Then run:
-
-```shell
-npm install
-```
-
-Next, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`:
-
-```shell
-npm link
-```
-
-To use the link you just defined in your project, switch to the directory you want to use your sendx-javascript-sdk from, and run:
-
-```shell
-npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
-```
-
-Finally, you need to build the module:
-
-```shell
-npm run build
-```
-
-#### git
-
-If the library is hosted at a git repository, e.g.https://github.com/sendx/sendx-javascript-sdk
-then install it via:
-
-```shell
-    npm install sendx/sendx-javascript-sdk --save
-```
-
-### For browser
 
-The library also works in the browser environment via npm and [browserify](http://browserify.org/). After following
-the above steps with Node.js and installing browserify with `npm install -g browserify`,
-perform the following (assuming *main.js* is your entry file):
+To install it via npm:
 
 ```shell
-browserify main.js > bundle.js
-```
-
-Then include *bundle.js* in the HTML pages.
-
-### Webpack Configuration
-
-Using Webpack you may encounter the following error: "Module not found: Error:
-Cannot resolve module", most certainly you should disable AMD loader. Add/merge
-the following section to your webpack config:
-
-```javascript
-module: {
-  rules: [
-    {
-      parser: {
-        amd: false
-      }
-    }
-  ]
-}
+npm install sendx-javascript-sdk 
 ```
 
 ## Getting Started
 
 Please follow the [installation](#installation) instruction and execute the following JS code:
 
 ```javascript
-var sendx = require('sendx-javascript-sdk');
+import sendx from 'sendx-javascript-sdk';
 
-var defaultClient = sendx.ApiClient.instance;
+let defaultClient = sendx.ApiClient.instance;
 // Configure API key authorization: TeamApiKey
 var TeamApiKey = defaultClient.authentications['TeamApiKey'];
 TeamApiKey.apiKey = "YOUR API KEY"
-// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
-//TeamApiKey.apiKeyPrefix['X-Team-ApiKey'] = "Token"
-
-var api = new sendx.CampaignApi()
-var restECampaign = {"name":"Flash Sale Announcement","subject":"⚡ 24-Hour Flash Sale - {{contact.firstName}}, Save 50%!","sender":"sender_4vK3WFhMgvOwUNyaL4QxCD","previewText":"Limited time offer - Today only!","htmlCode":"<html><body><h1>Flash Sale!</h1><p>Hi {{contact.firstName}},</p><p>Don't miss our 24-hour flash sale!</p><a href='{{sale.url}}'>Shop Now</a></body></html>","plainText":"Flash Sale!\n\nHi {{contact.firstName}},\n\nDon't miss our 24-hour flash sale!\n\nShop now: {{sale.url}}","scheduleType":1,"includedLists":["list_0tOFLp5RgV7s3LNiHrjGYs","list_vUCjsUmrVXtSppS8rD0Ssq"],"excludedTags":["tag_unengaged"]}; // {RestECampaign} 
-api.createCampaign(restECampaign).then(function(data) {
-  console.log('API called successfully. Returned data: ' + data);
-}, function(error) {
-  console.error(error);
+
+
+let apiInstance = new sendx.ContactApi(); // ContactApi |
+let contactRequest = new sendx.ContactRequest(); // ContactRequest |
+
+contactRequest.email = "jane@doe.com";
+contactRequest.firstName = "Jane";
+contactRequest.lastName = "Doe";
+contactRequest.company = "Tech Solutions Inc.";
+contactRequest.lastTrackedIp = "34.94.159.140";
+contactRequest.customFields = { "1231nfenife213": "VIP", "1434bife23bfij32": "Special Offer Subscriber" };
+contactRequest.lists = ["234b324bjed32", "234bij3e2eyv3v2i"];
+contactRequest.tags = ["234bijn2ei2jbu4", "2342bijhb2ijneni"];
+
+apiInstance.createContact(contactRequest).then((data) => {
+    console.log('API called successfully. Contact created: ' + JSON.stringify(data, null, 2));
+}, (error) => {
+    console.error(error);
 });