feat: remove specific error typing from the method definitions (#142)

briancbarrow · web-flow · commit 8fbbee73067b · 2023-06-21T12:41:25.000+01:00
* moved error properties to preRecordedTranscriptionResponse

* removed error response union types.

* removed ErrorResponse from LiveTranscription
diff --git a/src/billing.ts b/src/billing.ts
@@ -1,4 +1,4 @@
-import { BalanceList, Balance, RequestFunction, ErrorResponse } from "./types";
+import { BalanceList, Balance, RequestFunction } from "./types";
 
 export class Billing {
   constructor(
@@ -13,12 +13,12 @@ export class Billing {
    * @param {string} projectId Unique identifier of the project
    * @param {string} endpoint Custom API endpoint
    *
-   * @returns {Promise<BalanceList | ErrorResponse>}
+   * @returns {Promise<BalanceList>}
    */
   async listBalances(
     projectId: string,
     endpoint = "v1/projects"
-  ): Promise<BalanceList | ErrorResponse> {
+  ): Promise<BalanceList> {
     return this._request(
       "GET",
       this._credentials,
@@ -40,7 +40,7 @@ export class Billing {
     projectId: string,
     balanceId: string,
     endpoint = "v1/projects"
-  ): Promise<Balance | ErrorResponse> {
+  ): Promise<Balance> {
     return this._request(
       "GET",
       this._credentials,
diff --git a/src/invitation.ts b/src/invitation.ts
@@ -3,7 +3,6 @@ import {
   InvitationOptions,
   InvitationList,
   RequestFunction,
-  ErrorResponse
 } from "./types";
 
 export class Invitation {
@@ -24,7 +23,7 @@ export class Invitation {
   async list(
     projectId: string,
     endpoint = "v1/projects"
-  ): Promise<InvitationList | ErrorResponse> {
+  ): Promise<InvitationList> {
     return this._request(
       "GET",
       this._credentials,
@@ -46,7 +45,7 @@ export class Invitation {
     projectId: string,
     options: InvitationOptions,
     endpoint = "v1/projects"
-  ): Promise<Message | ErrorResponse> {
+  ): Promise<Message> {
     return this._request(
       "POST",
       this._credentials,
@@ -67,10 +66,7 @@ export class Invitation {
    *
    * @returns {Promise<Message>}
    */
-  async leave(
-    projectId: string,
-    endpoint = "v1/projects"
-  ): Promise<Message | ErrorResponse> {
+  async leave(projectId: string, endpoint = "v1/projects"): Promise<Message> {
     return this._request(
       "DELETE",
       this._credentials,
@@ -93,7 +89,7 @@ export class Invitation {
     projectId: string,
     email: string,
     endpoint = "v1/projects"
-  ): Promise<Message | ErrorResponse> {
+  ): Promise<Message> {
     return this._request(
       "DELETE",
       this._credentials,
diff --git a/src/keys.ts b/src/keys.ts
@@ -4,7 +4,7 @@ import {
   Key,
   KeyResponseObj,
   RequestFunction,
-  ErrorResponse
+  ErrorResponse,
 } from "./types";
 
 export class Keys {
@@ -25,7 +25,7 @@ export class Keys {
   async list(
     projectId: string,
     endpoint = "v1/projects"
-  ): Promise<KeyResponse | ErrorResponse> {
+  ): Promise<KeyResponse> {
     const response = await this._request(
       "GET",
       this._credentials,
@@ -56,7 +56,7 @@ export class Keys {
     projectId: string,
     keyId: string,
     endpoint = "v1/projects"
-  ): Promise<Key | ErrorResponse> {
+  ): Promise<Key> {
     return this._request(
       "GET",
       this._credentials,
@@ -82,7 +82,7 @@ export class Keys {
     scopes: Array<string>,
     options?: CreateKeyOptions,
     endpoint = "v1/projects"
-  ): Promise<Key | ErrorResponse> {
+  ): Promise<Key> {
     /** Throw an error if the user provided both expirationDate and timeToLive */
     if (
       options &&
diff --git a/src/members.ts b/src/members.ts
@@ -1,4 +1,4 @@
-import { MemberList, Message, RequestFunction, ErrorResponse } from "./types";
+import { MemberList, Message, RequestFunction } from "./types";
 
 export class Members {
   constructor(
@@ -13,12 +13,12 @@ export class Members {
    * @param {string} projectId Unique identifier of the project
    * @param {string} endpoint Custom API endpoint
    *
-   * @returns {Promise<MemberList | ErrorResponse>}
+   * @returns {Promise<MemberList>}
    */
   async listMembers(
     projectId: string,
     endpoint = "v1/projects"
-  ): Promise<MemberList | ErrorResponse> {
+  ): Promise<MemberList> {
     return this._request(
       "GET",
       this._credentials,
@@ -34,13 +34,13 @@ export class Members {
    * @param {string} memberId Unique identifier of the member
    * @param {string} endpoint Custom API endpoint
    *
-   * @returns {Promise<Message | ErrorResponse>}
+   * @returns {Promise<Message>}
    */
   async removeMember(
     projectId: string,
     memberId: string,
     endpoint = "v1/projects"
-  ): Promise<Message | ErrorResponse> {
+  ): Promise<Message> {
     return this._request(
       "DELETE",
       this._credentials,
diff --git a/src/projects.ts b/src/projects.ts
@@ -19,12 +19,10 @@ export class Projects {
    * Returns all projects accessible by the API key.
    * @param {string} endpoint Custom API endpoint
    *
-   * @returns {Promise<ProjectResponse | ErrorResponse>}
+   * @returns {Promise<ProjectResponse>}
    */
 
-  async list(
-    endpoint = "v1/projects"
-  ): Promise<ProjectResponse | ErrorResponse> {
+  async list(endpoint = "v1/projects"): Promise<ProjectResponse> {
     return this._request(
       "GET",
       this._credentials,
@@ -39,12 +37,9 @@ export class Projects {
    * @param {string} projectId Unique identifier of the project
    * @param {string} endpoint Custom API endpoint
    *
-   * @returns {Promise<Project | ErrorResponse>}
+   * @returns {Promise<Project>}
    */
-  async get(
-    projectId: string,
-    endpoint = "v1/projects"
-  ): Promise<Project | ErrorResponse> {
+  async get(projectId: string, endpoint = "v1/projects"): Promise<Project> {
     return this._request(
       "GET",
       this._credentials,
@@ -60,13 +55,13 @@ export class Projects {
    * @param {ProjectPatchRequest} payload Details to change as an object
    * @param {string} endpoint Custom API endpoint
    *
-   * @returns {Promise<ProjectPatchResponse | ErrorResponse>}
+   * @returns {Promise<ProjectPatchResponse>}
    */
   async update(
     project: string | Project,
     payload: ProjectPatchRequest,
     endpoint = "v1/projects"
-  ): Promise<ProjectPatchResponse | ErrorResponse> {
+  ): Promise<ProjectPatchResponse> {
     const projectObj = project as Project;
     let projectId = project as string;
 
@@ -89,7 +84,7 @@ export class Projects {
    * @param {string} projectId Unique identifier of the project
    * @param {string} endpoint Custom API endpoint
    *
-   * @returns {Promise<Message | ErrorResponse>}
+   * @returns {Promise<void | ErrorResponse>}
    */
   async delete(
     projectId: string,
diff --git a/src/scopes.ts b/src/scopes.ts
@@ -1,4 +1,4 @@
-import { ScopeList, Message, RequestFunction, ErrorResponse } from "./types";
+import { ScopeList, Message, RequestFunction } from "./types";
 
 export class Scopes {
   constructor(
@@ -14,13 +14,13 @@ export class Scopes {
    * @param {string} memberId Unique identifier of the member
    * @param {string} endpoint Custom API endpoint
    *
-   * @returns {Promise<ScopeList | ErrorResponse>}
+   * @returns {Promise<ScopeList>}
    */
   async get(
     projectId: string,
     memberId: string,
     endpoint = "v1/projects"
-  ): Promise<ScopeList | ErrorResponse> {
+  ): Promise<ScopeList> {
     return this._request(
       "GET",
       this._credentials,
@@ -37,14 +37,14 @@ export class Scopes {
    * @param {string} scope Scope to update the member to
    * @param {string} endpoint Custom API endpoint
    *
-   * @returns {Promise<Message | ErrorResponse>}
+   * @returns {Promise<Message>}
    */
   async update(
     projectID: string,
     memberId: string,
     scope: string,
     endpoint = "v1/projects"
-  ): Promise<Message | ErrorResponse> {
+  ): Promise<Message> {
     return this._request(
       "PUT",
       this._credentials,
diff --git a/src/transcription/index.ts b/src/transcription/index.ts
@@ -3,7 +3,7 @@ import {
   PrerecordedTranscriptionOptions,
   PrerecordedTranscriptionResponse,
   TranscriptionSource,
-  ErrorResponse
+  ErrorResponse,
 } from "../types";
 import { LiveTranscription } from "./liveTranscription";
 import { preRecordedTranscription } from "./preRecordedTranscription";
@@ -21,13 +21,13 @@ export class Transcriber {
    * @param {PrerecordedTranscriptionOptions} options Options used to toggle transcription features
    * @param {string} endpoint Custom API endpoint
    *
-   * @returns {Promise<PrerecordedTranscriptionResponse | ErrorResponse>}
+   * @returns {Promise<PrerecordedTranscriptionResponse>}
    */
   async preRecorded(
     source: TranscriptionSource,
     options?: PrerecordedTranscriptionOptions,
     endpoint?: string
-  ): Promise<PrerecordedTranscriptionResponse | ErrorResponse> {
+  ): Promise<PrerecordedTranscriptionResponse> {
     return await preRecordedTranscription(
       this._credentials,
       this._apiUrl || "",
@@ -43,12 +43,12 @@ export class Transcriber {
    * @param {LiveTranscriptionOptions} options Options used to toggle transcription features
    * @param {string} endpoint Custom API endpoint
    *
-   * @returns {LiveTranscription | ErrorResponse}
+   * @returns {LiveTranscription}
    */
   live(
     options?: LiveTranscriptionOptions,
     endpoint?: string
-  ): LiveTranscription | ErrorResponse {
+  ): LiveTranscription {
     return new LiveTranscription(
       this._credentials,
       this._apiUrl || "",
diff --git a/src/types/balance.ts b/src/types/balance.ts
@@ -3,4 +3,6 @@ export type Balance = {
   amount: number;
   units: string;
   purchase: string;
+  err_code?: string;
+  err_msg?: string;
 };
diff --git a/src/types/balanceList.ts b/src/types/balanceList.ts
@@ -2,4 +2,6 @@ import { Balance } from "./balance";
 
 export type BalanceList = {
   balances?: Array<Balance>;
+  err_code?: string;
+  err_msg?: string;
 };
diff --git a/src/types/invitationList.ts b/src/types/invitationList.ts
@@ -2,4 +2,6 @@ import { InvitationOptions } from "./invitationOptions";
 
 export type InvitationList = {
   invites?: Array<InvitationOptions>;
+  err_code?: string;
+  err_msg?: string;
 };
diff --git a/src/types/key.ts b/src/types/key.ts
@@ -22,4 +22,6 @@ export type Key = {
    * Array of scopes assigned to the key
    */
   scopes: Array<string>;
+  err_code?: string;
+  err_msg?: string;
 };
diff --git a/src/types/keyResponse.ts b/src/types/keyResponse.ts
@@ -8,4 +8,6 @@ export type KeyResponse = {
    * Array of API keys associated with the project
    */
   api_keys: Array<KeyResponseObj>;
+  err_code?: string;
+  err_msg?: string;
 };
diff --git a/src/types/memberList.ts b/src/types/memberList.ts
@@ -2,4 +2,6 @@ import { Member } from "./member";
 
 export type MemberList = {
   members?: Array<Member>;
+  err_code?: string;
+  err_msg?: string;
 };
diff --git a/src/types/message.ts b/src/types/message.ts
@@ -1,3 +1,5 @@
 export type Message = {
   message?: string;
+  err_code?: string;
+  err_msg?: string;
 };
diff --git a/src/types/prerecordedTranscriptionResponse.ts b/src/types/prerecordedTranscriptionResponse.ts
@@ -5,6 +5,8 @@ import { secondsToTimestamp } from "../helpers";
 import { WordBase } from "./wordBase";
 
 export class PrerecordedTranscriptionResponse {
+  err_code?: string;
+  err_msg?: string;
   request_id?: string;
   metadata?: Metadata;
   results?: {
diff --git a/src/types/project.ts b/src/types/project.ts
@@ -14,4 +14,6 @@ export type Project = {
    * Name of the company associated with the project. Optional.
    */
   company?: string;
+  err_code?: string;
+  err_msg?: string;
 };
diff --git a/src/types/projectPatchResponse.ts b/src/types/projectPatchResponse.ts
@@ -3,4 +3,6 @@ export type ProjectPatchResponse = {
    * Success message.
    */
   message: string;
+  err_code?: string;
+  err_msg?: string;
 };
diff --git a/src/types/projectResponse.ts b/src/types/projectResponse.ts
@@ -2,4 +2,6 @@ import { Project } from "./project";
 
 export type ProjectResponse = {
   projects: Array<Project>;
+  err_code?: string;
+  err_msg?: string;
 };
diff --git a/src/types/scopeList.ts b/src/types/scopeList.ts
@@ -1,3 +1,5 @@
 export type ScopeList = {
   scopes: Array<string>;
+  err_code?: string;
+  err_msg?: string;
 };
diff --git a/src/types/usageField.ts b/src/types/usageField.ts
@@ -4,4 +4,6 @@ export type UsageField = {
   processing_methods: Array<string>;
   languages: Array<string>;
   features: Array<string>;
+  err_code?: string;
+  err_msg?: string;
 };
diff --git a/src/types/usageRequest.ts b/src/types/usageRequest.ts
@@ -9,4 +9,6 @@ export type UsageRequest = {
   accessor: string;
   response?: UsageRequestDetail | UsageRequestMessage;
   callback?: UsageCallback;
+  err_code?: string;
+  err_msg?: string;
 };
diff --git a/src/types/usageRequestList.ts b/src/types/usageRequestList.ts
@@ -4,4 +4,6 @@ export type UsageRequestList = {
   page: number;
   limit: number;
   requests?: Array<UsageRequest>;
+  err_code?: string;
+  err_msg?: string;
 };
diff --git a/src/types/usageResponse.ts b/src/types/usageResponse.ts
@@ -8,4 +8,6 @@ export type UsageResponse = {
     amount: number;
   };
   results: Array<UsageResponseDetail>;
+  err_code?: string;
+  err_msg?: string;
 };
diff --git a/src/usage.ts b/src/usage.ts
