@epilot/message-client 1.1.1 → 1.1.4

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 epilot GmbH
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -1,40 +1,89 @@
-# `@epilot/message-client`
+# @epilot/message-client
 
-API Client for epilot Message API.
+[![CI](https://github.com/epilot-dev/sdk-js/workflows/CI/badge.svg)](https://github.com/epilot-dev/sdk-js/actions?query=workflow%3ACI)
+[![npm version](https://img.shields.io/npm/v/@epilot/message-client.svg)](https://www.npmjs.com/package/@epilot/message-client)
+[![bundle size](https://img.shields.io/bundlephobia/minzip/@epilot/message-client?label=gzip%20bundle)](https://bundlephobia.com/package/@epilot/message-client)
+[![License](http://img.shields.io/:license-mit-blue.svg)](https://github.com/epilot-dev/sdk-js/blob/main/LICENSE)
 
-Uses [`openapi-client-axios`](https://github.com/anttiviljami/openapi-client-axios)
+API Client for epilot [Message API](https://docs.epilot.io/api/message).
 
-## Getting Started
+Uses [`openapi-client-axios`](https://github.com/anttiviljami/openapi-client-axios)
 
-Install the package:
+## Installation
 
 ```bash
-npm install --save-dev @epilot/message-client
+npm install --save @epilot/message-client
 ```
 
-Import the package:
+## Usage
 
 ```typescript
 import { getClient } from '@epilot/message-client';
+const messageClient = getClient();
+const sendResponse = await messageClient.sendMessage(null, {
+  "thread": {
+    "topic": "CUSTOMER_MESSAGE",
+    "assigned_to": [
+      "206801",
+      "200109"
+    ],
+    "opportunity_id": 829072
+  },
+  "parent_id": "44d7a3eb-0cce-4bd3-a7cd-0b3e652de0c2",
+  "subject": "Request for solar panel price",
+  "html": "<div>We at ABC GmbH would like to request a price quote for the solar panel.</div>",
+  "text": "We at ABC GmbH would like to request a price quote for the solar panel.",
+  "from": {
+    "name": "epilot",
+    "address": "messaging@epilot.cloud",
+    "send_status": "SEND",
+    "send_error": {}
+  },
+  "reply_to": {
+    "name": "epilot",
+    "address": "messaging@epilot.cloud",
+    "send_status": "SEND",
+    "send_error": {}
+  },
+  "to": [
+    {
+      "name": "epilot",
+      "address": "messaging@epilot.cloud",
+      "send_status": "SEND",
+      "send_error": {}
+    }
+  ],
+  "cc": [
+    {
+      "name": "epilot",
+      "address": "messaging@epilot.cloud",
+      "send_status": "SEND",
+      "send_error": {}
+    }
+  ],
+  "bcc": [
+    {
+      "name": "epilot",
+      "address": "messaging@epilot.cloud",
+      "send_status": "SEND",
+      "send_error": {}
+    }
+  ],
+  "file": {
+    "$relation": [
+      {
+        "entity_id": "f820ce3b-07b0-45ae-bcc6-babb2f53f79f",
+        "filename": "Produktinformationen_epilot360_Double_Opt_in.pdf",
+        "is_message_attachment": true,
+        "cid": "fb222496-a1a5-4639-94f2-07b5e35e4068",
+        "inline": false,
+        "send_as_link": false
+      }
+    ]
+  }
+});
 ```
 
-Use the client:
-```typescript
-// get typed client
-const client = await getClient();
-```
-
-## BaseURL & Authorization
-
-To pass an authorization header and set up the API url, you can use axios
-defaults:
-
-```typescript
-const client = getClient();
-client.defaults.baseURL = config.ENTITY_API_URL;
-client.defaults.headers.common['authorization'] = `Bearer ${token}`;
-```
-
-## API Docs:
+## Documentation
 
-https://docs.api.epilot.io/
+https://docs.epilot.io/docs/messaging/message-api

package/dist/client.d.ts

@@ -1 +1,2 @@
-export declare const getClient: () => import("openapi-client-axios").OpenAPIClient<import("./openapi").OperationMethods, import("./openapi").PathsDictionary>;
+import { Client } from './openapi';
+export declare const getClient: () => Client;

package/dist/client.js

@@ -1,14 +1,29 @@
 "use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getClient = void 0;
+var lambda_powertools_correlation_ids_1 = __importDefault(require("@dazn/lambda-powertools-correlation-ids"));
 var openapi_client_axios_1 = __importDefault(require("openapi-client-axios"));
 var definition_1 = __importDefault(require("./definition"));
 var getClient = function () {
+    var _a;
     var api = new openapi_client_axios_1.default({ definition: definition_1.default, quick: true });
-    return api.initSync();
+    var apiClient = api.initSync();
+    apiClient.defaults.headers.common = __assign(__assign({}, ((_a = apiClient.defaults.headers.common) !== null && _a !== void 0 ? _a : {})), (lambda_powertools_correlation_ids_1.default.get() || {}));
+    return apiClient;
 };
 exports.getClient = getClient;
 //# sourceMappingURL=client.js.map