zoom_us 0.1.1

data/spec/api/groups_api_spec.rb

@@ -0,0 +1,201 @@
+=begin
+#Zoom API
+
+#The Zoom API allows developers to safely and securely access information from Zoom. You can use this API to build private services or public applications on the [Zoom App Marketplace](http://marketplace.zoom.us). To learn how to get your credentials and create private/public applications, read our [Authorization Guide](https://marketplace.zoom.us/docs/guides/authorization/credentials). All endpoints are available via `https` and are located at `api.zoom.us/v2/`.  For instance you can list all users on an account via `https://api.zoom.us/v2/users/`.
+
+OpenAPI spec version: 2.0.0
+Contact: developersupport@zoom.us
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.12
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for ZoomUs::GroupsApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'GroupsApi' do
+  before do
+    # run before each test
+    @instance = ZoomUs::GroupsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of GroupsApi' do
+    it 'should create an instance of GroupsApi' do
+      expect(@instance).to be_instance_of(ZoomUs::GroupsApi)
+    end
+  end
+
+  # unit tests for get_group_lock_settings
+  # Get Locked Settings
+  # Retrieve a [group's](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) locked settings. If you lock a setting, the group members will not be able to modify it individually. <p style=\"background-color:#FEEFB3; color:#9F6000\"><br>Note:</b> The `force_pmi_jbh_password` field under meeting settings is planned to be deprecated on September 22, 2019. This field will be replaced by another field that will provide the same functionality.</p>  **Prerequisite**: Pro, Business, or Education account<br> **Scopes**: `group:read:admin`<br>  
+  # @param group_id Id of the group.
+  # @param [Hash] opts the optional parameters
+  # @return [InlineResponse20069]
+  describe 'get_group_lock_settings test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_group_settings
+  # Get a Group's Settings
+  # Get settings for a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-).  **Prerequisite**: Pro, Business, or Education account<br> **Scopes**: `group:read:admin`<br>  
+  # @param group_id 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :option `meeting_authentication`: Use this query parameter to view [meeting authentication configuration](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars) applied on the account.<br>`recording_authentication`: Use this query parameter to view [recording authentication configuration](https://support.zoom.us/hc/en-us/articles/360037756671-Authentication-Profiles-for-Cloud-Recordings) applied on the account.
+  # @return [Object]
+  describe 'get_group_settings test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for group
+  # Get a Group
+  # Get a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under an account.  **Prerequisite**: Pro, Business, or Education account<br> **Scopes**: `group:read:admin`<br>  
+  # @param group_id The group ID.<br> Can be retrieved by calling [GET /groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups).
+  # @param [Hash] opts the optional parameters
+  # @return [InlineResponse20017]
+  describe 'group test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for group_create
+  # Create a Group
+  # Create a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under an account.  **Prerequisite**: Pro or higher account.<br> **Scopes**: `group:write:admin`<br>  
+  # @param body 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'group_create test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for group_delete
+  # Delete a Group
+  # Delete a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-).  **Prerequisite**: Pro, Business, or Education account<br> **Scopes**: `group:write:admin`<br>  
+  # @param group_id The group ID.<br> Can be retrieved by calling [GET /groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups).
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'group_delete test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for group_locked_settings
+  # Update Locked Settings
+  # Update a [group's](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) locked settings. If you lock a setting, the group members will not be able to modify it individually. <p style=\"background-color:#FEEFB3; color:#9F6000\"><br>Note:</b> The `force_pmi_jbh_password` field under meeting settings is planned to be deprecated on September 22, 2019. This field will be replaced by another field that will provide the same functionality.</p>  **Prerequisite**: Pro, Business, or Education account<br> **Scopes**: `group:write:admin`<br>  
+  # @param group_id The Id of the group.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Body50] :body 
+  # @return [Object]
+  describe 'group_locked_settings test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for group_members
+  # List Group Members 
+  # List the members of a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under your account.  **Prerequisite**: Pro, Business, or Education account<br> **Scopes**: `group:read:admin`<br>  
+  # @param group_id The group ID.<br> Can be retrieved by calling [GET /groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups).
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page_size The number of records returned within a single API call.
+  # @option opts [Integer] :page_number The current page number of returned records.
+  # @return [InlineResponse20018]
+  describe 'group_members test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for group_members_create
+  # Add Group Members
+  # Add members to a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under your account.  **Prerequisite**: Pro, Business, or Education account<br> **Scopes**: `group:write:admin`<br>  
+  # @param group_id The group ID.<br> Can be retrieved by calling [GET /groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups).
+  # @param body 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'group_members_create test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for group_members_delete
+  # Delete a Group Member
+  # Delete a member from a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) in a Zoom account.  **Prerequisite**: Pro, Business, or Education account<br> **Scopes**: `group:write:admin`<br>  
+  # @param group_id The group ID.<br> Can be retrieved by calling [GET /groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups).
+  # @param member_id The member ID.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'group_members_delete test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for group_update
+  # Update a Group
+  # Update a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under your account.  **Prerequisite**: Pro, Business, or Education account<br> **Scopes**: `group:write:admin`<br>  
+  # @param group_id The group ID.<br> Can be retrieved by calling [GET /groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups).
+  # @param body 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'group_update test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for groups
+  # List Groups
+  # List [groups](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under an account.  **Prerequisite**: Pro or higher account.<br> **Scopes**: `group:read:admin`<br>  
+  # @param [Hash] opts the optional parameters
+  # @return [InlineResponse20016]
+  describe 'groups test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for update_a_group_member
+  # Update a Group Member
+  # If a user is a member in multiple groups, you can [set a primary group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-#h_d07c7dcd-4fd8-485a-b5fe-a322e8d21c09) for the user. The group member will use the primary group's settings by default. However, if settings are locked in other groups, those settings will continue to be locked for that user. By default, the primary group is the first group that user is added to.<br><br> Use this API to perform either of the following tasks: * Simultaneously remove a member from one group and move the member to a different group. * Set a primary group for the user<br><br> **Prerequisites:**  * Pro or higher account<br> **Scopes:** `group:write:admin` 
+  # @param group_id Unique Identifier of the group. Can be retrieved by calling [GET /groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups) API.<br> To change a member's primary group, provide the groupId of the member's current primary group as the value of this field.<br> To remove a member from one group and move the member to another group, provide the groupId of the group from which the member is to be moved.
+  # @param member_id Unique Identifier of the group member. Can be retrieved by calling the [List Group Members](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groupmembers) API.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Body18] :body 
+  # @return [Object]
+  describe 'update_a_group_member test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for update_group_settings
+  # Update a Group's Settings
+  # Update settings for a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-).<p style=\"background-color:#FEEFB3; color:#9F6000\"><br>Note:</b> The `force_pmi_jbh_password` field under meeting settings is planned to be deprecated on September 22, 2019. This field will be replaced by another field that will provide the same functionality.</p> **Prerequisite**: Pro, Business, or Education account<br>  **Scopes**: `group:write:admin`<br>  
+  # @param group_id Id of the group.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Object] :body 
+  # @option opts [String] :option 
+  # @return [nil]
+  describe 'update_group_settings test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/im_chat_api_spec.rb

@@ -0,0 +1,96 @@
+=begin
+#Zoom API
+
+#The Zoom API allows developers to safely and securely access information from Zoom. You can use this API to build private services or public applications on the [Zoom App Marketplace](http://marketplace.zoom.us). To learn how to get your credentials and create private/public applications, read our [Authorization Guide](https://marketplace.zoom.us/docs/guides/authorization/credentials). All endpoints are available via `https` and are located at `api.zoom.us/v2/`.  For instance you can list all users on an account via `https://api.zoom.us/v2/users/`.
+
+OpenAPI spec version: 2.0.0
+Contact: developersupport@zoom.us
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.12
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for ZoomUs::IMChatApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'IMChatApi' do
+  before do
+    # run before each test
+    @instance = ZoomUs::IMChatApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of IMChatApi' do
+    it 'should create an instance of IMChatApi' do
+      expect(@instance).to be_instance_of(ZoomUs::IMChatApi)
+    end
+  end
+
+  # unit tests for im_chat_messages
+  # Retrieve IM Chat Messages
+  # Retrieve IM chat messages for a specified period of time. <aside>Note: This API only supports oauth2.</aside><br><br>  **Scopes:** `imchat:read`<br>  <br>  <p style=\"background-color:#ffffcc;\"><strong>API End of Life:</strong> This API will no longer be supported after April, 2020. <a href=\"https://marketplace.zoom.us/docs/deprecated-scopes\">Learn more</a>.</p><br>
+  # @param session_id IM chat session ID.
+  # @param from Start date in 'yyyy-mm-dd' format. The date range defined by the \"from\" and \"to\" parameters should only be one month as the report includes only one month worth of data at once.
+  # @param to End date.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page_size The number of records returned within a single API call.
+  # @option opts [String] :next_page_token The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.
+  # @return [InlineResponse20021]
+  describe 'im_chat_messages test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for im_chat_sessions
+  # Get IM Chat Sessions
+  # Retrieve IM Chat sessions for a specified period of time. <aside>Note: This API only supports Oauth2.</aside><br>  <p style=\"background-color:#ffffcc;\"><strong>API End of Life:</strong> This API will no longer be supported after April, 2020. <a href=\"https://marketplace.zoom.us/docs/deprecated-scopes\">Learn more</a>.</p><br>   **Scopes:** `imchat:read, imchat:read:admin`<br> 
+  # @param from Start date in 'yyyy-mm-dd' format. The date range defined by the \"from\" and \"to\" parameters should only be one month as the report includes only one month worth of data at once.
+  # @param to End date.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page_size The number of records returned within a single API call.
+  # @option opts [String] :next_page_token The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.
+  # @return [InlineResponse20020]
+  describe 'im_chat_sessions test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for listimmessages
+  # Get User’s IM Messages
+  # Get IM Chat messages for a specified period of time. <aside>Note: This API only supports Oauth2.</aside><br><br> **Scopes:** `imchat:read` <p style=\"background-color:#ffffcc;\"><strong>API End of Life:</strong> This API will no longer be supported after April, 2020. <a href=\"https://marketplace.zoom.us/docs/deprecated-scopes\">Learn more</a>.</p><br> 
+  # @param user_id The user ID or email address.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :chat_user Chat user's ID or email address.
+  # @option opts [String] :channel IM Channel's ID.
+  # @option opts [String] :date IM message's query date time, format as yyyy-MM-dd.
+  # @option opts [Integer] :page_size The number of records returned within a single API call.
+  # @option opts [String] :next_page_token The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.
+  # @return [InlineResponse20060]
+  describe 'listimmessages test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for sendimmessages
+  # Send IM messages
+  # Send chat message to a user. <aside>Note: This API only supports OAuth 2.0.</aside><br><br>**Scope:** `imchat:write` <p style=\"background-color:#ffffcc;\"><strong>API End of Life:</strong> This API will no longer be supported after April, 2020. <a href=\"https://marketplace.zoom.us/docs/deprecated-scopes\">Learn more</a>.</p><br>  
+  # @param [Hash] opts the optional parameters
+  # @option opts [Body44] :body 
+  # @option opts [String] :chat_user The email address (registered with Zoom) or the userId of the chat user.
+  # @return [InlineResponse20122]
+  describe 'sendimmessages test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/im_groups_api_spec.rb

@@ -0,0 +1,135 @@
+=begin
+#Zoom API
+
+#The Zoom API allows developers to safely and securely access information from Zoom. You can use this API to build private services or public applications on the [Zoom App Marketplace](http://marketplace.zoom.us). To learn how to get your credentials and create private/public applications, read our [Authorization Guide](https://marketplace.zoom.us/docs/guides/authorization/credentials). All endpoints are available via `https` and are located at `api.zoom.us/v2/`.  For instance you can list all users on an account via `https://api.zoom.us/v2/users/`.
+
+OpenAPI spec version: 2.0.0
+Contact: developersupport@zoom.us
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.12
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for ZoomUs::IMGroupsApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'IMGroupsApi' do
+  before do
+    # run before each test
+    @instance = ZoomUs::IMGroupsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of IMGroupsApi' do
+    it 'should create an instance of IMGroupsApi' do
+      expect(@instance).to be_instance_of(ZoomUs::IMGroupsApi)
+    end
+  end
+
+  # unit tests for im_group
+  # Retrieve an IM Directory Group
+  # Retrieve an [IM directory group](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management) under your account.<br><br> Scopes: `imgroup:read:admin`<br>  
+  # @param group_id The group ID.<br> Can be retrieved by calling [GET /groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups).
+  # @param [Hash] opts the optional parameters
+  # @return [InlineResponse20019]
+  describe 'im_group test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for im_group_create
+  # Create an IM Directory Group
+  # Create an [IM directory group](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management) under your account.<br><br> **Scopes**: `imgroup:write:admin`<br>  
+  # @param body 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'im_group_create test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for im_group_delete
+  # Delete an IM Directory Group
+  # Delete an [IM directory group](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management) under your account.<br><br> Scopes: `imgroup:write:admin`<br>  
+  # @param group_id The group ID.<br> Can be retrieved by calling [GET /groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups).
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'im_group_delete test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for im_group_members
+  # List IM Directory Group Members
+  # List the members of an [IM directory group](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management).<br><br> **Scope:** `imgroup:read:admin`<br>  
+  # @param group_id The group ID.<br> Can be retrieved by calling [GET /groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups).
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page_size The number of records returned within a single API call.
+  # @option opts [Integer] :page_number The current page number of returned records.
+  # @return [GroupMemberList]
+  describe 'im_group_members test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for im_group_members_create
+  # Add IM Directory Group Members
+  # Add members to an [IM directory group](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management) under an account.<br><br> **Scope:** `imgroup:write:admin`<br>  
+  # @param group_id The group ID.<br> Can be retrieved by calling [GET /groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups).
+  # @param body 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'im_group_members_create test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for im_group_members_delete
+  # Delete an IM Directory Group Member
+  # Delete a member from an [IM directory group](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management) under an account.<br><br> Scopes: `imgroup:write:admin`<br>  
+  # @param group_id The group ID.<br> Can be retrieved by calling [GET /groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups).
+  # @param member_id The member ID.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'im_group_members_delete test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for im_group_update
+  # Update an IM Directory Group
+  # Update an [IM directory group](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management) under your account.<br><br> **Scopes**: `imgroup:write:admin`<br>  
+  # @param group_id The group ID.<br> Can be retrieved by calling [GET /groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups).
+  # @param body 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'im_group_update test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for im_groups
+  # List IM Directory Groups
+  # List [IM directory groups](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management).<br><br> **Scopes**: `imgroup:read:admin`<br>  
+  # @param [Hash] opts the optional parameters
+  # @return [IMGroupList]
+  describe 'im_groups test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/meetings_api_spec.rb

@@ -0,0 +1,351 @@
+=begin
+#Zoom API
+
+#The Zoom API allows developers to safely and securely access information from Zoom. You can use this API to build private services or public applications on the [Zoom App Marketplace](http://marketplace.zoom.us). To learn how to get your credentials and create private/public applications, read our [Authorization Guide](https://marketplace.zoom.us/docs/guides/authorization/credentials). All endpoints are available via `https` and are located at `api.zoom.us/v2/`.  For instance you can list all users on an account via `https://api.zoom.us/v2/users/`.
+
+OpenAPI spec version: 2.0.0
+Contact: developersupport@zoom.us
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.12
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for ZoomUs::MeetingsApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'MeetingsApi' do
+  before do
+    # run before each test
+    @instance = ZoomUs::MeetingsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of MeetingsApi' do
+    it 'should create an instance of MeetingsApi' do
+      expect(@instance).to be_instance_of(ZoomUs::MeetingsApi)
+    end
+  end
+
+  # unit tests for list_past_meeting_files
+  # List Past Meeting Files
+  # List files sent via in-meeting chat during a meeting. The in-meeting files are deleted after 24 hours of the meeting completion time.  <br><br> **Scope:** `meeting:read`, `meeting:read:admin`<br>  
+  # @param meeting_id The meeting ID.
+  # @param [Hash] opts the optional parameters
+  # @return [InlineResponse20084]
+  describe 'list_past_meeting_files test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for list_past_meeting_polls
+  # List Past Meeting's Poll Results
+  # [Polls](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings) allow the meeting host to survey attendees. Use this API to list poll results of a meeting.<br><br>  **Scopes**: `meeting:read:admin`, `meeting:read`<br>  **Prerequisites**:<br> * Host user type must be **Pro**. * Meeting must be a scheduled meeting. Instant meetings do not have polling features enabled.
+  # @param meeting_id The meeting ID or meeting UUID. If   meeting ID is provided, it will take the last meeting instance.
+  # @param [Hash] opts the optional parameters
+  # @return [InlineResponse20083]
+  describe 'list_past_meeting_polls test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for meeting
+  # Get a Meeting
+  # Retrieve the details of a meeting.<br><br> **Scopes:** `meeting:read:admin` `meeting:read`<br>    
+  # @param meeting_id The meeting ID.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :occurrence_id Meeting occurrence id
+  # @return [InlineResponse20022]
+  describe 'meeting test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for meeting_create
+  # Create a Meeting
+  # Create a meeting for a user. <br>This API has a daily rate limit of 100 requests per day. Therefore, only 100 **Create a Meeting** API requests are permitted within a 24 hour window for a user.<br>  <aside>The <code>start_url</code> of a meeting is a URL using which a host or an alternative host can start a meeting. The expiration time for the <code>start_url</code> field is two hours for all regular users.    For users created using the <code>custCreate</code> option via the [Create Users](https://marketplace.zoom.us/docs/api-reference/zoom-api/users/usercreate) API, the expiration time of the <code>start_url</code> field is 90 days.   For security reasons, the recommended way to retrieve the updated value for the <code>start_url</code> field programmatically (after expiry) is by calling the [Retrieve a Meeting API](https://marketplace.zoom.us/docs/api-reference/zoom-api/meetings/meeting) and referring to the value of the <code>start_url</code> field in the response.</aside><br><br> Scopes: `meeting:write:admin` `meeting:write`
+  # @param user_id The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.
+  # @param body Meeting object.
+  # @param [Hash] opts the optional parameters
+  # @return [InlineResponse20110]
+  describe 'meeting_create test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for meeting_delete
+  # Delete a Meeting
+  # Delete a meeting.<br><br> **Scopes:** `meeting:write:admin` `meeting:write`<br>    
+  # @param meeting_id The meeting ID.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :occurrence_id The meeting occurrence ID.
+  # @option opts [BOOLEAN] :schedule_for_reminder `true`: Notify host and alternative host about the meeting cancellation via email. `false`: Do not send any email notification.
+  # @return [nil]
+  describe 'meeting_delete test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for meeting_invitation
+  # Get Meeting Invitation
+  # Retrieve the meeting invite note that was sent for a specific meeting.<br><br> **Scopes:** `meeting:read:admin` `meeting:read`<br>    
+  # @param meeting_id The meeting ID.
+  # @param [Hash] opts the optional parameters
+  # @return [MeetingInvitation]
+  describe 'meeting_invitation test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for meeting_live_stream_status_update
+  # Update Live Stream Status
+  # Zoom allows users to [live stream a meeting](https://support.zoom.us/hc/en-us/articles/115001777826-Live-Streaming-Meetings-or-Webinars-Using-a-Custom-Service) to a custom platform. Use this API to update the status of a meeting's live stream.<br><br> **Prerequisites:**<br> * Meeting host must have a Pro license.<br> **Scopes:** `meeting:write:admin` `meeting:write`<br>    
+  # @param meeting_id The meeting ID.
+  # @param body Meeting
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'meeting_live_stream_status_update test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for meeting_live_stream_update
+  # Update Live Stream
+  # Zoom allows users to [live stream a meeting](https://support.zoom.us/hc/en-us/articles/115001777826-Live-Streaming-Meetings-or-Webinars-Using-a-Custom-Service) to a custom platform. Use this API to update a meeting's live stream information.<br><br> **Prerequisites:**<br> * Meeting host must have a Pro license.<br> **Scopes:** `meeting:write:admin` `meeting:write`<br>    
+  # @param meeting_id The meeting ID.
+  # @param body Meeting
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'meeting_live_stream_update test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for meeting_poll_create
+  # Create a Meeting Poll
+  # Polls allow the meeting host to survey attendees. Use this API to create a [poll](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings) for a meeting.<br><br>  **Scopes**: `meeting:write:admin` `meeting:write`<br>    **Prerequisites**:<br> * Host user type must be **Pro**. * Polling feature should be enabled in the host's account. * Meeting must be a scheduled meeting. Instant meetings do not have polling features enabled.
+  # @param meeting_id The meeting ID.
+  # @param body Meeting poll object
+  # @param [Hash] opts the optional parameters
+  # @return [InlineResponse20112]
+  describe 'meeting_poll_create test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for meeting_poll_delete
+  # Delete a Meeting Poll
+  # Polls allow the meeting host to survey attendees. Use this API to delete a meeting [poll](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings).<br> **Scopes**: `meeting:write:admin` `meeting:write`<br>   **Prerequisites**:<br> * Host user type must be **Pro**. * Polling feature should be enabled in the host's account. * Meeting must be a scheduled meeting. Instant meetings do not have polling features enabled.
+  # @param meeting_id The meeting ID.
+  # @param poll_id The poll ID
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'meeting_poll_delete test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for meeting_poll_get
+  # Get a Meeting Poll
+  # Polls allow the meeting host to survey attendees. Use this API to get information about a specific meeting [poll](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings).<br><br> **Scopes**: `meeting:read:admin` `meeting:read`<br>     
+  # @param meeting_id The meeting ID.
+  # @param poll_id The poll ID
+  # @param [Hash] opts the optional parameters
+  # @return [InlineResponse20112]
+  describe 'meeting_poll_get test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for meeting_poll_update
+  # Update a Meeting Poll
+  # Polls allow the meeting host to survey attendees. Use this API to update information of a specific meeting [poll](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings)<br><br> **Scopes**: `meeting:write:admin` `meeting:write`    
+  # @param meeting_id The meeting ID.
+  # @param poll_id The poll ID
+  # @param body Meeting Poll
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'meeting_poll_update test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for meeting_polls
+  # List Meeting Polls
+  # Polls allow the meeting host to survey attendees. Use this API to list [polls](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings) of a meeting.<br><br>  **Scopes**: `meeting:read:admin` `meeting:read`<br>   **Prerequisites**:<br> * Host user type must be **Pro**. * Meeting must be a scheduled meeting. Instant meetings do not have polling features enabled.
+  # @param meeting_id The meeting ID.
+  # @param [Hash] opts the optional parameters
+  # @return [Object]
+  describe 'meeting_polls test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for meeting_registrant_create
+  # Add Meeting Registrant
+  # Register a participant for a meeting.<br><br> **Scopes:** `meeting:write:admin` `meeting:write`
+  # @param meeting_id The meeting ID.
+  # @param body 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :occurrence_ids Occurrence IDs. You can find these with the meeting get API. Multiple values separated by comma.
+  # @return [InlineResponse20111]
+  describe 'meeting_registrant_create test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for meeting_registrant_question_update
+  # Update Registration Questions
+  # Update registration questions that will be displayed to users while [registering for a meeeting](https://support.zoom.us/hc/en-us/articles/211579443-Registration-for-Meetings).<br><br> **Scopes:** `meeting:write`, `meeting:write:admin`<br>    
+  # @param meeting_id The meeting ID.
+  # @param body Meeting Registrant Questions
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'meeting_registrant_question_update test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for meeting_registrant_status
+  # Update Meeting Registrant Status
+  # Update a meeting registrant's status by either approving, cancelling or denying a registrant from joining the meeting.<br><br> **Scopes:** `meeting:write:admin` `meeting:write`
+  # @param meeting_id The meeting ID.
+  # @param body 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :occurrence_id The meeting occurrence ID.
+  # @return [nil]
+  describe 'meeting_registrant_status test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for meeting_registrants
+  # List Meeting Registrants
+  # A host or a user with admin permission can require [registration for a Zoom meeting](https://support.zoom.us/hc/en-us/articles/211579443-Registration-for-Meetings). Use this API to list users that have registered for a meeting.<br><br> **Scopes**: `meeting:read:admin` `meeting:read`<br> 
+  # @param meeting_id The meeting ID.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :occurrence_id The meeting occurrence ID.
+  # @option opts [String] :status The registrant status:<br>`pending` - Registrant's status is pending.<br>`approved` - Registrant's status is approved.<br>`denied` - Registrant's status is denied.
+  # @option opts [Integer] :page_size The number of records returned within a single API call.
+  # @option opts [Integer] :page_number The current page number of returned records.
+  # @return [RegistrationList]
+  describe 'meeting_registrants test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for meeting_registrants_questions_get
+  # List Registration Questions 
+  # List registration questions that will be displayed to users while [registering for a meeeting](https://support.zoom.us/hc/en-us/articles/211579443-Registration-for-Meetings).<br>  **Scopes:** `meeting:read`, `meeting:read:admin`<br>    
+  # @param meeting_id The meeting ID.
+  # @param [Hash] opts the optional parameters
+  # @return [InlineResponse20025]
+  describe 'meeting_registrants_questions_get test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for meeting_status
+  # Update Meeting Status
+  # End a meeting by updating its status.<br><br> **Scopes:** `meeting:write:admin` `meeting:write`
+  # @param meeting_id The meeting ID.
+  # @param body 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'meeting_status test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for meeting_update
+  # Update a Meeting
+  # Update the details of a meeting.<br>This API has a rate limit of 100 requests per day. Therefore, a meeting can only be updated for a maximum of 100 times within a 24 hour window.<br> **Scopes:** `meeting:write:admin` `meeting:write`<br>    
+  # @param meeting_id The meeting ID.
+  # @param body Meeting
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :occurrence_id Meeting occurrence id. Support change of agenda, start_time, duration, settings: {host_video, participant_video, join_before_host, mute_upon_entry, waiting_room, watermark, auto_recording}
+  # @return [nil]
+  describe 'meeting_update test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for meetings
+  # List Meetings
+  # List all the meetings that were scheduled for a user (meeting host).<br><br> **Scopes:** `meeting:read:admin` `meeting:read`<br>  
+  # @param user_id The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :type The meeting types: <br>`scheduled` - All the scheduled meetings.<br>`live` - All the live meetings.<br>`upcoming` - All the upcoming meetings.
+  # @option opts [Integer] :page_size The number of records returned within a single API call.
+  # @option opts [Integer] :page_number The current page number of returned records.
+  # @return [GroupList]
+  describe 'meetings test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for past_meeting_details
+  # Get Past Meeting Details
+  # Get details on a past meeting. <br><br> **Scopes:** `meeting:read:admin` `meeting:read`  > **Note**: Please double encode your UUID when using this API if the UUID begins with a '/'or contains '//' in it.
+  # @param meeting_uuid The meeting UUID. Please double encode your UUID when using it for other API calls if the UUID begins with a '/'or contains '//' in it.
+  # @param [Hash] opts the optional parameters
+  # @return [InlineResponse20023]
+  describe 'past_meeting_details test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for past_meeting_participants
+  # Get Past Meeting Participants
+  # Retrieve information on participants from a past meeting. <br><br> **Scopes:** `meeting:read:admin` `meeting:read`  **Prerequisites:**<br> * Paid account on a Pro or higher plan.  <br> <br>  **Note**: Please double encode your UUID when using this API if the UUID begins with a '/'or contains '//' in it. 
+  # @param meeting_uuid The meeting UUID. Please double encode your UUID when using it for other API calls if the UUID begins with a '/'or contains '//' in it.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page_size The number of records returned within a single API call.
+  # @option opts [String] :next_page_token The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.
+  # @return [InlineResponse20024]
+  describe 'past_meeting_participants test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for past_meetings
+  # List Ended Meeting Instances
+  # Get a list of ended meeting instances<br><br> **Scopes:** `meeting:read:admin` `meeting:read`<br>  
+  # @param meeting_id The meeting ID.
+  # @param [Hash] opts the optional parameters
+  # @return [Object]
+  describe 'past_meetings test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end