gong_api 1.0.0

data/Rakefile

@@ -0,0 +1,8 @@
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/config.json

@@ -0,0 +1,12 @@
+{
+  "gemName": "gong_api",
+  "moduleName": "GongAPI",
+  "gemVersion": "1.0.0",
+  "gemLicense": "MIT",
+  "gemHomepage": "https://gitlab.com/optonal/gong-api",
+  "gemSummary": "A Ruby Swagger API client for Gong",
+  "gemDescription": "A Ruby Swagger API client for Gong",
+  "gemAuthor": "OpTonal Inc.",
+  "gemAuthorEmail": "matija@optonal.com",
+  "hideGenerationTimestamp": false
+}

data/docs/Actor.md

@@ -0,0 +1,10 @@
+# GongAPI::Actor
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**context** | [**Array<PartyUploadContext>**](PartyUploadContext.md) | A list of links to external systems such as CRM, Telephony System, Case Management, etc. | [optional] 
+**email** | **String** | The email address of the person, if available. | [optional] 
+**name** | **String** | The name of the person, if available. | [optional] 
+**title** | **String** | The title of the person, if available. | [optional] 
+

data/docs/AggregateActivity.md

@@ -0,0 +1,21 @@
+# GongAPI::AggregateActivity
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**calls_as_host** | **Integer** | The number of recorded calls this user hosted. | [optional] 
+**calls_attended** | **Integer** | The number of calls in which this user is participant (not host). | [optional] 
+**calls_comments_given** | **Integer** | The number of calls in which a user gave at least one comment. | [optional] 
+**calls_comments_received** | **Integer** | The number of calls in which a user received at least one comment on the users calls. | [optional] 
+**calls_gave_feedback** | **Integer** | The number of recorded calls the user gave feedback on. | [optional] 
+**calls_marked_as_feedback_given** | **Integer** | The number of calls in which someone pressed the \"Mark as reviewed\". | [optional] 
+**calls_marked_as_feedback_received** | **Integer** | The number of calls in which someone pressed the “Mark as reviewed” on the users calls. | [optional] 
+**calls_received_feedback** | **Integer** | The number of recorded calls the user received feedback on. | [optional] 
+**calls_requested_feedback** | **Integer** | The number of recorded calls the user requested feedback on. | [optional] 
+**calls_scorecards_filled** | **Integer** | The number of scorecards the user completed. | [optional] 
+**calls_scorecards_received** | **Integer** | The number of calls in which someone filled a scorecard on the user's calls. | [optional] 
+**calls_shared_externally** | **Integer** | The number of calls the user shared with others outside the company. | [optional] 
+**calls_shared_internally** | **Integer** | The number of calls the user shared with others inside the company. | [optional] 
+**others_calls_listened_to** | **Integer** | The number of other users' calls the user listened to. | [optional] 
+**own_calls_listened_to** | **Integer** | The number of the user's own calls the user listened to. | [optional] 
+

data/docs/AggregateActivityWithDates.md

@@ -0,0 +1,23 @@
+# GongAPI::AggregateActivityWithDates
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**calls_as_host** | **Integer** | The number of recorded calls this user hosted. | [optional] 
+**calls_attended** | **Integer** | The number of calls in which this user is participant (not host). | [optional] 
+**calls_comments_given** | **Integer** | The number of calls in which a user gave at least one comment. | [optional] 
+**calls_comments_received** | **Integer** | The number of calls in which a user received at least one comment on the users calls. | [optional] 
+**calls_gave_feedback** | **Integer** | The number of recorded calls the user gave feedback on. | [optional] 
+**calls_marked_as_feedback_given** | **Integer** | The number of calls in which someone pressed the \"Mark as reviewed\". | [optional] 
+**calls_marked_as_feedback_received** | **Integer** | The number of calls in which someone pressed the “Mark as reviewed” on the users calls. | [optional] 
+**calls_received_feedback** | **Integer** | The number of recorded calls the user received feedback on. | [optional] 
+**calls_requested_feedback** | **Integer** | The number of recorded calls the user requested feedback on. | [optional] 
+**calls_scorecards_filled** | **Integer** | The number of scorecards the user completed. | [optional] 
+**calls_scorecards_received** | **Integer** | The number of calls in which someone filled a scorecard on the user's calls. | [optional] 
+**calls_shared_externally** | **Integer** | The number of calls the user shared with others outside the company. | [optional] 
+**calls_shared_internally** | **Integer** | The number of calls the user shared with others inside the company. | [optional] 
+**from_date** | **String** | The start of the period, or the request filter's fromDate for the first period in the range, in the ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC). | [optional] 
+**others_calls_listened_to** | **Integer** | The number of other users' calls the user listened to. | [optional] 
+**own_calls_listened_to** | **Integer** | The number of the user's own calls the user listened to. | [optional] 
+**to_date** | **String** | The end of the period, or the request filter's toDate for the last period in the range,  in the ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC). | [optional] 
+

data/docs/Answer.md

@@ -0,0 +1,12 @@
+# GongAPI::Answer
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**answer_text** | **String** | The answer's text, if answered. Null otherwise. | [optional] 
+**is_overall** | **BOOLEAN** | If the question is the main overall question or not. | [optional] 
+**not_applicable** | **BOOLEAN** | If the question is irrelevant for the call. | [optional] 
+**question_id** | **String** | The identifier of the question. | [optional] 
+**question_revision_id** | **String** | The identifier of the revision version of the question. | [optional] 
+**score** | **Integer** | Score between 1 to 5, if answered. Null otherwise. | [optional] 
+

data/docs/AnsweredScorecard.md

@@ -0,0 +1,16 @@
+# GongAPI::AnsweredScorecard
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**answered_scorecard_id** | **String** | The identifier of the answer of the scorecard. | [optional] 
+**answers** | [**Array<Answer>**](Answer.md) | The answers in the answered scorecard. | [optional] 
+**call_id** | **String** | Gong's unique numeric identifier for the call (up to 20 digits). | [optional] 
+**call_start_time** | **String** | The date and time when the call was recorded in the ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC). | [optional] 
+**review_time** | **String** | The date and time when the review was completed and published in the ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC). | [optional] 
+**reviewed_user_id** | **String** | The user Id of the team member being reviewed, who hosted the call. | [optional] 
+**reviewer_user_id** | **String** | The user Id of the team member who answered the scorecard for the call. | [optional] 
+**scorecard_id** | **String** | The identifier of the scorecard. | [optional] 
+**scorecard_name** | **String** | Scorecard name. | [optional] 
+**visibility_type** | **String** |  | [optional] 
+

data/docs/AnsweredScorecards.md

@@ -0,0 +1,9 @@
+# GongAPI::AnsweredScorecards
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**answered_scorecards** | [**Array<AnsweredScorecard>**](AnsweredScorecard.md) | A list, in which each item contains one answered scorecard. | [optional] 
+**records** | [**Records**](Records.md) |  | [optional] 
+**request_id** | **String** | A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes. | [optional] 
+

data/docs/AnsweredScorecardsFilter.md

@@ -0,0 +1,12 @@
+# GongAPI::AnsweredScorecardsFilter
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**call_from_date** | **String** | The date (in the company's time zone) of the call from when to list calls. This value is inclusive. The date should be specified in the following format: YYYY-MM-DD; if not specified, it starts with the earliest recorded call. | [optional] 
+**call_to_date** | **String** | The date (in the company's time zone) of the call until when to list calls. This value is exclusive. The date should be specified in the following format: YYYY-MM-DD; if not specified, it ends with the latest recorded call. | [optional] 
+**review_from_date** | **String** | The review date (in the company's time zone) from when to list calls. This value is inclusive. The date should be specified in the following format: YYYY-MM-DD; if not specified, it starts with the earliest reviewed call. | [optional] 
+**review_to_date** | **String** | The review date (in the company's time zone) until when to list calls. This value is exclusive. The date should be specified in the following format: YYYY-MM-DD; if not specified, it ends with the latest reviewed call. | [optional] 
+**reviewed_user_ids** | **Object** | List of user Ids of the team members being reviewed. If not specified, it returns all answered scorecards in the corresponding filter. | [optional] 
+**scorecard_ids** | **Object** | List of scorecards Ids. If not specified, it returns all answered scorecards in the corresponding filter. | [optional] 
+

data/docs/AssociationObject.md

@@ -0,0 +1,8 @@
+# GongAPI::AssociationObject
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_crm_id** | **String** | CRM account Id. | [optional] 
+**deal_crm_id** | **String** | CRM deal Id, if deal/opportunity was associated. | [optional] 
+

data/docs/AsyncProcessingResponse.md

@@ -0,0 +1,8 @@
+# GongAPI::AsyncProcessingResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**client_request_id** | **String** | The clientRequestId sent in the request - used to monitor the request process | [optional] 
+**request_id** | **String** | A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes. | [optional] 
+

data/docs/AuditingApi.md

@@ -0,0 +1,61 @@
+# GongAPI::AuditingApi
+
+All URIs are relative to *//127.0.0.1/*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**list_logs_using_get**](AuditingApi.md#list_logs_using_get) | **GET** /v2/logs | Retrieve logs data by type and time range (/v2/logs)
+
+# **list_logs_using_get**
+> LogsResponse list_logs_using_get(from_date_time, log_type, opts)
+
+Retrieve logs data by type and time range (/v2/logs)
+
+List log entries that took place during a specified time range.  When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:logs:read'.
+
+### Example
+```ruby
+# load the gem
+require 'gong_api'
+
+api_instance = GongAPI::AuditingApi.new
+from_date_time = 'from_date_time_example' # String | The time from which to retrieve log records, in the ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC).
+log_type = 'log_type_example' # String | Type of logs requested.
+opts = { 
+  cursor: 'cursor_example', # String | When paging is needed, provide the value supplied by the previous API call to bring the following page of records.
+  to_date_time: 'to_date_time_example' # String | The time until which to retrieve log records, in the ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC); if not specified, the logs end with the latest recorded log.
+}
+
+begin
+  #Retrieve logs data by type and time range (/v2/logs)
+  result = api_instance.list_logs_using_get(from_date_time, log_type, opts)
+  p result
+rescue GongAPI::ApiError => e
+  puts "Exception when calling AuditingApi->list_logs_using_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **from_date_time** | **String**| The time from which to retrieve log records, in the ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC). | 
+ **log_type** | **String**| Type of logs requested. | 
+ **cursor** | **String**| When paging is needed, provide the value supplied by the previous API call to bring the following page of records. | [optional] 
+ **to_date_time** | **String**| The time until which to retrieve log records, in the ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC); if not specified, the logs end with the latest recorded log. | [optional] 
+
+### Return type
+
+[**LogsResponse**](LogsResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/BaseResponse.md

@@ -0,0 +1,7 @@
+# GongAPI::BaseResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**request_id** | **String** | A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes. | [optional] 
+