cv-contracts 0.0.5 → 0.0.7

package/README.md

@@ -1 +1,41 @@
 # cv-contracts
+
+## Project Overview
+This repository contains a collection of TypeScript interfaces and enums that are used to model various entities and events with [Carbon Voice API](https://api.carbonvoice.app/v2/docs/#/). These entities include users, channels, workspaces, and messages, among others.
+
+The primary idea is to have a centralized place for webhook communication with [Carbon Voice API](https://api.carbonvoice.app/v2/docs/#/)
+
+## Usage example:
+## Install library
+```bash
+npm i cv-contracts
+```
+
+## Import respective contract
+```ts
+import { Message } from 'cv-contracts';
+
+const msg: Message = {
+  message_guid: string;
+  creator_guid: string;
+  channel_guid?: string | null;
+  workspace_guid?: string | null;
+  creator_first_name: string;
+  creator_last_name: string;
+  created_at: number;
+  last_updated_at: number;
+  deleted_at?: number | null;
+  duration_ms: number;
+  message_url?: string | null;
+  audio_stream_url?: string | null;
+  transcript_txt?: string | null;
+  ai_summary_txt?: string | null;
+  has_ai_summary?: boolean;
+  waveform_url?: string | null;
+  reply_count: number;
+  parent_message_guid?: string | null;
+  language?: string | null;
+  status: MessageStatus;
+  type: MessageType;
+}
+```

package/dist/interfaces/WorkspaceUserAdded.d.ts

@@ -0,0 +1,6 @@
+import { BasicUser } from './BasicUser';
+import { Workspace } from './Workspace';
+export interface WorkspaceUserAdded {
+    workspace: Workspace;
+    addedUser: BasicUser;
+}

package/dist/interfaces/WorkspaceUserAdded.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=WorkspaceUserAdded.js.map

package/dist/interfaces/WorkspaceUserAdded.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"WorkspaceUserAdded.js","sourceRoot":"","sources":["../../src/interfaces/WorkspaceUserAdded.ts"],"names":[],"mappings":""}

package/dist/interfaces/index.d.ts

@@ -10,6 +10,7 @@ export * from './SubscribedUserSettings';
 export * from './WebhookPayload';
 export * from './Workspace';
 export * from './WorkspaceFindableChannelCreated';
+export * from './WorkspaceUserAdded';
 export * from './WorkspaceUserJoined';
 export * from './WorkspaceUserLeft';
 export * from './WorkspaceUserRemoved';

package/dist/interfaces/index.js

@@ -26,6 +26,7 @@ __exportStar(require("./SubscribedUserSettings"), exports);
 __exportStar(require("./WebhookPayload"), exports);
 __exportStar(require("./Workspace"), exports);
 __exportStar(require("./WorkspaceFindableChannelCreated"), exports);
+__exportStar(require("./WorkspaceUserAdded"), exports);
 __exportStar(require("./WorkspaceUserJoined"), exports);
 __exportStar(require("./WorkspaceUserLeft"), exports);
 __exportStar(require("./WorkspaceUserRemoved"), exports);

package/dist/interfaces/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/interfaces/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,sDAAoC;AACpC,8CAA4B;AAC5B,4CAA0B;AAC1B,sDAAoC;AACpC,oDAAkC;AAClC,uDAAqC;AACrC,sDAAoC;AACpC,4CAA0B;AAC1B,2DAAyC;AACzC,mDAAiC;AACjC,8CAA4B;AAC5B,oEAAkD;AAClD,wDAAsC;AACtC,sDAAoC;AACpC,yDAAuC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/interfaces/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,sDAAoC;AACpC,8CAA4B;AAC5B,4CAA0B;AAC1B,sDAAoC;AACpC,oDAAkC;AAClC,uDAAqC;AACrC,sDAAoC;AACpC,4CAA0B;AAC1B,2DAAyC;AACzC,mDAAiC;AACjC,8CAA4B;AAC5B,oEAAkD;AAClD,uDAAqC;AACrC,wDAAsC;AACtC,sDAAoC;AACpC,yDAAuC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cv-contracts",
-  "version": "0.0.5",
+  "version": "0.0.7",
   "description": "Carbon Voice Contracts",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",