gong_api 1.0.0

data/lib/gong_api/api/meetings_in_beta_phase_api.rb

@@ -0,0 +1,264 @@
+=begin
+#Gong API
+
+#<h2>Overview</h2> <p> The Gong API allows you to: </p> <ol> <li> Receive the following information from Gong: <ol type=\"a\"> <li> Your company's <a href=\"#tag--Calls\">calls</a> in Gong </li> <li> Your company's <a href=\"#tag--Users\">users</a> in Gong </li> <li> Your company's user <a href=\"#tag--Stats\">stats</a> in Gong </li> <li> Your company's user <a href=\"#tag--Settings\">settings</a> in Gong </li> <li> Your company's <a href=\"#tag--Library\">libraries</a> in Gong </li> </ol></li> <li> <a href=\"#post-/v2/calls\">Upload</a> new or  <a href=\"#put-/v2/calls/-id-/media\">update</a>  call recordings in Gong, in order to support cases where you have an internal system that records  calls or obtains them from a third-party entity. </li> <li> <a href=\"#post-/v2/data-privacy/erase-data-for-email-address\">Data Privacy</a>:  Delete users and all their associated elements.</li> <li> Upload <a href=\"#tag--CRM\">CRM</a> data into Gong.  </li> </ol> <p>Base URL for all API calls is <a href=\"https://us-55616.api.gong.io\"> https://us-55616.api.gong.io </a> </p> <h2>Authentication</h2>  <p> There are two ways to retrieve credentials to the Gong Public API: </p> <ol><li>Retrieve Manually:<br> <p> In the <a href=\"https://app.gong.io/company/api\">Gong API Page</a> (you must be a technical administrator in Gong), click \"Create\" to receive an <b>Access Key</b>  and an <b>Access Key Secret</b>.<br> </p> <p> Use the Basic Authorization HTTP header (as per <a target=\"_blank\" href=\"https://www.rfc-editor.org/rfc/rfc7617.txt\">RFC</a>) to access the Public API as shown below:<br> <code>Authorization: Basic &lt;token&gt;</code><br> </p> <p> To create the basic token, combine the <b>Access Key</b> and the <b>Access Key Secret</b> with  colon (:) and then encode in Base64 as following:<br> <code>Base64(&lt;accessKey&gt; : &lt;accessKeySecret&gt;)</code><br><br> </p></li> <li>Retrieve through OAuth<br> <p> To obtain the Bearer token, follow the steps described in the <a target=\"_blank\" href=\"https://help.gong.io/hc/en-us/articles/360056677792\">Gong OAuth Guide</a>. <br></p> <p> After obtaining the token, use the Bearer Authorization HTTP header (as per <a target=\"_blank\" href=\"https://www.rfc-editor.org/rfc/rfc6750.txt\">RFC</a>) to access the Public API as shown below:<br> <code>Authorization: Bearer &lt;token&gt;</code> </p> </li></ol> <h2>Limits</h2>  <p> By default Gong limits your company's access to the service to 3 API calls per second, and 10,000 API calls per day. </p> <p> When the rate of API calls exceeds these limits an HTTP status code <b>429</b> is returned and a <b>Retry-After</b> header indicates  how many seconds to wait before making a new request. </p><p> If required, contact help@gong.io to change these limits. </p>  <h2>Cursors</h2>  <p> Some API calls that return a list are limited in the amount of records they may return, so multiple API calls may be  required to bring all records. Such an API call also returns a <b>records</b> field, which contains the number of records  in the current page, the current page number and the total number of records. </p> <p> In cases where the total number of records exceeds the number of records thus far retrieved, the <b>records</b> field will also  contain a <b>cursor</b> field which can be used to access the next page of records. To retrieve the next page, repeat the API call with  the <b>cursor</b> value as supplied by the previous API call. All other request inputs should remain the same. </p> <h2>Forward Compatibility</h2>  <p> When coding a system to accept Gong data, take into account that Gong may, without prior warning, add fields to the JSON output.  It is recommended to future proof your code so that it disregards all JSON fields you don't actually use.  </p><p></p>
+
+OpenAPI spec version: V2
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 3.0.37
+=end
+
+module GongAPI
+  class MeetingsInBetaPhaseApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Create a New Gong Meeting (/v2/meetings)
+    # When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:meetings:user:create'.
+    # @param body newMeetingRequest
+    # @param [Hash] opts the optional parameters
+    # @return [NewMeetingResponse]
+    def add_meeting_using_post(body, opts = {})
+      data, _status_code, _headers = add_meeting_using_post_with_http_info(body, opts)
+      data
+    end
+
+    # Create a New Gong Meeting (/v2/meetings)
+    # When accessed through a Bearer token authorization method, this endpoint requires the scope &#x27;api:meetings:user:create&#x27;.
+    # @param body newMeetingRequest
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(NewMeetingResponse, Integer, Hash)>] NewMeetingResponse data, response status code and response headers
+    def add_meeting_using_post_with_http_info(body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MeetingsInBetaPhaseApi.add_meeting_using_post ...'
+      end
+      # verify the required parameter 'body' is set
+      if @api_client.config.client_side_validation && body.nil?
+        fail ArgumentError, "Missing the required parameter 'body' when calling MeetingsInBetaPhaseApi.add_meeting_using_post"
+      end
+      # resource path
+      local_var_path = '/v2/meetings'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] || @api_client.object_to_http_body(body) 
+
+      return_type = opts[:return_type] || 'NewMeetingResponse' 
+
+      auth_names = opts[:auth_names] || []
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type)
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: MeetingsInBetaPhaseApi#add_meeting_using_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Delete a Gong Meeting (/v2/meetings)
+    # When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:meetings:user:delete'.
+    # @param body request
+    # @param meeting_id Gong&#x27;s unique identifier for the meeting (up to 20 digits).
+    # @param [Hash] opts the optional parameters
+    # @return [DeleteMeetingRequest]
+    def delete_meeting_using_delete(body, meeting_id, opts = {})
+      data, _status_code, _headers = delete_meeting_using_delete_with_http_info(body, meeting_id, opts)
+      data
+    end
+
+    # Delete a Gong Meeting (/v2/meetings)
+    # When accessed through a Bearer token authorization method, this endpoint requires the scope &#x27;api:meetings:user:delete&#x27;.
+    # @param body request
+    # @param meeting_id Gong&#x27;s unique identifier for the meeting (up to 20 digits).
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(DeleteMeetingRequest, Integer, Hash)>] DeleteMeetingRequest data, response status code and response headers
+    def delete_meeting_using_delete_with_http_info(body, meeting_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MeetingsInBetaPhaseApi.delete_meeting_using_delete ...'
+      end
+      # verify the required parameter 'body' is set
+      if @api_client.config.client_side_validation && body.nil?
+        fail ArgumentError, "Missing the required parameter 'body' when calling MeetingsInBetaPhaseApi.delete_meeting_using_delete"
+      end
+      # verify the required parameter 'meeting_id' is set
+      if @api_client.config.client_side_validation && meeting_id.nil?
+        fail ArgumentError, "Missing the required parameter 'meeting_id' when calling MeetingsInBetaPhaseApi.delete_meeting_using_delete"
+      end
+      # resource path
+      local_var_path = '/v2/meetings/{meetingId}'.sub('{' + 'meetingId' + '}', meeting_id.to_s)
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['*/*'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] || @api_client.object_to_http_body(body) 
+
+      return_type = opts[:return_type] || 'DeleteMeetingRequest' 
+
+      auth_names = opts[:auth_names] || []
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type)
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: MeetingsInBetaPhaseApi#delete_meeting_using_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Validate Gong meeting Integration (/v2/meetings/integration/status)
+    # When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:meetings:integration:status'.
+    # @param body integrationStatusRequest
+    # @param [Hash] opts the optional parameters
+    # @return [IntegrationStatusResponse]
+    def integration_status_using_post(body, opts = {})
+      data, _status_code, _headers = integration_status_using_post_with_http_info(body, opts)
+      data
+    end
+
+    # Validate Gong meeting Integration (/v2/meetings/integration/status)
+    # When accessed through a Bearer token authorization method, this endpoint requires the scope &#x27;api:meetings:integration:status&#x27;.
+    # @param body integrationStatusRequest
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(IntegrationStatusResponse, Integer, Hash)>] IntegrationStatusResponse data, response status code and response headers
+    def integration_status_using_post_with_http_info(body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MeetingsInBetaPhaseApi.integration_status_using_post ...'
+      end
+      # verify the required parameter 'body' is set
+      if @api_client.config.client_side_validation && body.nil?
+        fail ArgumentError, "Missing the required parameter 'body' when calling MeetingsInBetaPhaseApi.integration_status_using_post"
+      end
+      # resource path
+      local_var_path = '/v2/meetings/integration/status'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] || @api_client.object_to_http_body(body) 
+
+      return_type = opts[:return_type] || 'IntegrationStatusResponse' 
+
+      auth_names = opts[:auth_names] || []
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type)
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: MeetingsInBetaPhaseApi#integration_status_using_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Update a Gong Meeting (/v2/meetings/{meetingId})
+    # When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:meetings:user:update'.
+    # @param body updateMeetingRequest
+    # @param meeting_id Gong&#x27;s unique identifier for the meeting (up to 20 digits).
+    # @param [Hash] opts the optional parameters
+    # @return [UpdateMeetingResponse]
+    def update_meeting_using_put(body, meeting_id, opts = {})
+      data, _status_code, _headers = update_meeting_using_put_with_http_info(body, meeting_id, opts)
+      data
+    end
+
+    # Update a Gong Meeting (/v2/meetings/{meetingId})
+    # When accessed through a Bearer token authorization method, this endpoint requires the scope &#x27;api:meetings:user:update&#x27;.
+    # @param body updateMeetingRequest
+    # @param meeting_id Gong&#x27;s unique identifier for the meeting (up to 20 digits).
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(UpdateMeetingResponse, Integer, Hash)>] UpdateMeetingResponse data, response status code and response headers
+    def update_meeting_using_put_with_http_info(body, meeting_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MeetingsInBetaPhaseApi.update_meeting_using_put ...'
+      end
+      # verify the required parameter 'body' is set
+      if @api_client.config.client_side_validation && body.nil?
+        fail ArgumentError, "Missing the required parameter 'body' when calling MeetingsInBetaPhaseApi.update_meeting_using_put"
+      end
+      # verify the required parameter 'meeting_id' is set
+      if @api_client.config.client_side_validation && meeting_id.nil?
+        fail ArgumentError, "Missing the required parameter 'meeting_id' when calling MeetingsInBetaPhaseApi.update_meeting_using_put"
+      end
+      # resource path
+      local_var_path = '/v2/meetings/{meetingId}'.sub('{' + 'meetingId' + '}', meeting_id.to_s)
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] || @api_client.object_to_http_body(body) 
+
+      return_type = opts[:return_type] || 'UpdateMeetingResponse' 
+
+      auth_names = opts[:auth_names] || []
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type)
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: MeetingsInBetaPhaseApi#update_meeting_using_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end