gong_api 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (531) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +9 -0
  3. data/README.md +906 -0
  4. data/Rakefile +8 -0
  5. data/config.json +12 -0
  6. data/docs/Actor.md +10 -0
  7. data/docs/AggregateActivity.md +21 -0
  8. data/docs/AggregateActivityWithDates.md +23 -0
  9. data/docs/Answer.md +12 -0
  10. data/docs/AnsweredScorecard.md +16 -0
  11. data/docs/AnsweredScorecards.md +9 -0
  12. data/docs/AnsweredScorecardsFilter.md +12 -0
  13. data/docs/AssociationObject.md +8 -0
  14. data/docs/AsyncProcessingResponse.md +8 -0
  15. data/docs/AuditingApi.md +61 -0
  16. data/docs/BaseResponse.md +7 -0
  17. data/docs/CRMApi.md +490 -0
  18. data/docs/Call.md +13 -0
  19. data/docs/CallAccessDetails.md +8 -0
  20. data/docs/CallAccessWithPermissionLevel.md +8 -0
  21. data/docs/CallBasicData.md +25 -0
  22. data/docs/CallCollaboration.md +7 -0
  23. data/docs/CallContent.md +11 -0
  24. data/docs/CallContext.md +8 -0
  25. data/docs/CallInteraction.md +10 -0
  26. data/docs/CallParticipant.md +13 -0
  27. data/docs/CallReference.md +9 -0
  28. data/docs/CallTranscript.md +8 -0
  29. data/docs/CallTranscripts.md +9 -0
  30. data/docs/CallUploadContext.md +8 -0
  31. data/docs/CallUsersAccessDto.md +8 -0
  32. data/docs/Calls.md +9 -0
  33. data/docs/CallsAccessDetailsResponse.md +8 -0
  34. data/docs/CallsAccessGetDto.md +7 -0
  35. data/docs/CallsApi.md +349 -0
  36. data/docs/CallsFilter.md +10 -0
  37. data/docs/CallsRequestFilterWithOwners.md +11 -0
  38. data/docs/CallsResponse.md +9 -0
  39. data/docs/CallsUsersAccessAddDto.md +7 -0
  40. data/docs/CallsUsersAccessDeleteDto.md +7 -0
  41. data/docs/CoachingAccessWithPermissionLevel.md +8 -0
  42. data/docs/Collaboration.md +7 -0
  43. data/docs/Comment.md +14 -0
  44. data/docs/CompanyUsersAggregateActivityResponse.md +12 -0
  45. data/docs/CompanyUsersIntercationStatsResponse.md +12 -0
  46. data/docs/Content.md +10 -0
  47. data/docs/ContentSelector.md +9 -0
  48. data/docs/ContentSharedEvent.md +23 -0
  49. data/docs/ContentViewedEvent.md +23 -0
  50. data/docs/ContextField.md +8 -0
  51. data/docs/CrmPartyContextField.md +8 -0
  52. data/docs/CustomActionEvent.md +22 -0
  53. data/docs/CustomerData.md +8 -0
  54. data/docs/CustomerDataObject.md +11 -0
  55. data/docs/CustomerEngagement.md +13 -0
  56. data/docs/DailyActivityWithDates.md +23 -0
  57. data/docs/DataPrivacyApi.md +195 -0
  58. data/docs/DealsAccessWithPermissionLevel.md +8 -0
  59. data/docs/DeleteMeetingRequest.md +7 -0
  60. data/docs/EmailAddressReferences.md +12 -0
  61. data/docs/EmailMessage.md +11 -0
  62. data/docs/EmailsAccessWithPermissionLevel.md +8 -0
  63. data/docs/EngagementInBetaPhaseApi.md +148 -0
  64. data/docs/ErrorResponse.md +8 -0
  65. data/docs/EventAcceptedResponse.md +7 -0
  66. data/docs/ExposedFields.md +11 -0
  67. data/docs/ExternalCallObject.md +10 -0
  68. data/docs/ExternalCrmCallObject.md +9 -0
  69. data/docs/ExternalCrmPartyObject.md +9 -0
  70. data/docs/ExternalPartyObject.md +10 -0
  71. data/docs/ExternalSystem.md +8 -0
  72. data/docs/ExternalSystemObject.md +8 -0
  73. data/docs/ForecastAccessWithPermissionLevel.md +8 -0
  74. data/docs/GenericCrmIntegration.md +9 -0
  75. data/docs/GenericCrmRegistrationRequest.md +8 -0
  76. data/docs/GenericDealStageRequest.md +10 -0
  77. data/docs/GenericProperty.md +9 -0
  78. data/docs/GenericSchemaFieldRequest.md +14 -0
  79. data/docs/GetGenericCrmObjectsResponse.md +8 -0
  80. data/docs/IdMediaBody.md +7 -0
  81. data/docs/InsightsAccessWithPermissionLevel.md +8 -0
  82. data/docs/IntegrationStatusRequest.md +7 -0
  83. data/docs/IntegrationStatusResponse.md +8 -0
  84. data/docs/Interaction.md +10 -0
  85. data/docs/InteractionStat.md +8 -0
  86. data/docs/InteractionStats.md +9 -0
  87. data/docs/LibraryApi.md +103 -0
  88. data/docs/LibraryCall.md +13 -0
  89. data/docs/LibraryFolder.md +11 -0
  90. data/docs/LibraryFolderAccess.md +11 -0
  91. data/docs/LibraryFolderListOfCallsResponse.md +12 -0
  92. data/docs/LibraryResponse.md +8 -0
  93. data/docs/LineErrorResponse.md +8 -0
  94. data/docs/ListGenericCrmIntegrationsResponse.md +8 -0
  95. data/docs/ListSelectedFieldsResponse.md +8 -0
  96. data/docs/LogEntry.md +15 -0
  97. data/docs/LogsResponse.md +9 -0
  98. data/docs/ManualAssociationResponse.md +9 -0
  99. data/docs/ManualAssociationsBasicData.md +10 -0
  100. data/docs/MapUsersBody.md +7 -0
  101. data/docs/Media.md +8 -0
  102. data/docs/Meeting.md +7 -0
  103. data/docs/MeetingInvitee.md +10 -0
  104. data/docs/MeetingsErrorResponse.md +11 -0
  105. data/docs/MeetingsInBetaPhaseApi.md +199 -0
  106. data/docs/Monologue.md +9 -0
  107. data/docs/MultipleUsersRequestWithCreationDates.md +10 -0
  108. data/docs/MultipleUsersWithDates.md +9 -0
  109. data/docs/NewCallAddingRequest.md +25 -0
  110. data/docs/NewCallAddingResponse.md +8 -0
  111. data/docs/NewCallRecordingResponse.md +9 -0
  112. data/docs/NewMeetingRequest.md +12 -0
  113. data/docs/NewMeetingResponse.md +10 -0
  114. data/docs/ObjectEntitiesBody.md +7 -0
  115. data/docs/Occurrences.md +8 -0
  116. data/docs/Party.md +16 -0
  117. data/docs/PartyContext.md +8 -0
  118. data/docs/PartyContextField.md +8 -0
  119. data/docs/PartyUploadContext.md +8 -0
  120. data/docs/PermissionProfileDTO.md +41 -0
  121. data/docs/PermissionProfileResponse.md +8 -0
  122. data/docs/PermissionProfileUsersResponse.md +8 -0
  123. data/docs/PermissionProfilesResponse.md +8 -0
  124. data/docs/PermissionsApi.md +387 -0
  125. data/docs/PhoneNumberReferences.md +14 -0
  126. data/docs/PointOfInterest.md +10 -0
  127. data/docs/PointsOfInterest.md +7 -0
  128. data/docs/Question.md +13 -0
  129. data/docs/Questions.md +8 -0
  130. data/docs/Records.md +10 -0
  131. data/docs/RegisterGenericCrmResponse.md +8 -0
  132. data/docs/RequestAnsweredScorecardsFilter.md +8 -0
  133. data/docs/RequestCallsAccessGetDto.md +7 -0
  134. data/docs/RequestCallsFilter.md +8 -0
  135. data/docs/RequestCallsRequestFilterWithOwnersContentSelector.md +9 -0
  136. data/docs/RequestMultipleUsersRequestWithCreationDates.md +8 -0
  137. data/docs/RequestMultipleUsersWithDates.md +8 -0
  138. data/docs/RequestStatusResponse.md +11 -0
  139. data/docs/RequestWithTimePeriodMultipleUsersWithDates.md +9 -0
  140. data/docs/SchemaUpdateResponse.md +7 -0
  141. data/docs/Scorecard.md +14 -0
  142. data/docs/Scorecards.md +8 -0
  143. data/docs/Sentence.md +9 -0
  144. data/docs/Settings.md +12 -0
  145. data/docs/SettingsApi.md +91 -0
  146. data/docs/SettingsHistory.md +8 -0
  147. data/docs/Sharer.md +9 -0
  148. data/docs/Snippet.md +8 -0
  149. data/docs/Speaker.md +9 -0
  150. data/docs/SpeakersTimeline.md +8 -0
  151. data/docs/SpecificCall.md +8 -0
  152. data/docs/SpeechSegment.md +9 -0
  153. data/docs/SpokenLanguage.md +8 -0
  154. data/docs/StatsApi.md +242 -0
  155. data/docs/Structure.md +8 -0
  156. data/docs/Topic.md +8 -0
  157. data/docs/Tracker.md +12 -0
  158. data/docs/TrackerPhrases.md +9 -0
  159. data/docs/UpdateMeetingRequest.md +12 -0
  160. data/docs/UpdateMeetingResponse.md +8 -0
  161. data/docs/User.md +8 -0
  162. data/docs/UserAccessDetails.md +7 -0
  163. data/docs/UserActivity.md +9 -0
  164. data/docs/UserAggregateByPeriodActivities.md +9 -0
  165. data/docs/UserDayByDayActivity.md +9 -0
  166. data/docs/UserIntegrationStatus.md +12 -0
  167. data/docs/UserMetadata.md +21 -0
  168. data/docs/UserSettingsHistory.md +9 -0
  169. data/docs/UserSimpleMetadata.md +9 -0
  170. data/docs/UsersAggregateByPeriodActivity.md +9 -0
  171. data/docs/UsersApi.md +198 -0
  172. data/docs/UsersDayByDayActivity.md +9 -0
  173. data/docs/UsersMetadata.md +9 -0
  174. data/docs/Video.md +8 -0
  175. data/docs/WorkspaceMetadata.md +9 -0
  176. data/docs/WorkspacesMetadata.md +8 -0
  177. data/git_push.sh +55 -0
  178. data/gong-swagger.json +1 -0
  179. data/gong_api.gemspec +38 -0
  180. data/lib/gong_api/api/auditing_api.rb +94 -0
  181. data/lib/gong_api/api/calls_api.rb +437 -0
  182. data/lib/gong_api/api/crm_api.rb +651 -0
  183. data/lib/gong_api/api/data_privacy_api.rb +248 -0
  184. data/lib/gong_api/api/engagement_in_beta_phase_api.rb +194 -0
  185. data/lib/gong_api/api/library_api.rb +126 -0
  186. data/lib/gong_api/api/meetings_in_beta_phase_api.rb +264 -0
  187. data/lib/gong_api/api/permissions_api.rb +495 -0
  188. data/lib/gong_api/api/settings_api.rb +120 -0
  189. data/lib/gong_api/api/stats_api.rb +310 -0
  190. data/lib/gong_api/api/users_api.rb +246 -0
  191. data/lib/gong_api/api_client.rb +387 -0
  192. data/lib/gong_api/api_error.rb +57 -0
  193. data/lib/gong_api/configuration.rb +198 -0
  194. data/lib/gong_api/models/actor.rb +239 -0
  195. data/lib/gong_api/models/aggregate_activity.rb +348 -0
  196. data/lib/gong_api/models/aggregate_activity_with_dates.rb +368 -0
  197. data/lib/gong_api/models/answer.rb +257 -0
  198. data/lib/gong_api/models/answered_scorecard.rb +332 -0
  199. data/lib/gong_api/models/answered_scorecards.rb +228 -0
  200. data/lib/gong_api/models/answered_scorecards_filter.rb +258 -0
  201. data/lib/gong_api/models/association_object.rb +217 -0
  202. data/lib/gong_api/models/async_processing_response.rb +217 -0
  203. data/lib/gong_api/models/base_response.rb +207 -0
  204. data/lib/gong_api/models/call.rb +267 -0
  205. data/lib/gong_api/models/call_access_details.rb +220 -0
  206. data/lib/gong_api/models/call_access_with_permission_level.rb +254 -0
  207. data/lib/gong_api/models/call_basic_data.rb +446 -0
  208. data/lib/gong_api/models/call_collaboration.rb +208 -0
  209. data/lib/gong_api/models/call_content.rb +248 -0
  210. data/lib/gong_api/models/call_context.rb +254 -0
  211. data/lib/gong_api/models/call_interaction.rb +238 -0
  212. data/lib/gong_api/models/call_participant.rb +269 -0
  213. data/lib/gong_api/models/call_reference.rb +230 -0
  214. data/lib/gong_api/models/call_transcript.rb +219 -0
  215. data/lib/gong_api/models/call_transcripts.rb +228 -0
  216. data/lib/gong_api/models/call_upload_context.rb +259 -0
  217. data/lib/gong_api/models/call_users_access_dto.rb +228 -0
  218. data/lib/gong_api/models/calls.rb +228 -0
  219. data/lib/gong_api/models/calls_access_details_response.rb +219 -0
  220. data/lib/gong_api/models/calls_access_get_dto.rb +212 -0
  221. data/lib/gong_api/models/calls_filter.rb +238 -0
  222. data/lib/gong_api/models/calls_request_filter_with_owners.rb +248 -0
  223. data/lib/gong_api/models/calls_response.rb +228 -0
  224. data/lib/gong_api/models/calls_users_access_add_dto.rb +209 -0
  225. data/lib/gong_api/models/calls_users_access_delete_dto.rb +209 -0
  226. data/lib/gong_api/models/coaching_access_with_permission_level.rb +254 -0
  227. data/lib/gong_api/models/collaboration.rb +210 -0
  228. data/lib/gong_api/models/comment.rb +277 -0
  229. data/lib/gong_api/models/company_users_aggregate_activity_response.rb +258 -0
  230. data/lib/gong_api/models/company_users_intercation_stats_response.rb +258 -0
  231. data/lib/gong_api/models/content.rb +243 -0
  232. data/lib/gong_api/models/content_selector.rb +263 -0
  233. data/lib/gong_api/models/content_shared_event.rb +400 -0
  234. data/lib/gong_api/models/content_viewed_event.rb +432 -0
  235. data/lib/gong_api/models/context_field.rb +218 -0
  236. data/lib/gong_api/models/crm_party_context_field.rb +218 -0
  237. data/lib/gong_api/models/custom_action_event.rb +407 -0
  238. data/lib/gong_api/models/customer_data.rb +253 -0
  239. data/lib/gong_api/models/customer_data_object.rb +283 -0
  240. data/lib/gong_api/models/customer_engagement.rb +301 -0
  241. data/lib/gong_api/models/daily_activity_with_dates.rb +368 -0
  242. data/lib/gong_api/models/deals_access_with_permission_level.rb +254 -0
  243. data/lib/gong_api/models/delete_meeting_request.rb +208 -0
  244. data/lib/gong_api/models/email_address_references.rb +267 -0
  245. data/lib/gong_api/models/email_message.rb +247 -0
  246. data/lib/gong_api/models/emails_access_with_permission_level.rb +254 -0
  247. data/lib/gong_api/models/error_response.rb +217 -0
  248. data/lib/gong_api/models/event_accepted_response.rb +207 -0
  249. data/lib/gong_api/models/exposed_fields.rb +245 -0
  250. data/lib/gong_api/models/external_call_object.rb +286 -0
  251. data/lib/gong_api/models/external_crm_call_object.rb +274 -0
  252. data/lib/gong_api/models/external_crm_party_object.rb +274 -0
  253. data/lib/gong_api/models/external_party_object.rb +286 -0
  254. data/lib/gong_api/models/external_system.rb +253 -0
  255. data/lib/gong_api/models/external_system_object.rb +251 -0
  256. data/lib/gong_api/models/forecast_access_with_permission_level.rb +254 -0
  257. data/lib/gong_api/models/generic_crm_integration.rb +227 -0
  258. data/lib/gong_api/models/generic_crm_registration_request.rb +227 -0
  259. data/lib/gong_api/models/generic_deal_stage_request.rb +257 -0
  260. data/lib/gong_api/models/generic_property.rb +276 -0
  261. data/lib/gong_api/models/generic_schema_field_request.rb +328 -0
  262. data/lib/gong_api/models/get_generic_crm_objects_response.rb +219 -0
  263. data/lib/gong_api/models/id_media_body.rb +206 -0
  264. data/lib/gong_api/models/insights_access_with_permission_level.rb +254 -0
  265. data/lib/gong_api/models/integration_status_request.rb +209 -0
  266. data/lib/gong_api/models/integration_status_response.rb +219 -0
  267. data/lib/gong_api/models/interaction.rb +243 -0
  268. data/lib/gong_api/models/interaction_stat.rb +217 -0
  269. data/lib/gong_api/models/interaction_stats.rb +228 -0
  270. data/lib/gong_api/models/library_call.rb +267 -0
  271. data/lib/gong_api/models/library_folder.rb +248 -0
  272. data/lib/gong_api/models/library_folder_access.rb +284 -0
  273. data/lib/gong_api/models/library_folder_list_of_calls_response.rb +259 -0
  274. data/lib/gong_api/models/library_response.rb +219 -0
  275. data/lib/gong_api/models/line_error_response.rb +217 -0
  276. data/lib/gong_api/models/list_generic_crm_integrations_response.rb +219 -0
  277. data/lib/gong_api/models/list_selected_fields_response.rb +219 -0
  278. data/lib/gong_api/models/log_entry.rb +287 -0
  279. data/lib/gong_api/models/logs_response.rb +228 -0
  280. data/lib/gong_api/models/manual_association_response.rb +228 -0
  281. data/lib/gong_api/models/manual_associations_basic_data.rb +240 -0
  282. data/lib/gong_api/models/map_users_body.rb +206 -0
  283. data/lib/gong_api/models/media.rb +218 -0
  284. data/lib/gong_api/models/meeting.rb +207 -0
  285. data/lib/gong_api/models/meeting_invitee.rb +237 -0
  286. data/lib/gong_api/models/meetings_error_response.rb +247 -0
  287. data/lib/gong_api/models/monologue.rb +229 -0
  288. data/lib/gong_api/models/multiple_users_request_with_creation_dates.rb +238 -0
  289. data/lib/gong_api/models/multiple_users_with_dates.rb +238 -0
  290. data/lib/gong_api/models/new_call_adding_request.rb +450 -0
  291. data/lib/gong_api/models/new_call_adding_response.rb +217 -0
  292. data/lib/gong_api/models/new_call_recording_response.rb +227 -0
  293. data/lib/gong_api/models/new_meeting_request.rb +265 -0
  294. data/lib/gong_api/models/new_meeting_response.rb +239 -0
  295. data/lib/gong_api/models/object_entities_body.rb +206 -0
  296. data/lib/gong_api/models/occurrences.rb +217 -0
  297. data/lib/gong_api/models/party.rb +335 -0
  298. data/lib/gong_api/models/party_context.rb +254 -0
  299. data/lib/gong_api/models/party_context_field.rb +218 -0
  300. data/lib/gong_api/models/party_upload_context.rb +259 -0
  301. data/lib/gong_api/models/permission_profile_dto.rb +541 -0
  302. data/lib/gong_api/models/permission_profile_response.rb +216 -0
  303. data/lib/gong_api/models/permission_profile_users_response.rb +219 -0
  304. data/lib/gong_api/models/permission_profiles_response.rb +219 -0
  305. data/lib/gong_api/models/phone_number_references.rb +289 -0
  306. data/lib/gong_api/models/point_of_interest.rb +237 -0
  307. data/lib/gong_api/models/points_of_interest.rb +210 -0
  308. data/lib/gong_api/models/question.rb +267 -0
  309. data/lib/gong_api/models/questions.rb +218 -0
  310. data/lib/gong_api/models/records.rb +238 -0
  311. data/lib/gong_api/models/register_generic_crm_response.rb +217 -0
  312. data/lib/gong_api/models/request_answered_scorecards_filter.rb +216 -0
  313. data/lib/gong_api/models/request_calls_access_get_dto.rb +206 -0
  314. data/lib/gong_api/models/request_calls_filter.rb +216 -0
  315. data/lib/gong_api/models/request_calls_request_filter_with_owners_content_selector.rb +225 -0
  316. data/lib/gong_api/models/request_multiple_users_request_with_creation_dates.rb +216 -0
  317. data/lib/gong_api/models/request_multiple_users_with_dates.rb +216 -0
  318. data/lib/gong_api/models/request_status_response.rb +282 -0
  319. data/lib/gong_api/models/request_with_time_period_multiple_users_with_dates.rb +265 -0
  320. data/lib/gong_api/models/schema_update_response.rb +207 -0
  321. data/lib/gong_api/models/scorecard.rb +279 -0
  322. data/lib/gong_api/models/scorecards.rb +219 -0
  323. data/lib/gong_api/models/sentence.rb +227 -0
  324. data/lib/gong_api/models/settings.rb +258 -0
  325. data/lib/gong_api/models/settings_history.rb +219 -0
  326. data/lib/gong_api/models/sharer.rb +227 -0
  327. data/lib/gong_api/models/snippet.rb +218 -0
  328. data/lib/gong_api/models/speaker.rb +228 -0
  329. data/lib/gong_api/models/speakers_timeline.rb +219 -0
  330. data/lib/gong_api/models/specific_call.rb +216 -0
  331. data/lib/gong_api/models/speech_segment.rb +244 -0
  332. data/lib/gong_api/models/spoken_language.rb +218 -0
  333. data/lib/gong_api/models/structure.rb +218 -0
  334. data/lib/gong_api/models/topic.rb +217 -0
  335. data/lib/gong_api/models/tracker.rb +295 -0
  336. data/lib/gong_api/models/tracker_phrases.rb +229 -0
  337. data/lib/gong_api/models/update_meeting_request.rb +265 -0
  338. data/lib/gong_api/models/update_meeting_response.rb +217 -0
  339. data/lib/gong_api/models/user.rb +216 -0
  340. data/lib/gong_api/models/user_access_details.rb +208 -0
  341. data/lib/gong_api/models/user_activity.rb +226 -0
  342. data/lib/gong_api/models/user_aggregate_by_period_activities.rb +229 -0
  343. data/lib/gong_api/models/user_day_by_day_activity.rb +229 -0
  344. data/lib/gong_api/models/user_integration_status.rb +257 -0
  345. data/lib/gong_api/models/user_metadata.rb +347 -0
  346. data/lib/gong_api/models/user_settings_history.rb +261 -0
  347. data/lib/gong_api/models/user_simple_metadata.rb +227 -0
  348. data/lib/gong_api/models/users_aggregate_by_period_activity.rb +228 -0
  349. data/lib/gong_api/models/users_day_by_day_activity.rb +228 -0
  350. data/lib/gong_api/models/users_metadata.rb +228 -0
  351. data/lib/gong_api/models/video.rb +218 -0
  352. data/lib/gong_api/models/workspace_metadata.rb +227 -0
  353. data/lib/gong_api/models/workspaces_metadata.rb +219 -0
  354. data/lib/gong_api/version.rb +14 -0
  355. data/lib/gong_api.rb +209 -0
  356. data/spec/api/auditing_api_spec.rb +49 -0
  357. data/spec/api/calls_api_spec.rb +123 -0
  358. data/spec/api/crm_api_spec.rb +161 -0
  359. data/spec/api/data_privacy_api_spec.rb +82 -0
  360. data/spec/api/engagement_in_beta_phase_api_spec.rb +70 -0
  361. data/spec/api/library_api_spec.rb +58 -0
  362. data/spec/api/meetings_in_beta_phase_api_spec.rb +84 -0
  363. data/spec/api/permissions_api_spec.rb +132 -0
  364. data/spec/api/settings_api_spec.rb +56 -0
  365. data/spec/api/stats_api_spec.rb +94 -0
  366. data/spec/api/users_api_spec.rb +83 -0
  367. data/spec/api_client_spec.rb +225 -0
  368. data/spec/base_object_spec.rb +109 -0
  369. data/spec/configuration_spec.rb +41 -0
  370. data/spec/models/actor_spec.rb +58 -0
  371. data/spec/models/aggregate_activity_spec.rb +124 -0
  372. data/spec/models/aggregate_activity_with_dates_spec.rb +136 -0
  373. data/spec/models/answer_spec.rb +70 -0
  374. data/spec/models/answered_scorecard_spec.rb +98 -0
  375. data/spec/models/answered_scorecards_filter_spec.rb +70 -0
  376. data/spec/models/answered_scorecards_spec.rb +52 -0
  377. data/spec/models/association_object_spec.rb +46 -0
  378. data/spec/models/async_processing_response_spec.rb +46 -0
  379. data/spec/models/base_response_spec.rb +40 -0
  380. data/spec/models/call_access_details_spec.rb +46 -0
  381. data/spec/models/call_access_with_permission_level_spec.rb +50 -0
  382. data/spec/models/call_basic_data_spec.rb +160 -0
  383. data/spec/models/call_collaboration_spec.rb +40 -0
  384. data/spec/models/call_content_spec.rb +64 -0
  385. data/spec/models/call_context_spec.rb +50 -0
  386. data/spec/models/call_interaction_spec.rb +58 -0
  387. data/spec/models/call_participant_spec.rb +76 -0
  388. data/spec/models/call_reference_spec.rb +52 -0
  389. data/spec/models/call_spec.rb +76 -0
  390. data/spec/models/call_transcript_spec.rb +46 -0
  391. data/spec/models/call_transcripts_spec.rb +52 -0
  392. data/spec/models/call_upload_context_spec.rb +50 -0
  393. data/spec/models/call_users_access_dto_spec.rb +46 -0
  394. data/spec/models/calls_access_details_response_spec.rb +46 -0
  395. data/spec/models/calls_access_get_dto_spec.rb +40 -0
  396. data/spec/models/calls_filter_spec.rb +58 -0
  397. data/spec/models/calls_request_filter_with_owners_spec.rb +64 -0
  398. data/spec/models/calls_response_spec.rb +52 -0
  399. data/spec/models/calls_spec.rb +52 -0
  400. data/spec/models/calls_users_access_add_dto_spec.rb +40 -0
  401. data/spec/models/calls_users_access_delete_dto_spec.rb +40 -0
  402. data/spec/models/coaching_access_with_permission_level_spec.rb +50 -0
  403. data/spec/models/collaboration_spec.rb +40 -0
  404. data/spec/models/comment_spec.rb +82 -0
  405. data/spec/models/company_users_aggregate_activity_response_spec.rb +70 -0
  406. data/spec/models/company_users_intercation_stats_response_spec.rb +70 -0
  407. data/spec/models/content_selector_spec.rb +60 -0
  408. data/spec/models/content_shared_event_spec.rb +136 -0
  409. data/spec/models/content_spec.rb +58 -0
  410. data/spec/models/content_viewed_event_spec.rb +140 -0
  411. data/spec/models/context_field_spec.rb +46 -0
  412. data/spec/models/crm_party_context_field_spec.rb +46 -0
  413. data/spec/models/custom_action_event_spec.rb +134 -0
  414. data/spec/models/customer_data_object_spec.rb +68 -0
  415. data/spec/models/customer_data_spec.rb +50 -0
  416. data/spec/models/customer_engagement_spec.rb +80 -0
  417. data/spec/models/daily_activity_with_dates_spec.rb +136 -0
  418. data/spec/models/deals_access_with_permission_level_spec.rb +50 -0
  419. data/spec/models/delete_meeting_request_spec.rb +40 -0
  420. data/spec/models/email_address_references_spec.rb +70 -0
  421. data/spec/models/email_message_spec.rb +64 -0
  422. data/spec/models/emails_access_with_permission_level_spec.rb +50 -0
  423. data/spec/models/error_response_spec.rb +46 -0
  424. data/spec/models/event_accepted_response_spec.rb +40 -0
  425. data/spec/models/exposed_fields_spec.rb +64 -0
  426. data/spec/models/external_call_object_spec.rb +66 -0
  427. data/spec/models/external_crm_call_object_spec.rb +56 -0
  428. data/spec/models/external_crm_party_object_spec.rb +56 -0
  429. data/spec/models/external_party_object_spec.rb +66 -0
  430. data/spec/models/external_system_object_spec.rb +50 -0
  431. data/spec/models/external_system_spec.rb +50 -0
  432. data/spec/models/forecast_access_with_permission_level_spec.rb +50 -0
  433. data/spec/models/generic_crm_integration_spec.rb +52 -0
  434. data/spec/models/generic_crm_registration_request_spec.rb +46 -0
  435. data/spec/models/generic_deal_stage_request_spec.rb +58 -0
  436. data/spec/models/generic_property_spec.rb +56 -0
  437. data/spec/models/generic_schema_field_request_spec.rb +86 -0
  438. data/spec/models/get_generic_crm_objects_response_spec.rb +46 -0
  439. data/spec/models/id_media_body_spec.rb +40 -0
  440. data/spec/models/insights_access_with_permission_level_spec.rb +50 -0
  441. data/spec/models/integration_status_request_spec.rb +40 -0
  442. data/spec/models/integration_status_response_spec.rb +46 -0
  443. data/spec/models/interaction_spec.rb +58 -0
  444. data/spec/models/interaction_stat_spec.rb +46 -0
  445. data/spec/models/interaction_stats_spec.rb +52 -0
  446. data/spec/models/library_call_spec.rb +76 -0
  447. data/spec/models/library_folder_access_spec.rb +68 -0
  448. data/spec/models/library_folder_list_of_calls_response_spec.rb +70 -0
  449. data/spec/models/library_folder_spec.rb +64 -0
  450. data/spec/models/library_response_spec.rb +46 -0
  451. data/spec/models/line_error_response_spec.rb +46 -0
  452. data/spec/models/list_generic_crm_integrations_response_spec.rb +46 -0
  453. data/spec/models/list_selected_fields_response_spec.rb +46 -0
  454. data/spec/models/log_entry_spec.rb +88 -0
  455. data/spec/models/logs_response_spec.rb +52 -0
  456. data/spec/models/manual_association_response_spec.rb +52 -0
  457. data/spec/models/manual_associations_basic_data_spec.rb +58 -0
  458. data/spec/models/map_users_body_spec.rb +40 -0
  459. data/spec/models/media_spec.rb +46 -0
  460. data/spec/models/meeting_invitee_spec.rb +58 -0
  461. data/spec/models/meeting_spec.rb +40 -0
  462. data/spec/models/meetings_error_response_spec.rb +64 -0
  463. data/spec/models/monologue_spec.rb +52 -0
  464. data/spec/models/multiple_users_request_with_creation_dates_spec.rb +58 -0
  465. data/spec/models/multiple_users_with_dates_spec.rb +52 -0
  466. data/spec/models/new_call_adding_request_spec.rb +152 -0
  467. data/spec/models/new_call_adding_response_spec.rb +46 -0
  468. data/spec/models/new_call_recording_response_spec.rb +52 -0
  469. data/spec/models/new_meeting_request_spec.rb +70 -0
  470. data/spec/models/new_meeting_response_spec.rb +58 -0
  471. data/spec/models/object_entities_body_spec.rb +40 -0
  472. data/spec/models/occurrences_spec.rb +46 -0
  473. data/spec/models/party_context_field_spec.rb +46 -0
  474. data/spec/models/party_context_spec.rb +50 -0
  475. data/spec/models/party_spec.rb +102 -0
  476. data/spec/models/party_upload_context_spec.rb +50 -0
  477. data/spec/models/permission_profile_dto_spec.rb +244 -0
  478. data/spec/models/permission_profile_response_spec.rb +46 -0
  479. data/spec/models/permission_profile_users_response_spec.rb +46 -0
  480. data/spec/models/permission_profiles_response_spec.rb +46 -0
  481. data/spec/models/phone_number_references_spec.rb +82 -0
  482. data/spec/models/point_of_interest_spec.rb +58 -0
  483. data/spec/models/points_of_interest_spec.rb +40 -0
  484. data/spec/models/question_spec.rb +76 -0
  485. data/spec/models/questions_spec.rb +46 -0
  486. data/spec/models/records_spec.rb +58 -0
  487. data/spec/models/register_generic_crm_response_spec.rb +46 -0
  488. data/spec/models/request_answered_scorecards_filter_spec.rb +46 -0
  489. data/spec/models/request_calls_access_get_dto_spec.rb +40 -0
  490. data/spec/models/request_calls_filter_spec.rb +46 -0
  491. data/spec/models/request_calls_request_filter_with_owners_content_selector_spec.rb +52 -0
  492. data/spec/models/request_multiple_users_request_with_creation_dates_spec.rb +46 -0
  493. data/spec/models/request_multiple_users_with_dates_spec.rb +46 -0
  494. data/spec/models/request_status_response_spec.rb +68 -0
  495. data/spec/models/request_with_time_period_multiple_users_with_dates_spec.rb +56 -0
  496. data/spec/models/schema_update_response_spec.rb +40 -0
  497. data/spec/models/scorecard_spec.rb +82 -0
  498. data/spec/models/scorecards_spec.rb +46 -0
  499. data/spec/models/sentence_spec.rb +52 -0
  500. data/spec/models/settings_history_spec.rb +46 -0
  501. data/spec/models/settings_spec.rb +70 -0
  502. data/spec/models/sharer_spec.rb +52 -0
  503. data/spec/models/snippet_spec.rb +46 -0
  504. data/spec/models/speaker_spec.rb +52 -0
  505. data/spec/models/speakers_timeline_spec.rb +46 -0
  506. data/spec/models/specific_call_spec.rb +46 -0
  507. data/spec/models/speech_segment_spec.rb +52 -0
  508. data/spec/models/spoken_language_spec.rb +46 -0
  509. data/spec/models/structure_spec.rb +46 -0
  510. data/spec/models/topic_spec.rb +46 -0
  511. data/spec/models/tracker_phrases_spec.rb +52 -0
  512. data/spec/models/tracker_spec.rb +74 -0
  513. data/spec/models/update_meeting_request_spec.rb +70 -0
  514. data/spec/models/update_meeting_response_spec.rb +46 -0
  515. data/spec/models/user_access_details_spec.rb +40 -0
  516. data/spec/models/user_activity_spec.rb +52 -0
  517. data/spec/models/user_aggregate_by_period_activities_spec.rb +52 -0
  518. data/spec/models/user_day_by_day_activity_spec.rb +52 -0
  519. data/spec/models/user_integration_status_spec.rb +70 -0
  520. data/spec/models/user_metadata_spec.rb +124 -0
  521. data/spec/models/user_settings_history_spec.rb +56 -0
  522. data/spec/models/user_simple_metadata_spec.rb +52 -0
  523. data/spec/models/user_spec.rb +46 -0
  524. data/spec/models/users_aggregate_by_period_activity_spec.rb +52 -0
  525. data/spec/models/users_day_by_day_activity_spec.rb +52 -0
  526. data/spec/models/users_metadata_spec.rb +52 -0
  527. data/spec/models/video_spec.rb +46 -0
  528. data/spec/models/workspace_metadata_spec.rb +52 -0
  529. data/spec/models/workspaces_metadata_spec.rb +46 -0
  530. data/spec/spec_helper.rb +110 -0
  531. metadata +807 -0
@@ -0,0 +1,25 @@
1
+ # GongAPI::CallBasicData
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **client_unique_id** | **String** | The call's unique identifier in the origin recording system (typically a telephony recording system). The identifier is provided to Gong during the call creation via the Public API or through telephony systems integrations. | [optional]
7
+ **custom_data** | **String** | Metadata as was provided to Gong during the call creation via the Public API. | [optional]
8
+ **direction** | **String** | Call direction. | [optional]
9
+ **duration** | **Integer** | The duration of the call, in seconds. | [optional]
10
+ **id** | **String** | Gong's unique numeric identifier for the call (up to 20 digits). | [optional]
11
+ **is_private** | **BOOLEAN** | If the call is private. | [optional]
12
+ **language** | **String** | The language codes (as defined by ISO-639-2B). E.g., eng, fre, spa, ger, and ita. Also used are und (unsupported language), and zxx (not enough speech content for identification). | [optional]
13
+ **media** | **String** | Media type | [optional]
14
+ **meeting_url** | **String** | The meeting provider URL on which the web conference was recorded. | [optional]
15
+ **primary_user_id** | **String** | The primary user ID of the team member who hosted the call. | [optional]
16
+ **purpose** | **String** | The purpose of the call. | [optional]
17
+ **scheduled** | **String** | Scheduled date and time of the call in the ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC). | [optional]
18
+ **scope** | **String** | The scope of the call: 'internal' if all the participants are from the company, 'external' if some participants are not from the company, or 'unknown' if the scope is unknown. | [optional]
19
+ **sdr_disposition** | **String** | The SDR disposition of the call | [optional]
20
+ **started** | **String** | The date and time when the call was recorded in the ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC). | [optional]
21
+ **system** | **String** | The system with which the call was carried out (e.g., WebEx, ShoreTel, etc.). | [optional]
22
+ **title** | **String** | The title of the call. | [optional]
23
+ **url** | **String** | The URL to the page in the Gong web application where the call is available. | [optional]
24
+ **workspace_id** | **String** | Gong's unique numeric identifier for the call's workspace (up to 20 digits). | [optional]
25
+
@@ -0,0 +1,7 @@
1
+ # GongAPI::CallCollaboration
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **public_comments** | **BOOLEAN** | If true, add public comments made for this call | [optional]
7
+
@@ -0,0 +1,11 @@
1
+ # GongAPI::CallContent
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **points_of_interest** | **BOOLEAN** | If true, add call points of interest | [optional]
7
+ **structure** | **BOOLEAN** | If true, add call agenda, if available | [optional]
8
+ **topics** | **BOOLEAN** | If true, add duration of call topics | [optional]
9
+ **tracker_occurrences** | **BOOLEAN** | If true, the API will return the timing and speaker ID of each occurrence of a tracker (in addition to other tracker data). This functionality must be used in combination with the \"trackers\" field. The occurrence data is available only for the calls recorded since Jan 1, 2023, contact Gong support if a backfill of this data is required. | [optional]
10
+ **trackers** | **BOOLEAN** | If true, returns smart tracker and keyword tracker information for the call. | [optional]
11
+
@@ -0,0 +1,8 @@
1
+ # GongAPI::CallContext
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **objects** | [**Array<ExternalCallObject>**](ExternalCallObject.md) | List of objects within the external system | [optional]
7
+ **system** | **String** | External system name. e.g. Salesforce | [optional]
8
+
@@ -0,0 +1,10 @@
1
+ # GongAPI::CallInteraction
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **person_interaction_stats** | **BOOLEAN** | If true, add statistics for the host of the call. | [optional]
7
+ **questions** | **BOOLEAN** | If true, add question counts | [optional]
8
+ **speakers** | **BOOLEAN** | If true, add the time each participant spoke. | [optional]
9
+ **video** | **BOOLEAN** | If true, add video statistics | [optional]
10
+
@@ -0,0 +1,13 @@
1
+ # GongAPI::CallParticipant
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **context** | [**Array<PartyUploadContext>**](PartyUploadContext.md) | A list of links to external systems such as CRM, Telephony System, Case Management, etc. | [optional]
7
+ **email_address** | **String** | The email address of the party, if available. | [optional]
8
+ **media_channel_id** | **Integer** | The audio channel corresponding to the company team member (rep) used when the uploaded media file is multi-channel (stereo). The channel id is either 0 or 1 (representing left or right respectively) | [optional]
9
+ **name** | **String** | The name of the party, if available. | [optional]
10
+ **party_id** | **String** | An identifier that is only required when speakersTimeline is provided. The partyId is used to recognize the speakers within the provided speakersTimeline. | [optional]
11
+ **phone_number** | **String** | The phone number of the party, if available. | [optional]
12
+ **user_id** | **String** | The user ID of the participant within the Gong system, if the participant is a user. | [optional]
13
+
@@ -0,0 +1,9 @@
1
+ # GongAPI::CallReference
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **external_systems** | [**Array<ExternalSystem>**](ExternalSystem.md) | A list of links to external systems such as CRM, Telephony System, Case Management, etc. | [optional]
7
+ **id** | **String** | Gong's unique numeric identifier for the call (up to 20 digits). | [optional]
8
+ **status** | **String** | Call status | [optional]
9
+
@@ -0,0 +1,8 @@
1
+ # GongAPI::CallTranscript
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **call_id** | **String** | Gong's unique numeric identifier for the call (up to 20 digits). | [optional]
7
+ **transcript** | [**Array<Monologue>**](Monologue.md) | List of monologues. | [optional]
8
+
@@ -0,0 +1,9 @@
1
+ # GongAPI::CallTranscripts
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **call_transcripts** | [**Array<CallTranscript>**](CallTranscript.md) | A list with one entry per call. | [optional]
7
+ **records** | [**Records**](Records.md) | | [optional]
8
+ **request_id** | **String** | A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes. | [optional]
9
+
@@ -0,0 +1,8 @@
1
+ # GongAPI::CallUploadContext
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **objects** | [**Array<ExternalCrmCallObject>**](ExternalCrmCallObject.md) | List of objects within the external system. Note: Multiple opportunities/deals belonging to the same account are not supported. | [optional]
7
+ **system** | **String** | External system name. Currently only Salesforce and Generic are supported. |
8
+
@@ -0,0 +1,8 @@
1
+ # GongAPI::CallUsersAccessDto
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **call_id** | **String** | Gong's unique numeric call ID. |
7
+ **user_ids** | **Object** | Array of Gong's unique numeric user IDs. |
8
+
data/docs/Calls.md ADDED
@@ -0,0 +1,9 @@
1
+ # GongAPI::Calls
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **calls** | [**Array<Call>**](Call.md) | A list with one entry per call. | [optional]
7
+ **records** | [**Records**](Records.md) | | [optional]
8
+ **request_id** | **String** | A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes. | [optional]
9
+
@@ -0,0 +1,8 @@
1
+ # GongAPI::CallsAccessDetailsResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **call_access_list** | [**Array<CallAccessDetails>**](CallAccessDetails.md) | A list, in which each item specifies a call & users with access to this call. | [optional]
7
+ **request_id** | **String** | A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes. | [optional]
8
+
@@ -0,0 +1,7 @@
1
+ # GongAPI::CallsAccessGetDto
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **call_ids** | **Object** | Array of Gong's unique numeric call IDs. |
7
+
data/docs/CallsApi.md ADDED
@@ -0,0 +1,349 @@
1
+ # GongAPI::CallsApi
2
+
3
+ All URIs are relative to *//127.0.0.1/*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**add_call_recording_using_put**](CallsApi.md#add_call_recording_using_put) | **PUT** /v2/calls/{id}/media | Add call media (/v2/calls/{id}/media)
8
+ [**add_call_using_post**](CallsApi.md#add_call_using_post) | **POST** /v2/calls | Add new call (/v2/calls)
9
+ [**get_call_transcripts_using_post**](CallsApi.md#get_call_transcripts_using_post) | **POST** /v2/calls/transcript | Retrieve transcripts of calls by date or callIds (/v2/calls/transcript)
10
+ [**get_call_using_get**](CallsApi.md#get_call_using_get) | **GET** /v2/calls/{id} | Retrieve data for a specific call (/v2/calls/{id})
11
+ [**list_calls_extensive_using_post**](CallsApi.md#list_calls_extensive_using_post) | **POST** /v2/calls/extensive | Retrieve detailed call data by various filters (/v2/calls/extensive)
12
+ [**list_calls_using_get1**](CallsApi.md#list_calls_using_get1) | **GET** /v2/calls | Retrieve call data by date range (/v2/calls)
13
+ [**list_crm_calls_manual_association_using_get**](CallsApi.md#list_crm_calls_manual_association_using_get) | **GET** /v2/calls/manual-crm-associations | List all calls that were manually associated with CRM objects (/v2/calls/manual-crm-associations) in Beta Phase
14
+
15
+ # **add_call_recording_using_put**
16
+ > NewCallRecordingResponse add_call_recording_using_put(id, opts)
17
+
18
+ Add call media (/v2/calls/{id}/media)
19
+
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
+
22
+ ### Example
23
+ ```ruby
24
+ # load the gem
25
+ require 'gong_api'
26
+
27
+ api_instance = GongAPI::CallsApi.new
28
+ id = 'id_example' # String | callId returned from 'Add New Call' request
29
+ opts = {
30
+ media_file: 'media_file_example' # String |
31
+ }
32
+
33
+ begin
34
+ #Add call media (/v2/calls/{id}/media)
35
+ result = api_instance.add_call_recording_using_put(id, opts)
36
+ p result
37
+ rescue GongAPI::ApiError => e
38
+ puts "Exception when calling CallsApi->add_call_recording_using_put: #{e}"
39
+ end
40
+ ```
41
+
42
+ ### Parameters
43
+
44
+ Name | Type | Description | Notes
45
+ ------------- | ------------- | ------------- | -------------
46
+ **id** | **String**| callId returned from 'Add New Call' request |
47
+ **media_file** | **String**| | [optional]
48
+
49
+ ### Return type
50
+
51
+ [**NewCallRecordingResponse**](NewCallRecordingResponse.md)
52
+
53
+ ### Authorization
54
+
55
+ No authorization required
56
+
57
+ ### HTTP request headers
58
+
59
+ - **Content-Type**: multipart/form-data
60
+ - **Accept**: application/json
61
+
62
+
63
+
64
+ # **add_call_using_post**
65
+ > NewCallAddingResponse add_call_using_post(body)
66
+
67
+ Add new call (/v2/calls)
68
+
69
+ 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'.
70
+
71
+ ### Example
72
+ ```ruby
73
+ # load the gem
74
+ require 'gong_api'
75
+
76
+ api_instance = GongAPI::CallsApi.new
77
+ body = GongAPI::NewCallAddingRequest.new # NewCallAddingRequest | newCallAddingRequest
78
+
79
+
80
+ begin
81
+ #Add new call (/v2/calls)
82
+ result = api_instance.add_call_using_post(body)
83
+ p result
84
+ rescue GongAPI::ApiError => e
85
+ puts "Exception when calling CallsApi->add_call_using_post: #{e}"
86
+ end
87
+ ```
88
+
89
+ ### Parameters
90
+
91
+ Name | Type | Description | Notes
92
+ ------------- | ------------- | ------------- | -------------
93
+ **body** | [**NewCallAddingRequest**](NewCallAddingRequest.md)| newCallAddingRequest |
94
+
95
+ ### Return type
96
+
97
+ [**NewCallAddingResponse**](NewCallAddingResponse.md)
98
+
99
+ ### Authorization
100
+
101
+ No authorization required
102
+
103
+ ### HTTP request headers
104
+
105
+ - **Content-Type**: application/json
106
+ - **Accept**: application/json
107
+
108
+
109
+
110
+ # **get_call_transcripts_using_post**
111
+ > CallTranscripts get_call_transcripts_using_post(body)
112
+
113
+ Retrieve transcripts of calls by date or callIds (/v2/calls/transcript)
114
+
115
+ 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'.
116
+
117
+ ### Example
118
+ ```ruby
119
+ # load the gem
120
+ require 'gong_api'
121
+
122
+ api_instance = GongAPI::CallsApi.new
123
+ body = GongAPI::RequestCallsFilter.new # RequestCallsFilter | callsRequest
124
+
125
+
126
+ begin
127
+ #Retrieve transcripts of calls by date or callIds (/v2/calls/transcript)
128
+ result = api_instance.get_call_transcripts_using_post(body)
129
+ p result
130
+ rescue GongAPI::ApiError => e
131
+ puts "Exception when calling CallsApi->get_call_transcripts_using_post: #{e}"
132
+ end
133
+ ```
134
+
135
+ ### Parameters
136
+
137
+ Name | Type | Description | Notes
138
+ ------------- | ------------- | ------------- | -------------
139
+ **body** | [**RequestCallsFilter**](RequestCallsFilter.md)| callsRequest |
140
+
141
+ ### Return type
142
+
143
+ [**CallTranscripts**](CallTranscripts.md)
144
+
145
+ ### Authorization
146
+
147
+ No authorization required
148
+
149
+ ### HTTP request headers
150
+
151
+ - **Content-Type**: application/json
152
+ - **Accept**: application/json
153
+
154
+
155
+
156
+ # **get_call_using_get**
157
+ > SpecificCall get_call_using_get(id)
158
+
159
+ Retrieve data for a specific call (/v2/calls/{id})
160
+
161
+ Retrieve data for a specific call. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:calls:read:basic'.
162
+
163
+ ### Example
164
+ ```ruby
165
+ # load the gem
166
+ require 'gong_api'
167
+
168
+ api_instance = GongAPI::CallsApi.new
169
+ id = 'id_example' # String | Gong's unique numeric identifier for the call (up to 20 digits).
170
+
171
+
172
+ begin
173
+ #Retrieve data for a specific call (/v2/calls/{id})
174
+ result = api_instance.get_call_using_get(id)
175
+ p result
176
+ rescue GongAPI::ApiError => e
177
+ puts "Exception when calling CallsApi->get_call_using_get: #{e}"
178
+ end
179
+ ```
180
+
181
+ ### Parameters
182
+
183
+ Name | Type | Description | Notes
184
+ ------------- | ------------- | ------------- | -------------
185
+ **id** | **String**| Gong's unique numeric identifier for the call (up to 20 digits). |
186
+
187
+ ### Return type
188
+
189
+ [**SpecificCall**](SpecificCall.md)
190
+
191
+ ### Authorization
192
+
193
+ No authorization required
194
+
195
+ ### HTTP request headers
196
+
197
+ - **Content-Type**: Not defined
198
+ - **Accept**: application/json
199
+
200
+
201
+
202
+ # **list_calls_extensive_using_post**
203
+ > Calls list_calls_extensive_using_post(body)
204
+
205
+ Retrieve detailed call data by various filters (/v2/calls/extensive)
206
+
207
+ 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'.
208
+
209
+ ### Example
210
+ ```ruby
211
+ # load the gem
212
+ require 'gong_api'
213
+
214
+ api_instance = GongAPI::CallsApi.new
215
+ body = GongAPI::RequestCallsRequestFilterWithOwnersContentSelector.new # RequestCallsRequestFilterWithOwnersContentSelector | callsRequest
216
+
217
+
218
+ begin
219
+ #Retrieve detailed call data by various filters (/v2/calls/extensive)
220
+ result = api_instance.list_calls_extensive_using_post(body)
221
+ p result
222
+ rescue GongAPI::ApiError => e
223
+ puts "Exception when calling CallsApi->list_calls_extensive_using_post: #{e}"
224
+ end
225
+ ```
226
+
227
+ ### Parameters
228
+
229
+ Name | Type | Description | Notes
230
+ ------------- | ------------- | ------------- | -------------
231
+ **body** | [**RequestCallsRequestFilterWithOwnersContentSelector**](RequestCallsRequestFilterWithOwnersContentSelector.md)| callsRequest |
232
+
233
+ ### Return type
234
+
235
+ [**Calls**](Calls.md)
236
+
237
+ ### Authorization
238
+
239
+ No authorization required
240
+
241
+ ### HTTP request headers
242
+
243
+ - **Content-Type**: application/json
244
+ - **Accept**: application/json
245
+
246
+
247
+
248
+ # **list_calls_using_get1**
249
+ > CallsResponse list_calls_using_get1(from_date_time, to_date_time, opts)
250
+
251
+ Retrieve call data by date range (/v2/calls)
252
+
253
+ 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'.
254
+
255
+ ### Example
256
+ ```ruby
257
+ # load the gem
258
+ require 'gong_api'
259
+
260
+ api_instance = GongAPI::CallsApi.new
261
+ from_date_time = 'from_date_time_example' # String | 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.
262
+ to_date_time = 'to_date_time_example' # String | 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.
263
+ opts = {
264
+ cursor: 'cursor_example', # String | When paging is needed, provide the value supplied by the previous API call to bring the following page of records.
265
+ workspace_id: 'workspace_id_example' # String | Optional Workspace identifier, if supplied the API will return only the calls belonging to this workspace.
266
+ }
267
+
268
+ begin
269
+ #Retrieve call data by date range (/v2/calls)
270
+ result = api_instance.list_calls_using_get1(from_date_time, to_date_time, opts)
271
+ p result
272
+ rescue GongAPI::ApiError => e
273
+ puts "Exception when calling CallsApi->list_calls_using_get1: #{e}"
274
+ end
275
+ ```
276
+
277
+ ### Parameters
278
+
279
+ Name | Type | Description | Notes
280
+ ------------- | ------------- | ------------- | -------------
281
+ **from_date_time** | **String**| 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. |
282
+ **to_date_time** | **String**| 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. |
283
+ **cursor** | **String**| When paging is needed, provide the value supplied by the previous API call to bring the following page of records. | [optional]
284
+ **workspace_id** | **String**| Optional Workspace identifier, if supplied the API will return only the calls belonging to this workspace. | [optional]
285
+
286
+ ### Return type
287
+
288
+ [**CallsResponse**](CallsResponse.md)
289
+
290
+ ### Authorization
291
+
292
+ No authorization required
293
+
294
+ ### HTTP request headers
295
+
296
+ - **Content-Type**: Not defined
297
+ - **Accept**: application/json
298
+
299
+
300
+
301
+ # **list_crm_calls_manual_association_using_get**
302
+ > ManualAssociationResponse list_crm_calls_manual_association_using_get(opts)
303
+
304
+ List all calls that were manually associated with CRM objects (/v2/calls/manual-crm-associations) in Beta Phase
305
+
306
+ 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'.
307
+
308
+ ### Example
309
+ ```ruby
310
+ # load the gem
311
+ require 'gong_api'
312
+
313
+ api_instance = GongAPI::CallsApi.new
314
+ opts = {
315
+ cursor: 'cursor_example', # String | When paging is needed, provide the value supplied by the previous API call to bring the following page of records.
316
+ from_date_time: 'from_date_time_example' # String | 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.
317
+ }
318
+
319
+ begin
320
+ #List all calls that were manually associated with CRM objects (/v2/calls/manual-crm-associations) in Beta Phase
321
+ result = api_instance.list_crm_calls_manual_association_using_get(opts)
322
+ p result
323
+ rescue GongAPI::ApiError => e
324
+ puts "Exception when calling CallsApi->list_crm_calls_manual_association_using_get: #{e}"
325
+ end
326
+ ```
327
+
328
+ ### Parameters
329
+
330
+ Name | Type | Description | Notes
331
+ ------------- | ------------- | ------------- | -------------
332
+ **cursor** | **String**| When paging is needed, provide the value supplied by the previous API call to bring the following page of records. | [optional]
333
+ **from_date_time** | **String**| 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. | [optional]
334
+
335
+ ### Return type
336
+
337
+ [**ManualAssociationResponse**](ManualAssociationResponse.md)
338
+
339
+ ### Authorization
340
+
341
+ No authorization required
342
+
343
+ ### HTTP request headers
344
+
345
+ - **Content-Type**: Not defined
346
+ - **Accept**: application/json
347
+
348
+
349
+
@@ -0,0 +1,10 @@
1
+ # GongAPI::CallsFilter
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **call_ids** | **Object** | List of calls Ids to be filtered. If not supplied, returns all calls between fromDateTime and toDateTime. | [optional]
7
+ **from_date_time** | **String** | 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. The date applies to call start time. | [optional]
8
+ **to_date_time** | **String** | 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. The date applies to call start time. | [optional]
9
+ **workspace_id** | **String** | Optional Workspace identifier, if supplied the API will return only the calls belonging to this workspace. | [optional]
10
+
@@ -0,0 +1,11 @@
1
+ # GongAPI::CallsRequestFilterWithOwners
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **call_ids** | **Object** | List of calls Ids to be filtered. If not supplied, returns all calls between fromDateTime and toDateTime. | [optional]
7
+ **from_date_time** | **String** | 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. The date applies to call start time. | [optional]
8
+ **primary_user_ids** | **Object** | An optional list of user identifiers, if supplied the API will return only the calls hosted by the specified users. The identifiers in this field match the primaryUserId field of the calls. | [optional]
9
+ **to_date_time** | **String** | 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. The date applies to call start time. | [optional]
10
+ **workspace_id** | **String** | Optional Workspace identifier, if supplied the API will return only the calls belonging to this workspace. | [optional]
11
+
@@ -0,0 +1,9 @@
1
+ # GongAPI::CallsResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **calls** | [**Array<CallBasicData>**](CallBasicData.md) | A list, in which each item specifies one call. | [optional]
7
+ **records** | [**Records**](Records.md) | | [optional]
8
+ **request_id** | **String** | A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes. | [optional]
9
+
@@ -0,0 +1,7 @@
1
+ # GongAPI::CallsUsersAccessAddDto
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **call_access_list** | [**Array<CallUsersAccessDto>**](CallUsersAccessDto.md) | A list, in which each item specifies a call and a list of users to be given access to this call. | [optional]
7
+
@@ -0,0 +1,7 @@
1
+ # GongAPI::CallsUsersAccessDeleteDto
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **call_access_list** | [**Array<CallUsersAccessDto>**](CallUsersAccessDto.md) | A list, in which each item specifies a call and a list of users to be removed from the call. | [optional]
7
+
@@ -0,0 +1,8 @@
1
+ # GongAPI::CoachingAccessWithPermissionLevel
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **permission_level** | **String** | Permission access scope. | [optional]
7
+ **team_lead_ids** | **Array<String>** | List of user IDs to populate the managers-team permission level You can retrieve the user ids by using the “Users” API. | [optional]
8
+
@@ -0,0 +1,7 @@
1
+ # GongAPI::Collaboration
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **public_comments** | [**Array<Comment>**](Comment.md) | A list of public comments. | [optional]
7
+
data/docs/Comment.md ADDED
@@ -0,0 +1,14 @@
1
+ # GongAPI::Comment
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **audio_end_time** | **Float** | The number of seconds from the beginning of the call that the comment ends refers to. | [optional]
7
+ **audio_start_time** | **Float** | The number of seconds from the beginning of the call that the comment start refers to. | [optional]
8
+ **comment** | **String** | The comment itself. The comment may contains person tagging in this format @[user name](user Id) | [optional]
9
+ **commenter_user_id** | **String** | Unique identifier of the user who wrote the comment. | [optional]
10
+ **during_call** | **BOOLEAN** | True if the comment was written during the call, false if it was posted after the call. | [optional]
11
+ **id** | **String** | Unique identifier of the comment within the Gong's system. | [optional]
12
+ **in_reply_to** | **String** | The unique identifier of the original comment in case the current comment is a reply to the original one. | [optional]
13
+ **posted** | **String** | The date and time in the ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC); in which the comment was posted. | [optional]
14
+
@@ -0,0 +1,12 @@
1
+ # GongAPI::CompanyUsersAggregateActivityResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **from_date_time** | **String** | The date and time in the ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC), when the list of results starts. | [optional]
7
+ **records** | [**Records**](Records.md) | | [optional]
8
+ **request_id** | **String** | A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes. | [optional]
9
+ **time_zone** | **String** | The company's defined timezone in Gong. | [optional]
10
+ **to_date_time** | **String** | The date and time in the ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC), when the list of results ends. | [optional]
11
+ **users_aggregate_activity_stats** | [**Array<UserActivity>**](UserActivity.md) | A list, in which each item specifies one user's activities. | [optional]
12
+
@@ -0,0 +1,12 @@
1
+ # GongAPI::CompanyUsersIntercationStatsResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **from_date_time** | **String** | The date and time in the ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC), when the list of results starts. | [optional]
7
+ **people_interaction_stats** | [**Array<InteractionStats>**](InteractionStats.md) | A list of interaction statistics. Applicable values: 'Longest Monologue', 'Longest Customer Story', 'Interactivity', 'Patience', 'Question Rate'. | [optional]
8
+ **records** | [**Records**](Records.md) | | [optional]
9
+ **request_id** | **String** | A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes. | [optional]
10
+ **time_zone** | **String** | The company's defined timezone in Gong. | [optional]
11
+ **to_date_time** | **String** | The date and time in the ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC), when the list of results ends. | [optional]
12
+
data/docs/Content.md ADDED
@@ -0,0 +1,10 @@
1
+ # GongAPI::Content
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **points_of_interest** | [**PointsOfInterest**](PointsOfInterest.md) | | [optional]
7
+ **structure** | [**Array<Structure>**](Structure.md) | A list of the agenda of each part of the call. | [optional]
8
+ **topics** | [**Array<Topic>**](Topic.md) | A list of topics and their durations. | [optional]
9
+ **trackers** | [**Array<Tracker>**](Tracker.md) | A list of trackers found in the call. Trackers are collections of phrases defined in Gong for this company. | [optional]
10
+
@@ -0,0 +1,9 @@
1
+ # GongAPI::ContentSelector
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **context** | **String** | If 'Basic', add links to external systems (context objects) such as CRM, Telephony System, Case Management. If 'Extended' include also data (context fields) for these links. Default value 'None' | [optional]
7
+ **context_timing** | **Array<String>** | Timing for the context data. The field is optional and can contain either \"Now\" or \"TimeOfCall\" or both. The default value is [\"Now\"]. Can be provided only when the context field is set to 'Extended' | [optional]
8
+ **exposed_fields** | [**ExposedFields**](ExposedFields.md) | | [optional]
9
+