Module: GongAPI

Defined in:: lib/gong_api/version.rb,
lib/gong_api.rb,
lib/gong_api/api_error.rb,
lib/gong_api/api_client.rb,
lib/gong_api/api/crm_api.rb,
lib/gong_api/models/call.rb,
lib/gong_api/models/user.rb,
lib/gong_api/models/actor.rb,
lib/gong_api/models/calls.rb,
lib/gong_api/models/media.rb,
lib/gong_api/models/party.rb,
lib/gong_api/models/topic.rb,
lib/gong_api/models/video.rb,
lib/gong_api/api/calls_api.rb,
lib/gong_api/api/stats_api.rb,
lib/gong_api/api/users_api.rb,
lib/gong_api/configuration.rb,
lib/gong_api/models/answer.rb,
lib/gong_api/models/sharer.rb,
lib/gong_api/models/comment.rb,
lib/gong_api/models/content.rb,
lib/gong_api/models/meeting.rb,
lib/gong_api/models/records.rb,
lib/gong_api/models/snippet.rb,
lib/gong_api/models/speaker.rb,
lib/gong_api/models/tracker.rb,
lib/gong_api/api/library_api.rb,
lib/gong_api/models/question.rb,
lib/gong_api/models/sentence.rb,
lib/gong_api/models/settings.rb,
lib/gong_api/api/auditing_api.rb,
lib/gong_api/api/settings_api.rb,
lib/gong_api/models/log_entry.rb,
lib/gong_api/models/monologue.rb,
lib/gong_api/models/questions.rb,
lib/gong_api/models/scorecard.rb,
lib/gong_api/models/structure.rb,
lib/gong_api/models/scorecards.rb,
lib/gong_api/models/interaction.rb,
lib/gong_api/models/occurrences.rb,
lib/gong_api/api/permissions_api.rb,
lib/gong_api/models/call_content.rb,
lib/gong_api/models/call_context.rb,
lib/gong_api/models/calls_filter.rb,
lib/gong_api/models/library_call.rb,
lib/gong_api/api/data_privacy_api.rb,
lib/gong_api/models/base_response.rb,
lib/gong_api/models/collaboration.rb,
lib/gong_api/models/context_field.rb,
lib/gong_api/models/customer_data.rb,
lib/gong_api/models/email_message.rb,
lib/gong_api/models/id_media_body.rb,
lib/gong_api/models/logs_response.rb,
lib/gong_api/models/party_context.rb,
lib/gong_api/models/specific_call.rb,
lib/gong_api/models/user_activity.rb,
lib/gong_api/models/user_metadata.rb,
lib/gong_api/models/call_reference.rb,
lib/gong_api/models/calls_response.rb,
lib/gong_api/models/error_response.rb,
lib/gong_api/models/exposed_fields.rb,
lib/gong_api/models/library_folder.rb,
lib/gong_api/models/map_users_body.rb,
lib/gong_api/models/speech_segment.rb,
lib/gong_api/models/users_metadata.rb,
lib/gong_api/models/call_basic_data.rb,
lib/gong_api/models/call_transcript.rb,
lib/gong_api/models/external_system.rb,
lib/gong_api/models/meeting_invitee.rb,
lib/gong_api/models/spoken_language.rb,
lib/gong_api/models/tracker_phrases.rb,
lib/gong_api/models/call_interaction.rb,
lib/gong_api/models/call_participant.rb,
lib/gong_api/models/call_transcripts.rb,
lib/gong_api/models/content_selector.rb,
lib/gong_api/models/generic_property.rb,
lib/gong_api/models/interaction_stat.rb,
lib/gong_api/models/library_response.rb,
lib/gong_api/models/settings_history.rb,
lib/gong_api/models/interaction_stats.rb,
lib/gong_api/models/point_of_interest.rb,
lib/gong_api/models/speakers_timeline.rb,
lib/gong_api/models/aggregate_activity.rb,
lib/gong_api/models/answered_scorecard.rb,
lib/gong_api/models/association_object.rb,
lib/gong_api/models/call_collaboration.rb,
lib/gong_api/models/points_of_interest.rb,
lib/gong_api/models/workspace_metadata.rb,
lib/gong_api/models/answered_scorecards.rb,
lib/gong_api/models/call_access_details.rb,
lib/gong_api/models/call_upload_context.rb,
lib/gong_api/models/custom_action_event.rb,
lib/gong_api/models/customer_engagement.rb,
lib/gong_api/models/line_error_response.rb,
lib/gong_api/models/new_meeting_request.rb,
lib/gong_api/models/party_context_field.rb,
lib/gong_api/models/user_access_details.rb,
lib/gong_api/models/workspaces_metadata.rb,
lib/gong_api/models/calls_access_get_dto.rb,
lib/gong_api/models/content_shared_event.rb,
lib/gong_api/models/content_viewed_event.rb,
lib/gong_api/models/customer_data_object.rb,
lib/gong_api/models/external_call_object.rb,
lib/gong_api/models/new_meeting_response.rb,
lib/gong_api/models/object_entities_body.rb,
lib/gong_api/models/party_upload_context.rb,
lib/gong_api/models/request_calls_filter.rb,
lib/gong_api/models/user_simple_metadata.rb,
lib/gong_api/models/call_users_access_dto.rb,
lib/gong_api/models/external_party_object.rb,
lib/gong_api/models/library_folder_access.rb,
lib/gong_api/models/user_settings_history.rb,
lib/gong_api/models/delete_meeting_request.rb,
lib/gong_api/models/external_system_object.rb,
lib/gong_api/models/permission_profile_dto.rb,
lib/gong_api/models/schema_update_response.rb,
lib/gong_api/models/update_meeting_request.rb,
lib/gong_api/api/meetings_in_beta_phase_api.rb,
lib/gong_api/models/crm_party_context_field.rb,
lib/gong_api/models/event_accepted_response.rb,
lib/gong_api/models/generic_crm_integration.rb,
lib/gong_api/models/meetings_error_response.rb,
lib/gong_api/models/new_call_adding_request.rb,
lib/gong_api/models/phone_number_references.rb,
lib/gong_api/models/request_status_response.rb,
lib/gong_api/models/update_meeting_response.rb,
lib/gong_api/models/user_integration_status.rb,
lib/gong_api/models/email_address_references.rb,
lib/gong_api/models/external_crm_call_object.rb,
lib/gong_api/models/new_call_adding_response.rb,
lib/gong_api/models/user_day_by_day_activity.rb,
lib/gong_api/api/engagement_in_beta_phase_api.rb,
lib/gong_api/models/async_processing_response.rb,
lib/gong_api/models/daily_activity_with_dates.rb,
lib/gong_api/models/external_crm_party_object.rb,
lib/gong_api/models/multiple_users_with_dates.rb,
lib/gong_api/models/users_day_by_day_activity.rb,
lib/gong_api/models/answered_scorecards_filter.rb,
lib/gong_api/models/calls_users_access_add_dto.rb,
lib/gong_api/models/generic_deal_stage_request.rb,
lib/gong_api/models/integration_status_request.rb,
lib/gong_api/models/integration_status_response.rb,
lib/gong_api/models/manual_association_response.rb,
lib/gong_api/models/new_call_recording_response.rb,
lib/gong_api/models/permission_profile_response.rb,
lib/gong_api/models/generic_schema_field_request.rb,
lib/gong_api/models/permission_profiles_response.rb,
lib/gong_api/models/request_calls_access_get_dto.rb,
lib/gong_api/models/aggregate_activity_with_dates.rb,
lib/gong_api/models/calls_access_details_response.rb,
lib/gong_api/models/calls_users_access_delete_dto.rb,
lib/gong_api/models/list_selected_fields_response.rb,
lib/gong_api/models/register_generic_crm_response.rb,
lib/gong_api/models/manual_associations_basic_data.rb,
lib/gong_api/models/calls_request_filter_with_owners.rb,
lib/gong_api/models/generic_crm_registration_request.rb,
lib/gong_api/models/get_generic_crm_objects_response.rb,
lib/gong_api/models/call_access_with_permission_level.rb,
lib/gong_api/models/permission_profile_users_response.rb,
lib/gong_api/models/request_multiple_users_with_dates.rb,
lib/gong_api/models/deals_access_with_permission_level.rb,
lib/gong_api/models/request_answered_scorecards_filter.rb,
lib/gong_api/models/users_aggregate_by_period_activity.rb,
lib/gong_api/models/emails_access_with_permission_level.rb,
lib/gong_api/models/user_aggregate_by_period_activities.rb,
lib/gong_api/models/coaching_access_with_permission_level.rb,
lib/gong_api/models/forecast_access_with_permission_level.rb,
lib/gong_api/models/insights_access_with_permission_level.rb,
lib/gong_api/models/library_folder_list_of_calls_response.rb,
lib/gong_api/models/list_generic_crm_integrations_response.rb,
lib/gong_api/models/company_users_intercation_stats_response.rb,
lib/gong_api/models/company_users_aggregate_activity_response.rb,
lib/gong_api/models/multiple_users_request_with_creation_dates.rb,
lib/gong_api/models/request_multiple_users_request_with_creation_dates.rb,
lib/gong_api/models/request_with_time_period_multiple_users_with_dates.rb,
lib/gong_api/models/request_calls_request_filter_with_owners_content_selector.rb

Overview

#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="us-55616.api.gong.io"> 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:
<p> In the <a href="app.gong.io/company/api">Gong API Page</a> (you must be a technical administrator in Gong), click "Create" to receive an Access Key and an Access Key Secret.
</p> <p> Use the Basic Authorization HTTP header (as per <a target="_blank" href="www.rfc-editor.org/rfc/rfc7617.txt">RFC</a>) to access the Public API as shown below:
Authorization: Basic <token>
</p> <p> To create the basic token, combine the Access Key and the Access Key Secret with colon (:) and then encode in Base64 as following:
Base64(<accessKey> : <accessKeySecret>)
</p></li> <li>Retrieve through OAuth
<p> To obtain the Bearer token, follow the steps described in the <a target="_blank" href="help.gong.io/hc/en-us/articles/360056677792">Gong OAuth Guide</a>.
</p> <p> After obtaining the token, use the Bearer Authorization HTTP header (as per <a target="_blank" href="www.rfc-editor.org/rfc/rfc6750.txt">RFC</a>) to access the Public API as shown below:
Authorization: Bearer <token> </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 429 is returned and a Retry-After header indicates how many seconds to wait before making a new request. </p><p> If required, contact [email protected] 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 records 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 records field will also contain a cursor field which can be used to access the next page of records. To retrieve the next page, repeat the API call with the cursor 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: github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 3.0.37

Defined Under Namespace

Classes: Actor, AggregateActivity, AggregateActivityWithDates, Answer, AnsweredScorecard, AnsweredScorecards, AnsweredScorecardsFilter, ApiClient, ApiError, AssociationObject, AsyncProcessingResponse, AuditingApi, BaseResponse, CRMApi, Call, CallAccessDetails, CallAccessWithPermissionLevel, CallBasicData, CallCollaboration, CallContent, CallContext, CallInteraction, CallParticipant, CallReference, CallTranscript, CallTranscripts, CallUploadContext, CallUsersAccessDto, Calls, CallsAccessDetailsResponse, CallsAccessGetDto, CallsApi, CallsFilter, CallsRequestFilterWithOwners, CallsResponse, CallsUsersAccessAddDto, CallsUsersAccessDeleteDto, CoachingAccessWithPermissionLevel, Collaboration, Comment, CompanyUsersAggregateActivityResponse, CompanyUsersIntercationStatsResponse, Configuration, Content, ContentSelector, ContentSharedEvent, ContentViewedEvent, ContextField, CrmPartyContextField, CustomActionEvent, CustomerData, CustomerDataObject, CustomerEngagement, DailyActivityWithDates, DataPrivacyApi, DealsAccessWithPermissionLevel, DeleteMeetingRequest, EmailAddressReferences, EmailMessage, EmailsAccessWithPermissionLevel, EngagementInBetaPhaseApi, ErrorResponse, EventAcceptedResponse, ExposedFields, ExternalCallObject, ExternalCrmCallObject, ExternalCrmPartyObject, ExternalPartyObject, ExternalSystem, ExternalSystemObject, ForecastAccessWithPermissionLevel, GenericCrmIntegration, GenericCrmRegistrationRequest, GenericDealStageRequest, GenericProperty, GenericSchemaFieldRequest, GetGenericCrmObjectsResponse, IdMediaBody, InsightsAccessWithPermissionLevel, IntegrationStatusRequest, IntegrationStatusResponse, Interaction, InteractionStat, InteractionStats, LibraryApi, LibraryCall, LibraryFolder, LibraryFolderAccess, LibraryFolderListOfCallsResponse, LibraryResponse, LineErrorResponse, ListGenericCrmIntegrationsResponse, ListSelectedFieldsResponse, LogEntry, LogsResponse, ManualAssociationResponse, ManualAssociationsBasicData, MapUsersBody, Media, Meeting, MeetingInvitee, MeetingsErrorResponse, MeetingsInBetaPhaseApi, Monologue, MultipleUsersRequestWithCreationDates, MultipleUsersWithDates, NewCallAddingRequest, NewCallAddingResponse, NewCallRecordingResponse, NewMeetingRequest, NewMeetingResponse, ObjectEntitiesBody, Occurrences, Party, PartyContext, PartyContextField, PartyUploadContext, PermissionProfileDTO, PermissionProfileResponse, PermissionProfileUsersResponse, PermissionProfilesResponse, PermissionsApi, PhoneNumberReferences, PointOfInterest, PointsOfInterest, Question, Questions, Records, RegisterGenericCrmResponse, RequestAnsweredScorecardsFilter, RequestCallsAccessGetDto, RequestCallsFilter, RequestCallsRequestFilterWithOwnersContentSelector, RequestMultipleUsersRequestWithCreationDates, RequestMultipleUsersWithDates, RequestStatusResponse, RequestWithTimePeriodMultipleUsersWithDates, SchemaUpdateResponse, Scorecard, Scorecards, Sentence, Settings, SettingsApi, SettingsHistory, Sharer, Snippet, Speaker, SpeakersTimeline, SpecificCall, SpeechSegment, SpokenLanguage, StatsApi, Structure, Topic, Tracker, TrackerPhrases, UpdateMeetingRequest, UpdateMeetingResponse, User, UserAccessDetails, UserActivity, UserAggregateByPeriodActivities, UserDayByDayActivity, UserIntegrationStatus, UserMetadata, UserSettingsHistory, UserSimpleMetadata, UsersAggregateByPeriodActivity, UsersApi, UsersDayByDayActivity, UsersMetadata, Video, WorkspaceMetadata, WorkspacesMetadata

Constant Summary collapse

VERSION =

'1.0.0'

Class Method Summary collapse

.configure ⇒ Object

Customize default settings for the SDK using block.

Class Method Details

.configure ⇒ `Object`

Customize default settings for the SDK using block.

GongAPI.configure do |config|
  config.username = "xxx"
  config.password = "xxx"
end

If no block given, return the default Configuration object.

# File 'lib/gong_api.rb', line 201

def configure
  if block_given?
    yield(Configuration.default)
  else
    Configuration.default
  end
end