purecloud 0.67.1 → 0.68.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (424) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +3 -3
  3. data/bin/notificationMappings.json +4 -4
  4. data/config-ruby.json +1 -1
  5. data/doc_out/ActivityCode.html.md +20 -0
  6. data/doc_out/ActivityCodeContainer.html.md +13 -0
  7. data/doc_out/AgentActivityEntityListing.html.md +2 -2
  8. data/doc_out/AlertingApi.html.md +137 -35
  9. data/doc_out/AnalyticsApi.html.md +89 -23
  10. data/doc_out/AttemptLimitsEntityListing.html.md +2 -2
  11. data/doc_out/AttemptLimitsNotification.html.md +2 -1
  12. data/doc_out/AttributeEntityListing.html.md +2 -2
  13. data/doc_out/AttributesApi.html.md +25 -7
  14. data/doc_out/AuthorizationApi.html.md +69 -18
  15. data/doc_out/CalibrationEntityListing.html.md +2 -2
  16. data/doc_out/CallConversationEntityListing.html.md +2 -2
  17. data/doc_out/CallConversationNotificationCallMediaParticipant.html.md +1 -1
  18. data/doc_out/CallConversationNotificationParticipants.html.md +1 -1
  19. data/doc_out/CallableTimeSetEntityListing.html.md +2 -2
  20. data/doc_out/CallableTimeSetNotification.html.md +1 -1
  21. data/doc_out/CallbackConversationEntityListing.html.md +2 -2
  22. data/doc_out/CallbackConversationNotificationCallbackMediaParticipant.html.md +1 -1
  23. data/doc_out/CallbackConversationNotificationParticipants.html.md +1 -1
  24. data/doc_out/CampaignEntityListing.html.md +2 -2
  25. data/doc_out/CampaignNotification.html.md +2 -2
  26. data/doc_out/{CampaignNotificationError.html.md → CampaignNotificationRestErrorDetail.html.md} +2 -2
  27. data/doc_out/CampaignProgressNotification.html.md +1 -1
  28. data/doc_out/CampaignRuleEntityListing.html.md +2 -2
  29. data/doc_out/CampaignRuleNotification.html.md +1 -1
  30. data/doc_out/CampaignRuleNotificationCampaignRuleActionEntities.html.md +2 -2
  31. data/doc_out/CampaignRuleNotificationCampaignRuleEntities.html.md +2 -3
  32. data/doc_out/CampaignRuleNotificationUriReference.html.md +14 -0
  33. data/doc_out/CampaignScheduleNotification.html.md +2 -2
  34. data/doc_out/CampaignSequenceEntityListing.html.md +2 -2
  35. data/doc_out/CampaignSequenceNotification.html.md +2 -2
  36. data/doc_out/CertificateAuthorityEntityListing.html.md +2 -2
  37. data/doc_out/ChannelEntityListing.html.md +2 -2
  38. data/doc_out/ChatConversationEntityListing.html.md +2 -2
  39. data/doc_out/ChatConversationNotificationChatMediaParticipant.html.md +1 -1
  40. data/doc_out/ChatConversationNotificationParticipants.html.md +1 -1
  41. data/doc_out/CobrowseConversationEntityListing.html.md +2 -2
  42. data/doc_out/CobrowseConversationNotificationCobrowseMediaParticipant.html.md +1 -1
  43. data/doc_out/CobrowseConversationNotificationParticipants.html.md +1 -1
  44. data/doc_out/CommandStatusEntityListing.html.md +2 -2
  45. data/doc_out/ContactListEntityListing.html.md +2 -2
  46. data/doc_out/ContactListNotification.html.md +2 -2
  47. data/doc_out/{ContactListNotificationPhoneColumn_.html.md → ContactListNotificationContactPhoneNumberColumn.html.md} +2 -2
  48. data/doc_out/ContentManagementApi.html.md +153 -39
  49. data/doc_out/ConversationEntityListing.html.md +2 -2
  50. data/doc_out/ConversationsApi.html.md +421 -76
  51. data/doc_out/CreateEmailRequest.html.md +23 -0
  52. data/doc_out/CreateWebChatRequest.html.md +19 -0
  53. data/doc_out/DIDEntityListing.html.md +2 -2
  54. data/doc_out/DIDPoolEntityListing.html.md +2 -2
  55. data/doc_out/DecisionsFileMetadataEntityListing.html.md +2 -2
  56. data/doc_out/DncListEntityListing.html.md +2 -2
  57. data/doc_out/DncListNotification.html.md +1 -1
  58. data/doc_out/DocumentAuditEntityListing.html.md +2 -2
  59. data/doc_out/DocumentDataV2Notification.html.md +26 -0
  60. data/doc_out/{RecordingDataNotificationUserData.html.md → DocumentDataV2NotificationCreatedBy.html.md} +2 -2
  61. data/doc_out/DocumentDataV2NotificationLockData.html.md +15 -0
  62. data/doc_out/DocumentDataV2NotificationLockInfo.html.md +15 -0
  63. data/doc_out/{DocumentDataNotificationUserData.html.md → DocumentDataV2NotificationUserData.html.md} +2 -2
  64. data/doc_out/{DocumentDataNotificationWorkspace.html.md → DocumentDataV2NotificationWorkspace.html.md} +2 -2
  65. data/doc_out/{DocumentDataNotificationWorkspaceData.html.md → DocumentDataV2NotificationWorkspaceData.html.md} +2 -2
  66. data/doc_out/DocumentEntityListing.html.md +2 -2
  67. data/doc_out/DomainEdgeSoftwareVersionDtoEntityListing.html.md +2 -2
  68. data/doc_out/DomainEntityListing.html.md +2 -2
  69. data/doc_out/DomainEntityListingEvaluationForm.html.md +2 -2
  70. data/doc_out/DomainEntityListingQueryResult.html.md +2 -2
  71. data/doc_out/DomainOrganizationRole.html.md +1 -1
  72. data/doc_out/DomainOrganizationRoleCreate.html.md +1 -1
  73. data/doc_out/DomainOrganizationRoleUpdate.html.md +1 -1
  74. data/doc_out/EdgeEntityListing.html.md +2 -2
  75. data/doc_out/EdgeGroupEntityListing.html.md +2 -2
  76. data/doc_out/EdgeLineEntityListing.html.md +2 -2
  77. data/doc_out/EdgeRebootParameters.html.md +13 -0
  78. data/doc_out/EmailConversationEntityListing.html.md +2 -2
  79. data/doc_out/EmailConversationNotificationEmailMediaParticipant.html.md +1 -1
  80. data/doc_out/EmailConversationNotificationParticipants.html.md +1 -1
  81. data/doc_out/EmailMessageListing.html.md +2 -2
  82. data/doc_out/EncryptionKeyEntityListing.html.md +2 -2
  83. data/doc_out/EndpointEntityListing.html.md +2 -2
  84. data/doc_out/Entry.html.md +2 -2
  85. data/doc_out/EntryFeatureBoolean.html.md +14 -0
  86. data/doc_out/EvaluationEntityListing.html.md +2 -2
  87. data/doc_out/EvaluationFormEntityListing.html.md +2 -2
  88. data/doc_out/EvaluatorActivityEntityListing.html.md +2 -2
  89. data/doc_out/ExtensionEntityListing.html.md +2 -2
  90. data/doc_out/ExtensionPoolEntityListing.html.md +2 -2
  91. data/doc_out/FaxApi.html.md +25 -7
  92. data/doc_out/FaxDataV2Notification.html.md +29 -0
  93. data/doc_out/FaxDataV2NotificationLockData.html.md +15 -0
  94. data/doc_out/FaxDataV2NotificationLockInfo.html.md +15 -0
  95. data/doc_out/{FaxDataNotificationUserData.html.md → FaxDataV2NotificationUserData.html.md} +2 -2
  96. data/doc_out/{FaxDataNotificationWorkspaceData.html.md → FaxDataV2NotificationWorkspaceData.html.md} +2 -2
  97. data/doc_out/FaxDocumentEntityListing.html.md +2 -2
  98. data/doc_out/GeolocationApi.html.md +17 -5
  99. data/doc_out/GreetingListing.html.md +2 -2
  100. data/doc_out/GreetingsApi.html.md +65 -17
  101. data/doc_out/GroupEntityListing.html.md +2 -2
  102. data/doc_out/GroupsApi.html.md +45 -12
  103. data/doc_out/HeartBeatAlertContainer.html.md +2 -2
  104. data/doc_out/HeartBeatRuleContainer.html.md +2 -2
  105. data/doc_out/IdentityProviderApi.html.md +89 -23
  106. data/doc_out/InboundDomainEntityListing.html.md +2 -2
  107. data/doc_out/InboundRouteEntityListing.html.md +2 -2
  108. data/doc_out/InteractionStatsAlertContainer.html.md +2 -2
  109. data/doc_out/InteractionStatsRuleContainer.html.md +2 -2
  110. data/doc_out/JsonNode.html.md +2 -2
  111. data/doc_out/KeywordSetEntityListing.html.md +2 -2
  112. data/doc_out/LanguageEntityListing.html.md +2 -2
  113. data/doc_out/LanguagesApi.html.md +41 -11
  114. data/doc_out/LibraryEntityListing.html.md +2 -2
  115. data/doc_out/LineBaseEntityListing.html.md +2 -2
  116. data/doc_out/LineEntityListing.html.md +2 -2
  117. data/doc_out/LocalEncryptionConfigurationListing.html.md +2 -2
  118. data/doc_out/LocationsApi.html.md +17 -5
  119. data/doc_out/LogicalInterfaceEntityListing.html.md +2 -2
  120. data/doc_out/NotificationsApi.html.md +29 -8
  121. data/doc_out/OAuthApi.html.md +25 -7
  122. data/doc_out/OAuthClientEntityListing.html.md +2 -2
  123. data/doc_out/OAuthProviderEntityListing.html.md +2 -2
  124. data/doc_out/Organization.html.md +1 -0
  125. data/doc_out/OrganizationApi.html.md +70 -3
  126. data/doc_out/OrganizationPresenceEntityListing.html.md +2 -2
  127. data/doc_out/OrganizationRoleEntityListing.html.md +2 -2
  128. data/doc_out/OrphanRecordingListing.html.md +2 -2
  129. data/doc_out/OutOfOfficeNotification.html.md +1 -1
  130. data/doc_out/OutboundApi.html.md +323 -95
  131. data/doc_out/OutboundRouteBaseEntityListing.html.md +2 -2
  132. data/doc_out/OutboundRouteEntityListing.html.md +2 -2
  133. data/doc_out/PermissionCollectionEntityListing.html.md +2 -2
  134. data/doc_out/PhoneBaseEntityListing.html.md +2 -2
  135. data/doc_out/PhoneEntityListing.html.md +2 -2
  136. data/doc_out/PhoneMetaBaseEntityListing.html.md +2 -2
  137. data/doc_out/PhysicalInterfaceEntityListing.html.md +2 -2
  138. data/doc_out/PolicyEntityListing.html.md +2 -2
  139. data/doc_out/PresenceApi.html.md +33 -9
  140. data/doc_out/QualityApi.html.md +128 -33
  141. data/doc_out/QualityAuditPage.html.md +2 -2
  142. data/doc_out/QueueEntityListing.html.md +2 -2
  143. data/doc_out/QueueMemberEntityListing.html.md +2 -2
  144. data/doc_out/RecordingApi.html.md +133 -34
  145. data/doc_out/RecordingDataV2Notification.html.md +29 -0
  146. data/doc_out/{RecordingDataNotificationConversationData.html.md → RecordingDataV2NotificationConversationData.html.md} +2 -2
  147. data/doc_out/RecordingDataV2NotificationLockData.html.md +15 -0
  148. data/doc_out/RecordingDataV2NotificationLockInfo.html.md +15 -0
  149. data/doc_out/{DocumentDataNotificationCreatedBy.html.md → RecordingDataV2NotificationUserData.html.md} +2 -2
  150. data/doc_out/{RecordingDataNotificationWorkspaceData.html.md → RecordingDataV2NotificationWorkspaceData.html.md} +2 -2
  151. data/doc_out/ReportMetaDataEntityListing.html.md +2 -2
  152. data/doc_out/ReportRunEntryEntityDomainListing.html.md +2 -2
  153. data/doc_out/ReportScheduleEntityListing.html.md +2 -2
  154. data/doc_out/ResponseEntityList.html.md +2 -2
  155. data/doc_out/ResponseEntityListing.html.md +2 -2
  156. data/doc_out/ResponseManagementApi.html.md +45 -12
  157. data/doc_out/ResponseSetEntityListing.html.md +2 -2
  158. data/doc_out/ResponseSetNotification.html.md +1 -1
  159. data/doc_out/RoutingApi.html.md +193 -49
  160. data/doc_out/RoutingStatusAlertContainer.html.md +2 -2
  161. data/doc_out/RoutingStatusRuleContainer.html.md +2 -2
  162. data/doc_out/RuleSetEntityListing.html.md +2 -2
  163. data/doc_out/RuleSetNotification.html.md +1 -1
  164. data/doc_out/RuleSetNotificationCondition.html.md +1 -1
  165. data/doc_out/RuleSetNotificationConditions.html.md +1 -1
  166. data/doc_out/SchemaCategoryEntityListing.html.md +2 -2
  167. data/doc_out/SchemaReferenceEntityListing.html.md +2 -2
  168. data/doc_out/ScreenRecordingSessionListing.html.md +2 -2
  169. data/doc_out/ScreenShareConversationNotificationParticipants.html.md +1 -1
  170. data/doc_out/ScreenShareConversationNotificationScreenShareMediaParticipant.html.md +1 -1
  171. data/doc_out/ScriptEntityListing.html.md +2 -2
  172. data/doc_out/ScriptsApi.html.md +37 -10
  173. data/doc_out/SearchApi.html.md +49 -13
  174. data/doc_out/SecurityProfileEntityListing.html.md +2 -2
  175. data/doc_out/SequenceScheduleNotification.html.md +2 -2
  176. data/doc_out/ShareEntityListing.html.md +2 -2
  177. data/doc_out/SiteEntityListing.html.md +2 -2
  178. data/doc_out/SkillEntityListing.html.md +2 -2
  179. data/doc_out/SocialConversationNotificationParticipants.html.md +1 -1
  180. data/doc_out/SocialConversationNotificationSocialMediaParticipant.html.md +1 -1
  181. data/doc_out/StationEntityListing.html.md +2 -2
  182. data/doc_out/StationsApi.html.md +13 -4
  183. data/doc_out/SuggestApi.html.md +17 -5
  184. data/doc_out/TagValueEntityListing.html.md +2 -2
  185. data/doc_out/TelephonyProvidersEdgeApi.html.md +479 -121
  186. data/doc_out/TimeZoneEntityListing.html.md +2 -2
  187. data/doc_out/TokensApi.html.md +5 -2
  188. data/doc_out/TrunkBaseEntityListing.html.md +2 -2
  189. data/doc_out/TrunkEntityListing.html.md +2 -2
  190. data/doc_out/TrunkMetabaseEntityListing.html.md +2 -2
  191. data/doc_out/UserEntityListing.html.md +2 -2
  192. data/doc_out/UserListScheduleRequestBody.html.md +15 -0
  193. data/doc_out/UserPresenceAlertContainer.html.md +2 -2
  194. data/doc_out/UserPresenceRuleContainer.html.md +2 -2
  195. data/doc_out/UserQueueEntityListing.html.md +2 -2
  196. data/doc_out/UserRecordingEntityListing.html.md +2 -2
  197. data/doc_out/UserRecordingsApi.html.md +25 -7
  198. data/doc_out/UserSchedule.html.md +14 -0
  199. data/doc_out/UserScheduleActivity.html.md +18 -0
  200. data/doc_out/UserScheduleContainer.html.md +14 -0
  201. data/doc_out/UserScheduleFullDayTimeOffMarker.html.md +17 -0
  202. data/doc_out/UserScheduleShift.html.md +15 -0
  203. data/doc_out/UserSkillEntityListing.html.md +2 -2
  204. data/doc_out/UsersApi.html.md +169 -43
  205. data/doc_out/UtilitiesApi.html.md +13 -4
  206. data/doc_out/VideoConversationNotificationParticipants.html.md +1 -1
  207. data/doc_out/VideoConversationNotificationVideoMediaParticipant.html.md +1 -1
  208. data/doc_out/VoicemailApi.html.md +89 -23
  209. data/doc_out/VoicemailMessageEntityListing.html.md +2 -2
  210. data/doc_out/WfmUserEntityListing.html.md +13 -0
  211. data/doc_out/WorkforceManagementApi.html.md +227 -13
  212. data/doc_out/WorkspaceEntityListing.html.md +2 -2
  213. data/doc_out/WorkspaceMemberEntityListing.html.md +2 -2
  214. data/doc_out/WrapUpCodeMappingNotification.html.md +0 -1
  215. data/doc_out/WrapupCodeEntityListing.html.md +2 -2
  216. data/doc_out/index.html.md +3 -3
  217. data/lib/purecloud.rb +34 -20
  218. data/lib/purecloud/api/conversations_api.rb +120 -0
  219. data/lib/purecloud/api/organization_api.rb +57 -0
  220. data/lib/purecloud/api/outbound_api.rb +9 -9
  221. data/lib/purecloud/api/quality_api.rb +7 -0
  222. data/lib/purecloud/api/telephony_providers_edge_api.rb +3 -1
  223. data/lib/purecloud/api/workforce_management_api.rb +185 -3
  224. data/lib/purecloud/api_client.rb +1 -1
  225. data/lib/purecloud/models/activity_code.rb +253 -0
  226. data/lib/purecloud/models/activity_code_container.rb +169 -0
  227. data/lib/purecloud/models/agent_activity_entity_listing.rb +17 -17
  228. data/lib/purecloud/models/attempt_limits_entity_listing.rb +17 -17
  229. data/lib/purecloud/models/attempt_limits_notification.rb +24 -14
  230. data/lib/purecloud/models/attribute_entity_listing.rb +17 -17
  231. data/lib/purecloud/models/calibration_entity_listing.rb +17 -17
  232. data/lib/purecloud/models/call_conversation_entity_listing.rb +17 -17
  233. data/lib/purecloud/models/call_conversation_notification_call_media_participant.rb +1 -1
  234. data/lib/purecloud/models/call_conversation_notification_participants.rb +1 -1
  235. data/lib/purecloud/models/callable_time_set_entity_listing.rb +17 -17
  236. data/lib/purecloud/models/callable_time_set_notification.rb +13 -13
  237. data/lib/purecloud/models/callback_conversation_entity_listing.rb +17 -17
  238. data/lib/purecloud/models/callback_conversation_notification_callback_media_participant.rb +1 -1
  239. data/lib/purecloud/models/callback_conversation_notification_participants.rb +1 -1
  240. data/lib/purecloud/models/campaign_entity_listing.rb +17 -17
  241. data/lib/purecloud/models/campaign_notification.rb +15 -15
  242. data/lib/purecloud/models/{campaign_notification_error.rb → campaign_notification_rest_error_detail.rb} +1 -1
  243. data/lib/purecloud/models/campaign_progress_notification.rb +1 -1
  244. data/lib/purecloud/models/campaign_rule_entity_listing.rb +17 -17
  245. data/lib/purecloud/models/campaign_rule_notification.rb +14 -14
  246. data/lib/purecloud/models/campaign_rule_notification_campaign_rule_action_entities.rb +2 -2
  247. data/lib/purecloud/models/campaign_rule_notification_campaign_rule_entities.rb +3 -13
  248. data/lib/purecloud/models/campaign_rule_notification_uri_reference.rb +175 -0
  249. data/lib/purecloud/models/campaign_schedule_notification.rb +14 -14
  250. data/lib/purecloud/models/campaign_sequence_entity_listing.rb +17 -17
  251. data/lib/purecloud/models/campaign_sequence_notification.rb +15 -15
  252. data/lib/purecloud/models/certificate_authority_entity_listing.rb +17 -17
  253. data/lib/purecloud/models/channel_entity_listing.rb +17 -17
  254. data/lib/purecloud/models/chat_conversation_entity_listing.rb +17 -17
  255. data/lib/purecloud/models/chat_conversation_notification_chat_media_participant.rb +1 -1
  256. data/lib/purecloud/models/chat_conversation_notification_participants.rb +1 -1
  257. data/lib/purecloud/models/cobrowse_conversation_entity_listing.rb +17 -17
  258. data/lib/purecloud/models/cobrowse_conversation_notification_cobrowse_media_participant.rb +1 -1
  259. data/lib/purecloud/models/cobrowse_conversation_notification_participants.rb +1 -1
  260. data/lib/purecloud/models/command_status_entity_listing.rb +17 -17
  261. data/lib/purecloud/models/contact_list_entity_listing.rb +17 -17
  262. data/lib/purecloud/models/contact_list_notification.rb +14 -14
  263. data/lib/purecloud/models/{contact_list_notification_phone_column_.rb → contact_list_notification_contact_phone_number_column.rb} +1 -1
  264. data/lib/purecloud/models/contact_list_notification_import_status.rb +1 -1
  265. data/lib/purecloud/models/conversation_entity_listing.rb +17 -17
  266. data/lib/purecloud/models/create_email_request.rb +280 -0
  267. data/lib/purecloud/models/create_web_chat_request.rb +236 -0
  268. data/lib/purecloud/models/decisions_file_metadata_entity_listing.rb +17 -17
  269. data/lib/purecloud/models/did_entity_listing.rb +17 -17
  270. data/lib/purecloud/models/did_pool_entity_listing.rb +17 -17
  271. data/lib/purecloud/models/dnc_list_entity_listing.rb +17 -17
  272. data/lib/purecloud/models/dnc_list_notification.rb +14 -14
  273. data/lib/purecloud/models/dnc_list_notification_import_status.rb +1 -1
  274. data/lib/purecloud/models/document_audit_entity_listing.rb +17 -17
  275. data/lib/purecloud/models/{document_data_notification.rb → document_data_v2_notification.rb} +9 -29
  276. data/lib/purecloud/models/{recording_data_notification_user_data.rb → document_data_v2_notification_created_by.rb} +1 -1
  277. data/lib/purecloud/models/{document_data_notification_lock_info.rb → document_data_v2_notification_lock_data.rb} +4 -4
  278. data/lib/purecloud/models/{document_data_notification_lock_data.rb → document_data_v2_notification_lock_info.rb} +4 -4
  279. data/lib/purecloud/models/{document_data_notification_user_data.rb → document_data_v2_notification_user_data.rb} +1 -1
  280. data/lib/purecloud/models/{document_data_notification_workspace.rb → document_data_v2_notification_workspace.rb} +1 -1
  281. data/lib/purecloud/models/{document_data_notification_workspace_data.rb → document_data_v2_notification_workspace_data.rb} +1 -1
  282. data/lib/purecloud/models/document_entity_listing.rb +17 -17
  283. data/lib/purecloud/models/domain_edge_software_version_dto_entity_listing.rb +17 -17
  284. data/lib/purecloud/models/domain_entity_listing.rb +17 -17
  285. data/lib/purecloud/models/domain_entity_listing_evaluation_form.rb +17 -17
  286. data/lib/purecloud/models/domain_entity_listing_query_result.rb +17 -17
  287. data/lib/purecloud/models/domain_organization_role.rb +11 -11
  288. data/lib/purecloud/models/domain_organization_role_create.rb +11 -11
  289. data/lib/purecloud/models/domain_organization_role_update.rb +11 -11
  290. data/lib/purecloud/models/edge_entity_listing.rb +17 -17
  291. data/lib/purecloud/models/edge_group_entity_listing.rb +17 -17
  292. data/lib/purecloud/models/edge_line_entity_listing.rb +17 -17
  293. data/lib/purecloud/models/edge_reboot_parameters.rb +166 -0
  294. data/lib/purecloud/models/email_conversation_entity_listing.rb +17 -17
  295. data/lib/purecloud/models/email_conversation_notification_email_media_participant.rb +1 -1
  296. data/lib/purecloud/models/email_conversation_notification_participants.rb +1 -1
  297. data/lib/purecloud/models/email_message_listing.rb +17 -17
  298. data/lib/purecloud/models/encryption_key_entity_listing.rb +17 -17
  299. data/lib/purecloud/models/endpoint_entity_listing.rb +17 -17
  300. data/lib/purecloud/models/entry.rb +8 -10
  301. data/lib/purecloud/models/entry_feature_boolean.rb +184 -0
  302. data/lib/purecloud/models/evaluation_entity_listing.rb +17 -17
  303. data/lib/purecloud/models/evaluation_form_entity_listing.rb +17 -17
  304. data/lib/purecloud/models/evaluator_activity_entity_listing.rb +17 -17
  305. data/lib/purecloud/models/extension_entity_listing.rb +17 -17
  306. data/lib/purecloud/models/extension_pool_entity_listing.rb +17 -17
  307. data/lib/purecloud/models/{fax_data_notification.rb → fax_data_v2_notification.rb} +9 -29
  308. data/lib/purecloud/models/{fax_data_notification_lock_info.rb → fax_data_v2_notification_lock_data.rb} +4 -4
  309. data/lib/purecloud/models/{fax_data_notification_lock_data.rb → fax_data_v2_notification_lock_info.rb} +4 -4
  310. data/lib/purecloud/models/{fax_data_notification_user_data.rb → fax_data_v2_notification_user_data.rb} +1 -1
  311. data/lib/purecloud/models/{fax_data_notification_workspace_data.rb → fax_data_v2_notification_workspace_data.rb} +1 -1
  312. data/lib/purecloud/models/fax_document_entity_listing.rb +17 -17
  313. data/lib/purecloud/models/greeting_listing.rb +17 -17
  314. data/lib/purecloud/models/group_entity_listing.rb +17 -17
  315. data/lib/purecloud/models/heart_beat_alert_container.rb +17 -17
  316. data/lib/purecloud/models/heart_beat_rule_container.rb +17 -17
  317. data/lib/purecloud/models/import_status_notification.rb +1 -1
  318. data/lib/purecloud/models/inbound_domain_entity_listing.rb +17 -17
  319. data/lib/purecloud/models/inbound_route_entity_listing.rb +17 -17
  320. data/lib/purecloud/models/interaction_stats_alert_container.rb +17 -17
  321. data/lib/purecloud/models/interaction_stats_rule_container.rb +17 -17
  322. data/lib/purecloud/models/json_node.rb +24 -24
  323. data/lib/purecloud/models/keyword_set_entity_listing.rb +17 -17
  324. data/lib/purecloud/models/language_entity_listing.rb +17 -17
  325. data/lib/purecloud/models/library_entity_listing.rb +17 -17
  326. data/lib/purecloud/models/line_base_entity_listing.rb +17 -17
  327. data/lib/purecloud/models/line_entity_listing.rb +17 -17
  328. data/lib/purecloud/models/local_encryption_configuration_listing.rb +17 -17
  329. data/lib/purecloud/models/logical_interface_entity_listing.rb +17 -17
  330. data/lib/purecloud/models/o_auth_client_entity_listing.rb +17 -17
  331. data/lib/purecloud/models/o_auth_provider_entity_listing.rb +17 -17
  332. data/lib/purecloud/models/organization.rb +17 -4
  333. data/lib/purecloud/models/organization_presence_entity_listing.rb +17 -17
  334. data/lib/purecloud/models/organization_role_entity_listing.rb +17 -17
  335. data/lib/purecloud/models/orphan_recording_listing.rb +17 -17
  336. data/lib/purecloud/models/out_of_office_notification.rb +1 -1
  337. data/lib/purecloud/models/outbound_route_base_entity_listing.rb +17 -17
  338. data/lib/purecloud/models/outbound_route_entity_listing.rb +17 -17
  339. data/lib/purecloud/models/permission_collection_entity_listing.rb +17 -17
  340. data/lib/purecloud/models/phone_base_entity_listing.rb +17 -17
  341. data/lib/purecloud/models/phone_entity_listing.rb +17 -17
  342. data/lib/purecloud/models/phone_meta_base_entity_listing.rb +17 -17
  343. data/lib/purecloud/models/physical_interface_entity_listing.rb +17 -17
  344. data/lib/purecloud/models/policy_entity_listing.rb +17 -17
  345. data/lib/purecloud/models/quality_audit_page.rb +17 -17
  346. data/lib/purecloud/models/queue_entity_listing.rb +17 -17
  347. data/lib/purecloud/models/queue_member_entity_listing.rb +17 -17
  348. data/lib/purecloud/models/{recording_data_notification.rb → recording_data_v2_notification.rb} +10 -30
  349. data/lib/purecloud/models/{recording_data_notification_conversation_data.rb → recording_data_v2_notification_conversation_data.rb} +1 -1
  350. data/lib/purecloud/models/recording_data_v2_notification_lock_data.rb +185 -0
  351. data/lib/purecloud/models/recording_data_v2_notification_lock_info.rb +185 -0
  352. data/lib/purecloud/models/{document_data_notification_created_by.rb → recording_data_v2_notification_user_data.rb} +1 -1
  353. data/lib/purecloud/models/{recording_data_notification_workspace_data.rb → recording_data_v2_notification_workspace_data.rb} +1 -1
  354. data/lib/purecloud/models/report_meta_data_entity_listing.rb +17 -17
  355. data/lib/purecloud/models/report_run_entry_entity_domain_listing.rb +17 -17
  356. data/lib/purecloud/models/report_schedule_entity_listing.rb +17 -17
  357. data/lib/purecloud/models/response_entity_list.rb +17 -17
  358. data/lib/purecloud/models/response_entity_listing.rb +17 -17
  359. data/lib/purecloud/models/response_set_entity_listing.rb +17 -17
  360. data/lib/purecloud/models/response_set_notification.rb +13 -13
  361. data/lib/purecloud/models/routing_status_alert_container.rb +17 -17
  362. data/lib/purecloud/models/routing_status_rule_container.rb +17 -17
  363. data/lib/purecloud/models/rule_set_entity_listing.rb +17 -17
  364. data/lib/purecloud/models/rule_set_notification.rb +1 -1
  365. data/lib/purecloud/models/rule_set_notification_condition.rb +11 -11
  366. data/lib/purecloud/models/rule_set_notification_conditions.rb +18 -18
  367. data/lib/purecloud/models/rule_set_notification_rule.rb +9 -0
  368. data/lib/purecloud/models/rule_set_notification_rules.rb +9 -0
  369. data/lib/purecloud/models/schema_category_entity_listing.rb +17 -17
  370. data/lib/purecloud/models/schema_reference_entity_listing.rb +17 -17
  371. data/lib/purecloud/models/screen_recording_session_listing.rb +17 -17
  372. data/lib/purecloud/models/screen_share_conversation_notification_participants.rb +1 -1
  373. data/lib/purecloud/models/screen_share_conversation_notification_screen_share_media_participant.rb +1 -1
  374. data/lib/purecloud/models/script_entity_listing.rb +17 -17
  375. data/lib/purecloud/models/security_profile_entity_listing.rb +17 -17
  376. data/lib/purecloud/models/sequence_schedule_notification.rb +14 -14
  377. data/lib/purecloud/models/share_entity_listing.rb +17 -17
  378. data/lib/purecloud/models/site_entity_listing.rb +17 -17
  379. data/lib/purecloud/models/skill_entity_listing.rb +17 -17
  380. data/lib/purecloud/models/social_conversation_notification_participants.rb +1 -1
  381. data/lib/purecloud/models/social_conversation_notification_social_media_participant.rb +1 -1
  382. data/lib/purecloud/models/station_entity_listing.rb +17 -17
  383. data/lib/purecloud/models/tag_value_entity_listing.rb +17 -17
  384. data/lib/purecloud/models/time_zone_entity_listing.rb +17 -17
  385. data/lib/purecloud/models/trunk_base_entity_listing.rb +17 -17
  386. data/lib/purecloud/models/trunk_entity_listing.rb +17 -17
  387. data/lib/purecloud/models/trunk_metabase_entity_listing.rb +17 -17
  388. data/lib/purecloud/models/user_entity_listing.rb +17 -17
  389. data/lib/purecloud/models/user_list_schedule_request_body.rb +191 -0
  390. data/lib/purecloud/models/user_presence_alert_container.rb +17 -17
  391. data/lib/purecloud/models/user_presence_rule_container.rb +17 -17
  392. data/lib/purecloud/models/user_queue_entity_listing.rb +17 -17
  393. data/lib/purecloud/models/user_recording_entity_listing.rb +17 -17
  394. data/lib/purecloud/models/user_schedule.rb +182 -0
  395. data/lib/purecloud/models/user_schedule_activity.rb +222 -0
  396. data/lib/purecloud/models/user_schedule_container.rb +180 -0
  397. data/lib/purecloud/models/user_schedule_full_day_time_off_marker.rb +211 -0
  398. data/lib/purecloud/models/user_schedule_shift.rb +191 -0
  399. data/lib/purecloud/models/user_skill_entity_listing.rb +17 -17
  400. data/lib/purecloud/models/video_conversation_notification_participants.rb +1 -1
  401. data/lib/purecloud/models/video_conversation_notification_video_media_participant.rb +1 -1
  402. data/lib/purecloud/models/voicemail_message_entity_listing.rb +17 -17
  403. data/lib/purecloud/models/wfm_user_entity_listing.rb +167 -0
  404. data/lib/purecloud/models/workspace_entity_listing.rb +17 -17
  405. data/lib/purecloud/models/workspace_member_entity_listing.rb +17 -17
  406. data/lib/purecloud/models/wrap_up_code_mapping_notification.rb +4 -14
  407. data/lib/purecloud/models/wrapup_code_entity_listing.rb +17 -17
  408. data/lib/purecloud/version.rb +1 -1
  409. data/newVersion.md +1 -1
  410. data/swagger.json +1 -1
  411. data/swagger_template/api_doc.mustache +5 -2
  412. data/version.json +1 -1
  413. metadata +70 -42
  414. data/doc_out/DocumentDataNotification.html.md +0 -28
  415. data/doc_out/DocumentDataNotificationLockData.html.md +0 -15
  416. data/doc_out/DocumentDataNotificationLockInfo.html.md +0 -15
  417. data/doc_out/FaxDataNotification.html.md +0 -31
  418. data/doc_out/FaxDataNotificationLockData.html.md +0 -15
  419. data/doc_out/FaxDataNotificationLockInfo.html.md +0 -15
  420. data/doc_out/RecordingDataNotification.html.md +0 -31
  421. data/doc_out/RecordingDataNotificationLockData.html.md +0 -15
  422. data/doc_out/RecordingDataNotificationLockInfo.html.md +0 -15
  423. data/lib/purecloud/models/recording_data_notification_lock_data.rb +0 -185
  424. data/lib/purecloud/models/recording_data_notification_lock_info.rb +0 -185
@@ -11,11 +11,11 @@ title: SiteEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
16
+ | **next_uri** | **String** | | [optional] |
16
17
  | **previous_uri** | **String** | | [optional] |
17
18
  | **last_uri** | **String** | | [optional] |
18
- | **next_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -11,11 +11,11 @@ title: SkillEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
16
+ | **next_uri** | **String** | | [optional] |
16
17
  | **previous_uri** | **String** | | [optional] |
17
18
  | **last_uri** | **String** | | [optional] |
18
- | **next_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -34,7 +34,7 @@ title: SocialConversationNotificationParticipants
34
34
  | **address** | **String** | | [optional] |
35
35
  | **start_hold_time** | **DateTime** | | [optional] |
36
36
  | **attributes** | **Hash<String, String>** | | [optional] |
37
- | **user** | [**DocumentDataNotificationCreatedBy**](DocumentDataNotificationCreatedBy.html) | | [optional] |
37
+ | **user** | [**DocumentDataV2NotificationCreatedBy**](DocumentDataV2NotificationCreatedBy.html) | | [optional] |
38
38
  {: class="table table-striped"}
39
39
 
40
40
 
@@ -21,7 +21,7 @@ title: SocialConversationNotificationSocialMediaParticipant
21
21
  | **held** | **BOOLEAN** | | [optional] |
22
22
  | **wrapup_required** | **BOOLEAN** | | [optional] |
23
23
  | **wrapup_prompt** | **String** | | [optional] |
24
- | **user** | [**DocumentDataNotificationCreatedBy**](DocumentDataNotificationCreatedBy.html) | | [optional] |
24
+ | **user** | [**DocumentDataV2NotificationCreatedBy**](DocumentDataV2NotificationCreatedBy.html) | | [optional] |
25
25
  | **queue** | [**SocialConversationNotificationUriReference**](SocialConversationNotificationUriReference.html) | | [optional] |
26
26
  | **attributes** | **Hash<String, String>** | | [optional] |
27
27
  | **error_info** | [**SocialConversationNotificationErrorInfo**](SocialConversationNotificationErrorInfo.html) | | [optional] |
@@ -11,11 +11,11 @@ title: StationEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
16
+ | **next_uri** | **String** | | [optional] |
16
17
  | **previous_uri** | **String** | | [optional] |
17
18
  | **last_uri** | **String** | | [optional] |
18
- | **next_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -6,11 +6,11 @@ title: StationsApi
6
6
 
7
7
  All URIs are relative to *https://api.mypurecloud.com*
8
8
 
9
- Method | HTTP request | Description
9
+ Method | Description
10
10
  ------------- | ------------- | -------------
11
- |[**delete_station_id_associateduser**](StationsApi.html#delete_station_id_associateduser) | **DELETE** /api/v2/stations/{stationId}/associateduser | Unassigns the user assigned to this station|
12
- |[**get_station_id**](StationsApi.html#get_station_id) | **GET** /api/v2/stations/{stationId} | Get station.|
13
- |[**get_stations**](StationsApi.html#get_stations) | **GET** /api/v2/stations | Get the list of available stations.|
11
+ [**delete_station_id_associateduser**](StationsApi.html#delete_station_id_associateduser) | Unassigns the user assigned to this station
12
+ [**get_station_id**](StationsApi.html#get_station_id) | Get station.
13
+ [**get_stations**](StationsApi.html#get_stations) | Get the list of available stations.
14
14
  {: class="table table-striped"}
15
15
 
16
16
  <a name="delete_station_id_associateduser"></a>
@@ -21,6 +21,9 @@ Unassigns the user assigned to this station
21
21
 
22
22
 
23
23
 
24
+ Wraps DELETE /api/v2/stations/{stationId}/associateduser
25
+
26
+
24
27
  ### Example
25
28
  ~~~ruby
26
29
  # load the gem
@@ -77,6 +80,9 @@ Get station.
77
80
 
78
81
 
79
82
 
83
+ Wraps GET /api/v2/stations/{stationId}
84
+
85
+
80
86
  ### Example
81
87
  ~~~ruby
82
88
  # load the gem
@@ -133,6 +139,9 @@ Get the list of available stations.
133
139
 
134
140
 
135
141
 
142
+ Wraps GET /api/v2/stations
143
+
144
+
136
145
  ### Example
137
146
  ~~~ruby
138
147
  # load the gem
@@ -6,12 +6,12 @@ title: SuggestApi
6
6
 
7
7
  All URIs are relative to *https://api.mypurecloud.com*
8
8
 
9
- Method | HTTP request | Description
9
+ Method | Description
10
10
  ------------- | ------------- | -------------
11
- |[**get_search**](SuggestApi.html#get_search) | **GET** /api/v2/search | Search using the q64 value returned from a previous search.|
12
- |[**get_suggest**](SuggestApi.html#get_suggest) | **GET** /api/v2/search/suggest | Suggest resources using the q64 value returned from a previous suggest query.|
13
- |[**post_search**](SuggestApi.html#post_search) | **POST** /api/v2/search | Search resources.|
14
- |[**post_suggest**](SuggestApi.html#post_suggest) | **POST** /api/v2/search/suggest | Suggest resources.|
11
+ [**get_search**](SuggestApi.html#get_search) | Search using the q64 value returned from a previous search.
12
+ [**get_suggest**](SuggestApi.html#get_suggest) | Suggest resources using the q64 value returned from a previous suggest query.
13
+ [**post_search**](SuggestApi.html#post_search) | Search resources.
14
+ [**post_suggest**](SuggestApi.html#post_suggest) | Suggest resources.
15
15
  {: class="table table-striped"}
16
16
 
17
17
  <a name="get_search"></a>
@@ -22,6 +22,9 @@ Search using the q64 value returned from a previous search.
22
22
 
23
23
 
24
24
 
25
+ Wraps GET /api/v2/search
26
+
27
+
25
28
  ### Example
26
29
  ~~~ruby
27
30
  # load the gem
@@ -84,6 +87,9 @@ Suggest resources using the q64 value returned from a previous suggest query.
84
87
 
85
88
 
86
89
 
90
+ Wraps GET /api/v2/search/suggest
91
+
92
+
87
93
  ### Example
88
94
  ~~~ruby
89
95
  # load the gem
@@ -146,6 +152,9 @@ Search resources.
146
152
 
147
153
 
148
154
 
155
+ Wraps POST /api/v2/search
156
+
157
+
149
158
  ### Example
150
159
  ~~~ruby
151
160
  # load the gem
@@ -206,6 +215,9 @@ Suggest resources.
206
215
 
207
216
 
208
217
 
218
+ Wraps POST /api/v2/search/suggest
219
+
220
+
209
221
  ### Example
210
222
  ~~~ruby
211
223
  # load the gem
@@ -11,11 +11,11 @@ title: TagValueEntityListing
11
11
  | **page_size** | **Integer** | | [optional] |
12
12
  | **page_number** | **Integer** | | [optional] |
13
13
  | **total** | **Integer** | | [optional] |
14
- | **first_uri** | **String** | | [optional] |
15
14
  | **self_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
16
+ | **next_uri** | **String** | | [optional] |
16
17
  | **previous_uri** | **String** | | [optional] |
17
18
  | **last_uri** | **String** | | [optional] |
18
- | **next_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
21
21
 
@@ -6,126 +6,126 @@ title: TelephonyProvidersEdgeApi
6
6
 
7
7
  All URIs are relative to *https://api.mypurecloud.com*
8
8
 
9
- Method | HTTP request | Description
9
+ Method | Description
10
10
  ------------- | ------------- | -------------
11
- |[**delete_providers_edges_certificateauthorities_certificate_id**](TelephonyProvidersEdgeApi.html#delete_providers_edges_certificateauthorities_certificate_id) | **DELETE** /api/v2/telephony/providers/edges/certificateauthorities/{certificateId} | Delete a certificate authority.|
12
- |[**delete_providers_edges_didpools_didpool_id**](TelephonyProvidersEdgeApi.html#delete_providers_edges_didpools_didpool_id) | **DELETE** /api/v2/telephony/providers/edges/didpools/{didPoolId} | Delete a DID Pool by ID.|
13
- |[**delete_providers_edges_edge_id**](TelephonyProvidersEdgeApi.html#delete_providers_edges_edge_id) | **DELETE** /api/v2/telephony/providers/edges/{edgeId} | Delete a edge.|
14
- |[**delete_providers_edges_edge_id_logicalinterfaces_interface_id**](TelephonyProvidersEdgeApi.html#delete_providers_edges_edge_id_logicalinterfaces_interface_id) | **DELETE** /api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces/{interfaceId} | Delete an edge logical interface|
15
- |[**delete_providers_edges_edge_id_softwareupdate**](TelephonyProvidersEdgeApi.html#delete_providers_edges_edge_id_softwareupdate) | **DELETE** /api/v2/telephony/providers/edges/{edgeId}/softwareupdate | Cancels any in-progress update for this edge.|
16
- |[**delete_providers_edges_edgegroups_edgegroup_id**](TelephonyProvidersEdgeApi.html#delete_providers_edges_edgegroups_edgegroup_id) | **DELETE** /api/v2/telephony/providers/edges/edgegroups/{edgeGroupId} | Delete an edge group.|
17
- |[**delete_providers_edges_endpoints_endpoint_id**](TelephonyProvidersEdgeApi.html#delete_providers_edges_endpoints_endpoint_id) | **DELETE** /api/v2/telephony/providers/edges/endpoints/{endpointId} | Delete endpoint|
18
- |[**delete_providers_edges_extensionpools_extensionpool_id**](TelephonyProvidersEdgeApi.html#delete_providers_edges_extensionpools_extensionpool_id) | **DELETE** /api/v2/telephony/providers/edges/extensionpools/{extensionPoolId} | Delete an extension pool by ID|
19
- |[**delete_providers_edges_outboundroutes_outboundroute_id**](TelephonyProvidersEdgeApi.html#delete_providers_edges_outboundroutes_outboundroute_id) | **DELETE** /api/v2/telephony/providers/edges/outboundroutes/{outboundRouteId} | Delete Outbound Route|
20
- |[**delete_providers_edges_phonebasesettings_phonebase_id**](TelephonyProvidersEdgeApi.html#delete_providers_edges_phonebasesettings_phonebase_id) | **DELETE** /api/v2/telephony/providers/edges/phonebasesettings/{phoneBaseId} | Delete a Phone Base Settings by ID|
21
- |[**delete_providers_edges_phones_phone_id**](TelephonyProvidersEdgeApi.html#delete_providers_edges_phones_phone_id) | **DELETE** /api/v2/telephony/providers/edges/phones/{phoneId} | Delete a Phone by ID|
22
- |[**delete_providers_edges_sites_site_id**](TelephonyProvidersEdgeApi.html#delete_providers_edges_sites_site_id) | **DELETE** /api/v2/telephony/providers/edges/sites/{siteId} | Delete a Site by ID|
23
- |[**delete_providers_edges_sites_site_id_outboundroutes_outboundroute_id**](TelephonyProvidersEdgeApi.html#delete_providers_edges_sites_site_id_outboundroutes_outboundroute_id) | **DELETE** /api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId} | Delete Outbound Route|
24
- |[**delete_providers_edges_trunkbasesettings_trunkbasesettings_id**](TelephonyProvidersEdgeApi.html#delete_providers_edges_trunkbasesettings_trunkbasesettings_id) | **DELETE** /api/v2/telephony/providers/edges/trunkbasesettings/{trunkBaseSettingsId} | Delete a Trunk Base Settings object by ID|
25
- |[**get_providers_edges**](TelephonyProvidersEdgeApi.html#get_providers_edges) | **GET** /api/v2/telephony/providers/edges | Get the list of edges.|
26
- |[**get_providers_edges_availablelanguages**](TelephonyProvidersEdgeApi.html#get_providers_edges_availablelanguages) | **GET** /api/v2/telephony/providers/edges/availablelanguages | Get the list of available languages.|
27
- |[**get_providers_edges_certificateauthorities**](TelephonyProvidersEdgeApi.html#get_providers_edges_certificateauthorities) | **GET** /api/v2/telephony/providers/edges/certificateauthorities | Get the list of certificate authorities.|
28
- |[**get_providers_edges_certificateauthorities_certificate_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_certificateauthorities_certificate_id) | **GET** /api/v2/telephony/providers/edges/certificateauthorities/{certificateId} | Get a certificate authority.|
29
- |[**get_providers_edges_didpools**](TelephonyProvidersEdgeApi.html#get_providers_edges_didpools) | **GET** /api/v2/telephony/providers/edges/didpools | Get a listing of DID Pools|
30
- |[**get_providers_edges_didpools_didpool_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_didpools_didpool_id) | **GET** /api/v2/telephony/providers/edges/didpools/{didPoolId} | Get a DID Pool by ID.|
31
- |[**get_providers_edges_dids**](TelephonyProvidersEdgeApi.html#get_providers_edges_dids) | **GET** /api/v2/telephony/providers/edges/dids | Get a listing of DIDs|
32
- |[**get_providers_edges_dids_did_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_dids_did_id) | **GET** /api/v2/telephony/providers/edges/dids/{didId} | Get a DID by ID.|
33
- |[**get_providers_edges_edge_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_edge_id) | **GET** /api/v2/telephony/providers/edges/{edgeId} | Get edge.|
34
- |[**get_providers_edges_edge_id_lines**](TelephonyProvidersEdgeApi.html#get_providers_edges_edge_id_lines) | **GET** /api/v2/telephony/providers/edges/{edgeId}/lines | Get the list of lines.|
35
- |[**get_providers_edges_edge_id_lines_line_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_edge_id_lines_line_id) | **GET** /api/v2/telephony/providers/edges/{edgeId}/lines/{lineId} | Get line|
36
- |[**get_providers_edges_edge_id_logicalinterfaces**](TelephonyProvidersEdgeApi.html#get_providers_edges_edge_id_logicalinterfaces) | **GET** /api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces | Get edge logical interfaces.|
37
- |[**get_providers_edges_edge_id_logicalinterfaces_interface_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_edge_id_logicalinterfaces_interface_id) | **GET** /api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces/{interfaceId} | Get an edge logical interface|
38
- |[**get_providers_edges_edge_id_logs_jobs_job_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_edge_id_logs_jobs_job_id) | **GET** /api/v2/telephony/providers/edges/{edgeId}/logs/jobs/{jobId} | Get an Edge logs job.|
39
- |[**get_providers_edges_edge_id_metrics**](TelephonyProvidersEdgeApi.html#get_providers_edges_edge_id_metrics) | **GET** /api/v2/telephony/providers/edges/{edgeId}/metrics | Get the edge metrics.|
40
- |[**get_providers_edges_edge_id_physicalinterfaces**](TelephonyProvidersEdgeApi.html#get_providers_edges_edge_id_physicalinterfaces) | **GET** /api/v2/telephony/providers/edges/{edgeId}/physicalinterfaces | Retrieve a list of all configured physical interfaces from a specific edge.|
41
- |[**get_providers_edges_edge_id_physicalinterfaces_interface_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_edge_id_physicalinterfaces_interface_id) | **GET** /api/v2/telephony/providers/edges/{edgeId}/physicalinterfaces/{interfaceId} | Get edge physical interface.|
42
- |[**get_providers_edges_edge_id_setuppackage**](TelephonyProvidersEdgeApi.html#get_providers_edges_edge_id_setuppackage) | **GET** /api/v2/telephony/providers/edges/{edgeId}/setuppackage | Get the setup package for a locally deployed edge device. This is needed to complete the setup process for the virtual edge.|
43
- |[**get_providers_edges_edge_id_softwareupdate**](TelephonyProvidersEdgeApi.html#get_providers_edges_edge_id_softwareupdate) | **GET** /api/v2/telephony/providers/edges/{edgeId}/softwareupdate | Gets software update status information about any edge.|
44
- |[**get_providers_edges_edge_id_softwareversions**](TelephonyProvidersEdgeApi.html#get_providers_edges_edge_id_softwareversions) | **GET** /api/v2/telephony/providers/edges/{edgeId}/softwareversions | Gets all the available software versions for this edge.|
45
- |[**get_providers_edges_edgegroups**](TelephonyProvidersEdgeApi.html#get_providers_edges_edgegroups) | **GET** /api/v2/telephony/providers/edges/edgegroups | Get the list of edge groups.|
46
- |[**get_providers_edges_edgegroups_edgegroup_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_edgegroups_edgegroup_id) | **GET** /api/v2/telephony/providers/edges/edgegroups/{edgeGroupId} | Get edge group.|
47
- |[**get_providers_edges_edgeversionreport**](TelephonyProvidersEdgeApi.html#get_providers_edges_edgeversionreport) | **GET** /api/v2/telephony/providers/edges/edgeversionreport | Get the edge version report.|
48
- |[**get_providers_edges_endpoints**](TelephonyProvidersEdgeApi.html#get_providers_edges_endpoints) | **GET** /api/v2/telephony/providers/edges/endpoints | Get endpoints|
49
- |[**get_providers_edges_endpoints_endpoint_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_endpoints_endpoint_id) | **GET** /api/v2/telephony/providers/edges/endpoints/{endpointId} | Get endpoint|
50
- |[**get_providers_edges_extensionpools**](TelephonyProvidersEdgeApi.html#get_providers_edges_extensionpools) | **GET** /api/v2/telephony/providers/edges/extensionpools | Get a listing of extension pools|
51
- |[**get_providers_edges_extensionpools_extensionpool_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_extensionpools_extensionpool_id) | **GET** /api/v2/telephony/providers/edges/extensionpools/{extensionPoolId} | Get an extension pool by ID|
52
- |[**get_providers_edges_extensions**](TelephonyProvidersEdgeApi.html#get_providers_edges_extensions) | **GET** /api/v2/telephony/providers/edges/extensions | Get a listing of extensions|
53
- |[**get_providers_edges_extensions_extension_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_extensions_extension_id) | **GET** /api/v2/telephony/providers/edges/extensions/{extensionId} | Get an extension by ID.|
54
- |[**get_providers_edges_linebasesettings**](TelephonyProvidersEdgeApi.html#get_providers_edges_linebasesettings) | **GET** /api/v2/telephony/providers/edges/linebasesettings | Get a listing of line base settings objects|
55
- |[**get_providers_edges_linebasesettings_linebase_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_linebasesettings_linebase_id) | **GET** /api/v2/telephony/providers/edges/linebasesettings/{lineBaseId} | Get a line base settings object by ID|
56
- |[**get_providers_edges_lines**](TelephonyProvidersEdgeApi.html#get_providers_edges_lines) | **GET** /api/v2/telephony/providers/edges/lines | Get a list of Lines|
57
- |[**get_providers_edges_lines_line_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_lines_line_id) | **GET** /api/v2/telephony/providers/edges/lines/{lineId} | Get a Line by ID|
58
- |[**get_providers_edges_lines_template**](TelephonyProvidersEdgeApi.html#get_providers_edges_lines_template) | **GET** /api/v2/telephony/providers/edges/lines/template | Get a Line instance template based on a Line Base Settings object. This object can then be modified and saved as a new Line instance|
59
- |[**get_providers_edges_metrics**](TelephonyProvidersEdgeApi.html#get_providers_edges_metrics) | **GET** /api/v2/telephony/providers/edges/metrics | Get the metrics for a list of edges.|
60
- |[**get_providers_edges_outboundroutes**](TelephonyProvidersEdgeApi.html#get_providers_edges_outboundroutes) | **GET** /api/v2/telephony/providers/edges/outboundroutes | Get outbound routes|
61
- |[**get_providers_edges_outboundroutes_outboundroute_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_outboundroutes_outboundroute_id) | **GET** /api/v2/telephony/providers/edges/outboundroutes/{outboundRouteId} | Get outbound route|
62
- |[**get_providers_edges_phonebasesettings**](TelephonyProvidersEdgeApi.html#get_providers_edges_phonebasesettings) | **GET** /api/v2/telephony/providers/edges/phonebasesettings | Get a list of Phone Base Settings objects|
63
- |[**get_providers_edges_phonebasesettings_availablemetabases**](TelephonyProvidersEdgeApi.html#get_providers_edges_phonebasesettings_availablemetabases) | **GET** /api/v2/telephony/providers/edges/phonebasesettings/availablemetabases | Get a list of available makes and models to create a new Phone Base Settings|
64
- |[**get_providers_edges_phonebasesettings_phonebase_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_phonebasesettings_phonebase_id) | **GET** /api/v2/telephony/providers/edges/phonebasesettings/{phoneBaseId} | Get a Phone Base Settings object by ID|
65
- |[**get_providers_edges_phonebasesettings_template**](TelephonyProvidersEdgeApi.html#get_providers_edges_phonebasesettings_template) | **GET** /api/v2/telephony/providers/edges/phonebasesettings/template | Get a Phone Base Settings instance template from a given make and model. This object can then be modified and saved as a new Phone Base Settings instance|
66
- |[**get_providers_edges_phones**](TelephonyProvidersEdgeApi.html#get_providers_edges_phones) | **GET** /api/v2/telephony/providers/edges/phones | Get a list of Phone Instances|
67
- |[**get_providers_edges_phones_phone_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_phones_phone_id) | **GET** /api/v2/telephony/providers/edges/phones/{phoneId} | Get a Phone by ID|
68
- |[**get_providers_edges_phones_template**](TelephonyProvidersEdgeApi.html#get_providers_edges_phones_template) | **GET** /api/v2/telephony/providers/edges/phones/template | Get a Phone instance template based on a Phone Base Settings object. This object can then be modified and saved as a new Phone instance|
69
- |[**get_providers_edges_sites**](TelephonyProvidersEdgeApi.html#get_providers_edges_sites) | **GET** /api/v2/telephony/providers/edges/sites | Get the list of Sites.|
70
- |[**get_providers_edges_sites_site_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_sites_site_id) | **GET** /api/v2/telephony/providers/edges/sites/{siteId} | Get a Site by ID.|
71
- |[**get_providers_edges_sites_site_id_numberplans**](TelephonyProvidersEdgeApi.html#get_providers_edges_sites_site_id_numberplans) | **GET** /api/v2/telephony/providers/edges/sites/{siteId}/numberplans | Get the list of Number Plans for this Site.|
72
- |[**get_providers_edges_sites_site_id_numberplans_classifications**](TelephonyProvidersEdgeApi.html#get_providers_edges_sites_site_id_numberplans_classifications) | **GET** /api/v2/telephony/providers/edges/sites/{siteId}/numberplans/classifications | Get a list of Classifications for this Site|
73
- |[**get_providers_edges_sites_site_id_numberplans_numberplan_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_sites_site_id_numberplans_numberplan_id) | **GET** /api/v2/telephony/providers/edges/sites/{siteId}/numberplans/{numberPlanId} | Get a Number Plan by ID.|
74
- |[**get_providers_edges_sites_site_id_outboundroutes**](TelephonyProvidersEdgeApi.html#get_providers_edges_sites_site_id_outboundroutes) | **GET** /api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes | Get outbound routes|
75
- |[**get_providers_edges_sites_site_id_outboundroutes_outboundroute_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_sites_site_id_outboundroutes_outboundroute_id) | **GET** /api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId} | Get an outbound route|
76
- |[**get_providers_edges_timezones**](TelephonyProvidersEdgeApi.html#get_providers_edges_timezones) | **GET** /api/v2/telephony/providers/edges/timezones | Get a list of Edge-compatible time zones|
77
- |[**get_providers_edges_trunkbasesettings**](TelephonyProvidersEdgeApi.html#get_providers_edges_trunkbasesettings) | **GET** /api/v2/telephony/providers/edges/trunkbasesettings | Get Trunk Base Settings listing|
78
- |[**get_providers_edges_trunkbasesettings_availablemetabases**](TelephonyProvidersEdgeApi.html#get_providers_edges_trunkbasesettings_availablemetabases) | **GET** /api/v2/telephony/providers/edges/trunkbasesettings/availablemetabases | Get a list of available makes and models to create a new Trunk Base Settings|
79
- |[**get_providers_edges_trunkbasesettings_template**](TelephonyProvidersEdgeApi.html#get_providers_edges_trunkbasesettings_template) | **GET** /api/v2/telephony/providers/edges/trunkbasesettings/template | Get a Trunk Base Settings instance template from a given make and model. This object can then be modified and saved as a new Trunk Base Settings instance|
80
- |[**get_providers_edges_trunkbasesettings_trunkbasesettings_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_trunkbasesettings_trunkbasesettings_id) | **GET** /api/v2/telephony/providers/edges/trunkbasesettings/{trunkBaseSettingsId} | Get a Trunk Base Settings object by ID|
81
- |[**get_providers_edges_trunks**](TelephonyProvidersEdgeApi.html#get_providers_edges_trunks) | **GET** /api/v2/telephony/providers/edges/trunks | Get the list of available trunks.|
82
- |[**get_providers_edges_trunks_trunk_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_trunks_trunk_id) | **GET** /api/v2/telephony/providers/edges/trunks/{trunkId} | Get a Trunk by ID|
83
- |[**get_providers_edges_trunkswithrecording**](TelephonyProvidersEdgeApi.html#get_providers_edges_trunkswithrecording) | **GET** /api/v2/telephony/providers/edges/trunkswithrecording | Get Counts of trunks that have recording disabled or enabled|
84
- |[**get_schemas_edges_vnext**](TelephonyProvidersEdgeApi.html#get_schemas_edges_vnext) | **GET** /api/v2/configuration/schemas/edges/vnext | Lists available schema categories (Deprecated)|
85
- |[**get_schemas_edges_vnext_schemacategory**](TelephonyProvidersEdgeApi.html#get_schemas_edges_vnext_schemacategory) | **GET** /api/v2/configuration/schemas/edges/vnext/{schemaCategory} | List schemas of a specific category (Deprecated)|
86
- |[**get_schemas_edges_vnext_schemacategory_schematype**](TelephonyProvidersEdgeApi.html#get_schemas_edges_vnext_schemacategory_schematype) | **GET** /api/v2/configuration/schemas/edges/vnext/{schemaCategory}/{schemaType} | List schemas of a specific category (Deprecated)|
87
- |[**get_schemas_edges_vnext_schemacategory_schematype_schema_id**](TelephonyProvidersEdgeApi.html#get_schemas_edges_vnext_schemacategory_schematype_schema_id) | **GET** /api/v2/configuration/schemas/edges/vnext/{schemaCategory}/{schemaType}/{schemaId} | Get a json schema (Deprecated)|
88
- |[**get_schemas_edges_vnext_schemacategory_schematype_schema_id_extensiontype_metadata_id**](TelephonyProvidersEdgeApi.html#get_schemas_edges_vnext_schemacategory_schematype_schema_id_extensiontype_metadata_id) | **GET** /api/v2/configuration/schemas/edges/vnext/{schemaCategory}/{schemaType}/{schemaId}/{extensionType}/{metadataId} | Get metadata for a schema (Deprecated)|
89
- |[**post_providers_edges**](TelephonyProvidersEdgeApi.html#post_providers_edges) | **POST** /api/v2/telephony/providers/edges | Create an edge.|
90
- |[**post_providers_edges_addressvalidation**](TelephonyProvidersEdgeApi.html#post_providers_edges_addressvalidation) | **POST** /api/v2/telephony/providers/edges/addressvalidation | Validates a street address|
91
- |[**post_providers_edges_certificateauthorities**](TelephonyProvidersEdgeApi.html#post_providers_edges_certificateauthorities) | **POST** /api/v2/telephony/providers/edges/certificateauthorities | Create a certificate authority.|
92
- |[**post_providers_edges_didpools**](TelephonyProvidersEdgeApi.html#post_providers_edges_didpools) | **POST** /api/v2/telephony/providers/edges/didpools | Create a new DID pool|
93
- |[**post_providers_edges_edge_id_logicalinterfaces**](TelephonyProvidersEdgeApi.html#post_providers_edges_edge_id_logicalinterfaces) | **POST** /api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces | Create an edge logical interface.|
94
- |[**post_providers_edges_edge_id_logs_jobs**](TelephonyProvidersEdgeApi.html#post_providers_edges_edge_id_logs_jobs) | **POST** /api/v2/telephony/providers/edges/{edgeId}/logs/jobs | Create a job to upload a list of Edge logs.|
95
- |[**post_providers_edges_edge_id_logs_jobs_job_id_upload**](TelephonyProvidersEdgeApi.html#post_providers_edges_edge_id_logs_jobs_job_id_upload) | **POST** /api/v2/telephony/providers/edges/{edgeId}/logs/jobs/{jobId}/upload | Request that the specified fileIds be uploaded from the Edge.|
96
- |[**post_providers_edges_edge_id_reboot**](TelephonyProvidersEdgeApi.html#post_providers_edges_edge_id_reboot) | **POST** /api/v2/telephony/providers/edges/{edgeId}/reboot | Reboot an Edge|
97
- |[**post_providers_edges_edge_id_softwareupdate**](TelephonyProvidersEdgeApi.html#post_providers_edges_edge_id_softwareupdate) | **POST** /api/v2/telephony/providers/edges/{edgeId}/softwareupdate | Starts a software update for this edge.|
98
- |[**post_providers_edges_edge_id_unpair**](TelephonyProvidersEdgeApi.html#post_providers_edges_edge_id_unpair) | **POST** /api/v2/telephony/providers/edges/{edgeId}/unpair | Unpair an Edge|
99
- |[**post_providers_edges_edgegroups**](TelephonyProvidersEdgeApi.html#post_providers_edges_edgegroups) | **POST** /api/v2/telephony/providers/edges/edgegroups | Create an edge group.|
100
- |[**post_providers_edges_endpoints**](TelephonyProvidersEdgeApi.html#post_providers_edges_endpoints) | **POST** /api/v2/telephony/providers/edges/endpoints | Create endpoint|
101
- |[**post_providers_edges_extensionpools**](TelephonyProvidersEdgeApi.html#post_providers_edges_extensionpools) | **POST** /api/v2/telephony/providers/edges/extensionpools | Create a new extension pool|
102
- |[**post_providers_edges_offlineconfiguration**](TelephonyProvidersEdgeApi.html#post_providers_edges_offlineconfiguration) | **POST** /api/v2/telephony/providers/edges/offlineconfiguration | Create a file that can be used to configure a hardware Edge&#39;s settings.|
103
- |[**post_providers_edges_outboundroutes**](TelephonyProvidersEdgeApi.html#post_providers_edges_outboundroutes) | **POST** /api/v2/telephony/providers/edges/outboundroutes | Create outbound rule|
104
- |[**post_providers_edges_phonebasesettings**](TelephonyProvidersEdgeApi.html#post_providers_edges_phonebasesettings) | **POST** /api/v2/telephony/providers/edges/phonebasesettings | Create a new Phone Base Settings object|
105
- |[**post_providers_edges_phones**](TelephonyProvidersEdgeApi.html#post_providers_edges_phones) | **POST** /api/v2/telephony/providers/edges/phones | Create a new Phone|
106
- |[**post_providers_edges_phones_phone_id_reboot**](TelephonyProvidersEdgeApi.html#post_providers_edges_phones_phone_id_reboot) | **POST** /api/v2/telephony/providers/edges/phones/{phoneId}/reboot | Reboot a Phone|
107
- |[**post_providers_edges_phones_reboot**](TelephonyProvidersEdgeApi.html#post_providers_edges_phones_reboot) | **POST** /api/v2/telephony/providers/edges/phones/reboot | Reboot Multiple Phones|
108
- |[**post_providers_edges_sites**](TelephonyProvidersEdgeApi.html#post_providers_edges_sites) | **POST** /api/v2/telephony/providers/edges/sites | Create a Site.|
109
- |[**post_providers_edges_sites_site_id_outboundroutes**](TelephonyProvidersEdgeApi.html#post_providers_edges_sites_site_id_outboundroutes) | **POST** /api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes | Create outbound route|
110
- |[**post_providers_edges_sites_site_id_rebalance**](TelephonyProvidersEdgeApi.html#post_providers_edges_sites_site_id_rebalance) | **POST** /api/v2/telephony/providers/edges/sites/{siteId}/rebalance | Triggers the rebalance operation.|
111
- |[**post_providers_edges_trunkbasesettings**](TelephonyProvidersEdgeApi.html#post_providers_edges_trunkbasesettings) | **POST** /api/v2/telephony/providers/edges/trunkbasesettings | Create a Trunk Base Settings object|
112
- |[**put_providers_edges_certificateauthorities_certificate_id**](TelephonyProvidersEdgeApi.html#put_providers_edges_certificateauthorities_certificate_id) | **PUT** /api/v2/telephony/providers/edges/certificateauthorities/{certificateId} | Update a certificate authority.|
113
- |[**put_providers_edges_didpools_didpool_id**](TelephonyProvidersEdgeApi.html#put_providers_edges_didpools_didpool_id) | **PUT** /api/v2/telephony/providers/edges/didpools/{didPoolId} | Update a DID Pool by ID.|
114
- |[**put_providers_edges_dids_did_id**](TelephonyProvidersEdgeApi.html#put_providers_edges_dids_did_id) | **PUT** /api/v2/telephony/providers/edges/dids/{didId} | Update a DID by ID.|
115
- |[**put_providers_edges_edge_id**](TelephonyProvidersEdgeApi.html#put_providers_edges_edge_id) | **PUT** /api/v2/telephony/providers/edges/{edgeId} | Update a edge.|
116
- |[**put_providers_edges_edge_id_lines_line_id**](TelephonyProvidersEdgeApi.html#put_providers_edges_edge_id_lines_line_id) | **PUT** /api/v2/telephony/providers/edges/{edgeId}/lines/{lineId} | Update a line.|
117
- |[**put_providers_edges_edge_id_logicalinterfaces_interface_id**](TelephonyProvidersEdgeApi.html#put_providers_edges_edge_id_logicalinterfaces_interface_id) | **PUT** /api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces/{interfaceId} | Update an edge logical interface.|
118
- |[**put_providers_edges_edgegroups_edgegroup_id**](TelephonyProvidersEdgeApi.html#put_providers_edges_edgegroups_edgegroup_id) | **PUT** /api/v2/telephony/providers/edges/edgegroups/{edgeGroupId} | Update an edge group.|
119
- |[**put_providers_edges_endpoints_endpoint_id**](TelephonyProvidersEdgeApi.html#put_providers_edges_endpoints_endpoint_id) | **PUT** /api/v2/telephony/providers/edges/endpoints/{endpointId} | Update endpoint|
120
- |[**put_providers_edges_extensionpools_extensionpool_id**](TelephonyProvidersEdgeApi.html#put_providers_edges_extensionpools_extensionpool_id) | **PUT** /api/v2/telephony/providers/edges/extensionpools/{extensionPoolId} | Update an extension pool by ID|
121
- |[**put_providers_edges_extensions_extension_id**](TelephonyProvidersEdgeApi.html#put_providers_edges_extensions_extension_id) | **PUT** /api/v2/telephony/providers/edges/extensions/{extensionId} | Update an extension by ID.|
122
- |[**put_providers_edges_outboundroutes_outboundroute_id**](TelephonyProvidersEdgeApi.html#put_providers_edges_outboundroutes_outboundroute_id) | **PUT** /api/v2/telephony/providers/edges/outboundroutes/{outboundRouteId} | Update outbound route|
123
- |[**put_providers_edges_phonebasesettings_phonebase_id**](TelephonyProvidersEdgeApi.html#put_providers_edges_phonebasesettings_phonebase_id) | **PUT** /api/v2/telephony/providers/edges/phonebasesettings/{phoneBaseId} | Update a Phone Base Settings by ID|
124
- |[**put_providers_edges_phones_phone_id**](TelephonyProvidersEdgeApi.html#put_providers_edges_phones_phone_id) | **PUT** /api/v2/telephony/providers/edges/phones/{phoneId} | Update a Phone by ID|
125
- |[**put_providers_edges_sites_site_id**](TelephonyProvidersEdgeApi.html#put_providers_edges_sites_site_id) | **PUT** /api/v2/telephony/providers/edges/sites/{siteId} | Update a Site by ID.|
126
- |[**put_providers_edges_sites_site_id_numberplans**](TelephonyProvidersEdgeApi.html#put_providers_edges_sites_site_id_numberplans) | **PUT** /api/v2/telephony/providers/edges/sites/{siteId}/numberplans | Update the list of Number Plans.|
127
- |[**put_providers_edges_sites_site_id_outboundroutes_outboundroute_id**](TelephonyProvidersEdgeApi.html#put_providers_edges_sites_site_id_outboundroutes_outboundroute_id) | **PUT** /api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId} | Update outbound route|
128
- |[**put_providers_edges_trunkbasesettings_trunkbasesettings_id**](TelephonyProvidersEdgeApi.html#put_providers_edges_trunkbasesettings_trunkbasesettings_id) | **PUT** /api/v2/telephony/providers/edges/trunkbasesettings/{trunkBaseSettingsId} | Update a Trunk Base Settings object by ID|
11
+ [**delete_providers_edges_certificateauthorities_certificate_id**](TelephonyProvidersEdgeApi.html#delete_providers_edges_certificateauthorities_certificate_id) | Delete a certificate authority.
12
+ [**delete_providers_edges_didpools_didpool_id**](TelephonyProvidersEdgeApi.html#delete_providers_edges_didpools_didpool_id) | Delete a DID Pool by ID.
13
+ [**delete_providers_edges_edge_id**](TelephonyProvidersEdgeApi.html#delete_providers_edges_edge_id) | Delete a edge.
14
+ [**delete_providers_edges_edge_id_logicalinterfaces_interface_id**](TelephonyProvidersEdgeApi.html#delete_providers_edges_edge_id_logicalinterfaces_interface_id) | Delete an edge logical interface
15
+ [**delete_providers_edges_edge_id_softwareupdate**](TelephonyProvidersEdgeApi.html#delete_providers_edges_edge_id_softwareupdate) | Cancels any in-progress update for this edge.
16
+ [**delete_providers_edges_edgegroups_edgegroup_id**](TelephonyProvidersEdgeApi.html#delete_providers_edges_edgegroups_edgegroup_id) | Delete an edge group.
17
+ [**delete_providers_edges_endpoints_endpoint_id**](TelephonyProvidersEdgeApi.html#delete_providers_edges_endpoints_endpoint_id) | Delete endpoint
18
+ [**delete_providers_edges_extensionpools_extensionpool_id**](TelephonyProvidersEdgeApi.html#delete_providers_edges_extensionpools_extensionpool_id) | Delete an extension pool by ID
19
+ [**delete_providers_edges_outboundroutes_outboundroute_id**](TelephonyProvidersEdgeApi.html#delete_providers_edges_outboundroutes_outboundroute_id) | Delete Outbound Route
20
+ [**delete_providers_edges_phonebasesettings_phonebase_id**](TelephonyProvidersEdgeApi.html#delete_providers_edges_phonebasesettings_phonebase_id) | Delete a Phone Base Settings by ID
21
+ [**delete_providers_edges_phones_phone_id**](TelephonyProvidersEdgeApi.html#delete_providers_edges_phones_phone_id) | Delete a Phone by ID
22
+ [**delete_providers_edges_sites_site_id**](TelephonyProvidersEdgeApi.html#delete_providers_edges_sites_site_id) | Delete a Site by ID
23
+ [**delete_providers_edges_sites_site_id_outboundroutes_outboundroute_id**](TelephonyProvidersEdgeApi.html#delete_providers_edges_sites_site_id_outboundroutes_outboundroute_id) | Delete Outbound Route
24
+ [**delete_providers_edges_trunkbasesettings_trunkbasesettings_id**](TelephonyProvidersEdgeApi.html#delete_providers_edges_trunkbasesettings_trunkbasesettings_id) | Delete a Trunk Base Settings object by ID
25
+ [**get_providers_edges**](TelephonyProvidersEdgeApi.html#get_providers_edges) | Get the list of edges.
26
+ [**get_providers_edges_availablelanguages**](TelephonyProvidersEdgeApi.html#get_providers_edges_availablelanguages) | Get the list of available languages.
27
+ [**get_providers_edges_certificateauthorities**](TelephonyProvidersEdgeApi.html#get_providers_edges_certificateauthorities) | Get the list of certificate authorities.
28
+ [**get_providers_edges_certificateauthorities_certificate_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_certificateauthorities_certificate_id) | Get a certificate authority.
29
+ [**get_providers_edges_didpools**](TelephonyProvidersEdgeApi.html#get_providers_edges_didpools) | Get a listing of DID Pools
30
+ [**get_providers_edges_didpools_didpool_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_didpools_didpool_id) | Get a DID Pool by ID.
31
+ [**get_providers_edges_dids**](TelephonyProvidersEdgeApi.html#get_providers_edges_dids) | Get a listing of DIDs
32
+ [**get_providers_edges_dids_did_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_dids_did_id) | Get a DID by ID.
33
+ [**get_providers_edges_edge_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_edge_id) | Get edge.
34
+ [**get_providers_edges_edge_id_lines**](TelephonyProvidersEdgeApi.html#get_providers_edges_edge_id_lines) | Get the list of lines.
35
+ [**get_providers_edges_edge_id_lines_line_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_edge_id_lines_line_id) | Get line
36
+ [**get_providers_edges_edge_id_logicalinterfaces**](TelephonyProvidersEdgeApi.html#get_providers_edges_edge_id_logicalinterfaces) | Get edge logical interfaces.
37
+ [**get_providers_edges_edge_id_logicalinterfaces_interface_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_edge_id_logicalinterfaces_interface_id) | Get an edge logical interface
38
+ [**get_providers_edges_edge_id_logs_jobs_job_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_edge_id_logs_jobs_job_id) | Get an Edge logs job.
39
+ [**get_providers_edges_edge_id_metrics**](TelephonyProvidersEdgeApi.html#get_providers_edges_edge_id_metrics) | Get the edge metrics.
40
+ [**get_providers_edges_edge_id_physicalinterfaces**](TelephonyProvidersEdgeApi.html#get_providers_edges_edge_id_physicalinterfaces) | Retrieve a list of all configured physical interfaces from a specific edge.
41
+ [**get_providers_edges_edge_id_physicalinterfaces_interface_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_edge_id_physicalinterfaces_interface_id) | Get edge physical interface.
42
+ [**get_providers_edges_edge_id_setuppackage**](TelephonyProvidersEdgeApi.html#get_providers_edges_edge_id_setuppackage) | Get the setup package for a locally deployed edge device. This is needed to complete the setup process for the virtual edge.
43
+ [**get_providers_edges_edge_id_softwareupdate**](TelephonyProvidersEdgeApi.html#get_providers_edges_edge_id_softwareupdate) | Gets software update status information about any edge.
44
+ [**get_providers_edges_edge_id_softwareversions**](TelephonyProvidersEdgeApi.html#get_providers_edges_edge_id_softwareversions) | Gets all the available software versions for this edge.
45
+ [**get_providers_edges_edgegroups**](TelephonyProvidersEdgeApi.html#get_providers_edges_edgegroups) | Get the list of edge groups.
46
+ [**get_providers_edges_edgegroups_edgegroup_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_edgegroups_edgegroup_id) | Get edge group.
47
+ [**get_providers_edges_edgeversionreport**](TelephonyProvidersEdgeApi.html#get_providers_edges_edgeversionreport) | Get the edge version report.
48
+ [**get_providers_edges_endpoints**](TelephonyProvidersEdgeApi.html#get_providers_edges_endpoints) | Get endpoints
49
+ [**get_providers_edges_endpoints_endpoint_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_endpoints_endpoint_id) | Get endpoint
50
+ [**get_providers_edges_extensionpools**](TelephonyProvidersEdgeApi.html#get_providers_edges_extensionpools) | Get a listing of extension pools
51
+ [**get_providers_edges_extensionpools_extensionpool_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_extensionpools_extensionpool_id) | Get an extension pool by ID
52
+ [**get_providers_edges_extensions**](TelephonyProvidersEdgeApi.html#get_providers_edges_extensions) | Get a listing of extensions
53
+ [**get_providers_edges_extensions_extension_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_extensions_extension_id) | Get an extension by ID.
54
+ [**get_providers_edges_linebasesettings**](TelephonyProvidersEdgeApi.html#get_providers_edges_linebasesettings) | Get a listing of line base settings objects
55
+ [**get_providers_edges_linebasesettings_linebase_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_linebasesettings_linebase_id) | Get a line base settings object by ID
56
+ [**get_providers_edges_lines**](TelephonyProvidersEdgeApi.html#get_providers_edges_lines) | Get a list of Lines
57
+ [**get_providers_edges_lines_line_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_lines_line_id) | Get a Line by ID
58
+ [**get_providers_edges_lines_template**](TelephonyProvidersEdgeApi.html#get_providers_edges_lines_template) | Get a Line instance template based on a Line Base Settings object. This object can then be modified and saved as a new Line instance
59
+ [**get_providers_edges_metrics**](TelephonyProvidersEdgeApi.html#get_providers_edges_metrics) | Get the metrics for a list of edges.
60
+ [**get_providers_edges_outboundroutes**](TelephonyProvidersEdgeApi.html#get_providers_edges_outboundroutes) | Get outbound routes
61
+ [**get_providers_edges_outboundroutes_outboundroute_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_outboundroutes_outboundroute_id) | Get outbound route
62
+ [**get_providers_edges_phonebasesettings**](TelephonyProvidersEdgeApi.html#get_providers_edges_phonebasesettings) | Get a list of Phone Base Settings objects
63
+ [**get_providers_edges_phonebasesettings_availablemetabases**](TelephonyProvidersEdgeApi.html#get_providers_edges_phonebasesettings_availablemetabases) | Get a list of available makes and models to create a new Phone Base Settings
64
+ [**get_providers_edges_phonebasesettings_phonebase_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_phonebasesettings_phonebase_id) | Get a Phone Base Settings object by ID
65
+ [**get_providers_edges_phonebasesettings_template**](TelephonyProvidersEdgeApi.html#get_providers_edges_phonebasesettings_template) | Get a Phone Base Settings instance template from a given make and model. This object can then be modified and saved as a new Phone Base Settings instance
66
+ [**get_providers_edges_phones**](TelephonyProvidersEdgeApi.html#get_providers_edges_phones) | Get a list of Phone Instances
67
+ [**get_providers_edges_phones_phone_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_phones_phone_id) | Get a Phone by ID
68
+ [**get_providers_edges_phones_template**](TelephonyProvidersEdgeApi.html#get_providers_edges_phones_template) | Get a Phone instance template based on a Phone Base Settings object. This object can then be modified and saved as a new Phone instance
69
+ [**get_providers_edges_sites**](TelephonyProvidersEdgeApi.html#get_providers_edges_sites) | Get the list of Sites.
70
+ [**get_providers_edges_sites_site_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_sites_site_id) | Get a Site by ID.
71
+ [**get_providers_edges_sites_site_id_numberplans**](TelephonyProvidersEdgeApi.html#get_providers_edges_sites_site_id_numberplans) | Get the list of Number Plans for this Site.
72
+ [**get_providers_edges_sites_site_id_numberplans_classifications**](TelephonyProvidersEdgeApi.html#get_providers_edges_sites_site_id_numberplans_classifications) | Get a list of Classifications for this Site
73
+ [**get_providers_edges_sites_site_id_numberplans_numberplan_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_sites_site_id_numberplans_numberplan_id) | Get a Number Plan by ID.
74
+ [**get_providers_edges_sites_site_id_outboundroutes**](TelephonyProvidersEdgeApi.html#get_providers_edges_sites_site_id_outboundroutes) | Get outbound routes
75
+ [**get_providers_edges_sites_site_id_outboundroutes_outboundroute_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_sites_site_id_outboundroutes_outboundroute_id) | Get an outbound route
76
+ [**get_providers_edges_timezones**](TelephonyProvidersEdgeApi.html#get_providers_edges_timezones) | Get a list of Edge-compatible time zones
77
+ [**get_providers_edges_trunkbasesettings**](TelephonyProvidersEdgeApi.html#get_providers_edges_trunkbasesettings) | Get Trunk Base Settings listing
78
+ [**get_providers_edges_trunkbasesettings_availablemetabases**](TelephonyProvidersEdgeApi.html#get_providers_edges_trunkbasesettings_availablemetabases) | Get a list of available makes and models to create a new Trunk Base Settings
79
+ [**get_providers_edges_trunkbasesettings_template**](TelephonyProvidersEdgeApi.html#get_providers_edges_trunkbasesettings_template) | Get a Trunk Base Settings instance template from a given make and model. This object can then be modified and saved as a new Trunk Base Settings instance
80
+ [**get_providers_edges_trunkbasesettings_trunkbasesettings_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_trunkbasesettings_trunkbasesettings_id) | Get a Trunk Base Settings object by ID
81
+ [**get_providers_edges_trunks**](TelephonyProvidersEdgeApi.html#get_providers_edges_trunks) | Get the list of available trunks.
82
+ [**get_providers_edges_trunks_trunk_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_trunks_trunk_id) | Get a Trunk by ID
83
+ [**get_providers_edges_trunkswithrecording**](TelephonyProvidersEdgeApi.html#get_providers_edges_trunkswithrecording) | Get Counts of trunks that have recording disabled or enabled
84
+ [**get_schemas_edges_vnext**](TelephonyProvidersEdgeApi.html#get_schemas_edges_vnext) | Lists available schema categories (Deprecated)
85
+ [**get_schemas_edges_vnext_schemacategory**](TelephonyProvidersEdgeApi.html#get_schemas_edges_vnext_schemacategory) | List schemas of a specific category (Deprecated)
86
+ [**get_schemas_edges_vnext_schemacategory_schematype**](TelephonyProvidersEdgeApi.html#get_schemas_edges_vnext_schemacategory_schematype) | List schemas of a specific category (Deprecated)
87
+ [**get_schemas_edges_vnext_schemacategory_schematype_schema_id**](TelephonyProvidersEdgeApi.html#get_schemas_edges_vnext_schemacategory_schematype_schema_id) | Get a json schema (Deprecated)
88
+ [**get_schemas_edges_vnext_schemacategory_schematype_schema_id_extensiontype_metadata_id**](TelephonyProvidersEdgeApi.html#get_schemas_edges_vnext_schemacategory_schematype_schema_id_extensiontype_metadata_id) | Get metadata for a schema (Deprecated)
89
+ [**post_providers_edges**](TelephonyProvidersEdgeApi.html#post_providers_edges) | Create an edge.
90
+ [**post_providers_edges_addressvalidation**](TelephonyProvidersEdgeApi.html#post_providers_edges_addressvalidation) | Validates a street address
91
+ [**post_providers_edges_certificateauthorities**](TelephonyProvidersEdgeApi.html#post_providers_edges_certificateauthorities) | Create a certificate authority.
92
+ [**post_providers_edges_didpools**](TelephonyProvidersEdgeApi.html#post_providers_edges_didpools) | Create a new DID pool
93
+ [**post_providers_edges_edge_id_logicalinterfaces**](TelephonyProvidersEdgeApi.html#post_providers_edges_edge_id_logicalinterfaces) | Create an edge logical interface.
94
+ [**post_providers_edges_edge_id_logs_jobs**](TelephonyProvidersEdgeApi.html#post_providers_edges_edge_id_logs_jobs) | Create a job to upload a list of Edge logs.
95
+ [**post_providers_edges_edge_id_logs_jobs_job_id_upload**](TelephonyProvidersEdgeApi.html#post_providers_edges_edge_id_logs_jobs_job_id_upload) | Request that the specified fileIds be uploaded from the Edge.
96
+ [**post_providers_edges_edge_id_reboot**](TelephonyProvidersEdgeApi.html#post_providers_edges_edge_id_reboot) | Reboot an Edge
97
+ [**post_providers_edges_edge_id_softwareupdate**](TelephonyProvidersEdgeApi.html#post_providers_edges_edge_id_softwareupdate) | Starts a software update for this edge.
98
+ [**post_providers_edges_edge_id_unpair**](TelephonyProvidersEdgeApi.html#post_providers_edges_edge_id_unpair) | Unpair an Edge
99
+ [**post_providers_edges_edgegroups**](TelephonyProvidersEdgeApi.html#post_providers_edges_edgegroups) | Create an edge group.
100
+ [**post_providers_edges_endpoints**](TelephonyProvidersEdgeApi.html#post_providers_edges_endpoints) | Create endpoint
101
+ [**post_providers_edges_extensionpools**](TelephonyProvidersEdgeApi.html#post_providers_edges_extensionpools) | Create a new extension pool
102
+ [**post_providers_edges_offlineconfiguration**](TelephonyProvidersEdgeApi.html#post_providers_edges_offlineconfiguration) | Create a file that can be used to configure a hardware Edge&#39;s settings.
103
+ [**post_providers_edges_outboundroutes**](TelephonyProvidersEdgeApi.html#post_providers_edges_outboundroutes) | Create outbound rule
104
+ [**post_providers_edges_phonebasesettings**](TelephonyProvidersEdgeApi.html#post_providers_edges_phonebasesettings) | Create a new Phone Base Settings object
105
+ [**post_providers_edges_phones**](TelephonyProvidersEdgeApi.html#post_providers_edges_phones) | Create a new Phone
106
+ [**post_providers_edges_phones_phone_id_reboot**](TelephonyProvidersEdgeApi.html#post_providers_edges_phones_phone_id_reboot) | Reboot a Phone
107
+ [**post_providers_edges_phones_reboot**](TelephonyProvidersEdgeApi.html#post_providers_edges_phones_reboot) | Reboot Multiple Phones
108
+ [**post_providers_edges_sites**](TelephonyProvidersEdgeApi.html#post_providers_edges_sites) | Create a Site.
109
+ [**post_providers_edges_sites_site_id_outboundroutes**](TelephonyProvidersEdgeApi.html#post_providers_edges_sites_site_id_outboundroutes) | Create outbound route
110
+ [**post_providers_edges_sites_site_id_rebalance**](TelephonyProvidersEdgeApi.html#post_providers_edges_sites_site_id_rebalance) | Triggers the rebalance operation.
111
+ [**post_providers_edges_trunkbasesettings**](TelephonyProvidersEdgeApi.html#post_providers_edges_trunkbasesettings) | Create a Trunk Base Settings object
112
+ [**put_providers_edges_certificateauthorities_certificate_id**](TelephonyProvidersEdgeApi.html#put_providers_edges_certificateauthorities_certificate_id) | Update a certificate authority.
113
+ [**put_providers_edges_didpools_didpool_id**](TelephonyProvidersEdgeApi.html#put_providers_edges_didpools_didpool_id) | Update a DID Pool by ID.
114
+ [**put_providers_edges_dids_did_id**](TelephonyProvidersEdgeApi.html#put_providers_edges_dids_did_id) | Update a DID by ID.
115
+ [**put_providers_edges_edge_id**](TelephonyProvidersEdgeApi.html#put_providers_edges_edge_id) | Update a edge.
116
+ [**put_providers_edges_edge_id_lines_line_id**](TelephonyProvidersEdgeApi.html#put_providers_edges_edge_id_lines_line_id) | Update a line.
117
+ [**put_providers_edges_edge_id_logicalinterfaces_interface_id**](TelephonyProvidersEdgeApi.html#put_providers_edges_edge_id_logicalinterfaces_interface_id) | Update an edge logical interface.
118
+ [**put_providers_edges_edgegroups_edgegroup_id**](TelephonyProvidersEdgeApi.html#put_providers_edges_edgegroups_edgegroup_id) | Update an edge group.
119
+ [**put_providers_edges_endpoints_endpoint_id**](TelephonyProvidersEdgeApi.html#put_providers_edges_endpoints_endpoint_id) | Update endpoint
120
+ [**put_providers_edges_extensionpools_extensionpool_id**](TelephonyProvidersEdgeApi.html#put_providers_edges_extensionpools_extensionpool_id) | Update an extension pool by ID
121
+ [**put_providers_edges_extensions_extension_id**](TelephonyProvidersEdgeApi.html#put_providers_edges_extensions_extension_id) | Update an extension by ID.
122
+ [**put_providers_edges_outboundroutes_outboundroute_id**](TelephonyProvidersEdgeApi.html#put_providers_edges_outboundroutes_outboundroute_id) | Update outbound route
123
+ [**put_providers_edges_phonebasesettings_phonebase_id**](TelephonyProvidersEdgeApi.html#put_providers_edges_phonebasesettings_phonebase_id) | Update a Phone Base Settings by ID
124
+ [**put_providers_edges_phones_phone_id**](TelephonyProvidersEdgeApi.html#put_providers_edges_phones_phone_id) | Update a Phone by ID
125
+ [**put_providers_edges_sites_site_id**](TelephonyProvidersEdgeApi.html#put_providers_edges_sites_site_id) | Update a Site by ID.
126
+ [**put_providers_edges_sites_site_id_numberplans**](TelephonyProvidersEdgeApi.html#put_providers_edges_sites_site_id_numberplans) | Update the list of Number Plans.
127
+ [**put_providers_edges_sites_site_id_outboundroutes_outboundroute_id**](TelephonyProvidersEdgeApi.html#put_providers_edges_sites_site_id_outboundroutes_outboundroute_id) | Update outbound route
128
+ [**put_providers_edges_trunkbasesettings_trunkbasesettings_id**](TelephonyProvidersEdgeApi.html#put_providers_edges_trunkbasesettings_trunkbasesettings_id) | Update a Trunk Base Settings object by ID
129
129
  {: class="table table-striped"}
130
130
 
131
131
  <a name="delete_providers_edges_certificateauthorities_certificate_id"></a>
@@ -136,6 +136,9 @@ Delete a certificate authority.
136
136
 
137
137
 
138
138
 
139
+ Wraps DELETE /api/v2/telephony/providers/edges/certificateauthorities/{certificateId}
140
+
141
+
139
142
  ### Example
140
143
  ~~~ruby
141
144
  # load the gem
@@ -192,6 +195,9 @@ Delete a DID Pool by ID.
192
195
 
193
196
 
194
197
 
198
+ Wraps DELETE /api/v2/telephony/providers/edges/didpools/{didPoolId}
199
+
200
+
195
201
  ### Example
196
202
  ~~~ruby
197
203
  # load the gem
@@ -248,6 +254,9 @@ Delete a edge.
248
254
 
249
255
 
250
256
 
257
+ Wraps DELETE /api/v2/telephony/providers/edges/{edgeId}
258
+
259
+
251
260
  ### Example
252
261
  ~~~ruby
253
262
  # load the gem
@@ -304,6 +313,9 @@ Delete an edge logical interface
304
313
 
305
314
 
306
315
 
316
+ Wraps DELETE /api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces/{interfaceId}
317
+
318
+
307
319
  ### Example
308
320
  ~~~ruby
309
321
  # load the gem
@@ -362,6 +374,9 @@ Cancels any in-progress update for this edge.
362
374
 
363
375
 
364
376
 
377
+ Wraps DELETE /api/v2/telephony/providers/edges/{edgeId}/softwareupdate
378
+
379
+
365
380
  ### Example
366
381
  ~~~ruby
367
382
  # load the gem
@@ -418,6 +433,9 @@ Delete an edge group.
418
433
 
419
434
 
420
435
 
436
+ Wraps DELETE /api/v2/telephony/providers/edges/edgegroups/{edgeGroupId}
437
+
438
+
421
439
  ### Example
422
440
  ~~~ruby
423
441
  # load the gem
@@ -474,6 +492,9 @@ Delete endpoint
474
492
 
475
493
 
476
494
 
495
+ Wraps DELETE /api/v2/telephony/providers/edges/endpoints/{endpointId}
496
+
497
+
477
498
  ### Example
478
499
  ~~~ruby
479
500
  # load the gem
@@ -530,6 +551,9 @@ Delete an extension pool by ID
530
551
 
531
552
 
532
553
 
554
+ Wraps DELETE /api/v2/telephony/providers/edges/extensionpools/{extensionPoolId}
555
+
556
+
533
557
  ### Example
534
558
  ~~~ruby
535
559
  # load the gem
@@ -586,6 +610,9 @@ Delete Outbound Route
586
610
 
587
611
 
588
612
 
613
+ Wraps DELETE /api/v2/telephony/providers/edges/outboundroutes/{outboundRouteId}
614
+
615
+
589
616
  ### Example
590
617
  ~~~ruby
591
618
  # load the gem
@@ -642,6 +669,9 @@ Delete a Phone Base Settings by ID
642
669
 
643
670
 
644
671
 
672
+ Wraps DELETE /api/v2/telephony/providers/edges/phonebasesettings/{phoneBaseId}
673
+
674
+
645
675
  ### Example
646
676
  ~~~ruby
647
677
  # load the gem
@@ -698,6 +728,9 @@ Delete a Phone by ID
698
728
 
699
729
 
700
730
 
731
+ Wraps DELETE /api/v2/telephony/providers/edges/phones/{phoneId}
732
+
733
+
701
734
  ### Example
702
735
  ~~~ruby
703
736
  # load the gem
@@ -754,6 +787,9 @@ Delete a Site by ID
754
787
 
755
788
 
756
789
 
790
+ Wraps DELETE /api/v2/telephony/providers/edges/sites/{siteId}
791
+
792
+
757
793
  ### Example
758
794
  ~~~ruby
759
795
  # load the gem
@@ -810,6 +846,9 @@ Delete Outbound Route
810
846
 
811
847
 
812
848
 
849
+ Wraps DELETE /api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId}
850
+
851
+
813
852
  ### Example
814
853
  ~~~ruby
815
854
  # load the gem
@@ -866,6 +905,9 @@ Delete a Trunk Base Settings object by ID
866
905
 
867
906
 
868
907
 
908
+ Wraps DELETE /api/v2/telephony/providers/edges/trunkbasesettings/{trunkBaseSettingsId}
909
+
910
+
869
911
  ### Example
870
912
  ~~~ruby
871
913
  # load the gem
@@ -922,6 +964,9 @@ Get the list of edges.
922
964
 
923
965
 
924
966
 
967
+ Wraps GET /api/v2/telephony/providers/edges
968
+
969
+
925
970
  ### Example
926
971
  ~~~ruby
927
972
  # load the gem
@@ -991,6 +1036,9 @@ Get the list of available languages.
991
1036
 
992
1037
 
993
1038
 
1039
+ Wraps GET /api/v2/telephony/providers/edges/availablelanguages
1040
+
1041
+
994
1042
  ### Example
995
1043
  ~~~ruby
996
1044
  # load the gem
@@ -1041,6 +1089,9 @@ Get the list of certificate authorities.
1041
1089
 
1042
1090
 
1043
1091
 
1092
+ Wraps GET /api/v2/telephony/providers/edges/certificateauthorities
1093
+
1094
+
1044
1095
  ### Example
1045
1096
  ~~~ruby
1046
1097
  # load the gem
@@ -1091,6 +1142,9 @@ Get a certificate authority.
1091
1142
 
1092
1143
 
1093
1144
 
1145
+ Wraps GET /api/v2/telephony/providers/edges/certificateauthorities/{certificateId}
1146
+
1147
+
1094
1148
  ### Example
1095
1149
  ~~~ruby
1096
1150
  # load the gem
@@ -1147,6 +1201,9 @@ Get a listing of DID Pools
1147
1201
 
1148
1202
 
1149
1203
 
1204
+ Wraps GET /api/v2/telephony/providers/edges/didpools
1205
+
1206
+
1150
1207
  ### Example
1151
1208
  ~~~ruby
1152
1209
  # load the gem
@@ -1208,6 +1265,9 @@ Get a DID Pool by ID.
1208
1265
 
1209
1266
 
1210
1267
 
1268
+ Wraps GET /api/v2/telephony/providers/edges/didpools/{didPoolId}
1269
+
1270
+
1211
1271
  ### Example
1212
1272
  ~~~ruby
1213
1273
  # load the gem
@@ -1264,6 +1324,9 @@ Get a listing of DIDs
1264
1324
 
1265
1325
 
1266
1326
 
1327
+ Wraps GET /api/v2/telephony/providers/edges/dids
1328
+
1329
+
1267
1330
  ### Example
1268
1331
  ~~~ruby
1269
1332
  # load the gem
@@ -1329,6 +1392,9 @@ Get a DID by ID.
1329
1392
 
1330
1393
 
1331
1394
 
1395
+ Wraps GET /api/v2/telephony/providers/edges/dids/{didId}
1396
+
1397
+
1332
1398
  ### Example
1333
1399
  ~~~ruby
1334
1400
  # load the gem
@@ -1385,6 +1451,9 @@ Get edge.
1385
1451
 
1386
1452
 
1387
1453
 
1454
+ Wraps GET /api/v2/telephony/providers/edges/{edgeId}
1455
+
1456
+
1388
1457
  ### Example
1389
1458
  ~~~ruby
1390
1459
  # load the gem
@@ -1445,6 +1514,9 @@ Get the list of lines.
1445
1514
 
1446
1515
 
1447
1516
 
1517
+ Wraps GET /api/v2/telephony/providers/edges/{edgeId}/lines
1518
+
1519
+
1448
1520
  ### Example
1449
1521
  ~~~ruby
1450
1522
  # load the gem
@@ -1507,6 +1579,9 @@ Get line
1507
1579
 
1508
1580
 
1509
1581
 
1582
+ Wraps GET /api/v2/telephony/providers/edges/{edgeId}/lines/{lineId}
1583
+
1584
+
1510
1585
  ### Example
1511
1586
  ~~~ruby
1512
1587
  # load the gem
@@ -1566,6 +1641,9 @@ Get edge logical interfaces.
1566
1641
 
1567
1642
  Retrieve a list of all configured logical interfaces from a specific edge.
1568
1643
 
1644
+ Wraps GET /api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces
1645
+
1646
+
1569
1647
  ### Example
1570
1648
  ~~~ruby
1571
1649
  # load the gem
@@ -1626,6 +1704,9 @@ Get an edge logical interface
1626
1704
 
1627
1705
 
1628
1706
 
1707
+ Wraps GET /api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces/{interfaceId}
1708
+
1709
+
1629
1710
  ### Example
1630
1711
  ~~~ruby
1631
1712
  # load the gem
@@ -1689,6 +1770,9 @@ Get an Edge logs job.
1689
1770
 
1690
1771
 
1691
1772
 
1773
+ Wraps GET /api/v2/telephony/providers/edges/{edgeId}/logs/jobs/{jobId}
1774
+
1775
+
1692
1776
  ### Example
1693
1777
  ~~~ruby
1694
1778
  # load the gem
@@ -1748,6 +1832,9 @@ Get the edge metrics.
1748
1832
 
1749
1833
 
1750
1834
 
1835
+ Wraps GET /api/v2/telephony/providers/edges/{edgeId}/metrics
1836
+
1837
+
1751
1838
  ### Example
1752
1839
  ~~~ruby
1753
1840
  # load the gem
@@ -1804,6 +1891,9 @@ Retrieve a list of all configured physical interfaces from a specific edge.
1804
1891
 
1805
1892
 
1806
1893
 
1894
+ Wraps GET /api/v2/telephony/providers/edges/{edgeId}/physicalinterfaces
1895
+
1896
+
1807
1897
  ### Example
1808
1898
  ~~~ruby
1809
1899
  # load the gem
@@ -1860,6 +1950,9 @@ Get edge physical interface.
1860
1950
 
1861
1951
  Retrieve a physical interface from a specific edge.
1862
1952
 
1953
+ Wraps GET /api/v2/telephony/providers/edges/{edgeId}/physicalinterfaces/{interfaceId}
1954
+
1955
+
1863
1956
  ### Example
1864
1957
  ~~~ruby
1865
1958
  # load the gem
@@ -1919,6 +2012,9 @@ Get the setup package for a locally deployed edge device. This is needed to comp
1919
2012
 
1920
2013
 
1921
2014
 
2015
+ Wraps GET /api/v2/telephony/providers/edges/{edgeId}/setuppackage
2016
+
2017
+
1922
2018
  ### Example
1923
2019
  ~~~ruby
1924
2020
  # load the gem
@@ -1975,6 +2071,9 @@ Gets software update status information about any edge.
1975
2071
 
1976
2072
 
1977
2073
 
2074
+ Wraps GET /api/v2/telephony/providers/edges/{edgeId}/softwareupdate
2075
+
2076
+
1978
2077
  ### Example
1979
2078
  ~~~ruby
1980
2079
  # load the gem
@@ -2031,6 +2130,9 @@ Gets all the available software versions for this edge.
2031
2130
 
2032
2131
 
2033
2132
 
2133
+ Wraps GET /api/v2/telephony/providers/edges/{edgeId}/softwareversions
2134
+
2135
+
2034
2136
  ### Example
2035
2137
  ~~~ruby
2036
2138
  # load the gem
@@ -2087,6 +2189,9 @@ Get the list of edge groups.
2087
2189
 
2088
2190
 
2089
2191
 
2192
+ Wraps GET /api/v2/telephony/providers/edges/edgegroups
2193
+
2194
+
2090
2195
  ### Example
2091
2196
  ~~~ruby
2092
2197
  # load the gem
@@ -2152,6 +2257,9 @@ Get edge group.
2152
2257
 
2153
2258
 
2154
2259
 
2260
+ Wraps GET /api/v2/telephony/providers/edges/edgegroups/{edgeGroupId}
2261
+
2262
+
2155
2263
  ### Example
2156
2264
  ~~~ruby
2157
2265
  # load the gem
@@ -2212,6 +2320,9 @@ Get the edge version report.
2212
2320
 
2213
2321
  The report will not have consistent data about the edge version(s) until all edges have been reset.
2214
2322
 
2323
+ Wraps GET /api/v2/telephony/providers/edges/edgeversionreport
2324
+
2325
+
2215
2326
  ### Example
2216
2327
  ~~~ruby
2217
2328
  # load the gem
@@ -2262,6 +2373,9 @@ Get endpoints
2262
2373
 
2263
2374
 
2264
2375
 
2376
+ Wraps GET /api/v2/telephony/providers/edges/endpoints
2377
+
2378
+
2265
2379
  ### Example
2266
2380
  ~~~ruby
2267
2381
  # load the gem
@@ -2325,6 +2439,9 @@ Get endpoint
2325
2439
 
2326
2440
 
2327
2441
 
2442
+ Wraps GET /api/v2/telephony/providers/edges/endpoints/{endpointId}
2443
+
2444
+
2328
2445
  ### Example
2329
2446
  ~~~ruby
2330
2447
  # load the gem
@@ -2381,6 +2498,9 @@ Get a listing of extension pools
2381
2498
 
2382
2499
 
2383
2500
 
2501
+ Wraps GET /api/v2/telephony/providers/edges/extensionpools
2502
+
2503
+
2384
2504
  ### Example
2385
2505
  ~~~ruby
2386
2506
  # load the gem
@@ -2444,6 +2564,9 @@ Get an extension pool by ID
2444
2564
 
2445
2565
 
2446
2566
 
2567
+ Wraps GET /api/v2/telephony/providers/edges/extensionpools/{extensionPoolId}
2568
+
2569
+
2447
2570
  ### Example
2448
2571
  ~~~ruby
2449
2572
  # load the gem
@@ -2500,6 +2623,9 @@ Get a listing of extensions
2500
2623
 
2501
2624
 
2502
2625
 
2626
+ Wraps GET /api/v2/telephony/providers/edges/extensions
2627
+
2628
+
2503
2629
  ### Example
2504
2630
  ~~~ruby
2505
2631
  # load the gem
@@ -2565,6 +2691,9 @@ Get an extension by ID.
2565
2691
 
2566
2692
 
2567
2693
 
2694
+ Wraps GET /api/v2/telephony/providers/edges/extensions/{extensionId}
2695
+
2696
+
2568
2697
  ### Example
2569
2698
  ~~~ruby
2570
2699
  # load the gem
@@ -2621,6 +2750,9 @@ Get a listing of line base settings objects
2621
2750
 
2622
2751
 
2623
2752
 
2753
+ Wraps GET /api/v2/telephony/providers/edges/linebasesettings
2754
+
2755
+
2624
2756
  ### Example
2625
2757
  ~~~ruby
2626
2758
  # load the gem
@@ -2684,6 +2816,9 @@ Get a line base settings object by ID
2684
2816
 
2685
2817
 
2686
2818
 
2819
+ Wraps GET /api/v2/telephony/providers/edges/linebasesettings/{lineBaseId}
2820
+
2821
+
2687
2822
  ### Example
2688
2823
  ~~~ruby
2689
2824
  # load the gem
@@ -2740,6 +2875,9 @@ Get a list of Lines
2740
2875
 
2741
2876
 
2742
2877
 
2878
+ Wraps GET /api/v2/telephony/providers/edges/lines
2879
+
2880
+
2743
2881
  ### Example
2744
2882
  ~~~ruby
2745
2883
  # load the gem
@@ -2805,6 +2943,9 @@ Get a Line by ID
2805
2943
 
2806
2944
 
2807
2945
 
2946
+ Wraps GET /api/v2/telephony/providers/edges/lines/{lineId}
2947
+
2948
+
2808
2949
  ### Example
2809
2950
  ~~~ruby
2810
2951
  # load the gem
@@ -2861,6 +3002,9 @@ Get a Line instance template based on a Line Base Settings object. This object c
2861
3002
 
2862
3003
 
2863
3004
 
3005
+ Wraps GET /api/v2/telephony/providers/edges/lines/template
3006
+
3007
+
2864
3008
  ### Example
2865
3009
  ~~~ruby
2866
3010
  # load the gem
@@ -2917,6 +3061,9 @@ Get the metrics for a list of edges.
2917
3061
 
2918
3062
 
2919
3063
 
3064
+ Wraps GET /api/v2/telephony/providers/edges/metrics
3065
+
3066
+
2920
3067
  ### Example
2921
3068
  ~~~ruby
2922
3069
  # load the gem
@@ -2973,6 +3120,9 @@ Get outbound routes
2973
3120
 
2974
3121
 
2975
3122
 
3123
+ Wraps GET /api/v2/telephony/providers/edges/outboundroutes
3124
+
3125
+
2976
3126
  ### Example
2977
3127
  ~~~ruby
2978
3128
  # load the gem
@@ -3038,6 +3188,9 @@ Get outbound route
3038
3188
 
3039
3189
 
3040
3190
 
3191
+ Wraps GET /api/v2/telephony/providers/edges/outboundroutes/{outboundRouteId}
3192
+
3193
+
3041
3194
  ### Example
3042
3195
  ~~~ruby
3043
3196
  # load the gem
@@ -3094,6 +3247,9 @@ Get a list of Phone Base Settings objects
3094
3247
 
3095
3248
 
3096
3249
 
3250
+ Wraps GET /api/v2/telephony/providers/edges/phonebasesettings
3251
+
3252
+
3097
3253
  ### Example
3098
3254
  ~~~ruby
3099
3255
  # load the gem
@@ -3159,6 +3315,9 @@ Get a list of available makes and models to create a new Phone Base Settings
3159
3315
 
3160
3316
 
3161
3317
 
3318
+ Wraps GET /api/v2/telephony/providers/edges/phonebasesettings/availablemetabases
3319
+
3320
+
3162
3321
  ### Example
3163
3322
  ~~~ruby
3164
3323
  # load the gem
@@ -3218,6 +3377,9 @@ Get a Phone Base Settings object by ID
3218
3377
 
3219
3378
 
3220
3379
 
3380
+ Wraps GET /api/v2/telephony/providers/edges/phonebasesettings/{phoneBaseId}
3381
+
3382
+
3221
3383
  ### Example
3222
3384
  ~~~ruby
3223
3385
  # load the gem
@@ -3274,6 +3436,9 @@ Get a Phone Base Settings instance template from a given make and model. This ob
3274
3436
 
3275
3437
 
3276
3438
 
3439
+ Wraps GET /api/v2/telephony/providers/edges/phonebasesettings/template
3440
+
3441
+
3277
3442
  ### Example
3278
3443
  ~~~ruby
3279
3444
  # load the gem
@@ -3330,6 +3495,9 @@ Get a list of Phone Instances
3330
3495
 
3331
3496
 
3332
3497
 
3498
+ Wraps GET /api/v2/telephony/providers/edges/phones
3499
+
3500
+
3333
3501
  ### Example
3334
3502
  ~~~ruby
3335
3503
  # load the gem
@@ -3413,6 +3581,9 @@ Get a Phone by ID
3413
3581
 
3414
3582
 
3415
3583
 
3584
+ Wraps GET /api/v2/telephony/providers/edges/phones/{phoneId}
3585
+
3586
+
3416
3587
  ### Example
3417
3588
  ~~~ruby
3418
3589
  # load the gem
@@ -3469,6 +3640,9 @@ Get a Phone instance template based on a Phone Base Settings object. This object
3469
3640
 
3470
3641
 
3471
3642
 
3643
+ Wraps GET /api/v2/telephony/providers/edges/phones/template
3644
+
3645
+
3472
3646
  ### Example
3473
3647
  ~~~ruby
3474
3648
  # load the gem
@@ -3525,6 +3699,9 @@ Get the list of Sites.
3525
3699
 
3526
3700
 
3527
3701
 
3702
+ Wraps GET /api/v2/telephony/providers/edges/sites
3703
+
3704
+
3528
3705
  ### Example
3529
3706
  ~~~ruby
3530
3707
  # load the gem
@@ -3594,6 +3771,9 @@ Get a Site by ID.
3594
3771
 
3595
3772
 
3596
3773
 
3774
+ Wraps GET /api/v2/telephony/providers/edges/sites/{siteId}
3775
+
3776
+
3597
3777
  ### Example
3598
3778
  ~~~ruby
3599
3779
  # load the gem
@@ -3650,6 +3830,9 @@ Get the list of Number Plans for this Site.
3650
3830
 
3651
3831
 
3652
3832
 
3833
+ Wraps GET /api/v2/telephony/providers/edges/sites/{siteId}/numberplans
3834
+
3835
+
3653
3836
  ### Example
3654
3837
  ~~~ruby
3655
3838
  # load the gem
@@ -3706,6 +3889,9 @@ Get a list of Classifications for this Site
3706
3889
 
3707
3890
 
3708
3891
 
3892
+ Wraps GET /api/v2/telephony/providers/edges/sites/{siteId}/numberplans/classifications
3893
+
3894
+
3709
3895
  ### Example
3710
3896
  ~~~ruby
3711
3897
  # load the gem
@@ -3766,6 +3952,9 @@ Get a Number Plan by ID.
3766
3952
 
3767
3953
 
3768
3954
 
3955
+ Wraps GET /api/v2/telephony/providers/edges/sites/{siteId}/numberplans/{numberPlanId}
3956
+
3957
+
3769
3958
  ### Example
3770
3959
  ~~~ruby
3771
3960
  # load the gem
@@ -3825,6 +4014,9 @@ Get outbound routes
3825
4014
 
3826
4015
 
3827
4016
 
4017
+ Wraps GET /api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes
4018
+
4019
+
3828
4020
  ### Example
3829
4021
  ~~~ruby
3830
4022
  # load the gem
@@ -3891,6 +4083,9 @@ Get an outbound route
3891
4083
 
3892
4084
 
3893
4085
 
4086
+ Wraps GET /api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId}
4087
+
4088
+
3894
4089
  ### Example
3895
4090
  ~~~ruby
3896
4091
  # load the gem
@@ -3957,6 +4152,9 @@ Get a list of Edge-compatible time zones
3957
4152
 
3958
4153
 
3959
4154
 
4155
+ Wraps GET /api/v2/telephony/providers/edges/timezones
4156
+
4157
+
3960
4158
  ### Example
3961
4159
  ~~~ruby
3962
4160
  # load the gem
@@ -4016,6 +4214,9 @@ Get Trunk Base Settings listing
4016
4214
 
4017
4215
  Managed properties will not be returned unless the user is assigned the managed:all:all permission.
4018
4216
 
4217
+ Wraps GET /api/v2/telephony/providers/edges/trunkbasesettings
4218
+
4219
+
4019
4220
  ### Example
4020
4221
  ~~~ruby
4021
4222
  # load the gem
@@ -4087,6 +4288,9 @@ Get a list of available makes and models to create a new Trunk Base Settings
4087
4288
 
4088
4289
 
4089
4290
 
4291
+ Wraps GET /api/v2/telephony/providers/edges/trunkbasesettings/availablemetabases
4292
+
4293
+
4090
4294
  ### Example
4091
4295
  ~~~ruby
4092
4296
  # load the gem
@@ -4148,6 +4352,9 @@ Get a Trunk Base Settings instance template from a given make and model. This ob
4148
4352
 
4149
4353
 
4150
4354
 
4355
+ Wraps GET /api/v2/telephony/providers/edges/trunkbasesettings/template
4356
+
4357
+
4151
4358
  ### Example
4152
4359
  ~~~ruby
4153
4360
  # load the gem
@@ -4204,6 +4411,9 @@ Get a Trunk Base Settings object by ID
4204
4411
 
4205
4412
  Managed properties will not be returned unless the user is assigned the managed:all:all permission.
4206
4413
 
4414
+ Wraps GET /api/v2/telephony/providers/edges/trunkbasesettings/{trunkBaseSettingsId}
4415
+
4416
+
4207
4417
  ### Example
4208
4418
  ~~~ruby
4209
4419
  # load the gem
@@ -4264,6 +4474,9 @@ Get the list of available trunks.
4264
4474
 
4265
4475
  Trunks are created by assigning trunk base settings to an Edge or Edge Group.
4266
4476
 
4477
+ Wraps GET /api/v2/telephony/providers/edges/trunks
4478
+
4479
+
4267
4480
  ### Example
4268
4481
  ~~~ruby
4269
4482
  # load the gem
@@ -4333,6 +4546,9 @@ Get a Trunk by ID
4333
4546
 
4334
4547
 
4335
4548
 
4549
+ Wraps GET /api/v2/telephony/providers/edges/trunks/{trunkId}
4550
+
4551
+
4336
4552
  ### Example
4337
4553
  ~~~ruby
4338
4554
  # load the gem
@@ -4389,6 +4605,9 @@ Get Counts of trunks that have recording disabled or enabled
4389
4605
 
4390
4606
 
4391
4607
 
4608
+ Wraps GET /api/v2/telephony/providers/edges/trunkswithrecording
4609
+
4610
+
4392
4611
  ### Example
4393
4612
  ~~~ruby
4394
4613
  # load the gem
@@ -4446,6 +4665,9 @@ Lists available schema categories (Deprecated)
4446
4665
 
4447
4666
 
4448
4667
 
4668
+ Wraps GET /api/v2/configuration/schemas/edges/vnext
4669
+
4670
+
4449
4671
  ### Example
4450
4672
  ~~~ruby
4451
4673
  # load the gem
@@ -4505,6 +4727,9 @@ List schemas of a specific category (Deprecated)
4505
4727
 
4506
4728
 
4507
4729
 
4730
+ Wraps GET /api/v2/configuration/schemas/edges/vnext/{schemaCategory}
4731
+
4732
+
4508
4733
  ### Example
4509
4734
  ~~~ruby
4510
4735
  # load the gem
@@ -4567,6 +4792,9 @@ List schemas of a specific category (Deprecated)
4567
4792
 
4568
4793
 
4569
4794
 
4795
+ Wraps GET /api/v2/configuration/schemas/edges/vnext/{schemaCategory}/{schemaType}
4796
+
4797
+
4570
4798
  ### Example
4571
4799
  ~~~ruby
4572
4800
  # load the gem
@@ -4632,6 +4860,9 @@ Get a json schema (Deprecated)
4632
4860
 
4633
4861
 
4634
4862
 
4863
+ Wraps GET /api/v2/configuration/schemas/edges/vnext/{schemaCategory}/{schemaType}/{schemaId}
4864
+
4865
+
4635
4866
  ### Example
4636
4867
  ~~~ruby
4637
4868
  # load the gem
@@ -4694,6 +4925,9 @@ Get metadata for a schema (Deprecated)
4694
4925
 
4695
4926
 
4696
4927
 
4928
+ Wraps GET /api/v2/configuration/schemas/edges/vnext/{schemaCategory}/{schemaType}/{schemaId}/{extensionType}/{metadataId}
4929
+
4930
+
4697
4931
  ### Example
4698
4932
  ~~~ruby
4699
4933
  # load the gem
@@ -4766,6 +5000,9 @@ Create an edge.
4766
5000
 
4767
5001
 
4768
5002
 
5003
+ Wraps POST /api/v2/telephony/providers/edges
5004
+
5005
+
4769
5006
  ### Example
4770
5007
  ~~~ruby
4771
5008
  # load the gem
@@ -4822,6 +5059,9 @@ Validates a street address
4822
5059
 
4823
5060
 
4824
5061
 
5062
+ Wraps POST /api/v2/telephony/providers/edges/addressvalidation
5063
+
5064
+
4825
5065
  ### Example
4826
5066
  ~~~ruby
4827
5067
  # load the gem
@@ -4878,6 +5118,9 @@ Create a certificate authority.
4878
5118
 
4879
5119
 
4880
5120
 
5121
+ Wraps POST /api/v2/telephony/providers/edges/certificateauthorities
5122
+
5123
+
4881
5124
  ### Example
4882
5125
  ~~~ruby
4883
5126
  # load the gem
@@ -4934,6 +5177,9 @@ Create a new DID pool
4934
5177
 
4935
5178
 
4936
5179
 
5180
+ Wraps POST /api/v2/telephony/providers/edges/didpools
5181
+
5182
+
4937
5183
  ### Example
4938
5184
  ~~~ruby
4939
5185
  # load the gem
@@ -4990,6 +5236,9 @@ Create an edge logical interface.
4990
5236
 
4991
5237
  Create
4992
5238
 
5239
+ Wraps POST /api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces
5240
+
5241
+
4993
5242
  ### Example
4994
5243
  ~~~ruby
4995
5244
  # load the gem
@@ -5049,6 +5298,9 @@ Create a job to upload a list of Edge logs.
5049
5298
 
5050
5299
 
5051
5300
 
5301
+ Wraps POST /api/v2/telephony/providers/edges/{edgeId}/logs/jobs
5302
+
5303
+
5052
5304
  ### Example
5053
5305
  ~~~ruby
5054
5306
  # load the gem
@@ -5108,6 +5360,9 @@ Request that the specified fileIds be uploaded from the Edge.
5108
5360
 
5109
5361
 
5110
5362
 
5363
+ Wraps POST /api/v2/telephony/providers/edges/{edgeId}/logs/jobs/{jobId}/upload
5364
+
5365
+
5111
5366
  ### Example
5112
5367
  ~~~ruby
5113
5368
  # load the gem
@@ -5163,12 +5418,15 @@ nil (empty response body)
5163
5418
 
5164
5419
  <a name="post_providers_edges_edge_id_reboot"></a>
5165
5420
 
5166
- ## -String** post_providers_edges_edge_id_reboot(edge_id)
5421
+ ## -String** post_providers_edges_edge_id_reboot(edge_id, opts)
5167
5422
 
5168
5423
  Reboot an Edge
5169
5424
 
5170
5425
 
5171
5426
 
5427
+ Wraps POST /api/v2/telephony/providers/edges/{edgeId}/reboot
5428
+
5429
+
5172
5430
  ### Example
5173
5431
  ~~~ruby
5174
5432
  # load the gem
@@ -5188,10 +5446,13 @@ api_instance = PureCloud::TelephonyProvidersEdgeApi.new
5188
5446
 
5189
5447
  edge_id = "edge_id_example" # String | Edge ID
5190
5448
 
5449
+ opts = {
5450
+ body: PureCloud::EdgeRebootParameters.new # EdgeRebootParameters | Parameters for the edge reboot
5451
+ }
5191
5452
 
5192
5453
  begin
5193
5454
  #Reboot an Edge
5194
- result = api_instance.post_providers_edges_edge_id_reboot(edge_id)
5455
+ result = api_instance.post_providers_edges_edge_id_reboot(edge_id, opts)
5195
5456
  p result
5196
5457
  rescue PureCloud::ApiError => e
5197
5458
  puts "Exception when calling TelephonyProvidersEdgeApi->post_providers_edges_edge_id_reboot: #{e}"
@@ -5203,6 +5464,7 @@ end
5203
5464
  Name | Type | Description | Notes
5204
5465
  ------------- | ------------- | ------------- | -------------
5205
5466
  **edge_id** | **String**| Edge ID |
5467
+ **body** | [**EdgeRebootParameters**](EdgeRebootParameters.html)| Parameters for the edge reboot | [optional]
5206
5468
  {: class="table table-striped"}
5207
5469
 
5208
5470
 
@@ -5225,6 +5487,9 @@ Starts a software update for this edge.
5225
5487
 
5226
5488
 
5227
5489
 
5490
+ Wraps POST /api/v2/telephony/providers/edges/{edgeId}/softwareupdate
5491
+
5492
+
5228
5493
  ### Example
5229
5494
  ~~~ruby
5230
5495
  # load the gem
@@ -5284,6 +5549,9 @@ Unpair an Edge
5284
5549
 
5285
5550
 
5286
5551
 
5552
+ Wraps POST /api/v2/telephony/providers/edges/{edgeId}/unpair
5553
+
5554
+
5287
5555
  ### Example
5288
5556
  ~~~ruby
5289
5557
  # load the gem
@@ -5340,6 +5608,9 @@ Create an edge group.
5340
5608
 
5341
5609
 
5342
5610
 
5611
+ Wraps POST /api/v2/telephony/providers/edges/edgegroups
5612
+
5613
+
5343
5614
  ### Example
5344
5615
  ~~~ruby
5345
5616
  # load the gem
@@ -5396,6 +5667,9 @@ Create endpoint
5396
5667
 
5397
5668
 
5398
5669
 
5670
+ Wraps POST /api/v2/telephony/providers/edges/endpoints
5671
+
5672
+
5399
5673
  ### Example
5400
5674
  ~~~ruby
5401
5675
  # load the gem
@@ -5452,6 +5726,9 @@ Create a new extension pool
5452
5726
 
5453
5727
 
5454
5728
 
5729
+ Wraps POST /api/v2/telephony/providers/edges/extensionpools
5730
+
5731
+
5455
5732
  ### Example
5456
5733
  ~~~ruby
5457
5734
  # load the gem
@@ -5508,6 +5785,9 @@ Create a file that can be used to configure a hardware Edge's settings.
5508
5785
 
5509
5786
 
5510
5787
 
5788
+ Wraps POST /api/v2/telephony/providers/edges/offlineconfiguration
5789
+
5790
+
5511
5791
  ### Example
5512
5792
  ~~~ruby
5513
5793
  # load the gem
@@ -5564,6 +5844,9 @@ Create outbound rule
5564
5844
 
5565
5845
 
5566
5846
 
5847
+ Wraps POST /api/v2/telephony/providers/edges/outboundroutes
5848
+
5849
+
5567
5850
  ### Example
5568
5851
  ~~~ruby
5569
5852
  # load the gem
@@ -5620,6 +5903,9 @@ Create a new Phone Base Settings object
5620
5903
 
5621
5904
 
5622
5905
 
5906
+ Wraps POST /api/v2/telephony/providers/edges/phonebasesettings
5907
+
5908
+
5623
5909
  ### Example
5624
5910
  ~~~ruby
5625
5911
  # load the gem
@@ -5676,6 +5962,9 @@ Create a new Phone
5676
5962
 
5677
5963
 
5678
5964
 
5965
+ Wraps POST /api/v2/telephony/providers/edges/phones
5966
+
5967
+
5679
5968
  ### Example
5680
5969
  ~~~ruby
5681
5970
  # load the gem
@@ -5732,6 +6021,9 @@ Reboot a Phone
5732
6021
 
5733
6022
 
5734
6023
 
6024
+ Wraps POST /api/v2/telephony/providers/edges/phones/{phoneId}/reboot
6025
+
6026
+
5735
6027
  ### Example
5736
6028
  ~~~ruby
5737
6029
  # load the gem
@@ -5787,6 +6079,9 @@ Reboot Multiple Phones
5787
6079
 
5788
6080
 
5789
6081
 
6082
+ Wraps POST /api/v2/telephony/providers/edges/phones/reboot
6083
+
6084
+
5790
6085
  ### Example
5791
6086
  ~~~ruby
5792
6087
  # load the gem
@@ -5842,6 +6137,9 @@ Create a Site.
5842
6137
 
5843
6138
 
5844
6139
 
6140
+ Wraps POST /api/v2/telephony/providers/edges/sites
6141
+
6142
+
5845
6143
  ### Example
5846
6144
  ~~~ruby
5847
6145
  # load the gem
@@ -5898,6 +6196,9 @@ Create outbound route
5898
6196
 
5899
6197
 
5900
6198
 
6199
+ Wraps POST /api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes
6200
+
6201
+
5901
6202
  ### Example
5902
6203
  ~~~ruby
5903
6204
  # load the gem
@@ -5957,6 +6258,9 @@ Triggers the rebalance operation.
5957
6258
 
5958
6259
 
5959
6260
 
6261
+ Wraps POST /api/v2/telephony/providers/edges/sites/{siteId}/rebalance
6262
+
6263
+
5960
6264
  ### Example
5961
6265
  ~~~ruby
5962
6266
  # load the gem
@@ -6012,6 +6316,9 @@ Create a Trunk Base Settings object
6012
6316
 
6013
6317
 
6014
6318
 
6319
+ Wraps POST /api/v2/telephony/providers/edges/trunkbasesettings
6320
+
6321
+
6015
6322
  ### Example
6016
6323
  ~~~ruby
6017
6324
  # load the gem
@@ -6068,6 +6375,9 @@ Update a certificate authority.
6068
6375
 
6069
6376
 
6070
6377
 
6378
+ Wraps PUT /api/v2/telephony/providers/edges/certificateauthorities/{certificateId}
6379
+
6380
+
6071
6381
  ### Example
6072
6382
  ~~~ruby
6073
6383
  # load the gem
@@ -6127,6 +6437,9 @@ Update a DID Pool by ID.
6127
6437
 
6128
6438
 
6129
6439
 
6440
+ Wraps PUT /api/v2/telephony/providers/edges/didpools/{didPoolId}
6441
+
6442
+
6130
6443
  ### Example
6131
6444
  ~~~ruby
6132
6445
  # load the gem
@@ -6186,6 +6499,9 @@ Update a DID by ID.
6186
6499
 
6187
6500
 
6188
6501
 
6502
+ Wraps PUT /api/v2/telephony/providers/edges/dids/{didId}
6503
+
6504
+
6189
6505
  ### Example
6190
6506
  ~~~ruby
6191
6507
  # load the gem
@@ -6245,6 +6561,9 @@ Update a edge.
6245
6561
 
6246
6562
 
6247
6563
 
6564
+ Wraps PUT /api/v2/telephony/providers/edges/{edgeId}
6565
+
6566
+
6248
6567
  ### Example
6249
6568
  ~~~ruby
6250
6569
  # load the gem
@@ -6304,6 +6623,9 @@ Update a line.
6304
6623
 
6305
6624
 
6306
6625
 
6626
+ Wraps PUT /api/v2/telephony/providers/edges/{edgeId}/lines/{lineId}
6627
+
6628
+
6307
6629
  ### Example
6308
6630
  ~~~ruby
6309
6631
  # load the gem
@@ -6366,6 +6688,9 @@ Update an edge logical interface.
6366
6688
 
6367
6689
 
6368
6690
 
6691
+ Wraps PUT /api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces/{interfaceId}
6692
+
6693
+
6369
6694
  ### Example
6370
6695
  ~~~ruby
6371
6696
  # load the gem
@@ -6428,6 +6753,9 @@ Update an edge group.
6428
6753
 
6429
6754
 
6430
6755
 
6756
+ Wraps PUT /api/v2/telephony/providers/edges/edgegroups/{edgeGroupId}
6757
+
6758
+
6431
6759
  ### Example
6432
6760
  ~~~ruby
6433
6761
  # load the gem
@@ -6487,6 +6815,9 @@ Update endpoint
6487
6815
 
6488
6816
 
6489
6817
 
6818
+ Wraps PUT /api/v2/telephony/providers/edges/endpoints/{endpointId}
6819
+
6820
+
6490
6821
  ### Example
6491
6822
  ~~~ruby
6492
6823
  # load the gem
@@ -6546,6 +6877,9 @@ Update an extension pool by ID
6546
6877
 
6547
6878
 
6548
6879
 
6880
+ Wraps PUT /api/v2/telephony/providers/edges/extensionpools/{extensionPoolId}
6881
+
6882
+
6549
6883
  ### Example
6550
6884
  ~~~ruby
6551
6885
  # load the gem
@@ -6605,6 +6939,9 @@ Update an extension by ID.
6605
6939
 
6606
6940
 
6607
6941
 
6942
+ Wraps PUT /api/v2/telephony/providers/edges/extensions/{extensionId}
6943
+
6944
+
6608
6945
  ### Example
6609
6946
  ~~~ruby
6610
6947
  # load the gem
@@ -6664,6 +7001,9 @@ Update outbound route
6664
7001
 
6665
7002
 
6666
7003
 
7004
+ Wraps PUT /api/v2/telephony/providers/edges/outboundroutes/{outboundRouteId}
7005
+
7006
+
6667
7007
  ### Example
6668
7008
  ~~~ruby
6669
7009
  # load the gem
@@ -6723,6 +7063,9 @@ Update a Phone Base Settings by ID
6723
7063
 
6724
7064
 
6725
7065
 
7066
+ Wraps PUT /api/v2/telephony/providers/edges/phonebasesettings/{phoneBaseId}
7067
+
7068
+
6726
7069
  ### Example
6727
7070
  ~~~ruby
6728
7071
  # load the gem
@@ -6782,6 +7125,9 @@ Update a Phone by ID
6782
7125
 
6783
7126
 
6784
7127
 
7128
+ Wraps PUT /api/v2/telephony/providers/edges/phones/{phoneId}
7129
+
7130
+
6785
7131
  ### Example
6786
7132
  ~~~ruby
6787
7133
  # load the gem
@@ -6841,6 +7187,9 @@ Update a Site by ID.
6841
7187
 
6842
7188
 
6843
7189
 
7190
+ Wraps PUT /api/v2/telephony/providers/edges/sites/{siteId}
7191
+
7192
+
6844
7193
  ### Example
6845
7194
  ~~~ruby
6846
7195
  # load the gem
@@ -6900,6 +7249,9 @@ Update the list of Number Plans.
6900
7249
 
6901
7250
 
6902
7251
 
7252
+ Wraps PUT /api/v2/telephony/providers/edges/sites/{siteId}/numberplans
7253
+
7254
+
6903
7255
  ### Example
6904
7256
  ~~~ruby
6905
7257
  # load the gem
@@ -6959,6 +7311,9 @@ Update outbound route
6959
7311
 
6960
7312
 
6961
7313
 
7314
+ Wraps PUT /api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId}
7315
+
7316
+
6962
7317
  ### Example
6963
7318
  ~~~ruby
6964
7319
  # load the gem
@@ -7018,6 +7373,9 @@ Update a Trunk Base Settings object by ID
7018
7373
 
7019
7374
 
7020
7375
 
7376
+ Wraps PUT /api/v2/telephony/providers/edges/trunkbasesettings/{trunkBaseSettingsId}
7377
+
7378
+
7021
7379
  ### Example
7022
7380
  ~~~ruby
7023
7381
  # load the gem