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,450 @@
|
|
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
|
+
require 'date'
|
13
|
+
|
14
|
+
module GongAPI
|
15
|
+
# New call metadata
|
16
|
+
class NewCallAddingRequest
|
17
|
+
# 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);
|
18
|
+
attr_accessor :actual_start
|
19
|
+
|
20
|
+
# 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.
|
21
|
+
attr_accessor :call_provider_code
|
22
|
+
|
23
|
+
# 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.
|
24
|
+
attr_accessor :client_unique_id
|
25
|
+
|
26
|
+
# A list of references to external systems such as CRM, Telephony System, Case Management, etc.
|
27
|
+
attr_accessor :context
|
28
|
+
|
29
|
+
# Optional metadata associated with the call (represented as text). Gong stores this metadata and it can be used for troubleshooting.
|
30
|
+
attr_accessor :custom_data
|
31
|
+
|
32
|
+
# Whether the call is inbound (someone called the company), outbound (a rep dialed someone outside the company), or a conference call.
|
33
|
+
attr_accessor :direction
|
34
|
+
|
35
|
+
# The disposition of the call. The disposition is free text of up to 255 characters.
|
36
|
+
attr_accessor :disposition
|
37
|
+
|
38
|
+
# 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.
|
39
|
+
attr_accessor :download_media_url
|
40
|
+
|
41
|
+
# The actual call duration in seconds.
|
42
|
+
attr_accessor :duration
|
43
|
+
|
44
|
+
# 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
|
45
|
+
attr_accessor :language_code
|
46
|
+
|
47
|
+
# The URL of the conference call by which users join the meeting
|
48
|
+
attr_accessor :meeting_url
|
49
|
+
|
50
|
+
# A list of the call's participants. A party must be provided for the primaryUser.
|
51
|
+
attr_accessor :parties
|
52
|
+
|
53
|
+
# The Gong internal user ID of the team member who hosted the call.
|
54
|
+
attr_accessor :primary_user
|
55
|
+
|
56
|
+
# The purpose of the call. This optional field is a free text of up to 255 characters.
|
57
|
+
attr_accessor :purpose
|
58
|
+
|
59
|
+
# 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);
|
60
|
+
attr_accessor :scheduled_end
|
61
|
+
|
62
|
+
# 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);
|
63
|
+
attr_accessor :scheduled_start
|
64
|
+
|
65
|
+
attr_accessor :speakers_timeline
|
66
|
+
|
67
|
+
# The title of the call. This title is available in the Gong system for indexing and search.
|
68
|
+
attr_accessor :title
|
69
|
+
|
70
|
+
# Optional workspace identifier. If specified, the call will be placed into this workspace, otherwise, the default algorithm for workspace placement will be applied.
|
71
|
+
attr_accessor :workspace_id
|
72
|
+
|
73
|
+
class EnumAttributeValidator
|
74
|
+
attr_reader :datatype
|
75
|
+
attr_reader :allowable_values
|
76
|
+
|
77
|
+
def initialize(datatype, allowable_values)
|
78
|
+
@allowable_values = allowable_values.map do |value|
|
79
|
+
case datatype.to_s
|
80
|
+
when /Integer/i
|
81
|
+
value.to_i
|
82
|
+
when /Float/i
|
83
|
+
value.to_f
|
84
|
+
else
|
85
|
+
value
|
86
|
+
end
|
87
|
+
end
|
88
|
+
end
|
89
|
+
|
90
|
+
def valid?(value)
|
91
|
+
!value || allowable_values.include?(value)
|
92
|
+
end
|
93
|
+
end
|
94
|
+
|
95
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
96
|
+
def self.attribute_map
|
97
|
+
{
|
98
|
+
:'actual_start' => :'actualStart',
|
99
|
+
:'call_provider_code' => :'callProviderCode',
|
100
|
+
:'client_unique_id' => :'clientUniqueId',
|
101
|
+
:'context' => :'context',
|
102
|
+
:'custom_data' => :'customData',
|
103
|
+
:'direction' => :'direction',
|
104
|
+
:'disposition' => :'disposition',
|
105
|
+
:'download_media_url' => :'downloadMediaUrl',
|
106
|
+
:'duration' => :'duration',
|
107
|
+
:'language_code' => :'languageCode',
|
108
|
+
:'meeting_url' => :'meetingUrl',
|
109
|
+
:'parties' => :'parties',
|
110
|
+
:'primary_user' => :'primaryUser',
|
111
|
+
:'purpose' => :'purpose',
|
112
|
+
:'scheduled_end' => :'scheduledEnd',
|
113
|
+
:'scheduled_start' => :'scheduledStart',
|
114
|
+
:'speakers_timeline' => :'speakersTimeline',
|
115
|
+
:'title' => :'title',
|
116
|
+
:'workspace_id' => :'workspaceId'
|
117
|
+
}
|
118
|
+
end
|
119
|
+
|
120
|
+
# Attribute type mapping.
|
121
|
+
def self.openapi_types
|
122
|
+
{
|
123
|
+
:'actual_start' => :'Object',
|
124
|
+
:'call_provider_code' => :'Object',
|
125
|
+
:'client_unique_id' => :'Object',
|
126
|
+
:'context' => :'Object',
|
127
|
+
:'custom_data' => :'Object',
|
128
|
+
:'direction' => :'Object',
|
129
|
+
:'disposition' => :'Object',
|
130
|
+
:'download_media_url' => :'Object',
|
131
|
+
:'duration' => :'Object',
|
132
|
+
:'language_code' => :'Object',
|
133
|
+
:'meeting_url' => :'Object',
|
134
|
+
:'parties' => :'Object',
|
135
|
+
:'primary_user' => :'Object',
|
136
|
+
:'purpose' => :'Object',
|
137
|
+
:'scheduled_end' => :'Object',
|
138
|
+
:'scheduled_start' => :'Object',
|
139
|
+
:'speakers_timeline' => :'Object',
|
140
|
+
:'title' => :'Object',
|
141
|
+
:'workspace_id' => :'Object'
|
142
|
+
}
|
143
|
+
end
|
144
|
+
|
145
|
+
# List of attributes with nullable: true
|
146
|
+
def self.openapi_nullable
|
147
|
+
Set.new([
|
148
|
+
])
|
149
|
+
end
|
150
|
+
|
151
|
+
# Initializes the object
|
152
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
153
|
+
def initialize(attributes = {})
|
154
|
+
if (!attributes.is_a?(Hash))
|
155
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `GongAPI::NewCallAddingRequest` initialize method"
|
156
|
+
end
|
157
|
+
|
158
|
+
# check to see if the attribute exists and convert string to symbol for hash key
|
159
|
+
attributes = attributes.each_with_object({}) { |(k, v), h|
|
160
|
+
if (!self.class.attribute_map.key?(k.to_sym))
|
161
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `GongAPI::NewCallAddingRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
162
|
+
end
|
163
|
+
h[k.to_sym] = v
|
164
|
+
}
|
165
|
+
|
166
|
+
if attributes.key?(:'actual_start')
|
167
|
+
self.actual_start = attributes[:'actual_start']
|
168
|
+
end
|
169
|
+
|
170
|
+
if attributes.key?(:'call_provider_code')
|
171
|
+
self.call_provider_code = attributes[:'call_provider_code']
|
172
|
+
end
|
173
|
+
|
174
|
+
if attributes.key?(:'client_unique_id')
|
175
|
+
self.client_unique_id = attributes[:'client_unique_id']
|
176
|
+
end
|
177
|
+
|
178
|
+
if attributes.key?(:'context')
|
179
|
+
if (value = attributes[:'context']).is_a?(Array)
|
180
|
+
self.context = value
|
181
|
+
end
|
182
|
+
end
|
183
|
+
|
184
|
+
if attributes.key?(:'custom_data')
|
185
|
+
self.custom_data = attributes[:'custom_data']
|
186
|
+
end
|
187
|
+
|
188
|
+
if attributes.key?(:'direction')
|
189
|
+
self.direction = attributes[:'direction']
|
190
|
+
end
|
191
|
+
|
192
|
+
if attributes.key?(:'disposition')
|
193
|
+
self.disposition = attributes[:'disposition']
|
194
|
+
end
|
195
|
+
|
196
|
+
if attributes.key?(:'download_media_url')
|
197
|
+
self.download_media_url = attributes[:'download_media_url']
|
198
|
+
end
|
199
|
+
|
200
|
+
if attributes.key?(:'duration')
|
201
|
+
self.duration = attributes[:'duration']
|
202
|
+
end
|
203
|
+
|
204
|
+
if attributes.key?(:'language_code')
|
205
|
+
self.language_code = attributes[:'language_code']
|
206
|
+
end
|
207
|
+
|
208
|
+
if attributes.key?(:'meeting_url')
|
209
|
+
self.meeting_url = attributes[:'meeting_url']
|
210
|
+
end
|
211
|
+
|
212
|
+
if attributes.key?(:'parties')
|
213
|
+
if (value = attributes[:'parties']).is_a?(Array)
|
214
|
+
self.parties = value
|
215
|
+
end
|
216
|
+
end
|
217
|
+
|
218
|
+
if attributes.key?(:'primary_user')
|
219
|
+
self.primary_user = attributes[:'primary_user']
|
220
|
+
end
|
221
|
+
|
222
|
+
if attributes.key?(:'purpose')
|
223
|
+
self.purpose = attributes[:'purpose']
|
224
|
+
end
|
225
|
+
|
226
|
+
if attributes.key?(:'scheduled_end')
|
227
|
+
self.scheduled_end = attributes[:'scheduled_end']
|
228
|
+
end
|
229
|
+
|
230
|
+
if attributes.key?(:'scheduled_start')
|
231
|
+
self.scheduled_start = attributes[:'scheduled_start']
|
232
|
+
end
|
233
|
+
|
234
|
+
if attributes.key?(:'speakers_timeline')
|
235
|
+
self.speakers_timeline = attributes[:'speakers_timeline']
|
236
|
+
end
|
237
|
+
|
238
|
+
if attributes.key?(:'title')
|
239
|
+
self.title = attributes[:'title']
|
240
|
+
end
|
241
|
+
|
242
|
+
if attributes.key?(:'workspace_id')
|
243
|
+
self.workspace_id = attributes[:'workspace_id']
|
244
|
+
end
|
245
|
+
end
|
246
|
+
|
247
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
248
|
+
# @return Array for valid properties with the reasons
|
249
|
+
def list_invalid_properties
|
250
|
+
invalid_properties = Array.new
|
251
|
+
if @actual_start.nil?
|
252
|
+
invalid_properties.push('invalid value for "actual_start", actual_start cannot be nil.')
|
253
|
+
end
|
254
|
+
|
255
|
+
if @client_unique_id.nil?
|
256
|
+
invalid_properties.push('invalid value for "client_unique_id", client_unique_id cannot be nil.')
|
257
|
+
end
|
258
|
+
|
259
|
+
if @direction.nil?
|
260
|
+
invalid_properties.push('invalid value for "direction", direction cannot be nil.')
|
261
|
+
end
|
262
|
+
|
263
|
+
if @parties.nil?
|
264
|
+
invalid_properties.push('invalid value for "parties", parties cannot be nil.')
|
265
|
+
end
|
266
|
+
|
267
|
+
if @primary_user.nil?
|
268
|
+
invalid_properties.push('invalid value for "primary_user", primary_user cannot be nil.')
|
269
|
+
end
|
270
|
+
|
271
|
+
invalid_properties
|
272
|
+
end
|
273
|
+
|
274
|
+
# Check to see if the all the properties in the model are valid
|
275
|
+
# @return true if the model is valid
|
276
|
+
def valid?
|
277
|
+
return false if @actual_start.nil?
|
278
|
+
return false if @client_unique_id.nil?
|
279
|
+
return false if @direction.nil?
|
280
|
+
direction_validator = EnumAttributeValidator.new('Object', ['Conference', 'Inbound', 'Outbound', 'Unknown'])
|
281
|
+
return false unless direction_validator.valid?(@direction)
|
282
|
+
return false if @parties.nil?
|
283
|
+
return false if @primary_user.nil?
|
284
|
+
true
|
285
|
+
end
|
286
|
+
|
287
|
+
# Custom attribute writer method checking allowed values (enum).
|
288
|
+
# @param [Object] direction Object to be assigned
|
289
|
+
def direction=(direction)
|
290
|
+
validator = EnumAttributeValidator.new('Object', ['Conference', 'Inbound', 'Outbound', 'Unknown'])
|
291
|
+
unless validator.valid?(direction)
|
292
|
+
fail ArgumentError, "invalid value for \"direction\", must be one of #{validator.allowable_values}."
|
293
|
+
end
|
294
|
+
@direction = direction
|
295
|
+
end
|
296
|
+
|
297
|
+
# Checks equality by comparing each attribute.
|
298
|
+
# @param [Object] Object to be compared
|
299
|
+
def ==(o)
|
300
|
+
return true if self.equal?(o)
|
301
|
+
self.class == o.class &&
|
302
|
+
actual_start == o.actual_start &&
|
303
|
+
call_provider_code == o.call_provider_code &&
|
304
|
+
client_unique_id == o.client_unique_id &&
|
305
|
+
context == o.context &&
|
306
|
+
custom_data == o.custom_data &&
|
307
|
+
direction == o.direction &&
|
308
|
+
disposition == o.disposition &&
|
309
|
+
download_media_url == o.download_media_url &&
|
310
|
+
duration == o.duration &&
|
311
|
+
language_code == o.language_code &&
|
312
|
+
meeting_url == o.meeting_url &&
|
313
|
+
parties == o.parties &&
|
314
|
+
primary_user == o.primary_user &&
|
315
|
+
purpose == o.purpose &&
|
316
|
+
scheduled_end == o.scheduled_end &&
|
317
|
+
scheduled_start == o.scheduled_start &&
|
318
|
+
speakers_timeline == o.speakers_timeline &&
|
319
|
+
title == o.title &&
|
320
|
+
workspace_id == o.workspace_id
|
321
|
+
end
|
322
|
+
|
323
|
+
# @see the `==` method
|
324
|
+
# @param [Object] Object to be compared
|
325
|
+
def eql?(o)
|
326
|
+
self == o
|
327
|
+
end
|
328
|
+
|
329
|
+
# Calculates hash code according to all attributes.
|
330
|
+
# @return [Integer] Hash code
|
331
|
+
def hash
|
332
|
+
[actual_start, call_provider_code, client_unique_id, context, custom_data, direction, disposition, download_media_url, duration, language_code, meeting_url, parties, primary_user, purpose, scheduled_end, scheduled_start, speakers_timeline, title, workspace_id].hash
|
333
|
+
end
|
334
|
+
|
335
|
+
# Builds the object from hash
|
336
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
337
|
+
# @return [Object] Returns the model itself
|
338
|
+
def self.build_from_hash(attributes)
|
339
|
+
new.build_from_hash(attributes)
|
340
|
+
end
|
341
|
+
|
342
|
+
# Builds the object from hash
|
343
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
344
|
+
# @return [Object] Returns the model itself
|
345
|
+
def build_from_hash(attributes)
|
346
|
+
return nil unless attributes.is_a?(Hash)
|
347
|
+
self.class.openapi_types.each_pair do |key, type|
|
348
|
+
if type =~ /\AArray<(.*)>/i
|
349
|
+
# check to ensure the input is an array given that the attribute
|
350
|
+
# is documented as an array but the input is not
|
351
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
352
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
353
|
+
end
|
354
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
355
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
356
|
+
elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
|
357
|
+
self.send("#{key}=", nil)
|
358
|
+
end
|
359
|
+
end
|
360
|
+
|
361
|
+
self
|
362
|
+
end
|
363
|
+
|
364
|
+
# Deserializes the data based on type
|
365
|
+
# @param string type Data type
|
366
|
+
# @param string value Value to be deserialized
|
367
|
+
# @return [Object] Deserialized data
|
368
|
+
def _deserialize(type, value)
|
369
|
+
case type.to_sym
|
370
|
+
when :DateTime
|
371
|
+
DateTime.parse(value)
|
372
|
+
when :Date
|
373
|
+
Date.parse(value)
|
374
|
+
when :String
|
375
|
+
value.to_s
|
376
|
+
when :Integer
|
377
|
+
value.to_i
|
378
|
+
when :Float
|
379
|
+
value.to_f
|
380
|
+
when :Boolean
|
381
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
382
|
+
true
|
383
|
+
else
|
384
|
+
false
|
385
|
+
end
|
386
|
+
when :Object
|
387
|
+
# generic object (usually a Hash), return directly
|
388
|
+
value
|
389
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
390
|
+
inner_type = Regexp.last_match[:inner_type]
|
391
|
+
value.map { |v| _deserialize(inner_type, v) }
|
392
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
393
|
+
k_type = Regexp.last_match[:k_type]
|
394
|
+
v_type = Regexp.last_match[:v_type]
|
395
|
+
{}.tap do |hash|
|
396
|
+
value.each do |k, v|
|
397
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
398
|
+
end
|
399
|
+
end
|
400
|
+
else # model
|
401
|
+
GongAPI.const_get(type).build_from_hash(value)
|
402
|
+
end
|
403
|
+
end
|
404
|
+
|
405
|
+
# Returns the string representation of the object
|
406
|
+
# @return [String] String presentation of the object
|
407
|
+
def to_s
|
408
|
+
to_hash.to_s
|
409
|
+
end
|
410
|
+
|
411
|
+
# to_body is an alias to to_hash (backward compatibility)
|
412
|
+
# @return [Hash] Returns the object in the form of hash
|
413
|
+
def to_body
|
414
|
+
to_hash
|
415
|
+
end
|
416
|
+
|
417
|
+
# Returns the object in the form of hash
|
418
|
+
# @return [Hash] Returns the object in the form of hash
|
419
|
+
def to_hash
|
420
|
+
hash = {}
|
421
|
+
self.class.attribute_map.each_pair do |attr, param|
|
422
|
+
value = self.send(attr)
|
423
|
+
if value.nil?
|
424
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
425
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
426
|
+
end
|
427
|
+
|
428
|
+
hash[param] = _to_hash(value)
|
429
|
+
end
|
430
|
+
hash
|
431
|
+
end
|
432
|
+
|
433
|
+
# Outputs non-array value in the form of hash
|
434
|
+
# For object, use to_hash. Otherwise, just return the value
|
435
|
+
# @param [Object] value Any valid value
|
436
|
+
# @return [Hash] Returns the value in the form of hash
|
437
|
+
def _to_hash(value)
|
438
|
+
if value.is_a?(Array)
|
439
|
+
value.compact.map { |v| _to_hash(v) }
|
440
|
+
elsif value.is_a?(Hash)
|
441
|
+
{}.tap do |hash|
|
442
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
443
|
+
end
|
444
|
+
elsif value.respond_to? :to_hash
|
445
|
+
value.to_hash
|
446
|
+
else
|
447
|
+
value
|
448
|
+
end
|
449
|
+
end end
|
450
|
+
end
|
@@ -0,0 +1,217 @@
|
|
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
|
+
require 'date'
|
13
|
+
|
14
|
+
module GongAPI
|
15
|
+
class NewCallAddingResponse
|
16
|
+
# New call ID
|
17
|
+
attr_accessor :call_id
|
18
|
+
|
19
|
+
# A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes.
|
20
|
+
attr_accessor :request_id
|
21
|
+
|
22
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
23
|
+
def self.attribute_map
|
24
|
+
{
|
25
|
+
:'call_id' => :'callId',
|
26
|
+
:'request_id' => :'requestId'
|
27
|
+
}
|
28
|
+
end
|
29
|
+
|
30
|
+
# Attribute type mapping.
|
31
|
+
def self.openapi_types
|
32
|
+
{
|
33
|
+
:'call_id' => :'Object',
|
34
|
+
:'request_id' => :'Object'
|
35
|
+
}
|
36
|
+
end
|
37
|
+
|
38
|
+
# List of attributes with nullable: true
|
39
|
+
def self.openapi_nullable
|
40
|
+
Set.new([
|
41
|
+
])
|
42
|
+
end
|
43
|
+
|
44
|
+
# Initializes the object
|
45
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
46
|
+
def initialize(attributes = {})
|
47
|
+
if (!attributes.is_a?(Hash))
|
48
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `GongAPI::NewCallAddingResponse` initialize method"
|
49
|
+
end
|
50
|
+
|
51
|
+
# check to see if the attribute exists and convert string to symbol for hash key
|
52
|
+
attributes = attributes.each_with_object({}) { |(k, v), h|
|
53
|
+
if (!self.class.attribute_map.key?(k.to_sym))
|
54
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `GongAPI::NewCallAddingResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
55
|
+
end
|
56
|
+
h[k.to_sym] = v
|
57
|
+
}
|
58
|
+
|
59
|
+
if attributes.key?(:'call_id')
|
60
|
+
self.call_id = attributes[:'call_id']
|
61
|
+
end
|
62
|
+
|
63
|
+
if attributes.key?(:'request_id')
|
64
|
+
self.request_id = attributes[:'request_id']
|
65
|
+
end
|
66
|
+
end
|
67
|
+
|
68
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
69
|
+
# @return Array for valid properties with the reasons
|
70
|
+
def list_invalid_properties
|
71
|
+
invalid_properties = Array.new
|
72
|
+
invalid_properties
|
73
|
+
end
|
74
|
+
|
75
|
+
# Check to see if the all the properties in the model are valid
|
76
|
+
# @return true if the model is valid
|
77
|
+
def valid?
|
78
|
+
true
|
79
|
+
end
|
80
|
+
|
81
|
+
# Checks equality by comparing each attribute.
|
82
|
+
# @param [Object] Object to be compared
|
83
|
+
def ==(o)
|
84
|
+
return true if self.equal?(o)
|
85
|
+
self.class == o.class &&
|
86
|
+
call_id == o.call_id &&
|
87
|
+
request_id == o.request_id
|
88
|
+
end
|
89
|
+
|
90
|
+
# @see the `==` method
|
91
|
+
# @param [Object] Object to be compared
|
92
|
+
def eql?(o)
|
93
|
+
self == o
|
94
|
+
end
|
95
|
+
|
96
|
+
# Calculates hash code according to all attributes.
|
97
|
+
# @return [Integer] Hash code
|
98
|
+
def hash
|
99
|
+
[call_id, request_id].hash
|
100
|
+
end
|
101
|
+
|
102
|
+
# Builds the object from hash
|
103
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
104
|
+
# @return [Object] Returns the model itself
|
105
|
+
def self.build_from_hash(attributes)
|
106
|
+
new.build_from_hash(attributes)
|
107
|
+
end
|
108
|
+
|
109
|
+
# Builds the object from hash
|
110
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
111
|
+
# @return [Object] Returns the model itself
|
112
|
+
def build_from_hash(attributes)
|
113
|
+
return nil unless attributes.is_a?(Hash)
|
114
|
+
self.class.openapi_types.each_pair do |key, type|
|
115
|
+
if type =~ /\AArray<(.*)>/i
|
116
|
+
# check to ensure the input is an array given that the attribute
|
117
|
+
# is documented as an array but the input is not
|
118
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
119
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
120
|
+
end
|
121
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
122
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
123
|
+
elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
|
124
|
+
self.send("#{key}=", nil)
|
125
|
+
end
|
126
|
+
end
|
127
|
+
|
128
|
+
self
|
129
|
+
end
|
130
|
+
|
131
|
+
# Deserializes the data based on type
|
132
|
+
# @param string type Data type
|
133
|
+
# @param string value Value to be deserialized
|
134
|
+
# @return [Object] Deserialized data
|
135
|
+
def _deserialize(type, value)
|
136
|
+
case type.to_sym
|
137
|
+
when :DateTime
|
138
|
+
DateTime.parse(value)
|
139
|
+
when :Date
|
140
|
+
Date.parse(value)
|
141
|
+
when :String
|
142
|
+
value.to_s
|
143
|
+
when :Integer
|
144
|
+
value.to_i
|
145
|
+
when :Float
|
146
|
+
value.to_f
|
147
|
+
when :Boolean
|
148
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
149
|
+
true
|
150
|
+
else
|
151
|
+
false
|
152
|
+
end
|
153
|
+
when :Object
|
154
|
+
# generic object (usually a Hash), return directly
|
155
|
+
value
|
156
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
157
|
+
inner_type = Regexp.last_match[:inner_type]
|
158
|
+
value.map { |v| _deserialize(inner_type, v) }
|
159
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
160
|
+
k_type = Regexp.last_match[:k_type]
|
161
|
+
v_type = Regexp.last_match[:v_type]
|
162
|
+
{}.tap do |hash|
|
163
|
+
value.each do |k, v|
|
164
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
165
|
+
end
|
166
|
+
end
|
167
|
+
else # model
|
168
|
+
GongAPI.const_get(type).build_from_hash(value)
|
169
|
+
end
|
170
|
+
end
|
171
|
+
|
172
|
+
# Returns the string representation of the object
|
173
|
+
# @return [String] String presentation of the object
|
174
|
+
def to_s
|
175
|
+
to_hash.to_s
|
176
|
+
end
|
177
|
+
|
178
|
+
# to_body is an alias to to_hash (backward compatibility)
|
179
|
+
# @return [Hash] Returns the object in the form of hash
|
180
|
+
def to_body
|
181
|
+
to_hash
|
182
|
+
end
|
183
|
+
|
184
|
+
# Returns the object in the form of hash
|
185
|
+
# @return [Hash] Returns the object in the form of hash
|
186
|
+
def to_hash
|
187
|
+
hash = {}
|
188
|
+
self.class.attribute_map.each_pair do |attr, param|
|
189
|
+
value = self.send(attr)
|
190
|
+
if value.nil?
|
191
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
192
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
193
|
+
end
|
194
|
+
|
195
|
+
hash[param] = _to_hash(value)
|
196
|
+
end
|
197
|
+
hash
|
198
|
+
end
|
199
|
+
|
200
|
+
# Outputs non-array value in the form of hash
|
201
|
+
# For object, use to_hash. Otherwise, just return the value
|
202
|
+
# @param [Object] value Any valid value
|
203
|
+
# @return [Hash] Returns the value in the form of hash
|
204
|
+
def _to_hash(value)
|
205
|
+
if value.is_a?(Array)
|
206
|
+
value.compact.map { |v| _to_hash(v) }
|
207
|
+
elsif value.is_a?(Hash)
|
208
|
+
{}.tap do |hash|
|
209
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
210
|
+
end
|
211
|
+
elsif value.respond_to? :to_hash
|
212
|
+
value.to_hash
|
213
|
+
else
|
214
|
+
value
|
215
|
+
end
|
216
|
+
end end
|
217
|
+
end
|