Skip to content

Commit

Permalink
Merge pull request #46 from aneeshafedo/slalpha5-zoom
Browse files Browse the repository at this point in the history 
Revamp optional parameters in Zoom connector (slalpha5)
  • Loading branch information
@indikasampath2000
indikasampath2000 authored Jul 3, 2021
2 parents 4ebf7a3 + b7c1d3b commit 6f8208b
Show file tree
Hide file tree
Showing 2 changed files with 54 additions and 42 deletions.
52 changes: 30 additions & 22 deletions openapi/zoom/client.bal
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,16 +23,19 @@ public type ClientConfig record {
http:ClientSecureSocket secureSocketConfig?;
};

# List of meetings
public type CompoundListMeetingsResponse record {
*PaginationObject;
*MeetingList;
};

# Response received from meeting creation
public type CompoundCreateMeetingResponse record {
*MeetingMetadata;
*RequestedMeetingDetails;
};

# List of meeting registrants
public type CompoundListMeetingRegistrantsResponse record {
*PaginationObject;
*RegistrantsList;
Expand All @@ -51,9 +54,9 @@ public type CompoundAddMeetingRegistrantRequest record {
# Custom questions.
RegistrantCustomQuestion[] custom_questions?;
# A valid email address of the registrant.
string email?;
string email;
# Registrant's first name.
string first_name?;
string first_name;
# Registrant's Industry.
string industry?;
# Registrant's job title.
Expand All @@ -79,7 +82,7 @@ public type CompoundAddMeetingRegistrantRequest record {
# Add meeting registrant respond
public type AddMeetingRegistrantResponse record {
# [Meeting ID](https://support.zoom.us/hc/en-us/articles/201362373-What-is-a-Meeting-ID-): Unique identifier of the meeting in "**long**" format(represented as int64 data type in JSON), also known as the meeting number.
int id?;
int id;
# Unique URL for this registrant to join the meeting. This URL should only be shared with the registrant for whom the API request was made.
string join_url?;
# Unique identifier of the registrant.
Expand All @@ -90,13 +93,15 @@ public type AddMeetingRegistrantResponse record {
string topic?;
};

# Meeting registrant update request
public type UpdateMeetingRegistrantStatusRequest record {
# Registrant Status:<br>`approve` - Approve registrant.<br>`cancel` - Cancel previously approved registrant's registration.<br>`deny` - Deny registrant.
string action;
# List of registrants.
RestriantDetails[] registrants?;
SimplifiedRegistrantDetails[] registrants?;
};

# Meeting details
public type CompoundGetMeetingByIdResponse record {
*MeetingFullMetadata;
*RequestedMeetingDetails;
Expand Down Expand Up @@ -136,16 +141,16 @@ public type UpdateMeetingStatusRequest record {
string action?;
};

# **HTTP Status Code:** `200`. List of ended meeting instances returned.
# List of ended meeting instances returned. **HTTP Status Code:** `200`.
public type ListPastMeetingsResponse record {
# List of ended meeting instances.
EndedMeetingDetails[] meetings?;
};

# **HTTP Status Code:** `200` **OK**. Polls returned successfully.
# Polls returned successfully. **HTTP Status Code:** `200` **OK**.
public type ListPastMeetingPollsResponse record {
# [Meeting ID](https://support.zoom.us/hc/en-us/articles/201362373-What-is-a-Meeting-ID-): Unique identifier of the meeting in "**long**" format(represented as int64 data type in JSON), also known as the meeting number.
int id?;
int id;
# Answers submitted by users.
UserSubmittedAnswers[] questions?;
# The start time of the meeting.
Expand All @@ -154,7 +159,7 @@ public type ListPastMeetingPollsResponse record {
string uuid?;
};

# **HTTP Status Code:** `200`. Meeting details returned.
# Meeting details returned. **HTTP Status Code:** `200`.
public type GetPastMeetingDetailsResponse record {
# Meeting duration.
int duration?;
Expand All @@ -163,7 +168,7 @@ public type GetPastMeetingDetailsResponse record {
# Host ID.
string host_id?;
# [Meeting ID](https://support.zoom.us/hc/en-us/articles/201362373-What-is-a-Meeting-ID-): Unique identifier of the meeting in "**long**" format(represented as int64 data type in JSON), also known as the meeting number.
int id?;
int id;
# Number of meeting participants.
int participants_count?;
# Meeting start time (GMT).
Expand All @@ -182,12 +187,13 @@ public type GetPastMeetingDetailsResponse record {
string uuid?;
};

# List of past meeting participants
public type CompoundListPastMeetingParticipantsResponse record {
*PaginationObject;
*MeetingPartcipantsList;
};

# **HTTP Status Code:**. List polls of a Meeting returned
# List polls of a Meeting returned. **HTTP Status Code:**.
public type GetMeetingPollsResponse record {
# Array of Polls
PollDetails[] polls?;
Expand All @@ -203,7 +209,7 @@ public type CreateMeetingPollRequest record {
string title?;
};

# Poll
# Response received from poll creation
public type CompoundCreateMeetingPollResponse record {
# Meeting Poll ID
string id?;
Expand All @@ -215,7 +221,7 @@ public type CompoundCreateMeetingPollResponse record {
string title?;
};

# Poll
# Meeting poll details
public type CompoundGetMeetingPollResponse record {
# Meeting Poll ID
string id?;
Expand All @@ -227,54 +233,55 @@ public type CompoundGetMeetingPollResponse record {
string title?;
};

# Poll
# Updated poll request
public type CompoundUpdateMeetingPollRequest record {
# Array of Polls
PollQuestions[] questions?;
# Title for the poll.
string title?;
};

# Batch Meeting poll object
# Batch meeting poll object
public type CreateBatchPollsRequest record {
# Array of Poll Questions
PollQuestions[] questions?;
# Meeting Poll Title.
string title?;
};

# **HTTP Status Code:** `201`. Meeting Poll Created
# Meeting poll created. **HTTP Status Code:** `201`.
public type CreateBatchPollsResponse record {
# create batch poll response
AddPollQuestionsResponse[] polls?;
};

# **HTTP Status Code:** `200`<br>
# Meeting invitation. **HTTP Status Code:** `200`.
public type GetMeetingInvitationResponse record {
# Meeting invitation.
string invitation?;
};

# **HTTP Status Code:** `200` **OK**. Live Stream details returned.
# Live Stream details returned. **HTTP Status Code:** `200` **OK**.
public type GetLiveStreamDetailsResponse record {
# Live streaming page URL. This is the URL using which anyone can view the live stream of the meeting.
string page_url?;
# Stream Key.
string stream_key?;
string stream_key;
# Stream URL.
string stream_url?;
string stream_url;
};

# Meeting
# Meeting live stream update request.
public type UpdateMeetingLiveStreamRequest record {
# The livestream page URL.
string page_url?;
string page_url;
# Stream name and key.
string stream_key;
# Streaming URL.
string stream_url;
};

# List of webinar registrants
public type CompoundListWebinarRegistrantsResponse record {
*PaginationObject;
*RegistrantsList;
Expand All @@ -294,12 +301,13 @@ public type ListWebinarParticipantsResponse record {
int total_records?;
};

# List of webinar absentees
public type CompoundListWebinarAbsenteesResponse record {
*PaginationObject;
*RegistrantsList;
};

# **HTTP Status Code:** `200` **OK**
# List of meeting templates. **HTTP Status Code:** `200` **OK**
public type ListMeetingTemplatesResponse record {
# template details
TemplateDetails[] templates?;
Expand Down
44 changes: 24 additions & 20 deletions openapi/zoom/types.bal
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
// specific language governing permissions and limitations
// under the License.

# Meeting tracking details
public type RequestedMeetingTrackingDetails record {
# Label of the tracking field.
string 'field?;
Expand All @@ -23,6 +24,7 @@ public type RequestedMeetingTrackingDetails record {
boolean visible?;
};

# Meeting tracking fields
public type TrackingFields record {
# Tracking fields type
string 'field?;
Expand All @@ -36,6 +38,7 @@ public type RegistrantsList record {
RegistrantDetails[] registrants?;
};

# Interpreter details
public type InterpreterDetails record {
# Email address of the interpreter.
string email?;
Expand Down Expand Up @@ -78,9 +81,9 @@ public type PollQuestions record {
# Possible answers for the question.
string[] answers?;
# Name of the question.
string name?;
string name;
# Question type:<br>`single` - Single choice<br>`mutliple` - Multiple choice
string 'type?;
string 'type;
};

# Webinar participant's details
Expand Down Expand Up @@ -116,9 +119,9 @@ public type RegistrantDetails record {
# Custom questions.
RegistrantCustomQuestion[] custom_questions?;
# A valid email address of the registrant.
string email?;
string email;
# Registrant's first name.
string first_name?;
string first_name;
# Registrant's Industry.
string industry?;
# Registrant's job title.
Expand Down Expand Up @@ -160,7 +163,7 @@ public type MeetingOccurenceDetails record {
};

# Registrant's details
public type RestriantDetails record {
public type SimplifiedRegistrantDetails record {
# Registrant email
string email?;
# Registrant Id
Expand All @@ -182,9 +185,9 @@ public type PollQuestionAnswer record {
# Date and time at which the answer to the poll was submitted.
string date_time?;
# Unique identifier of the poll.
string polling_id?;
string polling_id;
# Question asked during the poll.
string question?;
string question;
};

public type GlobalDialInNumbersDetails record {
Expand All @@ -195,7 +198,7 @@ public type GlobalDialInNumbersDetails record {
# Full name of country. For example, Brazil.
string country_name?;
# Phone number. For example, +1 2332357613.
string number?;
string number;
# Type of number.
string 'type?;
};
Expand All @@ -211,7 +214,7 @@ public type LanguageInterpretationDetails record {
# Meeting participant's details
public type ParticipantDetails record {
# Email address of the participant.
string email?;
string email;
# Name of the participant.
string name?;
};
Expand All @@ -221,31 +224,31 @@ public type RequestedMeetingDetails record {
# Agenda
string agenda?;
# The date and time at which this meeting was created.
string created_at?;
string created_at;
# Meeting duration.
int duration?;
# H.323/SIP room system password
string h323_password?;
# URL for participants to join the meeting. This URL should only be shared with users that you would like to invite for the meeting.
string join_url?;
string join_url;
# Array of occurrence objects.
MeetingOccurenceDetails[] occurrences?;
# Meeting password. Password may only contain the following characters: `[a-z A-Z 0-9 @ - _ * !]`
string password?;
string password;
# Personal Meeting Id. Only used for scheduled meetings and recurring meetings with no fixed time.
int pmi?;
# Recurrence related meeting informations
ReccurenceDetails recurrence?;
# Meeting settings
MeetingSettings settings?;
# Meeting start date-time in UTC/GMT. Example: "2020-03-31T12:02:00Z"
string start_time?;
string start_time;
# URL to start the meeting. This URL should only be used by the host of the meeting and **should not be shared with anyone other than the host** of the meeting as anyone with this URL will be able to login to the Zoom Client as the host of the meeting.
string start_url?;
# Timezone to format start_time
string timezone?;
# Meeting topic
string topic?;
string topic;
# Tracking fields
RequestedMeetingTrackingDetails[] tracking_fields?;
# Meeting Type
Expand All @@ -257,7 +260,7 @@ public type PollDetails record {
# Array of Polls
PollQuestions[] questions?;
# Title for the poll.
string title?;
string title;
};

# Approve or block users from specific regions/countries from joining this meeting.
Expand Down Expand Up @@ -301,13 +304,13 @@ public type MeetingObject record {
# Meeting duration.
int duration?;
# ID of the user who is set as the host of the meeting.
string host_id?;
string host_id;
# Meeting ID - also known as the meeting number in double (int64) format.
int id?;
int id;
# Join URL.
string join_url?;
string join_url;
# Meeting start time.
string start_time?;
string start_time;
# Timezone to format the meeting start time.
string timezone?;
# Meeting topic.
Expand Down Expand Up @@ -473,7 +476,7 @@ public type MeetingFullMetadata record {
# ID of the user who is set as host of meeting.
string host_id?;
# [Meeting ID](https://support.zoom.us/hc/en-us/articles/201362373-What-is-a-Meeting-ID-): Unique identifier of the meeting in "**long**" format(represented as int64 data type in JSON), also known as the meeting number.
int id?;
int id;
# Unique meeting ID. Each meeting instance will generate its own Meeting UUID (i.e., after a meeting ends, a new UUID will be generated for the next instance of the meeting). You can retrieve a list of UUIDs from past meeting instances using [this API](https://marketplace.zoom.us/docs/api-reference/zoom-api/meetings/pastmeetings) . Please double encode your UUID when using it for API calls if the UUID begins with a '/'or contains '//' in it.
string uuid?;
};
Expand All @@ -488,6 +491,7 @@ public type TemplateDetails record {
int 'type?;
};

# List of custom questions
public type CustomQuestions record {
# Answer choices for the question. Can not be used for `short` question type as this type of question requires registrants to type out the answer.
string[] answers?;
Expand Down

0 comments on commit 6f8208b

Please sign in to comment.