@deepgram/sdk 1.2.2 → 1.3.1-beta

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,163 +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.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.2...HEAD
-[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

package/CODE_OF_CONDUCT.md

@@ -1,128 +1,128 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-We as members, contributors, and leaders pledge to make participation in our
-community a harassment-free experience for everyone, regardless of age, body
-size, visible or invisible disability, ethnicity, sex characteristics, gender
-identity and expression, level of experience, education, socio-economic status,
-nationality, personal appearance, race, religion, or sexual identity
-and orientation.
-
-We pledge to act and interact in ways that contribute to an open, welcoming,
-diverse, inclusive, and healthy community.
-
-## Our Standards
-
-Examples of behavior that contributes to a positive environment for our
-community include:
-
-- Demonstrating empathy and kindness toward other people
-- Being respectful of differing opinions, viewpoints, and experiences
-- Giving and gracefully accepting constructive feedback
-- Accepting responsibility and apologizing to those affected by our mistakes,
-  and learning from the experience
-- Focusing on what is best not just for us as individuals, but for the
-  overall community
-
-Examples of unacceptable behavior include:
-
-- The use of sexualized language or imagery, and sexual attention or
-  advances of any kind
-- Trolling, insulting or derogatory comments, and personal or political attacks
-- Public or private harassment
-- Publishing others' private information, such as a physical or email
-  address, without their explicit permission
-- Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Enforcement Responsibilities
-
-Community leaders are responsible for clarifying and enforcing our standards of
-acceptable behavior and will take appropriate and fair corrective action in
-response to any behavior that they deem inappropriate, threatening, offensive,
-or harmful.
-
-Community leaders have the right and responsibility to remove, edit, or reject
-comments, commits, code, wiki edits, issues, and other contributions that are
-not aligned to this Code of Conduct, and will communicate reasons for moderation
-decisions when appropriate.
-
-## Scope
-
-This Code of Conduct applies within all community spaces, and also applies when
-an individual is officially representing the community in public spaces.
-Examples of representing our community include using an official e-mail address,
-posting via an official social media account, or acting as an appointed
-representative at an online or offline event.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported to the community leaders responsible for enforcement at
-devrel@deepgram.com.
-All complaints will be reviewed and investigated promptly and fairly.
-
-All community leaders are obligated to respect the privacy and security of the
-reporter of any incident.
-
-## Enforcement Guidelines
-
-Community leaders will follow these Community Impact Guidelines in determining
-the consequences for any action they deem in violation of this Code of Conduct:
-
-### 1. Correction
-
-**Community Impact**: Use of inappropriate language or other behavior deemed
-unprofessional or unwelcome in the community.
-
-**Consequence**: A private, written warning from community leaders, providing
-clarity around the nature of the violation and an explanation of why the
-behavior was inappropriate. A public apology may be requested.
-
-### 2. Warning
-
-**Community Impact**: A violation through a single incident or series
-of actions.
-
-**Consequence**: A warning with consequences for continued behavior. No
-interaction with the people involved, including unsolicited interaction with
-those enforcing the Code of Conduct, for a specified period of time. This
-includes avoiding interactions in community spaces as well as external channels
-like social media. Violating these terms may lead to a temporary or
-permanent ban.
-
-### 3. Temporary Ban
-
-**Community Impact**: A serious violation of community standards, including
-sustained inappropriate behavior.
-
-**Consequence**: A temporary ban from any sort of interaction or public
-communication with the community for a specified period of time. No public or
-private interaction with the people involved, including unsolicited interaction
-with those enforcing the Code of Conduct, is allowed during this period.
-Violating these terms may lead to a permanent ban.
-
-### 4. Permanent Ban
-
-**Community Impact**: Demonstrating a pattern of violation of community
-standards, including sustained inappropriate behavior, harassment of an
-individual, or aggression toward or disparagement of classes of individuals.
-
-**Consequence**: A permanent ban from any sort of public interaction within
-the community.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 2.0, available at
-https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
-
-Community Impact Guidelines were inspired by [Mozilla's code of conduct
-enforcement ladder](https://github.com/mozilla/diversity).
-
-[homepage]: https://www.contributor-covenant.org
-
-For answers to common questions about this code of conduct, see the FAQ at
-https://www.contributor-covenant.org/faq. Translations are available at
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+devrel@deepgram.com.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
 https://www.contributor-covenant.org/translations.