@deepgram/sdk 2.1.1 → 2.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (65) hide show
  1. package/README.md +251 -361
  2. package/dist/billing.d.ts +4 -4
  3. package/dist/helpers/secondsToTimestamp.d.ts +1 -1
  4. package/dist/httpRequest.d.ts +1 -0
  5. package/dist/index.js +1 -1
  6. package/dist/invitation.d.ts +5 -5
  7. package/dist/keys.d.ts +3 -3
  8. package/dist/members.d.ts +5 -5
  9. package/dist/projects.d.ts +8 -8
  10. package/dist/scopes.d.ts +5 -5
  11. package/dist/transcription/index.d.ts +5 -5
  12. package/dist/transcription/preRecordedTranscription.d.ts +1 -1
  13. package/dist/types/alternatives.d.ts +1 -1
  14. package/dist/types/balance.d.ts +3 -1
  15. package/dist/types/balanceList.d.ts +3 -1
  16. package/dist/types/channel.d.ts +1 -1
  17. package/dist/types/createKeyOptions.d.ts +1 -1
  18. package/dist/types/entity.d.ts +1 -1
  19. package/dist/types/error.d.ts +1 -1
  20. package/dist/types/hit.d.ts +1 -1
  21. package/dist/types/invitationList.d.ts +3 -1
  22. package/dist/types/invitationOptions.d.ts +1 -1
  23. package/dist/types/key.d.ts +3 -1
  24. package/dist/types/keyResponse.d.ts +3 -1
  25. package/dist/types/keyResponseObj.d.ts +1 -1
  26. package/dist/types/keyword.d.ts +1 -1
  27. package/dist/types/liveTranscriptionOptions.d.ts +1 -1
  28. package/dist/types/liveTranscriptionResponse.d.ts +1 -1
  29. package/dist/types/member.d.ts +1 -1
  30. package/dist/types/memberList.d.ts +3 -1
  31. package/dist/types/message.d.ts +3 -1
  32. package/dist/types/metadata.d.ts +9 -1
  33. package/dist/types/paragraph.d.ts +1 -1
  34. package/dist/types/paragraphGroup.d.ts +1 -1
  35. package/dist/types/prerecordedTranscriptionOptions.d.ts +2 -2
  36. package/dist/types/prerecordedTranscriptionResponse.d.ts +13 -10
  37. package/dist/types/project.d.ts +3 -1
  38. package/dist/types/projectPatchRequest.d.ts +1 -1
  39. package/dist/types/projectPatchResponse.d.ts +3 -1
  40. package/dist/types/projectResponse.d.ts +3 -1
  41. package/dist/types/requestFunction.d.ts +4 -3
  42. package/dist/types/scopeList.d.ts +3 -1
  43. package/dist/types/search.d.ts +1 -1
  44. package/dist/types/sentence.d.ts +1 -1
  45. package/dist/types/summary.d.ts +1 -1
  46. package/dist/types/toggleConfigOptions.d.ts +1 -1
  47. package/dist/types/topic.d.ts +1 -1
  48. package/dist/types/topicGroup.d.ts +1 -1
  49. package/dist/types/transcriptionSource.d.ts +5 -4
  50. package/dist/types/translation.d.ts +1 -1
  51. package/dist/types/usageCallback.d.ts +1 -1
  52. package/dist/types/usageField.d.ts +3 -1
  53. package/dist/types/usageFieldOptions.d.ts +1 -1
  54. package/dist/types/usageOptions.d.ts +2 -2
  55. package/dist/types/usageRequest.d.ts +3 -1
  56. package/dist/types/usageRequestDetail.d.ts +1 -1
  57. package/dist/types/usageRequestList.d.ts +3 -1
  58. package/dist/types/usageRequestListOptions.d.ts +1 -1
  59. package/dist/types/usageRequestMessage.d.ts +1 -1
  60. package/dist/types/usageResponse.d.ts +3 -1
  61. package/dist/types/usageResponseDetail.d.ts +1 -1
  62. package/dist/types/utterance.d.ts +1 -1
  63. package/dist/types/wordBase.d.ts +1 -1
  64. package/dist/usage.d.ts +7 -7
  65. package/package.json +3 -2
package/dist/types/wordBase.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- export declare type WordBase = {
1
+ export type WordBase = {
2
2
  word: string;
3
3
  start: number;
4
4
  end: number;
package/dist/usage.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { RequestFunction, UsageField, UsageFieldOptions, UsageOptions, UsageRequest, UsageRequestList, UsageRequestListOptions, UsageResponse, ErrorResponse } from "./types";
1
+ import { RequestFunction, UsageField, UsageFieldOptions, UsageOptions, UsageRequest, UsageRequestList, UsageRequestListOptions, UsageResponse } from "./types";
2
2
  export declare class Usage {
3
3
  private _credentials;
4
4
  private _apiUrl;
@@ -11,9 +11,9 @@ export declare class Usage {
11
11
  * @param {UsageRequestListOptions} options Additional filter options
12
12
  * @param {string} endpoint Custom API endpoint
13
13
  *
14
- * @returns {Promise<UsageRequestList | ErrorResponse>}
14
+ * @returns {Promise<UsageRequestList>}
15
15
  */
16
- listRequests(projectId: string, options?: UsageRequestListOptions, endpoint?: string): Promise<UsageRequestList | ErrorResponse>;
16
+ listRequests(projectId: string, options?: UsageRequestListOptions, endpoint?: string): Promise<UsageRequestList>;
17
17
  /**
18
18
  * Retrieves a specific request associated with the provided project_id.
19
19
  * @param {string} projectId Unique identifier of the project
@@ -29,16 +29,16 @@ export declare class Usage {
29
29
  * @param {UsageOptions} options Options to filter usage
30
30
  * @param {string} endpoint Custom API endpoint
31
31
  *
32
- * @returns {Promise<UsageResponse | ErrorResponse>}
32
+ * @returns {Promise<UsageResponse>}
33
33
  */
34
- getUsage(projectId: string, options?: UsageOptions, endpoint?: string): Promise<UsageResponse | ErrorResponse>;
34
+ getUsage(projectId: string, options?: UsageOptions, endpoint?: string): Promise<UsageResponse>;
35
35
  /**
36
36
  * Retrieves features used by the provided project_id based on the provided options.
37
37
  * @param {string} projectId Unique identifier of the project
38
38
  * @param {UsageFieldOptions} options Options to filter usage
39
39
  * @param {string} endpoint Custom API endpoint
40
40
  *
41
- * @returns {Promise<UsageField | ErrorResponse>}
41
+ * @returns {Promise<UsageField>}
42
42
  */
43
- getFields(projectId: string, options?: UsageFieldOptions, endpoint?: string): Promise<UsageField | ErrorResponse>;
43
+ getFields(projectId: string, options?: UsageFieldOptions, endpoint?: string): Promise<UsageField>;
44
44
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@deepgram/sdk",
3
- "version": "2.1.1",
3
+ "version": "2.2.0",
4
4
  "description": "An SDK for the Deepgram automated speech recognition platform",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -60,13 +60,14 @@
60
60
  "nyc": "^15.1.0",
61
61
  "prettier": "^2.4.1",
62
62
  "sinon": "^10.0.0",
63
- "ts-node": "^9.1.1",
63
+ "ts-node": "^10.9.1",
64
64
  "typescript": "^4.6.3",
65
65
  "webpack": "^5.72.0",
66
66
  "webpack-cli": "^4.9.2"
67
67
  },
68
68
  "dependencies": {
69
69
  "bufferutil": "^4.0.6",
70
+ "dayjs": "^1.11.8",
70
71
  "utf-8-validate": "^5.0.9",
71
72
  "ws": "^7.5.5"
72
73
  }