Initial implementation of Ballerina Zoom Scheduler API connector

README.md

@@ -6,21 +6,152 @@
 
 ## Overview
 
-[//]: # (TODO: Add overview mentioning the purpose of the module, supported REST API versions, and other high-level details.)
+[Zoom](https://www.zoom.com/) is a video communications platform that enables users to schedule, host, and join virtual meetings, webinars, and conferences.
+
+The `ballerinax/zoom.scheduler` package offers APIs to connect ant interract with [Zoom Scheduler](https://developers.zoom.us/docs/api/scheduler) endpoints. specifically based on Zoom API v2.
+
 
 ## Setup guide
 
-[//]: # (TODO: Add detailed steps to obtain credentials and configure the module.)
+To use the `ballerinax/zoom.scheduler` connector, you must have access to the Zoom API through [Zoom Marketplace](https://marketplace.zoom.us/) and a project under it. If you do not have a Zoom account, you can sign up for one [here](https://zoom.us/signup#/signup).
+
+### Step 1: Create a new app
+
+1. Open the [Zoom Marketplace](https://marketplace.zoom.us/).
+
+2. Click "Develop" → "Build App"
+
+     ![Zoom marketplace](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-zoom.scheduler/refs/heads/main/docs/setup/resources/zoom-marketplace.png)   
+3. Choose **"General App"** app type (for user authorization with refresh tokens)
+
+   ![App Type](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-zoom.scheduler/refs/heads/main/docs/setup/resources/app-type.png)
+
+4. Fill in basic information
+
+### Step 2: Configure OAuth Settings
+
+3. **Note down your credentials**:
+   * Client ID
+   * Client Secret
+
+   ![App Credentials](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-zoom.scheduler/refs/heads/main/docs/setup/resources/app-credentials.png)
+
+2. **Set Redirect URI**: Add your application's redirect URI (e.g., `http://localhost:8080/callback`)
+      ![Redirect URI](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-zoom.scheduler/refs/heads/main/docs/setup/resources/redirect-URI.png)
+
+3. **Add Scopes**: Make sure your Zoom app has the necessary scopes for the Scheduler API:
+   * Add `scheduler:read`, `scheduler:write` and `user:read` in the scope
+
+   ![Zoom Scopes](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-zoom.scheduler/refs/heads/main/docs/setup/resources/zoom-scopes.png)
+
+
+### Step 3: Activate the App
+
+1. Complete all required information
+2. Activate the app
+
+   ![Activate App](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-zoom.scheduler/refs/heads/main/docs/setup/resources/activate-app.png)
+
+### Step 4: Get User Authorization
+
+1. **Direct users to authorization URL** (replace `YOUR_CLIENT_ID` and `YOUR_REDIRECT_URI`):
+```
+https://zoom.us/oauth/authorize?response_type=code&client_id=YOUR_CLIENT_ID&redirect_uri=YOUR_REDIRECT_URI&scope=scheduler:read scheduler:write user:read
+```
+
+2. **User authorizes the app** and gets redirected to your callback URL with an authorization code
+
+3. **Exchange authorization code for tokens**:
+```curl
+curl -X POST https://zoom.us/oauth/token \
+  -H "Authorization: Basic $(echo -n 'CLIENT_ID:CLIENT_SECRET' | base64)" \
+  -d "grant_type=authorization_code&code=AUTHORIZATION_CODE&redirect_uri=YOUR_REDIRECT_URI"
+```
+
+This returns both `access_token` and `refresh_token`.
+
+* Replace:
+   * `CLIENT_ID` with your app's Client ID
+   * `CLIENT_SECRET` with your app's Client Secret
+   * `AUTHORIZATION_CODE` with the code received from the callback
+   * `YOUR_REDIRECT_URI` with your configured redirect URI
+
+### Step 5: Verify Your Setup
+```curl
+curl -X GET "https://api.zoom.us/v2/users/me" \
+  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
+```
+This will give you the user ID needed for API calls.
 
 ## Quickstart
 
-[//]: # (TODO: Add a quickstart guide to demonstrate a basic functionality of the module, including sample code snippets.)
+To use the `ballerinax/zoom.scheduler` connector in your Ballerina application, update the `.bal` file as follows:
+
+### Step 1: Import the module
+
+Import the `zoom.scheduler` module.
+
+```ballerina
+import ballerinax/zoom.scheduler;
+```
+
+### Step 2: Instantiate a new connector
+
+1. Create a `Config.toml` file and, configure the obtained credentials in the above steps as follows:
+
+```bash
+token = "<Access Token>"
+```
+
+2. Create a `zoom.scheduler:ConnectionConfig` with the obtained access token and initialize the connector with it.
+
+```ballerina
+configurable string token = ?;
+
+final zoom.scheduler:Client zoom.scheduler = check new({
+    auth: {
+        token
+    }
+});
+```
+### Step 3: Invoke the connector operation
+
+Now, utilize the available connector operations.
+
+#### Create a schedule
+
+```ballerina
+public function main() returns error? {
+    zoom.scheduler:InlineResponse2011 schedule = check zoom.scheduler->/schedules.post(
+        payload = {
+            summary: "Team Meeting",
+            description: "Weekly team sync",
+            duration: 60
+        }
+    );
+    io:println("Schedule created with ID: ", schedule.scheduleId);
+}
+```
+
+### Step 4: Run the Ballerina application
+
+```bash
+bal run
+```
 
 ## Examples
 
 The `Zoom Scheduler` connector provides practical examples illustrating usage in various scenarios. Explore these [examples](https://github.com/module-ballerinax-zoom.scheduler/tree/main/examples/), covering the following use cases:
 
-[//]: # (TODO: Add examples)
+* **[Meeting Scheduler](https://github.com/ballerina-platform/module-ballerinax-zoom.scheduler/tree/main/examples/meeting-scheduler)** - Create scheduled meetings, generate single-use scheduling links, and manage team meeting schedules with automated booking capabilities.
+
+* **[Availability Manager](https://github.com/ballerina-platform/module-ballerinax-zoom.scheduler/tree/main/examples/availability-manager)** - Configure availability schedules, analyze scheduler analytics, and manage working hours for different time zones and business requirements.
+
+## Issues and projects
+
+The **Issues** and **Projects** tabs are disabled for this repository as this is part of the Ballerina library. To report bugs, request new features, start new discussions, view project boards, etc., visit the Ballerina library [parent repository](https://github.com/ballerina-platform/ballerina-library).
+
+This repository only contains the source code for the package.
 
 ## Build from the source
 
@@ -114,3 +245,4 @@ All the contributors are encouraged to read the [Ballerina Code of Conduct](http
 * For example demonstrations of the usage, go to [Ballerina By Examples](https://ballerina.io/learn/by-example/).
 * Chat live with us via our [Discord server](https://discord.gg/ballerinalang).
 * Post all technical questions on Stack Overflow with the [#ballerina](https://stackoverflow.com/questions/tagged/ballerina) tag.
+

ballerina/Ballerina.toml

@@ -5,8 +5,8 @@ name = "zoom.scheduler"
 version = "1.0.0"
 license = ["Apache-2.0"]
 authors = ["Ballerina"]
-keywords = []
-# icon = "icon.png" # TODO: update icon.png
+keywords = ["Zoom", "Video Conference", "Scheduling", "Calendar"] 
+icon = "icon.png" 
 repository = "https://github.com/ballerina-platform/module-ballerinax-zoom.scheduler"
 
 [build-options]