@deepgram/sdk 2.1.1 → 2.3.0

package/dist/types/usageField.d.ts

@@ -1,7 +1,9 @@
-export declare type UsageField = {
+export type UsageField = {
     tags: Array<string>;
     models: Array<string>;
     processing_methods: Array<string>;
     languages: Array<string>;
     features: Array<string>;
+    err_code?: string;
+    err_msg?: string;
 };

package/dist/types/usageFieldOptions.d.ts

@@ -1,4 +1,4 @@
-export declare type UsageFieldOptions = {
+export type UsageFieldOptions = {
     start?: string;
     end?: string;
 };

package/dist/types/usageOptions.d.ts

@@ -1,4 +1,4 @@
-export declare type UsageOptions = {
+export type UsageOptions = {
     start?: string;
     end?: string;
     accessor?: string;
@@ -24,7 +24,7 @@ export declare type UsageOptions = {
     translate?: boolean;
     detect_entities?: boolean;
     detect_topics?: boolean;
-    summarize?: boolean;
+    summarize?: boolean | string;
     paragraphs?: boolean;
     utt_split?: boolean;
     analyze_sentiment?: boolean;

package/dist/types/usageRequest.d.ts

@@ -1,11 +1,13 @@
 import { UsageCallback } from "./usageCallback";
 import { UsageRequestDetail } from "./usageRequestDetail";
 import { UsageRequestMessage } from "./usageRequestMessage";
-export declare type UsageRequest = {
+export type UsageRequest = {
     request_id: string;
     created: string;
     path: string;
     accessor: string;
     response?: UsageRequestDetail | UsageRequestMessage;
     callback?: UsageCallback;
+    err_code?: string;
+    err_msg?: string;
 };

package/dist/types/usageRequestDetail.d.ts

@@ -1,4 +1,4 @@
-export declare type UsageRequestDetail = {
+export type UsageRequestDetail = {
     details: {
         usd: number;
         duration: number;

package/dist/types/usageRequestList.d.ts

@@ -1,6 +1,8 @@
 import { UsageRequest } from "./usageRequest";
-export declare type UsageRequestList = {
+export type UsageRequestList = {
     page: number;
     limit: number;
     requests?: Array<UsageRequest>;
+    err_code?: string;
+    err_msg?: string;
 };

package/dist/types/usageRequestListOptions.d.ts

@@ -1,4 +1,4 @@
-export declare type UsageRequestListOptions = {
+export type UsageRequestListOptions = {
     start?: string;
     end?: string;
     page?: number;

package/dist/types/usageRequestMessage.d.ts

@@ -1,3 +1,3 @@
-export declare type UsageRequestMessage = {
+export type UsageRequestMessage = {
     message?: string;
 };

package/dist/types/usageResponse.d.ts

@@ -1,5 +1,5 @@
 import { UsageResponseDetail } from "./usageResponseDetail";
-export declare type UsageResponse = {
+export type UsageResponse = {
     start: string;
     end: string;
     resolution: {
@@ -7,4 +7,6 @@ export declare type UsageResponse = {
         amount: number;
     };
     results: Array<UsageResponseDetail>;
+    err_code?: string;
+    err_msg?: string;
 };

package/dist/types/usageResponseDetail.d.ts

@@ -1,4 +1,4 @@
-export declare type UsageResponseDetail = {
+export type UsageResponseDetail = {
     start: string;
     end: string;
     hours: number;

package/dist/types/utterance.d.ts

@@ -1,5 +1,5 @@
 import { WordBase } from "./wordBase";
-export declare type Utterance = {
+export type Utterance = {
     /**
      * Start time (in seconds) from the beginning of the audio stream.
      */

package/dist/types/warning.d.ts

@@ -0,0 +1,5 @@
+export type Warning = {
+    parameter: string;
+    type: "unsupported_language" | "unsupported_model" | "unsupported_encoding" | "deprecated";
+    message: string;
+};

package/dist/types/wordBase.d.ts

@@ -1,4 +1,4 @@
-export declare type WordBase = {
+export type WordBase = {
     word: string;
     start: number;
     end: number;

package/dist/usage.d.ts

@@ -1,4 +1,4 @@
-import { RequestFunction, UsageField, UsageFieldOptions, UsageOptions, UsageRequest, UsageRequestList, UsageRequestListOptions, UsageResponse, ErrorResponse } from "./types";
+import { RequestFunction, UsageField, UsageFieldOptions, UsageOptions, UsageRequest, UsageRequestList, UsageRequestListOptions, UsageResponse } from "./types";
 export declare class Usage {
     private _credentials;
     private _apiUrl;
@@ -11,9 +11,9 @@ export declare class Usage {
      * @param {UsageRequestListOptions} options Additional filter options
      * @param {string} endpoint Custom API endpoint
      *
-     * @returns {Promise<UsageRequestList | ErrorResponse>}
+     * @returns {Promise<UsageRequestList>}
      */
-    listRequests(projectId: string, options?: UsageRequestListOptions, endpoint?: string): Promise<UsageRequestList | ErrorResponse>;
+    listRequests(projectId: string, options?: UsageRequestListOptions, endpoint?: string): Promise<UsageRequestList>;
     /**
      * Retrieves a specific request associated with the provided project_id.
      * @param {string} projectId Unique identifier of the project
@@ -29,16 +29,16 @@ export declare class Usage {
      * @param {UsageOptions} options Options to filter usage
      * @param {string} endpoint Custom API endpoint
      *
-     * @returns {Promise<UsageResponse | ErrorResponse>}
+     * @returns {Promise<UsageResponse>}
      */
-    getUsage(projectId: string, options?: UsageOptions, endpoint?: string): Promise<UsageResponse | ErrorResponse>;
+    getUsage(projectId: string, options?: UsageOptions, endpoint?: string): Promise<UsageResponse>;
     /**
      * Retrieves features used by the provided project_id based on the provided options.
      * @param {string} projectId Unique identifier of the project
      * @param {UsageFieldOptions} options Options to filter usage
      * @param {string} endpoint Custom API endpoint
      *
-     * @returns {Promise<UsageField | ErrorResponse>}
+     * @returns {Promise<UsageField>}
      */
-    getFields(projectId: string, options?: UsageFieldOptions, endpoint?: string): Promise<UsageField | ErrorResponse>;
+    getFields(projectId: string, options?: UsageFieldOptions, endpoint?: string): Promise<UsageField>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@deepgram/sdk",
-  "version": "2.1.1",
+  "version": "2.3.0",
   "description": "An SDK for the Deepgram automated speech recognition platform",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -60,13 +60,14 @@
     "nyc": "^15.1.0",
     "prettier": "^2.4.1",
     "sinon": "^10.0.0",
-    "ts-node": "^9.1.1",
+    "ts-node": "^10.9.1",
     "typescript": "^4.6.3",
     "webpack": "^5.72.0",
     "webpack-cli": "^4.9.2"
   },
   "dependencies": {
     "bufferutil": "^4.0.6",
+    "dayjs": "^1.11.8",
     "utf-8-validate": "^5.0.9",
     "ws": "^7.5.5"
   }