@deepgram/sdk 1.2.4 → 1.3.1-beta.1

package/.devcontainer/Dockerfile

@@ -0,0 +1,16 @@
+# See here for image contents: https://github.com/microsoft/vscode-dev-containers/tree/v0.231.2/containers/javascript-node/.devcontainer/base.Dockerfile
+
+# [Choice] Node.js version (use -bullseye variants on local arm64/Apple Silicon): 16, 14, 12, 16-bullseye, 14-bullseye, 12-bullseye, 16-buster, 14-buster, 12-buster
+ARG VARIANT="16-bullseye"
+FROM mcr.microsoft.com/vscode/devcontainers/javascript-node:0-${VARIANT}
+
+# [Optional] Uncomment this section to install additional OS packages.
+# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
+#     && apt-get -y install --no-install-recommends <your-package-list-here>
+
+# [Optional] Uncomment if you want to install an additional version of node using nvm
+# ARG EXTRA_NODE_VERSION=10
+# RUN su node -c "source /usr/local/share/nvm/nvm.sh && nvm install ${EXTRA_NODE_VERSION}"
+
+# [Optional] Uncomment if you want to install more global node modules
+# RUN su node -c "npm install -g <your-package-list-here>"

package/.devcontainer/devcontainer.json

@@ -0,0 +1,29 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
+// https://github.com/microsoft/vscode-dev-containers/tree/v0.231.2/containers/javascript-node
+{
+	"name": "Node.js",
+	"build": {
+		"dockerfile": "Dockerfile",
+		// Update 'VARIANT' to pick a Node version: 16, 14, 12.
+		// Append -bullseye or -buster to pin to an OS version.
+		// Use -bullseye variants on local arm64/Apple Silicon.
+		"args": { "VARIANT": "12" }
+	},
+
+	// Set *default* container specific settings.json values on container create.
+	"settings": {},
+
+	// Add the IDs of extensions you want installed when the container is created.
+	"extensions": [
+		"dbaeumer.vscode-eslint"
+	],
+
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// "forwardPorts": [],
+
+	// Use 'postCreateCommand' to run commands after the container is created.
+	// "postCreateCommand": "yarn install",
+
+	// Comment out to connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
+	"remoteUser": "node"
+}

package/CHANGELOG.md

@@ -1,171 +1,196 @@
-# Changelog
-
-All notable changes to this project will be documented in this file.
-
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
-
-## [Unreleased]
-
----
-
-## [1.2.4]
-
-### Fixed
-
-- Getting the list of API keys was returning the wrong type of object. The SDK now returns the correct object type, but also returns what was previously implemented with deprecation notices.
-- The `version` parameter was typed as required for both pre-recorded and live transcription. Changed this to be optional.
-
-## [1.2.2]
-
-### Updated
-
-- Updated the `wordBase` type to include an optional `speaker` property.
-- Updated the documentation for the speaker property of the `utterance` type.
-
-## [1.2.1]
-
-### Fixed
-
-- Fixed a bug that caused real-time transcriptions to not close correctly. This
-would result in the user not received the final transcription.
-
-## [1.2.0]
-
-### Updated
-
-- Updated the `keys.create` function to allow new `expirationDate` or `timeToLive`
-values. These are optional and one at most can be provided. Providing both will
-throw an error.
-
-## [1.1.0]
-
-### Added
-
-- Prerecorded transcription responses can now be used to generate WebVTT and
-  SRT caption files. Example:
-
-  ```js
-  const response = await deepgram.transcription.preRecorded(
-    { url: "URL_TO_FILE" },
-    {
-      punctuate: true,
-      utterances: true,
-    }
-  );
-  const webVTT = response.toWebVTT();
-  const SRT = response.toSRT();
-  ```
-
-  The [utterances](https://developers.deepgram.com/documentation/features/utterances/)
-  feature is required to use this functionality.
-
-## [1.0.3]
-
-### Added
-
-- In addition to a Url and Buffer, `trascricription.preRecorded` now accepts a
-  ReadStream as a source of the file to transcribe.
-
-### Updated
-
-- Removed a console log that occurred when an HTTP request ended
-
-## [1.0.2]
-
-### Added
-
-- `deepgram.projects.update` will now update a project
-- Prerecorded transcription responses now include utterances
-
-### Updated
-
-- The project type has been modified to the following:
-
-```ts
-{
-  project_id: string;
-  name?: string;
-  company?: string;
-};
-```
-
-- The key type has been modified to the following:
-
-```ts
-{
-  api_key_id: string;
-  key?: string;
-  comment: string;
-  created: string;
-  scopes: Array<string>;
-};
-```
-
-- The usage request type has been modified to the following:
-
-```ts
-{
-  request_id: string;
-  created: string;
-  path: string;
-  accessor: string;
-  response?: UsageRequestDetail | UsageRequestMessage;
-  callback?: UsageCallback;
-};
-```
-
-## [1.0.0]
-
-### Added
-
-#### Live transcription
-
-- `deepgram.transcription.live` now manages a websocket connection to Deepgram's API
-  for live transcription
-
-#### Projects
-
-- `deepgram.projects` allows listing projects or getting a specific project from
-  your Deepgram account
-
-### Updated
-
-#### Pre-recorded transcription
-
-- `deepgram.batch` has been moved to `deepgram.transcription.preRecorded`
-- Type of `source` parameter of pre-recorded transcriptions has changed. You can now
-  send one of two types of objects: `{ url: YOUR_FILES_URL }` or
-  `{ buffer: BUFFER_OF_YOUR_FILE, mimetype: FILES_MIME_TYPE }`
-
-#### API Key management
-
-- All `deepgram.keys` methods now require a `projectId`.
-- `deepgram.keys.create` now requires an additional parameter `scopes`. This is a
-  string array specifying the scopes available to the newly created API key
-
-## [0.6.5]
-
-- Added notice to README to denote the library is in a very unstable state.
-
-## [0.6.4]
-
-### Added
-
-- `transcribe` method will now return transcription results for both urls or buffers.
-- `keys` now provides `create`, `list`, and `delete` methods that allow managing of
-  API keys.
-
----
-
-[unreleased]: https://github.com/deepgram/node-sdk/compare/1.2.4...HEAD
-[1.2.2]: https://github.com/deepgram/node-sdk/compare/1.2.2...1.2.4
-[1.2.2]: https://github.com/deepgram/node-sdk/compare/1.2.1...1.2.2
-[1.2.1]: https://github.com/deepgram/node-sdk/compare/1.2.0...1.2.1
-[1.2.0]: https://github.com/deepgram/node-sdk/compare/1.1.0...1.2.0
-[1.1.0]: https://github.com/deepgram/node-sdk/compare/1.0.3...1.1.0
-[1.0.3]: https://github.com/deepgram/node-sdk/compare/1.0.2...1.0.3
-[1.0.2]: https://github.com/deepgram/node-sdk/compare/1.0.0...1.0.2
-[1.0.0]: https://github.com/deepgram/node-sdk/compare/0.6.5...1.0.0
-[0.6.5]: https://github.com/deepgram/node-sdk/compare/0.6.4...0.6.5
-[0.6.4]: https://github.com/deepgram/node-sdk/compare/edc07b4...0.6.4
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+---
+
+## [1.3.1-beta]
+
+### Updated
+
+- Updated user-agent header to be generated on build rather than on demand.
+
+## [1.3.0]
+
+### Added
+
+- Added Message Class for generic message responses
+- Added member endpoint functionality
+  - This includes the `listMembers` and `removeMember` methods
+  - Added Member and MemberList Class
+- Added scopes endpoint functionality
+  - This includes the `get` and `update` methods
+  - Added ScopeList Class
+- Added invites endpoint functionality
+  - This includes the `list`, `send`, `leave` and `delete` methods
+  - Added InvitationOptions and InvitationList Class
+- Added balances endpoint functionality
+  - This includes the `listBalances` and `getBalance` methods
+  - Added Balance and BalanceList Class
+
+## [1.2.4]
+
+### Fixed
+
+- Getting the list of API keys was returning the wrong type of object. The SDK now returns the correct object type, but also returns what was previously implemented with deprecation notices.
+- The `version` parameter was typed as required for both pre-recorded and live transcription. Changed this to be optional.
+
+## [1.2.2]
+
+### Updated
+
+- Updated the `wordBase` type to include an optional `speaker` property.
+- Updated the documentation for the speaker property of the `utterance` type.
+
+## [1.2.1]
+
+### Fixed
+
+- Fixed a bug that caused real-time transcriptions to not close correctly. This
+  would result in the user not received the final transcription.
+
+## [1.2.0]
+
+### Updated
+
+- Updated the `keys.create` function to allow new `expirationDate` or `timeToLive`
+  values. These are optional and one at most can be provided. Providing both will
+  throw an error.
+
+## [1.1.0]
+
+### Added
+
+- Prerecorded transcription responses can now be used to generate WebVTT and
+  SRT caption files. Example:
+
+  ```js
+  const response = await deepgram.transcription.preRecorded(
+    { url: "URL_TO_FILE" },
+    {
+      punctuate: true,
+      utterances: true,
+    }
+  );
+  const webVTT = response.toWebVTT();
+  const SRT = response.toSRT();
+  ```
+
+  The [utterances](https://developers.deepgram.com/documentation/features/utterances/)
+  feature is required to use this functionality.
+
+## [1.0.3]
+
+### Added
+
+- In addition to a Url and Buffer, `trascricription.preRecorded` now accepts a
+  ReadStream as a source of the file to transcribe.
+
+### Updated
+
+- Removed a console log that occurred when an HTTP request ended
+
+## [1.0.2]
+
+### Added
+
+- `deepgram.projects.update` will now update a project
+- Prerecorded transcription responses now include utterances
+
+### Updated
+
+- The project type has been modified to the following:
+
+```ts
+{
+  project_id: string;
+  name?: string;
+  company?: string;
+};
+```
+
+- The key type has been modified to the following:
+
+```ts
+{
+  api_key_id: string;
+  key?: string;
+  comment: string;
+  created: string;
+  scopes: Array<string>;
+};
+```
+
+- The usage request type has been modified to the following:
+
+```ts
+{
+  request_id: string;
+  created: string;
+  path: string;
+  accessor: string;
+  response?: UsageRequestDetail | UsageRequestMessage;
+  callback?: UsageCallback;
+};
+```
+
+## [1.0.0]
+
+### Added
+
+#### Live transcription
+
+- `deepgram.transcription.live` now manages a websocket connection to Deepgram's API
+  for live transcription
+
+#### Projects
+
+- `deepgram.projects` allows listing projects or getting a specific project from
+  your Deepgram account
+
+### Updated
+
+#### Pre-recorded transcription
+
+- `deepgram.batch` has been moved to `deepgram.transcription.preRecorded`
+- Type of `source` parameter of pre-recorded transcriptions has changed. You can now
+  send one of two types of objects: `{ url: YOUR_FILES_URL }` or
+  `{ buffer: BUFFER_OF_YOUR_FILE, mimetype: FILES_MIME_TYPE }`
+
+#### API Key management
+
+- All `deepgram.keys` methods now require a `projectId`.
+- `deepgram.keys.create` now requires an additional parameter `scopes`. This is a
+  string array specifying the scopes available to the newly created API key
+
+## [0.6.5]
+
+- Added notice to README to denote the library is in a very unstable state.
+
+## [0.6.4]
+
+### Added
+
+- `transcribe` method will now return transcription results for both urls or buffers.
+- `keys` now provides `create`, `list`, and `delete` methods that allow managing of
+  API keys.
+
+---
+
+[unreleased]: https://github.com/deepgram/node-sdk/compare/1.3.0...HEAD
+[1.3.0]: https://github.com/deepgram/node-sdk/compare/1.2.2...1.2.4
+[1.2.4]: https://github.com/deepgram/node-sdk/compare/1.2.2...1.2.4
+[1.2.2]: https://github.com/deepgram/node-sdk/compare/1.2.1...1.2.2
+[1.2.1]: https://github.com/deepgram/node-sdk/compare/1.2.0...1.2.1
+[1.2.0]: https://github.com/deepgram/node-sdk/compare/1.1.0...1.2.0
+[1.1.0]: https://github.com/deepgram/node-sdk/compare/1.0.3...1.1.0
+[1.0.3]: https://github.com/deepgram/node-sdk/compare/1.0.2...1.0.3
+[1.0.2]: https://github.com/deepgram/node-sdk/compare/1.0.0...1.0.2
+[1.0.0]: https://github.com/deepgram/node-sdk/compare/0.6.5...1.0.0
+[0.6.5]: https://github.com/deepgram/node-sdk/compare/0.6.4...0.6.5
+[0.6.4]: https://github.com/deepgram/node-sdk/compare/edc07b4...0.6.4