gong_api 1.0.0

data/docs/ContentSharedEvent.md

@@ -0,0 +1,23 @@
+# GongAPI::ContentSharedEvent
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**action_name** | **String** | The name of the action like \"Document Sent\" or \"Presentation Shared\". | [optional] 
+**content_id** | **String** | The id of the content that was shared in the reporting system. | 
+**content_properties** | [**Array<GenericProperty>**](GenericProperty.md) | A list of additional properties for the content | [optional] 
+**content_title** | **String** | Human readable title of the content. | 
+**content_url** | **String** | The url of the content that was shared in the reporting system. This is the url that is was accessed by the viewer. | 
+**crm_context** | [**Array<CallUploadContext>**](CallUploadContext.md) | A list of references to external systems such as CRM, Telephony System, Case Management, etc. | [optional] 
+**event_id** | **String** | The original id of the event as designated in the reporting system. | [optional] 
+**event_properties** | [**Array<GenericProperty>**](GenericProperty.md) | A list of additional properties for the event | [optional] 
+**event_timestamp** | **String** | The date and time when the event happened in the ISO-8601 format (e.g., '2021-08-01T02:30:00+05:00' or '2021-08-01T08:00:00Z', where Z stands for UTC); | 
+**recipients** | [**Array<Actor>**](Actor.md) | array of objects with  name + email of recipients. Email is required. | [optional] 
+**reporting_system** | **String** | The unique identifier of the reporting system. It is the same value in all events originating from the same system. | 
+**share_id** | **String** | The id of the share action, in case there can be more than one share per content. | [optional] 
+**share_info_url** | **String** | The link to a page that presents additional information about this event. | [optional] 
+**sharer** | [**Sharer**](Sharer.md) |  | [optional] 
+**sharing_message_body** | **String** | The share message body. Can contain HTML and will be cleaned when it is presented. | [optional] 
+**sharing_message_subject** | **String** | The subject of share email / message. | [optional] 
+**workspace_id** | **String** | Optional workspace identifier. If specified, the event will be placed into this workspace, otherwise, the default algorithm for workspace placement will be applied. | [optional] 
+

data/docs/ContentViewedEvent.md

@@ -0,0 +1,23 @@
+# GongAPI::ContentViewedEvent
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**agent_platform** | **String** | Platform on which the interaction was made | [optional] 
+**content_id** | **String** | The id of the content that was viewed in the reporting system. | 
+**content_properties** | [**Array<GenericProperty>**](GenericProperty.md) | A list of additional properties for the content | [optional] 
+**content_title** | **String** | Human readable title of the content. | 
+**content_url** | **String** | The url of the content that was viewed in the reporting system. This is the url that is was accessed by the viewer. | 
+**crm_context** | [**Array<CallUploadContext>**](CallUploadContext.md) | A list of references to external systems such as CRM, Telephony System, Case Management, etc. | [optional] 
+**event_id** | **String** | The original id of the event as designated in the reporting system. | [optional] 
+**event_properties** | [**Array<GenericProperty>**](GenericProperty.md) | A list of additional properties for the event | [optional] 
+**event_timestamp** | **String** | The date and time when the event happened in the ISO-8601 format (e.g., '2021-08-01T02:30:00+05:00' or '2021-08-01T08:00:00Z', where Z stands for UTC); | 
+**mobile_app_id** | **String** | The application identification string in case of interaction via mobile application (bundle identifier or package name). | [optional] 
+**reporting_system** | **String** | The unique identifier of the reporting system. It is the same value in all events originating from the same system. | 
+**share_id** | **String** | The id of the share action that corresponds to this view event, in case there can be more than one share per content. | [optional] 
+**user_agent** | **String** | \"User-Agent\" header value for browser based interaction | [optional] 
+**view_action_title** | **String** | The name of the action like \"Document Viewed\" or \"Presentation Opened\". | [optional] 
+**view_info_url** | **String** | The link to a page that presents additional information about this event. | [optional] 
+**viewer** | [**Actor**](Actor.md) |  | [optional] 
+**workspace_id** | **String** | Optional workspace identifier. If specified, the event will be placed into this workspace, otherwise, the default algorithm for workspace placement will be applied. | [optional] 
+

data/docs/ContextField.md

@@ -0,0 +1,8 @@
+# GongAPI::ContextField
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Field name. For Account supported fields are: Name, Website, Industry and all the custom fields. For Opportunity supported fields are Name, LeadSource, Type, StageName, Probability, Amount, CloseDate and all the custom fields. | [optional] 
+**value** | **Object** | Field value | [optional] 
+

data/docs/CrmPartyContextField.md

@@ -0,0 +1,8 @@
+# GongAPI::CrmPartyContextField
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Field name | [optional] 
+**value** | **Object** | Object value | [optional] 
+

data/docs/CustomActionEvent.md

@@ -0,0 +1,22 @@
+# GongAPI::CustomActionEvent
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**action_name** | **String** | The name of the action like \"Document Viewed\" or \"Presentation Opened\". | [optional] 
+**actor** | [**Actor**](Actor.md) |  | [optional] 
+**agent_platform** | **String** | Platform on which the interaction was made | [optional] 
+**content_id** | **String** | The id of the content that was viewed in the reporting system. | [optional] 
+**content_properties** | [**Array<GenericProperty>**](GenericProperty.md) | A list of additional properties for the content | [optional] 
+**content_title** | **String** | Human readable title of the content. | [optional] 
+**content_url** | **String** | The url of the content that was viewed in the reporting system. This is the url that is was accessed by the viewer. | [optional] 
+**crm_context** | [**Array<CallUploadContext>**](CallUploadContext.md) | A list of references to external systems such as CRM, Telephony System, Case Management, etc. | [optional] 
+**event_id** | **String** | The original id of the event as designated in the reporting system. | [optional] 
+**event_info_url** | **String** | The link to a page that presents additional information about this event. | [optional] 
+**event_properties** | [**Array<GenericProperty>**](GenericProperty.md) | A list of additional properties for the event | [optional] 
+**event_timestamp** | **String** | The date and time when the event happened in the ISO-8601 format (e.g., '2021-08-01T02:30:00+05:00' or '2021-08-01T08:00:00Z', where Z stands for UTC); | 
+**mobile_app_id** | **String** | The application identification string in case of interaction via mobile application (bundle identifier or package name). | [optional] 
+**reporting_system** | **String** | The unique identifier of the reporting system. It is the same value in all events originating from the same system. | 
+**user_agent** | **String** | \"User-Agent\" header value for browser based interaction | [optional] 
+**workspace_id** | **String** | Optional workspace identifier. If specified, the event will be placed into this workspace, otherwise, the default algorithm for workspace placement will be applied. | [optional] 
+

data/docs/CustomerData.md

@@ -0,0 +1,8 @@
+# GongAPI::CustomerData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**objects** | [**Array<CustomerDataObject>**](CustomerDataObject.md) | List of objects in the external system. | [optional] 
+**system** | **String** | External system name. | [optional] 
+

data/docs/CustomerDataObject.md

@@ -0,0 +1,11 @@
+# GongAPI::CustomerDataObject
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**external_id** | **String** | External ID. | [optional] 
+**fields** | [**Array<ContextField>**](ContextField.md) | Object fields. | [optional] 
+**id** | **String** | Gong's unique numeric identifier (up to 20 digits) for the Lead or Contact. | [optional] 
+**mirror_id** | **String** | Crm Mirror ID. | [optional] 
+**object_type** | **String** | Object Type. | [optional] 
+

data/docs/CustomerEngagement.md

@@ -0,0 +1,13 @@
+# GongAPI::CustomerEngagement
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**content_id** | **String** | Event content id | [optional] 
+**content_url** | **String** | Event content url | [optional] 
+**event_name** | **String** | Event name | [optional] 
+**event_type** | **String** | Event type | [optional] 
+**reporting_system** | **String** | Event reporting system | [optional] 
+**source_event_id** | **String** | Source event Id  | [optional] 
+**timestamp** | **String** | The date and time the event occurred 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/DailyActivityWithDates.md

@@ -0,0 +1,23 @@
+# GongAPI::DailyActivityWithDates
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**calls_as_host** | **Object** | List of IDs of calls in which this user is the host. | [optional] 
+**calls_attended** | **Object** | List of IDs of calls in which this user is participant (not host) | [optional] 
+**calls_comments_given** | **Object** | List of IDs of calls in which a user gave at least one comment. | [optional] 
+**calls_comments_received** | **Object** | List of IDs of calls in which a user received at least one comment on the users calls. | [optional] 
+**calls_gave_feedback** | **Object** | List of IDs of calls where the user gave feedback. | [optional] 
+**calls_marked_as_feedback_given** | **Object** |  List of IDs of calls in which someone pressed the \"Mark as reviewed\". | [optional] 
+**calls_marked_as_feedback_received** | **Object** | List of IDs of calls in which someone pressed the \"Mark as reviewed\" on the users calls. | [optional] 
+**calls_received_feedback** | **Object** |  List of IDs of calls where the user received feedback. | [optional] 
+**calls_requested_feedback** | **Object** |  List of IDs of calls where the user requested feedback. | [optional] 
+**calls_scorecards_filled** | **Object** | List of IDs of calls in which the user filled scorecards. | [optional] 
+**calls_scorecards_received** | **Object** | List of IDs of calls in which someone filled a scorecard on the users calls. | [optional] 
+**calls_shared_externally** | **Object** | List of IDs of calls the user shared with people outside the company. | [optional] 
+**calls_shared_internally** | **Object** | List of IDs of calls the user shared with other users inside the company. | [optional] 
+**from_date** | **String** | The start of the day 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** | **Object** | List of IDs of calls, not belonging to this user, that the user listened to. | [optional] 
+**own_calls_listened_to** | **Object** | List of IDs of the user's own calls, that the user listened to. | [optional] 
+**to_date** | **String** | The end of the day 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/DataPrivacyApi.md

@@ -0,0 +1,195 @@
+# GongAPI::DataPrivacyApi
+
+All URIs are relative to *//127.0.0.1/*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**find_all_references_to_email_address_using_get**](DataPrivacyApi.md#find_all_references_to_email_address_using_get) | **GET** /v2/data-privacy/data-for-email-address | Retrieve all references to an email address. (/v2/data-privacy/data-for-email-address)
+[**find_all_references_to_phone_number_using_get**](DataPrivacyApi.md#find_all_references_to_phone_number_using_get) | **GET** /v2/data-privacy/data-for-phone-number | Retrieve all references to a phone number. (/v2/data-privacy/data-for-phone-number)
+[**purge_email_address_using_post**](DataPrivacyApi.md#purge_email_address_using_post) | **POST** /v2/data-privacy/erase-data-for-email-address | Delete the email address, and all associated elements (/v2/data-privacy/erase-data-for-email-address)
+[**purge_phone_number_using_post**](DataPrivacyApi.md#purge_phone_number_using_post) | **POST** /v2/data-privacy/erase-data-for-phone-number | Delete the phone number, and all associated elements (/v2/data-privacy/erase-data-for-phone-number)
+
+# **find_all_references_to_email_address_using_get**
+> EmailAddressReferences find_all_references_to_email_address_using_get(email_address)
+
+Retrieve all references to an email address. (/v2/data-privacy/data-for-email-address)
+
+Shows the elements in the Gong system that reference the given email address. Given an emails address, this endpoint returns details of all calls and email messages that reference this address, and any leads or contacts with this email address.  When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:data-privacy:read'.
+
+### Example
+```ruby
+# load the gem
+require 'gong_api'
+
+api_instance = GongAPI::DataPrivacyApi.new
+email_address = 'email_address_example' # String | The email address.
+
+
+begin
+  #Retrieve all references to an email address. (/v2/data-privacy/data-for-email-address)
+  result = api_instance.find_all_references_to_email_address_using_get(email_address)
+  p result
+rescue GongAPI::ApiError => e
+  puts "Exception when calling DataPrivacyApi->find_all_references_to_email_address_using_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **email_address** | **String**| The email address. | 
+
+### Return type
+
+[**EmailAddressReferences**](EmailAddressReferences.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **find_all_references_to_phone_number_using_get**
+> PhoneNumberReferences find_all_references_to_phone_number_using_get(phone_number)
+
+Retrieve all references to a phone number. (/v2/data-privacy/data-for-phone-number)
+
+Shows the elements in the Gong system that reference the given phone number. Given a phone number, this endpoint returns details of any leads or contacts with this phone number and their associated calls and email messages.  When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:data-privacy:read'.
+
+### Example
+```ruby
+# load the gem
+require 'gong_api'
+
+api_instance = GongAPI::DataPrivacyApi.new
+phone_number = 'phone_number_example' # String | The phone number.  This number must start with a + (plus) sign followed by the country code, area code, and local phone number. All other non-digits are ignored.  The following are examples of permitted phone numbers: +1 425 555 2671, +1-425-555-2671, +1 425 5552671, +14255552671, +1 425 555 26 71, +1(425) 555-2671, etc.  Note: This parameter should be URL-encoded.
+
+
+begin
+  #Retrieve all references to a phone number. (/v2/data-privacy/data-for-phone-number)
+  result = api_instance.find_all_references_to_phone_number_using_get(phone_number)
+  p result
+rescue GongAPI::ApiError => e
+  puts "Exception when calling DataPrivacyApi->find_all_references_to_phone_number_using_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **phone_number** | **String**| The phone number.  This number must start with a + (plus) sign followed by the country code, area code, and local phone number. All other non-digits are ignored.  The following are examples of permitted phone numbers: +1 425 555 2671, +1-425-555-2671, +1 425 5552671, +14255552671, +1 425 555 26 71, +1(425) 555-2671, etc.  Note: This parameter should be URL-encoded. | 
+
+### Return type
+
+[**PhoneNumberReferences**](PhoneNumberReferences.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **purge_email_address_using_post**
+> BaseResponse purge_email_address_using_post(email_address)
+
+Delete the email address, and all associated elements (/v2/data-privacy/erase-data-for-email-address)
+
+Given an email address, this endpoint deletes from the Gong system any calls or email messages that reference this address. Email messages sent to or from the address are deleted. Calls where the email address appears (as a lead, contact, attendee or speaker) are deleted. Leads or Contacts with the email address are deleted. The deletion is not immediate, and may take several hours to complete.  This endpoint contains a data integrity protection mechanism to prevent the deletion of an abnormal number of objects. If the deletion fails please contact support at help@gong.io  Delete the data from your CRM and email system before performing this operation so that private data is not re-imported into Gong.  When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:data-privacy:delete'.
+
+### Example
+```ruby
+# load the gem
+require 'gong_api'
+
+api_instance = GongAPI::DataPrivacyApi.new
+email_address = 'email_address_example' # String | The email address.
+
+
+begin
+  #Delete the email address, and all associated elements (/v2/data-privacy/erase-data-for-email-address)
+  result = api_instance.purge_email_address_using_post(email_address)
+  p result
+rescue GongAPI::ApiError => e
+  puts "Exception when calling DataPrivacyApi->purge_email_address_using_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **email_address** | **String**| The email address. | 
+
+### Return type
+
+[**BaseResponse**](BaseResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **purge_phone_number_using_post**
+> BaseResponse purge_phone_number_using_post(phone_number)
+
+Delete the phone number, and all associated elements (/v2/data-privacy/erase-data-for-phone-number)
+
+Given a phone number, this endpoint deletes from the Gong system any leads or contacts with a matching phone number or mobile phone number. Email messages sent to or from these leads/contacts are deleted. Calls where the leads/contacts appear are deleted. The deletion is not immediate, and may take several hours to complete.  This endpoint contains a data integrity protection mechanism to prevent the deletion of an abnormal number of objects. If the deletion fails please contact support at help@gong.io  Delete the data from your CRM and email system before performing this operation so that private data is not re-imported into Gong.  When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:data-privacy:delete'.
+
+### Example
+```ruby
+# load the gem
+require 'gong_api'
+
+api_instance = GongAPI::DataPrivacyApi.new
+phone_number = 'phone_number_example' # String | The phone number.  This number must start with a + (plus) sign followed by the country code, area code, and local phone number. All other non-digits are ignored.  The following are examples of permitted phone numbers: +1 425 555 2671, +1-425-555-2671, +1 425 5552671, +14255552671, +1 425 555 26 71, +1(425) 555-2671, etc.  Note: This parameter should be URL-encoded.
+
+
+begin
+  #Delete the phone number, and all associated elements (/v2/data-privacy/erase-data-for-phone-number)
+  result = api_instance.purge_phone_number_using_post(phone_number)
+  p result
+rescue GongAPI::ApiError => e
+  puts "Exception when calling DataPrivacyApi->purge_phone_number_using_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **phone_number** | **String**| The phone number.  This number must start with a + (plus) sign followed by the country code, area code, and local phone number. All other non-digits are ignored.  The following are examples of permitted phone numbers: +1 425 555 2671, +1-425-555-2671, +1 425 5552671, +14255552671, +1 425 555 26 71, +1(425) 555-2671, etc.  Note: This parameter should be URL-encoded. | 
+
+### Return type
+
+[**BaseResponse**](BaseResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/DealsAccessWithPermissionLevel.md

@@ -0,0 +1,8 @@
+# GongAPI::DealsAccessWithPermissionLevel
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**permission_level** | **String** | Permission access scope. | [optional] 
+**team_lead_ids** | **Array<String>** | List of user IDs to populate the managers-team permission level  You can retrieve the user ids by using the “Users” API. | [optional] 
+

data/docs/DeleteMeetingRequest.md

@@ -0,0 +1,7 @@
+# GongAPI::DeleteMeetingRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**organizer_email** | **String** | The email address of the user who created the meeting. | [optional] 
+

data/docs/EmailAddressReferences.md

@@ -0,0 +1,12 @@
+# GongAPI::EmailAddressReferences
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**calls** | [**Array<CallReference>**](CallReference.md) | Related calls. | [optional] 
+**customer_data** | [**Array<CustomerData>**](CustomerData.md) | A list of links to data from external systems (such as CRM, Telephony System, Case Management, etc.) that reference the email address and that Gong stores. | [optional] 
+**customer_engagement** | [**Array<CustomerEngagement>**](CustomerEngagement.md) | A list of customer's engagement (such as viewing external share call) | [optional] 
+**emails** | [**Array<EmailMessage>**](EmailMessage.md) | Related email messages. | [optional] 
+**meetings** | [**Array<Meeting>**](Meeting.md) | Related meetings. | [optional] 
+**request_id** | **String** | A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes. | [optional] 
+

data/docs/EmailMessage.md

@@ -0,0 +1,11 @@
+# GongAPI::EmailMessage
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**from** | **String** | The sender's email address. | [optional] 
+**id** | **String** | Gong's unique 32 character identifier for the email message. | [optional] 
+**mailbox** | **String** | The mailbox from which the email was retrieved. | [optional] 
+**message_hash** | **String** | Hash code of the email message. | [optional] 
+**sent_time** | **String** | The date and time the email message was sent 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/EmailsAccessWithPermissionLevel.md

@@ -0,0 +1,8 @@
+# GongAPI::EmailsAccessWithPermissionLevel
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**permission_level** | **String** | Permission access scope. | [optional] 
+**team_lead_ids** | **Array<String>** | List of user IDs to populate the managers-team permission level  You can retrieve the user ids by using the “Users” API. | [optional] 
+

data/docs/EngagementInBetaPhaseApi.md

@@ -0,0 +1,148 @@
+# GongAPI::EngagementInBetaPhaseApi
+
+All URIs are relative to *//127.0.0.1/*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**content_shared_using_put**](EngagementInBetaPhaseApi.md#content_shared_using_put) | **PUT** /v2/customer-engagement/content/shared | Report event of a content share (/v2/customer-engagement/content/shared)
+[**content_viewed_using_put**](EngagementInBetaPhaseApi.md#content_viewed_using_put) | **PUT** /v2/customer-engagement/content/viewed | Report event of a content view (/v2/customer-engagement/content/viewed)
+[**custom_action_using_put**](EngagementInBetaPhaseApi.md#custom_action_using_put) | **PUT** /v2/customer-engagement/action | Report event of a custom action (/v2/customer-engagement/action)
+
+# **content_shared_using_put**
+> BaseResponse content_shared_using_put(body)
+
+Report event of a content share (/v2/customer-engagement/content/shared)
+
+Push engagement events into Gong and display them as events in Gong’s activity timeline, when a Gong user shares content with external participants (for example, a contract was “shared” by the account executive with his prospects)  When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:engagement-data:write'.
+
+### Example
+```ruby
+# load the gem
+require 'gong_api'
+
+api_instance = GongAPI::EngagementInBetaPhaseApi.new
+body = GongAPI::ContentSharedEvent.new # ContentSharedEvent | request
+
+
+begin
+  #Report event of a content share (/v2/customer-engagement/content/shared)
+  result = api_instance.content_shared_using_put(body)
+  p result
+rescue GongAPI::ApiError => e
+  puts "Exception when calling EngagementInBetaPhaseApi->content_shared_using_put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**ContentSharedEvent**](ContentSharedEvent.md)| request | 
+
+### Return type
+
+[**BaseResponse**](BaseResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+
+# **content_viewed_using_put**
+> BaseResponse content_viewed_using_put(body)
+
+Report event of a content view (/v2/customer-engagement/content/viewed)
+
+Push engagement events into Gong and display them as events in Gong’s activity timeline, when a content is viewed by an external participant (for example, a contract was “viewed” by the prospect)  When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:engagement-data:write'.
+
+### Example
+```ruby
+# load the gem
+require 'gong_api'
+
+api_instance = GongAPI::EngagementInBetaPhaseApi.new
+body = GongAPI::ContentViewedEvent.new # ContentViewedEvent | request
+
+
+begin
+  #Report event of a content view (/v2/customer-engagement/content/viewed)
+  result = api_instance.content_viewed_using_put(body)
+  p result
+rescue GongAPI::ApiError => e
+  puts "Exception when calling EngagementInBetaPhaseApi->content_viewed_using_put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**ContentViewedEvent**](ContentViewedEvent.md)| request | 
+
+### Return type
+
+[**BaseResponse**](BaseResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+
+# **custom_action_using_put**
+> BaseResponse custom_action_using_put(body)
+
+Report event of a custom action (/v2/customer-engagement/action)
+
+Push engagement events into Gong and display them as events in Gong’s activity timeline, when a content is engaged by an external participant (for example, a contract was “signed” by the prospect)  When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:engagement-data:write'.
+
+### Example
+```ruby
+# load the gem
+require 'gong_api'
+
+api_instance = GongAPI::EngagementInBetaPhaseApi.new
+body = GongAPI::CustomActionEvent.new # CustomActionEvent | request
+
+
+begin
+  #Report event of a custom action (/v2/customer-engagement/action)
+  result = api_instance.custom_action_using_put(body)
+  p result
+rescue GongAPI::ApiError => e
+  puts "Exception when calling EngagementInBetaPhaseApi->custom_action_using_put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**CustomActionEvent**](CustomActionEvent.md)| request | 
+
+### Return type
+
+[**BaseResponse**](BaseResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+

data/docs/ErrorResponse.md

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

data/docs/EventAcceptedResponse.md

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

data/docs/ExposedFields.md

@@ -0,0 +1,11 @@
+# GongAPI::ExposedFields
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**collaboration** | [**CallCollaboration**](CallCollaboration.md) |  | [optional] 
+**content** | [**CallContent**](CallContent.md) |  | [optional] 
+**interaction** | [**CallInteraction**](CallInteraction.md) |  | [optional] 
+**media** | **BOOLEAN** | If true and exist, add audio url and video url of the call. The urls will be available for 8 hours. | [optional] 
+**parties** | **BOOLEAN** | If true, add information about the parties of the call | [optional] 
+

data/docs/ExternalCallObject.md

@@ -0,0 +1,10 @@
+# GongAPI::ExternalCallObject
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**fields** | [**Array<ContextField>**](ContextField.md) | Object fields | [optional] 
+**object_id** | **String** | Object ID | [optional] 
+**object_type** | **String** | Object Type. e.g Opportunity. | [optional] 
+**timing** | **String** | Timing of object | [optional] 
+

data/docs/ExternalCrmCallObject.md

@@ -0,0 +1,9 @@
+# GongAPI::ExternalCrmCallObject
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**fields** | [**Array<ContextField>**](ContextField.md) | Object fields. Intended for future use only. | [optional] 
+**object_id** | **String** | Object ID. For Salesforce both case-sensitive and case-insensitive formats are supported. | 
+**object_type** | **String** | Object Type. e.g. Account. | 
+

data/docs/ExternalCrmPartyObject.md

@@ -0,0 +1,9 @@
+# GongAPI::ExternalCrmPartyObject
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**fields** | [**Array<CrmPartyContextField>**](CrmPartyContextField.md) | Object fields. Intended for future use only. | [optional] 
+**object_id** | **String** | Object ID. For Salesforce both case-sensitive and case-insensitive formats are supported. | 
+**object_type** | **String** | Object Type. Valid only for non-company parties. e.g. Lead. | 
+

data/docs/ExternalPartyObject.md

@@ -0,0 +1,10 @@
+# GongAPI::ExternalPartyObject
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**fields** | [**Array<PartyContextField>**](PartyContextField.md) | Object fields | [optional] 
+**object_id** | **String** | Object ID | [optional] 
+**object_type** | **String** | Object Type. e.g. Lead | [optional] 
+**timing** | **String** | Timing of object | [optional] 
+

data/docs/ExternalSystem.md

@@ -0,0 +1,8 @@
+# GongAPI::ExternalSystem
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**objects** | [**Array<ExternalSystemObject>**](ExternalSystemObject.md) | List of objects within the external system. | [optional] 
+**system** | **String** | External system name. | [optional] 
+

data/docs/ExternalSystemObject.md

@@ -0,0 +1,8 @@
+# GongAPI::ExternalSystemObject
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**external_id** | **String** | External ID. | [optional] 
+**object_type** | **String** | Object Type. | [optional] 
+