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
@@ -0,0 +1,8 @@
|
|
1
|
+
# GongAPI::ForecastAccessWithPermissionLevel
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**permission_level** | **String** | Permission access scope. | [optional]
|
7
|
+
**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]
|
8
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# GongAPI::GenericCrmIntegration
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**integration_id** | **Integer** | Integration ID generated by Gong | [optional]
|
7
|
+
**name** | **String** | Integration name | [optional]
|
8
|
+
**owner_email** | **String** | Email of the integration owner | [optional]
|
9
|
+
|
@@ -0,0 +1,8 @@
|
|
1
|
+
# GongAPI::GenericCrmRegistrationRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**name** | **String** | Integration name. |
|
7
|
+
**owner_email** | **String** | Email address of the person responsible for the integration. |
|
8
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# GongAPI::GenericDealStageRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**internal_name** | **String** | Unique name or unique identifier that identifies the stage in the CRM |
|
7
|
+
**is_active** | **BOOLEAN** | Indicates if the stage is active in the CRM |
|
8
|
+
**name** | **String** | Stage name (for display in Gong UI) |
|
9
|
+
**sort_order** | **Integer** | The order of the stage in the sales process (starting from 1) |
|
10
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# GongAPI::GenericProperty
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**data_type** | **String** | Property data type. |
|
7
|
+
**name** | **String** | Property name. |
|
8
|
+
**value** | **String** | Property value. Value format should match dataType. If dataType is \"number\", value should be passed in JSON number format, e.g. 3.14. If dataType is \"date\", the value should be passed in JSON date format, e.g. 2021-02-17T02:30:00-08:00. If the dataType is \"url\", the value should be valid URL, e.g. \"https://example.com/example?q=v\" |
|
9
|
+
|
@@ -0,0 +1,14 @@
|
|
1
|
+
# GongAPI::GenericSchemaFieldRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**is_deleted** | **BOOLEAN** | \"true\" deletes the field from the schema and its value is removed from all objects. Use with caution. | [optional]
|
7
|
+
**label** | **String** | The label is used to display the field |
|
8
|
+
**last_modified** | **String** | The last modification timestamp of the field schema. <br>The timestamp should be in the ISO-8601 format without milliseconds e.g., \"2020-12-17T13:45:01Z\" | [optional]
|
9
|
+
**name** | **String** | <b>Deprecated</b>. Please use uniqueName | [optional]
|
10
|
+
**ordered_value_list** | **Array<String>** | Required for fields of type PICKLIST. Provides the list of available values for the field | [optional]
|
11
|
+
**reference_to** | **String** | Required for field of type REFERENCE. Defines the type of object referred to by this field. Must be one of \"ACCOUNT\", \"CONTACT\", \"DEAL\", \"LEAD\" or \"USER\" | [optional]
|
12
|
+
**type** | **String** | The field type (case-sensitive). See the <b>Supported Field Types</b> table. |
|
13
|
+
**unique_name** | **String** | The unique name of the field in the CRM system |
|
14
|
+
|
@@ -0,0 +1,8 @@
|
|
1
|
+
# GongAPI::GetGenericCrmObjectsResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**crm_objects_map** | **Hash<String, Hash<String, Object>>** | crmObjects | [optional]
|
7
|
+
**request_id** | **String** | A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes. | [optional]
|
8
|
+
|
data/docs/IdMediaBody.md
ADDED
@@ -0,0 +1,8 @@
|
|
1
|
+
# GongAPI::InsightsAccessWithPermissionLevel
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**permission_level** | **String** | Permission access scope. | [optional]
|
7
|
+
**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]
|
8
|
+
|
@@ -0,0 +1,8 @@
|
|
1
|
+
# GongAPI::IntegrationStatusResponse
|
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
|
+
**users** | [**Array<UserIntegrationStatus>**](UserIntegrationStatus.md) | The integration status for the request users | [optional]
|
8
|
+
|
data/docs/Interaction.md
ADDED
@@ -0,0 +1,10 @@
|
|
1
|
+
# GongAPI::Interaction
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**interaction_stats** | [**Array<InteractionStats>**](InteractionStats.md) | A list of interaction statistics. Applicable values: 'Longest Monologue', 'Longest Customer Story', 'Interactivity', 'Patience'. | [optional]
|
7
|
+
**questions** | [**Questions**](Questions.md) | | [optional]
|
8
|
+
**speakers** | [**Array<Speaker>**](Speaker.md) | A list of the talk duration per speaker. | [optional]
|
9
|
+
**video** | [**Array<Video>**](Video.md) | A list of video statistics about what's presented and for how long. | [optional]
|
10
|
+
|
@@ -0,0 +1,8 @@
|
|
1
|
+
# GongAPI::InteractionStat
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**name** | **String** | Stat name | [optional]
|
7
|
+
**value** | **Float** | Stat measurement (Can be either a double or integer) | [optional]
|
8
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# GongAPI::InteractionStats
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**person_interaction_stats** | [**Array<InteractionStat>**](InteractionStat.md) | | [optional]
|
7
|
+
**user_email_address** | **String** | The email address of the Gong user. | [optional]
|
8
|
+
**user_id** | **String** | Gong's unique numeric identifier for the user (up to 20 digits). | [optional]
|
9
|
+
|
data/docs/LibraryApi.md
ADDED
@@ -0,0 +1,103 @@
|
|
1
|
+
# GongAPI::LibraryApi
|
2
|
+
|
3
|
+
All URIs are relative to *//127.0.0.1/*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**get_calls_in_specific_folder_using_get**](LibraryApi.md#get_calls_in_specific_folder_using_get) | **GET** /v2/library/folder-content | List of calls in a specific folder (/v2/library/folder-content)
|
8
|
+
[**get_library_structure_using_get**](LibraryApi.md#get_library_structure_using_get) | **GET** /v2/library/folders | Retrieve Library folders (/v2/library/folders)
|
9
|
+
|
10
|
+
# **get_calls_in_specific_folder_using_get**
|
11
|
+
> LibraryFolderListOfCallsResponse get_calls_in_specific_folder_using_get(opts)
|
12
|
+
|
13
|
+
List of calls in a specific folder (/v2/library/folder-content)
|
14
|
+
|
15
|
+
Given a folder id, this endpoint retrieves a list of calls in it. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:library:read'.
|
16
|
+
|
17
|
+
### Example
|
18
|
+
```ruby
|
19
|
+
# load the gem
|
20
|
+
require 'gong_api'
|
21
|
+
|
22
|
+
api_instance = GongAPI::LibraryApi.new
|
23
|
+
opts = {
|
24
|
+
folder_id: 'folder_id_example' # String | Gong's unique numeric identifier for the folder (up to 20 digits).
|
25
|
+
}
|
26
|
+
|
27
|
+
begin
|
28
|
+
#List of calls in a specific folder (/v2/library/folder-content)
|
29
|
+
result = api_instance.get_calls_in_specific_folder_using_get(opts)
|
30
|
+
p result
|
31
|
+
rescue GongAPI::ApiError => e
|
32
|
+
puts "Exception when calling LibraryApi->get_calls_in_specific_folder_using_get: #{e}"
|
33
|
+
end
|
34
|
+
```
|
35
|
+
|
36
|
+
### Parameters
|
37
|
+
|
38
|
+
Name | Type | Description | Notes
|
39
|
+
------------- | ------------- | ------------- | -------------
|
40
|
+
**folder_id** | **String**| Gong's unique numeric identifier for the folder (up to 20 digits). | [optional]
|
41
|
+
|
42
|
+
### Return type
|
43
|
+
|
44
|
+
[**LibraryFolderListOfCallsResponse**](LibraryFolderListOfCallsResponse.md)
|
45
|
+
|
46
|
+
### Authorization
|
47
|
+
|
48
|
+
No authorization required
|
49
|
+
|
50
|
+
### HTTP request headers
|
51
|
+
|
52
|
+
- **Content-Type**: Not defined
|
53
|
+
- **Accept**: application/json
|
54
|
+
|
55
|
+
|
56
|
+
|
57
|
+
# **get_library_structure_using_get**
|
58
|
+
> LibraryResponse get_library_structure_using_get(opts)
|
59
|
+
|
60
|
+
Retrieve Library folders (/v2/library/folders)
|
61
|
+
|
62
|
+
Use this endpoint to retrieve a list of public library folders. We do not allow retrieval of either private or archived folders. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:library:read'.
|
63
|
+
|
64
|
+
### Example
|
65
|
+
```ruby
|
66
|
+
# load the gem
|
67
|
+
require 'gong_api'
|
68
|
+
|
69
|
+
api_instance = GongAPI::LibraryApi.new
|
70
|
+
opts = {
|
71
|
+
workspace_id: 'workspace_id_example' # String | Workspace identifier. We will retrieve folders which are related to this specific workspace.
|
72
|
+
}
|
73
|
+
|
74
|
+
begin
|
75
|
+
#Retrieve Library folders (/v2/library/folders)
|
76
|
+
result = api_instance.get_library_structure_using_get(opts)
|
77
|
+
p result
|
78
|
+
rescue GongAPI::ApiError => e
|
79
|
+
puts "Exception when calling LibraryApi->get_library_structure_using_get: #{e}"
|
80
|
+
end
|
81
|
+
```
|
82
|
+
|
83
|
+
### Parameters
|
84
|
+
|
85
|
+
Name | Type | Description | Notes
|
86
|
+
------------- | ------------- | ------------- | -------------
|
87
|
+
**workspace_id** | **String**| Workspace identifier. We will retrieve folders which are related to this specific workspace. | [optional]
|
88
|
+
|
89
|
+
### Return type
|
90
|
+
|
91
|
+
[**LibraryResponse**](LibraryResponse.md)
|
92
|
+
|
93
|
+
### Authorization
|
94
|
+
|
95
|
+
No authorization required
|
96
|
+
|
97
|
+
### HTTP request headers
|
98
|
+
|
99
|
+
- **Content-Type**: Not defined
|
100
|
+
- **Accept**: application/json
|
101
|
+
|
102
|
+
|
103
|
+
|
data/docs/LibraryCall.md
ADDED
@@ -0,0 +1,13 @@
|
|
1
|
+
# GongAPI::LibraryCall
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**added_by** | **String** | Gong's unique numeric identifier for the user who added the call to folder. | [optional]
|
7
|
+
**created** | **String** | The date and time when the call was added to folder in the ISO-8601 format (e.g., '2020-01-12T14:30:00-08:00'). | [optional]
|
8
|
+
**id** | **String** | Gong's unique numeric identifier of a call (up to 20 digits). | [optional]
|
9
|
+
**note** | **String** | A note attached to the call in the folder. The note is optional. | [optional]
|
10
|
+
**snippet** | [**Snippet**](Snippet.md) | | [optional]
|
11
|
+
**title** | **String** | The title of the call. | [optional]
|
12
|
+
**url** | **String** | URL of the call. | [optional]
|
13
|
+
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# GongAPI::LibraryFolder
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**created_by** | **String** | Gong's unique numeric identifier for the user who added the folder. | [optional]
|
7
|
+
**id** | **String** | Gong's unique numeric identifier for a library's folder (up to 20 digits). | [optional]
|
8
|
+
**name** | **String** | Display name of the folder. | [optional]
|
9
|
+
**parent_folder_id** | **String** | Gong's unique numeric identifier for library's parent folder (null for root folder). | [optional]
|
10
|
+
**updated** | **String** | Folder's last update time in the ISO-8601 format (e.g., '2020-03-14T05:30:00-08:00'). | [optional]
|
11
|
+
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# GongAPI::LibraryFolderAccess
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**library_folder_ids** | **Array<String>** | List of library folder Ids, if set, \"permissionLevel\" must not be \"none\". | [optional]
|
7
|
+
**manage_folder_calls** | **BOOLEAN** | A user with this profile can add calls to folders, archive calls, if set, \"permissionLevel\" must not be \"none\". | [optional]
|
8
|
+
**manage_public_folder** | **BOOLEAN** | A user with this profile can manage public folder, if set, \"permissionLevel\" must not be \"none\". | [optional]
|
9
|
+
**manage_streams** | **BOOLEAN** | A user with this profile can manage streams, if set, \"permissionLevel\" must not be \"none\". | [optional]
|
10
|
+
**permission_level** | **String** | Library folder permission level - mandatory value. | [optional]
|
11
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# GongAPI::LibraryFolderListOfCallsResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**calls** | [**Array<LibraryCall>**](LibraryCall.md) | A list, in which each item represents one library call. | [optional]
|
7
|
+
**created_by** | **String** | Gong's unique numeric identifier for the user who added the folder. | [optional]
|
8
|
+
**id** | **String** | Gong's unique numeric identifier for a library's folder (up to 20 digits). | [optional]
|
9
|
+
**name** | **String** | Display name of the folder. | [optional]
|
10
|
+
**request_id** | **String** | A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes. | [optional]
|
11
|
+
**updated** | **String** | Folder's last update time in the ISO-8601 format (e.g., '2020-03-14T05:30:00-08:00'). | [optional]
|
12
|
+
|
@@ -0,0 +1,8 @@
|
|
1
|
+
# GongAPI::LibraryResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**folders** | [**Array<LibraryFolder>**](LibraryFolder.md) | A list, in which each item specifies one folder. | [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::LineErrorResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**description** | **String** | Error description | [optional]
|
7
|
+
**line** | **Integer** | Line number of failed object | [optional]
|
8
|
+
|
@@ -0,0 +1,8 @@
|
|
1
|
+
# GongAPI::ListGenericCrmIntegrationsResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**integrations** | [**Array<GenericCrmIntegration>**](GenericCrmIntegration.md) | Active Integration | [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::ListSelectedFieldsResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**object_type_to_selected_fields** | **Hash<String, Array<GenericSchemaFieldRequest>>** | selectedFields | [optional]
|
7
|
+
**request_id** | **String** | A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes. | [optional]
|
8
|
+
|
data/docs/LogEntry.md
ADDED
@@ -0,0 +1,15 @@
|
|
1
|
+
# GongAPI::LogEntry
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**event_time** | **String** | The time 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); when log was created. | [optional]
|
7
|
+
**impersonator_company_id** | **String** | Gong's unique numeric identifier for the impersonating user's company id (up to 20 digits), if available. | [optional]
|
8
|
+
**impersonator_email_address** | **String** | The email address of the impersonating user, if available. | [optional]
|
9
|
+
**impersonator_full_name** | **String** | The full name of the impersonating user, if available. | [optional]
|
10
|
+
**impersonator_user_id** | **String** | Gong's unique numeric identifier for the impersonating user (up to 20 digits), if available. | [optional]
|
11
|
+
**log_record** | **Object** | The list of log fields and associated values. This element will be populated dynamically by the log record, depending on the type of log. | [optional]
|
12
|
+
**user_email_address** | **String** | The email address of the user, if available. | [optional]
|
13
|
+
**user_full_name** | **String** | The full name of the user, if available. | [optional]
|
14
|
+
**user_id** | **String** | Gong's unique numeric identifier for the user (up to 20 digits), if available. | [optional]
|
15
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# GongAPI::LogsResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**log_entries** | [**Array<LogEntry>**](LogEntry.md) | A list, in which each item specifies one log. | [optional]
|
7
|
+
**records** | [**Records**](Records.md) | | [optional]
|
8
|
+
**request_id** | **String** | A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes. | [optional]
|
9
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# GongAPI::ManualAssociationResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**associations** | [**Array<ManualAssociationsBasicData>**](ManualAssociationsBasicData.md) | A list, in which each item specifies one manual call association. | [optional]
|
7
|
+
**records** | [**Records**](Records.md) | | [optional]
|
8
|
+
**request_id** | **String** | A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes. | [optional]
|
9
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# GongAPI::ManualAssociationsBasicData
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**associated_crm_objects** | [**Array<AssociationObject>**](AssociationObject.md) | List of all association objects. | [optional]
|
7
|
+
**call_id** | **String** | Gong's unique numeric identifier for the call (up to 20 digits). | [optional]
|
8
|
+
**created** | **String** | The association date. | [optional]
|
9
|
+
**user_id** | **String** | The user Id who performed the association. | [optional]
|
10
|
+
|
data/docs/Media.md
ADDED
@@ -0,0 +1,8 @@
|
|
1
|
+
# GongAPI::Media
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**audio_url** | **String** | If true and exist, add audio url of the call. The url will be available for 8 hours. | [optional]
|
7
|
+
**video_url** | **String** | If true and exist, add video url of the call. The url will be available for 8 hours. | [optional]
|
8
|
+
|
data/docs/Meeting.md
ADDED
@@ -0,0 +1,10 @@
|
|
1
|
+
# GongAPI::MeetingInvitee
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**display_name** | **String** | The name of the person. | [optional]
|
7
|
+
**email** | **String** | The unique meeting to identify the meeting. | [optional]
|
8
|
+
**first_name** | **String** | The first name of the person, if available. | [optional]
|
9
|
+
**last_name** | **String** | The last name of the person, if available. | [optional]
|
10
|
+
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# GongAPI::MeetingsErrorResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**errors** | **Object** | Error messages. | [optional]
|
7
|
+
**fix_url** | **String** | Link to Gong where a Gong administrator can fix the issue | [optional]
|
8
|
+
**help_url** | **String** | Link to Gong help center. | [optional]
|
9
|
+
**request_id** | **String** | A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes. | [optional]
|
10
|
+
**user_facing_error** | **String** | User facing error messages. | [optional]
|
11
|
+
|
@@ -0,0 +1,199 @@
|
|
1
|
+
# GongAPI::MeetingsInBetaPhaseApi
|
2
|
+
|
3
|
+
All URIs are relative to *//127.0.0.1/*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**add_meeting_using_post**](MeetingsInBetaPhaseApi.md#add_meeting_using_post) | **POST** /v2/meetings | Create a New Gong Meeting (/v2/meetings)
|
8
|
+
[**delete_meeting_using_delete**](MeetingsInBetaPhaseApi.md#delete_meeting_using_delete) | **DELETE** /v2/meetings/{meetingId} | Delete a Gong Meeting (/v2/meetings)
|
9
|
+
[**integration_status_using_post**](MeetingsInBetaPhaseApi.md#integration_status_using_post) | **POST** /v2/meetings/integration/status | Validate Gong meeting Integration (/v2/meetings/integration/status)
|
10
|
+
[**update_meeting_using_put**](MeetingsInBetaPhaseApi.md#update_meeting_using_put) | **PUT** /v2/meetings/{meetingId} | Update a Gong Meeting (/v2/meetings/{meetingId})
|
11
|
+
|
12
|
+
# **add_meeting_using_post**
|
13
|
+
> NewMeetingResponse add_meeting_using_post(body)
|
14
|
+
|
15
|
+
Create a New Gong Meeting (/v2/meetings)
|
16
|
+
|
17
|
+
When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:meetings:user:create'.
|
18
|
+
|
19
|
+
### Example
|
20
|
+
```ruby
|
21
|
+
# load the gem
|
22
|
+
require 'gong_api'
|
23
|
+
|
24
|
+
api_instance = GongAPI::MeetingsInBetaPhaseApi.new
|
25
|
+
body = GongAPI::NewMeetingRequest.new # NewMeetingRequest | newMeetingRequest
|
26
|
+
|
27
|
+
|
28
|
+
begin
|
29
|
+
#Create a New Gong Meeting (/v2/meetings)
|
30
|
+
result = api_instance.add_meeting_using_post(body)
|
31
|
+
p result
|
32
|
+
rescue GongAPI::ApiError => e
|
33
|
+
puts "Exception when calling MeetingsInBetaPhaseApi->add_meeting_using_post: #{e}"
|
34
|
+
end
|
35
|
+
```
|
36
|
+
|
37
|
+
### Parameters
|
38
|
+
|
39
|
+
Name | Type | Description | Notes
|
40
|
+
------------- | ------------- | ------------- | -------------
|
41
|
+
**body** | [**NewMeetingRequest**](NewMeetingRequest.md)| newMeetingRequest |
|
42
|
+
|
43
|
+
### Return type
|
44
|
+
|
45
|
+
[**NewMeetingResponse**](NewMeetingResponse.md)
|
46
|
+
|
47
|
+
### Authorization
|
48
|
+
|
49
|
+
No authorization required
|
50
|
+
|
51
|
+
### HTTP request headers
|
52
|
+
|
53
|
+
- **Content-Type**: application/json
|
54
|
+
- **Accept**: application/json
|
55
|
+
|
56
|
+
|
57
|
+
|
58
|
+
# **delete_meeting_using_delete**
|
59
|
+
> DeleteMeetingRequest delete_meeting_using_delete(bodymeeting_id)
|
60
|
+
|
61
|
+
Delete a Gong Meeting (/v2/meetings)
|
62
|
+
|
63
|
+
When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:meetings:user:delete'.
|
64
|
+
|
65
|
+
### Example
|
66
|
+
```ruby
|
67
|
+
# load the gem
|
68
|
+
require 'gong_api'
|
69
|
+
|
70
|
+
api_instance = GongAPI::MeetingsInBetaPhaseApi.new
|
71
|
+
body = GongAPI::DeleteMeetingRequest.new # DeleteMeetingRequest | request
|
72
|
+
meeting_id = 789 # Integer | Gong's unique identifier for the meeting (up to 20 digits).
|
73
|
+
|
74
|
+
|
75
|
+
begin
|
76
|
+
#Delete a Gong Meeting (/v2/meetings)
|
77
|
+
result = api_instance.delete_meeting_using_delete(bodymeeting_id)
|
78
|
+
p result
|
79
|
+
rescue GongAPI::ApiError => e
|
80
|
+
puts "Exception when calling MeetingsInBetaPhaseApi->delete_meeting_using_delete: #{e}"
|
81
|
+
end
|
82
|
+
```
|
83
|
+
|
84
|
+
### Parameters
|
85
|
+
|
86
|
+
Name | Type | Description | Notes
|
87
|
+
------------- | ------------- | ------------- | -------------
|
88
|
+
**body** | [**DeleteMeetingRequest**](DeleteMeetingRequest.md)| request |
|
89
|
+
**meeting_id** | **Integer**| Gong's unique identifier for the meeting (up to 20 digits). |
|
90
|
+
|
91
|
+
### Return type
|
92
|
+
|
93
|
+
[**DeleteMeetingRequest**](DeleteMeetingRequest.md)
|
94
|
+
|
95
|
+
### Authorization
|
96
|
+
|
97
|
+
No authorization required
|
98
|
+
|
99
|
+
### HTTP request headers
|
100
|
+
|
101
|
+
- **Content-Type**: */*
|
102
|
+
- **Accept**: application/json
|
103
|
+
|
104
|
+
|
105
|
+
|
106
|
+
# **integration_status_using_post**
|
107
|
+
> IntegrationStatusResponse integration_status_using_post(body)
|
108
|
+
|
109
|
+
Validate Gong meeting Integration (/v2/meetings/integration/status)
|
110
|
+
|
111
|
+
When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:meetings:integration:status'.
|
112
|
+
|
113
|
+
### Example
|
114
|
+
```ruby
|
115
|
+
# load the gem
|
116
|
+
require 'gong_api'
|
117
|
+
|
118
|
+
api_instance = GongAPI::MeetingsInBetaPhaseApi.new
|
119
|
+
body = GongAPI::IntegrationStatusRequest.new # IntegrationStatusRequest | integrationStatusRequest
|
120
|
+
|
121
|
+
|
122
|
+
begin
|
123
|
+
#Validate Gong meeting Integration (/v2/meetings/integration/status)
|
124
|
+
result = api_instance.integration_status_using_post(body)
|
125
|
+
p result
|
126
|
+
rescue GongAPI::ApiError => e
|
127
|
+
puts "Exception when calling MeetingsInBetaPhaseApi->integration_status_using_post: #{e}"
|
128
|
+
end
|
129
|
+
```
|
130
|
+
|
131
|
+
### Parameters
|
132
|
+
|
133
|
+
Name | Type | Description | Notes
|
134
|
+
------------- | ------------- | ------------- | -------------
|
135
|
+
**body** | [**IntegrationStatusRequest**](IntegrationStatusRequest.md)| integrationStatusRequest |
|
136
|
+
|
137
|
+
### Return type
|
138
|
+
|
139
|
+
[**IntegrationStatusResponse**](IntegrationStatusResponse.md)
|
140
|
+
|
141
|
+
### Authorization
|
142
|
+
|
143
|
+
No authorization required
|
144
|
+
|
145
|
+
### HTTP request headers
|
146
|
+
|
147
|
+
- **Content-Type**: application/json
|
148
|
+
- **Accept**: application/json
|
149
|
+
|
150
|
+
|
151
|
+
|
152
|
+
# **update_meeting_using_put**
|
153
|
+
> UpdateMeetingResponse update_meeting_using_put(bodymeeting_id)
|
154
|
+
|
155
|
+
Update a Gong Meeting (/v2/meetings/{meetingId})
|
156
|
+
|
157
|
+
When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:meetings:user:update'.
|
158
|
+
|
159
|
+
### Example
|
160
|
+
```ruby
|
161
|
+
# load the gem
|
162
|
+
require 'gong_api'
|
163
|
+
|
164
|
+
api_instance = GongAPI::MeetingsInBetaPhaseApi.new
|
165
|
+
body = GongAPI::UpdateMeetingRequest.new # UpdateMeetingRequest | updateMeetingRequest
|
166
|
+
meeting_id = 789 # Integer | Gong's unique identifier for the meeting (up to 20 digits).
|
167
|
+
|
168
|
+
|
169
|
+
begin
|
170
|
+
#Update a Gong Meeting (/v2/meetings/{meetingId})
|
171
|
+
result = api_instance.update_meeting_using_put(bodymeeting_id)
|
172
|
+
p result
|
173
|
+
rescue GongAPI::ApiError => e
|
174
|
+
puts "Exception when calling MeetingsInBetaPhaseApi->update_meeting_using_put: #{e}"
|
175
|
+
end
|
176
|
+
```
|
177
|
+
|
178
|
+
### Parameters
|
179
|
+
|
180
|
+
Name | Type | Description | Notes
|
181
|
+
------------- | ------------- | ------------- | -------------
|
182
|
+
**body** | [**UpdateMeetingRequest**](UpdateMeetingRequest.md)| updateMeetingRequest |
|
183
|
+
**meeting_id** | **Integer**| Gong's unique identifier for the meeting (up to 20 digits). |
|
184
|
+
|
185
|
+
### Return type
|
186
|
+
|
187
|
+
[**UpdateMeetingResponse**](UpdateMeetingResponse.md)
|
188
|
+
|
189
|
+
### Authorization
|
190
|
+
|
191
|
+
No authorization required
|
192
|
+
|
193
|
+
### HTTP request headers
|
194
|
+
|
195
|
+
- **Content-Type**: application/json
|
196
|
+
- **Accept**: application/json
|
197
|
+
|
198
|
+
|
199
|
+
|
data/docs/Monologue.md
ADDED
@@ -0,0 +1,9 @@
|
|
1
|
+
# GongAPI::Monologue
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**sentences** | [**Array<Sentence>**](Sentence.md) | A list of sentences spoken in the monologue. | [optional]
|
7
|
+
**speaker_id** | **String** | Unique ID of the speaker. Cross-reference this with the 'speakerId' field of objects in the 'parties' array returned from endpoint '/v2/calls/extensive' to identify the participant. | [optional]
|
8
|
+
**topic** | **String** | The name of the topic. | [optional]
|
9
|
+
|