zaccl 3.0.17 → 4.0.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 (70) hide show
  1. package/docs/ECatCloudRecording.js.html +74 -27
  2. package/docs/ECatGroup.js.html +207 -0
  3. package/docs/ECatMeeting.js.html +76 -11
  4. package/docs/ECatUser.js.html +7 -10
  5. package/docs/ECatWebinar.js.html +6 -5
  6. package/docs/api.cloudRecording.html +371 -48
  7. package/docs/api.group.html +367 -0
  8. package/docs/api.meeting.html +437 -15
  9. package/docs/api.user.html +10 -10
  10. package/docs/api.webinar.html +5 -5
  11. package/docs/index.html +1 -1
  12. package/lib/endpoints/ECatCloudRecording.d.ts +33 -9
  13. package/lib/endpoints/ECatCloudRecording.js +73 -26
  14. package/lib/endpoints/ECatCloudRecording.js.map +1 -1
  15. package/lib/endpoints/ECatGroup.d.ts +39 -0
  16. package/lib/endpoints/ECatGroup.js +142 -0
  17. package/lib/endpoints/ECatGroup.js.map +1 -0
  18. package/lib/endpoints/ECatMeeting.d.ts +40 -10
  19. package/lib/endpoints/ECatMeeting.js +75 -10
  20. package/lib/endpoints/ECatMeeting.js.map +1 -1
  21. package/lib/endpoints/ECatUser.d.ts +5 -5
  22. package/lib/endpoints/ECatUser.js +6 -9
  23. package/lib/endpoints/ECatUser.js.map +1 -1
  24. package/lib/endpoints/ECatWebinar.d.ts +4 -4
  25. package/lib/endpoints/ECatWebinar.js +5 -4
  26. package/lib/endpoints/ECatWebinar.js.map +1 -1
  27. package/lib/index.d.ts +22 -0
  28. package/lib/index.js +19 -0
  29. package/lib/index.js.map +1 -1
  30. package/lib/shared/helpers/genVisitEndpoint.js +60 -17
  31. package/lib/shared/helpers/genVisitEndpoint.js.map +1 -1
  32. package/lib/shared/types/VisitEndpointFunc.d.ts +2 -1
  33. package/lib/types/ZoomAPI.d.ts +2 -0
  34. package/lib/types/ZoomAPI.js.map +1 -1
  35. package/lib/types/ZoomGroup.d.ts +10 -0
  36. package/lib/types/ZoomGroup.js +3 -0
  37. package/lib/types/ZoomGroup.js.map +1 -0
  38. package/lib/types/ZoomGroupMember.d.ts +12 -0
  39. package/lib/types/ZoomGroupMember.js +3 -0
  40. package/lib/types/ZoomGroupMember.js.map +1 -0
  41. package/lib/types/ZoomMeetingRecordings.d.ts +1 -0
  42. package/lib/types/ZoomMeetingTranscript.d.ts +17 -0
  43. package/lib/types/ZoomMeetingTranscript.js +3 -0
  44. package/lib/types/ZoomMeetingTranscript.js.map +1 -0
  45. package/lib/types/ZoomPastMeetingDetails.d.ts +22 -0
  46. package/lib/types/ZoomPastMeetingDetails.js +3 -0
  47. package/lib/types/ZoomPastMeetingDetails.js.map +1 -0
  48. package/lib/types/ZoomPastMeetingParticipant.d.ts +18 -0
  49. package/lib/types/ZoomPastMeetingParticipant.js +3 -0
  50. package/lib/types/ZoomPastMeetingParticipant.js.map +1 -0
  51. package/lib/types/ZoomRecordingInAccount.d.ts +22 -0
  52. package/lib/types/ZoomRecordingInAccount.js +3 -0
  53. package/lib/types/ZoomRecordingInAccount.js.map +1 -0
  54. package/package.json +2 -2
  55. package/src/endpoints/ECatCloudRecording.ts +86 -30
  56. package/src/endpoints/ECatGroup.ts +89 -0
  57. package/src/endpoints/ECatMeeting.ts +81 -10
  58. package/src/endpoints/ECatUser.ts +6 -9
  59. package/src/endpoints/ECatWebinar.ts +5 -4
  60. package/src/index.ts +53 -0
  61. package/src/shared/helpers/genVisitEndpoint.ts +123 -79
  62. package/src/shared/types/VisitEndpointFunc.ts +4 -2
  63. package/src/types/ZoomAPI.ts +2 -0
  64. package/src/types/ZoomGroup.ts +14 -0
  65. package/src/types/ZoomGroupMember.ts +20 -0
  66. package/src/types/ZoomMeetingRecordings.ts +2 -0
  67. package/src/types/ZoomMeetingTranscript.ts +28 -0
  68. package/src/types/ZoomPastMeetingDetails.ts +38 -0
  69. package/src/types/ZoomPastMeetingParticipant.ts +30 -0
  70. package/src/types/ZoomRecordingInAccount.ts +38 -0
@@ -0,0 +1,28 @@
1
+ /**
2
+ * Transcript for a specific zoom meeting instance
3
+ * @author Gabe Abrams
4
+ */
5
+ type ZoomMeetingTranscript = {
6
+ // The meeting ID
7
+ meeting_id: string,
8
+ // The user account's unique identifier.
9
+ account_id: string,
10
+ // The meeting topic.
11
+ meeting_topic: string,
12
+ // ID of the user set as the host of the meeting.
13
+ host_id: string,
14
+ // The date and time that the meeting's transcript was created.
15
+ transcript_created_time: string,
16
+ // Whether the meeting transcript is available for download.
17
+ can_download: boolean,
18
+ // Auto-delete status of a meeting's transcript
19
+ auto_delete: boolean,
20
+ // The date when the recording will be auto-deleted when `auto_delete` is true.
21
+ auto_delete_date: string,
22
+ // The URL to download the transcript. Present only when `can_download` is `true`.
23
+ download_url: string | null,
24
+ // The reason why the transcript cannot be downloaded when `can_download` is `false`.
25
+ download_restriction_reason: 'DELETED_OR_TRASHED' | 'UNSUPPORTED' | 'NO_TRANSCRIPT_DATA' | 'NOT_READY' | null,
26
+ };
27
+
28
+ export default ZoomMeetingTranscript;
@@ -0,0 +1,38 @@
1
+ /**
2
+ * Details about a past meeting
3
+ * @author Gabe Abrams
4
+ */
5
+ type ZoomPastMeetingDetails = {
6
+ // The meeting ID,
7
+ id: number,
8
+ // The meeting's UUID
9
+ uuid: string,
10
+ // The meeting's duration, in minutes
11
+ duration: number,
12
+ // The meeting's start date and time
13
+ start_time: string,
14
+ // The meeting's end date and time
15
+ end_time: string,
16
+ // The host's ID
17
+ host_id: string,
18
+ // The meeting host's department
19
+ dept: string,
20
+ // The number of meeting participants
21
+ participants_count: number,
22
+ // Whether the meeting was created directly through Zoom or via an API request
23
+ source: string,
24
+ // The meeting's topic
25
+ topic: string,
26
+ // The total number of minutes attended by the meeting's host and participants
27
+ total_minutes: number,
28
+ // The meeting type (0-4, 7-8)
29
+ type: 0 | 1 | 2 | 3 | 4 | 7 | 8,
30
+ // The user's email address
31
+ user_email: string,
32
+ // The user's display name
33
+ user_name: string,
34
+ // Whether the summary feature was used in the meeting
35
+ has_meeting_summary: boolean,
36
+ };
37
+
38
+ export default ZoomPastMeetingDetails;
@@ -0,0 +1,30 @@
1
+ /**
2
+ * Represents a participant in a Zoom past meeting.
3
+ * @author Gabe Abrams
4
+ */
5
+ type ZoomPastMeetingParticipant = {
6
+ // Unique identifier for the participant
7
+ id?: string;
8
+ // Display name of the participant
9
+ name?: string;
10
+ // Zoom user ID of the participant
11
+ user_id?: string;
12
+ // Registration ID if participant registered beforehand
13
+ registrant_id?: string;
14
+ // Email address of the participant
15
+ user_email?: string;
16
+ // ISO 8601 timestamp when participant joined the meeting
17
+ join_time?: string;
18
+ // ISO 8601 timestamp when participant left the meeting
19
+ leave_time?: string;
20
+ // Duration in seconds that the participant was in the meeting
21
+ duration?: number;
22
+ // Indicates if participant connected via failover
23
+ failover?: boolean;
24
+ // Current status of the participant in the meeting
25
+ status?: 'in_meeting' | 'in_waiting_room';
26
+ // Indicates if the participant is an internal Zoom user
27
+ internal_user?: boolean;
28
+ };
29
+
30
+ export default ZoomPastMeetingParticipant;
@@ -0,0 +1,38 @@
1
+ import ZoomRecordingFile from './ZoomRecordingFile';
2
+
3
+ /**
4
+ * A single recording in an account
5
+ * @author Gabe Abrams
6
+ */
7
+ type ZoomRecordingInAccount = {
8
+ // The meeting's scheduled duration
9
+ duration: number,
10
+ // The meeting host's user ID
11
+ host_id: string,
12
+ // The meeting's ID
13
+ id: number,
14
+ // The total number of recordings retrieved from the account
15
+ recording_count: number,
16
+ // The information about the recording files
17
+ recording_files: ZoomRecordingFile[],
18
+ // The date and time when the meeting started
19
+ start_time: string,
20
+ // The meeting's topic
21
+ topic: string,
22
+ // The total size of the recording file, in bytes
23
+ total_size: number,
24
+ // The recording's associated type of meeting or webinar
25
+ type: number,
26
+ // The meeting's universally unique ID
27
+ uuid: string,
28
+ // Recording zone used in the Zoom Node Platform
29
+ rc_zone?: string,
30
+ // The unique ID for the hybrid recorder or recording connector
31
+ instance_id?: string,
32
+ // The name of the Zoom Node Service
33
+ service_name?: string,
34
+ // NFS address
35
+ external_storage_addr?: string,
36
+ };
37
+
38
+ export default ZoomRecordingInAccount;