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,10 @@
|
|
1
|
+
# GongAPI::MultipleUsersRequestWithCreationDates
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**created_from_date_time** | **String** | An optional user creation time lower limit, if supplied the API will return only the users created at or after this time. The filed is 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
|
+
**created_to_date_time** | **String** | An optional user creation time upper limit, if supplied the API will return only the users created before this time. The filed is 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]
|
8
|
+
**include_avatars** | **BOOLEAN** | Avatars are synthetic users representing Gong employees (CSMs and support providers) when they access your instance. References to avatars' IDs may be found in the outputs of other API endpoints. This parameter is optional, if not provided avatars will not be included in the results. | [optional]
|
9
|
+
**user_ids** | **Object** | Set of Gong's unique numeric identifiers for the users (up to 20 digits). | [optional]
|
10
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# GongAPI::MultipleUsersWithDates
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**from_date** | **Date** | The date (in the company's time zone) from which to list a user's activity. This value is inclusive. The date should be specified in the following format: YYYY-MM-DD. |
|
7
|
+
**to_date** | **Date** | The date (in the company's time zone) until which to list a user's activity. This value is exclusive. This value should not exceed the current day.The date should be specified in the following format: YYYY-MM-DD. |
|
8
|
+
**user_ids** | **Object** | Set of Gong's unique numeric identifiers for the users (up to 20 digits). | [optional]
|
9
|
+
|
@@ -0,0 +1,25 @@
|
|
1
|
+
# GongAPI::NewCallAddingRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**actual_start** | **String** | The actual date and time when the call started 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); |
|
7
|
+
**call_provider_code** | **String** | The code identifies the provider conferencing or telephony system. For example: zoom, clearslide, gotomeeting, ringcentral, outreach, insidesales, etc. These values are predefined by Gong, please contact help@gong.io to find the proper value for your system. | [optional]
|
8
|
+
**client_unique_id** | **String** | A call's unique identifier in the PBX or the recording system. Gong uses this identifier to prevent repeated attempts to upload the same recording. |
|
9
|
+
**context** | [**Array<CallUploadContext>**](CallUploadContext.md) | A list of references to external systems such as CRM, Telephony System, Case Management, etc. | [optional]
|
10
|
+
**custom_data** | **String** | Optional metadata associated with the call (represented as text). Gong stores this metadata and it can be used for troubleshooting. | [optional]
|
11
|
+
**direction** | **String** | Whether the call is inbound (someone called the company), outbound (a rep dialed someone outside the company), or a conference call. |
|
12
|
+
**disposition** | **String** | The disposition of the call. The disposition is free text of up to 255 characters. | [optional]
|
13
|
+
**download_media_url** | **String** | The URL from which Gong can download the media file. The URL must be unique, the audio or video file must be a maximum of 1.5GB. If you provide this URL, you should not perform the 'Add call media' step. | [optional]
|
14
|
+
**duration** | **Float** | The actual call duration in seconds. | [optional]
|
15
|
+
**language_code** | **String** | The language code the call should be transcribed to. This field is optional as Gong automatically detects the language spoken in the call and transcribes it accordingly. Set this field only if you are sure of the language the call is in. Valid values are: af-ZA, am-ET, ar-AE, ar-BH, ar-DZ, ar-EG, ar-IL, ar-IQ, ar-JO, ar-KW, ar-LB, ar-MA, ar-MR, ar-OM, ar-PS, ar-QA, ar-SA, ar-TN, ar-YE, az-AZ, bg-BG, bn-BD, bn-IN, bs-BA, ca-ES, cs-CZ, da-DK, de-AT, de-CH, de-DE, el-GR, en-AB, en-AU, en-CA, en-GB, en-IE, en-IN, en-NZ, en-PH, en-SG, en-US, en-WL, en-ZA, es-AR, es-BO, es-CL, es-CO, es-CR, es-DO, es-EC, es-ES, es-GT, es-HN, es-MX, es-NI, es-PA, es-PE, es-PR, es-PY, es-SV, es-US, es-UY, et-EE, eu-ES, fa-IR, fi-FI, fil-PH, fr-BE, fr-CA, fr-CH, fr-FR, gl-ES, gu-IN, he-IL, hi-IN, hr-HR, hu-HU, hy-AM, id-ID, is-IS, it-CH, it-IT, ja-JP, jv-ID, ka-GE, kk-KZ, km-KH, kn-IN, ko-KR, lo-LA, lt-LT, lv-LV, mk-MK, ml-IN, mn-MN, mr-IN, ms-MY, my-MM, ne-NP, nl-BE, nl-NL, no-NO, pa-Guru-IN, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, si-LK, sk-SK, sl-SI, sq-AL, sr-RS, su-ID, sv-SE, sw-KE, sw-TZ, ta-IN, ta-LK, ta-MY, ta-SG, te-IN, th-TH, tr-TR, uk-UA, ur-IN, ur-PK, uz-UZ, vi-VN, yue-Hant-HK, zh-CN, zh-TW, zu-ZA | [optional]
|
16
|
+
**meeting_url** | **String** | The URL of the conference call by which users join the meeting | [optional]
|
17
|
+
**parties** | [**Array<CallParticipant>**](CallParticipant.md) | A list of the call's participants. A party must be provided for the primaryUser. |
|
18
|
+
**primary_user** | **String** | The Gong internal user ID of the team member who hosted the call. |
|
19
|
+
**purpose** | **String** | The purpose of the call. This optional field is a free text of up to 255 characters. | [optional]
|
20
|
+
**scheduled_end** | **String** | The date and time the call was scheduled to end 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]
|
21
|
+
**scheduled_start** | **String** | The date and time the call was scheduled to begin 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]
|
22
|
+
**speakers_timeline** | [**SpeakersTimeline**](SpeakersTimeline.md) | | [optional]
|
23
|
+
**title** | **String** | The title of the call. This title is available in the Gong system for indexing and search. | [optional]
|
24
|
+
**workspace_id** | **String** | Optional workspace identifier. If specified, the call will be placed into this workspace, otherwise, the default algorithm for workspace placement will be applied. | [optional]
|
25
|
+
|
@@ -0,0 +1,8 @@
|
|
1
|
+
# GongAPI::NewCallAddingResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**call_id** | **String** | New call ID | [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::NewCallRecordingResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**call_id** | **String** | New call ID | [optional]
|
7
|
+
**request_id** | **String** | A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes. | [optional]
|
8
|
+
**url** | **String** | The URL to the page in the Gong web application where the call is available. | [optional]
|
9
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# GongAPI::NewMeetingRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**end_time** | **String** | The meeting end time in 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
|
+
**external_id** | **String** | The ID as it is formed on the external system. | [optional]
|
8
|
+
**invitees** | [**Array<MeetingInvitee>**](MeetingInvitee.md) | A list of email addresses of invitees to the event (not including the organizer). |
|
9
|
+
**organizer_email** | **String** | The email address of the user creating the meeting, the Gong consent page link will be used according to the settings of this user. | [optional]
|
10
|
+
**start_time** | **String** | The meeting start time in ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC). | [optional]
|
11
|
+
**title** | **String** | Title of the event. | [optional]
|
12
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# GongAPI::NewMeetingResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**additional_invitees** | [**Array<MeetingInvitee>**](MeetingInvitee.md) | Attendees the requesting party should add to the invitation, this should support adding email addresses such as coordinator@gong.io for Gong to schedule the recording of the meeting. | [optional]
|
7
|
+
**meeting_id** | **String** | Gong's unique identifier for the meeting (up to 20 digits). | [optional]
|
8
|
+
**meeting_url** | **String** | The Gong URL of the meeting, should be used to enter the meeting. | [optional]
|
9
|
+
**request_id** | **String** | A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes. | [optional]
|
10
|
+
|
data/docs/Occurrences.md
ADDED
@@ -0,0 +1,8 @@
|
|
1
|
+
# GongAPI::Occurrences
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**speaker_id** | **String** | Unique ID of the speaker in the call who said it. It references the speakerID in the “parties” field and in the transcript. | [optional]
|
7
|
+
**start_time** | **Float** | The number of seconds from the beginning of the call when the tracker phrase was captured. | [optional]
|
8
|
+
|
data/docs/Party.md
ADDED
@@ -0,0 +1,16 @@
|
|
1
|
+
# GongAPI::Party
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**affiliation** | **String** | Whether the participant is from the company or not. | [optional]
|
7
|
+
**context** | [**Array<PartyContext>**](PartyContext.md) | A list of links to external systems such as CRM, Dialer, Case Management, etc. | [optional]
|
8
|
+
**email_address** | **String** | Email address. | [optional]
|
9
|
+
**id** | **String** | Unique ID of the participant in the call. | [optional]
|
10
|
+
**methods** | **Array<String>** | Whether the participant was invited to the meeting or only attended the call. | [optional]
|
11
|
+
**name** | **String** | The name of the participant. | [optional]
|
12
|
+
**phone_number** | **String** | The phone number of the participant. | [optional]
|
13
|
+
**speaker_id** | **String** | Unique ID of a participant that spoke in the call. References to this id will appear in the '/v2/calls/transcript' endpoint response. | [optional]
|
14
|
+
**title** | **String** | The job title of the participant | [optional]
|
15
|
+
**user_id** | **String** | The user ID of the participant within the Gong system, if the participant exists in the system. | [optional]
|
16
|
+
|
@@ -0,0 +1,8 @@
|
|
1
|
+
# GongAPI::PartyContext
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**objects** | [**Array<ExternalPartyObject>**](ExternalPartyObject.md) | List of objects within the external system | [optional]
|
7
|
+
**system** | **String** | External system name. e.g. Salesforce | [optional]
|
8
|
+
|
@@ -0,0 +1,8 @@
|
|
1
|
+
# GongAPI::PartyContextField
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**name** | **String** | Field name. All custom fields are supported. | [optional]
|
7
|
+
**value** | **Object** | Object value | [optional]
|
8
|
+
|
@@ -0,0 +1,8 @@
|
|
1
|
+
# GongAPI::PartyUploadContext
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**objects** | [**Array<ExternalCrmPartyObject>**](ExternalCrmPartyObject.md) | List of objects within the external system | [optional]
|
7
|
+
**system** | **String** | External system name. Currently only Salesforce and Generic are supported. |
|
8
|
+
|
@@ -0,0 +1,41 @@
|
|
1
|
+
# GongAPI::PermissionProfileDTO
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**account** | **BOOLEAN** | User can view account pages. | [optional]
|
7
|
+
**activity** | **BOOLEAN** | User can view activity pages. | [optional]
|
8
|
+
**calls_access** | [**CallAccessWithPermissionLevel**](CallAccessWithPermissionLevel.md) | | [optional]
|
9
|
+
**calls_and_search** | **BOOLEAN** | User can view and search calls. | [optional]
|
10
|
+
**coaching** | **BOOLEAN** | User can view coaching pages. | [optional]
|
11
|
+
**coaching_access** | [**CoachingAccessWithPermissionLevel**](CoachingAccessWithPermissionLevel.md) | | [optional]
|
12
|
+
**create_edit_and_delete_deals_boards** | **BOOLEAN** | User can create/edit/delete deals boards. | [optional]
|
13
|
+
**crm_data_import** | **BOOLEAN** | User can perform import of crm data. | [optional]
|
14
|
+
**crm_data_inline_editing** | **BOOLEAN** | User can perform inline editing of crm data. | [optional]
|
15
|
+
**deals** | **BOOLEAN** | User can view deals pages. | [optional]
|
16
|
+
**deals_access** | [**DealsAccessWithPermissionLevel**](DealsAccessWithPermissionLevel.md) | | [optional]
|
17
|
+
**deals_inline_editing** | **BOOLEAN** | User can perform inline editing of deals. | [optional]
|
18
|
+
**delete_calls** | **BOOLEAN** | User can delete calls. | [optional]
|
19
|
+
**delete_emails** | **BOOLEAN** | User can delete emails. | [optional]
|
20
|
+
**description** | **String** | Permission profile description. | [optional]
|
21
|
+
**download_call_media** | **BOOLEAN** | User can download call media. | [optional]
|
22
|
+
**emails_access** | [**EmailsAccessWithPermissionLevel**](EmailsAccessWithPermissionLevel.md) | | [optional]
|
23
|
+
**export_calls_and_coaching_data_to_csv** | **BOOLEAN** | User can export calls and coaching metrics data to CSV. | [optional]
|
24
|
+
**forecast** | **BOOLEAN** | User can view forecast pages. | [optional]
|
25
|
+
**forecast_access** | [**ForecastAccessWithPermissionLevel**](ForecastAccessWithPermissionLevel.md) | | [optional]
|
26
|
+
**id** | **String** | Unique numeric identifier of the permission profile (up to 20 digits). | [optional]
|
27
|
+
**initiatives** | **BOOLEAN** | User can view initiatives page. | [optional]
|
28
|
+
**insights** | **BOOLEAN** | User can view insights pages. | [optional]
|
29
|
+
**insights_access** | [**InsightsAccessWithPermissionLevel**](InsightsAccessWithPermissionLevel.md) | | [optional]
|
30
|
+
**library** | **BOOLEAN** | User can view library pages. | [optional]
|
31
|
+
**library_folder_access** | [**LibraryFolderAccess**](LibraryFolderAccess.md) | | [optional]
|
32
|
+
**manage_general_business_settings** | **BOOLEAN** | User can manage general business settings. | [optional]
|
33
|
+
**manage_scorecards** | **BOOLEAN** | User can manage scorecards. | [optional]
|
34
|
+
**manually_schedule_and_upload_calls** | **BOOLEAN** | User can manually schedule and upload calls. | [optional]
|
35
|
+
**market** | **BOOLEAN** | User can view market page. | [optional]
|
36
|
+
**name** | **String** | Permission profile name. | [optional]
|
37
|
+
**private_calls** | **BOOLEAN** | User can set their own calls as private. | [optional]
|
38
|
+
**score_calls** | **BOOLEAN** | User can score calls. | [optional]
|
39
|
+
**share_calls_with_customers** | **BOOLEAN** | User can share calls with customers. | [optional]
|
40
|
+
**team_stats** | **BOOLEAN** | User can view team stats page. | [optional]
|
41
|
+
|
@@ -0,0 +1,8 @@
|
|
1
|
+
# GongAPI::PermissionProfileResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**profile** | [**PermissionProfileDTO**](PermissionProfileDTO.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,8 @@
|
|
1
|
+
# GongAPI::PermissionProfileUsersResponse
|
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<UserSimpleMetadata>**](UserSimpleMetadata.md) | A list, in which each item specifies a user attached to the permission profile. | [optional]
|
8
|
+
|
@@ -0,0 +1,8 @@
|
|
1
|
+
# GongAPI::PermissionProfilesResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**profiles** | [**Array<PermissionProfileDTO>**](PermissionProfileDTO.md) | A list, in which each item specifies a permission profile. | [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,387 @@
|
|
1
|
+
# GongAPI::PermissionsApi
|
2
|
+
|
3
|
+
All URIs are relative to *//127.0.0.1/*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**add_users_access_to_calls_using_put**](PermissionsApi.md#add_users_access_to_calls_using_put) | **PUT** /v2/calls/users-access | Give individual users access to calls (/v2/calls/users-access)
|
8
|
+
[**create_permission_profile_using_post**](PermissionsApi.md#create_permission_profile_using_post) | **POST** /v2/permission-profile | Create permission profile (/v2/permission-profile)
|
9
|
+
[**delete_users_access_to_calls_using_delete**](PermissionsApi.md#delete_users_access_to_calls_using_delete) | **DELETE** /v2/calls/users-access | Remove specific individual users access from calls (/v2/calls/users-access)
|
10
|
+
[**get_permission_profile_using_get**](PermissionsApi.md#get_permission_profile_using_get) | **GET** /v2/permission-profile | Permission profile for a given profile Id (/v2/permission-profile)
|
11
|
+
[**get_users_access_to_calls_using_get**](PermissionsApi.md#get_users_access_to_calls_using_get) | **GET** /v2/calls/users-access | Retrieve users that have specific individual access to calls (/v2/calls/users-access)
|
12
|
+
[**list_permission_profile_users_using_get**](PermissionsApi.md#list_permission_profile_users_using_get) | **GET** /v2/permission-profile/users | List all users attached to a given permission profile (/v2/permission-profile/users)
|
13
|
+
[**list_permission_profile_using_get**](PermissionsApi.md#list_permission_profile_using_get) | **GET** /v2/all-permission-profiles | List all company permission profiles for a given workspace (/v2/all-permission-profiles)
|
14
|
+
[**update_permission_profile_using_put**](PermissionsApi.md#update_permission_profile_using_put) | **PUT** /v2/permission-profile | Update permission profile (/v2/permission-profile)
|
15
|
+
|
16
|
+
# **add_users_access_to_calls_using_put**
|
17
|
+
> BaseResponse add_users_access_to_calls_using_put(body)
|
18
|
+
|
19
|
+
Give individual users access to calls (/v2/calls/users-access)
|
20
|
+
|
21
|
+
Give individual users access to calls. If a user already has access (perhaps the call was shared with them, or they have access through their permission profiles) the request will have no effect. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:call-user-access:write'.
|
22
|
+
|
23
|
+
### Example
|
24
|
+
```ruby
|
25
|
+
# load the gem
|
26
|
+
require 'gong_api'
|
27
|
+
|
28
|
+
api_instance = GongAPI::PermissionsApi.new
|
29
|
+
body = GongAPI::CallsUsersAccessAddDto.new # CallsUsersAccessAddDto | callsUsersAccessAddDto
|
30
|
+
|
31
|
+
|
32
|
+
begin
|
33
|
+
#Give individual users access to calls (/v2/calls/users-access)
|
34
|
+
result = api_instance.add_users_access_to_calls_using_put(body)
|
35
|
+
p result
|
36
|
+
rescue GongAPI::ApiError => e
|
37
|
+
puts "Exception when calling PermissionsApi->add_users_access_to_calls_using_put: #{e}"
|
38
|
+
end
|
39
|
+
```
|
40
|
+
|
41
|
+
### Parameters
|
42
|
+
|
43
|
+
Name | Type | Description | Notes
|
44
|
+
------------- | ------------- | ------------- | -------------
|
45
|
+
**body** | [**CallsUsersAccessAddDto**](CallsUsersAccessAddDto.md)| callsUsersAccessAddDto |
|
46
|
+
|
47
|
+
### Return type
|
48
|
+
|
49
|
+
[**BaseResponse**](BaseResponse.md)
|
50
|
+
|
51
|
+
### Authorization
|
52
|
+
|
53
|
+
No authorization required
|
54
|
+
|
55
|
+
### HTTP request headers
|
56
|
+
|
57
|
+
- **Content-Type**: application/json
|
58
|
+
- **Accept**: application/json
|
59
|
+
|
60
|
+
|
61
|
+
|
62
|
+
# **create_permission_profile_using_post**
|
63
|
+
> PermissionProfileResponse create_permission_profile_using_post(bodyworkspace_id)
|
64
|
+
|
65
|
+
Create permission profile (/v2/permission-profile)
|
66
|
+
|
67
|
+
Create a permission profile in a given workspace.
|
68
|
+
|
69
|
+
### Example
|
70
|
+
```ruby
|
71
|
+
# load the gem
|
72
|
+
require 'gong_api'
|
73
|
+
|
74
|
+
api_instance = GongAPI::PermissionsApi.new
|
75
|
+
body = GongAPI::PermissionProfileDTO.new # PermissionProfileDTO | permissionProfileDTO
|
76
|
+
workspace_id = 'workspace_id_example' # String | Workspace identifier. You can retrieve the workspace using the \"workspaces\" (under \"Settings\") API.
|
77
|
+
|
78
|
+
|
79
|
+
begin
|
80
|
+
#Create permission profile (/v2/permission-profile)
|
81
|
+
result = api_instance.create_permission_profile_using_post(bodyworkspace_id)
|
82
|
+
p result
|
83
|
+
rescue GongAPI::ApiError => e
|
84
|
+
puts "Exception when calling PermissionsApi->create_permission_profile_using_post: #{e}"
|
85
|
+
end
|
86
|
+
```
|
87
|
+
|
88
|
+
### Parameters
|
89
|
+
|
90
|
+
Name | Type | Description | Notes
|
91
|
+
------------- | ------------- | ------------- | -------------
|
92
|
+
**body** | [**PermissionProfileDTO**](PermissionProfileDTO.md)| permissionProfileDTO |
|
93
|
+
**workspace_id** | **String**| Workspace identifier. You can retrieve the workspace using the \"workspaces\" (under \"Settings\") API. |
|
94
|
+
|
95
|
+
### Return type
|
96
|
+
|
97
|
+
[**PermissionProfileResponse**](PermissionProfileResponse.md)
|
98
|
+
|
99
|
+
### Authorization
|
100
|
+
|
101
|
+
No authorization required
|
102
|
+
|
103
|
+
### HTTP request headers
|
104
|
+
|
105
|
+
- **Content-Type**: application/json
|
106
|
+
- **Accept**: application/json
|
107
|
+
|
108
|
+
|
109
|
+
|
110
|
+
# **delete_users_access_to_calls_using_delete**
|
111
|
+
> BaseResponse delete_users_access_to_calls_using_delete(body)
|
112
|
+
|
113
|
+
Remove specific individual users access from calls (/v2/calls/users-access)
|
114
|
+
|
115
|
+
Remove individual user access from calls. The request can only remove access previously given by the /v2/calls/users-access API. If a given user does not have access to the call, they will be unaffected. If a given user does have access to the call, but not through the pubic API (for example if the call was shared with the user), the user's access will remain unchanged. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:call-user-access:write'.
|
116
|
+
|
117
|
+
### Example
|
118
|
+
```ruby
|
119
|
+
# load the gem
|
120
|
+
require 'gong_api'
|
121
|
+
|
122
|
+
api_instance = GongAPI::PermissionsApi.new
|
123
|
+
body = GongAPI::CallsUsersAccessDeleteDto.new # CallsUsersAccessDeleteDto | callsUsersAccessDeleteDto
|
124
|
+
|
125
|
+
|
126
|
+
begin
|
127
|
+
#Remove specific individual users access from calls (/v2/calls/users-access)
|
128
|
+
result = api_instance.delete_users_access_to_calls_using_delete(body)
|
129
|
+
p result
|
130
|
+
rescue GongAPI::ApiError => e
|
131
|
+
puts "Exception when calling PermissionsApi->delete_users_access_to_calls_using_delete: #{e}"
|
132
|
+
end
|
133
|
+
```
|
134
|
+
|
135
|
+
### Parameters
|
136
|
+
|
137
|
+
Name | Type | Description | Notes
|
138
|
+
------------- | ------------- | ------------- | -------------
|
139
|
+
**body** | [**CallsUsersAccessDeleteDto**](CallsUsersAccessDeleteDto.md)| callsUsersAccessDeleteDto |
|
140
|
+
|
141
|
+
### Return type
|
142
|
+
|
143
|
+
[**BaseResponse**](BaseResponse.md)
|
144
|
+
|
145
|
+
### Authorization
|
146
|
+
|
147
|
+
No authorization required
|
148
|
+
|
149
|
+
### HTTP request headers
|
150
|
+
|
151
|
+
- **Content-Type**: */*
|
152
|
+
- **Accept**: application/json
|
153
|
+
|
154
|
+
|
155
|
+
|
156
|
+
# **get_permission_profile_using_get**
|
157
|
+
> PermissionProfileResponse get_permission_profile_using_get(profile_id)
|
158
|
+
|
159
|
+
Permission profile for a given profile Id (/v2/permission-profile)
|
160
|
+
|
161
|
+
Returns a permission profile.
|
162
|
+
|
163
|
+
### Example
|
164
|
+
```ruby
|
165
|
+
# load the gem
|
166
|
+
require 'gong_api'
|
167
|
+
|
168
|
+
api_instance = GongAPI::PermissionsApi.new
|
169
|
+
profile_id = 'profile_id_example' # String | Permission profile identifier.
|
170
|
+
|
171
|
+
|
172
|
+
begin
|
173
|
+
#Permission profile for a given profile Id (/v2/permission-profile)
|
174
|
+
result = api_instance.get_permission_profile_using_get(profile_id)
|
175
|
+
p result
|
176
|
+
rescue GongAPI::ApiError => e
|
177
|
+
puts "Exception when calling PermissionsApi->get_permission_profile_using_get: #{e}"
|
178
|
+
end
|
179
|
+
```
|
180
|
+
|
181
|
+
### Parameters
|
182
|
+
|
183
|
+
Name | Type | Description | Notes
|
184
|
+
------------- | ------------- | ------------- | -------------
|
185
|
+
**profile_id** | **String**| Permission profile identifier. |
|
186
|
+
|
187
|
+
### Return type
|
188
|
+
|
189
|
+
[**PermissionProfileResponse**](PermissionProfileResponse.md)
|
190
|
+
|
191
|
+
### Authorization
|
192
|
+
|
193
|
+
No authorization required
|
194
|
+
|
195
|
+
### HTTP request headers
|
196
|
+
|
197
|
+
- **Content-Type**: Not defined
|
198
|
+
- **Accept**: application/json
|
199
|
+
|
200
|
+
|
201
|
+
|
202
|
+
# **get_users_access_to_calls_using_get**
|
203
|
+
> CallsAccessDetailsResponse get_users_access_to_calls_using_get(body)
|
204
|
+
|
205
|
+
Retrieve users that have specific individual access to calls (/v2/calls/users-access)
|
206
|
+
|
207
|
+
Returns a list of users who have received individual access to calls through the API. This endpoint doesn't cover user that have access for other reasons (such as sharing recipients, or access through permission profiles). When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:call-user-access:read'.
|
208
|
+
|
209
|
+
### Example
|
210
|
+
```ruby
|
211
|
+
# load the gem
|
212
|
+
require 'gong_api'
|
213
|
+
|
214
|
+
api_instance = GongAPI::PermissionsApi.new
|
215
|
+
body = GongAPI::RequestCallsAccessGetDto.new # RequestCallsAccessGetDto | callsAccessGetDto
|
216
|
+
|
217
|
+
|
218
|
+
begin
|
219
|
+
#Retrieve users that have specific individual access to calls (/v2/calls/users-access)
|
220
|
+
result = api_instance.get_users_access_to_calls_using_get(body)
|
221
|
+
p result
|
222
|
+
rescue GongAPI::ApiError => e
|
223
|
+
puts "Exception when calling PermissionsApi->get_users_access_to_calls_using_get: #{e}"
|
224
|
+
end
|
225
|
+
```
|
226
|
+
|
227
|
+
### Parameters
|
228
|
+
|
229
|
+
Name | Type | Description | Notes
|
230
|
+
------------- | ------------- | ------------- | -------------
|
231
|
+
**body** | [**RequestCallsAccessGetDto**](RequestCallsAccessGetDto.md)| callsAccessGetDto |
|
232
|
+
|
233
|
+
### Return type
|
234
|
+
|
235
|
+
[**CallsAccessDetailsResponse**](CallsAccessDetailsResponse.md)
|
236
|
+
|
237
|
+
### Authorization
|
238
|
+
|
239
|
+
No authorization required
|
240
|
+
|
241
|
+
### HTTP request headers
|
242
|
+
|
243
|
+
- **Content-Type**: */*
|
244
|
+
- **Accept**: application/json
|
245
|
+
|
246
|
+
|
247
|
+
|
248
|
+
# **list_permission_profile_users_using_get**
|
249
|
+
> PermissionProfileUsersResponse list_permission_profile_users_using_get(profile_id)
|
250
|
+
|
251
|
+
List all users attached to a given permission profile (/v2/permission-profile/users)
|
252
|
+
|
253
|
+
Returns a list of all users whose access is controlled by the given permission profile. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:users:read'.
|
254
|
+
|
255
|
+
### Example
|
256
|
+
```ruby
|
257
|
+
# load the gem
|
258
|
+
require 'gong_api'
|
259
|
+
|
260
|
+
api_instance = GongAPI::PermissionsApi.new
|
261
|
+
profile_id = 'profile_id_example' # String | Permission profile identifier.
|
262
|
+
|
263
|
+
|
264
|
+
begin
|
265
|
+
#List all users attached to a given permission profile (/v2/permission-profile/users)
|
266
|
+
result = api_instance.list_permission_profile_users_using_get(profile_id)
|
267
|
+
p result
|
268
|
+
rescue GongAPI::ApiError => e
|
269
|
+
puts "Exception when calling PermissionsApi->list_permission_profile_users_using_get: #{e}"
|
270
|
+
end
|
271
|
+
```
|
272
|
+
|
273
|
+
### Parameters
|
274
|
+
|
275
|
+
Name | Type | Description | Notes
|
276
|
+
------------- | ------------- | ------------- | -------------
|
277
|
+
**profile_id** | **String**| Permission profile identifier. |
|
278
|
+
|
279
|
+
### Return type
|
280
|
+
|
281
|
+
[**PermissionProfileUsersResponse**](PermissionProfileUsersResponse.md)
|
282
|
+
|
283
|
+
### Authorization
|
284
|
+
|
285
|
+
No authorization required
|
286
|
+
|
287
|
+
### HTTP request headers
|
288
|
+
|
289
|
+
- **Content-Type**: Not defined
|
290
|
+
- **Accept**: application/json
|
291
|
+
|
292
|
+
|
293
|
+
|
294
|
+
# **list_permission_profile_using_get**
|
295
|
+
> PermissionProfilesResponse list_permission_profile_using_get(workspace_id)
|
296
|
+
|
297
|
+
List all company permission profiles for a given workspace (/v2/all-permission-profiles)
|
298
|
+
|
299
|
+
Returns a list of all permission profiles. The listing is in the alphabetical order of the profile names.
|
300
|
+
|
301
|
+
### Example
|
302
|
+
```ruby
|
303
|
+
# load the gem
|
304
|
+
require 'gong_api'
|
305
|
+
|
306
|
+
api_instance = GongAPI::PermissionsApi.new
|
307
|
+
workspace_id = 'workspace_id_example' # String | Workspace identifier, the API will return only the profiles belonging to this workspace. You can retrieve the workspace using the \"workspaces\" (under \"Settings\") API.
|
308
|
+
|
309
|
+
|
310
|
+
begin
|
311
|
+
#List all company permission profiles for a given workspace (/v2/all-permission-profiles)
|
312
|
+
result = api_instance.list_permission_profile_using_get(workspace_id)
|
313
|
+
p result
|
314
|
+
rescue GongAPI::ApiError => e
|
315
|
+
puts "Exception when calling PermissionsApi->list_permission_profile_using_get: #{e}"
|
316
|
+
end
|
317
|
+
```
|
318
|
+
|
319
|
+
### Parameters
|
320
|
+
|
321
|
+
Name | Type | Description | Notes
|
322
|
+
------------- | ------------- | ------------- | -------------
|
323
|
+
**workspace_id** | **String**| Workspace identifier, the API will return only the profiles belonging to this workspace. You can retrieve the workspace using the \"workspaces\" (under \"Settings\") API. |
|
324
|
+
|
325
|
+
### Return type
|
326
|
+
|
327
|
+
[**PermissionProfilesResponse**](PermissionProfilesResponse.md)
|
328
|
+
|
329
|
+
### Authorization
|
330
|
+
|
331
|
+
No authorization required
|
332
|
+
|
333
|
+
### HTTP request headers
|
334
|
+
|
335
|
+
- **Content-Type**: Not defined
|
336
|
+
- **Accept**: application/json
|
337
|
+
|
338
|
+
|
339
|
+
|
340
|
+
# **update_permission_profile_using_put**
|
341
|
+
> PermissionProfileResponse update_permission_profile_using_put(bodyprofile_id)
|
342
|
+
|
343
|
+
Update permission profile (/v2/permission-profile)
|
344
|
+
|
345
|
+
Update a permission profile.
|
346
|
+
|
347
|
+
### Example
|
348
|
+
```ruby
|
349
|
+
# load the gem
|
350
|
+
require 'gong_api'
|
351
|
+
|
352
|
+
api_instance = GongAPI::PermissionsApi.new
|
353
|
+
body = GongAPI::PermissionProfileDTO.new # PermissionProfileDTO | permissionProfileDTO
|
354
|
+
profile_id = 'profile_id_example' # String | Permission profile identifier.
|
355
|
+
|
356
|
+
|
357
|
+
begin
|
358
|
+
#Update permission profile (/v2/permission-profile)
|
359
|
+
result = api_instance.update_permission_profile_using_put(bodyprofile_id)
|
360
|
+
p result
|
361
|
+
rescue GongAPI::ApiError => e
|
362
|
+
puts "Exception when calling PermissionsApi->update_permission_profile_using_put: #{e}"
|
363
|
+
end
|
364
|
+
```
|
365
|
+
|
366
|
+
### Parameters
|
367
|
+
|
368
|
+
Name | Type | Description | Notes
|
369
|
+
------------- | ------------- | ------------- | -------------
|
370
|
+
**body** | [**PermissionProfileDTO**](PermissionProfileDTO.md)| permissionProfileDTO |
|
371
|
+
**profile_id** | **String**| Permission profile identifier. |
|
372
|
+
|
373
|
+
### Return type
|
374
|
+
|
375
|
+
[**PermissionProfileResponse**](PermissionProfileResponse.md)
|
376
|
+
|
377
|
+
### Authorization
|
378
|
+
|
379
|
+
No authorization required
|
380
|
+
|
381
|
+
### HTTP request headers
|
382
|
+
|
383
|
+
- **Content-Type**: application/json
|
384
|
+
- **Accept**: application/json
|
385
|
+
|
386
|
+
|
387
|
+
|
@@ -0,0 +1,14 @@
|
|
1
|
+
# GongAPI::PhoneNumberReferences
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**calls** | [**Array<CallReference>**](CallReference.md) | Related calls. | [optional]
|
7
|
+
**customer_data** | [**Array<CustomerData>**](CustomerData.md) | A list of links to data from external systems (such as CRM, Telephony System, Case Management, etc.) that reference the email address and that Gong stores. | [optional]
|
8
|
+
**email_addresses** | **Array<String>** | Related email addresses. | [optional]
|
9
|
+
**emails** | [**Array<EmailMessage>**](EmailMessage.md) | Related email messages. | [optional]
|
10
|
+
**matching_phone_numbers** | **Array<String>** | Matching phone numbers found. | [optional]
|
11
|
+
**meetings** | [**Array<Meeting>**](Meeting.md) | Related meetings. | [optional]
|
12
|
+
**request_id** | **String** | A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes. | [optional]
|
13
|
+
**supplied_phone_number** | **String** | The supplied phone number. | [optional]
|
14
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# GongAPI::PointOfInterest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**snippet** | **String** | The snippet including the action. | [optional]
|
7
|
+
**snippet_end_time** | **Float** | The number of seconds from the beginning of the call that the snippet end refers to. | [optional]
|
8
|
+
**snippet_start_time** | **Float** | The number of seconds from the beginning of the call that the snippet start refers to. | [optional]
|
9
|
+
**speaker_id** | **String** | Unique ID of the participant in the call. | [optional]
|
10
|
+
|