-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
19 changed files
with
632 additions
and
54 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,150 @@ | ||
import { CreateRoomParams, CreateRoomResponse } from './createRoom.ts'; | ||
import { JoinTokenParams, JoinTokenResponse } from './joinToken.ts'; | ||
import { IsRoomActiveParams, IsRoomActiveResponse } from './isRoomActive.ts'; | ||
import { | ||
ActiveRoomInfoParams, | ||
ActiveRoomInfoResponse, | ||
} from './activeRoomInfo.ts'; | ||
import { ActiveRoomsInfoResponse } from './activeRoomsInfo.ts'; | ||
import { | ||
FetchPastRoomsInfoParams, | ||
FetchRoomsInfoResponse, | ||
} from './fetchPastRoomsInfo.ts'; | ||
import { EndRoomParams, EndRoomResponse } from './endRoom.ts'; | ||
import { | ||
FetchAnalyticsParams, | ||
FetchAnalyticsResponse, | ||
} from './fetchAnalytics.ts'; | ||
import { | ||
DeleteAnalyticsParams, | ||
DeleteAnalyticsResponse, | ||
} from './deleteAnalytics.ts'; | ||
import { | ||
AnalyticsDownloadTokenParams, | ||
AnalyticsDownloadTokenResponse, | ||
} from './analyticsDownloadToken.ts'; | ||
import { | ||
FetchRecordingsParams, | ||
FetchRecordingsResponse, | ||
} from './fetchRecordings.ts'; | ||
import { | ||
DeleteRecordingsParams, | ||
DeleteRecordingsResponse, | ||
} from './deleteRecordings.ts'; | ||
import { | ||
RecordingDownloadTokenParams, | ||
RecordingDownloadTokenResponse, | ||
} from './recordingDownloadToken.ts'; | ||
import { ClientFilesResponse } from './clientFiles.ts'; | ||
|
||
export interface PlugNmeetAPI { | ||
/** | ||
* Create new room | ||
* @param params | ||
* @returns Promise<CreateRoomResponse> | ||
*/ | ||
createRoom(params: CreateRoomParams): Promise<CreateRoomResponse>; | ||
|
||
/** | ||
* Generate join token | ||
* @param params | ||
* @returns Promise<JoinTokenResponse> | ||
*/ | ||
getJoinToken(params: JoinTokenParams): Promise<JoinTokenResponse>; | ||
|
||
/** | ||
* If room is active or not | ||
* @param params | ||
* @returns Promise<IsRoomActiveResponse> | ||
*/ | ||
isRoomActive(params: IsRoomActiveParams): Promise<IsRoomActiveResponse>; | ||
|
||
/** | ||
* Get active room information | ||
* @param params | ||
* @returns Promise<ActiveRoomInfoResponse> | ||
*/ | ||
getActiveRoomInfo( | ||
params: ActiveRoomInfoParams, | ||
): Promise<ActiveRoomInfoResponse>; | ||
|
||
/** | ||
* Get all active rooms | ||
* @returns Promise<ActiveRoomsInfoResponse> | ||
*/ | ||
getActiveRoomsInfo(): Promise<ActiveRoomsInfoResponse>; | ||
|
||
/** | ||
* Fetch info about past rooms | ||
* @param params | ||
* @returns Promise<FetchRoomsInfoResponse> | ||
*/ | ||
fetchPastRoomsInfo( | ||
params: FetchPastRoomsInfoParams, | ||
): Promise<FetchRoomsInfoResponse>; | ||
|
||
/** | ||
* End active room | ||
* @param params | ||
* @returns Promise<EndRoomResponse> | ||
*/ | ||
endRoom(params: EndRoomParams): Promise<EndRoomResponse>; | ||
|
||
/** | ||
* Fetch analytics | ||
* @param params | ||
* @returns Promise<FetchAnalyticsResponse> | ||
*/ | ||
fetchAnalytics(params: FetchAnalyticsParams): Promise<FetchAnalyticsResponse>; | ||
|
||
/** | ||
* Delete analytics | ||
* @param params | ||
* @returns Promise<DeleteAnalyticsResponse> | ||
*/ | ||
deleteAnalytics( | ||
params: DeleteAnalyticsParams, | ||
): Promise<DeleteAnalyticsResponse>; | ||
|
||
/** | ||
* Generate token to download recording | ||
* @param params | ||
* @returns Promise<AnalyticsDownloadTokenResponse> | ||
*/ | ||
getAnalyticsDownloadToken( | ||
params: AnalyticsDownloadTokenParams, | ||
): Promise<AnalyticsDownloadTokenResponse>; | ||
|
||
/** | ||
* Fetch recordings | ||
* @param params | ||
* @returns Promise<FetchRecordingsResponse> | ||
*/ | ||
fetchRecordings( | ||
params: FetchRecordingsParams, | ||
): Promise<FetchRecordingsResponse>; | ||
|
||
/** | ||
* Delete recording | ||
* @param params | ||
* @returns Promise<DeleteRecordingsResponse> | ||
*/ | ||
deleteRecordings( | ||
params: DeleteRecordingsParams, | ||
): Promise<DeleteRecordingsResponse>; | ||
|
||
/** | ||
* Generate token to download recording | ||
* @param params | ||
* @returns Promise<RecordingDownloadTokenResponse> | ||
*/ | ||
getRecordingDownloadToken( | ||
params: RecordingDownloadTokenParams, | ||
): Promise<RecordingDownloadTokenResponse>; | ||
|
||
/** | ||
* To get JS & CSS files to build interface | ||
* @returns Promise<ClientFilesResponse> | ||
*/ | ||
getClientFiles(): Promise<ClientFilesResponse>; | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
export type AnalyticsDownloadTokenParams = { | ||
file_id: string; | ||
}; | ||
|
||
export type AnalyticsDownloadTokenResponse = { | ||
status: boolean; | ||
msg: string; | ||
token?: string; | ||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
export type DeleteAnalyticsParams = { | ||
file_id: string; | ||
}; | ||
|
||
export type DeleteAnalyticsResponse = { | ||
status: boolean; | ||
msg: string; | ||
}; |
Oops, something went wrong.