phone_com_client 1.0.1

Sign up to get free protection for your applications and to get access to all the features.
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,311 @@
1
+ # PhoneComClient::PaymentMethodsApi
2
+
3
+ All URIs are relative to *https://api.phone.com/v4*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**create_account_payment_method**](PaymentMethodsApi.md#create_account_payment_method) | **POST** /accounts/{account_id}/payment-methods | Create an individual payment method.
8
+ [**delete_account_payment_method**](PaymentMethodsApi.md#delete_account_payment_method) | **DELETE** /accounts/{account_id}/payment-methods/{pm_id} | Delete an individual payment method.
9
+ [**get_account_payment_method**](PaymentMethodsApi.md#get_account_payment_method) | **GET** /accounts/{account_id}/payment-methods/{pm_id} | Show details of an individual payment method.
10
+ [**list_account_payment_methods**](PaymentMethodsApi.md#list_account_payment_methods) | **GET** /accounts/{account_id}/payment-methods | Get a list of payment methods for an account.
11
+ [**patch_account_payment_method**](PaymentMethodsApi.md#patch_account_payment_method) | **PATCH** /accounts/{account_id}/payment-methods/{pm_id} | Replace the status of an individual payment method.
12
+
13
+
14
+ # **create_account_payment_method**
15
+ > PaymentFull create_account_payment_method(account_id, data)
16
+
17
+ Create an individual payment method.
18
+
19
+ Create an individual payment method. See Account Payment Methods for more info on the properties.
20
+
21
+ ### Example
22
+ ```ruby
23
+ # load the gem
24
+ require 'phone_com_client'
25
+ # setup authorization
26
+ PhoneComClient.configure do |config|
27
+ # Configure API key authorization: apiKey
28
+ config.api_key['Authorization'] = 'YOUR API KEY'
29
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
30
+ #config.api_key_prefix['Authorization'] = 'Bearer'
31
+ end
32
+
33
+ api_instance = PhoneComClient::PaymentMethodsApi.new
34
+
35
+ account_id = 56 # Integer | Account ID
36
+
37
+ data = PhoneComClient::CreatePaymentParams.new # CreatePaymentParams | Payment data
38
+
39
+
40
+ begin
41
+ #Create an individual payment method.
42
+ result = api_instance.create_account_payment_method(account_id, data)
43
+ p result
44
+ rescue PhoneComClient::ApiError => e
45
+ puts "Exception when calling PaymentMethodsApi->create_account_payment_method: #{e}"
46
+ end
47
+ ```
48
+
49
+ ### Parameters
50
+
51
+ Name | Type | Description | Notes
52
+ ------------- | ------------- | ------------- | -------------
53
+ **account_id** | **Integer**| Account ID |
54
+ **data** | [**CreatePaymentParams**](CreatePaymentParams.md)| Payment data |
55
+
56
+ ### Return type
57
+
58
+ [**PaymentFull**](PaymentFull.md)
59
+
60
+ ### Authorization
61
+
62
+ [apiKey](../README.md#apiKey)
63
+
64
+ ### HTTP request headers
65
+
66
+ - **Content-Type**: application/json
67
+ - **Accept**: application/json
68
+
69
+
70
+
71
+ # **delete_account_payment_method**
72
+ > DeleteEntry delete_account_payment_method(account_id, pm_id)
73
+
74
+ Delete an individual payment method.
75
+
76
+ Delete an individual payment method. See Account Payment Methods for more info on the properties.
77
+
78
+ ### Example
79
+ ```ruby
80
+ # load the gem
81
+ require 'phone_com_client'
82
+ # setup authorization
83
+ PhoneComClient.configure do |config|
84
+ # Configure API key authorization: apiKey
85
+ config.api_key['Authorization'] = 'YOUR API KEY'
86
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
87
+ #config.api_key_prefix['Authorization'] = 'Bearer'
88
+ end
89
+
90
+ api_instance = PhoneComClient::PaymentMethodsApi.new
91
+
92
+ account_id = 56 # Integer | Account ID
93
+
94
+ pm_id = 56 # Integer | Payment Method ID
95
+
96
+
97
+ begin
98
+ #Delete an individual payment method.
99
+ result = api_instance.delete_account_payment_method(account_id, pm_id)
100
+ p result
101
+ rescue PhoneComClient::ApiError => e
102
+ puts "Exception when calling PaymentMethodsApi->delete_account_payment_method: #{e}"
103
+ end
104
+ ```
105
+
106
+ ### Parameters
107
+
108
+ Name | Type | Description | Notes
109
+ ------------- | ------------- | ------------- | -------------
110
+ **account_id** | **Integer**| Account ID |
111
+ **pm_id** | **Integer**| Payment Method ID |
112
+
113
+ ### Return type
114
+
115
+ [**DeleteEntry**](DeleteEntry.md)
116
+
117
+ ### Authorization
118
+
119
+ [apiKey](../README.md#apiKey)
120
+
121
+ ### HTTP request headers
122
+
123
+ - **Content-Type**: application/json
124
+ - **Accept**: application/json
125
+
126
+
127
+
128
+ # **get_account_payment_method**
129
+ > PaymentFull get_account_payment_method(account_id, pm_id)
130
+
131
+ Show details of an individual payment method.
132
+
133
+ Show details of an individual payment method. See Account Payment Methods for more info on the properties.
134
+
135
+ ### Example
136
+ ```ruby
137
+ # load the gem
138
+ require 'phone_com_client'
139
+ # setup authorization
140
+ PhoneComClient.configure do |config|
141
+ # Configure API key authorization: apiKey
142
+ config.api_key['Authorization'] = 'YOUR API KEY'
143
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
144
+ #config.api_key_prefix['Authorization'] = 'Bearer'
145
+ end
146
+
147
+ api_instance = PhoneComClient::PaymentMethodsApi.new
148
+
149
+ account_id = 56 # Integer | Account ID
150
+
151
+ pm_id = 56 # Integer | Payment Method ID
152
+
153
+
154
+ begin
155
+ #Show details of an individual payment method.
156
+ result = api_instance.get_account_payment_method(account_id, pm_id)
157
+ p result
158
+ rescue PhoneComClient::ApiError => e
159
+ puts "Exception when calling PaymentMethodsApi->get_account_payment_method: #{e}"
160
+ end
161
+ ```
162
+
163
+ ### Parameters
164
+
165
+ Name | Type | Description | Notes
166
+ ------------- | ------------- | ------------- | -------------
167
+ **account_id** | **Integer**| Account ID |
168
+ **pm_id** | **Integer**| Payment Method ID |
169
+
170
+ ### Return type
171
+
172
+ [**PaymentFull**](PaymentFull.md)
173
+
174
+ ### Authorization
175
+
176
+ [apiKey](../README.md#apiKey)
177
+
178
+ ### HTTP request headers
179
+
180
+ - **Content-Type**: application/json
181
+ - **Accept**: application/json
182
+
183
+
184
+
185
+ # **list_account_payment_methods**
186
+ > ListPaymentMethods list_account_payment_methods(account_id, , opts)
187
+
188
+ Get a list of payment methods for an account.
189
+
190
+ Get a list of payment methods for an account. See Account Payment Methods for more info on the properties.
191
+
192
+ ### Example
193
+ ```ruby
194
+ # load the gem
195
+ require 'phone_com_client'
196
+ # setup authorization
197
+ PhoneComClient.configure do |config|
198
+ # Configure API key authorization: apiKey
199
+ config.api_key['Authorization'] = 'YOUR API KEY'
200
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
201
+ #config.api_key_prefix['Authorization'] = 'Bearer'
202
+ end
203
+
204
+ api_instance = PhoneComClient::PaymentMethodsApi.new
205
+
206
+ account_id = 56 # Integer | Account ID
207
+
208
+ opts = {
209
+ filters_id: ['filters_id_example'], # Array<String> | ID filter
210
+ sort_id: 'sort_id_example', # String | ID sorting
211
+ limit: 56, # Integer | Max results
212
+ offset: 56, # Integer | Results to skip
213
+ fields: 'fields_example', # String | Field set
214
+ }
215
+
216
+ begin
217
+ #Get a list of payment methods for an account.
218
+ result = api_instance.list_account_payment_methods(account_id, , opts)
219
+ p result
220
+ rescue PhoneComClient::ApiError => e
221
+ puts "Exception when calling PaymentMethodsApi->list_account_payment_methods: #{e}"
222
+ end
223
+ ```
224
+
225
+ ### Parameters
226
+
227
+ Name | Type | Description | Notes
228
+ ------------- | ------------- | ------------- | -------------
229
+ **account_id** | **Integer**| Account ID |
230
+ **filters_id** | [**Array&lt;String&gt;**](String.md)| ID filter | [optional]
231
+ **sort_id** | **String**| ID sorting | [optional]
232
+ **limit** | **Integer**| Max results | [optional]
233
+ **offset** | **Integer**| Results to skip | [optional]
234
+ **fields** | **String**| Field set | [optional]
235
+
236
+ ### Return type
237
+
238
+ [**ListPaymentMethods**](ListPaymentMethods.md)
239
+
240
+ ### Authorization
241
+
242
+ [apiKey](../README.md#apiKey)
243
+
244
+ ### HTTP request headers
245
+
246
+ - **Content-Type**: application/json
247
+ - **Accept**: application/json
248
+
249
+
250
+
251
+ # **patch_account_payment_method**
252
+ > PaymentFull patch_account_payment_method(account_id, pm_id, opts)
253
+
254
+ Replace the status of an individual payment method.
255
+
256
+ Replace the status of an individual payment method. See Account Payment Methods for more info on the properties.
257
+
258
+ ### Example
259
+ ```ruby
260
+ # load the gem
261
+ require 'phone_com_client'
262
+ # setup authorization
263
+ PhoneComClient.configure do |config|
264
+ # Configure API key authorization: apiKey
265
+ config.api_key['Authorization'] = 'YOUR API KEY'
266
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
267
+ #config.api_key_prefix['Authorization'] = 'Bearer'
268
+ end
269
+
270
+ api_instance = PhoneComClient::PaymentMethodsApi.new
271
+
272
+ account_id = 56 # Integer | Account ID
273
+
274
+ pm_id = 56 # Integer | Payment Method ID
275
+
276
+ opts = {
277
+ data: PhoneComClient::PatchPaymentParams.new # PatchPaymentParams | Payment data
278
+ }
279
+
280
+ begin
281
+ #Replace the status of an individual payment method.
282
+ result = api_instance.patch_account_payment_method(account_id, pm_id, opts)
283
+ p result
284
+ rescue PhoneComClient::ApiError => e
285
+ puts "Exception when calling PaymentMethodsApi->patch_account_payment_method: #{e}"
286
+ end
287
+ ```
288
+
289
+ ### Parameters
290
+
291
+ Name | Type | Description | Notes
292
+ ------------- | ------------- | ------------- | -------------
293
+ **account_id** | **Integer**| Account ID |
294
+ **pm_id** | **Integer**| Payment Method ID |
295
+ **data** | [**PatchPaymentParams**](PatchPaymentParams.md)| Payment data | [optional]
296
+
297
+ ### Return type
298
+
299
+ [**PaymentFull**](PaymentFull.md)
300
+
301
+ ### Authorization
302
+
303
+ [apiKey](../README.md#apiKey)
304
+
305
+ ### HTTP request headers
306
+
307
+ - **Content-Type**: application/json
308
+ - **Accept**: application/json
309
+
310
+
311
+
@@ -0,0 +1,13 @@
1
+ # PhoneComClient::PaymentSummary
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **id** | **Integer** | Payment Method ID | [optional]
7
+ **voip_id** | **Integer** | API Account ID | [optional]
8
+ **status** | **String** | &#39;primary&#39; &#x3D; primary card used for billing; &#39;onfile&#39; &#x3D; card on file; &#39;hidden&#39; &#x3D; deleted card; | [optional]
9
+ **nickname** | **String** | Name of Card | [optional]
10
+ **type** | **String** | &#39;cc&#39; for credit card | [optional]
11
+ **created_at** | **Integer** | Time payment record is created | [optional]
12
+
13
+
@@ -0,0 +1,10 @@
1
+ # PhoneComClient::PhoneNumberContact
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **type** | **String** | Type of phone number, must be one of: home, business, mobile, fax, pager. Default is home. | [optional]
7
+ **number** | **String** | Phone number, as entered. Does not need to be formatted in any particular way. Required. | [optional]
8
+ **normalized** | **String** | Phone number in E.164 format. Read-only. | [optional]
9
+
10
+
@@ -0,0 +1,16 @@
1
+ # PhoneComClient::PhoneNumberFull
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **id** | **Integer** | Integer Phone number ID. This is the internal Phone.com ID for this number, not the phone number itself. Read-only. | [optional]
7
+ **name** | **String** | Name | [optional]
8
+ **phone_number** | **String** | Phone number, in E.164 format | [optional]
9
+ **block_incoming** | **BOOLEAN** | Whether to block incoming calls. Boolean. | [optional]
10
+ **block_anonymous** | **BOOLEAN** | Whether to block anonymous calls. Boolean. | [optional]
11
+ **route** | [**RouteSummary**](RouteSummary.md) | The Route assigned to handle incoming calls for this number, if any. Output is a Route Summary Object, or NULL if not set. Input can be a Route Lookup Object or NULL to unset. | [optional]
12
+ **caller_id** | [**CallerIdPhoneNumber**](CallerIdPhoneNumber.md) | | [optional]
13
+ **sms_forwarding** | [**SmsForwarding**](SmsForwarding.md) | | [optional]
14
+ **call_notifications** | [**CallNotifications**](CallNotifications.md) | | [optional]
15
+
16
+
@@ -0,0 +1,262 @@
1
+ # PhoneComClient::PhoneNumbersApi
2
+
3
+ All URIs are relative to *https://api.phone.com/v4*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**create_account_phone_number**](PhoneNumbersApi.md#create_account_phone_number) | **POST** /accounts/{account_id}/phone-numbers | Add a phone number to an account.
8
+ [**get_account_phone_number**](PhoneNumbersApi.md#get_account_phone_number) | **GET** /accounts/{account_id}/phone-numbers/{number_id} | Show details of an individual phone number.
9
+ [**list_account_phone_numbers**](PhoneNumbersApi.md#list_account_phone_numbers) | **GET** /accounts/{account_id}/phone-numbers | Get a list of phone numbers registered to an account.
10
+ [**replace_account_phone_number**](PhoneNumbersApi.md#replace_account_phone_number) | **PUT** /accounts/{account_id}/phone-numbers/{number_id} | Update the settings for an existing phone number on your account.
11
+
12
+
13
+ # **create_account_phone_number**
14
+ > PhoneNumberFull create_account_phone_number(account_id, , opts)
15
+
16
+ Add a phone number to an account.
17
+
18
+ Add a phone number to an account. See Account Phone Numbers for more info on the properties.
19
+
20
+ ### Example
21
+ ```ruby
22
+ # load the gem
23
+ require 'phone_com_client'
24
+ # setup authorization
25
+ PhoneComClient.configure do |config|
26
+ # Configure API key authorization: apiKey
27
+ config.api_key['Authorization'] = 'YOUR API KEY'
28
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
29
+ #config.api_key_prefix['Authorization'] = 'Bearer'
30
+ end
31
+
32
+ api_instance = PhoneComClient::PhoneNumbersApi.new
33
+
34
+ account_id = 56 # Integer | Account ID
35
+
36
+ opts = {
37
+ data: PhoneComClient::CreatePhoneNumberParams.new # CreatePhoneNumberParams | Phone Number data
38
+ }
39
+
40
+ begin
41
+ #Add a phone number to an account.
42
+ result = api_instance.create_account_phone_number(account_id, , opts)
43
+ p result
44
+ rescue PhoneComClient::ApiError => e
45
+ puts "Exception when calling PhoneNumbersApi->create_account_phone_number: #{e}"
46
+ end
47
+ ```
48
+
49
+ ### Parameters
50
+
51
+ Name | Type | Description | Notes
52
+ ------------- | ------------- | ------------- | -------------
53
+ **account_id** | **Integer**| Account ID |
54
+ **data** | [**CreatePhoneNumberParams**](CreatePhoneNumberParams.md)| Phone Number data | [optional]
55
+
56
+ ### Return type
57
+
58
+ [**PhoneNumberFull**](PhoneNumberFull.md)
59
+
60
+ ### Authorization
61
+
62
+ [apiKey](../README.md#apiKey)
63
+
64
+ ### HTTP request headers
65
+
66
+ - **Content-Type**: application/json
67
+ - **Accept**: application/json
68
+
69
+
70
+
71
+ # **get_account_phone_number**
72
+ > PhoneNumberFull get_account_phone_number(account_id, number_id)
73
+
74
+ Show details of an individual phone number.
75
+
76
+ Show details of an individual phone number. See Account Phone Numbers for more info on the properties.
77
+
78
+ ### Example
79
+ ```ruby
80
+ # load the gem
81
+ require 'phone_com_client'
82
+ # setup authorization
83
+ PhoneComClient.configure do |config|
84
+ # Configure API key authorization: apiKey
85
+ config.api_key['Authorization'] = 'YOUR API KEY'
86
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
87
+ #config.api_key_prefix['Authorization'] = 'Bearer'
88
+ end
89
+
90
+ api_instance = PhoneComClient::PhoneNumbersApi.new
91
+
92
+ account_id = 56 # Integer | Account ID
93
+
94
+ number_id = 56 # Integer | Number ID
95
+
96
+
97
+ begin
98
+ #Show details of an individual phone number.
99
+ result = api_instance.get_account_phone_number(account_id, number_id)
100
+ p result
101
+ rescue PhoneComClient::ApiError => e
102
+ puts "Exception when calling PhoneNumbersApi->get_account_phone_number: #{e}"
103
+ end
104
+ ```
105
+
106
+ ### Parameters
107
+
108
+ Name | Type | Description | Notes
109
+ ------------- | ------------- | ------------- | -------------
110
+ **account_id** | **Integer**| Account ID |
111
+ **number_id** | **Integer**| Number ID |
112
+
113
+ ### Return type
114
+
115
+ [**PhoneNumberFull**](PhoneNumberFull.md)
116
+
117
+ ### Authorization
118
+
119
+ [apiKey](../README.md#apiKey)
120
+
121
+ ### HTTP request headers
122
+
123
+ - **Content-Type**: application/json
124
+ - **Accept**: application/json
125
+
126
+
127
+
128
+ # **list_account_phone_numbers**
129
+ > ListPhoneNumbers list_account_phone_numbers(account_id, , opts)
130
+
131
+ Get a list of phone numbers registered to an account.
132
+
133
+ Get a list of phone numbers registered to an account. See Account Phone Numbers for more info on the properties.
134
+
135
+ ### Example
136
+ ```ruby
137
+ # load the gem
138
+ require 'phone_com_client'
139
+ # setup authorization
140
+ PhoneComClient.configure do |config|
141
+ # Configure API key authorization: apiKey
142
+ config.api_key['Authorization'] = 'YOUR API KEY'
143
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
144
+ #config.api_key_prefix['Authorization'] = 'Bearer'
145
+ end
146
+
147
+ api_instance = PhoneComClient::PhoneNumbersApi.new
148
+
149
+ account_id = 56 # Integer | Account ID
150
+
151
+ opts = {
152
+ filters_id: ['filters_id_example'], # Array<String> | ID filter
153
+ filters_name: ['filters_name_example'], # Array<String> | Name filter
154
+ filters_phone_number: ['filters_phone_number_example'], # Array<String> | Phone number filter
155
+ sort_id: 'sort_id_example', # String | ID sorting
156
+ sort_name: 'sort_name_example', # String | Name sorting
157
+ sort_phone_number: 'sort_phone_number_example', # String | Phone number sorting
158
+ limit: 56, # Integer | Max results
159
+ offset: 56, # Integer | Results to skip
160
+ fields: 'fields_example', # String | Field set
161
+ }
162
+
163
+ begin
164
+ #Get a list of phone numbers registered to an account.
165
+ result = api_instance.list_account_phone_numbers(account_id, , opts)
166
+ p result
167
+ rescue PhoneComClient::ApiError => e
168
+ puts "Exception when calling PhoneNumbersApi->list_account_phone_numbers: #{e}"
169
+ end
170
+ ```
171
+
172
+ ### Parameters
173
+
174
+ Name | Type | Description | Notes
175
+ ------------- | ------------- | ------------- | -------------
176
+ **account_id** | **Integer**| Account ID |
177
+ **filters_id** | [**Array&lt;String&gt;**](String.md)| ID filter | [optional]
178
+ **filters_name** | [**Array&lt;String&gt;**](String.md)| Name filter | [optional]
179
+ **filters_phone_number** | [**Array&lt;String&gt;**](String.md)| Phone number filter | [optional]
180
+ **sort_id** | **String**| ID sorting | [optional]
181
+ **sort_name** | **String**| Name sorting | [optional]
182
+ **sort_phone_number** | **String**| Phone number sorting | [optional]
183
+ **limit** | **Integer**| Max results | [optional]
184
+ **offset** | **Integer**| Results to skip | [optional]
185
+ **fields** | **String**| Field set | [optional]
186
+
187
+ ### Return type
188
+
189
+ [**ListPhoneNumbers**](ListPhoneNumbers.md)
190
+
191
+ ### Authorization
192
+
193
+ [apiKey](../README.md#apiKey)
194
+
195
+ ### HTTP request headers
196
+
197
+ - **Content-Type**: application/json
198
+ - **Accept**: application/json
199
+
200
+
201
+
202
+ # **replace_account_phone_number**
203
+ > PhoneNumberFull replace_account_phone_number(account_id, number_id, opts)
204
+
205
+ Update the settings for an existing phone number on your account.
206
+
207
+ Update the settings for an existing phone number on your account. See Account Phone Numbers for more info on the properties.
208
+
209
+ ### Example
210
+ ```ruby
211
+ # load the gem
212
+ require 'phone_com_client'
213
+ # setup authorization
214
+ PhoneComClient.configure do |config|
215
+ # Configure API key authorization: apiKey
216
+ config.api_key['Authorization'] = 'YOUR API KEY'
217
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
218
+ #config.api_key_prefix['Authorization'] = 'Bearer'
219
+ end
220
+
221
+ api_instance = PhoneComClient::PhoneNumbersApi.new
222
+
223
+ account_id = 56 # Integer | Account ID
224
+
225
+ number_id = 56 # Integer | Number ID
226
+
227
+ opts = {
228
+ data: PhoneComClient::ReplacePhoneNumberParams.new # ReplacePhoneNumberParams | Phone Number data
229
+ }
230
+
231
+ begin
232
+ #Update the settings for an existing phone number on your account.
233
+ result = api_instance.replace_account_phone_number(account_id, number_id, opts)
234
+ p result
235
+ rescue PhoneComClient::ApiError => e
236
+ puts "Exception when calling PhoneNumbersApi->replace_account_phone_number: #{e}"
237
+ end
238
+ ```
239
+
240
+ ### Parameters
241
+
242
+ Name | Type | Description | Notes
243
+ ------------- | ------------- | ------------- | -------------
244
+ **account_id** | **Integer**| Account ID |
245
+ **number_id** | **Integer**| Number ID |
246
+ **data** | [**ReplacePhoneNumberParams**](ReplacePhoneNumberParams.md)| Phone Number data | [optional]
247
+
248
+ ### Return type
249
+
250
+ [**PhoneNumberFull**](PhoneNumberFull.md)
251
+
252
+ ### Authorization
253
+
254
+ [apiKey](../README.md#apiKey)
255
+
256
+ ### HTTP request headers
257
+
258
+ - **Content-Type**: application/json
259
+ - **Accept**: application/json
260
+
261
+
262
+
@@ -0,0 +1,15 @@
1
+ # PhoneComClient::PhoneNumbersRegionFull
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **country_code** | **String** | Optional. Integer representing the international calling code for the phone number&#39;s country. | [optional]
7
+ **npa** | **Integer** | Optional. Area Code, for North American phone numbers. | [optional]
8
+ **nxx** | **Integer** | Optional. Second set of 3 digits, for North American phone numbers. | [optional]
9
+ **is_toll_free** | **Integer** | Optional. Boolean describing whether the phone numbers in this group are toll free. | [optional]
10
+ **city** | **String** | Optional. City name. | [optional]
11
+ **province_postal_code** | **String** | Optional. Two-letter postal code for the state or province. | [optional]
12
+ **country_postal_code** | **String** | Optional. Two-letter postal code for the country. | [optional]
13
+ **quantity** | **Integer** | Integer. Quantity of phone numbers currently available in the given region. | [optional]
14
+
15
+
@@ -0,0 +1,11 @@
1
+ # PhoneComClient::PingResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **datetime** | **String** | | [optional]
7
+ **remote_ip** | **String** | | [optional]
8
+ **timestamp** | **Integer** | | [optional]
9
+ **user_agent** | **String** | | [optional]
10
+
11
+
@@ -0,0 +1,13 @@
1
+ # PhoneComClient::PricingFull
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **id** | **Integer** | Integer ID of this object. | [optional]
7
+ **pricing** | [**PricingObject**](PricingObject.md) | Pricing Object | [optional]
8
+ **voip_id** | **Integer** | Phone.com API Account (VoIP) ID | [optional]
9
+ **reason** | **String** | Reason this pricing plan is applied | [optional]
10
+ **who** | **String** | Name of the person / process who added this pricing plan to the subaccount | [optional]
11
+ **expire_date** | **String** | Pricing plan expiration timestamp in unix format. If pricing plan never expires, this item will not be returned | [optional]
12
+
13
+
@@ -0,0 +1,9 @@
1
+ # PhoneComClient::PricingObject
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **id** | **Integer** | Pricing code / ID | [optional]
7
+ **name** | **String** | Name of pricing plan | [optional]
8
+
9
+
data/docs/QueueFull.md ADDED
@@ -0,0 +1,15 @@
1
+ # PhoneComClient::QueueFull
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **id** | **Integer** | Integer ID. Read-only. |
7
+ **name** | **String** | Name. Required. |
8
+ **greeting** | [**MediaSummary**](MediaSummary.md) | Greeting to be played when caller first connects. Output is a Media Summary Object. Input must be a Media Lookup Object. Must refer to a media recording that has is_hold_music set to FALSE. Can be set to NULL to disable the greeting. | [optional]
9
+ **hold_music** | [**HoldMusic**](HoldMusic.md) | | [optional]
10
+ **max_hold_time** | **Integer** | Maximum hold time in seconds. If provided, must equal one of: 60, 120, 180, 240, 300, 600, 900, 1200, 1800, 2700, 3600. Default is 300. | [optional]
11
+ **caller_id_type** | **String** | Caller id type to show members. If provided, must equal one of: &#39;called_number&#39;, &#39;calling_number&#39;. Default is &#39;calling_number&#39;. | [optional]
12
+ **ring_time** | **Integer** | Number of seconds to ring a member before cycling to the next member. If provided, must equal one of: 5, 10, 15, 20, 25, 30. Default is 5. | [optional]
13
+ **members** | [**Array&lt;Member&gt;**](Member.md) | Array of Member Objects. Non-virtual account extensions or phone numbers. See below for details. | [optional]
14
+
15
+
@@ -0,0 +1,9 @@
1
+ # PhoneComClient::QueueSummary
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **id** | **Integer** | Integer ID. Read-only. |
7
+ **name** | **String** | Name. Required. |
8
+
9
+