@itentialopensource/adapter-zoom

{ "openapi": "3.1.0", "info": { "title": "", "version": "1.0.0" }, "paths": { "/accounts": { "get": { "tags": [ "Accounts" ], "operationId": "getAccounts", "description": "The parameters and request body are for method: getAccounts. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "page_count": { "type": "number" }, "page_number": { "type": "number" }, "page_size": { "type": "number" }, "total_records": { "type": "number" }, "accounts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "account_name": { "type": "string" }, "owner_email": { "type": "string" }, "account_type": { "type": "string" }, "seats": { "type": "number" }, "subscription_start_time": { "type": "string" }, "subscription_end_time": { "type": "string" }, "created_at": { "type": "string" } } } } } }, "example": { "page_count": 8, "page_number": 1, "page_size": 30, "total_records": 4, "accounts": [ { "id": "string", "account_name": "string", "owner_email": "string", "account_type": "string", "seats": 6, "subscription_start_time": "string", "subscription_end_time": "string", "created_at": "string" }, { "id": "string", "account_name": "string", "owner_email": "string", "account_type": "string", "seats": 9, "subscription_start_time": "string", "subscription_end_time": "string", "created_at": "string" }, { "id": "string", "account_name": "string", "owner_email": "string", "account_type": "string", "seats": 2, "subscription_start_time": "string", "subscription_end_time": "string", "created_at": "string" } ] } } } } }, "parameters": [ { "name": "pageSize", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "Accounts" ], "operationId": "accountCreate", "description": "The parameters and request body are for method: accountCreate. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "owner_id": { "type": "string" }, "owner_email": { "type": "string" }, "created_at": { "type": "string" } } }, "example": { "id": "string", "owner_id": "string", "owner_email": "string", "created_at": "string" } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/accounts/{accountId}": { "get": { "tags": [ "Accounts" ], "operationId": "account", "description": "The parameters and request body are for method: account. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "owner_id": { "type": "string" }, "owner_email": { "type": "string" }, "created_at": { "type": "string" }, "options": { "type": "object", "properties": { "share_rc": { "type": "boolean" }, "room_connectors": { "type": "string" }, "share_mc": { "type": "boolean" }, "meeting_connectors": { "type": "string" }, "pay_mode": { "type": "string" } } }, "vanity_url": { "type": "string" } } }, "example": { "id": "string", "owner_id": "string", "owner_email": "string", "created_at": "string", "options": { "share_rc": false, "room_connectors": "string", "share_mc": true, "meeting_connectors": "string", "pay_mode": "master" }, "vanity_url": "string" } } } } }, "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "title": "accountId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "delete": { "tags": [ "Accounts" ], "operationId": "accountDisassociate", "description": "The parameters and request body are for method: accountDisassociate. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "title": "accountId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/accounts/{accountId}/options": { "patch": { "tags": [ "Accounts" ], "operationId": "accountOptionsUpdate", "description": "The parameters and request body are for method: accountOptionsUpdate. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "title": "accountId", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/accounts/{accountId}/settings": { "get": { "tags": [ "Accounts" ], "operationId": "accountSettings", "description": "The parameters and request body are for method: accountSettings. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "schedule_meting": { "type": "object", "properties": { "host_video": { "type": "boolean" }, "participant_video": { "type": "boolean" }, "audio_type": { "type": "string" }, "join_before_host": { "type": "boolean" }, "enforce_login": { "type": "boolean" }, "enforce_login_with_domains": { "type": "boolean" }, "enforce_login_domains": { "type": "string" }, "not_store_meeting_topic": { "type": "boolean" }, "force_pmi_jbh_password": { "type": "boolean" } } }, "in_meeting": { "type": "object", "properties": { "e2e_encryption": { "type": "boolean" }, "chat": { "type": "boolean" }, "private_chat": { "type": "boolean" }, "auto_saving_chat": { "type": "boolean" }, "file_transfer": { "type": "boolean" }, "feedback": { "type": "boolean" }, "post_meeting_feedback": { "type": "boolean" }, "co_host": { "type": "boolean" }, "polling": { "type": "boolean" }, "attendee_on_hold": { "type": "boolean" }, "show_meeting_control_toolbar": { "type": "boolean" }, "allow_show_zoom_windows": { "type": "boolean" }, "annotation": { "type": "boolean" }, "whiteboard": { "type": "boolean" }, "webinar_question_answer": { "type": "boolean" }, "anonymous_question_answer": { "type": "boolean" }, "breakout_room": { "type": "boolean" }, "closed_caption": { "type": "boolean" }, "far_end_camera_control": { "type": "boolean" }, "group_hd": { "type": "boolean" }, "virtual_background": { "type": "boolean" }, "watermark": { "type": "boolean" }, "alert_guest_join": { "type": "boolean" }, "auto_answer": { "type": "boolean" }, "p2p_connetion": { "type": "boolean" }, "p2p_ports": { "type": "boolean" }, "ports_range": { "type": "string" }, "sending_default_email_invites": { "type": "boolean" }, "use_html_format_email": { "type": "boolean" }, "dscp_marking": { "type": "boolean" }, "dscp_audio": { "type": "number" }, "dscp_video": { "type": "number" }, "stereo_audio": { "type": "boolean" }, "original_audio": { "type": "boolean" }, "screen_sharing": { "type": "boolean" }, "remote_control": { "type": "boolean" }, "attention_tracking": { "type": "boolean" }, "allow_live_streaming": { "type": "boolean" }, "workplace_by_facebook": { "type": "boolean" }, "custom_live_streaming": { "type": "boolean" }, "custom_service_instructions": { "type": "string" } } }, "email_notification": { "type": "object", "properties": { "cloud_recording_avaliable_reminder": { "type": "boolean" }, "jbh_reminder": { "type": "boolean" }, "cancel_meeting_reminder": { "type": "boolean" }, "low_host_count_reminder": { "type": "boolean" }, "alternative_host_reminder": { "type": "boolean" } } }, "zoom_rooms": { "type": "object", "properties": { "upcoming_meeting_alert": { "type": "boolean" }, "start_airplay_manually": { "type": "boolean" }, "weekly_system_restart": { "type": "boolean" }, "list_meetings_with_calendar": { "type": "boolean" }, "zr_post_meeting_feedback": { "type": "boolean" }, "ultrasonic": { "type": "boolean" }, "force_private_meeting": { "type": "boolean" }, "hide_host_information": { "type": "boolean" }, "cmr_for_instant_meeting": { "type": "boolean" }, "auto_start_stop_scheduled_meetings": { "type": "boolean" } } }, "security": { "type": "object", "properties": { "admin_change_name_pic": { "type": "boolean" }, "import_photos_from_devices": { "type": "boolean" }, "hide_billing_info": { "type": "boolean" } } }, "recording": { "type": "object", "properties": { "local_recording": { "type": "boolean" }, "cloud_recording": { "type": "boolean" }, "record_speaker_view": { "type": "boolean" }, "record_gallery_view": { "type": "boolean" }, "record_audio_file": { "type": "boolean" }, "save_chat_text": { "type": "boolean" }, "show_timestamp": { "type": "boolean" }, "recording_audio_transcript": { "type": "boolean" }, "auto_recording": { "type": "string" }, "cloud_recording_download": { "type": "boolean" }, "cloud_recording_download_host": { "type": "boolean" }, "account_user_access_recording": { "type": "boolean" }, "auto_delete_cmr": { "type": "boolean" }, "auto_delete_cmr_days": { "type": "number" } } }, "telephony": { "type": "object", "properties": { "third_party_audio": { "type": "boolean" }, "audio_conference_info": { "type": "string" } } }, "integration": { "type": "object", "properties": { "google_calendar": { "type": "boolean" }, "google_drive": { "type": "boolean" }, "dropbox": { "type": "boolean" }, "box": { "type": "boolean" }, "microsoft_one_drive": { "type": "boolean" }, "kubi": { "type": "boolean" } } }, "feature": { "type": "object", "properties": { "meeting_capacity": { "type": "number" } } } } }, "example": { "schedule_meting": { "host_video": false, "participant_video": false, "audio_type": "both", "join_before_host": true, "enforce_login": false, "enforce_login_with_domains": true, "enforce_login_domains": "string", "not_store_meeting_topic": true, "force_pmi_jbh_password": false }, "in_meeting": { "e2e_encryption": true, "chat": true, "private_chat": false, "auto_saving_chat": true, "file_transfer": false, "feedback": true, "post_meeting_feedback": true, "co_host": true, "polling": false, "attendee_on_hold": false, "show_meeting_control_toolbar": true, "allow_show_zoom_windows": true, "annotation": false, "whiteboard": true, "webinar_question_answer": false, "anonymous_question_answer": true, "breakout_room": false, "closed_caption": false, "far_end_camera_control": false, "group_hd": false, "virtual_background": false, "watermark": false, "alert_guest_join": true, "auto_answer": false, "p2p_connetion": true, "p2p_ports": true, "ports_range": "string", "sending_default_email_invites": true, "use_html_format_email": true, "dscp_marking": false, "dscp_audio": 5, "dscp_video": 10, "stereo_audio": false, "original_audio": false, "screen_sharing": false, "remote_control": true, "attention_tracking": false, "allow_live_streaming": false, "workplace_by_facebook": true, "custom_live_streaming": false, "custom_service_instructions": "string" }, "email_notification": { "cloud_recording_avaliable_reminder": true, "jbh_reminder": false, "cancel_meeting_reminder": false, "low_host_count_reminder": true, "alternative_host_reminder": true }, "zoom_rooms": { "upcoming_meeting_alert": false, "start_airplay_manually": false, "weekly_system_restart": true, "list_meetings_with_calendar": true, "zr_post_meeting_feedback": true, "ultrasonic": false, "force_private_meeting": true, "hide_host_information": false, "cmr_for_instant_meeting": true, "auto_start_stop_scheduled_meetings": false }, "security": { "admin_change_name_pic": false, "import_photos_from_devices": true, "hide_billing_info": false }, "recording": { "local_recording": true, "cloud_recording": false, "record_speaker_view": true, "record_gallery_view": true, "record_audio_file": false, "save_chat_text": true, "show_timestamp": true, "recording_audio_transcript": true, "auto_recording": "cloud", "cloud_recording_download": false, "cloud_recording_download_host": false, "account_user_access_recording": false, "auto_delete_cmr": false, "auto_delete_cmr_days": 10 }, "telephony": { "third_party_audio": true, "audio_conference_info": "string" }, "integration": { "google_calendar": false, "google_drive": true, "dropbox": false, "box": false, "microsoft_one_drive": false, "kubi": true }, "feature": { "meeting_capacity": 100 } } } } } }, "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "title": "accountId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "patch": { "tags": [ "Accounts" ], "operationId": "accountSettingsUpdate", "description": "The parameters and request body are for method: accountSettingsUpdate. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "title": "accountId", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/accounts/{accountId}/managed_domains": { "get": { "tags": [ "Accounts" ], "operationId": "accountManagedDomain", "description": "The parameters and request body are for method: accountManagedDomain. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "total_records": { "type": "number" }, "domains": { "type": "array", "items": { "type": "object", "properties": { "domain": { "type": "string" }, "status": { "type": "string" } } } } } }, "example": { "total_records": 2, "domains": [ { "domain": "string", "status": "string" }, { "domain": "string", "status": "string" }, { "domain": "string", "status": "string" } ] } } } } }, "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "title": "accountId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/accounts/{accountId}/billing": { "get": { "tags": [ "Billing" ], "operationId": "accountBilling", "description": "The parameters and request body are for method: accountBilling. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "first_name": { "type": "string" }, "last_name": { "type": "string" }, "email": { "type": "string" }, "phone_number": { "type": "string" }, "address": { "type": "string" }, "apt": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "type": "string" }, "country": { "type": "string" } } }, "example": { "first_name": "string", "last_name": "string", "email": "string", "phone_number": "string", "address": "string", "apt": "string", "city": "string", "state": "string", "zip": "string", "country": "string" } } } } }, "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "title": "accountId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "patch": { "tags": [ "Billing" ], "operationId": "accountBillingUpdate", "description": "The parameters and request body are for method: accountBillingUpdate. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "title": "accountId", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/accounts/{accountId}/plans": { "get": { "tags": [ "Billing" ], "operationId": "accountPlans", "description": "The parameters and request body are for method: accountPlans. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "plan_base": { "type": "object", "properties": { "type": { "type": "string" }, "hosts": { "type": "number" } } }, "plan_zoom_rooms": { "type": "object", "properties": { "type": { "type": "string" }, "hosts": { "type": "number" } } }, "plan_room_connector": { "type": "object", "properties": { "type": { "type": "string" }, "hosts": { "type": "number" } } }, "plan_large_meeting": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "hosts": { "type": "number" } } } }, "plan_webinar": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "hosts": { "type": "number" } } } }, "plan_recording": { "type": "string" }, "plan_audio": { "type": "object", "properties": { "type": { "type": "string" }, "tollfree_countries": { "type": "string" }, "premium_countries": { "type": "string" }, "callout_countries": { "type": "string" }, "ddi_numbers": { "type": "number" } } } } }, "example": { "plan_base": { "type": "string", "hosts": 7 }, "plan_zoom_rooms": { "type": "string", "hosts": 4 }, "plan_room_connector": { "type": "string", "hosts": 9 }, "plan_large_meeting": [ { "type": "string", "hosts": 5 }, { "type": "string", "hosts": 1 }, { "type": "string", "hosts": 6 }, { "type": "string", "hosts": 7 }, { "type": "string", "hosts": 4 }, { "type": "string", "hosts": 6 }, { "type": "string", "hosts": 3 }, { "type": "string", "hosts": 3 }, { "type": "string", "hosts": 6 } ], "plan_webinar": [ { "type": "string", "hosts": 8 }, { "type": "string", "hosts": 1 }, { "type": "string", "hosts": 7 }, { "type": "string", "hosts": 3 }, { "type": "string", "hosts": 10 }, { "type": "string", "hosts": 9 } ], "plan_recording": "string", "plan_audio": { "type": "string", "tollfree_countries": "string", "premium_countries": "string", "callout_countries": "string", "ddi_numbers": 2 } } } } } }, "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "title": "accountId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "Billing" ], "operationId": "accountPlanCreate", "description": "The parameters and request body are for method: accountPlanCreate. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "plan_base": { "type": "object", "properties": { "type": { "type": "string" }, "hosts": { "type": "number" } } }, "plan_zoom_rooms": { "type": "object", "properties": { "type": { "type": "string" }, "hosts": { "type": "number" } } }, "plan_room_connector": { "type": "object", "properties": { "type": { "type": "string" }, "hosts": { "type": "number" } } }, "plan_large_meeting": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "hosts": { "type": "number" } } } }, "plan_webinar": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "hosts": { "type": "number" } } } }, "plan_recording": { "type": "string" }, "plan_audio": { "type": "object", "properties": { "type": { "type": "string" }, "tollfree_countries": { "type": "string" }, "premium_countries": { "type": "string" }, "callout_countries": { "type": "string" }, "ddi_numbers": { "type": "number" } } } } }, "example": { "plan_base": { "type": "string", "hosts": 6 }, "plan_zoom_rooms": { "type": "string", "hosts": 7 }, "plan_room_connector": { "type": "string", "hosts": 7 }, "plan_large_meeting": [ { "type": "string", "hosts": 10 }, { "type": "string", "hosts": 8 }, { "type": "string", "hosts": 7 }, { "type": "string", "hosts": 1 }, { "type": "string", "hosts": 4 }, { "type": "string", "hosts": 8 }, { "type": "string", "hosts": 4 }, { "type": "string", "hosts": 3 }, { "type": "string", "hosts": 6 } ], "plan_webinar": [ { "type": "string", "hosts": 8 }, { "type": "string", "hosts": 10 }, { "type": "string", "hosts": 7 }, { "type": "string", "hosts": 4 } ], "plan_recording": "string", "plan_audio": { "type": "string", "tollfree_countries": "string", "premium_countries": "string", "callout_countries": "string", "ddi_numbers": 2 } } } } } }, "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "title": "accountId", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/accounts/{accountId}/plans/base": { "put": { "tags": [ "Billing" ], "operationId": "accountPlanBaseUpdate", "description": "The parameters and request body are for method: accountPlanBaseUpdate. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "title": "accountId", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": {