@epilot/entity-client 3.0.14 → 3.0.15

package/README.md

@@ -1,48 +1,30 @@
-# `@epilot/entity-client`
-
-JavaScript client library for the epilot Core Entity API
-
-Uses [`openapi-client-axios`](https://github.com/anttiviljami/openapi-client-axios)
-
-## Getting Started
-
-Install the package:
-
-```bash
-npm install --save-dev @epilot/entity-client
-```
-
-Import the package:
-
-```typescript
-import { getClient } from '@epilot/entity-client';
-```
-
-Use the client:
-```typescript
-// get typed client
-const client = await getClient();
-
-// call operations
-const createRes = await client.createEntity(null, { name: "viljami" });
-const { id } = creteRes.data;
-
-const getRes = await client.getEntity(id);
-const { entity } = getRes.data;
-```
-
-## 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:
-
-https://docs.api.epilot.io/entity
-
+# @epilot/entity-client
+
+[![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/entity-client.svg)](https://www.npmjs.com/package/@epilot/entity-client)
+[![bundle size](https://img.shields.io/bundlephobia/minzip/@epilot/entity-client?label=gzip%20bundle)](https://bundlephobia.com/package/@epilot/entity-client)
+[![License](http://img.shields.io/:license-mit-blue.svg)](https://github.com/epilot-dev/sdk-js/blob/main/LICENSE)
+
+Client library for epilot [Entity API](https://docs.epilot.io/api/entity)
+
+Uses [`openapi-client-axios`](https://github.com/anttiviljami/openapi-client-axios)
+
+## Installation
+
+```bash
+npm install --save @epilot/entity-client
+```
+
+## Usage
+
+```typescript
+import { getClient } from '@epilot/entity-client';
+const entityClient = getClient();
+
+const createResponse = await entityClient.createEntity({ slug: 'contact' }, { first_name: 'Example', last_name: 'Entity' });
+const getResponse = await entityClient.getEntity({ slug: 'contact', id: createResponse.data._id });
+```
+
+## Documentation
+
+https://docs.epilot.io/docs/entities/entity-api

package/dist/client.d.ts

@@ -1,2 +1,2 @@
-import { Client } from './openapi';
-export declare const getClient: () => Client;
+import { Client } from './openapi';
+export declare const getClient: () => Client;

package/dist/client.js

@@ -1,32 +1,32 @@
-"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 api = new openapi_client_axios_1.default({ definition: definition_1.default, quick: true });
-    var apiClient = api.initSync();
-    apiClient.interceptors.request.use(function (config) {
-        var correlationHeaders = lambda_powertools_correlation_ids_1.default.get() || {};
-        config.headers = __assign(__assign({}, (config.headers || {})), correlationHeaders);
-        return config;
-    });
-    return apiClient;
-};
-exports.getClient = getClient;
+"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 api = new openapi_client_axios_1.default({ definition: definition_1.default, quick: true });
+    var apiClient = api.initSync();
+    apiClient.interceptors.request.use(function (config) {
+        var correlationHeaders = lambda_powertools_correlation_ids_1.default.get() || {};
+        config.headers = __assign(__assign({}, (config.headers || {})), correlationHeaders);
+        return config;
+    });
+    return apiClient;
+};
+exports.getClient = getClient;
 //# sourceMappingURL=client.js.map

package/dist/definition.d.ts

@@ -1,3 +1,3 @@
-import type { Document } from 'openapi-client-axios';
-declare const _default: Document;
-export default _default;
+import type { Document } from 'openapi-client-axios';
+declare const _default: Document;
+export default _default;