phone_com_client 1.0.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 (542) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +7 -0
  3. data/Gemfile.lock +69 -0
  4. data/LICENSE +21 -0
  5. data/README.md +344 -0
  6. data/Rakefile +8 -0
  7. data/docs/AccountFull.md +14 -0
  8. data/docs/AccountSummary.md +9 -0
  9. data/docs/AccountsApi.md +127 -0
  10. data/docs/Address.md +13 -0
  11. data/docs/AddressListContacts.md +13 -0
  12. data/docs/ApplicationFull.md +9 -0
  13. data/docs/ApplicationSummary.md +9 -0
  14. data/docs/ApplicationsApi.md +137 -0
  15. data/docs/AvailableNumbersApi.md +94 -0
  16. data/docs/AvailableNumbersFull.md +18 -0
  17. data/docs/CallDetails.md +12 -0
  18. data/docs/CallFull.md +8 -0
  19. data/docs/CallLogFull.md +27 -0
  20. data/docs/CallLogsApi.md +149 -0
  21. data/docs/CallNotifications.md +9 -0
  22. data/docs/CallbackObject.md +13 -0
  23. data/docs/CallerIdFull.md +10 -0
  24. data/docs/CallerIdPhoneNumber.md +9 -0
  25. data/docs/CallerIdsApi.md +82 -0
  26. data/docs/CallsApi.md +67 -0
  27. data/docs/ContactAccount.md +14 -0
  28. data/docs/ContactFull.md +26 -0
  29. data/docs/ContactResponse.md +14 -0
  30. data/docs/ContactSummary.md +15 -0
  31. data/docs/ContactsApi.md +333 -0
  32. data/docs/CreateCallParams.md +15 -0
  33. data/docs/CreateContactParams.md +23 -0
  34. data/docs/CreateDeviceParams.md +9 -0
  35. data/docs/CreateExtensionParams.md +20 -0
  36. data/docs/CreateGroupParams.md +8 -0
  37. data/docs/CreateListenerParams.md +10 -0
  38. data/docs/CreateMediaParams.md +17 -0
  39. data/docs/CreateMenuParams.md +14 -0
  40. data/docs/CreateOauthParams.md +16 -0
  41. data/docs/CreatePaymentParams.md +11 -0
  42. data/docs/CreatePhoneNumberParams.md +15 -0
  43. data/docs/CreatePricingParams.md +10 -0
  44. data/docs/CreateQueueParams.md +14 -0
  45. data/docs/CreateRedirectUriParams.md +8 -0
  46. data/docs/CreateRouteParams.md +10 -0
  47. data/docs/CreateSmsParams.md +11 -0
  48. data/docs/CreateSubaccountParams.md +11 -0
  49. data/docs/CreateTrunkParams.md +14 -0
  50. data/docs/DefaultApi.md +57 -0
  51. data/docs/DeleteEntry.md +8 -0
  52. data/docs/DeviceFull.md +11 -0
  53. data/docs/DeviceMembership.md +9 -0
  54. data/docs/DeviceSummary.md +9 -0
  55. data/docs/DevicesApi.md +316 -0
  56. data/docs/Email.md +9 -0
  57. data/docs/ExpressServiceCodeFull.md +10 -0
  58. data/docs/ExpressServiceCodesApi.md +125 -0
  59. data/docs/ExtensionFull.md +24 -0
  60. data/docs/ExtensionSummary.md +10 -0
  61. data/docs/ExtensionsApi.md +262 -0
  62. data/docs/FilterCallLogs.md +13 -0
  63. data/docs/FilterIdArray.md +8 -0
  64. data/docs/FilterIdDirectionFrom.md +10 -0
  65. data/docs/FilterIdExtensionNameArray.md +10 -0
  66. data/docs/FilterIdGroupIdUpdatedAtArray.md +10 -0
  67. data/docs/FilterIdNameArray.md +9 -0
  68. data/docs/FilterIdNamePhoneNumberArray.md +10 -0
  69. data/docs/FilterListAvailableNumbers.md +17 -0
  70. data/docs/FilterListPhoneNumbersRegions.md +14 -0
  71. data/docs/FilterNameNumberArray.md +9 -0
  72. data/docs/FilterVoicemailArray.md +13 -0
  73. data/docs/FromObject.md +11 -0
  74. data/docs/GetOauthAccessToken.md +10 -0
  75. data/docs/Greeting.md +11 -0
  76. data/docs/GreetingInput.md +11 -0
  77. data/docs/GroupFull.md +9 -0
  78. data/docs/GroupListContacts.md +9 -0
  79. data/docs/GroupSummary.md +9 -0
  80. data/docs/GroupsApi.md +329 -0
  81. data/docs/HoldMusic.md +9 -0
  82. data/docs/Line.md +9 -0
  83. data/docs/ListAccounts.md +13 -0
  84. data/docs/ListApplications.md +13 -0
  85. data/docs/ListAvailableNumbers.md +13 -0
  86. data/docs/ListCallLogs.md +13 -0
  87. data/docs/ListCallerIds.md +13 -0
  88. data/docs/ListContacts.md +13 -0
  89. data/docs/ListDevices.md +13 -0
  90. data/docs/ListExpressServiceCodes.md +13 -0
  91. data/docs/ListExtensions.md +13 -0
  92. data/docs/ListGroups.md +13 -0
  93. data/docs/ListListeners.md +13 -0
  94. data/docs/ListMedia.md +13 -0
  95. data/docs/ListMenus.md +13 -0
  96. data/docs/ListOauthClients.md +13 -0
  97. data/docs/ListOauthClientsRedirectUris.md +12 -0
  98. data/docs/ListPaymentMethods.md +13 -0
  99. data/docs/ListPhoneNumbers.md +13 -0
  100. data/docs/ListPhoneNumbersRegions.md +14 -0
  101. data/docs/ListPricings.md +13 -0
  102. data/docs/ListQueues.md +13 -0
  103. data/docs/ListRoutes.md +13 -0
  104. data/docs/ListSchedules.md +13 -0
  105. data/docs/ListSms.md +13 -0
  106. data/docs/ListTrunks.md +13 -0
  107. data/docs/ListVoicemail.md +13 -0
  108. data/docs/ListenerFull.md +14 -0
  109. data/docs/ListenersApi.md +312 -0
  110. data/docs/MediaApi.md +441 -0
  111. data/docs/MediaFull.md +10 -0
  112. data/docs/MediaSummary.md +9 -0
  113. data/docs/Member.md +9 -0
  114. data/docs/MenuFull.md +15 -0
  115. data/docs/MenuSummary.md +9 -0
  116. data/docs/MenusApi.md +316 -0
  117. data/docs/Notification.md +9 -0
  118. data/docs/NumberRegionsApi.md +98 -0
  119. data/docs/OauthAccessToken.md +12 -0
  120. data/docs/OauthApi.md +176 -0
  121. data/docs/OauthClientFull.md +9 -0
  122. data/docs/OauthClientRedirectUriFull.md +10 -0
  123. data/docs/OauthClientsApi.md +191 -0
  124. data/docs/OauthClientsRedirectUrisApi.md +262 -0
  125. data/docs/Option.md +9 -0
  126. data/docs/PatchPaymentParams.md +8 -0
  127. data/docs/PatchSmsParams.md +8 -0
  128. data/docs/PatchVoicemailParams.md +8 -0
  129. data/docs/PaymentFull.md +20 -0
  130. data/docs/PaymentMethodsApi.md +311 -0
  131. data/docs/PaymentSummary.md +13 -0
  132. data/docs/PhoneNumberContact.md +10 -0
  133. data/docs/PhoneNumberFull.md +16 -0
  134. data/docs/PhoneNumbersApi.md +262 -0
  135. data/docs/PhoneNumbersRegionFull.md +15 -0
  136. data/docs/PingResponse.md +11 -0
  137. data/docs/PricingFull.md +13 -0
  138. data/docs/PricingObject.md +9 -0
  139. data/docs/QueueFull.md +15 -0
  140. data/docs/QueueSummary.md +9 -0
  141. data/docs/QueuesApi.md +316 -0
  142. data/docs/Recipient.md +9 -0
  143. data/docs/RedirectUriFull.md +10 -0
  144. data/docs/ReplaceExtensionParams.md +21 -0
  145. data/docs/ReplaceMenuParams.md +14 -0
  146. data/docs/ReplacePhoneNumberParams.md +13 -0
  147. data/docs/RouteFull.md +11 -0
  148. data/docs/RouteSummary.md +9 -0
  149. data/docs/RoutesApi.md +316 -0
  150. data/docs/RuleSet.md +9 -0
  151. data/docs/RuleSetAction.md +17 -0
  152. data/docs/RuleSetFilter.md +11 -0
  153. data/docs/RuleSetForwardItem.md +14 -0
  154. data/docs/ScheduleFull.md +9 -0
  155. data/docs/ScheduleSummary.md +9 -0
  156. data/docs/SchedulesApi.md +137 -0
  157. data/docs/ScopeDetails.md +8 -0
  158. data/docs/SipAuthentication.md +11 -0
  159. data/docs/SmsApi.md +265 -0
  160. data/docs/SmsForwarding.md +10 -0
  161. data/docs/SmsForwardingParams.md +10 -0
  162. data/docs/SmsFull.md +15 -0
  163. data/docs/SortCallLogs.md +10 -0
  164. data/docs/SortId.md +8 -0
  165. data/docs/SortIdCreatedAt.md +9 -0
  166. data/docs/SortIdExtensionName.md +10 -0
  167. data/docs/SortIdName.md +9 -0
  168. data/docs/SortIdNamePhoneNumber.md +10 -0
  169. data/docs/SortIdUpdatedAt.md +9 -0
  170. data/docs/SortListAvailableNumbers.md +10 -0
  171. data/docs/SortListPhoneNumbersRegions.md +14 -0
  172. data/docs/SortNameNumber.md +9 -0
  173. data/docs/SubaccountPricingApi.md +261 -0
  174. data/docs/SubaccountsApi.md +133 -0
  175. data/docs/TrunkFull.md +15 -0
  176. data/docs/TrunkSummary.md +9 -0
  177. data/docs/TrunksApi.md +314 -0
  178. data/docs/Voicemail.md +13 -0
  179. data/docs/VoicemailApi.md +207 -0
  180. data/docs/VoicemailFull.md +16 -0
  181. data/docs/VoicemailInput.md +13 -0
  182. data/git_push.sh +55 -0
  183. data/lib/phone_com_client/api/accounts_api.rb +144 -0
  184. data/lib/phone_com_client/api/applications_api.rb +166 -0
  185. data/lib/phone_com_client/api/available_numbers_api.rb +131 -0
  186. data/lib/phone_com_client/api/call_logs_api.rb +204 -0
  187. data/lib/phone_com_client/api/caller_ids_api.rb +112 -0
  188. data/lib/phone_com_client/api/calls_api.rb +79 -0
  189. data/lib/phone_com_client/api/contacts_api.rb +377 -0
  190. data/lib/phone_com_client/api/default_api.rb +71 -0
  191. data/lib/phone_com_client/api/devices_api.rb +344 -0
  192. data/lib/phone_com_client/api/express_service_codes_api.rb +140 -0
  193. data/lib/phone_com_client/api/extensions_api.rb +294 -0
  194. data/lib/phone_com_client/api/groups_api.rb +382 -0
  195. data/lib/phone_com_client/api/listeners_api.rb +334 -0
  196. data/lib/phone_com_client/api/media_api.rb +470 -0
  197. data/lib/phone_com_client/api/menus_api.rb +344 -0
  198. data/lib/phone_com_client/api/number_regions_api.rb +149 -0
  199. data/lib/phone_com_client/api/oauth_api.rb +196 -0
  200. data/lib/phone_com_client/api/oauth_clients_api.rb +216 -0
  201. data/lib/phone_com_client/api/oauth_clients_redirect_uris_api.rb +296 -0
  202. data/lib/phone_com_client/api/payment_methods_api.rb +338 -0
  203. data/lib/phone_com_client/api/phone_numbers_api.rb +294 -0
  204. data/lib/phone_com_client/api/queues_api.rb +344 -0
  205. data/lib/phone_com_client/api/routes_api.rb +344 -0
  206. data/lib/phone_com_client/api/schedules_api.rb +166 -0
  207. data/lib/phone_com_client/api/sms_api.rb +316 -0
  208. data/lib/phone_com_client/api/subaccount_pricing_api.rb +300 -0
  209. data/lib/phone_com_client/api/subaccounts_api.rb +156 -0
  210. data/lib/phone_com_client/api/trunks_api.rb +352 -0
  211. data/lib/phone_com_client/api/voicemail_api.rb +252 -0
  212. data/lib/phone_com_client/api_client.rb +389 -0
  213. data/lib/phone_com_client/api_error.rb +38 -0
  214. data/lib/phone_com_client/configuration.rb +209 -0
  215. data/lib/phone_com_client/models/account_full.rb +245 -0
  216. data/lib/phone_com_client/models/account_summary.rb +195 -0
  217. data/lib/phone_com_client/models/address.rb +250 -0
  218. data/lib/phone_com_client/models/address_list_contacts.rb +234 -0
  219. data/lib/phone_com_client/models/application_full.rb +195 -0
  220. data/lib/phone_com_client/models/application_summary.rb +195 -0
  221. data/lib/phone_com_client/models/available_numbers_full.rb +285 -0
  222. data/lib/phone_com_client/models/call_details.rb +225 -0
  223. data/lib/phone_com_client/models/call_full.rb +185 -0
  224. data/lib/phone_com_client/models/call_log_full.rb +377 -0
  225. data/lib/phone_com_client/models/call_notifications.rb +197 -0
  226. data/lib/phone_com_client/models/callback_object.rb +234 -0
  227. data/lib/phone_com_client/models/caller_id_full.rb +205 -0
  228. data/lib/phone_com_client/models/caller_id_phone_number.rb +210 -0
  229. data/lib/phone_com_client/models/contact_account.rb +243 -0
  230. data/lib/phone_com_client/models/contact_full.rb +370 -0
  231. data/lib/phone_com_client/models/contact_response.rb +243 -0
  232. data/lib/phone_com_client/models/contact_summary.rb +255 -0
  233. data/lib/phone_com_client/models/create_call_params.rb +254 -0
  234. data/lib/phone_com_client/models/create_contact_params.rb +340 -0
  235. data/lib/phone_com_client/models/create_device_params.rb +196 -0
  236. data/lib/phone_com_client/models/create_extension_params.rb +302 -0
  237. data/lib/phone_com_client/models/create_group_params.rb +184 -0
  238. data/lib/phone_com_client/models/create_listener_params.rb +206 -0
  239. data/lib/phone_com_client/models/create_media_params.rb +274 -0
  240. data/lib/phone_com_client/models/create_menu_params.rb +239 -0
  241. data/lib/phone_com_client/models/create_oauth_params.rb +264 -0
  242. data/lib/phone_com_client/models/create_payment_params.rb +214 -0
  243. data/lib/phone_com_client/models/create_phone_number_params.rb +251 -0
  244. data/lib/phone_com_client/models/create_pricing_params.rb +204 -0
  245. data/lib/phone_com_client/models/create_queue_params.rb +246 -0
  246. data/lib/phone_com_client/models/create_redirect_uri_params.rb +184 -0
  247. data/lib/phone_com_client/models/create_route_params.rb +206 -0
  248. data/lib/phone_com_client/models/create_sms_params.rb +229 -0
  249. data/lib/phone_com_client/models/create_subaccount_params.rb +224 -0
  250. data/lib/phone_com_client/models/create_trunk_params.rb +246 -0
  251. data/lib/phone_com_client/models/delete_entry.rb +183 -0
  252. data/lib/phone_com_client/models/device_full.rb +216 -0
  253. data/lib/phone_com_client/models/device_membership.rb +195 -0
  254. data/lib/phone_com_client/models/device_summary.rb +195 -0
  255. data/lib/phone_com_client/models/email.rb +194 -0
  256. data/lib/phone_com_client/models/express_service_code_full.rb +207 -0
  257. data/lib/phone_com_client/models/extension_full.rb +342 -0
  258. data/lib/phone_com_client/models/extension_summary.rb +205 -0
  259. data/lib/phone_com_client/models/filter_call_logs.rb +228 -0
  260. data/lib/phone_com_client/models/filter_id_array.rb +183 -0
  261. data/lib/phone_com_client/models/filter_id_direction_from.rb +201 -0
  262. data/lib/phone_com_client/models/filter_id_extension_name_array.rb +201 -0
  263. data/lib/phone_com_client/models/filter_id_group_id_updated_at_array.rb +201 -0
  264. data/lib/phone_com_client/models/filter_id_name_array.rb +192 -0
  265. data/lib/phone_com_client/models/filter_id_name_phone_number_array.rb +201 -0
  266. data/lib/phone_com_client/models/filter_list_available_numbers.rb +264 -0
  267. data/lib/phone_com_client/models/filter_list_phone_numbers_regions.rb +237 -0
  268. data/lib/phone_com_client/models/filter_name_number_array.rb +192 -0
  269. data/lib/phone_com_client/models/filter_voicemail_array.rb +228 -0
  270. data/lib/phone_com_client/models/from_object.rb +215 -0
  271. data/lib/phone_com_client/models/get_oauth_access_token.rb +203 -0
  272. data/lib/phone_com_client/models/greeting.rb +215 -0
  273. data/lib/phone_com_client/models/greeting_input.rb +215 -0
  274. data/lib/phone_com_client/models/group_full.rb +195 -0
  275. data/lib/phone_com_client/models/group_list_contacts.rb +195 -0
  276. data/lib/phone_com_client/models/group_summary.rb +195 -0
  277. data/lib/phone_com_client/models/hold_music.rb +195 -0
  278. data/lib/phone_com_client/models/line.rb +194 -0
  279. data/lib/phone_com_client/models/list_accounts.rb +230 -0
  280. data/lib/phone_com_client/models/list_applications.rb +230 -0
  281. data/lib/phone_com_client/models/list_available_numbers.rb +230 -0
  282. data/lib/phone_com_client/models/list_call_logs.rb +230 -0
  283. data/lib/phone_com_client/models/list_caller_ids.rb +230 -0
  284. data/lib/phone_com_client/models/list_contacts.rb +230 -0
  285. data/lib/phone_com_client/models/list_devices.rb +230 -0
  286. data/lib/phone_com_client/models/list_express_service_codes.rb +232 -0
  287. data/lib/phone_com_client/models/list_extensions.rb +230 -0
  288. data/lib/phone_com_client/models/list_groups.rb +230 -0
  289. data/lib/phone_com_client/models/list_listeners.rb +230 -0
  290. data/lib/phone_com_client/models/list_media.rb +230 -0
  291. data/lib/phone_com_client/models/list_menus.rb +230 -0
  292. data/lib/phone_com_client/models/list_oauth_clients.rb +230 -0
  293. data/lib/phone_com_client/models/list_oauth_clients_redirect_uris.rb +221 -0
  294. data/lib/phone_com_client/models/list_payment_methods.rb +230 -0
  295. data/lib/phone_com_client/models/list_phone_numbers.rb +231 -0
  296. data/lib/phone_com_client/models/list_phone_numbers_regions.rb +241 -0
  297. data/lib/phone_com_client/models/list_pricings.rb +230 -0
  298. data/lib/phone_com_client/models/list_queues.rb +230 -0
  299. data/lib/phone_com_client/models/list_routes.rb +230 -0
  300. data/lib/phone_com_client/models/list_schedules.rb +230 -0
  301. data/lib/phone_com_client/models/list_sms.rb +230 -0
  302. data/lib/phone_com_client/models/list_trunks.rb +230 -0
  303. data/lib/phone_com_client/models/list_voicemail.rb +230 -0
  304. data/lib/phone_com_client/models/listener_full.rb +244 -0
  305. data/lib/phone_com_client/models/media_full.rb +220 -0
  306. data/lib/phone_com_client/models/media_summary.rb +195 -0
  307. data/lib/phone_com_client/models/member.rb +194 -0
  308. data/lib/phone_com_client/models/menu_full.rb +257 -0
  309. data/lib/phone_com_client/models/menu_summary.rb +195 -0
  310. data/lib/phone_com_client/models/notification.rb +197 -0
  311. data/lib/phone_com_client/models/oauth_access_token.rb +219 -0
  312. data/lib/phone_com_client/models/oauth_client_full.rb +195 -0
  313. data/lib/phone_com_client/models/oauth_client_redirect_uri_full.rb +205 -0
  314. data/lib/phone_com_client/models/option.rb +194 -0
  315. data/lib/phone_com_client/models/patch_payment_params.rb +184 -0
  316. data/lib/phone_com_client/models/patch_sms_params.rb +184 -0
  317. data/lib/phone_com_client/models/patch_voicemail_params.rb +184 -0
  318. data/lib/phone_com_client/models/payment_full.rb +305 -0
  319. data/lib/phone_com_client/models/payment_summary.rb +235 -0
  320. data/lib/phone_com_client/models/phone_number_contact.rb +204 -0
  321. data/lib/phone_com_client/models/phone_number_full.rb +262 -0
  322. data/lib/phone_com_client/models/phone_numbers_region_full.rb +255 -0
  323. data/lib/phone_com_client/models/ping_response.rb +211 -0
  324. data/lib/phone_com_client/models/pricing_full.rb +235 -0
  325. data/lib/phone_com_client/models/pricing_object.rb +194 -0
  326. data/lib/phone_com_client/models/queue_full.rb +266 -0
  327. data/lib/phone_com_client/models/queue_summary.rb +205 -0
  328. data/lib/phone_com_client/models/recipient.rb +194 -0
  329. data/lib/phone_com_client/models/redirect_uri_full.rb +204 -0
  330. data/lib/phone_com_client/models/replace_extension_params.rb +312 -0
  331. data/lib/phone_com_client/models/replace_menu_params.rb +239 -0
  332. data/lib/phone_com_client/models/replace_phone_number_params.rb +251 -0
  333. data/lib/phone_com_client/models/route_full.rb +217 -0
  334. data/lib/phone_com_client/models/route_summary.rb +195 -0
  335. data/lib/phone_com_client/models/rule_set.rb +195 -0
  336. data/lib/phone_com_client/models/rule_set_action.rb +292 -0
  337. data/lib/phone_com_client/models/rule_set_filter.rb +230 -0
  338. data/lib/phone_com_client/models/rule_set_forward_item.rb +294 -0
  339. data/lib/phone_com_client/models/schedule_full.rb +195 -0
  340. data/lib/phone_com_client/models/schedule_summary.rb +195 -0
  341. data/lib/phone_com_client/models/scope_details.rb +183 -0
  342. data/lib/phone_com_client/models/sip_authentication.rb +215 -0
  343. data/lib/phone_com_client/models/sms_forwarding.rb +220 -0
  344. data/lib/phone_com_client/models/sms_forwarding_params.rb +220 -0
  345. data/lib/phone_com_client/models/sms_full.rb +257 -0
  346. data/lib/phone_com_client/models/sort_call_logs.rb +201 -0
  347. data/lib/phone_com_client/models/sort_id.rb +183 -0
  348. data/lib/phone_com_client/models/sort_id_created_at.rb +192 -0
  349. data/lib/phone_com_client/models/sort_id_extension_name.rb +201 -0
  350. data/lib/phone_com_client/models/sort_id_name.rb +192 -0
  351. data/lib/phone_com_client/models/sort_id_name_phone_number.rb +201 -0
  352. data/lib/phone_com_client/models/sort_id_updated_at.rb +192 -0
  353. data/lib/phone_com_client/models/sort_list_available_numbers.rb +201 -0
  354. data/lib/phone_com_client/models/sort_list_phone_numbers_regions.rb +237 -0
  355. data/lib/phone_com_client/models/sort_name_number.rb +192 -0
  356. data/lib/phone_com_client/models/trunk_full.rb +297 -0
  357. data/lib/phone_com_client/models/trunk_summary.rb +205 -0
  358. data/lib/phone_com_client/models/voicemail.rb +234 -0
  359. data/lib/phone_com_client/models/voicemail_full.rb +265 -0
  360. data/lib/phone_com_client/models/voicemail_input.rb +234 -0
  361. data/lib/phone_com_client/version.rb +15 -0
  362. data/lib/phone_com_client.rb +214 -0
  363. data/phone_com_client.gemspec +45 -0
  364. data/spec/api/accounts_api_spec.rb +63 -0
  365. data/spec/api/applications_api_spec.rb +67 -0
  366. data/spec/api/available_numbers_api_spec.rb +62 -0
  367. data/spec/api/call_logs_api_spec.rb +73 -0
  368. data/spec/api/caller_ids_api_spec.rb +55 -0
  369. data/spec/api/calls_api_spec.rb +48 -0
  370. data/spec/api/contacts_api_spec.rb +113 -0
  371. data/spec/api/default_api_spec.rb +46 -0
  372. data/spec/api/devices_api_spec.rb +107 -0
  373. data/spec/api/express_service_codes_api_spec.rb +61 -0
  374. data/spec/api/extensions_api_spec.rb +96 -0
  375. data/spec/api/groups_api_spec.rb +112 -0
  376. data/spec/api/listeners_api_spec.rb +105 -0
  377. data/spec/api/media_api_spec.rb +136 -0
  378. data/spec/api/menus_api_spec.rb +107 -0
  379. data/spec/api/number_regions_api_spec.rb +64 -0
  380. data/spec/api/oauth_api_spec.rb +73 -0
  381. data/spec/api/oauth_clients_api_spec.rb +78 -0
  382. data/spec/api/oauth_clients_redirect_uris_api_spec.rb +95 -0
  383. data/spec/api/payment_methods_api_spec.rb +105 -0
  384. data/spec/api/phone_numbers_api_spec.rb +96 -0
  385. data/spec/api/queues_api_spec.rb +107 -0
  386. data/spec/api/routes_api_spec.rb +107 -0
  387. data/spec/api/schedules_api_spec.rb +67 -0
  388. data/spec/api/sms_api_spec.rb +98 -0
  389. data/spec/api/subaccount_pricing_api_spec.rb +95 -0
  390. data/spec/api/subaccounts_api_spec.rb +65 -0
  391. data/spec/api/trunks_api_spec.rb +107 -0
  392. data/spec/api/voicemail_api_spec.rb +85 -0
  393. data/spec/api_client_spec.rb +226 -0
  394. data/spec/configuration_spec.rb +42 -0
  395. data/spec/models/account_full_spec.rb +77 -0
  396. data/spec/models/account_summary_spec.rb +47 -0
  397. data/spec/models/address_list_contacts_spec.rb +71 -0
  398. data/spec/models/address_spec.rb +71 -0
  399. data/spec/models/application_full_spec.rb +47 -0
  400. data/spec/models/application_summary_spec.rb +47 -0
  401. data/spec/models/available_numbers_full_spec.rb +101 -0
  402. data/spec/models/call_details_spec.rb +65 -0
  403. data/spec/models/call_full_spec.rb +41 -0
  404. data/spec/models/call_log_full_spec.rb +155 -0
  405. data/spec/models/call_notifications_spec.rb +47 -0
  406. data/spec/models/callback_object_spec.rb +71 -0
  407. data/spec/models/caller_id_full_spec.rb +53 -0
  408. data/spec/models/caller_id_phone_number_spec.rb +47 -0
  409. data/spec/models/contact_account_spec.rb +77 -0
  410. data/spec/models/contact_full_spec.rb +149 -0
  411. data/spec/models/contact_response_spec.rb +77 -0
  412. data/spec/models/contact_summary_spec.rb +83 -0
  413. data/spec/models/create_call_params_spec.rb +83 -0
  414. data/spec/models/create_contact_params_spec.rb +131 -0
  415. data/spec/models/create_device_params_spec.rb +47 -0
  416. data/spec/models/create_extension_params_spec.rb +113 -0
  417. data/spec/models/create_group_params_spec.rb +41 -0
  418. data/spec/models/create_listener_params_spec.rb +53 -0
  419. data/spec/models/create_media_params_spec.rb +95 -0
  420. data/spec/models/create_menu_params_spec.rb +77 -0
  421. data/spec/models/create_oauth_params_spec.rb +89 -0
  422. data/spec/models/create_payment_params_spec.rb +59 -0
  423. data/spec/models/create_phone_number_params_spec.rb +83 -0
  424. data/spec/models/create_pricing_params_spec.rb +53 -0
  425. data/spec/models/create_queue_params_spec.rb +77 -0
  426. data/spec/models/create_redirect_uri_params_spec.rb +41 -0
  427. data/spec/models/create_route_params_spec.rb +53 -0
  428. data/spec/models/create_sms_params_spec.rb +59 -0
  429. data/spec/models/create_subaccount_params_spec.rb +59 -0
  430. data/spec/models/create_trunk_params_spec.rb +77 -0
  431. data/spec/models/delete_entry_spec.rb +41 -0
  432. data/spec/models/device_full_spec.rb +59 -0
  433. data/spec/models/device_membership_spec.rb +47 -0
  434. data/spec/models/device_summary_spec.rb +47 -0
  435. data/spec/models/email_spec.rb +47 -0
  436. data/spec/models/express_service_code_full_spec.rb +53 -0
  437. data/spec/models/extension_full_spec.rb +137 -0
  438. data/spec/models/extension_summary_spec.rb +53 -0
  439. data/spec/models/filter_call_logs_spec.rb +71 -0
  440. data/spec/models/filter_id_array_spec.rb +41 -0
  441. data/spec/models/filter_id_direction_from_spec.rb +53 -0
  442. data/spec/models/filter_id_extension_name_array_spec.rb +53 -0
  443. data/spec/models/filter_id_group_id_updated_at_array_spec.rb +53 -0
  444. data/spec/models/filter_id_name_array_spec.rb +47 -0
  445. data/spec/models/filter_id_name_phone_number_array_spec.rb +53 -0
  446. data/spec/models/filter_list_available_numbers_spec.rb +95 -0
  447. data/spec/models/filter_list_phone_numbers_regions_spec.rb +77 -0
  448. data/spec/models/filter_name_number_array_spec.rb +47 -0
  449. data/spec/models/filter_voicemail_array_spec.rb +71 -0
  450. data/spec/models/from_object_spec.rb +59 -0
  451. data/spec/models/get_oauth_access_token_spec.rb +53 -0
  452. data/spec/models/greeting_input_spec.rb +59 -0
  453. data/spec/models/greeting_spec.rb +59 -0
  454. data/spec/models/group_full_spec.rb +47 -0
  455. data/spec/models/group_list_contacts_spec.rb +47 -0
  456. data/spec/models/group_summary_spec.rb +47 -0
  457. data/spec/models/hold_music_spec.rb +47 -0
  458. data/spec/models/line_spec.rb +47 -0
  459. data/spec/models/list_accounts_spec.rb +71 -0
  460. data/spec/models/list_applications_spec.rb +71 -0
  461. data/spec/models/list_available_numbers_spec.rb +71 -0
  462. data/spec/models/list_call_logs_spec.rb +71 -0
  463. data/spec/models/list_caller_ids_spec.rb +71 -0
  464. data/spec/models/list_contacts_spec.rb +71 -0
  465. data/spec/models/list_devices_spec.rb +71 -0
  466. data/spec/models/list_express_service_codes_spec.rb +71 -0
  467. data/spec/models/list_extensions_spec.rb +71 -0
  468. data/spec/models/list_groups_spec.rb +71 -0
  469. data/spec/models/list_listeners_spec.rb +71 -0
  470. data/spec/models/list_media_spec.rb +71 -0
  471. data/spec/models/list_menus_spec.rb +71 -0
  472. data/spec/models/list_oauth_clients_redirect_uris_spec.rb +65 -0
  473. data/spec/models/list_oauth_clients_spec.rb +71 -0
  474. data/spec/models/list_payment_methods_spec.rb +71 -0
  475. data/spec/models/list_phone_numbers_regions_spec.rb +77 -0
  476. data/spec/models/list_phone_numbers_spec.rb +71 -0
  477. data/spec/models/list_pricings_spec.rb +71 -0
  478. data/spec/models/list_queues_spec.rb +71 -0
  479. data/spec/models/list_routes_spec.rb +71 -0
  480. data/spec/models/list_schedules_spec.rb +71 -0
  481. data/spec/models/list_sms_spec.rb +71 -0
  482. data/spec/models/list_trunks_spec.rb +71 -0
  483. data/spec/models/list_voicemail_spec.rb +71 -0
  484. data/spec/models/listener_full_spec.rb +77 -0
  485. data/spec/models/media_full_spec.rb +53 -0
  486. data/spec/models/media_summary_spec.rb +47 -0
  487. data/spec/models/member_spec.rb +47 -0
  488. data/spec/models/menu_full_spec.rb +83 -0
  489. data/spec/models/menu_summary_spec.rb +47 -0
  490. data/spec/models/notification_spec.rb +47 -0
  491. data/spec/models/oauth_access_token_spec.rb +65 -0
  492. data/spec/models/oauth_client_full_spec.rb +47 -0
  493. data/spec/models/oauth_client_redirect_uri_full_spec.rb +53 -0
  494. data/spec/models/option_spec.rb +47 -0
  495. data/spec/models/patch_payment_params_spec.rb +41 -0
  496. data/spec/models/patch_sms_params_spec.rb +41 -0
  497. data/spec/models/patch_voicemail_params_spec.rb +41 -0
  498. data/spec/models/payment_full_spec.rb +113 -0
  499. data/spec/models/payment_summary_spec.rb +71 -0
  500. data/spec/models/phone_number_contact_spec.rb +53 -0
  501. data/spec/models/phone_number_full_spec.rb +89 -0
  502. data/spec/models/phone_numbers_region_full_spec.rb +83 -0
  503. data/spec/models/ping_response_spec.rb +59 -0
  504. data/spec/models/pricing_full_spec.rb +71 -0
  505. data/spec/models/pricing_object_spec.rb +47 -0
  506. data/spec/models/queue_full_spec.rb +83 -0
  507. data/spec/models/queue_summary_spec.rb +47 -0
  508. data/spec/models/recipient_spec.rb +47 -0
  509. data/spec/models/redirect_uri_full_spec.rb +53 -0
  510. data/spec/models/replace_extension_params_spec.rb +119 -0
  511. data/spec/models/replace_menu_params_spec.rb +77 -0
  512. data/spec/models/replace_phone_number_params_spec.rb +83 -0
  513. data/spec/models/route_full_spec.rb +59 -0
  514. data/spec/models/route_summary_spec.rb +47 -0
  515. data/spec/models/rule_set_action_spec.rb +95 -0
  516. data/spec/models/rule_set_filter_spec.rb +59 -0
  517. data/spec/models/rule_set_forward_item_spec.rb +77 -0
  518. data/spec/models/rule_set_spec.rb +47 -0
  519. data/spec/models/schedule_full_spec.rb +47 -0
  520. data/spec/models/schedule_summary_spec.rb +47 -0
  521. data/spec/models/scope_details_spec.rb +41 -0
  522. data/spec/models/sip_authentication_spec.rb +59 -0
  523. data/spec/models/sms_forwarding_params_spec.rb +53 -0
  524. data/spec/models/sms_forwarding_spec.rb +53 -0
  525. data/spec/models/sms_full_spec.rb +83 -0
  526. data/spec/models/sort_call_logs_spec.rb +53 -0
  527. data/spec/models/sort_id_created_at_spec.rb +47 -0
  528. data/spec/models/sort_id_extension_name_spec.rb +53 -0
  529. data/spec/models/sort_id_name_phone_number_spec.rb +53 -0
  530. data/spec/models/sort_id_name_spec.rb +47 -0
  531. data/spec/models/sort_id_spec.rb +41 -0
  532. data/spec/models/sort_id_updated_at_spec.rb +47 -0
  533. data/spec/models/sort_list_available_numbers_spec.rb +53 -0
  534. data/spec/models/sort_list_phone_numbers_regions_spec.rb +77 -0
  535. data/spec/models/sort_name_number_spec.rb +47 -0
  536. data/spec/models/trunk_full_spec.rb +83 -0
  537. data/spec/models/trunk_summary_spec.rb +47 -0
  538. data/spec/models/voicemail_full_spec.rb +89 -0
  539. data/spec/models/voicemail_input_spec.rb +71 -0
  540. data/spec/models/voicemail_spec.rb +71 -0
  541. data/spec/spec_helper.rb +111 -0
  542. metadata +942 -0
@@ -0,0 +1,13 @@
1
+ # PhoneComClient::AddressListContacts
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **type** | **String** | Address type, one of: home or business. Default is home. | [optional]
7
+ **street** | **String** | House number and street name, including apartment, suite, etc. | [optional]
8
+ **city** | **String** | City | [optional]
9
+ **state** | **String** | State or province | [optional]
10
+ **zip** | **String** | Zip code or postal code | [optional]
11
+ **country** | **String** | Country name | [optional]
12
+
13
+
@@ -0,0 +1,9 @@
1
+ # PhoneComClient::ApplicationFull
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **id** | **Integer** | Application ID. Read-only. | [optional]
7
+ **name** | **String** | Application name | [optional]
8
+
9
+
@@ -0,0 +1,9 @@
1
+ # PhoneComClient::ApplicationSummary
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **id** | **Integer** | Application ID. Read-only. | [optional]
7
+ **name** | **String** | Application name | [optional]
8
+
9
+
@@ -0,0 +1,137 @@
1
+ # PhoneComClient::ApplicationsApi
2
+
3
+ All URIs are relative to *https://api.phone.com/v4*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**get_account_application**](ApplicationsApi.md#get_account_application) | **GET** /accounts/{account_id}/applications/{application_id} | Show details of an individual Application on a given account.
8
+ [**list_account_applications**](ApplicationsApi.md#list_account_applications) | **GET** /accounts/{account_id}/applications | This service lists the Applications on a given account
9
+
10
+
11
+ # **get_account_application**
12
+ > ApplicationFull get_account_application(account_id, application_id)
13
+
14
+ Show details of an individual Application on a given account.
15
+
16
+ Show details of an individual Application on a given account.
17
+
18
+ ### Example
19
+ ```ruby
20
+ # load the gem
21
+ require 'phone_com_client'
22
+ # setup authorization
23
+ PhoneComClient.configure do |config|
24
+ # Configure API key authorization: apiKey
25
+ config.api_key['Authorization'] = 'YOUR API KEY'
26
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
27
+ #config.api_key_prefix['Authorization'] = 'Bearer'
28
+ end
29
+
30
+ api_instance = PhoneComClient::ApplicationsApi.new
31
+
32
+ account_id = 56 # Integer | Account ID
33
+
34
+ application_id = 56 # Integer | Application ID
35
+
36
+
37
+ begin
38
+ #Show details of an individual Application on a given account.
39
+ result = api_instance.get_account_application(account_id, application_id)
40
+ p result
41
+ rescue PhoneComClient::ApiError => e
42
+ puts "Exception when calling ApplicationsApi->get_account_application: #{e}"
43
+ end
44
+ ```
45
+
46
+ ### Parameters
47
+
48
+ Name | Type | Description | Notes
49
+ ------------- | ------------- | ------------- | -------------
50
+ **account_id** | **Integer**| Account ID |
51
+ **application_id** | **Integer**| Application ID |
52
+
53
+ ### Return type
54
+
55
+ [**ApplicationFull**](ApplicationFull.md)
56
+
57
+ ### Authorization
58
+
59
+ [apiKey](../README.md#apiKey)
60
+
61
+ ### HTTP request headers
62
+
63
+ - **Content-Type**: application/json
64
+ - **Accept**: application/json
65
+
66
+
67
+
68
+ # **list_account_applications**
69
+ > ListApplications list_account_applications(account_id, , opts)
70
+
71
+ This service lists the Applications on a given account
72
+
73
+ Show details of an individual Application on a given account.
74
+
75
+ ### Example
76
+ ```ruby
77
+ # load the gem
78
+ require 'phone_com_client'
79
+ # setup authorization
80
+ PhoneComClient.configure do |config|
81
+ # Configure API key authorization: apiKey
82
+ config.api_key['Authorization'] = 'YOUR API KEY'
83
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
84
+ #config.api_key_prefix['Authorization'] = 'Bearer'
85
+ end
86
+
87
+ api_instance = PhoneComClient::ApplicationsApi.new
88
+
89
+ account_id = 56 # Integer | Account ID
90
+
91
+ opts = {
92
+ filters_id: ['filters_id_example'], # Array<String> | ID filter
93
+ filters_name: ['filters_name_example'], # Array<String> | Name filter
94
+ sort_id: 'sort_id_example', # String | ID sorting
95
+ sort_name: 'sort_name_example', # String | Name sorting
96
+ limit: 56, # Integer | Max results
97
+ offset: 56, # Integer | Results to skip
98
+ fields: 'fields_example', # String | Field set
99
+ }
100
+
101
+ begin
102
+ #This service lists the Applications on a given account
103
+ result = api_instance.list_account_applications(account_id, , opts)
104
+ p result
105
+ rescue PhoneComClient::ApiError => e
106
+ puts "Exception when calling ApplicationsApi->list_account_applications: #{e}"
107
+ end
108
+ ```
109
+
110
+ ### Parameters
111
+
112
+ Name | Type | Description | Notes
113
+ ------------- | ------------- | ------------- | -------------
114
+ **account_id** | **Integer**| Account ID |
115
+ **filters_id** | [**Array&lt;String&gt;**](String.md)| ID filter | [optional]
116
+ **filters_name** | [**Array&lt;String&gt;**](String.md)| Name filter | [optional]
117
+ **sort_id** | **String**| ID sorting | [optional]
118
+ **sort_name** | **String**| Name sorting | [optional]
119
+ **limit** | **Integer**| Max results | [optional]
120
+ **offset** | **Integer**| Results to skip | [optional]
121
+ **fields** | **String**| Field set | [optional]
122
+
123
+ ### Return type
124
+
125
+ [**ListApplications**](ListApplications.md)
126
+
127
+ ### Authorization
128
+
129
+ [apiKey](../README.md#apiKey)
130
+
131
+ ### HTTP request headers
132
+
133
+ - **Content-Type**: application/json
134
+ - **Accept**: application/json
135
+
136
+
137
+
@@ -0,0 +1,94 @@
1
+ # PhoneComClient::AvailableNumbersApi
2
+
3
+ All URIs are relative to *https://api.phone.com/v4*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**list_available_phone_numbers**](AvailableNumbersApi.md#list_available_phone_numbers) | **GET** /phone-numbers/available |
8
+
9
+
10
+ # **list_available_phone_numbers**
11
+ > ListAvailableNumbers list_available_phone_numbers(opts)
12
+
13
+
14
+
15
+
16
+
17
+ ### Example
18
+ ```ruby
19
+ # load the gem
20
+ require 'phone_com_client'
21
+ # setup authorization
22
+ PhoneComClient.configure do |config|
23
+ # Configure API key authorization: apiKey
24
+ config.api_key['Authorization'] = 'YOUR API KEY'
25
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
26
+ #config.api_key_prefix['Authorization'] = 'Bearer'
27
+ end
28
+
29
+ api_instance = PhoneComClient::AvailableNumbersApi.new
30
+
31
+ opts = {
32
+ filters_phone_number: ['filters_phone_number_example'], # Array<String> | Phone number filter
33
+ filters_country_code: ['filters_country_code_example'], # Array<String> | Country Code filter
34
+ filters_npa: ['filters_npa_example'], # Array<String> | Area Code filter (North America only)
35
+ filters_nxx: ['filters_nxx_example'], # Array<String> | 2nd set of 3 digits filter (North America only)
36
+ filters_xxxx: ['filters_xxxx_example'], # Array<String> | NANP XXXX filter
37
+ filters_city: ['filters_city_example'], # Array<String> | City filter
38
+ filters_province: ['filters_province_example'], # Array<String> | State or Province (postal code) filter
39
+ filters_country: ['filters_country_example'], # Array<String> | Country (postal code) filter
40
+ filters_price: ['filters_price_example'], # Array<String> | Price filter
41
+ filters_category: ['filters_category_example'], # Array<String> | Category filter
42
+ sort_internal: 'sort_internal_example', # String | Internal (quasi-random) sorting
43
+ sort_price: 'sort_price_example', # String | Price sorting
44
+ sort_phone_number: 'sort_phone_number_example', # String | Phone number sorting
45
+ limit: 56, # Integer | Max results
46
+ offset: 56, # Integer | Results to skip
47
+ fields: 'fields_example', # String | Field set
48
+ }
49
+
50
+ begin
51
+ #
52
+ result = api_instance.list_available_phone_numbers(opts)
53
+ p result
54
+ rescue PhoneComClient::ApiError => e
55
+ puts "Exception when calling AvailableNumbersApi->list_available_phone_numbers: #{e}"
56
+ end
57
+ ```
58
+
59
+ ### Parameters
60
+
61
+ Name | Type | Description | Notes
62
+ ------------- | ------------- | ------------- | -------------
63
+ **filters_phone_number** | [**Array&lt;String&gt;**](String.md)| Phone number filter | [optional]
64
+ **filters_country_code** | [**Array&lt;String&gt;**](String.md)| Country Code filter | [optional]
65
+ **filters_npa** | [**Array&lt;String&gt;**](String.md)| Area Code filter (North America only) | [optional]
66
+ **filters_nxx** | [**Array&lt;String&gt;**](String.md)| 2nd set of 3 digits filter (North America only) | [optional]
67
+ **filters_xxxx** | [**Array&lt;String&gt;**](String.md)| NANP XXXX filter | [optional]
68
+ **filters_city** | [**Array&lt;String&gt;**](String.md)| City filter | [optional]
69
+ **filters_province** | [**Array&lt;String&gt;**](String.md)| State or Province (postal code) filter | [optional]
70
+ **filters_country** | [**Array&lt;String&gt;**](String.md)| Country (postal code) filter | [optional]
71
+ **filters_price** | [**Array&lt;String&gt;**](String.md)| Price filter | [optional]
72
+ **filters_category** | [**Array&lt;String&gt;**](String.md)| Category filter | [optional]
73
+ **sort_internal** | **String**| Internal (quasi-random) sorting | [optional]
74
+ **sort_price** | **String**| Price sorting | [optional]
75
+ **sort_phone_number** | **String**| Phone number sorting | [optional]
76
+ **limit** | **Integer**| Max results | [optional]
77
+ **offset** | **Integer**| Results to skip | [optional]
78
+ **fields** | **String**| Field set | [optional]
79
+
80
+ ### Return type
81
+
82
+ [**ListAvailableNumbers**](ListAvailableNumbers.md)
83
+
84
+ ### Authorization
85
+
86
+ [apiKey](../README.md#apiKey)
87
+
88
+ ### HTTP request headers
89
+
90
+ - **Content-Type**: application/json
91
+ - **Accept**: application/json
92
+
93
+
94
+
@@ -0,0 +1,18 @@
1
+ # PhoneComClient::AvailableNumbersFull
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **phone_number** | **String** | Phone number, in E.164 format | [optional]
7
+ **formatted** | **String** | Human-readable formatted version of the phone number | [optional]
8
+ **price** | **Integer** | The one-time initial price for this number, in USD. Some numbers show REQUEST_QUOTE here. Please contact our sales department if you are interested in these numbers. | [optional]
9
+ **is_toll_free** | **BOOLEAN** | Whether the number is toll-free | [optional]
10
+ **country_code** | **String** | The international dialing prefix for this number. For US and Canadian numbers, for example, this will be \&quot;1\&quot;. | [optional]
11
+ **npa** | **String** | Area code (a.k.a. NPA). Included for North American numbers only. | [optional]
12
+ **nxx** | **String** | Second 3 digits (a.k.a. NXX). Included for North American numbers only. | [optional]
13
+ **xxxx** | **String** | Last 4 digits (a.k.a. XXXX). Included for North American numbers only. | [optional]
14
+ **city** | **String** | City with which this number is associated, if known. Otherwise NULL. | [optional]
15
+ **province** | **String** | State or Province with which this number is associated, if known. Postal Code. Otherwise NULL. | [optional]
16
+ **country** | **String** | Country with which this number is associated, if known. Otherwise NULL. | [optional]
17
+
18
+
@@ -0,0 +1,12 @@
1
+ # PhoneComClient::CallDetails
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **start_time** | **Integer** | UNIX time stamp representing the UTC time that this call item starts | [optional]
7
+ **type** | **String** | Endpoint for this call item, such as call, voicemail, fax, menu, menu item, queue ... | [optional]
8
+ **id_value** | **Integer** | ID associated with this call item endpoint (type) | [optional]
9
+ **voip_id** | **Integer** | Same as account id | [optional]
10
+ **voip_phone_id** | **Integer** | Same as account extension id | [optional]
11
+
12
+
data/docs/CallFull.md ADDED
@@ -0,0 +1,8 @@
1
+ # PhoneComClient::CallFull
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **id** | **String** | | [optional]
7
+
8
+
@@ -0,0 +1,27 @@
1
+ # PhoneComClient::CallLogFull
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **id** | **String** | ID | [optional]
7
+ **uuid** | **String** | Internal system id, may be null | [optional]
8
+ **extension** | [**ExtensionSummary**](ExtensionSummary.md) | Account extension | [optional]
9
+ **caller_id** | **String** | Call made from this phone number | [optional]
10
+ **called_number** | **String** | Call made to this phone number | [optional]
11
+ **start_time** | **String** | Call start time | [optional]
12
+ **created_at** | **String** | Call log creation time. Same as call end time + time needed to create call log | [optional]
13
+ **direction** | **String** | Call direction: in or out | [optional]
14
+ **type** | **String** | Call type: call, fax, audiogram ... | [optional]
15
+ **call_duration** | **Integer** | Call duration in seconds | [optional]
16
+ **is_monitored** | **String** | Was call being monitored? | [optional]
17
+ **call_number** | **String** | Internal system call reference number | [optional]
18
+ **final_action** | **String** | Last action of call flow | [optional]
19
+ **voicemail_url** | **String** | URL of voicemail if available. User may download the audio via this URL. Empty string if voicemail does not exist | [optional]
20
+ **voicemail_cp_url** | **String** | URL of voicemail if available. User may listen to the audio online via this URL. Empty string if voicemail does not exist | [optional]
21
+ **voicemail_transcript** | **String** | Transcript of voicemail if enabled and available | [optional]
22
+ **call_recording_url** | **String** | URL of call recording if available. User may download the audio via this URL. Empty string if call recording does not exist | [optional]
23
+ **call_recording_cp_url** | **String** | URL of call recording if available. User may listen to the audio online via this URL. Empty string if call recording does not exist | [optional]
24
+ **details** | [**Array&lt;CallDetails&gt;**](CallDetails.md) | A list of call flows from beginning of call to end of call. | [optional]
25
+ **caller_cnam** | **String** | Internal system caller id / name | [optional]
26
+
27
+
@@ -0,0 +1,149 @@
1
+ # PhoneComClient::CallLogsApi
2
+
3
+ All URIs are relative to *https://api.phone.com/v4*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**get_account_call_logs**](CallLogsApi.md#get_account_call_logs) | **GET** /accounts/{account_id}/call-logs/{call_id} | Show details of an individual Call Log entry
8
+ [**list_account_call_logs**](CallLogsApi.md#list_account_call_logs) | **GET** /accounts/{account_id}/call-logs | Get a list of call details associated with your account
9
+
10
+
11
+ # **get_account_call_logs**
12
+ > CallLogFull get_account_call_logs(account_id, call_id)
13
+
14
+ Show details of an individual Call Log entry
15
+
16
+ Show details of an individual Call Log entry. See Call Logs for more detail.
17
+
18
+ ### Example
19
+ ```ruby
20
+ # load the gem
21
+ require 'phone_com_client'
22
+ # setup authorization
23
+ PhoneComClient.configure do |config|
24
+ # Configure API key authorization: apiKey
25
+ config.api_key['Authorization'] = 'YOUR API KEY'
26
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
27
+ #config.api_key_prefix['Authorization'] = 'Bearer'
28
+ end
29
+
30
+ api_instance = PhoneComClient::CallLogsApi.new
31
+
32
+ account_id = 56 # Integer | Account ID
33
+
34
+ call_id = 'call_id_example' # String | Call ID
35
+
36
+
37
+ begin
38
+ #Show details of an individual Call Log entry
39
+ result = api_instance.get_account_call_logs(account_id, call_id)
40
+ p result
41
+ rescue PhoneComClient::ApiError => e
42
+ puts "Exception when calling CallLogsApi->get_account_call_logs: #{e}"
43
+ end
44
+ ```
45
+
46
+ ### Parameters
47
+
48
+ Name | Type | Description | Notes
49
+ ------------- | ------------- | ------------- | -------------
50
+ **account_id** | **Integer**| Account ID |
51
+ **call_id** | **String**| Call ID |
52
+
53
+ ### Return type
54
+
55
+ [**CallLogFull**](CallLogFull.md)
56
+
57
+ ### Authorization
58
+
59
+ [apiKey](../README.md#apiKey)
60
+
61
+ ### HTTP request headers
62
+
63
+ - **Content-Type**: application/json
64
+ - **Accept**: application/json
65
+
66
+
67
+
68
+ # **list_account_call_logs**
69
+ > ListCallLogs list_account_call_logs(account_id, , opts)
70
+
71
+ Get a list of call details associated with your account
72
+
73
+ Get a list of call details associated with your account. See Call Logs for more detail.
74
+
75
+ ### Example
76
+ ```ruby
77
+ # load the gem
78
+ require 'phone_com_client'
79
+ # setup authorization
80
+ PhoneComClient.configure do |config|
81
+ # Configure API key authorization: apiKey
82
+ config.api_key['Authorization'] = 'YOUR API KEY'
83
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
84
+ #config.api_key_prefix['Authorization'] = 'Bearer'
85
+ end
86
+
87
+ api_instance = PhoneComClient::CallLogsApi.new
88
+
89
+ account_id = 56 # Integer | Account ID
90
+
91
+ opts = {
92
+ filters_id: ['filters_id_example'], # Array<String> | ID filter
93
+ filters_start_time: ['filters_start_time_example'], # Array<String> | Call start time filter
94
+ filters_created_at: 'filters_created_at_example', # String | Call log creation time filter
95
+ filters_direction: 'filters_direction_example', # String | Call direction filter: in or out
96
+ filters_called_number: 'filters_called_number_example', # String | Called number
97
+ filters_type: 'filters_type_example', # String | Call type, such as 'call', 'fax', 'audiogram'
98
+ filters_extension: ['filters_extension_example'], # Array<String> | Extension filter
99
+ sort_id: 'sort_id_example', # String | ID sorting
100
+ sort_start_time: 'sort_start_time_example', # String | Sorting by call start time: asc or desc
101
+ sort_created_at: 'sort_created_at_example', # String | Sorting by call log creation time: asc or desc
102
+ limit: 56, # Integer | Max results
103
+ offset: 56, # Integer | Results to skip
104
+ fields: 'fields_example', # String | Field set
105
+ }
106
+
107
+ begin
108
+ #Get a list of call details associated with your account
109
+ result = api_instance.list_account_call_logs(account_id, , opts)
110
+ p result
111
+ rescue PhoneComClient::ApiError => e
112
+ puts "Exception when calling CallLogsApi->list_account_call_logs: #{e}"
113
+ end
114
+ ```
115
+
116
+ ### Parameters
117
+
118
+ Name | Type | Description | Notes
119
+ ------------- | ------------- | ------------- | -------------
120
+ **account_id** | **Integer**| Account ID |
121
+ **filters_id** | [**Array&lt;String&gt;**](String.md)| ID filter | [optional]
122
+ **filters_start_time** | [**Array&lt;String&gt;**](String.md)| Call start time filter | [optional]
123
+ **filters_created_at** | **String**| Call log creation time filter | [optional]
124
+ **filters_direction** | **String**| Call direction filter: in or out | [optional]
125
+ **filters_called_number** | **String**| Called number | [optional]
126
+ **filters_type** | **String**| Call type, such as &#39;call&#39;, &#39;fax&#39;, &#39;audiogram&#39; | [optional]
127
+ **filters_extension** | [**Array&lt;String&gt;**](String.md)| Extension filter | [optional]
128
+ **sort_id** | **String**| ID sorting | [optional]
129
+ **sort_start_time** | **String**| Sorting by call start time: asc or desc | [optional]
130
+ **sort_created_at** | **String**| Sorting by call log creation time: asc or desc | [optional]
131
+ **limit** | **Integer**| Max results | [optional]
132
+ **offset** | **Integer**| Results to skip | [optional]
133
+ **fields** | **String**| Field set | [optional]
134
+
135
+ ### Return type
136
+
137
+ [**ListCallLogs**](ListCallLogs.md)
138
+
139
+ ### Authorization
140
+
141
+ [apiKey](../README.md#apiKey)
142
+
143
+ ### HTTP request headers
144
+
145
+ - **Content-Type**: application/json
146
+ - **Accept**: application/json
147
+
148
+
149
+
@@ -0,0 +1,9 @@
1
+ # PhoneComClient::CallNotifications
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **emails** | **Array&lt;String&gt;** | Array of email addresses | [optional]
7
+ **sms** | **String** | A phone number capable of receiving SMS messages | [optional]
8
+
9
+
@@ -0,0 +1,13 @@
1
+ # PhoneComClient::CallbackObject
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **url** | **String** | URL of webhook, where the event is emitted to. Note: The listener supports both HTTP &amp; HTTPS, we highly recommend that users use HTTPS on all callbacks (with user name and password) to ensure no one may send malicious events pretending to be Phone.com. | [optional]
7
+ **role** | **String** | Role of callback: main or backup | [optional]
8
+ **verb** | **String** | HTTP method: get or post | [optional]
9
+ **username** | **String** | Optional user name needed to logon to the webhook URL | [optional]
10
+ **password** | **String** | Optional password needed to logon to the webhook URL | [optional]
11
+ **timeout** | **Integer** | Optional : Duration of HTTP response will time out while sending the event to the callback URL. (1 - 10 seconds) | [optional]
12
+
13
+
@@ -0,0 +1,10 @@
1
+ # PhoneComClient::CallerIdFull
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **number** | **String** | Phone number, in E.164 format | [optional]
7
+ **name** | **String** | Name you have supplied for this number | [optional]
8
+ **type** | **String** | Type of Caller ID. account means this number is registered to your account, and extra refers to extra numbers which you have authorized, which are not managed under Phone.com. | [optional]
9
+
10
+
@@ -0,0 +1,9 @@
1
+ # PhoneComClient::CallerIdPhoneNumber
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **name** | **String** | Name that this number will be associated with. Must be no longer than 15 characters, and can only contain English letters, numbers, spaces, and commas. | [optional]
7
+ **type** | **String** | Can be \&quot;business\&quot; or \&quot;personal\&quot; | [optional]
8
+
9
+
@@ -0,0 +1,82 @@
1
+ # PhoneComClient::CallerIdsApi
2
+
3
+ All URIs are relative to *https://api.phone.com/v4*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**get_caller_ids**](CallerIdsApi.md#get_caller_ids) | **GET** /accounts/{account_id}/extensions/{extension_id}/caller-ids | Show the Caller ID options a given extension can use.
8
+
9
+
10
+ # **get_caller_ids**
11
+ > ListCallerIds get_caller_ids(account_id, extension_id, , opts)
12
+
13
+ Show the Caller ID options a given extension can use.
14
+
15
+ Show the Caller ID options a given extension can use. See Intro to Caller IDs for more on the properties.
16
+
17
+ ### Example
18
+ ```ruby
19
+ # load the gem
20
+ require 'phone_com_client'
21
+ # setup authorization
22
+ PhoneComClient.configure do |config|
23
+ # Configure API key authorization: apiKey
24
+ config.api_key['Authorization'] = 'YOUR API KEY'
25
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
26
+ #config.api_key_prefix['Authorization'] = 'Bearer'
27
+ end
28
+
29
+ api_instance = PhoneComClient::CallerIdsApi.new
30
+
31
+ account_id = 56 # Integer | Account ID
32
+
33
+ extension_id = 56 # Integer | Extension ID
34
+
35
+ opts = {
36
+ filters_number: ['filters_number_example'], # Array<String> | Number filter
37
+ filters_name: ['filters_name_example'], # Array<String> | Name filter
38
+ sort_number: 'sort_number_example', # String | Number sorting
39
+ sort_name: 'sort_name_example', # String | Name sorting
40
+ limit: 56, # Integer | Max results
41
+ offset: 56, # Integer | Results to skip
42
+ fields: 'fields_example', # String | Field set
43
+ }
44
+
45
+ begin
46
+ #Show the Caller ID options a given extension can use.
47
+ result = api_instance.get_caller_ids(account_id, extension_id, , opts)
48
+ p result
49
+ rescue PhoneComClient::ApiError => e
50
+ puts "Exception when calling CallerIdsApi->get_caller_ids: #{e}"
51
+ end
52
+ ```
53
+
54
+ ### Parameters
55
+
56
+ Name | Type | Description | Notes
57
+ ------------- | ------------- | ------------- | -------------
58
+ **account_id** | **Integer**| Account ID |
59
+ **extension_id** | **Integer**| Extension ID |
60
+ **filters_number** | [**Array&lt;String&gt;**](String.md)| Number filter | [optional]
61
+ **filters_name** | [**Array&lt;String&gt;**](String.md)| Name filter | [optional]
62
+ **sort_number** | **String**| Number sorting | [optional]
63
+ **sort_name** | **String**| Name sorting | [optional]
64
+ **limit** | **Integer**| Max results | [optional]
65
+ **offset** | **Integer**| Results to skip | [optional]
66
+ **fields** | **String**| Field set | [optional]
67
+
68
+ ### Return type
69
+
70
+ [**ListCallerIds**](ListCallerIds.md)
71
+
72
+ ### Authorization
73
+
74
+ [apiKey](../README.md#apiKey)
75
+
76
+ ### HTTP request headers
77
+
78
+ - **Content-Type**: application/json
79
+ - **Accept**: application/json
80
+
81
+
82
+