gong_api 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/Gemfile +9 -0
- data/README.md +906 -0
- data/Rakefile +8 -0
- data/config.json +12 -0
- data/docs/Actor.md +10 -0
- data/docs/AggregateActivity.md +21 -0
- data/docs/AggregateActivityWithDates.md +23 -0
- data/docs/Answer.md +12 -0
- data/docs/AnsweredScorecard.md +16 -0
- data/docs/AnsweredScorecards.md +9 -0
- data/docs/AnsweredScorecardsFilter.md +12 -0
- data/docs/AssociationObject.md +8 -0
- data/docs/AsyncProcessingResponse.md +8 -0
- data/docs/AuditingApi.md +61 -0
- data/docs/BaseResponse.md +7 -0
- data/docs/CRMApi.md +490 -0
- data/docs/Call.md +13 -0
- data/docs/CallAccessDetails.md +8 -0
- data/docs/CallAccessWithPermissionLevel.md +8 -0
- data/docs/CallBasicData.md +25 -0
- data/docs/CallCollaboration.md +7 -0
- data/docs/CallContent.md +11 -0
- data/docs/CallContext.md +8 -0
- data/docs/CallInteraction.md +10 -0
- data/docs/CallParticipant.md +13 -0
- data/docs/CallReference.md +9 -0
- data/docs/CallTranscript.md +8 -0
- data/docs/CallTranscripts.md +9 -0
- data/docs/CallUploadContext.md +8 -0
- data/docs/CallUsersAccessDto.md +8 -0
- data/docs/Calls.md +9 -0
- data/docs/CallsAccessDetailsResponse.md +8 -0
- data/docs/CallsAccessGetDto.md +7 -0
- data/docs/CallsApi.md +349 -0
- data/docs/CallsFilter.md +10 -0
- data/docs/CallsRequestFilterWithOwners.md +11 -0
- data/docs/CallsResponse.md +9 -0
- data/docs/CallsUsersAccessAddDto.md +7 -0
- data/docs/CallsUsersAccessDeleteDto.md +7 -0
- data/docs/CoachingAccessWithPermissionLevel.md +8 -0
- data/docs/Collaboration.md +7 -0
- data/docs/Comment.md +14 -0
- data/docs/CompanyUsersAggregateActivityResponse.md +12 -0
- data/docs/CompanyUsersIntercationStatsResponse.md +12 -0
- data/docs/Content.md +10 -0
- data/docs/ContentSelector.md +9 -0
- data/docs/ContentSharedEvent.md +23 -0
- data/docs/ContentViewedEvent.md +23 -0
- data/docs/ContextField.md +8 -0
- data/docs/CrmPartyContextField.md +8 -0
- data/docs/CustomActionEvent.md +22 -0
- data/docs/CustomerData.md +8 -0
- data/docs/CustomerDataObject.md +11 -0
- data/docs/CustomerEngagement.md +13 -0
- data/docs/DailyActivityWithDates.md +23 -0
- data/docs/DataPrivacyApi.md +195 -0
- data/docs/DealsAccessWithPermissionLevel.md +8 -0
- data/docs/DeleteMeetingRequest.md +7 -0
- data/docs/EmailAddressReferences.md +12 -0
- data/docs/EmailMessage.md +11 -0
- data/docs/EmailsAccessWithPermissionLevel.md +8 -0
- data/docs/EngagementInBetaPhaseApi.md +148 -0
- data/docs/ErrorResponse.md +8 -0
- data/docs/EventAcceptedResponse.md +7 -0
- data/docs/ExposedFields.md +11 -0
- data/docs/ExternalCallObject.md +10 -0
- data/docs/ExternalCrmCallObject.md +9 -0
- data/docs/ExternalCrmPartyObject.md +9 -0
- data/docs/ExternalPartyObject.md +10 -0
- data/docs/ExternalSystem.md +8 -0
- data/docs/ExternalSystemObject.md +8 -0
- data/docs/ForecastAccessWithPermissionLevel.md +8 -0
- data/docs/GenericCrmIntegration.md +9 -0
- data/docs/GenericCrmRegistrationRequest.md +8 -0
- data/docs/GenericDealStageRequest.md +10 -0
- data/docs/GenericProperty.md +9 -0
- data/docs/GenericSchemaFieldRequest.md +14 -0
- data/docs/GetGenericCrmObjectsResponse.md +8 -0
- data/docs/IdMediaBody.md +7 -0
- data/docs/InsightsAccessWithPermissionLevel.md +8 -0
- data/docs/IntegrationStatusRequest.md +7 -0
- data/docs/IntegrationStatusResponse.md +8 -0
- data/docs/Interaction.md +10 -0
- data/docs/InteractionStat.md +8 -0
- data/docs/InteractionStats.md +9 -0
- data/docs/LibraryApi.md +103 -0
- data/docs/LibraryCall.md +13 -0
- data/docs/LibraryFolder.md +11 -0
- data/docs/LibraryFolderAccess.md +11 -0
- data/docs/LibraryFolderListOfCallsResponse.md +12 -0
- data/docs/LibraryResponse.md +8 -0
- data/docs/LineErrorResponse.md +8 -0
- data/docs/ListGenericCrmIntegrationsResponse.md +8 -0
- data/docs/ListSelectedFieldsResponse.md +8 -0
- data/docs/LogEntry.md +15 -0
- data/docs/LogsResponse.md +9 -0
- data/docs/ManualAssociationResponse.md +9 -0
- data/docs/ManualAssociationsBasicData.md +10 -0
- data/docs/MapUsersBody.md +7 -0
- data/docs/Media.md +8 -0
- data/docs/Meeting.md +7 -0
- data/docs/MeetingInvitee.md +10 -0
- data/docs/MeetingsErrorResponse.md +11 -0
- data/docs/MeetingsInBetaPhaseApi.md +199 -0
- data/docs/Monologue.md +9 -0
- data/docs/MultipleUsersRequestWithCreationDates.md +10 -0
- data/docs/MultipleUsersWithDates.md +9 -0
- data/docs/NewCallAddingRequest.md +25 -0
- data/docs/NewCallAddingResponse.md +8 -0
- data/docs/NewCallRecordingResponse.md +9 -0
- data/docs/NewMeetingRequest.md +12 -0
- data/docs/NewMeetingResponse.md +10 -0
- data/docs/ObjectEntitiesBody.md +7 -0
- data/docs/Occurrences.md +8 -0
- data/docs/Party.md +16 -0
- data/docs/PartyContext.md +8 -0
- data/docs/PartyContextField.md +8 -0
- data/docs/PartyUploadContext.md +8 -0
- data/docs/PermissionProfileDTO.md +41 -0
- data/docs/PermissionProfileResponse.md +8 -0
- data/docs/PermissionProfileUsersResponse.md +8 -0
- data/docs/PermissionProfilesResponse.md +8 -0
- data/docs/PermissionsApi.md +387 -0
- data/docs/PhoneNumberReferences.md +14 -0
- data/docs/PointOfInterest.md +10 -0
- data/docs/PointsOfInterest.md +7 -0
- data/docs/Question.md +13 -0
- data/docs/Questions.md +8 -0
- data/docs/Records.md +10 -0
- data/docs/RegisterGenericCrmResponse.md +8 -0
- data/docs/RequestAnsweredScorecardsFilter.md +8 -0
- data/docs/RequestCallsAccessGetDto.md +7 -0
- data/docs/RequestCallsFilter.md +8 -0
- data/docs/RequestCallsRequestFilterWithOwnersContentSelector.md +9 -0
- data/docs/RequestMultipleUsersRequestWithCreationDates.md +8 -0
- data/docs/RequestMultipleUsersWithDates.md +8 -0
- data/docs/RequestStatusResponse.md +11 -0
- data/docs/RequestWithTimePeriodMultipleUsersWithDates.md +9 -0
- data/docs/SchemaUpdateResponse.md +7 -0
- data/docs/Scorecard.md +14 -0
- data/docs/Scorecards.md +8 -0
- data/docs/Sentence.md +9 -0
- data/docs/Settings.md +12 -0
- data/docs/SettingsApi.md +91 -0
- data/docs/SettingsHistory.md +8 -0
- data/docs/Sharer.md +9 -0
- data/docs/Snippet.md +8 -0
- data/docs/Speaker.md +9 -0
- data/docs/SpeakersTimeline.md +8 -0
- data/docs/SpecificCall.md +8 -0
- data/docs/SpeechSegment.md +9 -0
- data/docs/SpokenLanguage.md +8 -0
- data/docs/StatsApi.md +242 -0
- data/docs/Structure.md +8 -0
- data/docs/Topic.md +8 -0
- data/docs/Tracker.md +12 -0
- data/docs/TrackerPhrases.md +9 -0
- data/docs/UpdateMeetingRequest.md +12 -0
- data/docs/UpdateMeetingResponse.md +8 -0
- data/docs/User.md +8 -0
- data/docs/UserAccessDetails.md +7 -0
- data/docs/UserActivity.md +9 -0
- data/docs/UserAggregateByPeriodActivities.md +9 -0
- data/docs/UserDayByDayActivity.md +9 -0
- data/docs/UserIntegrationStatus.md +12 -0
- data/docs/UserMetadata.md +21 -0
- data/docs/UserSettingsHistory.md +9 -0
- data/docs/UserSimpleMetadata.md +9 -0
- data/docs/UsersAggregateByPeriodActivity.md +9 -0
- data/docs/UsersApi.md +198 -0
- data/docs/UsersDayByDayActivity.md +9 -0
- data/docs/UsersMetadata.md +9 -0
- data/docs/Video.md +8 -0
- data/docs/WorkspaceMetadata.md +9 -0
- data/docs/WorkspacesMetadata.md +8 -0
- data/git_push.sh +55 -0
- data/gong-swagger.json +1 -0
- data/gong_api.gemspec +38 -0
- data/lib/gong_api/api/auditing_api.rb +94 -0
- data/lib/gong_api/api/calls_api.rb +437 -0
- data/lib/gong_api/api/crm_api.rb +651 -0
- data/lib/gong_api/api/data_privacy_api.rb +248 -0
- data/lib/gong_api/api/engagement_in_beta_phase_api.rb +194 -0
- data/lib/gong_api/api/library_api.rb +126 -0
- data/lib/gong_api/api/meetings_in_beta_phase_api.rb +264 -0
- data/lib/gong_api/api/permissions_api.rb +495 -0
- data/lib/gong_api/api/settings_api.rb +120 -0
- data/lib/gong_api/api/stats_api.rb +310 -0
- data/lib/gong_api/api/users_api.rb +246 -0
- data/lib/gong_api/api_client.rb +387 -0
- data/lib/gong_api/api_error.rb +57 -0
- data/lib/gong_api/configuration.rb +198 -0
- data/lib/gong_api/models/actor.rb +239 -0
- data/lib/gong_api/models/aggregate_activity.rb +348 -0
- data/lib/gong_api/models/aggregate_activity_with_dates.rb +368 -0
- data/lib/gong_api/models/answer.rb +257 -0
- data/lib/gong_api/models/answered_scorecard.rb +332 -0
- data/lib/gong_api/models/answered_scorecards.rb +228 -0
- data/lib/gong_api/models/answered_scorecards_filter.rb +258 -0
- data/lib/gong_api/models/association_object.rb +217 -0
- data/lib/gong_api/models/async_processing_response.rb +217 -0
- data/lib/gong_api/models/base_response.rb +207 -0
- data/lib/gong_api/models/call.rb +267 -0
- data/lib/gong_api/models/call_access_details.rb +220 -0
- data/lib/gong_api/models/call_access_with_permission_level.rb +254 -0
- data/lib/gong_api/models/call_basic_data.rb +446 -0
- data/lib/gong_api/models/call_collaboration.rb +208 -0
- data/lib/gong_api/models/call_content.rb +248 -0
- data/lib/gong_api/models/call_context.rb +254 -0
- data/lib/gong_api/models/call_interaction.rb +238 -0
- data/lib/gong_api/models/call_participant.rb +269 -0
- data/lib/gong_api/models/call_reference.rb +230 -0
- data/lib/gong_api/models/call_transcript.rb +219 -0
- data/lib/gong_api/models/call_transcripts.rb +228 -0
- data/lib/gong_api/models/call_upload_context.rb +259 -0
- data/lib/gong_api/models/call_users_access_dto.rb +228 -0
- data/lib/gong_api/models/calls.rb +228 -0
- data/lib/gong_api/models/calls_access_details_response.rb +219 -0
- data/lib/gong_api/models/calls_access_get_dto.rb +212 -0
- data/lib/gong_api/models/calls_filter.rb +238 -0
- data/lib/gong_api/models/calls_request_filter_with_owners.rb +248 -0
- data/lib/gong_api/models/calls_response.rb +228 -0
- data/lib/gong_api/models/calls_users_access_add_dto.rb +209 -0
- data/lib/gong_api/models/calls_users_access_delete_dto.rb +209 -0
- data/lib/gong_api/models/coaching_access_with_permission_level.rb +254 -0
- data/lib/gong_api/models/collaboration.rb +210 -0
- data/lib/gong_api/models/comment.rb +277 -0
- data/lib/gong_api/models/company_users_aggregate_activity_response.rb +258 -0
- data/lib/gong_api/models/company_users_intercation_stats_response.rb +258 -0
- data/lib/gong_api/models/content.rb +243 -0
- data/lib/gong_api/models/content_selector.rb +263 -0
- data/lib/gong_api/models/content_shared_event.rb +400 -0
- data/lib/gong_api/models/content_viewed_event.rb +432 -0
- data/lib/gong_api/models/context_field.rb +218 -0
- data/lib/gong_api/models/crm_party_context_field.rb +218 -0
- data/lib/gong_api/models/custom_action_event.rb +407 -0
- data/lib/gong_api/models/customer_data.rb +253 -0
- data/lib/gong_api/models/customer_data_object.rb +283 -0
- data/lib/gong_api/models/customer_engagement.rb +301 -0
- data/lib/gong_api/models/daily_activity_with_dates.rb +368 -0
- data/lib/gong_api/models/deals_access_with_permission_level.rb +254 -0
- data/lib/gong_api/models/delete_meeting_request.rb +208 -0
- data/lib/gong_api/models/email_address_references.rb +267 -0
- data/lib/gong_api/models/email_message.rb +247 -0
- data/lib/gong_api/models/emails_access_with_permission_level.rb +254 -0
- data/lib/gong_api/models/error_response.rb +217 -0
- data/lib/gong_api/models/event_accepted_response.rb +207 -0
- data/lib/gong_api/models/exposed_fields.rb +245 -0
- data/lib/gong_api/models/external_call_object.rb +286 -0
- data/lib/gong_api/models/external_crm_call_object.rb +274 -0
- data/lib/gong_api/models/external_crm_party_object.rb +274 -0
- data/lib/gong_api/models/external_party_object.rb +286 -0
- data/lib/gong_api/models/external_system.rb +253 -0
- data/lib/gong_api/models/external_system_object.rb +251 -0
- data/lib/gong_api/models/forecast_access_with_permission_level.rb +254 -0
- data/lib/gong_api/models/generic_crm_integration.rb +227 -0
- data/lib/gong_api/models/generic_crm_registration_request.rb +227 -0
- data/lib/gong_api/models/generic_deal_stage_request.rb +257 -0
- data/lib/gong_api/models/generic_property.rb +276 -0
- data/lib/gong_api/models/generic_schema_field_request.rb +328 -0
- data/lib/gong_api/models/get_generic_crm_objects_response.rb +219 -0
- data/lib/gong_api/models/id_media_body.rb +206 -0
- data/lib/gong_api/models/insights_access_with_permission_level.rb +254 -0
- data/lib/gong_api/models/integration_status_request.rb +209 -0
- data/lib/gong_api/models/integration_status_response.rb +219 -0
- data/lib/gong_api/models/interaction.rb +243 -0
- data/lib/gong_api/models/interaction_stat.rb +217 -0
- data/lib/gong_api/models/interaction_stats.rb +228 -0
- data/lib/gong_api/models/library_call.rb +267 -0
- data/lib/gong_api/models/library_folder.rb +248 -0
- data/lib/gong_api/models/library_folder_access.rb +284 -0
- data/lib/gong_api/models/library_folder_list_of_calls_response.rb +259 -0
- data/lib/gong_api/models/library_response.rb +219 -0
- data/lib/gong_api/models/line_error_response.rb +217 -0
- data/lib/gong_api/models/list_generic_crm_integrations_response.rb +219 -0
- data/lib/gong_api/models/list_selected_fields_response.rb +219 -0
- data/lib/gong_api/models/log_entry.rb +287 -0
- data/lib/gong_api/models/logs_response.rb +228 -0
- data/lib/gong_api/models/manual_association_response.rb +228 -0
- data/lib/gong_api/models/manual_associations_basic_data.rb +240 -0
- data/lib/gong_api/models/map_users_body.rb +206 -0
- data/lib/gong_api/models/media.rb +218 -0
- data/lib/gong_api/models/meeting.rb +207 -0
- data/lib/gong_api/models/meeting_invitee.rb +237 -0
- data/lib/gong_api/models/meetings_error_response.rb +247 -0
- data/lib/gong_api/models/monologue.rb +229 -0
- data/lib/gong_api/models/multiple_users_request_with_creation_dates.rb +238 -0
- data/lib/gong_api/models/multiple_users_with_dates.rb +238 -0
- data/lib/gong_api/models/new_call_adding_request.rb +450 -0
- data/lib/gong_api/models/new_call_adding_response.rb +217 -0
- data/lib/gong_api/models/new_call_recording_response.rb +227 -0
- data/lib/gong_api/models/new_meeting_request.rb +265 -0
- data/lib/gong_api/models/new_meeting_response.rb +239 -0
- data/lib/gong_api/models/object_entities_body.rb +206 -0
- data/lib/gong_api/models/occurrences.rb +217 -0
- data/lib/gong_api/models/party.rb +335 -0
- data/lib/gong_api/models/party_context.rb +254 -0
- data/lib/gong_api/models/party_context_field.rb +218 -0
- data/lib/gong_api/models/party_upload_context.rb +259 -0
- data/lib/gong_api/models/permission_profile_dto.rb +541 -0
- data/lib/gong_api/models/permission_profile_response.rb +216 -0
- data/lib/gong_api/models/permission_profile_users_response.rb +219 -0
- data/lib/gong_api/models/permission_profiles_response.rb +219 -0
- data/lib/gong_api/models/phone_number_references.rb +289 -0
- data/lib/gong_api/models/point_of_interest.rb +237 -0
- data/lib/gong_api/models/points_of_interest.rb +210 -0
- data/lib/gong_api/models/question.rb +267 -0
- data/lib/gong_api/models/questions.rb +218 -0
- data/lib/gong_api/models/records.rb +238 -0
- data/lib/gong_api/models/register_generic_crm_response.rb +217 -0
- data/lib/gong_api/models/request_answered_scorecards_filter.rb +216 -0
- data/lib/gong_api/models/request_calls_access_get_dto.rb +206 -0
- data/lib/gong_api/models/request_calls_filter.rb +216 -0
- data/lib/gong_api/models/request_calls_request_filter_with_owners_content_selector.rb +225 -0
- data/lib/gong_api/models/request_multiple_users_request_with_creation_dates.rb +216 -0
- data/lib/gong_api/models/request_multiple_users_with_dates.rb +216 -0
- data/lib/gong_api/models/request_status_response.rb +282 -0
- data/lib/gong_api/models/request_with_time_period_multiple_users_with_dates.rb +265 -0
- data/lib/gong_api/models/schema_update_response.rb +207 -0
- data/lib/gong_api/models/scorecard.rb +279 -0
- data/lib/gong_api/models/scorecards.rb +219 -0
- data/lib/gong_api/models/sentence.rb +227 -0
- data/lib/gong_api/models/settings.rb +258 -0
- data/lib/gong_api/models/settings_history.rb +219 -0
- data/lib/gong_api/models/sharer.rb +227 -0
- data/lib/gong_api/models/snippet.rb +218 -0
- data/lib/gong_api/models/speaker.rb +228 -0
- data/lib/gong_api/models/speakers_timeline.rb +219 -0
- data/lib/gong_api/models/specific_call.rb +216 -0
- data/lib/gong_api/models/speech_segment.rb +244 -0
- data/lib/gong_api/models/spoken_language.rb +218 -0
- data/lib/gong_api/models/structure.rb +218 -0
- data/lib/gong_api/models/topic.rb +217 -0
- data/lib/gong_api/models/tracker.rb +295 -0
- data/lib/gong_api/models/tracker_phrases.rb +229 -0
- data/lib/gong_api/models/update_meeting_request.rb +265 -0
- data/lib/gong_api/models/update_meeting_response.rb +217 -0
- data/lib/gong_api/models/user.rb +216 -0
- data/lib/gong_api/models/user_access_details.rb +208 -0
- data/lib/gong_api/models/user_activity.rb +226 -0
- data/lib/gong_api/models/user_aggregate_by_period_activities.rb +229 -0
- data/lib/gong_api/models/user_day_by_day_activity.rb +229 -0
- data/lib/gong_api/models/user_integration_status.rb +257 -0
- data/lib/gong_api/models/user_metadata.rb +347 -0
- data/lib/gong_api/models/user_settings_history.rb +261 -0
- data/lib/gong_api/models/user_simple_metadata.rb +227 -0
- data/lib/gong_api/models/users_aggregate_by_period_activity.rb +228 -0
- data/lib/gong_api/models/users_day_by_day_activity.rb +228 -0
- data/lib/gong_api/models/users_metadata.rb +228 -0
- data/lib/gong_api/models/video.rb +218 -0
- data/lib/gong_api/models/workspace_metadata.rb +227 -0
- data/lib/gong_api/models/workspaces_metadata.rb +219 -0
- data/lib/gong_api/version.rb +14 -0
- data/lib/gong_api.rb +209 -0
- data/spec/api/auditing_api_spec.rb +49 -0
- data/spec/api/calls_api_spec.rb +123 -0
- data/spec/api/crm_api_spec.rb +161 -0
- data/spec/api/data_privacy_api_spec.rb +82 -0
- data/spec/api/engagement_in_beta_phase_api_spec.rb +70 -0
- data/spec/api/library_api_spec.rb +58 -0
- data/spec/api/meetings_in_beta_phase_api_spec.rb +84 -0
- data/spec/api/permissions_api_spec.rb +132 -0
- data/spec/api/settings_api_spec.rb +56 -0
- data/spec/api/stats_api_spec.rb +94 -0
- data/spec/api/users_api_spec.rb +83 -0
- data/spec/api_client_spec.rb +225 -0
- data/spec/base_object_spec.rb +109 -0
- data/spec/configuration_spec.rb +41 -0
- data/spec/models/actor_spec.rb +58 -0
- data/spec/models/aggregate_activity_spec.rb +124 -0
- data/spec/models/aggregate_activity_with_dates_spec.rb +136 -0
- data/spec/models/answer_spec.rb +70 -0
- data/spec/models/answered_scorecard_spec.rb +98 -0
- data/spec/models/answered_scorecards_filter_spec.rb +70 -0
- data/spec/models/answered_scorecards_spec.rb +52 -0
- data/spec/models/association_object_spec.rb +46 -0
- data/spec/models/async_processing_response_spec.rb +46 -0
- data/spec/models/base_response_spec.rb +40 -0
- data/spec/models/call_access_details_spec.rb +46 -0
- data/spec/models/call_access_with_permission_level_spec.rb +50 -0
- data/spec/models/call_basic_data_spec.rb +160 -0
- data/spec/models/call_collaboration_spec.rb +40 -0
- data/spec/models/call_content_spec.rb +64 -0
- data/spec/models/call_context_spec.rb +50 -0
- data/spec/models/call_interaction_spec.rb +58 -0
- data/spec/models/call_participant_spec.rb +76 -0
- data/spec/models/call_reference_spec.rb +52 -0
- data/spec/models/call_spec.rb +76 -0
- data/spec/models/call_transcript_spec.rb +46 -0
- data/spec/models/call_transcripts_spec.rb +52 -0
- data/spec/models/call_upload_context_spec.rb +50 -0
- data/spec/models/call_users_access_dto_spec.rb +46 -0
- data/spec/models/calls_access_details_response_spec.rb +46 -0
- data/spec/models/calls_access_get_dto_spec.rb +40 -0
- data/spec/models/calls_filter_spec.rb +58 -0
- data/spec/models/calls_request_filter_with_owners_spec.rb +64 -0
- data/spec/models/calls_response_spec.rb +52 -0
- data/spec/models/calls_spec.rb +52 -0
- data/spec/models/calls_users_access_add_dto_spec.rb +40 -0
- data/spec/models/calls_users_access_delete_dto_spec.rb +40 -0
- data/spec/models/coaching_access_with_permission_level_spec.rb +50 -0
- data/spec/models/collaboration_spec.rb +40 -0
- data/spec/models/comment_spec.rb +82 -0
- data/spec/models/company_users_aggregate_activity_response_spec.rb +70 -0
- data/spec/models/company_users_intercation_stats_response_spec.rb +70 -0
- data/spec/models/content_selector_spec.rb +60 -0
- data/spec/models/content_shared_event_spec.rb +136 -0
- data/spec/models/content_spec.rb +58 -0
- data/spec/models/content_viewed_event_spec.rb +140 -0
- data/spec/models/context_field_spec.rb +46 -0
- data/spec/models/crm_party_context_field_spec.rb +46 -0
- data/spec/models/custom_action_event_spec.rb +134 -0
- data/spec/models/customer_data_object_spec.rb +68 -0
- data/spec/models/customer_data_spec.rb +50 -0
- data/spec/models/customer_engagement_spec.rb +80 -0
- data/spec/models/daily_activity_with_dates_spec.rb +136 -0
- data/spec/models/deals_access_with_permission_level_spec.rb +50 -0
- data/spec/models/delete_meeting_request_spec.rb +40 -0
- data/spec/models/email_address_references_spec.rb +70 -0
- data/spec/models/email_message_spec.rb +64 -0
- data/spec/models/emails_access_with_permission_level_spec.rb +50 -0
- data/spec/models/error_response_spec.rb +46 -0
- data/spec/models/event_accepted_response_spec.rb +40 -0
- data/spec/models/exposed_fields_spec.rb +64 -0
- data/spec/models/external_call_object_spec.rb +66 -0
- data/spec/models/external_crm_call_object_spec.rb +56 -0
- data/spec/models/external_crm_party_object_spec.rb +56 -0
- data/spec/models/external_party_object_spec.rb +66 -0
- data/spec/models/external_system_object_spec.rb +50 -0
- data/spec/models/external_system_spec.rb +50 -0
- data/spec/models/forecast_access_with_permission_level_spec.rb +50 -0
- data/spec/models/generic_crm_integration_spec.rb +52 -0
- data/spec/models/generic_crm_registration_request_spec.rb +46 -0
- data/spec/models/generic_deal_stage_request_spec.rb +58 -0
- data/spec/models/generic_property_spec.rb +56 -0
- data/spec/models/generic_schema_field_request_spec.rb +86 -0
- data/spec/models/get_generic_crm_objects_response_spec.rb +46 -0
- data/spec/models/id_media_body_spec.rb +40 -0
- data/spec/models/insights_access_with_permission_level_spec.rb +50 -0
- data/spec/models/integration_status_request_spec.rb +40 -0
- data/spec/models/integration_status_response_spec.rb +46 -0
- data/spec/models/interaction_spec.rb +58 -0
- data/spec/models/interaction_stat_spec.rb +46 -0
- data/spec/models/interaction_stats_spec.rb +52 -0
- data/spec/models/library_call_spec.rb +76 -0
- data/spec/models/library_folder_access_spec.rb +68 -0
- data/spec/models/library_folder_list_of_calls_response_spec.rb +70 -0
- data/spec/models/library_folder_spec.rb +64 -0
- data/spec/models/library_response_spec.rb +46 -0
- data/spec/models/line_error_response_spec.rb +46 -0
- data/spec/models/list_generic_crm_integrations_response_spec.rb +46 -0
- data/spec/models/list_selected_fields_response_spec.rb +46 -0
- data/spec/models/log_entry_spec.rb +88 -0
- data/spec/models/logs_response_spec.rb +52 -0
- data/spec/models/manual_association_response_spec.rb +52 -0
- data/spec/models/manual_associations_basic_data_spec.rb +58 -0
- data/spec/models/map_users_body_spec.rb +40 -0
- data/spec/models/media_spec.rb +46 -0
- data/spec/models/meeting_invitee_spec.rb +58 -0
- data/spec/models/meeting_spec.rb +40 -0
- data/spec/models/meetings_error_response_spec.rb +64 -0
- data/spec/models/monologue_spec.rb +52 -0
- data/spec/models/multiple_users_request_with_creation_dates_spec.rb +58 -0
- data/spec/models/multiple_users_with_dates_spec.rb +52 -0
- data/spec/models/new_call_adding_request_spec.rb +152 -0
- data/spec/models/new_call_adding_response_spec.rb +46 -0
- data/spec/models/new_call_recording_response_spec.rb +52 -0
- data/spec/models/new_meeting_request_spec.rb +70 -0
- data/spec/models/new_meeting_response_spec.rb +58 -0
- data/spec/models/object_entities_body_spec.rb +40 -0
- data/spec/models/occurrences_spec.rb +46 -0
- data/spec/models/party_context_field_spec.rb +46 -0
- data/spec/models/party_context_spec.rb +50 -0
- data/spec/models/party_spec.rb +102 -0
- data/spec/models/party_upload_context_spec.rb +50 -0
- data/spec/models/permission_profile_dto_spec.rb +244 -0
- data/spec/models/permission_profile_response_spec.rb +46 -0
- data/spec/models/permission_profile_users_response_spec.rb +46 -0
- data/spec/models/permission_profiles_response_spec.rb +46 -0
- data/spec/models/phone_number_references_spec.rb +82 -0
- data/spec/models/point_of_interest_spec.rb +58 -0
- data/spec/models/points_of_interest_spec.rb +40 -0
- data/spec/models/question_spec.rb +76 -0
- data/spec/models/questions_spec.rb +46 -0
- data/spec/models/records_spec.rb +58 -0
- data/spec/models/register_generic_crm_response_spec.rb +46 -0
- data/spec/models/request_answered_scorecards_filter_spec.rb +46 -0
- data/spec/models/request_calls_access_get_dto_spec.rb +40 -0
- data/spec/models/request_calls_filter_spec.rb +46 -0
- data/spec/models/request_calls_request_filter_with_owners_content_selector_spec.rb +52 -0
- data/spec/models/request_multiple_users_request_with_creation_dates_spec.rb +46 -0
- data/spec/models/request_multiple_users_with_dates_spec.rb +46 -0
- data/spec/models/request_status_response_spec.rb +68 -0
- data/spec/models/request_with_time_period_multiple_users_with_dates_spec.rb +56 -0
- data/spec/models/schema_update_response_spec.rb +40 -0
- data/spec/models/scorecard_spec.rb +82 -0
- data/spec/models/scorecards_spec.rb +46 -0
- data/spec/models/sentence_spec.rb +52 -0
- data/spec/models/settings_history_spec.rb +46 -0
- data/spec/models/settings_spec.rb +70 -0
- data/spec/models/sharer_spec.rb +52 -0
- data/spec/models/snippet_spec.rb +46 -0
- data/spec/models/speaker_spec.rb +52 -0
- data/spec/models/speakers_timeline_spec.rb +46 -0
- data/spec/models/specific_call_spec.rb +46 -0
- data/spec/models/speech_segment_spec.rb +52 -0
- data/spec/models/spoken_language_spec.rb +46 -0
- data/spec/models/structure_spec.rb +46 -0
- data/spec/models/topic_spec.rb +46 -0
- data/spec/models/tracker_phrases_spec.rb +52 -0
- data/spec/models/tracker_spec.rb +74 -0
- data/spec/models/update_meeting_request_spec.rb +70 -0
- data/spec/models/update_meeting_response_spec.rb +46 -0
- data/spec/models/user_access_details_spec.rb +40 -0
- data/spec/models/user_activity_spec.rb +52 -0
- data/spec/models/user_aggregate_by_period_activities_spec.rb +52 -0
- data/spec/models/user_day_by_day_activity_spec.rb +52 -0
- data/spec/models/user_integration_status_spec.rb +70 -0
- data/spec/models/user_metadata_spec.rb +124 -0
- data/spec/models/user_settings_history_spec.rb +56 -0
- data/spec/models/user_simple_metadata_spec.rb +52 -0
- data/spec/models/user_spec.rb +46 -0
- data/spec/models/users_aggregate_by_period_activity_spec.rb +52 -0
- data/spec/models/users_day_by_day_activity_spec.rb +52 -0
- data/spec/models/users_metadata_spec.rb +52 -0
- data/spec/models/video_spec.rb +46 -0
- data/spec/models/workspace_metadata_spec.rb +52 -0
- data/spec/models/workspaces_metadata_spec.rb +46 -0
- data/spec/spec_helper.rb +110 -0
- metadata +807 -0
data/docs/Question.md
ADDED
@@ -0,0 +1,13 @@
|
|
1
|
+
# GongAPI::Question
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**created** | **String** | The date and time when the question was created 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]
|
7
|
+
**is_overall** | **BOOLEAN** | If the question is the main overall question. | [optional]
|
8
|
+
**question_id** | **String** | The identifier for the question. | [optional]
|
9
|
+
**question_revision_id** | **String** | The identifier for the revision version of the question. | [optional]
|
10
|
+
**question_text** | **String** | The question's text. | [optional]
|
11
|
+
**updated** | **String** | The date and time when the question was updated 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]
|
12
|
+
**updater_user_id** | **String** | The user Id of the team member that updated the question. | [optional]
|
13
|
+
|
data/docs/Questions.md
ADDED
@@ -0,0 +1,8 @@
|
|
1
|
+
# GongAPI::Questions
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**company_count** | **Integer** | The number of questions asked by company speakers. | [optional]
|
7
|
+
**non_company_count** | **Integer** | The number of questions asked by non-company speakers. | [optional]
|
8
|
+
|
data/docs/Records.md
ADDED
@@ -0,0 +1,10 @@
|
|
1
|
+
# GongAPI::Records
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**current_page_number** | **Integer** | Current page number. | [optional]
|
7
|
+
**current_page_size** | **Integer** | Number of records in the current page. | [optional]
|
8
|
+
**cursor** | **String** | Returned only when there are more records to be retrieved. Repeat the API call and pass this cursor value in the request to retrieve the next page of records. | [optional]
|
9
|
+
**total_records** | **Integer** | Total number of records. | [optional]
|
10
|
+
|
@@ -0,0 +1,8 @@
|
|
1
|
+
# GongAPI::RegisterGenericCrmResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**integration_id** | **Integer** | <style>.public-api-info { background: rgb(222, 235, 255);}.public-api-tip { background: rgb(227, 252, 239);}.public-api-parameter { background: rgba(9,30,66,0.08);}.public-api-note { background: rgb(234, 230, 255);}.public-api-important { background: rgb(255, 250, 230);}.public-api-critical { background: rgb(255, 235, 230);}table, th, td { border: 1px solid gray; border-collapse: collapse;}th, td { padding: 5px;}th { text-align: left;}</style>Use the Gong integration ID in future requests to the API. This ensures you are accessing the correct integration. <br><div class='public-api-tip'>You will need a library that can parse the <code class='public-api-parameter'>integrationId</code> in the response as Long or BigInt. Parsing the <code class='public-api-parameter'>integrationId</code> as an Integer will truncate the <code class='public-api-parameter'>integrationId</code> to trailing zeros and will return an incorrect id.</div> | [optional]
|
7
|
+
**request_id** | **String** | A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes. | [optional]
|
8
|
+
|
@@ -0,0 +1,8 @@
|
|
1
|
+
# GongAPI::RequestAnsweredScorecardsFilter
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**cursor** | **String** | When paging is needed, provide the value supplied by the previous API call to bring the following page of records. | [optional]
|
7
|
+
**filter** | [**AnsweredScorecardsFilter**](AnsweredScorecardsFilter.md) | | [optional]
|
8
|
+
|
@@ -0,0 +1,8 @@
|
|
1
|
+
# GongAPI::RequestCallsFilter
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**cursor** | **String** | When paging is needed, provide the value supplied by the previous API call to bring the following page of records. | [optional]
|
7
|
+
**filter** | [**CallsFilter**](CallsFilter.md) | | [optional]
|
8
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# GongAPI::RequestCallsRequestFilterWithOwnersContentSelector
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**content_selector** | [**ContentSelector**](ContentSelector.md) | | [optional]
|
7
|
+
**cursor** | **String** | When paging is needed, provide the value supplied by the previous API call to bring the following page of records. | [optional]
|
8
|
+
**filter** | [**CallsRequestFilterWithOwners**](CallsRequestFilterWithOwners.md) | | [optional]
|
9
|
+
|
@@ -0,0 +1,8 @@
|
|
1
|
+
# GongAPI::RequestMultipleUsersRequestWithCreationDates
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**cursor** | **String** | When paging is needed, provide the value supplied by the previous API call to bring the following page of records. | [optional]
|
7
|
+
**filter** | [**MultipleUsersRequestWithCreationDates**](MultipleUsersRequestWithCreationDates.md) | | [optional]
|
8
|
+
|
@@ -0,0 +1,8 @@
|
|
1
|
+
# GongAPI::RequestMultipleUsersWithDates
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**cursor** | **String** | When paging is needed, provide the value supplied by the previous API call to bring the following page of records. | [optional]
|
7
|
+
**filter** | [**MultipleUsersWithDates**](MultipleUsersWithDates.md) | | [optional]
|
8
|
+
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# GongAPI::RequestStatusResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**errors** | [**Array<LineErrorResponse>**](LineErrorResponse.md) | | [optional]
|
7
|
+
**request_id** | **String** | A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes. | [optional]
|
8
|
+
**status** | **String** | Request status | [optional]
|
9
|
+
**total_error_count** | **Integer** | Number of objects that failed parsing | [optional]
|
10
|
+
**total_success_count** | **Integer** | Number of valid objects | [optional]
|
11
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# GongAPI::RequestWithTimePeriodMultipleUsersWithDates
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**aggregation_period** | **String** | Calendar time period for aggregating data. Note: First day of the week is Monday. |
|
7
|
+
**cursor** | **String** | When paging is needed, provide the value supplied by the previous API call to bring the following page of records. | [optional]
|
8
|
+
**filter** | [**MultipleUsersWithDates**](MultipleUsersWithDates.md) | | [optional]
|
9
|
+
|
@@ -0,0 +1,7 @@
|
|
1
|
+
# GongAPI::SchemaUpdateResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**request_id** | **String** | A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes. | [optional]
|
7
|
+
|
data/docs/Scorecard.md
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
# GongAPI::Scorecard
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**created** | **String** | The date and time when the scorecard was created 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]
|
7
|
+
**enabled** | **BOOLEAN** | If the scorecard is enabled or not. | [optional]
|
8
|
+
**questions** | [**Array<Question>**](Question.md) | The questions in the scorecard. | [optional]
|
9
|
+
**scorecard_id** | **String** | The identifier of the scorecard. | [optional]
|
10
|
+
**scorecard_name** | **String** | Scorecard name. | [optional]
|
11
|
+
**updated** | **String** | The date and time when the scorecard was updated 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]
|
12
|
+
**updater_user_id** | **String** | The user Id of the team member that updated the scorecard. | [optional]
|
13
|
+
**workspace_id** | **String** | Scorecard workspaceId. | [optional]
|
14
|
+
|
data/docs/Scorecards.md
ADDED
@@ -0,0 +1,8 @@
|
|
1
|
+
# GongAPI::Scorecards
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**request_id** | **String** | A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes. | [optional]
|
7
|
+
**scorecards** | [**Array<Scorecard>**](Scorecard.md) | A list, in which each item contains one scorecard. | [optional]
|
8
|
+
|
data/docs/Sentence.md
ADDED
@@ -0,0 +1,9 @@
|
|
1
|
+
# GongAPI::Sentence
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**_end** | **Integer** | The end time of the sentence, in milliseconds from the start of the call. | [optional]
|
7
|
+
**start** | **Integer** | The starting time of the sentence, in milliseconds from the start of the call. | [optional]
|
8
|
+
**text** | **String** | The sentence. | [optional]
|
9
|
+
|
data/docs/Settings.md
ADDED
@@ -0,0 +1,12 @@
|
|
1
|
+
# GongAPI::Settings
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**emails_imported** | **BOOLEAN** | True if the team member is set to import emails by Gong, false if not. | [optional]
|
7
|
+
**non_recorded_meetings_imported** | **BOOLEAN** | True if the team member is set to import non recorded meetings by Gong, false if not. | [optional]
|
8
|
+
**prevent_email_import** | **BOOLEAN** | True if the team member is set to prevent import of emails by Gong, false if not. | [optional]
|
9
|
+
**prevent_web_conference_recording** | **BOOLEAN** | If true, invitation of this user to a web conference will prevent its recording (even if other users invited are set to record). | [optional]
|
10
|
+
**telephony_calls_imported** | **BOOLEAN** | True if the team member is set to import telephony calls from by Gong, false if not. | [optional]
|
11
|
+
**web_conferences_recorded** | **BOOLEAN** | True if the team member is set to be recorded by Gong, false if not. | [optional]
|
12
|
+
|
data/docs/SettingsApi.md
ADDED
@@ -0,0 +1,91 @@
|
|
1
|
+
# GongAPI::SettingsApi
|
2
|
+
|
3
|
+
All URIs are relative to *//127.0.0.1/*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**list_scorecards_using_get**](SettingsApi.md#list_scorecards_using_get) | **GET** /v2/settings/scorecards | Retrieve scorecards details (/v2/settings/scorecards)
|
8
|
+
[**list_workspaces_using_get**](SettingsApi.md#list_workspaces_using_get) | **GET** /v2/workspaces | List all company workspaces (/v2/workspaces)
|
9
|
+
|
10
|
+
# **list_scorecards_using_get**
|
11
|
+
> Scorecards list_scorecards_using_get
|
12
|
+
|
13
|
+
Retrieve scorecards details (/v2/settings/scorecards)
|
14
|
+
|
15
|
+
Retrieve all the scorecards within the Gong system. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:settings:scorecards:read'.
|
16
|
+
|
17
|
+
### Example
|
18
|
+
```ruby
|
19
|
+
# load the gem
|
20
|
+
require 'gong_api'
|
21
|
+
|
22
|
+
api_instance = GongAPI::SettingsApi.new
|
23
|
+
|
24
|
+
begin
|
25
|
+
#Retrieve scorecards details (/v2/settings/scorecards)
|
26
|
+
result = api_instance.list_scorecards_using_get
|
27
|
+
p result
|
28
|
+
rescue GongAPI::ApiError => e
|
29
|
+
puts "Exception when calling SettingsApi->list_scorecards_using_get: #{e}"
|
30
|
+
end
|
31
|
+
```
|
32
|
+
|
33
|
+
### Parameters
|
34
|
+
This endpoint does not need any parameter.
|
35
|
+
|
36
|
+
### Return type
|
37
|
+
|
38
|
+
[**Scorecards**](Scorecards.md)
|
39
|
+
|
40
|
+
### Authorization
|
41
|
+
|
42
|
+
No authorization required
|
43
|
+
|
44
|
+
### HTTP request headers
|
45
|
+
|
46
|
+
- **Content-Type**: Not defined
|
47
|
+
- **Accept**: application/json
|
48
|
+
|
49
|
+
|
50
|
+
|
51
|
+
# **list_workspaces_using_get**
|
52
|
+
> WorkspacesMetadata list_workspaces_using_get
|
53
|
+
|
54
|
+
List all company workspaces (/v2/workspaces)
|
55
|
+
|
56
|
+
Returns a list of all workspaces including their details. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:workspaces:read'.
|
57
|
+
|
58
|
+
### Example
|
59
|
+
```ruby
|
60
|
+
# load the gem
|
61
|
+
require 'gong_api'
|
62
|
+
|
63
|
+
api_instance = GongAPI::SettingsApi.new
|
64
|
+
|
65
|
+
begin
|
66
|
+
#List all company workspaces (/v2/workspaces)
|
67
|
+
result = api_instance.list_workspaces_using_get
|
68
|
+
p result
|
69
|
+
rescue GongAPI::ApiError => e
|
70
|
+
puts "Exception when calling SettingsApi->list_workspaces_using_get: #{e}"
|
71
|
+
end
|
72
|
+
```
|
73
|
+
|
74
|
+
### Parameters
|
75
|
+
This endpoint does not need any parameter.
|
76
|
+
|
77
|
+
### Return type
|
78
|
+
|
79
|
+
[**WorkspacesMetadata**](WorkspacesMetadata.md)
|
80
|
+
|
81
|
+
### Authorization
|
82
|
+
|
83
|
+
No authorization required
|
84
|
+
|
85
|
+
### HTTP request headers
|
86
|
+
|
87
|
+
- **Content-Type**: Not defined
|
88
|
+
- **Accept**: application/json
|
89
|
+
|
90
|
+
|
91
|
+
|
@@ -0,0 +1,8 @@
|
|
1
|
+
# GongAPI::SettingsHistory
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**request_id** | **String** | A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes. | [optional]
|
7
|
+
**user_settings_history** | [**Array<UserSettingsHistory>**](UserSettingsHistory.md) | User's settings history. | [optional]
|
8
|
+
|
data/docs/Sharer.md
ADDED
@@ -0,0 +1,9 @@
|
|
1
|
+
# GongAPI::Sharer
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**email** | **String** | The email address of the person, if available. | [optional]
|
7
|
+
**id** | **String** | The user id in Gong, if available. | [optional]
|
8
|
+
**name** | **String** | The name of the person, if available. | [optional]
|
9
|
+
|
data/docs/Snippet.md
ADDED
@@ -0,0 +1,8 @@
|
|
1
|
+
# GongAPI::Snippet
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**from_sec** | **Integer** | Call snippet start in seconds relative to the call start time. For example 305 is a snippet that starts after 5 minutes and 5 seconds after the beginning of the call. | [optional]
|
7
|
+
**to_sec** | **Integer** | Call snippet end in seconds relative to the call start time. For example 900 means that this snippet ends after exactly 15 minutes after the beginning of the call. | [optional]
|
8
|
+
|
data/docs/Speaker.md
ADDED
@@ -0,0 +1,9 @@
|
|
1
|
+
# GongAPI::Speaker
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**id** | **String** | Unique ID of the participant in the call. | [optional]
|
7
|
+
**talk_time** | **Float** | Talk duration in seconds | [optional]
|
8
|
+
**user_id** | **String** | User Id within the Gong system | [optional]
|
9
|
+
|
@@ -0,0 +1,8 @@
|
|
1
|
+
# GongAPI::SpeakersTimeline
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**precise** | **BOOLEAN** | Indicates whether the provided speech segments match the media precisely or need further refinement based on the media. \"Precisely\" here means that segments do not deviate from the actual speech in the media by more than 100ms. | [optional]
|
7
|
+
**speech_segments** | [**Array<SpeechSegment>**](SpeechSegment.md) | The audio recording speech segments (who spoke when). | [optional]
|
8
|
+
|
@@ -0,0 +1,8 @@
|
|
1
|
+
# GongAPI::SpecificCall
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**call** | [**CallBasicData**](CallBasicData.md) | | [optional]
|
7
|
+
**request_id** | **String** | A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes. | [optional]
|
8
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# GongAPI::SpeechSegment
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**from_time** | **Integer** | The start time of the segment in milliseconds from the beginning of the call. |
|
7
|
+
**party_ids** | **Array<String>** | The speaking parties in the segment, each must have a correlating partyId within 'parties'. It is allowed to provide overlapping segments, i.e. you can either specify multiple speakers in a segment or send several overlapping segments each marked with one speaker. |
|
8
|
+
**to_time** | **Integer** | The end time of the segment in milliseconds from the beginning of the call. |
|
9
|
+
|
@@ -0,0 +1,8 @@
|
|
1
|
+
# GongAPI::SpokenLanguage
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**language** | **String** | Language spoken by the user encoded according to the BCP-47 standard. | [optional]
|
7
|
+
**primary** | **BOOLEAN** | Indicates the primary language (one per user). The language will be assumed when the system cannot identify the language of a call, e.g., due to poor quality or the call being too short. | [optional]
|
8
|
+
|
data/docs/StatsApi.md
ADDED
@@ -0,0 +1,242 @@
|
|
1
|
+
# GongAPI::StatsApi
|
2
|
+
|
3
|
+
All URIs are relative to *//127.0.0.1/*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**list_answered_scorecards_using_post**](StatsApi.md#list_answered_scorecards_using_post) | **POST** /v2/stats/activity/scorecards | Retrieve answered scorecards for applicable reviewed users or scorecards for a date range (/v2/stats/activity/scorecards)
|
8
|
+
[**list_interaction_stats_using_post**](StatsApi.md#list_interaction_stats_using_post) | **POST** /v2/stats/interaction | Retrieve interaction stats for applicable users by date (/v2/stats/interaction)
|
9
|
+
[**list_multiple_users_aggregate_activity_using_post**](StatsApi.md#list_multiple_users_aggregate_activity_using_post) | **POST** /v2/stats/activity/aggregate | Retrieve aggregated activity for defined users by date (/v2/stats/activity/aggregate)
|
10
|
+
[**list_multiple_users_aggregate_by_period_using_post**](StatsApi.md#list_multiple_users_aggregate_by_period_using_post) | **POST** /v2/stats/activity/aggregate-by-period | Retrieve aggregated activity for defined users by a date range with grouping in time periods (/v2/stats/activity/aggregate-by-period)
|
11
|
+
[**list_multiple_users_day_by_day_activity_using_post**](StatsApi.md#list_multiple_users_day_by_day_activity_using_post) | **POST** /v2/stats/activity/day-by-day | Retrieve daily activity for applicable users for a date range (/v2/stats/activity/day-by-day)
|
12
|
+
|
13
|
+
# **list_answered_scorecards_using_post**
|
14
|
+
> AnsweredScorecards list_answered_scorecards_using_post(body)
|
15
|
+
|
16
|
+
Retrieve answered scorecards for applicable reviewed users or scorecards for a date range (/v2/stats/activity/scorecards)
|
17
|
+
|
18
|
+
Retrieve all the answers for the scorecards that were reviewed during a specified date range, for calls that took place during a specified date range, for specific scorecards or for specific reviewed users. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:stats:scorecards'.
|
19
|
+
|
20
|
+
### Example
|
21
|
+
```ruby
|
22
|
+
# load the gem
|
23
|
+
require 'gong_api'
|
24
|
+
|
25
|
+
api_instance = GongAPI::StatsApi.new
|
26
|
+
body = GongAPI::RequestAnsweredScorecardsFilter.new # RequestAnsweredScorecardsFilter | answeredScorecardsRequest
|
27
|
+
|
28
|
+
|
29
|
+
begin
|
30
|
+
#Retrieve answered scorecards for applicable reviewed users or scorecards for a date range (/v2/stats/activity/scorecards)
|
31
|
+
result = api_instance.list_answered_scorecards_using_post(body)
|
32
|
+
p result
|
33
|
+
rescue GongAPI::ApiError => e
|
34
|
+
puts "Exception when calling StatsApi->list_answered_scorecards_using_post: #{e}"
|
35
|
+
end
|
36
|
+
```
|
37
|
+
|
38
|
+
### Parameters
|
39
|
+
|
40
|
+
Name | Type | Description | Notes
|
41
|
+
------------- | ------------- | ------------- | -------------
|
42
|
+
**body** | [**RequestAnsweredScorecardsFilter**](RequestAnsweredScorecardsFilter.md)| answeredScorecardsRequest |
|
43
|
+
|
44
|
+
### Return type
|
45
|
+
|
46
|
+
[**AnsweredScorecards**](AnsweredScorecards.md)
|
47
|
+
|
48
|
+
### Authorization
|
49
|
+
|
50
|
+
No authorization required
|
51
|
+
|
52
|
+
### HTTP request headers
|
53
|
+
|
54
|
+
- **Content-Type**: application/json
|
55
|
+
- **Accept**: application/json
|
56
|
+
|
57
|
+
|
58
|
+
|
59
|
+
# **list_interaction_stats_using_post**
|
60
|
+
> CompanyUsersIntercationStatsResponse list_interaction_stats_using_post(body)
|
61
|
+
|
62
|
+
Retrieve interaction stats for applicable users by date (/v2/stats/interaction)
|
63
|
+
|
64
|
+
Returns interaction stats for users based on calls that have Whisper turned on. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:stats:interaction'.
|
65
|
+
|
66
|
+
### Example
|
67
|
+
```ruby
|
68
|
+
# load the gem
|
69
|
+
require 'gong_api'
|
70
|
+
|
71
|
+
api_instance = GongAPI::StatsApi.new
|
72
|
+
body = GongAPI::RequestMultipleUsersWithDates.new # RequestMultipleUsersWithDates | statsRequest
|
73
|
+
|
74
|
+
|
75
|
+
begin
|
76
|
+
#Retrieve interaction stats for applicable users by date (/v2/stats/interaction)
|
77
|
+
result = api_instance.list_interaction_stats_using_post(body)
|
78
|
+
p result
|
79
|
+
rescue GongAPI::ApiError => e
|
80
|
+
puts "Exception when calling StatsApi->list_interaction_stats_using_post: #{e}"
|
81
|
+
end
|
82
|
+
```
|
83
|
+
|
84
|
+
### Parameters
|
85
|
+
|
86
|
+
Name | Type | Description | Notes
|
87
|
+
------------- | ------------- | ------------- | -------------
|
88
|
+
**body** | [**RequestMultipleUsersWithDates**](RequestMultipleUsersWithDates.md)| statsRequest |
|
89
|
+
|
90
|
+
### Return type
|
91
|
+
|
92
|
+
[**CompanyUsersIntercationStatsResponse**](CompanyUsersIntercationStatsResponse.md)
|
93
|
+
|
94
|
+
### Authorization
|
95
|
+
|
96
|
+
No authorization required
|
97
|
+
|
98
|
+
### HTTP request headers
|
99
|
+
|
100
|
+
- **Content-Type**: application/json
|
101
|
+
- **Accept**: application/json
|
102
|
+
|
103
|
+
|
104
|
+
|
105
|
+
# **list_multiple_users_aggregate_activity_using_post**
|
106
|
+
> CompanyUsersAggregateActivityResponse list_multiple_users_aggregate_activity_using_post(body)
|
107
|
+
|
108
|
+
Retrieve aggregated activity for defined users by date (/v2/stats/activity/aggregate)
|
109
|
+
|
110
|
+
Lists the activity of multiple users within the Gong system during a defined period. Given the period, this endpoint returns multiple records, one for each user, with an applicable activity during the period. Each record includes statistics about the user's activity. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:stats:user-actions'.
|
111
|
+
|
112
|
+
### Example
|
113
|
+
```ruby
|
114
|
+
# load the gem
|
115
|
+
require 'gong_api'
|
116
|
+
|
117
|
+
api_instance = GongAPI::StatsApi.new
|
118
|
+
body = GongAPI::RequestMultipleUsersWithDates.new # RequestMultipleUsersWithDates | multipleUsersRequest
|
119
|
+
|
120
|
+
|
121
|
+
begin
|
122
|
+
#Retrieve aggregated activity for defined users by date (/v2/stats/activity/aggregate)
|
123
|
+
result = api_instance.list_multiple_users_aggregate_activity_using_post(body)
|
124
|
+
p result
|
125
|
+
rescue GongAPI::ApiError => e
|
126
|
+
puts "Exception when calling StatsApi->list_multiple_users_aggregate_activity_using_post: #{e}"
|
127
|
+
end
|
128
|
+
```
|
129
|
+
|
130
|
+
### Parameters
|
131
|
+
|
132
|
+
Name | Type | Description | Notes
|
133
|
+
------------- | ------------- | ------------- | -------------
|
134
|
+
**body** | [**RequestMultipleUsersWithDates**](RequestMultipleUsersWithDates.md)| multipleUsersRequest |
|
135
|
+
|
136
|
+
### Return type
|
137
|
+
|
138
|
+
[**CompanyUsersAggregateActivityResponse**](CompanyUsersAggregateActivityResponse.md)
|
139
|
+
|
140
|
+
### Authorization
|
141
|
+
|
142
|
+
No authorization required
|
143
|
+
|
144
|
+
### HTTP request headers
|
145
|
+
|
146
|
+
- **Content-Type**: application/json
|
147
|
+
- **Accept**: application/json
|
148
|
+
|
149
|
+
|
150
|
+
|
151
|
+
# **list_multiple_users_aggregate_by_period_using_post**
|
152
|
+
> UsersAggregateByPeriodActivity list_multiple_users_aggregate_by_period_using_post(body)
|
153
|
+
|
154
|
+
Retrieve aggregated activity for defined users by a date range with grouping in time periods (/v2/stats/activity/aggregate-by-period)
|
155
|
+
|
156
|
+
Lists the aggregated activity of multiple users within the Gong system for each time period within the defined date range. This endpoint returns multiple records, one for each user. For each user there are items for every time period in the date range, including statistics about the user's activity. Records are returned only for users with activity in the range. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:stats:user-actions'.
|
157
|
+
|
158
|
+
### Example
|
159
|
+
```ruby
|
160
|
+
# load the gem
|
161
|
+
require 'gong_api'
|
162
|
+
|
163
|
+
api_instance = GongAPI::StatsApi.new
|
164
|
+
body = GongAPI::RequestWithTimePeriodMultipleUsersWithDates.new # RequestWithTimePeriodMultipleUsersWithDates | multipleUsersRequest
|
165
|
+
|
166
|
+
|
167
|
+
begin
|
168
|
+
#Retrieve aggregated activity for defined users by a date range with grouping in time periods (/v2/stats/activity/aggregate-by-period)
|
169
|
+
result = api_instance.list_multiple_users_aggregate_by_period_using_post(body)
|
170
|
+
p result
|
171
|
+
rescue GongAPI::ApiError => e
|
172
|
+
puts "Exception when calling StatsApi->list_multiple_users_aggregate_by_period_using_post: #{e}"
|
173
|
+
end
|
174
|
+
```
|
175
|
+
|
176
|
+
### Parameters
|
177
|
+
|
178
|
+
Name | Type | Description | Notes
|
179
|
+
------------- | ------------- | ------------- | -------------
|
180
|
+
**body** | [**RequestWithTimePeriodMultipleUsersWithDates**](RequestWithTimePeriodMultipleUsersWithDates.md)| multipleUsersRequest |
|
181
|
+
|
182
|
+
### Return type
|
183
|
+
|
184
|
+
[**UsersAggregateByPeriodActivity**](UsersAggregateByPeriodActivity.md)
|
185
|
+
|
186
|
+
### Authorization
|
187
|
+
|
188
|
+
No authorization required
|
189
|
+
|
190
|
+
### HTTP request headers
|
191
|
+
|
192
|
+
- **Content-Type**: application/json
|
193
|
+
- **Accept**: application/json
|
194
|
+
|
195
|
+
|
196
|
+
|
197
|
+
# **list_multiple_users_day_by_day_activity_using_post**
|
198
|
+
> UsersDayByDayActivity list_multiple_users_day_by_day_activity_using_post(body)
|
199
|
+
|
200
|
+
Retrieve daily activity for applicable users for a date range (/v2/stats/activity/day-by-day)
|
201
|
+
|
202
|
+
Retrieve the daily activity of multiple users within the Gong system for a range of dates. This endpoint returns records including statistics about each user's activity, on the daily level. Records are returned only for users with activity in the range. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:stats:user-actions:detailed'.
|
203
|
+
|
204
|
+
### Example
|
205
|
+
```ruby
|
206
|
+
# load the gem
|
207
|
+
require 'gong_api'
|
208
|
+
|
209
|
+
api_instance = GongAPI::StatsApi.new
|
210
|
+
body = GongAPI::RequestMultipleUsersWithDates.new # RequestMultipleUsersWithDates | multipleUsersRequest
|
211
|
+
|
212
|
+
|
213
|
+
begin
|
214
|
+
#Retrieve daily activity for applicable users for a date range (/v2/stats/activity/day-by-day)
|
215
|
+
result = api_instance.list_multiple_users_day_by_day_activity_using_post(body)
|
216
|
+
p result
|
217
|
+
rescue GongAPI::ApiError => e
|
218
|
+
puts "Exception when calling StatsApi->list_multiple_users_day_by_day_activity_using_post: #{e}"
|
219
|
+
end
|
220
|
+
```
|
221
|
+
|
222
|
+
### Parameters
|
223
|
+
|
224
|
+
Name | Type | Description | Notes
|
225
|
+
------------- | ------------- | ------------- | -------------
|
226
|
+
**body** | [**RequestMultipleUsersWithDates**](RequestMultipleUsersWithDates.md)| multipleUsersRequest |
|
227
|
+
|
228
|
+
### Return type
|
229
|
+
|
230
|
+
[**UsersDayByDayActivity**](UsersDayByDayActivity.md)
|
231
|
+
|
232
|
+
### Authorization
|
233
|
+
|
234
|
+
No authorization required
|
235
|
+
|
236
|
+
### HTTP request headers
|
237
|
+
|
238
|
+
- **Content-Type**: application/json
|
239
|
+
- **Accept**: application/json
|
240
|
+
|
241
|
+
|
242
|
+
|
data/docs/Structure.md
ADDED
@@ -0,0 +1,8 @@
|
|
1
|
+
# GongAPI::Structure
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**duration** | **Integer** | The duration of this part of the call | [optional]
|
7
|
+
**name** | **String** | The agenda name | [optional]
|
8
|
+
|
data/docs/Topic.md
ADDED
@@ -0,0 +1,8 @@
|
|
1
|
+
# GongAPI::Topic
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**duration** | **Integer** | The total time, in seconds, spent on this topic within the call. | [optional]
|
7
|
+
**name** | **String** | The name of the topic (e.g., Pricing). | [optional]
|
8
|
+
|
data/docs/Tracker.md
ADDED
@@ -0,0 +1,12 @@
|
|
1
|
+
# GongAPI::Tracker
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**count** | **Integer** | The number of times words in this Tracker occurred in the call. | [optional]
|
7
|
+
**id** | **String** | The unique ID of the Tracker. | [optional]
|
8
|
+
**name** | **String** | The name of the Tracker (e.g., Stores). | [optional]
|
9
|
+
**occurrences** | [**Array<Occurrences>**](Occurrences.md) | A list of details for each occurrence of Tracker phrases. | [optional]
|
10
|
+
**phrases** | [**Array<TrackerPhrases>**](TrackerPhrases.md) | A list of occurrence counters for each specific phrase within the tracker (e.g., Amazon, Walmart). | [optional]
|
11
|
+
**type** | **String** | The type of the tracker - Keyword or Smart. | [optional]
|
12
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# GongAPI::TrackerPhrases
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**count** | **Integer** | The number of occurrences of this tracker's value. | [optional]
|
7
|
+
**occurrences** | [**Array<Occurrences>**](Occurrences.md) | A list of details for each occurrence of the phrase. | [optional]
|
8
|
+
**phrase** | **String** | The specific phrase within the tracker (e.g., Walmart). | [optional]
|
9
|
+
|