gong_api 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/Gemfile +9 -0
- data/README.md +906 -0
- data/Rakefile +8 -0
- data/config.json +12 -0
- data/docs/Actor.md +10 -0
- data/docs/AggregateActivity.md +21 -0
- data/docs/AggregateActivityWithDates.md +23 -0
- data/docs/Answer.md +12 -0
- data/docs/AnsweredScorecard.md +16 -0
- data/docs/AnsweredScorecards.md +9 -0
- data/docs/AnsweredScorecardsFilter.md +12 -0
- data/docs/AssociationObject.md +8 -0
- data/docs/AsyncProcessingResponse.md +8 -0
- data/docs/AuditingApi.md +61 -0
- data/docs/BaseResponse.md +7 -0
- data/docs/CRMApi.md +490 -0
- data/docs/Call.md +13 -0
- data/docs/CallAccessDetails.md +8 -0
- data/docs/CallAccessWithPermissionLevel.md +8 -0
- data/docs/CallBasicData.md +25 -0
- data/docs/CallCollaboration.md +7 -0
- data/docs/CallContent.md +11 -0
- data/docs/CallContext.md +8 -0
- data/docs/CallInteraction.md +10 -0
- data/docs/CallParticipant.md +13 -0
- data/docs/CallReference.md +9 -0
- data/docs/CallTranscript.md +8 -0
- data/docs/CallTranscripts.md +9 -0
- data/docs/CallUploadContext.md +8 -0
- data/docs/CallUsersAccessDto.md +8 -0
- data/docs/Calls.md +9 -0
- data/docs/CallsAccessDetailsResponse.md +8 -0
- data/docs/CallsAccessGetDto.md +7 -0
- data/docs/CallsApi.md +349 -0
- data/docs/CallsFilter.md +10 -0
- data/docs/CallsRequestFilterWithOwners.md +11 -0
- data/docs/CallsResponse.md +9 -0
- data/docs/CallsUsersAccessAddDto.md +7 -0
- data/docs/CallsUsersAccessDeleteDto.md +7 -0
- data/docs/CoachingAccessWithPermissionLevel.md +8 -0
- data/docs/Collaboration.md +7 -0
- data/docs/Comment.md +14 -0
- data/docs/CompanyUsersAggregateActivityResponse.md +12 -0
- data/docs/CompanyUsersIntercationStatsResponse.md +12 -0
- data/docs/Content.md +10 -0
- data/docs/ContentSelector.md +9 -0
- data/docs/ContentSharedEvent.md +23 -0
- data/docs/ContentViewedEvent.md +23 -0
- data/docs/ContextField.md +8 -0
- data/docs/CrmPartyContextField.md +8 -0
- data/docs/CustomActionEvent.md +22 -0
- data/docs/CustomerData.md +8 -0
- data/docs/CustomerDataObject.md +11 -0
- data/docs/CustomerEngagement.md +13 -0
- data/docs/DailyActivityWithDates.md +23 -0
- data/docs/DataPrivacyApi.md +195 -0
- data/docs/DealsAccessWithPermissionLevel.md +8 -0
- data/docs/DeleteMeetingRequest.md +7 -0
- data/docs/EmailAddressReferences.md +12 -0
- data/docs/EmailMessage.md +11 -0
- data/docs/EmailsAccessWithPermissionLevel.md +8 -0
- data/docs/EngagementInBetaPhaseApi.md +148 -0
- data/docs/ErrorResponse.md +8 -0
- data/docs/EventAcceptedResponse.md +7 -0
- data/docs/ExposedFields.md +11 -0
- data/docs/ExternalCallObject.md +10 -0
- data/docs/ExternalCrmCallObject.md +9 -0
- data/docs/ExternalCrmPartyObject.md +9 -0
- data/docs/ExternalPartyObject.md +10 -0
- data/docs/ExternalSystem.md +8 -0
- data/docs/ExternalSystemObject.md +8 -0
- data/docs/ForecastAccessWithPermissionLevel.md +8 -0
- data/docs/GenericCrmIntegration.md +9 -0
- data/docs/GenericCrmRegistrationRequest.md +8 -0
- data/docs/GenericDealStageRequest.md +10 -0
- data/docs/GenericProperty.md +9 -0
- data/docs/GenericSchemaFieldRequest.md +14 -0
- data/docs/GetGenericCrmObjectsResponse.md +8 -0
- data/docs/IdMediaBody.md +7 -0
- data/docs/InsightsAccessWithPermissionLevel.md +8 -0
- data/docs/IntegrationStatusRequest.md +7 -0
- data/docs/IntegrationStatusResponse.md +8 -0
- data/docs/Interaction.md +10 -0
- data/docs/InteractionStat.md +8 -0
- data/docs/InteractionStats.md +9 -0
- data/docs/LibraryApi.md +103 -0
- data/docs/LibraryCall.md +13 -0
- data/docs/LibraryFolder.md +11 -0
- data/docs/LibraryFolderAccess.md +11 -0
- data/docs/LibraryFolderListOfCallsResponse.md +12 -0
- data/docs/LibraryResponse.md +8 -0
- data/docs/LineErrorResponse.md +8 -0
- data/docs/ListGenericCrmIntegrationsResponse.md +8 -0
- data/docs/ListSelectedFieldsResponse.md +8 -0
- data/docs/LogEntry.md +15 -0
- data/docs/LogsResponse.md +9 -0
- data/docs/ManualAssociationResponse.md +9 -0
- data/docs/ManualAssociationsBasicData.md +10 -0
- data/docs/MapUsersBody.md +7 -0
- data/docs/Media.md +8 -0
- data/docs/Meeting.md +7 -0
- data/docs/MeetingInvitee.md +10 -0
- data/docs/MeetingsErrorResponse.md +11 -0
- data/docs/MeetingsInBetaPhaseApi.md +199 -0
- data/docs/Monologue.md +9 -0
- data/docs/MultipleUsersRequestWithCreationDates.md +10 -0
- data/docs/MultipleUsersWithDates.md +9 -0
- data/docs/NewCallAddingRequest.md +25 -0
- data/docs/NewCallAddingResponse.md +8 -0
- data/docs/NewCallRecordingResponse.md +9 -0
- data/docs/NewMeetingRequest.md +12 -0
- data/docs/NewMeetingResponse.md +10 -0
- data/docs/ObjectEntitiesBody.md +7 -0
- data/docs/Occurrences.md +8 -0
- data/docs/Party.md +16 -0
- data/docs/PartyContext.md +8 -0
- data/docs/PartyContextField.md +8 -0
- data/docs/PartyUploadContext.md +8 -0
- data/docs/PermissionProfileDTO.md +41 -0
- data/docs/PermissionProfileResponse.md +8 -0
- data/docs/PermissionProfileUsersResponse.md +8 -0
- data/docs/PermissionProfilesResponse.md +8 -0
- data/docs/PermissionsApi.md +387 -0
- data/docs/PhoneNumberReferences.md +14 -0
- data/docs/PointOfInterest.md +10 -0
- data/docs/PointsOfInterest.md +7 -0
- data/docs/Question.md +13 -0
- data/docs/Questions.md +8 -0
- data/docs/Records.md +10 -0
- data/docs/RegisterGenericCrmResponse.md +8 -0
- data/docs/RequestAnsweredScorecardsFilter.md +8 -0
- data/docs/RequestCallsAccessGetDto.md +7 -0
- data/docs/RequestCallsFilter.md +8 -0
- data/docs/RequestCallsRequestFilterWithOwnersContentSelector.md +9 -0
- data/docs/RequestMultipleUsersRequestWithCreationDates.md +8 -0
- data/docs/RequestMultipleUsersWithDates.md +8 -0
- data/docs/RequestStatusResponse.md +11 -0
- data/docs/RequestWithTimePeriodMultipleUsersWithDates.md +9 -0
- data/docs/SchemaUpdateResponse.md +7 -0
- data/docs/Scorecard.md +14 -0
- data/docs/Scorecards.md +8 -0
- data/docs/Sentence.md +9 -0
- data/docs/Settings.md +12 -0
- data/docs/SettingsApi.md +91 -0
- data/docs/SettingsHistory.md +8 -0
- data/docs/Sharer.md +9 -0
- data/docs/Snippet.md +8 -0
- data/docs/Speaker.md +9 -0
- data/docs/SpeakersTimeline.md +8 -0
- data/docs/SpecificCall.md +8 -0
- data/docs/SpeechSegment.md +9 -0
- data/docs/SpokenLanguage.md +8 -0
- data/docs/StatsApi.md +242 -0
- data/docs/Structure.md +8 -0
- data/docs/Topic.md +8 -0
- data/docs/Tracker.md +12 -0
- data/docs/TrackerPhrases.md +9 -0
- data/docs/UpdateMeetingRequest.md +12 -0
- data/docs/UpdateMeetingResponse.md +8 -0
- data/docs/User.md +8 -0
- data/docs/UserAccessDetails.md +7 -0
- data/docs/UserActivity.md +9 -0
- data/docs/UserAggregateByPeriodActivities.md +9 -0
- data/docs/UserDayByDayActivity.md +9 -0
- data/docs/UserIntegrationStatus.md +12 -0
- data/docs/UserMetadata.md +21 -0
- data/docs/UserSettingsHistory.md +9 -0
- data/docs/UserSimpleMetadata.md +9 -0
- data/docs/UsersAggregateByPeriodActivity.md +9 -0
- data/docs/UsersApi.md +198 -0
- data/docs/UsersDayByDayActivity.md +9 -0
- data/docs/UsersMetadata.md +9 -0
- data/docs/Video.md +8 -0
- data/docs/WorkspaceMetadata.md +9 -0
- data/docs/WorkspacesMetadata.md +8 -0
- data/git_push.sh +55 -0
- data/gong-swagger.json +1 -0
- data/gong_api.gemspec +38 -0
- data/lib/gong_api/api/auditing_api.rb +94 -0
- data/lib/gong_api/api/calls_api.rb +437 -0
- data/lib/gong_api/api/crm_api.rb +651 -0
- data/lib/gong_api/api/data_privacy_api.rb +248 -0
- data/lib/gong_api/api/engagement_in_beta_phase_api.rb +194 -0
- data/lib/gong_api/api/library_api.rb +126 -0
- data/lib/gong_api/api/meetings_in_beta_phase_api.rb +264 -0
- data/lib/gong_api/api/permissions_api.rb +495 -0
- data/lib/gong_api/api/settings_api.rb +120 -0
- data/lib/gong_api/api/stats_api.rb +310 -0
- data/lib/gong_api/api/users_api.rb +246 -0
- data/lib/gong_api/api_client.rb +387 -0
- data/lib/gong_api/api_error.rb +57 -0
- data/lib/gong_api/configuration.rb +198 -0
- data/lib/gong_api/models/actor.rb +239 -0
- data/lib/gong_api/models/aggregate_activity.rb +348 -0
- data/lib/gong_api/models/aggregate_activity_with_dates.rb +368 -0
- data/lib/gong_api/models/answer.rb +257 -0
- data/lib/gong_api/models/answered_scorecard.rb +332 -0
- data/lib/gong_api/models/answered_scorecards.rb +228 -0
- data/lib/gong_api/models/answered_scorecards_filter.rb +258 -0
- data/lib/gong_api/models/association_object.rb +217 -0
- data/lib/gong_api/models/async_processing_response.rb +217 -0
- data/lib/gong_api/models/base_response.rb +207 -0
- data/lib/gong_api/models/call.rb +267 -0
- data/lib/gong_api/models/call_access_details.rb +220 -0
- data/lib/gong_api/models/call_access_with_permission_level.rb +254 -0
- data/lib/gong_api/models/call_basic_data.rb +446 -0
- data/lib/gong_api/models/call_collaboration.rb +208 -0
- data/lib/gong_api/models/call_content.rb +248 -0
- data/lib/gong_api/models/call_context.rb +254 -0
- data/lib/gong_api/models/call_interaction.rb +238 -0
- data/lib/gong_api/models/call_participant.rb +269 -0
- data/lib/gong_api/models/call_reference.rb +230 -0
- data/lib/gong_api/models/call_transcript.rb +219 -0
- data/lib/gong_api/models/call_transcripts.rb +228 -0
- data/lib/gong_api/models/call_upload_context.rb +259 -0
- data/lib/gong_api/models/call_users_access_dto.rb +228 -0
- data/lib/gong_api/models/calls.rb +228 -0
- data/lib/gong_api/models/calls_access_details_response.rb +219 -0
- data/lib/gong_api/models/calls_access_get_dto.rb +212 -0
- data/lib/gong_api/models/calls_filter.rb +238 -0
- data/lib/gong_api/models/calls_request_filter_with_owners.rb +248 -0
- data/lib/gong_api/models/calls_response.rb +228 -0
- data/lib/gong_api/models/calls_users_access_add_dto.rb +209 -0
- data/lib/gong_api/models/calls_users_access_delete_dto.rb +209 -0
- data/lib/gong_api/models/coaching_access_with_permission_level.rb +254 -0
- data/lib/gong_api/models/collaboration.rb +210 -0
- data/lib/gong_api/models/comment.rb +277 -0
- data/lib/gong_api/models/company_users_aggregate_activity_response.rb +258 -0
- data/lib/gong_api/models/company_users_intercation_stats_response.rb +258 -0
- data/lib/gong_api/models/content.rb +243 -0
- data/lib/gong_api/models/content_selector.rb +263 -0
- data/lib/gong_api/models/content_shared_event.rb +400 -0
- data/lib/gong_api/models/content_viewed_event.rb +432 -0
- data/lib/gong_api/models/context_field.rb +218 -0
- data/lib/gong_api/models/crm_party_context_field.rb +218 -0
- data/lib/gong_api/models/custom_action_event.rb +407 -0
- data/lib/gong_api/models/customer_data.rb +253 -0
- data/lib/gong_api/models/customer_data_object.rb +283 -0
- data/lib/gong_api/models/customer_engagement.rb +301 -0
- data/lib/gong_api/models/daily_activity_with_dates.rb +368 -0
- data/lib/gong_api/models/deals_access_with_permission_level.rb +254 -0
- data/lib/gong_api/models/delete_meeting_request.rb +208 -0
- data/lib/gong_api/models/email_address_references.rb +267 -0
- data/lib/gong_api/models/email_message.rb +247 -0
- data/lib/gong_api/models/emails_access_with_permission_level.rb +254 -0
- data/lib/gong_api/models/error_response.rb +217 -0
- data/lib/gong_api/models/event_accepted_response.rb +207 -0
- data/lib/gong_api/models/exposed_fields.rb +245 -0
- data/lib/gong_api/models/external_call_object.rb +286 -0
- data/lib/gong_api/models/external_crm_call_object.rb +274 -0
- data/lib/gong_api/models/external_crm_party_object.rb +274 -0
- data/lib/gong_api/models/external_party_object.rb +286 -0
- data/lib/gong_api/models/external_system.rb +253 -0
- data/lib/gong_api/models/external_system_object.rb +251 -0
- data/lib/gong_api/models/forecast_access_with_permission_level.rb +254 -0
- data/lib/gong_api/models/generic_crm_integration.rb +227 -0
- data/lib/gong_api/models/generic_crm_registration_request.rb +227 -0
- data/lib/gong_api/models/generic_deal_stage_request.rb +257 -0
- data/lib/gong_api/models/generic_property.rb +276 -0
- data/lib/gong_api/models/generic_schema_field_request.rb +328 -0
- data/lib/gong_api/models/get_generic_crm_objects_response.rb +219 -0
- data/lib/gong_api/models/id_media_body.rb +206 -0
- data/lib/gong_api/models/insights_access_with_permission_level.rb +254 -0
- data/lib/gong_api/models/integration_status_request.rb +209 -0
- data/lib/gong_api/models/integration_status_response.rb +219 -0
- data/lib/gong_api/models/interaction.rb +243 -0
- data/lib/gong_api/models/interaction_stat.rb +217 -0
- data/lib/gong_api/models/interaction_stats.rb +228 -0
- data/lib/gong_api/models/library_call.rb +267 -0
- data/lib/gong_api/models/library_folder.rb +248 -0
- data/lib/gong_api/models/library_folder_access.rb +284 -0
- data/lib/gong_api/models/library_folder_list_of_calls_response.rb +259 -0
- data/lib/gong_api/models/library_response.rb +219 -0
- data/lib/gong_api/models/line_error_response.rb +217 -0
- data/lib/gong_api/models/list_generic_crm_integrations_response.rb +219 -0
- data/lib/gong_api/models/list_selected_fields_response.rb +219 -0
- data/lib/gong_api/models/log_entry.rb +287 -0
- data/lib/gong_api/models/logs_response.rb +228 -0
- data/lib/gong_api/models/manual_association_response.rb +228 -0
- data/lib/gong_api/models/manual_associations_basic_data.rb +240 -0
- data/lib/gong_api/models/map_users_body.rb +206 -0
- data/lib/gong_api/models/media.rb +218 -0
- data/lib/gong_api/models/meeting.rb +207 -0
- data/lib/gong_api/models/meeting_invitee.rb +237 -0
- data/lib/gong_api/models/meetings_error_response.rb +247 -0
- data/lib/gong_api/models/monologue.rb +229 -0
- data/lib/gong_api/models/multiple_users_request_with_creation_dates.rb +238 -0
- data/lib/gong_api/models/multiple_users_with_dates.rb +238 -0
- data/lib/gong_api/models/new_call_adding_request.rb +450 -0
- data/lib/gong_api/models/new_call_adding_response.rb +217 -0
- data/lib/gong_api/models/new_call_recording_response.rb +227 -0
- data/lib/gong_api/models/new_meeting_request.rb +265 -0
- data/lib/gong_api/models/new_meeting_response.rb +239 -0
- data/lib/gong_api/models/object_entities_body.rb +206 -0
- data/lib/gong_api/models/occurrences.rb +217 -0
- data/lib/gong_api/models/party.rb +335 -0
- data/lib/gong_api/models/party_context.rb +254 -0
- data/lib/gong_api/models/party_context_field.rb +218 -0
- data/lib/gong_api/models/party_upload_context.rb +259 -0
- data/lib/gong_api/models/permission_profile_dto.rb +541 -0
- data/lib/gong_api/models/permission_profile_response.rb +216 -0
- data/lib/gong_api/models/permission_profile_users_response.rb +219 -0
- data/lib/gong_api/models/permission_profiles_response.rb +219 -0
- data/lib/gong_api/models/phone_number_references.rb +289 -0
- data/lib/gong_api/models/point_of_interest.rb +237 -0
- data/lib/gong_api/models/points_of_interest.rb +210 -0
- data/lib/gong_api/models/question.rb +267 -0
- data/lib/gong_api/models/questions.rb +218 -0
- data/lib/gong_api/models/records.rb +238 -0
- data/lib/gong_api/models/register_generic_crm_response.rb +217 -0
- data/lib/gong_api/models/request_answered_scorecards_filter.rb +216 -0
- data/lib/gong_api/models/request_calls_access_get_dto.rb +206 -0
- data/lib/gong_api/models/request_calls_filter.rb +216 -0
- data/lib/gong_api/models/request_calls_request_filter_with_owners_content_selector.rb +225 -0
- data/lib/gong_api/models/request_multiple_users_request_with_creation_dates.rb +216 -0
- data/lib/gong_api/models/request_multiple_users_with_dates.rb +216 -0
- data/lib/gong_api/models/request_status_response.rb +282 -0
- data/lib/gong_api/models/request_with_time_period_multiple_users_with_dates.rb +265 -0
- data/lib/gong_api/models/schema_update_response.rb +207 -0
- data/lib/gong_api/models/scorecard.rb +279 -0
- data/lib/gong_api/models/scorecards.rb +219 -0
- data/lib/gong_api/models/sentence.rb +227 -0
- data/lib/gong_api/models/settings.rb +258 -0
- data/lib/gong_api/models/settings_history.rb +219 -0
- data/lib/gong_api/models/sharer.rb +227 -0
- data/lib/gong_api/models/snippet.rb +218 -0
- data/lib/gong_api/models/speaker.rb +228 -0
- data/lib/gong_api/models/speakers_timeline.rb +219 -0
- data/lib/gong_api/models/specific_call.rb +216 -0
- data/lib/gong_api/models/speech_segment.rb +244 -0
- data/lib/gong_api/models/spoken_language.rb +218 -0
- data/lib/gong_api/models/structure.rb +218 -0
- data/lib/gong_api/models/topic.rb +217 -0
- data/lib/gong_api/models/tracker.rb +295 -0
- data/lib/gong_api/models/tracker_phrases.rb +229 -0
- data/lib/gong_api/models/update_meeting_request.rb +265 -0
- data/lib/gong_api/models/update_meeting_response.rb +217 -0
- data/lib/gong_api/models/user.rb +216 -0
- data/lib/gong_api/models/user_access_details.rb +208 -0
- data/lib/gong_api/models/user_activity.rb +226 -0
- data/lib/gong_api/models/user_aggregate_by_period_activities.rb +229 -0
- data/lib/gong_api/models/user_day_by_day_activity.rb +229 -0
- data/lib/gong_api/models/user_integration_status.rb +257 -0
- data/lib/gong_api/models/user_metadata.rb +347 -0
- data/lib/gong_api/models/user_settings_history.rb +261 -0
- data/lib/gong_api/models/user_simple_metadata.rb +227 -0
- data/lib/gong_api/models/users_aggregate_by_period_activity.rb +228 -0
- data/lib/gong_api/models/users_day_by_day_activity.rb +228 -0
- data/lib/gong_api/models/users_metadata.rb +228 -0
- data/lib/gong_api/models/video.rb +218 -0
- data/lib/gong_api/models/workspace_metadata.rb +227 -0
- data/lib/gong_api/models/workspaces_metadata.rb +219 -0
- data/lib/gong_api/version.rb +14 -0
- data/lib/gong_api.rb +209 -0
- data/spec/api/auditing_api_spec.rb +49 -0
- data/spec/api/calls_api_spec.rb +123 -0
- data/spec/api/crm_api_spec.rb +161 -0
- data/spec/api/data_privacy_api_spec.rb +82 -0
- data/spec/api/engagement_in_beta_phase_api_spec.rb +70 -0
- data/spec/api/library_api_spec.rb +58 -0
- data/spec/api/meetings_in_beta_phase_api_spec.rb +84 -0
- data/spec/api/permissions_api_spec.rb +132 -0
- data/spec/api/settings_api_spec.rb +56 -0
- data/spec/api/stats_api_spec.rb +94 -0
- data/spec/api/users_api_spec.rb +83 -0
- data/spec/api_client_spec.rb +225 -0
- data/spec/base_object_spec.rb +109 -0
- data/spec/configuration_spec.rb +41 -0
- data/spec/models/actor_spec.rb +58 -0
- data/spec/models/aggregate_activity_spec.rb +124 -0
- data/spec/models/aggregate_activity_with_dates_spec.rb +136 -0
- data/spec/models/answer_spec.rb +70 -0
- data/spec/models/answered_scorecard_spec.rb +98 -0
- data/spec/models/answered_scorecards_filter_spec.rb +70 -0
- data/spec/models/answered_scorecards_spec.rb +52 -0
- data/spec/models/association_object_spec.rb +46 -0
- data/spec/models/async_processing_response_spec.rb +46 -0
- data/spec/models/base_response_spec.rb +40 -0
- data/spec/models/call_access_details_spec.rb +46 -0
- data/spec/models/call_access_with_permission_level_spec.rb +50 -0
- data/spec/models/call_basic_data_spec.rb +160 -0
- data/spec/models/call_collaboration_spec.rb +40 -0
- data/spec/models/call_content_spec.rb +64 -0
- data/spec/models/call_context_spec.rb +50 -0
- data/spec/models/call_interaction_spec.rb +58 -0
- data/spec/models/call_participant_spec.rb +76 -0
- data/spec/models/call_reference_spec.rb +52 -0
- data/spec/models/call_spec.rb +76 -0
- data/spec/models/call_transcript_spec.rb +46 -0
- data/spec/models/call_transcripts_spec.rb +52 -0
- data/spec/models/call_upload_context_spec.rb +50 -0
- data/spec/models/call_users_access_dto_spec.rb +46 -0
- data/spec/models/calls_access_details_response_spec.rb +46 -0
- data/spec/models/calls_access_get_dto_spec.rb +40 -0
- data/spec/models/calls_filter_spec.rb +58 -0
- data/spec/models/calls_request_filter_with_owners_spec.rb +64 -0
- data/spec/models/calls_response_spec.rb +52 -0
- data/spec/models/calls_spec.rb +52 -0
- data/spec/models/calls_users_access_add_dto_spec.rb +40 -0
- data/spec/models/calls_users_access_delete_dto_spec.rb +40 -0
- data/spec/models/coaching_access_with_permission_level_spec.rb +50 -0
- data/spec/models/collaboration_spec.rb +40 -0
- data/spec/models/comment_spec.rb +82 -0
- data/spec/models/company_users_aggregate_activity_response_spec.rb +70 -0
- data/spec/models/company_users_intercation_stats_response_spec.rb +70 -0
- data/spec/models/content_selector_spec.rb +60 -0
- data/spec/models/content_shared_event_spec.rb +136 -0
- data/spec/models/content_spec.rb +58 -0
- data/spec/models/content_viewed_event_spec.rb +140 -0
- data/spec/models/context_field_spec.rb +46 -0
- data/spec/models/crm_party_context_field_spec.rb +46 -0
- data/spec/models/custom_action_event_spec.rb +134 -0
- data/spec/models/customer_data_object_spec.rb +68 -0
- data/spec/models/customer_data_spec.rb +50 -0
- data/spec/models/customer_engagement_spec.rb +80 -0
- data/spec/models/daily_activity_with_dates_spec.rb +136 -0
- data/spec/models/deals_access_with_permission_level_spec.rb +50 -0
- data/spec/models/delete_meeting_request_spec.rb +40 -0
- data/spec/models/email_address_references_spec.rb +70 -0
- data/spec/models/email_message_spec.rb +64 -0
- data/spec/models/emails_access_with_permission_level_spec.rb +50 -0
- data/spec/models/error_response_spec.rb +46 -0
- data/spec/models/event_accepted_response_spec.rb +40 -0
- data/spec/models/exposed_fields_spec.rb +64 -0
- data/spec/models/external_call_object_spec.rb +66 -0
- data/spec/models/external_crm_call_object_spec.rb +56 -0
- data/spec/models/external_crm_party_object_spec.rb +56 -0
- data/spec/models/external_party_object_spec.rb +66 -0
- data/spec/models/external_system_object_spec.rb +50 -0
- data/spec/models/external_system_spec.rb +50 -0
- data/spec/models/forecast_access_with_permission_level_spec.rb +50 -0
- data/spec/models/generic_crm_integration_spec.rb +52 -0
- data/spec/models/generic_crm_registration_request_spec.rb +46 -0
- data/spec/models/generic_deal_stage_request_spec.rb +58 -0
- data/spec/models/generic_property_spec.rb +56 -0
- data/spec/models/generic_schema_field_request_spec.rb +86 -0
- data/spec/models/get_generic_crm_objects_response_spec.rb +46 -0
- data/spec/models/id_media_body_spec.rb +40 -0
- data/spec/models/insights_access_with_permission_level_spec.rb +50 -0
- data/spec/models/integration_status_request_spec.rb +40 -0
- data/spec/models/integration_status_response_spec.rb +46 -0
- data/spec/models/interaction_spec.rb +58 -0
- data/spec/models/interaction_stat_spec.rb +46 -0
- data/spec/models/interaction_stats_spec.rb +52 -0
- data/spec/models/library_call_spec.rb +76 -0
- data/spec/models/library_folder_access_spec.rb +68 -0
- data/spec/models/library_folder_list_of_calls_response_spec.rb +70 -0
- data/spec/models/library_folder_spec.rb +64 -0
- data/spec/models/library_response_spec.rb +46 -0
- data/spec/models/line_error_response_spec.rb +46 -0
- data/spec/models/list_generic_crm_integrations_response_spec.rb +46 -0
- data/spec/models/list_selected_fields_response_spec.rb +46 -0
- data/spec/models/log_entry_spec.rb +88 -0
- data/spec/models/logs_response_spec.rb +52 -0
- data/spec/models/manual_association_response_spec.rb +52 -0
- data/spec/models/manual_associations_basic_data_spec.rb +58 -0
- data/spec/models/map_users_body_spec.rb +40 -0
- data/spec/models/media_spec.rb +46 -0
- data/spec/models/meeting_invitee_spec.rb +58 -0
- data/spec/models/meeting_spec.rb +40 -0
- data/spec/models/meetings_error_response_spec.rb +64 -0
- data/spec/models/monologue_spec.rb +52 -0
- data/spec/models/multiple_users_request_with_creation_dates_spec.rb +58 -0
- data/spec/models/multiple_users_with_dates_spec.rb +52 -0
- data/spec/models/new_call_adding_request_spec.rb +152 -0
- data/spec/models/new_call_adding_response_spec.rb +46 -0
- data/spec/models/new_call_recording_response_spec.rb +52 -0
- data/spec/models/new_meeting_request_spec.rb +70 -0
- data/spec/models/new_meeting_response_spec.rb +58 -0
- data/spec/models/object_entities_body_spec.rb +40 -0
- data/spec/models/occurrences_spec.rb +46 -0
- data/spec/models/party_context_field_spec.rb +46 -0
- data/spec/models/party_context_spec.rb +50 -0
- data/spec/models/party_spec.rb +102 -0
- data/spec/models/party_upload_context_spec.rb +50 -0
- data/spec/models/permission_profile_dto_spec.rb +244 -0
- data/spec/models/permission_profile_response_spec.rb +46 -0
- data/spec/models/permission_profile_users_response_spec.rb +46 -0
- data/spec/models/permission_profiles_response_spec.rb +46 -0
- data/spec/models/phone_number_references_spec.rb +82 -0
- data/spec/models/point_of_interest_spec.rb +58 -0
- data/spec/models/points_of_interest_spec.rb +40 -0
- data/spec/models/question_spec.rb +76 -0
- data/spec/models/questions_spec.rb +46 -0
- data/spec/models/records_spec.rb +58 -0
- data/spec/models/register_generic_crm_response_spec.rb +46 -0
- data/spec/models/request_answered_scorecards_filter_spec.rb +46 -0
- data/spec/models/request_calls_access_get_dto_spec.rb +40 -0
- data/spec/models/request_calls_filter_spec.rb +46 -0
- data/spec/models/request_calls_request_filter_with_owners_content_selector_spec.rb +52 -0
- data/spec/models/request_multiple_users_request_with_creation_dates_spec.rb +46 -0
- data/spec/models/request_multiple_users_with_dates_spec.rb +46 -0
- data/spec/models/request_status_response_spec.rb +68 -0
- data/spec/models/request_with_time_period_multiple_users_with_dates_spec.rb +56 -0
- data/spec/models/schema_update_response_spec.rb +40 -0
- data/spec/models/scorecard_spec.rb +82 -0
- data/spec/models/scorecards_spec.rb +46 -0
- data/spec/models/sentence_spec.rb +52 -0
- data/spec/models/settings_history_spec.rb +46 -0
- data/spec/models/settings_spec.rb +70 -0
- data/spec/models/sharer_spec.rb +52 -0
- data/spec/models/snippet_spec.rb +46 -0
- data/spec/models/speaker_spec.rb +52 -0
- data/spec/models/speakers_timeline_spec.rb +46 -0
- data/spec/models/specific_call_spec.rb +46 -0
- data/spec/models/speech_segment_spec.rb +52 -0
- data/spec/models/spoken_language_spec.rb +46 -0
- data/spec/models/structure_spec.rb +46 -0
- data/spec/models/topic_spec.rb +46 -0
- data/spec/models/tracker_phrases_spec.rb +52 -0
- data/spec/models/tracker_spec.rb +74 -0
- data/spec/models/update_meeting_request_spec.rb +70 -0
- data/spec/models/update_meeting_response_spec.rb +46 -0
- data/spec/models/user_access_details_spec.rb +40 -0
- data/spec/models/user_activity_spec.rb +52 -0
- data/spec/models/user_aggregate_by_period_activities_spec.rb +52 -0
- data/spec/models/user_day_by_day_activity_spec.rb +52 -0
- data/spec/models/user_integration_status_spec.rb +70 -0
- data/spec/models/user_metadata_spec.rb +124 -0
- data/spec/models/user_settings_history_spec.rb +56 -0
- data/spec/models/user_simple_metadata_spec.rb +52 -0
- data/spec/models/user_spec.rb +46 -0
- data/spec/models/users_aggregate_by_period_activity_spec.rb +52 -0
- data/spec/models/users_day_by_day_activity_spec.rb +52 -0
- data/spec/models/users_metadata_spec.rb +52 -0
- data/spec/models/video_spec.rb +46 -0
- data/spec/models/workspace_metadata_spec.rb +52 -0
- data/spec/models/workspaces_metadata_spec.rb +46 -0
- data/spec/spec_helper.rb +110 -0
- metadata +807 -0
data/gong_api.gemspec
ADDED
@@ -0,0 +1,38 @@
|
|
1
|
+
# -*- encoding: utf-8 -*-
|
2
|
+
|
3
|
+
=begin
|
4
|
+
#Gong API
|
5
|
+
|
6
|
+
#<h2>Overview</h2> <p> The Gong API allows you to: </p> <ol> <li> Receive the following information from Gong: <ol type=\"a\"> <li> Your company's <a href=\"#tag--Calls\">calls</a> in Gong </li> <li> Your company's <a href=\"#tag--Users\">users</a> in Gong </li> <li> Your company's user <a href=\"#tag--Stats\">stats</a> in Gong </li> <li> Your company's user <a href=\"#tag--Settings\">settings</a> in Gong </li> <li> Your company's <a href=\"#tag--Library\">libraries</a> in Gong </li> </ol></li> <li> <a href=\"#post-/v2/calls\">Upload</a> new or <a href=\"#put-/v2/calls/-id-/media\">update</a> call recordings in Gong, in order to support cases where you have an internal system that records calls or obtains them from a third-party entity. </li> <li> <a href=\"#post-/v2/data-privacy/erase-data-for-email-address\">Data Privacy</a>: Delete users and all their associated elements.</li> <li> Upload <a href=\"#tag--CRM\">CRM</a> data into Gong. </li> </ol> <p>Base URL for all API calls is <a href=\"https://us-55616.api.gong.io\"> https://us-55616.api.gong.io </a> </p> <h2>Authentication</h2> <p> There are two ways to retrieve credentials to the Gong Public API: </p> <ol><li>Retrieve Manually:<br> <p> In the <a href=\"https://app.gong.io/company/api\">Gong API Page</a> (you must be a technical administrator in Gong), click \"Create\" to receive an <b>Access Key</b> and an <b>Access Key Secret</b>.<br> </p> <p> Use the Basic Authorization HTTP header (as per <a target=\"_blank\" href=\"https://www.rfc-editor.org/rfc/rfc7617.txt\">RFC</a>) to access the Public API as shown below:<br> <code>Authorization: Basic <token></code><br> </p> <p> To create the basic token, combine the <b>Access Key</b> and the <b>Access Key Secret</b> with colon (:) and then encode in Base64 as following:<br> <code>Base64(<accessKey> : <accessKeySecret>)</code><br><br> </p></li> <li>Retrieve through OAuth<br> <p> To obtain the Bearer token, follow the steps described in the <a target=\"_blank\" href=\"https://help.gong.io/hc/en-us/articles/360056677792\">Gong OAuth Guide</a>. <br></p> <p> After obtaining the token, use the Bearer Authorization HTTP header (as per <a target=\"_blank\" href=\"https://www.rfc-editor.org/rfc/rfc6750.txt\">RFC</a>) to access the Public API as shown below:<br> <code>Authorization: Bearer <token></code> </p> </li></ol> <h2>Limits</h2> <p> By default Gong limits your company's access to the service to 3 API calls per second, and 10,000 API calls per day. </p> <p> When the rate of API calls exceeds these limits an HTTP status code <b>429</b> is returned and a <b>Retry-After</b> header indicates how many seconds to wait before making a new request. </p><p> If required, contact help@gong.io to change these limits. </p> <h2>Cursors</h2> <p> Some API calls that return a list are limited in the amount of records they may return, so multiple API calls may be required to bring all records. Such an API call also returns a <b>records</b> field, which contains the number of records in the current page, the current page number and the total number of records. </p> <p> In cases where the total number of records exceeds the number of records thus far retrieved, the <b>records</b> field will also contain a <b>cursor</b> field which can be used to access the next page of records. To retrieve the next page, repeat the API call with the <b>cursor</b> value as supplied by the previous API call. All other request inputs should remain the same. </p> <h2>Forward Compatibility</h2> <p> When coding a system to accept Gong data, take into account that Gong may, without prior warning, add fields to the JSON output. It is recommended to future proof your code so that it disregards all JSON fields you don't actually use. </p><p></p>
|
7
|
+
|
8
|
+
OpenAPI spec version: V2
|
9
|
+
|
10
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
11
|
+
Swagger Codegen version: 3.0.37
|
12
|
+
=end
|
13
|
+
|
14
|
+
$:.push File.expand_path("../lib", __FILE__)
|
15
|
+
require "gong_api/version"
|
16
|
+
|
17
|
+
Gem::Specification.new do |s|
|
18
|
+
s.name = "gong_api"
|
19
|
+
s.version = GongAPI::VERSION
|
20
|
+
s.platform = Gem::Platform::RUBY
|
21
|
+
s.authors = ["OpTonal Inc."]
|
22
|
+
s.email = ["matija@optonal.com"]
|
23
|
+
s.homepage = "https://gitlab.com/optonal/gong-api"
|
24
|
+
s.summary = "A Ruby Swagger API client for Gong"
|
25
|
+
s.description = "A Ruby Swagger API client for Gong"
|
26
|
+
s.license = 'MIT'
|
27
|
+
s.required_ruby_version = ">= 1.9"
|
28
|
+
|
29
|
+
s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
|
30
|
+
s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
|
31
|
+
|
32
|
+
s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
|
33
|
+
|
34
|
+
s.files = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
|
35
|
+
s.test_files = `find spec/*`.split("\n")
|
36
|
+
s.executables = []
|
37
|
+
s.require_paths = ["lib"]
|
38
|
+
end
|
@@ -0,0 +1,94 @@
|
|
1
|
+
=begin
|
2
|
+
#Gong API
|
3
|
+
|
4
|
+
#<h2>Overview</h2> <p> The Gong API allows you to: </p> <ol> <li> Receive the following information from Gong: <ol type=\"a\"> <li> Your company's <a href=\"#tag--Calls\">calls</a> in Gong </li> <li> Your company's <a href=\"#tag--Users\">users</a> in Gong </li> <li> Your company's user <a href=\"#tag--Stats\">stats</a> in Gong </li> <li> Your company's user <a href=\"#tag--Settings\">settings</a> in Gong </li> <li> Your company's <a href=\"#tag--Library\">libraries</a> in Gong </li> </ol></li> <li> <a href=\"#post-/v2/calls\">Upload</a> new or <a href=\"#put-/v2/calls/-id-/media\">update</a> call recordings in Gong, in order to support cases where you have an internal system that records calls or obtains them from a third-party entity. </li> <li> <a href=\"#post-/v2/data-privacy/erase-data-for-email-address\">Data Privacy</a>: Delete users and all their associated elements.</li> <li> Upload <a href=\"#tag--CRM\">CRM</a> data into Gong. </li> </ol> <p>Base URL for all API calls is <a href=\"https://us-55616.api.gong.io\"> https://us-55616.api.gong.io </a> </p> <h2>Authentication</h2> <p> There are two ways to retrieve credentials to the Gong Public API: </p> <ol><li>Retrieve Manually:<br> <p> In the <a href=\"https://app.gong.io/company/api\">Gong API Page</a> (you must be a technical administrator in Gong), click \"Create\" to receive an <b>Access Key</b> and an <b>Access Key Secret</b>.<br> </p> <p> Use the Basic Authorization HTTP header (as per <a target=\"_blank\" href=\"https://www.rfc-editor.org/rfc/rfc7617.txt\">RFC</a>) to access the Public API as shown below:<br> <code>Authorization: Basic <token></code><br> </p> <p> To create the basic token, combine the <b>Access Key</b> and the <b>Access Key Secret</b> with colon (:) and then encode in Base64 as following:<br> <code>Base64(<accessKey> : <accessKeySecret>)</code><br><br> </p></li> <li>Retrieve through OAuth<br> <p> To obtain the Bearer token, follow the steps described in the <a target=\"_blank\" href=\"https://help.gong.io/hc/en-us/articles/360056677792\">Gong OAuth Guide</a>. <br></p> <p> After obtaining the token, use the Bearer Authorization HTTP header (as per <a target=\"_blank\" href=\"https://www.rfc-editor.org/rfc/rfc6750.txt\">RFC</a>) to access the Public API as shown below:<br> <code>Authorization: Bearer <token></code> </p> </li></ol> <h2>Limits</h2> <p> By default Gong limits your company's access to the service to 3 API calls per second, and 10,000 API calls per day. </p> <p> When the rate of API calls exceeds these limits an HTTP status code <b>429</b> is returned and a <b>Retry-After</b> header indicates how many seconds to wait before making a new request. </p><p> If required, contact help@gong.io to change these limits. </p> <h2>Cursors</h2> <p> Some API calls that return a list are limited in the amount of records they may return, so multiple API calls may be required to bring all records. Such an API call also returns a <b>records</b> field, which contains the number of records in the current page, the current page number and the total number of records. </p> <p> In cases where the total number of records exceeds the number of records thus far retrieved, the <b>records</b> field will also contain a <b>cursor</b> field which can be used to access the next page of records. To retrieve the next page, repeat the API call with the <b>cursor</b> value as supplied by the previous API call. All other request inputs should remain the same. </p> <h2>Forward Compatibility</h2> <p> When coding a system to accept Gong data, take into account that Gong may, without prior warning, add fields to the JSON output. It is recommended to future proof your code so that it disregards all JSON fields you don't actually use. </p><p></p>
|
5
|
+
|
6
|
+
OpenAPI spec version: V2
|
7
|
+
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
Swagger Codegen version: 3.0.37
|
10
|
+
=end
|
11
|
+
|
12
|
+
module GongAPI
|
13
|
+
class AuditingApi
|
14
|
+
attr_accessor :api_client
|
15
|
+
|
16
|
+
def initialize(api_client = ApiClient.default)
|
17
|
+
@api_client = api_client
|
18
|
+
end
|
19
|
+
# Retrieve logs data by type and time range (/v2/logs)
|
20
|
+
# List log entries that took place during a specified time range. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:logs:read'.
|
21
|
+
# @param from_date_time The time from which to retrieve log records, 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).
|
22
|
+
# @param log_type Type of logs requested.
|
23
|
+
# @param [Hash] opts the optional parameters
|
24
|
+
# @option opts [String] :cursor When paging is needed, provide the value supplied by the previous API call to bring the following page of records.
|
25
|
+
# @option opts [String] :to_date_time The time until which to retrieve log records, 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); if not specified, the logs end with the latest recorded log.
|
26
|
+
# @return [LogsResponse]
|
27
|
+
def list_logs_using_get(from_date_time, log_type, opts = {})
|
28
|
+
data, _status_code, _headers = list_logs_using_get_with_http_info(from_date_time, log_type, opts)
|
29
|
+
data
|
30
|
+
end
|
31
|
+
|
32
|
+
# Retrieve logs data by type and time range (/v2/logs)
|
33
|
+
# List log entries that took place during a specified time range. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:logs:read'.
|
34
|
+
# @param from_date_time The time from which to retrieve log records, 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).
|
35
|
+
# @param log_type Type of logs requested.
|
36
|
+
# @param [Hash] opts the optional parameters
|
37
|
+
# @option opts [String] :cursor When paging is needed, provide the value supplied by the previous API call to bring the following page of records.
|
38
|
+
# @option opts [String] :to_date_time The time until which to retrieve log records, 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); if not specified, the logs end with the latest recorded log.
|
39
|
+
# @return [Array<(LogsResponse, Integer, Hash)>] LogsResponse data, response status code and response headers
|
40
|
+
def list_logs_using_get_with_http_info(from_date_time, log_type, opts = {})
|
41
|
+
if @api_client.config.debugging
|
42
|
+
@api_client.config.logger.debug 'Calling API: AuditingApi.list_logs_using_get ...'
|
43
|
+
end
|
44
|
+
# verify the required parameter 'from_date_time' is set
|
45
|
+
if @api_client.config.client_side_validation && from_date_time.nil?
|
46
|
+
fail ArgumentError, "Missing the required parameter 'from_date_time' when calling AuditingApi.list_logs_using_get"
|
47
|
+
end
|
48
|
+
# verify the required parameter 'log_type' is set
|
49
|
+
if @api_client.config.client_side_validation && log_type.nil?
|
50
|
+
fail ArgumentError, "Missing the required parameter 'log_type' when calling AuditingApi.list_logs_using_get"
|
51
|
+
end
|
52
|
+
# verify enum value
|
53
|
+
if @api_client.config.client_side_validation && !['AccessLog', 'ExternallySharedCallAccess', 'ExternallySharedCallPlay', 'UserActivityLog', 'UserCallPlay'].include?(log_type)
|
54
|
+
fail ArgumentError, "invalid value for 'log_type', must be one of AccessLog, ExternallySharedCallAccess, ExternallySharedCallPlay, UserActivityLog, UserCallPlay"
|
55
|
+
end
|
56
|
+
# resource path
|
57
|
+
local_var_path = '/v2/logs'
|
58
|
+
|
59
|
+
# query parameters
|
60
|
+
query_params = opts[:query_params] || {}
|
61
|
+
query_params[:'fromDateTime'] = from_date_time
|
62
|
+
query_params[:'logType'] = log_type
|
63
|
+
query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
|
64
|
+
query_params[:'toDateTime'] = opts[:'to_date_time'] if !opts[:'to_date_time'].nil?
|
65
|
+
|
66
|
+
# header parameters
|
67
|
+
header_params = opts[:header_params] || {}
|
68
|
+
# HTTP header 'Accept' (if needed)
|
69
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
70
|
+
|
71
|
+
# form parameters
|
72
|
+
form_params = opts[:form_params] || {}
|
73
|
+
|
74
|
+
# http body (model)
|
75
|
+
post_body = opts[:body]
|
76
|
+
|
77
|
+
return_type = opts[:return_type] || 'LogsResponse'
|
78
|
+
|
79
|
+
auth_names = opts[:auth_names] || []
|
80
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
81
|
+
:header_params => header_params,
|
82
|
+
:query_params => query_params,
|
83
|
+
:form_params => form_params,
|
84
|
+
:body => post_body,
|
85
|
+
:auth_names => auth_names,
|
86
|
+
:return_type => return_type)
|
87
|
+
|
88
|
+
if @api_client.config.debugging
|
89
|
+
@api_client.config.logger.debug "API called: AuditingApi#list_logs_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
90
|
+
end
|
91
|
+
return data, status_code, headers
|
92
|
+
end
|
93
|
+
end
|
94
|
+
end
|
@@ -0,0 +1,437 @@
|
|
1
|
+
=begin
|
2
|
+
#Gong API
|
3
|
+
|
4
|
+
#<h2>Overview</h2> <p> The Gong API allows you to: </p> <ol> <li> Receive the following information from Gong: <ol type=\"a\"> <li> Your company's <a href=\"#tag--Calls\">calls</a> in Gong </li> <li> Your company's <a href=\"#tag--Users\">users</a> in Gong </li> <li> Your company's user <a href=\"#tag--Stats\">stats</a> in Gong </li> <li> Your company's user <a href=\"#tag--Settings\">settings</a> in Gong </li> <li> Your company's <a href=\"#tag--Library\">libraries</a> in Gong </li> </ol></li> <li> <a href=\"#post-/v2/calls\">Upload</a> new or <a href=\"#put-/v2/calls/-id-/media\">update</a> call recordings in Gong, in order to support cases where you have an internal system that records calls or obtains them from a third-party entity. </li> <li> <a href=\"#post-/v2/data-privacy/erase-data-for-email-address\">Data Privacy</a>: Delete users and all their associated elements.</li> <li> Upload <a href=\"#tag--CRM\">CRM</a> data into Gong. </li> </ol> <p>Base URL for all API calls is <a href=\"https://us-55616.api.gong.io\"> https://us-55616.api.gong.io </a> </p> <h2>Authentication</h2> <p> There are two ways to retrieve credentials to the Gong Public API: </p> <ol><li>Retrieve Manually:<br> <p> In the <a href=\"https://app.gong.io/company/api\">Gong API Page</a> (you must be a technical administrator in Gong), click \"Create\" to receive an <b>Access Key</b> and an <b>Access Key Secret</b>.<br> </p> <p> Use the Basic Authorization HTTP header (as per <a target=\"_blank\" href=\"https://www.rfc-editor.org/rfc/rfc7617.txt\">RFC</a>) to access the Public API as shown below:<br> <code>Authorization: Basic <token></code><br> </p> <p> To create the basic token, combine the <b>Access Key</b> and the <b>Access Key Secret</b> with colon (:) and then encode in Base64 as following:<br> <code>Base64(<accessKey> : <accessKeySecret>)</code><br><br> </p></li> <li>Retrieve through OAuth<br> <p> To obtain the Bearer token, follow the steps described in the <a target=\"_blank\" href=\"https://help.gong.io/hc/en-us/articles/360056677792\">Gong OAuth Guide</a>. <br></p> <p> After obtaining the token, use the Bearer Authorization HTTP header (as per <a target=\"_blank\" href=\"https://www.rfc-editor.org/rfc/rfc6750.txt\">RFC</a>) to access the Public API as shown below:<br> <code>Authorization: Bearer <token></code> </p> </li></ol> <h2>Limits</h2> <p> By default Gong limits your company's access to the service to 3 API calls per second, and 10,000 API calls per day. </p> <p> When the rate of API calls exceeds these limits an HTTP status code <b>429</b> is returned and a <b>Retry-After</b> header indicates how many seconds to wait before making a new request. </p><p> If required, contact help@gong.io to change these limits. </p> <h2>Cursors</h2> <p> Some API calls that return a list are limited in the amount of records they may return, so multiple API calls may be required to bring all records. Such an API call also returns a <b>records</b> field, which contains the number of records in the current page, the current page number and the total number of records. </p> <p> In cases where the total number of records exceeds the number of records thus far retrieved, the <b>records</b> field will also contain a <b>cursor</b> field which can be used to access the next page of records. To retrieve the next page, repeat the API call with the <b>cursor</b> value as supplied by the previous API call. All other request inputs should remain the same. </p> <h2>Forward Compatibility</h2> <p> When coding a system to accept Gong data, take into account that Gong may, without prior warning, add fields to the JSON output. It is recommended to future proof your code so that it disregards all JSON fields you don't actually use. </p><p></p>
|
5
|
+
|
6
|
+
OpenAPI spec version: V2
|
7
|
+
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
Swagger Codegen version: 3.0.37
|
10
|
+
=end
|
11
|
+
|
12
|
+
module GongAPI
|
13
|
+
class CallsApi
|
14
|
+
attr_accessor :api_client
|
15
|
+
|
16
|
+
def initialize(api_client = ApiClient.default)
|
17
|
+
@api_client = api_client
|
18
|
+
end
|
19
|
+
# Add call media (/v2/calls/{id}/media)
|
20
|
+
# Adds a call media, recorded by a telephony system (PBX) or other media recording facility. Gong accepts call recordings in various audio and video file formats, including WAV, MP3, MP4, MKV and FLAC. If uploading a dual-channel (stereo) file separated by speaker, make sure to specify which channel correspondsto the company team member (rep) in the parties/mediaChannelId parameter of the Add New Call operation. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:calls:create'.
|
21
|
+
# @param id callId returned from 'Add New Call' request
|
22
|
+
# @param [Hash] opts the optional parameters
|
23
|
+
# @option opts [String] :media_file
|
24
|
+
# @return [NewCallRecordingResponse]
|
25
|
+
def add_call_recording_using_put(id, opts = {})
|
26
|
+
data, _status_code, _headers = add_call_recording_using_put_with_http_info(id, opts)
|
27
|
+
data
|
28
|
+
end
|
29
|
+
|
30
|
+
# Add call media (/v2/calls/{id}/media)
|
31
|
+
# Adds a call media, recorded by a telephony system (PBX) or other media recording facility. Gong accepts call recordings in various audio and video file formats, including WAV, MP3, MP4, MKV and FLAC. If uploading a dual-channel (stereo) file separated by speaker, make sure to specify which channel correspondsto the company team member (rep) in the parties/mediaChannelId parameter of the Add New Call operation. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:calls:create'.
|
32
|
+
# @param id callId returned from 'Add New Call' request
|
33
|
+
# @param [Hash] opts the optional parameters
|
34
|
+
# @option opts [String] :media_file
|
35
|
+
# @return [Array<(NewCallRecordingResponse, Integer, Hash)>] NewCallRecordingResponse data, response status code and response headers
|
36
|
+
def add_call_recording_using_put_with_http_info(id, opts = {})
|
37
|
+
if @api_client.config.debugging
|
38
|
+
@api_client.config.logger.debug 'Calling API: CallsApi.add_call_recording_using_put ...'
|
39
|
+
end
|
40
|
+
# verify the required parameter 'id' is set
|
41
|
+
if @api_client.config.client_side_validation && id.nil?
|
42
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CallsApi.add_call_recording_using_put"
|
43
|
+
end
|
44
|
+
# resource path
|
45
|
+
local_var_path = '/v2/calls/{id}/media'.sub('{' + 'id' + '}', id.to_s)
|
46
|
+
|
47
|
+
# query parameters
|
48
|
+
query_params = opts[:query_params] || {}
|
49
|
+
|
50
|
+
# header parameters
|
51
|
+
header_params = opts[:header_params] || {}
|
52
|
+
# HTTP header 'Accept' (if needed)
|
53
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
54
|
+
# HTTP header 'Content-Type'
|
55
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
|
56
|
+
|
57
|
+
# form parameters
|
58
|
+
form_params = opts[:form_params] || {}
|
59
|
+
form_params['mediaFile'] = opts[:'media_file'] if !opts[:'media_file'].nil?
|
60
|
+
|
61
|
+
# http body (model)
|
62
|
+
post_body = opts[:body]
|
63
|
+
|
64
|
+
return_type = opts[:return_type] || 'NewCallRecordingResponse'
|
65
|
+
|
66
|
+
auth_names = opts[:auth_names] || []
|
67
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
68
|
+
:header_params => header_params,
|
69
|
+
:query_params => query_params,
|
70
|
+
:form_params => form_params,
|
71
|
+
:body => post_body,
|
72
|
+
:auth_names => auth_names,
|
73
|
+
:return_type => return_type)
|
74
|
+
|
75
|
+
if @api_client.config.debugging
|
76
|
+
@api_client.config.logger.debug "API called: CallsApi#add_call_recording_using_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
77
|
+
end
|
78
|
+
return data, status_code, headers
|
79
|
+
end
|
80
|
+
# Add new call (/v2/calls)
|
81
|
+
# When using this endpoint, either provide a downloadMediaUrl or use the returned callId in a follow-up request to /v2/calls/{id}/media to upload the media file. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:calls:create'.
|
82
|
+
# @param body newCallAddingRequest
|
83
|
+
# @param [Hash] opts the optional parameters
|
84
|
+
# @return [NewCallAddingResponse]
|
85
|
+
def add_call_using_post(body, opts = {})
|
86
|
+
data, _status_code, _headers = add_call_using_post_with_http_info(body, opts)
|
87
|
+
data
|
88
|
+
end
|
89
|
+
|
90
|
+
# Add new call (/v2/calls)
|
91
|
+
# When using this endpoint, either provide a downloadMediaUrl or use the returned callId in a follow-up request to /v2/calls/{id}/media to upload the media file. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:calls:create'.
|
92
|
+
# @param body newCallAddingRequest
|
93
|
+
# @param [Hash] opts the optional parameters
|
94
|
+
# @return [Array<(NewCallAddingResponse, Integer, Hash)>] NewCallAddingResponse data, response status code and response headers
|
95
|
+
def add_call_using_post_with_http_info(body, opts = {})
|
96
|
+
if @api_client.config.debugging
|
97
|
+
@api_client.config.logger.debug 'Calling API: CallsApi.add_call_using_post ...'
|
98
|
+
end
|
99
|
+
# verify the required parameter 'body' is set
|
100
|
+
if @api_client.config.client_side_validation && body.nil?
|
101
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling CallsApi.add_call_using_post"
|
102
|
+
end
|
103
|
+
# resource path
|
104
|
+
local_var_path = '/v2/calls'
|
105
|
+
|
106
|
+
# query parameters
|
107
|
+
query_params = opts[:query_params] || {}
|
108
|
+
|
109
|
+
# header parameters
|
110
|
+
header_params = opts[:header_params] || {}
|
111
|
+
# HTTP header 'Accept' (if needed)
|
112
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
113
|
+
# HTTP header 'Content-Type'
|
114
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
115
|
+
|
116
|
+
# form parameters
|
117
|
+
form_params = opts[:form_params] || {}
|
118
|
+
|
119
|
+
# http body (model)
|
120
|
+
post_body = opts[:body] || @api_client.object_to_http_body(body)
|
121
|
+
|
122
|
+
return_type = opts[:return_type] || 'NewCallAddingResponse'
|
123
|
+
|
124
|
+
auth_names = opts[:auth_names] || []
|
125
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
126
|
+
:header_params => header_params,
|
127
|
+
:query_params => query_params,
|
128
|
+
:form_params => form_params,
|
129
|
+
:body => post_body,
|
130
|
+
:auth_names => auth_names,
|
131
|
+
:return_type => return_type)
|
132
|
+
|
133
|
+
if @api_client.config.debugging
|
134
|
+
@api_client.config.logger.debug "API called: CallsApi#add_call_using_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
135
|
+
end
|
136
|
+
return data, status_code, headers
|
137
|
+
end
|
138
|
+
# Retrieve transcripts of calls by date or callIds (/v2/calls/transcript)
|
139
|
+
# Lists the transcripts of calls that took place during a specified date range and have specified callIds. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:calls:read:transcript'.
|
140
|
+
# @param body callsRequest
|
141
|
+
# @param [Hash] opts the optional parameters
|
142
|
+
# @return [CallTranscripts]
|
143
|
+
def get_call_transcripts_using_post(body, opts = {})
|
144
|
+
data, _status_code, _headers = get_call_transcripts_using_post_with_http_info(body, opts)
|
145
|
+
data
|
146
|
+
end
|
147
|
+
|
148
|
+
# Retrieve transcripts of calls by date or callIds (/v2/calls/transcript)
|
149
|
+
# Lists the transcripts of calls that took place during a specified date range and have specified callIds. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:calls:read:transcript'.
|
150
|
+
# @param body callsRequest
|
151
|
+
# @param [Hash] opts the optional parameters
|
152
|
+
# @return [Array<(CallTranscripts, Integer, Hash)>] CallTranscripts data, response status code and response headers
|
153
|
+
def get_call_transcripts_using_post_with_http_info(body, opts = {})
|
154
|
+
if @api_client.config.debugging
|
155
|
+
@api_client.config.logger.debug 'Calling API: CallsApi.get_call_transcripts_using_post ...'
|
156
|
+
end
|
157
|
+
# verify the required parameter 'body' is set
|
158
|
+
if @api_client.config.client_side_validation && body.nil?
|
159
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling CallsApi.get_call_transcripts_using_post"
|
160
|
+
end
|
161
|
+
# resource path
|
162
|
+
local_var_path = '/v2/calls/transcript'
|
163
|
+
|
164
|
+
# query parameters
|
165
|
+
query_params = opts[:query_params] || {}
|
166
|
+
|
167
|
+
# header parameters
|
168
|
+
header_params = opts[:header_params] || {}
|
169
|
+
# HTTP header 'Accept' (if needed)
|
170
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
171
|
+
# HTTP header 'Content-Type'
|
172
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
173
|
+
|
174
|
+
# form parameters
|
175
|
+
form_params = opts[:form_params] || {}
|
176
|
+
|
177
|
+
# http body (model)
|
178
|
+
post_body = opts[:body] || @api_client.object_to_http_body(body)
|
179
|
+
|
180
|
+
return_type = opts[:return_type] || 'CallTranscripts'
|
181
|
+
|
182
|
+
auth_names = opts[:auth_names] || []
|
183
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
184
|
+
:header_params => header_params,
|
185
|
+
:query_params => query_params,
|
186
|
+
:form_params => form_params,
|
187
|
+
:body => post_body,
|
188
|
+
:auth_names => auth_names,
|
189
|
+
:return_type => return_type)
|
190
|
+
|
191
|
+
if @api_client.config.debugging
|
192
|
+
@api_client.config.logger.debug "API called: CallsApi#get_call_transcripts_using_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
193
|
+
end
|
194
|
+
return data, status_code, headers
|
195
|
+
end
|
196
|
+
# Retrieve data for a specific call (/v2/calls/{id})
|
197
|
+
# Retrieve data for a specific call. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:calls:read:basic'.
|
198
|
+
# @param id Gong's unique numeric identifier for the call (up to 20 digits).
|
199
|
+
# @param [Hash] opts the optional parameters
|
200
|
+
# @return [SpecificCall]
|
201
|
+
def get_call_using_get(id, opts = {})
|
202
|
+
data, _status_code, _headers = get_call_using_get_with_http_info(id, opts)
|
203
|
+
data
|
204
|
+
end
|
205
|
+
|
206
|
+
# Retrieve data for a specific call (/v2/calls/{id})
|
207
|
+
# Retrieve data for a specific call. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:calls:read:basic'.
|
208
|
+
# @param id Gong's unique numeric identifier for the call (up to 20 digits).
|
209
|
+
# @param [Hash] opts the optional parameters
|
210
|
+
# @return [Array<(SpecificCall, Integer, Hash)>] SpecificCall data, response status code and response headers
|
211
|
+
def get_call_using_get_with_http_info(id, opts = {})
|
212
|
+
if @api_client.config.debugging
|
213
|
+
@api_client.config.logger.debug 'Calling API: CallsApi.get_call_using_get ...'
|
214
|
+
end
|
215
|
+
# verify the required parameter 'id' is set
|
216
|
+
if @api_client.config.client_side_validation && id.nil?
|
217
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CallsApi.get_call_using_get"
|
218
|
+
end
|
219
|
+
# resource path
|
220
|
+
local_var_path = '/v2/calls/{id}'.sub('{' + 'id' + '}', id.to_s)
|
221
|
+
|
222
|
+
# query parameters
|
223
|
+
query_params = opts[:query_params] || {}
|
224
|
+
|
225
|
+
# header parameters
|
226
|
+
header_params = opts[:header_params] || {}
|
227
|
+
# HTTP header 'Accept' (if needed)
|
228
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
229
|
+
|
230
|
+
# form parameters
|
231
|
+
form_params = opts[:form_params] || {}
|
232
|
+
|
233
|
+
# http body (model)
|
234
|
+
post_body = opts[:body]
|
235
|
+
|
236
|
+
return_type = opts[:return_type] || 'SpecificCall'
|
237
|
+
|
238
|
+
auth_names = opts[:auth_names] || []
|
239
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
240
|
+
:header_params => header_params,
|
241
|
+
:query_params => query_params,
|
242
|
+
:form_params => form_params,
|
243
|
+
:body => post_body,
|
244
|
+
:auth_names => auth_names,
|
245
|
+
:return_type => return_type)
|
246
|
+
|
247
|
+
if @api_client.config.debugging
|
248
|
+
@api_client.config.logger.debug "API called: CallsApi#get_call_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
249
|
+
end
|
250
|
+
return data, status_code, headers
|
251
|
+
end
|
252
|
+
# Retrieve detailed call data by various filters (/v2/calls/extensive)
|
253
|
+
# Lists detailed call data for calls that took place during a specified date range, have specified call IDs or hosted by specified users. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:calls:read:extensive'. Moreover, clients requesting media download URLs by the contentSelector.exposedFields.media field should also have the scope 'api:calls:read:media-url'.
|
254
|
+
# @param body callsRequest
|
255
|
+
# @param [Hash] opts the optional parameters
|
256
|
+
# @return [Calls]
|
257
|
+
def list_calls_extensive_using_post(body, opts = {})
|
258
|
+
data, _status_code, _headers = list_calls_extensive_using_post_with_http_info(body, opts)
|
259
|
+
data
|
260
|
+
end
|
261
|
+
|
262
|
+
# Retrieve detailed call data by various filters (/v2/calls/extensive)
|
263
|
+
# Lists detailed call data for calls that took place during a specified date range, have specified call IDs or hosted by specified users. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:calls:read:extensive'. Moreover, clients requesting media download URLs by the contentSelector.exposedFields.media field should also have the scope 'api:calls:read:media-url'.
|
264
|
+
# @param body callsRequest
|
265
|
+
# @param [Hash] opts the optional parameters
|
266
|
+
# @return [Array<(Calls, Integer, Hash)>] Calls data, response status code and response headers
|
267
|
+
def list_calls_extensive_using_post_with_http_info(body, opts = {})
|
268
|
+
if @api_client.config.debugging
|
269
|
+
@api_client.config.logger.debug 'Calling API: CallsApi.list_calls_extensive_using_post ...'
|
270
|
+
end
|
271
|
+
# verify the required parameter 'body' is set
|
272
|
+
if @api_client.config.client_side_validation && body.nil?
|
273
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling CallsApi.list_calls_extensive_using_post"
|
274
|
+
end
|
275
|
+
# resource path
|
276
|
+
local_var_path = '/v2/calls/extensive'
|
277
|
+
|
278
|
+
# query parameters
|
279
|
+
query_params = opts[:query_params] || {}
|
280
|
+
|
281
|
+
# header parameters
|
282
|
+
header_params = opts[:header_params] || {}
|
283
|
+
# HTTP header 'Accept' (if needed)
|
284
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
285
|
+
# HTTP header 'Content-Type'
|
286
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
287
|
+
|
288
|
+
# form parameters
|
289
|
+
form_params = opts[:form_params] || {}
|
290
|
+
|
291
|
+
# http body (model)
|
292
|
+
post_body = opts[:body] || @api_client.object_to_http_body(body)
|
293
|
+
|
294
|
+
return_type = opts[:return_type] || 'Calls'
|
295
|
+
|
296
|
+
auth_names = opts[:auth_names] || []
|
297
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
298
|
+
:header_params => header_params,
|
299
|
+
:query_params => query_params,
|
300
|
+
:form_params => form_params,
|
301
|
+
:body => post_body,
|
302
|
+
:auth_names => auth_names,
|
303
|
+
:return_type => return_type)
|
304
|
+
|
305
|
+
if @api_client.config.debugging
|
306
|
+
@api_client.config.logger.debug "API called: CallsApi#list_calls_extensive_using_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
307
|
+
end
|
308
|
+
return data, status_code, headers
|
309
|
+
end
|
310
|
+
# Retrieve call data by date range (/v2/calls)
|
311
|
+
# List calls that took place during a specified date range. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:calls:read:basic'.
|
312
|
+
# @param from_date_time The date from which to list calls, 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); if not specified, the calls start with the earliest recorded call. For web-conference calls recorded by Gong, the date denotes its scheduled time, otherwise, it denotes its actual start time.
|
313
|
+
# @param to_date_time The date until which to list calls, 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); if not specified, the calls end with the latest recorded call. For web-conference calls recorded by Gong, the date denotes its scheduled time, otherwise, it denotes its actual start time.
|
314
|
+
# @param [Hash] opts the optional parameters
|
315
|
+
# @option opts [String] :cursor When paging is needed, provide the value supplied by the previous API call to bring the following page of records.
|
316
|
+
# @option opts [String] :workspace_id Optional Workspace identifier, if supplied the API will return only the calls belonging to this workspace.
|
317
|
+
# @return [CallsResponse]
|
318
|
+
def list_calls_using_get1(from_date_time, to_date_time, opts = {})
|
319
|
+
data, _status_code, _headers = list_calls_using_get1_with_http_info(from_date_time, to_date_time, opts)
|
320
|
+
data
|
321
|
+
end
|
322
|
+
|
323
|
+
# Retrieve call data by date range (/v2/calls)
|
324
|
+
# List calls that took place during a specified date range. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:calls:read:basic'.
|
325
|
+
# @param from_date_time The date from which to list calls, 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); if not specified, the calls start with the earliest recorded call. For web-conference calls recorded by Gong, the date denotes its scheduled time, otherwise, it denotes its actual start time.
|
326
|
+
# @param to_date_time The date until which to list calls, 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); if not specified, the calls end with the latest recorded call. For web-conference calls recorded by Gong, the date denotes its scheduled time, otherwise, it denotes its actual start time.
|
327
|
+
# @param [Hash] opts the optional parameters
|
328
|
+
# @option opts [String] :cursor When paging is needed, provide the value supplied by the previous API call to bring the following page of records.
|
329
|
+
# @option opts [String] :workspace_id Optional Workspace identifier, if supplied the API will return only the calls belonging to this workspace.
|
330
|
+
# @return [Array<(CallsResponse, Integer, Hash)>] CallsResponse data, response status code and response headers
|
331
|
+
def list_calls_using_get1_with_http_info(from_date_time, to_date_time, opts = {})
|
332
|
+
if @api_client.config.debugging
|
333
|
+
@api_client.config.logger.debug 'Calling API: CallsApi.list_calls_using_get1 ...'
|
334
|
+
end
|
335
|
+
# verify the required parameter 'from_date_time' is set
|
336
|
+
if @api_client.config.client_side_validation && from_date_time.nil?
|
337
|
+
fail ArgumentError, "Missing the required parameter 'from_date_time' when calling CallsApi.list_calls_using_get1"
|
338
|
+
end
|
339
|
+
# verify the required parameter 'to_date_time' is set
|
340
|
+
if @api_client.config.client_side_validation && to_date_time.nil?
|
341
|
+
fail ArgumentError, "Missing the required parameter 'to_date_time' when calling CallsApi.list_calls_using_get1"
|
342
|
+
end
|
343
|
+
# resource path
|
344
|
+
local_var_path = '/v2/calls'
|
345
|
+
|
346
|
+
# query parameters
|
347
|
+
query_params = opts[:query_params] || {}
|
348
|
+
query_params[:'fromDateTime'] = from_date_time
|
349
|
+
query_params[:'toDateTime'] = to_date_time
|
350
|
+
query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
|
351
|
+
query_params[:'workspaceId'] = opts[:'workspace_id'] if !opts[:'workspace_id'].nil?
|
352
|
+
|
353
|
+
# header parameters
|
354
|
+
header_params = opts[:header_params] || {}
|
355
|
+
# HTTP header 'Accept' (if needed)
|
356
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
357
|
+
|
358
|
+
# form parameters
|
359
|
+
form_params = opts[:form_params] || {}
|
360
|
+
|
361
|
+
# http body (model)
|
362
|
+
post_body = opts[:body]
|
363
|
+
|
364
|
+
return_type = opts[:return_type] || 'CallsResponse'
|
365
|
+
|
366
|
+
auth_names = opts[:auth_names] || []
|
367
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
368
|
+
:header_params => header_params,
|
369
|
+
:query_params => query_params,
|
370
|
+
:form_params => form_params,
|
371
|
+
:body => post_body,
|
372
|
+
:auth_names => auth_names,
|
373
|
+
:return_type => return_type)
|
374
|
+
|
375
|
+
if @api_client.config.debugging
|
376
|
+
@api_client.config.logger.debug "API called: CallsApi#list_calls_using_get1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
377
|
+
end
|
378
|
+
return data, status_code, headers
|
379
|
+
end
|
380
|
+
# List all calls that were manually associated with CRM objects (/v2/calls/manual-crm-associations) in Beta Phase
|
381
|
+
# Returns a list of all calls that were manually associated or re-associated with CRM account and deal/opportunity since a given time. Actions will be listed in the ascending order of their timing. Notice if a call was associated and later re-associated the API will return both events. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:crm-calls:manual-association:read'.
|
382
|
+
# @param [Hash] opts the optional parameters
|
383
|
+
# @option opts [String] :cursor When paging is needed, provide the value supplied by the previous API call to bring the following page of records.
|
384
|
+
# @option opts [String] :from_date_time Association time filter - only the associations made after that time will be listed. The time 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); if not specified all association events will be listed.
|
385
|
+
# @return [ManualAssociationResponse]
|
386
|
+
def list_crm_calls_manual_association_using_get(opts = {})
|
387
|
+
data, _status_code, _headers = list_crm_calls_manual_association_using_get_with_http_info(opts)
|
388
|
+
data
|
389
|
+
end
|
390
|
+
|
391
|
+
# List all calls that were manually associated with CRM objects (/v2/calls/manual-crm-associations) in Beta Phase
|
392
|
+
# Returns a list of all calls that were manually associated or re-associated with CRM account and deal/opportunity since a given time. Actions will be listed in the ascending order of their timing. Notice if a call was associated and later re-associated the API will return both events. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:crm-calls:manual-association:read'.
|
393
|
+
# @param [Hash] opts the optional parameters
|
394
|
+
# @option opts [String] :cursor When paging is needed, provide the value supplied by the previous API call to bring the following page of records.
|
395
|
+
# @option opts [String] :from_date_time Association time filter - only the associations made after that time will be listed. The time 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); if not specified all association events will be listed.
|
396
|
+
# @return [Array<(ManualAssociationResponse, Integer, Hash)>] ManualAssociationResponse data, response status code and response headers
|
397
|
+
def list_crm_calls_manual_association_using_get_with_http_info(opts = {})
|
398
|
+
if @api_client.config.debugging
|
399
|
+
@api_client.config.logger.debug 'Calling API: CallsApi.list_crm_calls_manual_association_using_get ...'
|
400
|
+
end
|
401
|
+
# resource path
|
402
|
+
local_var_path = '/v2/calls/manual-crm-associations'
|
403
|
+
|
404
|
+
# query parameters
|
405
|
+
query_params = opts[:query_params] || {}
|
406
|
+
query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
|
407
|
+
query_params[:'fromDateTime'] = opts[:'from_date_time'] if !opts[:'from_date_time'].nil?
|
408
|
+
|
409
|
+
# header parameters
|
410
|
+
header_params = opts[:header_params] || {}
|
411
|
+
# HTTP header 'Accept' (if needed)
|
412
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
413
|
+
|
414
|
+
# form parameters
|
415
|
+
form_params = opts[:form_params] || {}
|
416
|
+
|
417
|
+
# http body (model)
|
418
|
+
post_body = opts[:body]
|
419
|
+
|
420
|
+
return_type = opts[:return_type] || 'ManualAssociationResponse'
|
421
|
+
|
422
|
+
auth_names = opts[:auth_names] || []
|
423
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
424
|
+
:header_params => header_params,
|
425
|
+
:query_params => query_params,
|
426
|
+
:form_params => form_params,
|
427
|
+
:body => post_body,
|
428
|
+
:auth_names => auth_names,
|
429
|
+
:return_type => return_type)
|
430
|
+
|
431
|
+
if @api_client.config.debugging
|
432
|
+
@api_client.config.logger.debug "API called: CallsApi#list_crm_calls_manual_association_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
433
|
+
end
|
434
|
+
return data, status_code, headers
|
435
|
+
end
|
436
|
+
end
|
437
|
+
end
|