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.
- checksums.yaml +7 -0
- data/Gemfile +7 -0
- data/Gemfile.lock +69 -0
- data/LICENSE +21 -0
- data/README.md +344 -0
- data/Rakefile +8 -0
- data/docs/AccountFull.md +14 -0
- data/docs/AccountSummary.md +9 -0
- data/docs/AccountsApi.md +127 -0
- data/docs/Address.md +13 -0
- data/docs/AddressListContacts.md +13 -0
- data/docs/ApplicationFull.md +9 -0
- data/docs/ApplicationSummary.md +9 -0
- data/docs/ApplicationsApi.md +137 -0
- data/docs/AvailableNumbersApi.md +94 -0
- data/docs/AvailableNumbersFull.md +18 -0
- data/docs/CallDetails.md +12 -0
- data/docs/CallFull.md +8 -0
- data/docs/CallLogFull.md +27 -0
- data/docs/CallLogsApi.md +149 -0
- data/docs/CallNotifications.md +9 -0
- data/docs/CallbackObject.md +13 -0
- data/docs/CallerIdFull.md +10 -0
- data/docs/CallerIdPhoneNumber.md +9 -0
- data/docs/CallerIdsApi.md +82 -0
- data/docs/CallsApi.md +67 -0
- data/docs/ContactAccount.md +14 -0
- data/docs/ContactFull.md +26 -0
- data/docs/ContactResponse.md +14 -0
- data/docs/ContactSummary.md +15 -0
- data/docs/ContactsApi.md +333 -0
- data/docs/CreateCallParams.md +15 -0
- data/docs/CreateContactParams.md +23 -0
- data/docs/CreateDeviceParams.md +9 -0
- data/docs/CreateExtensionParams.md +20 -0
- data/docs/CreateGroupParams.md +8 -0
- data/docs/CreateListenerParams.md +10 -0
- data/docs/CreateMediaParams.md +17 -0
- data/docs/CreateMenuParams.md +14 -0
- data/docs/CreateOauthParams.md +16 -0
- data/docs/CreatePaymentParams.md +11 -0
- data/docs/CreatePhoneNumberParams.md +15 -0
- data/docs/CreatePricingParams.md +10 -0
- data/docs/CreateQueueParams.md +14 -0
- data/docs/CreateRedirectUriParams.md +8 -0
- data/docs/CreateRouteParams.md +10 -0
- data/docs/CreateSmsParams.md +11 -0
- data/docs/CreateSubaccountParams.md +11 -0
- data/docs/CreateTrunkParams.md +14 -0
- data/docs/DefaultApi.md +57 -0
- data/docs/DeleteEntry.md +8 -0
- data/docs/DeviceFull.md +11 -0
- data/docs/DeviceMembership.md +9 -0
- data/docs/DeviceSummary.md +9 -0
- data/docs/DevicesApi.md +316 -0
- data/docs/Email.md +9 -0
- data/docs/ExpressServiceCodeFull.md +10 -0
- data/docs/ExpressServiceCodesApi.md +125 -0
- data/docs/ExtensionFull.md +24 -0
- data/docs/ExtensionSummary.md +10 -0
- data/docs/ExtensionsApi.md +262 -0
- data/docs/FilterCallLogs.md +13 -0
- data/docs/FilterIdArray.md +8 -0
- data/docs/FilterIdDirectionFrom.md +10 -0
- data/docs/FilterIdExtensionNameArray.md +10 -0
- data/docs/FilterIdGroupIdUpdatedAtArray.md +10 -0
- data/docs/FilterIdNameArray.md +9 -0
- data/docs/FilterIdNamePhoneNumberArray.md +10 -0
- data/docs/FilterListAvailableNumbers.md +17 -0
- data/docs/FilterListPhoneNumbersRegions.md +14 -0
- data/docs/FilterNameNumberArray.md +9 -0
- data/docs/FilterVoicemailArray.md +13 -0
- data/docs/FromObject.md +11 -0
- data/docs/GetOauthAccessToken.md +10 -0
- data/docs/Greeting.md +11 -0
- data/docs/GreetingInput.md +11 -0
- data/docs/GroupFull.md +9 -0
- data/docs/GroupListContacts.md +9 -0
- data/docs/GroupSummary.md +9 -0
- data/docs/GroupsApi.md +329 -0
- data/docs/HoldMusic.md +9 -0
- data/docs/Line.md +9 -0
- data/docs/ListAccounts.md +13 -0
- data/docs/ListApplications.md +13 -0
- data/docs/ListAvailableNumbers.md +13 -0
- data/docs/ListCallLogs.md +13 -0
- data/docs/ListCallerIds.md +13 -0
- data/docs/ListContacts.md +13 -0
- data/docs/ListDevices.md +13 -0
- data/docs/ListExpressServiceCodes.md +13 -0
- data/docs/ListExtensions.md +13 -0
- data/docs/ListGroups.md +13 -0
- data/docs/ListListeners.md +13 -0
- data/docs/ListMedia.md +13 -0
- data/docs/ListMenus.md +13 -0
- data/docs/ListOauthClients.md +13 -0
- data/docs/ListOauthClientsRedirectUris.md +12 -0
- data/docs/ListPaymentMethods.md +13 -0
- data/docs/ListPhoneNumbers.md +13 -0
- data/docs/ListPhoneNumbersRegions.md +14 -0
- data/docs/ListPricings.md +13 -0
- data/docs/ListQueues.md +13 -0
- data/docs/ListRoutes.md +13 -0
- data/docs/ListSchedules.md +13 -0
- data/docs/ListSms.md +13 -0
- data/docs/ListTrunks.md +13 -0
- data/docs/ListVoicemail.md +13 -0
- data/docs/ListenerFull.md +14 -0
- data/docs/ListenersApi.md +312 -0
- data/docs/MediaApi.md +441 -0
- data/docs/MediaFull.md +10 -0
- data/docs/MediaSummary.md +9 -0
- data/docs/Member.md +9 -0
- data/docs/MenuFull.md +15 -0
- data/docs/MenuSummary.md +9 -0
- data/docs/MenusApi.md +316 -0
- data/docs/Notification.md +9 -0
- data/docs/NumberRegionsApi.md +98 -0
- data/docs/OauthAccessToken.md +12 -0
- data/docs/OauthApi.md +176 -0
- data/docs/OauthClientFull.md +9 -0
- data/docs/OauthClientRedirectUriFull.md +10 -0
- data/docs/OauthClientsApi.md +191 -0
- data/docs/OauthClientsRedirectUrisApi.md +262 -0
- data/docs/Option.md +9 -0
- data/docs/PatchPaymentParams.md +8 -0
- data/docs/PatchSmsParams.md +8 -0
- data/docs/PatchVoicemailParams.md +8 -0
- data/docs/PaymentFull.md +20 -0
- data/docs/PaymentMethodsApi.md +311 -0
- data/docs/PaymentSummary.md +13 -0
- data/docs/PhoneNumberContact.md +10 -0
- data/docs/PhoneNumberFull.md +16 -0
- data/docs/PhoneNumbersApi.md +262 -0
- data/docs/PhoneNumbersRegionFull.md +15 -0
- data/docs/PingResponse.md +11 -0
- data/docs/PricingFull.md +13 -0
- data/docs/PricingObject.md +9 -0
- data/docs/QueueFull.md +15 -0
- data/docs/QueueSummary.md +9 -0
- data/docs/QueuesApi.md +316 -0
- data/docs/Recipient.md +9 -0
- data/docs/RedirectUriFull.md +10 -0
- data/docs/ReplaceExtensionParams.md +21 -0
- data/docs/ReplaceMenuParams.md +14 -0
- data/docs/ReplacePhoneNumberParams.md +13 -0
- data/docs/RouteFull.md +11 -0
- data/docs/RouteSummary.md +9 -0
- data/docs/RoutesApi.md +316 -0
- data/docs/RuleSet.md +9 -0
- data/docs/RuleSetAction.md +17 -0
- data/docs/RuleSetFilter.md +11 -0
- data/docs/RuleSetForwardItem.md +14 -0
- data/docs/ScheduleFull.md +9 -0
- data/docs/ScheduleSummary.md +9 -0
- data/docs/SchedulesApi.md +137 -0
- data/docs/ScopeDetails.md +8 -0
- data/docs/SipAuthentication.md +11 -0
- data/docs/SmsApi.md +265 -0
- data/docs/SmsForwarding.md +10 -0
- data/docs/SmsForwardingParams.md +10 -0
- data/docs/SmsFull.md +15 -0
- data/docs/SortCallLogs.md +10 -0
- data/docs/SortId.md +8 -0
- data/docs/SortIdCreatedAt.md +9 -0
- data/docs/SortIdExtensionName.md +10 -0
- data/docs/SortIdName.md +9 -0
- data/docs/SortIdNamePhoneNumber.md +10 -0
- data/docs/SortIdUpdatedAt.md +9 -0
- data/docs/SortListAvailableNumbers.md +10 -0
- data/docs/SortListPhoneNumbersRegions.md +14 -0
- data/docs/SortNameNumber.md +9 -0
- data/docs/SubaccountPricingApi.md +261 -0
- data/docs/SubaccountsApi.md +133 -0
- data/docs/TrunkFull.md +15 -0
- data/docs/TrunkSummary.md +9 -0
- data/docs/TrunksApi.md +314 -0
- data/docs/Voicemail.md +13 -0
- data/docs/VoicemailApi.md +207 -0
- data/docs/VoicemailFull.md +16 -0
- data/docs/VoicemailInput.md +13 -0
- data/git_push.sh +55 -0
- data/lib/phone_com_client/api/accounts_api.rb +144 -0
- data/lib/phone_com_client/api/applications_api.rb +166 -0
- data/lib/phone_com_client/api/available_numbers_api.rb +131 -0
- data/lib/phone_com_client/api/call_logs_api.rb +204 -0
- data/lib/phone_com_client/api/caller_ids_api.rb +112 -0
- data/lib/phone_com_client/api/calls_api.rb +79 -0
- data/lib/phone_com_client/api/contacts_api.rb +377 -0
- data/lib/phone_com_client/api/default_api.rb +71 -0
- data/lib/phone_com_client/api/devices_api.rb +344 -0
- data/lib/phone_com_client/api/express_service_codes_api.rb +140 -0
- data/lib/phone_com_client/api/extensions_api.rb +294 -0
- data/lib/phone_com_client/api/groups_api.rb +382 -0
- data/lib/phone_com_client/api/listeners_api.rb +334 -0
- data/lib/phone_com_client/api/media_api.rb +470 -0
- data/lib/phone_com_client/api/menus_api.rb +344 -0
- data/lib/phone_com_client/api/number_regions_api.rb +149 -0
- data/lib/phone_com_client/api/oauth_api.rb +196 -0
- data/lib/phone_com_client/api/oauth_clients_api.rb +216 -0
- data/lib/phone_com_client/api/oauth_clients_redirect_uris_api.rb +296 -0
- data/lib/phone_com_client/api/payment_methods_api.rb +338 -0
- data/lib/phone_com_client/api/phone_numbers_api.rb +294 -0
- data/lib/phone_com_client/api/queues_api.rb +344 -0
- data/lib/phone_com_client/api/routes_api.rb +344 -0
- data/lib/phone_com_client/api/schedules_api.rb +166 -0
- data/lib/phone_com_client/api/sms_api.rb +316 -0
- data/lib/phone_com_client/api/subaccount_pricing_api.rb +300 -0
- data/lib/phone_com_client/api/subaccounts_api.rb +156 -0
- data/lib/phone_com_client/api/trunks_api.rb +352 -0
- data/lib/phone_com_client/api/voicemail_api.rb +252 -0
- data/lib/phone_com_client/api_client.rb +389 -0
- data/lib/phone_com_client/api_error.rb +38 -0
- data/lib/phone_com_client/configuration.rb +209 -0
- data/lib/phone_com_client/models/account_full.rb +245 -0
- data/lib/phone_com_client/models/account_summary.rb +195 -0
- data/lib/phone_com_client/models/address.rb +250 -0
- data/lib/phone_com_client/models/address_list_contacts.rb +234 -0
- data/lib/phone_com_client/models/application_full.rb +195 -0
- data/lib/phone_com_client/models/application_summary.rb +195 -0
- data/lib/phone_com_client/models/available_numbers_full.rb +285 -0
- data/lib/phone_com_client/models/call_details.rb +225 -0
- data/lib/phone_com_client/models/call_full.rb +185 -0
- data/lib/phone_com_client/models/call_log_full.rb +377 -0
- data/lib/phone_com_client/models/call_notifications.rb +197 -0
- data/lib/phone_com_client/models/callback_object.rb +234 -0
- data/lib/phone_com_client/models/caller_id_full.rb +205 -0
- data/lib/phone_com_client/models/caller_id_phone_number.rb +210 -0
- data/lib/phone_com_client/models/contact_account.rb +243 -0
- data/lib/phone_com_client/models/contact_full.rb +370 -0
- data/lib/phone_com_client/models/contact_response.rb +243 -0
- data/lib/phone_com_client/models/contact_summary.rb +255 -0
- data/lib/phone_com_client/models/create_call_params.rb +254 -0
- data/lib/phone_com_client/models/create_contact_params.rb +340 -0
- data/lib/phone_com_client/models/create_device_params.rb +196 -0
- data/lib/phone_com_client/models/create_extension_params.rb +302 -0
- data/lib/phone_com_client/models/create_group_params.rb +184 -0
- data/lib/phone_com_client/models/create_listener_params.rb +206 -0
- data/lib/phone_com_client/models/create_media_params.rb +274 -0
- data/lib/phone_com_client/models/create_menu_params.rb +239 -0
- data/lib/phone_com_client/models/create_oauth_params.rb +264 -0
- data/lib/phone_com_client/models/create_payment_params.rb +214 -0
- data/lib/phone_com_client/models/create_phone_number_params.rb +251 -0
- data/lib/phone_com_client/models/create_pricing_params.rb +204 -0
- data/lib/phone_com_client/models/create_queue_params.rb +246 -0
- data/lib/phone_com_client/models/create_redirect_uri_params.rb +184 -0
- data/lib/phone_com_client/models/create_route_params.rb +206 -0
- data/lib/phone_com_client/models/create_sms_params.rb +229 -0
- data/lib/phone_com_client/models/create_subaccount_params.rb +224 -0
- data/lib/phone_com_client/models/create_trunk_params.rb +246 -0
- data/lib/phone_com_client/models/delete_entry.rb +183 -0
- data/lib/phone_com_client/models/device_full.rb +216 -0
- data/lib/phone_com_client/models/device_membership.rb +195 -0
- data/lib/phone_com_client/models/device_summary.rb +195 -0
- data/lib/phone_com_client/models/email.rb +194 -0
- data/lib/phone_com_client/models/express_service_code_full.rb +207 -0
- data/lib/phone_com_client/models/extension_full.rb +342 -0
- data/lib/phone_com_client/models/extension_summary.rb +205 -0
- data/lib/phone_com_client/models/filter_call_logs.rb +228 -0
- data/lib/phone_com_client/models/filter_id_array.rb +183 -0
- data/lib/phone_com_client/models/filter_id_direction_from.rb +201 -0
- data/lib/phone_com_client/models/filter_id_extension_name_array.rb +201 -0
- data/lib/phone_com_client/models/filter_id_group_id_updated_at_array.rb +201 -0
- data/lib/phone_com_client/models/filter_id_name_array.rb +192 -0
- data/lib/phone_com_client/models/filter_id_name_phone_number_array.rb +201 -0
- data/lib/phone_com_client/models/filter_list_available_numbers.rb +264 -0
- data/lib/phone_com_client/models/filter_list_phone_numbers_regions.rb +237 -0
- data/lib/phone_com_client/models/filter_name_number_array.rb +192 -0
- data/lib/phone_com_client/models/filter_voicemail_array.rb +228 -0
- data/lib/phone_com_client/models/from_object.rb +215 -0
- data/lib/phone_com_client/models/get_oauth_access_token.rb +203 -0
- data/lib/phone_com_client/models/greeting.rb +215 -0
- data/lib/phone_com_client/models/greeting_input.rb +215 -0
- data/lib/phone_com_client/models/group_full.rb +195 -0
- data/lib/phone_com_client/models/group_list_contacts.rb +195 -0
- data/lib/phone_com_client/models/group_summary.rb +195 -0
- data/lib/phone_com_client/models/hold_music.rb +195 -0
- data/lib/phone_com_client/models/line.rb +194 -0
- data/lib/phone_com_client/models/list_accounts.rb +230 -0
- data/lib/phone_com_client/models/list_applications.rb +230 -0
- data/lib/phone_com_client/models/list_available_numbers.rb +230 -0
- data/lib/phone_com_client/models/list_call_logs.rb +230 -0
- data/lib/phone_com_client/models/list_caller_ids.rb +230 -0
- data/lib/phone_com_client/models/list_contacts.rb +230 -0
- data/lib/phone_com_client/models/list_devices.rb +230 -0
- data/lib/phone_com_client/models/list_express_service_codes.rb +232 -0
- data/lib/phone_com_client/models/list_extensions.rb +230 -0
- data/lib/phone_com_client/models/list_groups.rb +230 -0
- data/lib/phone_com_client/models/list_listeners.rb +230 -0
- data/lib/phone_com_client/models/list_media.rb +230 -0
- data/lib/phone_com_client/models/list_menus.rb +230 -0
- data/lib/phone_com_client/models/list_oauth_clients.rb +230 -0
- data/lib/phone_com_client/models/list_oauth_clients_redirect_uris.rb +221 -0
- data/lib/phone_com_client/models/list_payment_methods.rb +230 -0
- data/lib/phone_com_client/models/list_phone_numbers.rb +231 -0
- data/lib/phone_com_client/models/list_phone_numbers_regions.rb +241 -0
- data/lib/phone_com_client/models/list_pricings.rb +230 -0
- data/lib/phone_com_client/models/list_queues.rb +230 -0
- data/lib/phone_com_client/models/list_routes.rb +230 -0
- data/lib/phone_com_client/models/list_schedules.rb +230 -0
- data/lib/phone_com_client/models/list_sms.rb +230 -0
- data/lib/phone_com_client/models/list_trunks.rb +230 -0
- data/lib/phone_com_client/models/list_voicemail.rb +230 -0
- data/lib/phone_com_client/models/listener_full.rb +244 -0
- data/lib/phone_com_client/models/media_full.rb +220 -0
- data/lib/phone_com_client/models/media_summary.rb +195 -0
- data/lib/phone_com_client/models/member.rb +194 -0
- data/lib/phone_com_client/models/menu_full.rb +257 -0
- data/lib/phone_com_client/models/menu_summary.rb +195 -0
- data/lib/phone_com_client/models/notification.rb +197 -0
- data/lib/phone_com_client/models/oauth_access_token.rb +219 -0
- data/lib/phone_com_client/models/oauth_client_full.rb +195 -0
- data/lib/phone_com_client/models/oauth_client_redirect_uri_full.rb +205 -0
- data/lib/phone_com_client/models/option.rb +194 -0
- data/lib/phone_com_client/models/patch_payment_params.rb +184 -0
- data/lib/phone_com_client/models/patch_sms_params.rb +184 -0
- data/lib/phone_com_client/models/patch_voicemail_params.rb +184 -0
- data/lib/phone_com_client/models/payment_full.rb +305 -0
- data/lib/phone_com_client/models/payment_summary.rb +235 -0
- data/lib/phone_com_client/models/phone_number_contact.rb +204 -0
- data/lib/phone_com_client/models/phone_number_full.rb +262 -0
- data/lib/phone_com_client/models/phone_numbers_region_full.rb +255 -0
- data/lib/phone_com_client/models/ping_response.rb +211 -0
- data/lib/phone_com_client/models/pricing_full.rb +235 -0
- data/lib/phone_com_client/models/pricing_object.rb +194 -0
- data/lib/phone_com_client/models/queue_full.rb +266 -0
- data/lib/phone_com_client/models/queue_summary.rb +205 -0
- data/lib/phone_com_client/models/recipient.rb +194 -0
- data/lib/phone_com_client/models/redirect_uri_full.rb +204 -0
- data/lib/phone_com_client/models/replace_extension_params.rb +312 -0
- data/lib/phone_com_client/models/replace_menu_params.rb +239 -0
- data/lib/phone_com_client/models/replace_phone_number_params.rb +251 -0
- data/lib/phone_com_client/models/route_full.rb +217 -0
- data/lib/phone_com_client/models/route_summary.rb +195 -0
- data/lib/phone_com_client/models/rule_set.rb +195 -0
- data/lib/phone_com_client/models/rule_set_action.rb +292 -0
- data/lib/phone_com_client/models/rule_set_filter.rb +230 -0
- data/lib/phone_com_client/models/rule_set_forward_item.rb +294 -0
- data/lib/phone_com_client/models/schedule_full.rb +195 -0
- data/lib/phone_com_client/models/schedule_summary.rb +195 -0
- data/lib/phone_com_client/models/scope_details.rb +183 -0
- data/lib/phone_com_client/models/sip_authentication.rb +215 -0
- data/lib/phone_com_client/models/sms_forwarding.rb +220 -0
- data/lib/phone_com_client/models/sms_forwarding_params.rb +220 -0
- data/lib/phone_com_client/models/sms_full.rb +257 -0
- data/lib/phone_com_client/models/sort_call_logs.rb +201 -0
- data/lib/phone_com_client/models/sort_id.rb +183 -0
- data/lib/phone_com_client/models/sort_id_created_at.rb +192 -0
- data/lib/phone_com_client/models/sort_id_extension_name.rb +201 -0
- data/lib/phone_com_client/models/sort_id_name.rb +192 -0
- data/lib/phone_com_client/models/sort_id_name_phone_number.rb +201 -0
- data/lib/phone_com_client/models/sort_id_updated_at.rb +192 -0
- data/lib/phone_com_client/models/sort_list_available_numbers.rb +201 -0
- data/lib/phone_com_client/models/sort_list_phone_numbers_regions.rb +237 -0
- data/lib/phone_com_client/models/sort_name_number.rb +192 -0
- data/lib/phone_com_client/models/trunk_full.rb +297 -0
- data/lib/phone_com_client/models/trunk_summary.rb +205 -0
- data/lib/phone_com_client/models/voicemail.rb +234 -0
- data/lib/phone_com_client/models/voicemail_full.rb +265 -0
- data/lib/phone_com_client/models/voicemail_input.rb +234 -0
- data/lib/phone_com_client/version.rb +15 -0
- data/lib/phone_com_client.rb +214 -0
- data/phone_com_client.gemspec +45 -0
- data/spec/api/accounts_api_spec.rb +63 -0
- data/spec/api/applications_api_spec.rb +67 -0
- data/spec/api/available_numbers_api_spec.rb +62 -0
- data/spec/api/call_logs_api_spec.rb +73 -0
- data/spec/api/caller_ids_api_spec.rb +55 -0
- data/spec/api/calls_api_spec.rb +48 -0
- data/spec/api/contacts_api_spec.rb +113 -0
- data/spec/api/default_api_spec.rb +46 -0
- data/spec/api/devices_api_spec.rb +107 -0
- data/spec/api/express_service_codes_api_spec.rb +61 -0
- data/spec/api/extensions_api_spec.rb +96 -0
- data/spec/api/groups_api_spec.rb +112 -0
- data/spec/api/listeners_api_spec.rb +105 -0
- data/spec/api/media_api_spec.rb +136 -0
- data/spec/api/menus_api_spec.rb +107 -0
- data/spec/api/number_regions_api_spec.rb +64 -0
- data/spec/api/oauth_api_spec.rb +73 -0
- data/spec/api/oauth_clients_api_spec.rb +78 -0
- data/spec/api/oauth_clients_redirect_uris_api_spec.rb +95 -0
- data/spec/api/payment_methods_api_spec.rb +105 -0
- data/spec/api/phone_numbers_api_spec.rb +96 -0
- data/spec/api/queues_api_spec.rb +107 -0
- data/spec/api/routes_api_spec.rb +107 -0
- data/spec/api/schedules_api_spec.rb +67 -0
- data/spec/api/sms_api_spec.rb +98 -0
- data/spec/api/subaccount_pricing_api_spec.rb +95 -0
- data/spec/api/subaccounts_api_spec.rb +65 -0
- data/spec/api/trunks_api_spec.rb +107 -0
- data/spec/api/voicemail_api_spec.rb +85 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/account_full_spec.rb +77 -0
- data/spec/models/account_summary_spec.rb +47 -0
- data/spec/models/address_list_contacts_spec.rb +71 -0
- data/spec/models/address_spec.rb +71 -0
- data/spec/models/application_full_spec.rb +47 -0
- data/spec/models/application_summary_spec.rb +47 -0
- data/spec/models/available_numbers_full_spec.rb +101 -0
- data/spec/models/call_details_spec.rb +65 -0
- data/spec/models/call_full_spec.rb +41 -0
- data/spec/models/call_log_full_spec.rb +155 -0
- data/spec/models/call_notifications_spec.rb +47 -0
- data/spec/models/callback_object_spec.rb +71 -0
- data/spec/models/caller_id_full_spec.rb +53 -0
- data/spec/models/caller_id_phone_number_spec.rb +47 -0
- data/spec/models/contact_account_spec.rb +77 -0
- data/spec/models/contact_full_spec.rb +149 -0
- data/spec/models/contact_response_spec.rb +77 -0
- data/spec/models/contact_summary_spec.rb +83 -0
- data/spec/models/create_call_params_spec.rb +83 -0
- data/spec/models/create_contact_params_spec.rb +131 -0
- data/spec/models/create_device_params_spec.rb +47 -0
- data/spec/models/create_extension_params_spec.rb +113 -0
- data/spec/models/create_group_params_spec.rb +41 -0
- data/spec/models/create_listener_params_spec.rb +53 -0
- data/spec/models/create_media_params_spec.rb +95 -0
- data/spec/models/create_menu_params_spec.rb +77 -0
- data/spec/models/create_oauth_params_spec.rb +89 -0
- data/spec/models/create_payment_params_spec.rb +59 -0
- data/spec/models/create_phone_number_params_spec.rb +83 -0
- data/spec/models/create_pricing_params_spec.rb +53 -0
- data/spec/models/create_queue_params_spec.rb +77 -0
- data/spec/models/create_redirect_uri_params_spec.rb +41 -0
- data/spec/models/create_route_params_spec.rb +53 -0
- data/spec/models/create_sms_params_spec.rb +59 -0
- data/spec/models/create_subaccount_params_spec.rb +59 -0
- data/spec/models/create_trunk_params_spec.rb +77 -0
- data/spec/models/delete_entry_spec.rb +41 -0
- data/spec/models/device_full_spec.rb +59 -0
- data/spec/models/device_membership_spec.rb +47 -0
- data/spec/models/device_summary_spec.rb +47 -0
- data/spec/models/email_spec.rb +47 -0
- data/spec/models/express_service_code_full_spec.rb +53 -0
- data/spec/models/extension_full_spec.rb +137 -0
- data/spec/models/extension_summary_spec.rb +53 -0
- data/spec/models/filter_call_logs_spec.rb +71 -0
- data/spec/models/filter_id_array_spec.rb +41 -0
- data/spec/models/filter_id_direction_from_spec.rb +53 -0
- data/spec/models/filter_id_extension_name_array_spec.rb +53 -0
- data/spec/models/filter_id_group_id_updated_at_array_spec.rb +53 -0
- data/spec/models/filter_id_name_array_spec.rb +47 -0
- data/spec/models/filter_id_name_phone_number_array_spec.rb +53 -0
- data/spec/models/filter_list_available_numbers_spec.rb +95 -0
- data/spec/models/filter_list_phone_numbers_regions_spec.rb +77 -0
- data/spec/models/filter_name_number_array_spec.rb +47 -0
- data/spec/models/filter_voicemail_array_spec.rb +71 -0
- data/spec/models/from_object_spec.rb +59 -0
- data/spec/models/get_oauth_access_token_spec.rb +53 -0
- data/spec/models/greeting_input_spec.rb +59 -0
- data/spec/models/greeting_spec.rb +59 -0
- data/spec/models/group_full_spec.rb +47 -0
- data/spec/models/group_list_contacts_spec.rb +47 -0
- data/spec/models/group_summary_spec.rb +47 -0
- data/spec/models/hold_music_spec.rb +47 -0
- data/spec/models/line_spec.rb +47 -0
- data/spec/models/list_accounts_spec.rb +71 -0
- data/spec/models/list_applications_spec.rb +71 -0
- data/spec/models/list_available_numbers_spec.rb +71 -0
- data/spec/models/list_call_logs_spec.rb +71 -0
- data/spec/models/list_caller_ids_spec.rb +71 -0
- data/spec/models/list_contacts_spec.rb +71 -0
- data/spec/models/list_devices_spec.rb +71 -0
- data/spec/models/list_express_service_codes_spec.rb +71 -0
- data/spec/models/list_extensions_spec.rb +71 -0
- data/spec/models/list_groups_spec.rb +71 -0
- data/spec/models/list_listeners_spec.rb +71 -0
- data/spec/models/list_media_spec.rb +71 -0
- data/spec/models/list_menus_spec.rb +71 -0
- data/spec/models/list_oauth_clients_redirect_uris_spec.rb +65 -0
- data/spec/models/list_oauth_clients_spec.rb +71 -0
- data/spec/models/list_payment_methods_spec.rb +71 -0
- data/spec/models/list_phone_numbers_regions_spec.rb +77 -0
- data/spec/models/list_phone_numbers_spec.rb +71 -0
- data/spec/models/list_pricings_spec.rb +71 -0
- data/spec/models/list_queues_spec.rb +71 -0
- data/spec/models/list_routes_spec.rb +71 -0
- data/spec/models/list_schedules_spec.rb +71 -0
- data/spec/models/list_sms_spec.rb +71 -0
- data/spec/models/list_trunks_spec.rb +71 -0
- data/spec/models/list_voicemail_spec.rb +71 -0
- data/spec/models/listener_full_spec.rb +77 -0
- data/spec/models/media_full_spec.rb +53 -0
- data/spec/models/media_summary_spec.rb +47 -0
- data/spec/models/member_spec.rb +47 -0
- data/spec/models/menu_full_spec.rb +83 -0
- data/spec/models/menu_summary_spec.rb +47 -0
- data/spec/models/notification_spec.rb +47 -0
- data/spec/models/oauth_access_token_spec.rb +65 -0
- data/spec/models/oauth_client_full_spec.rb +47 -0
- data/spec/models/oauth_client_redirect_uri_full_spec.rb +53 -0
- data/spec/models/option_spec.rb +47 -0
- data/spec/models/patch_payment_params_spec.rb +41 -0
- data/spec/models/patch_sms_params_spec.rb +41 -0
- data/spec/models/patch_voicemail_params_spec.rb +41 -0
- data/spec/models/payment_full_spec.rb +113 -0
- data/spec/models/payment_summary_spec.rb +71 -0
- data/spec/models/phone_number_contact_spec.rb +53 -0
- data/spec/models/phone_number_full_spec.rb +89 -0
- data/spec/models/phone_numbers_region_full_spec.rb +83 -0
- data/spec/models/ping_response_spec.rb +59 -0
- data/spec/models/pricing_full_spec.rb +71 -0
- data/spec/models/pricing_object_spec.rb +47 -0
- data/spec/models/queue_full_spec.rb +83 -0
- data/spec/models/queue_summary_spec.rb +47 -0
- data/spec/models/recipient_spec.rb +47 -0
- data/spec/models/redirect_uri_full_spec.rb +53 -0
- data/spec/models/replace_extension_params_spec.rb +119 -0
- data/spec/models/replace_menu_params_spec.rb +77 -0
- data/spec/models/replace_phone_number_params_spec.rb +83 -0
- data/spec/models/route_full_spec.rb +59 -0
- data/spec/models/route_summary_spec.rb +47 -0
- data/spec/models/rule_set_action_spec.rb +95 -0
- data/spec/models/rule_set_filter_spec.rb +59 -0
- data/spec/models/rule_set_forward_item_spec.rb +77 -0
- data/spec/models/rule_set_spec.rb +47 -0
- data/spec/models/schedule_full_spec.rb +47 -0
- data/spec/models/schedule_summary_spec.rb +47 -0
- data/spec/models/scope_details_spec.rb +41 -0
- data/spec/models/sip_authentication_spec.rb +59 -0
- data/spec/models/sms_forwarding_params_spec.rb +53 -0
- data/spec/models/sms_forwarding_spec.rb +53 -0
- data/spec/models/sms_full_spec.rb +83 -0
- data/spec/models/sort_call_logs_spec.rb +53 -0
- data/spec/models/sort_id_created_at_spec.rb +47 -0
- data/spec/models/sort_id_extension_name_spec.rb +53 -0
- data/spec/models/sort_id_name_phone_number_spec.rb +53 -0
- data/spec/models/sort_id_name_spec.rb +47 -0
- data/spec/models/sort_id_spec.rb +41 -0
- data/spec/models/sort_id_updated_at_spec.rb +47 -0
- data/spec/models/sort_list_available_numbers_spec.rb +53 -0
- data/spec/models/sort_list_phone_numbers_regions_spec.rb +77 -0
- data/spec/models/sort_name_number_spec.rb +47 -0
- data/spec/models/trunk_full_spec.rb +83 -0
- data/spec/models/trunk_summary_spec.rb +47 -0
- data/spec/models/voicemail_full_spec.rb +89 -0
- data/spec/models/voicemail_input_spec.rb +71 -0
- data/spec/models/voicemail_spec.rb +71 -0
- data/spec/spec_helper.rb +111 -0
- metadata +942 -0
checksums.yaml
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
---
|
|
2
|
+
SHA256:
|
|
3
|
+
metadata.gz: cc34bc327e3661340b5605bcf2ec2bf6e25f5dcdd83ae51a562d6225da0b63af
|
|
4
|
+
data.tar.gz: ab1b31805ff90f62aac16f46786b68fdc9397a53744a21485d58a3cf44462c8d
|
|
5
|
+
SHA512:
|
|
6
|
+
metadata.gz: acbd238eb69ba9ca3aa103b047f0798a59245bd22fbf75d0017cb0efaf5d17b44bd2837f976bce1c1a9f98ab96a7e5eceaea015d126e46d5744427ba57bcfd31
|
|
7
|
+
data.tar.gz: f61658de1b4e9be575ff49175761e265593bf7b3d564ba1a087bc0792832c82d5f664098bef7c9f1f674a90c47975af96a889cf26011c8e6632f65618d393963
|
data/Gemfile
ADDED
data/Gemfile.lock
ADDED
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
PATH
|
|
2
|
+
remote: .
|
|
3
|
+
specs:
|
|
4
|
+
phone_com_client (1.0.0)
|
|
5
|
+
json (~> 2.1, >= 2.1.0)
|
|
6
|
+
typhoeus (~> 1.0, >= 1.0.1)
|
|
7
|
+
|
|
8
|
+
GEM
|
|
9
|
+
remote: https://rubygems.org/
|
|
10
|
+
specs:
|
|
11
|
+
ZenTest (4.11.2)
|
|
12
|
+
addressable (2.6.0)
|
|
13
|
+
public_suffix (>= 2.0.2, < 4.0)
|
|
14
|
+
autotest (4.4.6)
|
|
15
|
+
ZenTest (>= 4.4.1)
|
|
16
|
+
autotest-fsevent (0.2.14)
|
|
17
|
+
sys-uname
|
|
18
|
+
autotest-growl (0.2.16)
|
|
19
|
+
autotest-rails-pure (4.1.2)
|
|
20
|
+
crack (0.4.3)
|
|
21
|
+
safe_yaml (~> 1.0.0)
|
|
22
|
+
diff-lcs (1.3)
|
|
23
|
+
ethon (0.12.0)
|
|
24
|
+
ffi (>= 1.3.0)
|
|
25
|
+
ffi (1.10.0)
|
|
26
|
+
hashdiff (0.3.9)
|
|
27
|
+
json (2.2.0)
|
|
28
|
+
public_suffix (3.0.3)
|
|
29
|
+
rake (12.0.0)
|
|
30
|
+
rspec (3.8.0)
|
|
31
|
+
rspec-core (~> 3.8.0)
|
|
32
|
+
rspec-expectations (~> 3.8.0)
|
|
33
|
+
rspec-mocks (~> 3.8.0)
|
|
34
|
+
rspec-core (3.8.0)
|
|
35
|
+
rspec-support (~> 3.8.0)
|
|
36
|
+
rspec-expectations (3.8.3)
|
|
37
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
|
38
|
+
rspec-support (~> 3.8.0)
|
|
39
|
+
rspec-mocks (3.8.0)
|
|
40
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
|
41
|
+
rspec-support (~> 3.8.0)
|
|
42
|
+
rspec-support (3.8.0)
|
|
43
|
+
safe_yaml (1.0.5)
|
|
44
|
+
sys-uname (1.0.4)
|
|
45
|
+
ffi (>= 1.0.0)
|
|
46
|
+
typhoeus (1.3.1)
|
|
47
|
+
ethon (>= 0.9.0)
|
|
48
|
+
vcr (3.0.3)
|
|
49
|
+
webmock (1.24.6)
|
|
50
|
+
addressable (>= 2.3.6)
|
|
51
|
+
crack (>= 0.3.2)
|
|
52
|
+
hashdiff
|
|
53
|
+
|
|
54
|
+
PLATFORMS
|
|
55
|
+
ruby
|
|
56
|
+
|
|
57
|
+
DEPENDENCIES
|
|
58
|
+
autotest (~> 4.4, >= 4.4.6)
|
|
59
|
+
autotest-fsevent (~> 0.2, >= 0.2.12)
|
|
60
|
+
autotest-growl (~> 0.2, >= 0.2.16)
|
|
61
|
+
autotest-rails-pure (~> 4.1, >= 4.1.2)
|
|
62
|
+
phone_com_client!
|
|
63
|
+
rake (~> 12.0.0)
|
|
64
|
+
rspec (~> 3.6, >= 3.6.0)
|
|
65
|
+
vcr (~> 3.0, >= 3.0.1)
|
|
66
|
+
webmock (~> 1.24, >= 1.24.3)
|
|
67
|
+
|
|
68
|
+
BUNDLED WITH
|
|
69
|
+
1.17.2
|
data/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2019 Nick Gorbikoff
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
data/README.md
ADDED
|
@@ -0,0 +1,344 @@
|
|
|
1
|
+
# phone_com_client
|
|
2
|
+
|
|
3
|
+
PhoneComClient - the Ruby gem for the Phone.com API
|
|
4
|
+
|
|
5
|
+
This is a Phone.com api PhoneCom definition
|
|
6
|
+
|
|
7
|
+
This SDK is automatically generated by the [PhoneCom Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
|
8
|
+
|
|
9
|
+
- API version: 1.0.0
|
|
10
|
+
- Package version: 1.0.0
|
|
11
|
+
- Build package: io.swagger.codegen.languages.RubyClientCodegen
|
|
12
|
+
|
|
13
|
+
## Installation
|
|
14
|
+
|
|
15
|
+
### Build a gem
|
|
16
|
+
|
|
17
|
+
To build the Ruby code into a gem:
|
|
18
|
+
|
|
19
|
+
```shell
|
|
20
|
+
gem build phone_com_client.gemspec
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
Then either install the gem locally:
|
|
24
|
+
|
|
25
|
+
```shell
|
|
26
|
+
gem install ./phone_com_client-1.0.0.gem
|
|
27
|
+
```
|
|
28
|
+
(for development, run `gem install --dev ./phone_com_client-1.0.0.gem` to install the development dependencies)
|
|
29
|
+
|
|
30
|
+
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
|
31
|
+
|
|
32
|
+
Finally add this to the Gemfile:
|
|
33
|
+
|
|
34
|
+
gem 'phone_com_client', '~> 1.0.0'
|
|
35
|
+
|
|
36
|
+
### Install from Git
|
|
37
|
+
|
|
38
|
+
If the Ruby gem is hosted at a git repository: https://github.com/YOUR_GIT_USERNAME/YOUR_GIT_REPO, then add the following in the Gemfile:
|
|
39
|
+
|
|
40
|
+
gem 'phone_com_client', :git => 'https://github.com/YOUR_GIT_USERNAME/YOUR_GIT_REPO.git'
|
|
41
|
+
|
|
42
|
+
### Include the Ruby code directly
|
|
43
|
+
|
|
44
|
+
Include the Ruby code directly using `-I` as follows:
|
|
45
|
+
|
|
46
|
+
```shell
|
|
47
|
+
ruby -Ilib script.rb
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
## Getting Started
|
|
51
|
+
|
|
52
|
+
Please follow the [installation](#installation) procedure and then run the following code:
|
|
53
|
+
```ruby
|
|
54
|
+
# Load the gem
|
|
55
|
+
require 'phone_com_client'
|
|
56
|
+
|
|
57
|
+
# Setup authorization
|
|
58
|
+
PhoneComClient.configure do |config|
|
|
59
|
+
# Configure API key authorization: apiKey
|
|
60
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
61
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
62
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
63
|
+
end
|
|
64
|
+
|
|
65
|
+
api_instance = PhoneComClient::AccountsApi.new
|
|
66
|
+
|
|
67
|
+
account_id = 56 # Integer | Account ID
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
begin
|
|
71
|
+
#Retrieve details of an individual account
|
|
72
|
+
result = api_instance.get_account(account_id, )
|
|
73
|
+
p result
|
|
74
|
+
rescue PhoneComClient::ApiError => e
|
|
75
|
+
puts "Exception when calling AccountsApi->get_account: #{e}"
|
|
76
|
+
end
|
|
77
|
+
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
## Documentation for API Endpoints
|
|
81
|
+
|
|
82
|
+
All URIs are relative to *https://api.phone.com/v4*
|
|
83
|
+
|
|
84
|
+
Class | Method | HTTP request | Description
|
|
85
|
+
------------ | ------------- | ------------- | -------------
|
|
86
|
+
*PhoneComClient::AccountsApi* | [**get_account**](docs/AccountsApi.md#get_account) | **GET** /accounts/{account_id} | Retrieve details of an individual account
|
|
87
|
+
*PhoneComClient::AccountsApi* | [**list_accounts**](docs/AccountsApi.md#list_accounts) | **GET** /accounts | Get a list of accounts visible to the authenticated user or client.
|
|
88
|
+
*PhoneComClient::ApplicationsApi* | [**get_account_application**](docs/ApplicationsApi.md#get_account_application) | **GET** /accounts/{account_id}/applications/{application_id} | Show details of an individual Application on a given account.
|
|
89
|
+
*PhoneComClient::ApplicationsApi* | [**list_account_applications**](docs/ApplicationsApi.md#list_account_applications) | **GET** /accounts/{account_id}/applications | This service lists the Applications on a given account
|
|
90
|
+
*PhoneComClient::AvailableNumbersApi* | [**list_available_phone_numbers**](docs/AvailableNumbersApi.md#list_available_phone_numbers) | **GET** /phone-numbers/available |
|
|
91
|
+
*PhoneComClient::CallLogsApi* | [**get_account_call_logs**](docs/CallLogsApi.md#get_account_call_logs) | **GET** /accounts/{account_id}/call-logs/{call_id} | Show details of an individual Call Log entry
|
|
92
|
+
*PhoneComClient::CallLogsApi* | [**list_account_call_logs**](docs/CallLogsApi.md#list_account_call_logs) | **GET** /accounts/{account_id}/call-logs | Get a list of call details associated with your account
|
|
93
|
+
*PhoneComClient::CallerIdsApi* | [**get_caller_ids**](docs/CallerIdsApi.md#get_caller_ids) | **GET** /accounts/{account_id}/extensions/{extension_id}/caller-ids | Show the Caller ID options a given extension can use.
|
|
94
|
+
*PhoneComClient::CallsApi* | [**create_account_call**](docs/CallsApi.md#create_account_call) | **POST** /accounts/{account_id}/calls | Make a phone call
|
|
95
|
+
*PhoneComClient::ContactsApi* | [**create_account_extension_contact**](docs/ContactsApi.md#create_account_extension_contact) | **POST** /accounts/{account_id}/extensions/{extension_id}/contacts | Add a new address book contact for an extension.
|
|
96
|
+
*PhoneComClient::ContactsApi* | [**delete_account_extension_contact**](docs/ContactsApi.md#delete_account_extension_contact) | **DELETE** /accounts/{account_id}/extensions/{extension_id}/contacts/{contact_id} | Delete a contact from the address book.
|
|
97
|
+
*PhoneComClient::ContactsApi* | [**get_account_extension_contact**](docs/ContactsApi.md#get_account_extension_contact) | **GET** /accounts/{account_id}/extensions/{extension_id}/contacts/{contact_id} | Retrieve the details of an address book contact.
|
|
98
|
+
*PhoneComClient::ContactsApi* | [**list_account_extension_contacts**](docs/ContactsApi.md#list_account_extension_contacts) | **GET** /accounts/{account_id}/extensions/{extension_id}/contacts | Show the Caller ID options a given extension can use.
|
|
99
|
+
*PhoneComClient::ContactsApi* | [**replace_account_extension_contact**](docs/ContactsApi.md#replace_account_extension_contact) | **PUT** /accounts/{account_id}/extensions/{extension_id}/contacts/{contact_id} | Update the info of a contact in the address book.
|
|
100
|
+
*PhoneComClient::DefaultApi* | [**ping**](docs/DefaultApi.md#ping) | **GET** /ping | The default API command
|
|
101
|
+
*PhoneComClient::DevicesApi* | [**create_account_device**](docs/DevicesApi.md#create_account_device) | **POST** /accounts/{account_id}/devices | Register a generic VoIP device.
|
|
102
|
+
*PhoneComClient::DevicesApi* | [**delete_account_device**](docs/DevicesApi.md#delete_account_device) | **DELETE** /accounts/{account_id}/devices/{device_id} | Delete a VoIP device.
|
|
103
|
+
*PhoneComClient::DevicesApi* | [**get_account_device**](docs/DevicesApi.md#get_account_device) | **GET** /accounts/{account_id}/devices/{device_id} | Show details of an individual VoIP device.
|
|
104
|
+
*PhoneComClient::DevicesApi* | [**list_account_devices**](docs/DevicesApi.md#list_account_devices) | **GET** /accounts/{account_id}/devices | Get a list of VoIP devices associated with your account.
|
|
105
|
+
*PhoneComClient::DevicesApi* | [**replace_account_device**](docs/DevicesApi.md#replace_account_device) | **PUT** /accounts/{account_id}/devices/{device_id} | Update the details of an individual VoIP device.
|
|
106
|
+
*PhoneComClient::ExpressServiceCodesApi* | [**get_account_express_srv_code**](docs/ExpressServiceCodesApi.md#get_account_express_srv_code) | **GET** /accounts/{account_id}/express-service-codes/{code_id} | Show details of an account Express Service Code
|
|
107
|
+
*PhoneComClient::ExpressServiceCodesApi* | [**list_account_express_srv_codes**](docs/ExpressServiceCodesApi.md#list_account_express_srv_codes) | **GET** /accounts/{account_id}/express-service-codes | Get the Express Service Code associated with your account in list format.
|
|
108
|
+
*PhoneComClient::ExtensionsApi* | [**create_account_extension**](docs/ExtensionsApi.md#create_account_extension) | **POST** /accounts/{account_id}/extensions | Create an individual extension.
|
|
109
|
+
*PhoneComClient::ExtensionsApi* | [**get_account_extension**](docs/ExtensionsApi.md#get_account_extension) | **GET** /accounts/{account_id}/extensions/{extension_id} | Show details of an individual extension.
|
|
110
|
+
*PhoneComClient::ExtensionsApi* | [**list_account_extensions**](docs/ExtensionsApi.md#list_account_extensions) | **GET** /accounts/{account_id}/extensions | Get a list of extensions visible to the authenticated user or client.
|
|
111
|
+
*PhoneComClient::ExtensionsApi* | [**replace_account_extension**](docs/ExtensionsApi.md#replace_account_extension) | **PUT** /accounts/{account_id}/extensions/{extension_id} | Replace an individual extension.
|
|
112
|
+
*PhoneComClient::GroupsApi* | [**create_account_extension_contact_group**](docs/GroupsApi.md#create_account_extension_contact_group) | **POST** /accounts/{account_id}/extensions/{extension_id}/contact-groups | Add a new contact group to an account extension.
|
|
113
|
+
*PhoneComClient::GroupsApi* | [**delete_account_extension_contact_group**](docs/GroupsApi.md#delete_account_extension_contact_group) | **DELETE** /accounts/{account_id}/extensions/{extension_id}/contact-groups/{group_id} | Delete a contact group from the address book.
|
|
114
|
+
*PhoneComClient::GroupsApi* | [**get_account_extension_contact_group**](docs/GroupsApi.md#get_account_extension_contact_group) | **GET** /accounts/{account_id}/extensions/{extension_id}/contact-groups/{group_id} | Retrieve the information of a contact group.
|
|
115
|
+
*PhoneComClient::GroupsApi* | [**list_account_extension_contact_groups**](docs/GroupsApi.md#list_account_extension_contact_groups) | **GET** /accounts/{account_id}/extensions/{extension_id}/contact-groups | Show a list of contact groups belonging to an extension.
|
|
116
|
+
*PhoneComClient::GroupsApi* | [**replace_account_extension_contact_group**](docs/GroupsApi.md#replace_account_extension_contact_group) | **PUT** /accounts/{account_id}/extensions/{extension_id}/contact-groups/{group_id} | Update the information of a contact group.
|
|
117
|
+
*PhoneComClient::ListenersApi* | [**create_account_listener**](docs/ListenersApi.md#create_account_listener) | **POST** /accounts/{account_id}/listeners | Add a listener object to your account that can be used to subscribe an event.
|
|
118
|
+
*PhoneComClient::ListenersApi* | [**delete_account_listener**](docs/ListenersApi.md#delete_account_listener) | **DELETE** /accounts/{account_id}/listeners/{listener_id} | Delete an individual event listener.
|
|
119
|
+
*PhoneComClient::ListenersApi* | [**get_account_listener**](docs/ListenersApi.md#get_account_listener) | **GET** /accounts/{account_id}/listeners/{listener_id} | Show details of an individual listener.
|
|
120
|
+
*PhoneComClient::ListenersApi* | [**list_account_listeners**](docs/ListenersApi.md#list_account_listeners) | **GET** /accounts/{account_id}/listeners | Get a list of listeners for an account.
|
|
121
|
+
*PhoneComClient::ListenersApi* | [**replace_account_listener**](docs/ListenersApi.md#replace_account_listener) | **PUT** /accounts/{account_id}/listeners/{listener_id} | Update the settings of an individual event listener.
|
|
122
|
+
*PhoneComClient::MediaApi* | [**create_account_media_files**](docs/MediaApi.md#create_account_media_files) | **POST** /accounts/{account_id}/media/files | Add a media object to your account that can be used as a greeting or hold music. Users may create a media by using the built-in Text-to-speech (TTS) facility or upload a file of their choice. (Note: The maximum size for media files or JSON objects included with a POST or PUT request is 10 MB)
|
|
123
|
+
*PhoneComClient::MediaApi* | [**create_account_media_tts**](docs/MediaApi.md#create_account_media_tts) | **POST** /accounts/{account_id}/media/tts | Add a media object to your account that can be used as a greeting or hold music. Users may create a media by using the built-in Text-to-speech (TTS) facility or upload a file of their choice. (Note: The maximum size for media files or JSON objects included with a POST or PUT request is 10 MB)
|
|
124
|
+
*PhoneComClient::MediaApi* | [**delete_account_media**](docs/MediaApi.md#delete_account_media) | **DELETE** /accounts/{account_id}/media/{media_id} | Delete an individual media record
|
|
125
|
+
*PhoneComClient::MediaApi* | [**get_account_media**](docs/MediaApi.md#get_account_media) | **GET** /accounts/{account_id}/media/{media_id} | Show details of an individual media recording (Greeting or Hold Music)
|
|
126
|
+
*PhoneComClient::MediaApi* | [**list_account_media**](docs/MediaApi.md#list_account_media) | **GET** /accounts/{account_id}/media | Get a list of media recordings for an account.
|
|
127
|
+
*PhoneComClient::MediaApi* | [**replace_account_media_files**](docs/MediaApi.md#replace_account_media_files) | **PUT** /accounts/{account_id}/media/files/{media_id} | Update a media object to your account. Note: The maximum size for media files or JSON objects included with a POST or PUT request is 10 MB.
|
|
128
|
+
*PhoneComClient::MediaApi* | [**replace_account_media_tts**](docs/MediaApi.md#replace_account_media_tts) | **PUT** /accounts/{account_id}/media/tts/{media_id} | Update a media object to your account.
|
|
129
|
+
*PhoneComClient::MenusApi* | [**create_account_menu**](docs/MenusApi.md#create_account_menu) | **POST** /accounts/{account_id}/menus | Create an individual menu.
|
|
130
|
+
*PhoneComClient::MenusApi* | [**delete_account_menu**](docs/MenusApi.md#delete_account_menu) | **DELETE** /accounts/{account_id}/menus/{menu_id} | Delete an individual menu.
|
|
131
|
+
*PhoneComClient::MenusApi* | [**get_account_menu**](docs/MenusApi.md#get_account_menu) | **GET** /accounts/{account_id}/menus/{menu_id} | Show details of an individual menu.
|
|
132
|
+
*PhoneComClient::MenusApi* | [**list_account_menus**](docs/MenusApi.md#list_account_menus) | **GET** /accounts/{account_id}/menus | Get a list of menus for an account.
|
|
133
|
+
*PhoneComClient::MenusApi* | [**replace_account_menu**](docs/MenusApi.md#replace_account_menu) | **PUT** /accounts/{account_id}/menus/{menu_id} | Replace an individual menu.
|
|
134
|
+
*PhoneComClient::NumberRegionsApi* | [**list_available_phone_number_regions**](docs/NumberRegionsApi.md#list_available_phone_number_regions) | **GET** /phone-numbers/available/regions |
|
|
135
|
+
*PhoneComClient::OauthApi* | [**create_oauth_access_token**](docs/OauthApi.md#create_oauth_access_token) | **POST** /oauth/access-token | To create an access token via the /oauth/access-token API, an API user may choose any one of the grant types it supports: Authorization Code Grant, Client Credential Grant, Password Credential Grant or Refresh Token Grant.
|
|
136
|
+
*PhoneComClient::OauthApi* | [**create_oauth_authorization**](docs/OauthApi.md#create_oauth_authorization) | **GET** /oauth/authorization | Create Authorization Code or Access Token.
|
|
137
|
+
*PhoneComClient::OauthApi* | [**get_oauth_access_token**](docs/OauthApi.md#get_oauth_access_token) | **GET** /oauth/access-token | Retrieve details of an access token, such as scope, expiration and extension ID.
|
|
138
|
+
*PhoneComClient::OauthClientsApi* | [**delete_account_oauth_client**](docs/OauthClientsApi.md#delete_account_oauth_client) | **DELETE** /accounts/{account_id}/oauth/clients/{client_id} | Delete an individual OAuth client.
|
|
139
|
+
*PhoneComClient::OauthClientsApi* | [**get_account_oauth_client**](docs/OauthClientsApi.md#get_account_oauth_client) | **GET** /accounts/{account_id}/oauth/clients/{client_id} | Show details of an individual OAuth client.
|
|
140
|
+
*PhoneComClient::OauthClientsApi* | [**list_account_oauth_clients**](docs/OauthClientsApi.md#list_account_oauth_clients) | **GET** /accounts/{account_id}/oauth/clients | Get a list of OAuth clients for an account.
|
|
141
|
+
*PhoneComClient::OauthClientsRedirectUrisApi* | [**create_account_oauth_clients_redirect_uri**](docs/OauthClientsRedirectUrisApi.md#create_account_oauth_clients_redirect_uri) | **POST** /accounts/{account_id}/oauth/clients/{client_id}/redirect-uris | Create an OAuth Client Redirect URI record.
|
|
142
|
+
*PhoneComClient::OauthClientsRedirectUrisApi* | [**delete_account_oauth_clients_redirect_uri**](docs/OauthClientsRedirectUrisApi.md#delete_account_oauth_clients_redirect_uri) | **DELETE** /accounts/{account_id}/oauth/clients/{client_id}/redirect-uris/{uri_id} | Delete an OAuth Client Redirect URI record.
|
|
143
|
+
*PhoneComClient::OauthClientsRedirectUrisApi* | [**get_account_oauth_clients_redirect_uri**](docs/OauthClientsRedirectUrisApi.md#get_account_oauth_clients_redirect_uri) | **GET** /accounts/{account_id}/oauth/clients/{client_id}/redirect-uris/{uri_id} | Get details of an OAuth Client Redirect URI record.
|
|
144
|
+
*PhoneComClient::OauthClientsRedirectUrisApi* | [**list_account_oauth_clients_redirect_uris**](docs/OauthClientsRedirectUrisApi.md#list_account_oauth_clients_redirect_uris) | **GET** /accounts/{account_id}/oauth/clients/{client_id}/redirect-uris | Get a list of OAuth Client Redirect URIs for an account.
|
|
145
|
+
*PhoneComClient::PaymentMethodsApi* | [**create_account_payment_method**](docs/PaymentMethodsApi.md#create_account_payment_method) | **POST** /accounts/{account_id}/payment-methods | Create an individual payment method.
|
|
146
|
+
*PhoneComClient::PaymentMethodsApi* | [**delete_account_payment_method**](docs/PaymentMethodsApi.md#delete_account_payment_method) | **DELETE** /accounts/{account_id}/payment-methods/{pm_id} | Delete an individual payment method.
|
|
147
|
+
*PhoneComClient::PaymentMethodsApi* | [**get_account_payment_method**](docs/PaymentMethodsApi.md#get_account_payment_method) | **GET** /accounts/{account_id}/payment-methods/{pm_id} | Show details of an individual payment method.
|
|
148
|
+
*PhoneComClient::PaymentMethodsApi* | [**list_account_payment_methods**](docs/PaymentMethodsApi.md#list_account_payment_methods) | **GET** /accounts/{account_id}/payment-methods | Get a list of payment methods for an account.
|
|
149
|
+
*PhoneComClient::PaymentMethodsApi* | [**patch_account_payment_method**](docs/PaymentMethodsApi.md#patch_account_payment_method) | **PATCH** /accounts/{account_id}/payment-methods/{pm_id} | Replace the status of an individual payment method.
|
|
150
|
+
*PhoneComClient::PhoneNumbersApi* | [**create_account_phone_number**](docs/PhoneNumbersApi.md#create_account_phone_number) | **POST** /accounts/{account_id}/phone-numbers | Add a phone number to an account.
|
|
151
|
+
*PhoneComClient::PhoneNumbersApi* | [**get_account_phone_number**](docs/PhoneNumbersApi.md#get_account_phone_number) | **GET** /accounts/{account_id}/phone-numbers/{number_id} | Show details of an individual phone number.
|
|
152
|
+
*PhoneComClient::PhoneNumbersApi* | [**list_account_phone_numbers**](docs/PhoneNumbersApi.md#list_account_phone_numbers) | **GET** /accounts/{account_id}/phone-numbers | Get a list of phone numbers registered to an account.
|
|
153
|
+
*PhoneComClient::PhoneNumbersApi* | [**replace_account_phone_number**](docs/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.
|
|
154
|
+
*PhoneComClient::QueuesApi* | [**create_account_queue**](docs/QueuesApi.md#create_account_queue) | **POST** /accounts/{account_id}/queues | Create a queue.
|
|
155
|
+
*PhoneComClient::QueuesApi* | [**delete_account_queue**](docs/QueuesApi.md#delete_account_queue) | **DELETE** /accounts/{account_id}/queues/{queue_id} | Delete a queue.
|
|
156
|
+
*PhoneComClient::QueuesApi* | [**get_account_queue**](docs/QueuesApi.md#get_account_queue) | **GET** /accounts/{account_id}/queues/{queue_id} | Show details of an individual queue.
|
|
157
|
+
*PhoneComClient::QueuesApi* | [**list_account_queues**](docs/QueuesApi.md#list_account_queues) | **GET** /accounts/{account_id}/queues | Get a list of queues for an account.
|
|
158
|
+
*PhoneComClient::QueuesApi* | [**replace_account_queue**](docs/QueuesApi.md#replace_account_queue) | **PUT** /accounts/{account_id}/queues/{queue_id} | Replace a queue.
|
|
159
|
+
*PhoneComClient::RoutesApi* | [**create_route**](docs/RoutesApi.md#create_route) | **POST** /accounts/{account_id}/routes | Add a new route to the account.
|
|
160
|
+
*PhoneComClient::RoutesApi* | [**delete_account_route**](docs/RoutesApi.md#delete_account_route) | **DELETE** /accounts/{account_id}/routes/{route_id} | Delete a route from the account.
|
|
161
|
+
*PhoneComClient::RoutesApi* | [**get_account_route**](docs/RoutesApi.md#get_account_route) | **GET** /accounts/{account_id}/routes/{route_id} | Show details of an individual route.
|
|
162
|
+
*PhoneComClient::RoutesApi* | [**list_account_routes**](docs/RoutesApi.md#list_account_routes) | **GET** /accounts/{account_id}/routes | Get a list of routes for an account.
|
|
163
|
+
*PhoneComClient::RoutesApi* | [**replace_account_route**](docs/RoutesApi.md#replace_account_route) | **PUT** /accounts/{account_id}/routes/{route_id} | Update the information of a route.
|
|
164
|
+
*PhoneComClient::SchedulesApi* | [**get_account_schedule**](docs/SchedulesApi.md#get_account_schedule) | **GET** /accounts/{account_id}/schedules/{schedule_id} | Show details of an individual schedule
|
|
165
|
+
*PhoneComClient::SchedulesApi* | [**list_account_schedules**](docs/SchedulesApi.md#list_account_schedules) | **GET** /accounts/{account_id}/schedules | Get a list of schedules for an account
|
|
166
|
+
*PhoneComClient::SmsApi* | [**create_account_sms**](docs/SmsApi.md#create_account_sms) | **POST** /accounts/{account_id}/sms | Send a SMS to one or a group of recipients.
|
|
167
|
+
*PhoneComClient::SmsApi* | [**get_account_sms**](docs/SmsApi.md#get_account_sms) | **GET** /accounts/{account_id}/sms/{sms_id} | This service shows the details of an individual SMS.
|
|
168
|
+
*PhoneComClient::SmsApi* | [**list_account_sms**](docs/SmsApi.md#list_account_sms) | **GET** /accounts/{account_id}/sms | Get a list of SMS messages for an account.
|
|
169
|
+
*PhoneComClient::SmsApi* | [**patch_account_sms**](docs/SmsApi.md#patch_account_sms) | **PATCH** /accounts/{account_id}/sms/{sms_id} | Update the is_new parameter in a sms record.
|
|
170
|
+
*PhoneComClient::SubaccountPricingApi* | [**create_account_subaccount_pricing**](docs/SubaccountPricingApi.md#create_account_subaccount_pricing) | **POST** /accounts/{account_id}/subaccounts/{subaccount_id}/pricing | Add a pricing plan to a subaccount.
|
|
171
|
+
*PhoneComClient::SubaccountPricingApi* | [**delete_account_subaccount_pricing**](docs/SubaccountPricingApi.md#delete_account_subaccount_pricing) | **DELETE** /accounts/{account_id}/subaccounts/{subaccount_id}/pricing/{pricing_id} | Delete a pricing plan from a subaccount.
|
|
172
|
+
*PhoneComClient::SubaccountPricingApi* | [**get_account_subaccount_pricing**](docs/SubaccountPricingApi.md#get_account_subaccount_pricing) | **GET** /accounts/{account_id}/subaccounts/{subaccount_id}/pricing/{pricing_id} | Get the details of a pricing plan for a subaccount.
|
|
173
|
+
*PhoneComClient::SubaccountPricingApi* | [**list_account_subaccount_pricing**](docs/SubaccountPricingApi.md#list_account_subaccount_pricing) | **GET** /accounts/{account_id}/subaccounts/{subaccount_id}/pricing | Get a list of pricing plans for a subaccount.
|
|
174
|
+
*PhoneComClient::SubaccountsApi* | [**create_account_subaccount**](docs/SubaccountsApi.md#create_account_subaccount) | **POST** /accounts/{account_id}/subaccounts | Add a subaccount for the authenticated user or client
|
|
175
|
+
*PhoneComClient::SubaccountsApi* | [**list_account_subaccounts**](docs/SubaccountsApi.md#list_account_subaccounts) | **GET** /accounts/{account_id}/subaccounts | Get a list of subaccounts for the authenticated user or client
|
|
176
|
+
*PhoneComClient::TrunksApi* | [**create_account_trunk**](docs/TrunksApi.md#create_account_trunk) | **POST** /accounts/{account_id}/trunks | Add a trunk record with SIP information.
|
|
177
|
+
*PhoneComClient::TrunksApi* | [**delete_account_trunk**](docs/TrunksApi.md#delete_account_trunk) | **DELETE** /accounts/{account_id}/trunks/{trunk_id} | Delete a trunk from account.
|
|
178
|
+
*PhoneComClient::TrunksApi* | [**get_account_trunk**](docs/TrunksApi.md#get_account_trunk) | **GET** /accounts/{account_id}/trunks/{trunk_id} | Show details of an individual trunk.
|
|
179
|
+
*PhoneComClient::TrunksApi* | [**list_account_trunks**](docs/TrunksApi.md#list_account_trunks) | **GET** /accounts/{account_id}/trunks | Get a list of trunks for an account.
|
|
180
|
+
*PhoneComClient::TrunksApi* | [**replace_account_trunk**](docs/TrunksApi.md#replace_account_trunk) | **PUT** /accounts/{account_id}/trunks/{trunk_id} | Replace parameters in a trunk.
|
|
181
|
+
*PhoneComClient::VoicemailApi* | [**get_account_voicemail**](docs/VoicemailApi.md#get_account_voicemail) | **GET** /accounts/{account_id}/voicemail/{voicemail_id} | This service shows the details of an individual voicemail.
|
|
182
|
+
*PhoneComClient::VoicemailApi* | [**list_account_voicemail**](docs/VoicemailApi.md#list_account_voicemail) | **GET** /accounts/{account_id}/voicemail | Get a list of voicemail messages for an account.
|
|
183
|
+
*PhoneComClient::VoicemailApi* | [**patch_account_voicemail**](docs/VoicemailApi.md#patch_account_voicemail) | **PATCH** /accounts/{account_id}/voicemail/{voicemail_id} | Update the is_new parameter in a voicemail record.
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
## Documentation for Models
|
|
187
|
+
|
|
188
|
+
- [PhoneComClient::AccountFull](docs/AccountFull.md)
|
|
189
|
+
- [PhoneComClient::AccountSummary](docs/AccountSummary.md)
|
|
190
|
+
- [PhoneComClient::Address](docs/Address.md)
|
|
191
|
+
- [PhoneComClient::AddressListContacts](docs/AddressListContacts.md)
|
|
192
|
+
- [PhoneComClient::ApplicationFull](docs/ApplicationFull.md)
|
|
193
|
+
- [PhoneComClient::ApplicationSummary](docs/ApplicationSummary.md)
|
|
194
|
+
- [PhoneComClient::AvailableNumbersFull](docs/AvailableNumbersFull.md)
|
|
195
|
+
- [PhoneComClient::CallDetails](docs/CallDetails.md)
|
|
196
|
+
- [PhoneComClient::CallFull](docs/CallFull.md)
|
|
197
|
+
- [PhoneComClient::CallLogFull](docs/CallLogFull.md)
|
|
198
|
+
- [PhoneComClient::CallNotifications](docs/CallNotifications.md)
|
|
199
|
+
- [PhoneComClient::CallbackObject](docs/CallbackObject.md)
|
|
200
|
+
- [PhoneComClient::CallerIdFull](docs/CallerIdFull.md)
|
|
201
|
+
- [PhoneComClient::CallerIdPhoneNumber](docs/CallerIdPhoneNumber.md)
|
|
202
|
+
- [PhoneComClient::ContactAccount](docs/ContactAccount.md)
|
|
203
|
+
- [PhoneComClient::ContactFull](docs/ContactFull.md)
|
|
204
|
+
- [PhoneComClient::ContactResponse](docs/ContactResponse.md)
|
|
205
|
+
- [PhoneComClient::ContactSummary](docs/ContactSummary.md)
|
|
206
|
+
- [PhoneComClient::CreateCallParams](docs/CreateCallParams.md)
|
|
207
|
+
- [PhoneComClient::CreateContactParams](docs/CreateContactParams.md)
|
|
208
|
+
- [PhoneComClient::CreateDeviceParams](docs/CreateDeviceParams.md)
|
|
209
|
+
- [PhoneComClient::CreateExtensionParams](docs/CreateExtensionParams.md)
|
|
210
|
+
- [PhoneComClient::CreateGroupParams](docs/CreateGroupParams.md)
|
|
211
|
+
- [PhoneComClient::CreateListenerParams](docs/CreateListenerParams.md)
|
|
212
|
+
- [PhoneComClient::CreateMediaParams](docs/CreateMediaParams.md)
|
|
213
|
+
- [PhoneComClient::CreateMenuParams](docs/CreateMenuParams.md)
|
|
214
|
+
- [PhoneComClient::CreateOauthParams](docs/CreateOauthParams.md)
|
|
215
|
+
- [PhoneComClient::CreatePaymentParams](docs/CreatePaymentParams.md)
|
|
216
|
+
- [PhoneComClient::CreatePhoneNumberParams](docs/CreatePhoneNumberParams.md)
|
|
217
|
+
- [PhoneComClient::CreatePricingParams](docs/CreatePricingParams.md)
|
|
218
|
+
- [PhoneComClient::CreateQueueParams](docs/CreateQueueParams.md)
|
|
219
|
+
- [PhoneComClient::CreateRedirectUriParams](docs/CreateRedirectUriParams.md)
|
|
220
|
+
- [PhoneComClient::CreateRouteParams](docs/CreateRouteParams.md)
|
|
221
|
+
- [PhoneComClient::CreateSmsParams](docs/CreateSmsParams.md)
|
|
222
|
+
- [PhoneComClient::CreateSubaccountParams](docs/CreateSubaccountParams.md)
|
|
223
|
+
- [PhoneComClient::CreateTrunkParams](docs/CreateTrunkParams.md)
|
|
224
|
+
- [PhoneComClient::DeleteEntry](docs/DeleteEntry.md)
|
|
225
|
+
- [PhoneComClient::DeviceFull](docs/DeviceFull.md)
|
|
226
|
+
- [PhoneComClient::DeviceMembership](docs/DeviceMembership.md)
|
|
227
|
+
- [PhoneComClient::DeviceSummary](docs/DeviceSummary.md)
|
|
228
|
+
- [PhoneComClient::Email](docs/Email.md)
|
|
229
|
+
- [PhoneComClient::ExpressServiceCodeFull](docs/ExpressServiceCodeFull.md)
|
|
230
|
+
- [PhoneComClient::ExtensionFull](docs/ExtensionFull.md)
|
|
231
|
+
- [PhoneComClient::ExtensionSummary](docs/ExtensionSummary.md)
|
|
232
|
+
- [PhoneComClient::FilterCallLogs](docs/FilterCallLogs.md)
|
|
233
|
+
- [PhoneComClient::FilterIdArray](docs/FilterIdArray.md)
|
|
234
|
+
- [PhoneComClient::FilterIdDirectionFrom](docs/FilterIdDirectionFrom.md)
|
|
235
|
+
- [PhoneComClient::FilterIdExtensionNameArray](docs/FilterIdExtensionNameArray.md)
|
|
236
|
+
- [PhoneComClient::FilterIdGroupIdUpdatedAtArray](docs/FilterIdGroupIdUpdatedAtArray.md)
|
|
237
|
+
- [PhoneComClient::FilterIdNameArray](docs/FilterIdNameArray.md)
|
|
238
|
+
- [PhoneComClient::FilterIdNamePhoneNumberArray](docs/FilterIdNamePhoneNumberArray.md)
|
|
239
|
+
- [PhoneComClient::FilterListAvailableNumbers](docs/FilterListAvailableNumbers.md)
|
|
240
|
+
- [PhoneComClient::FilterListPhoneNumbersRegions](docs/FilterListPhoneNumbersRegions.md)
|
|
241
|
+
- [PhoneComClient::FilterNameNumberArray](docs/FilterNameNumberArray.md)
|
|
242
|
+
- [PhoneComClient::FilterVoicemailArray](docs/FilterVoicemailArray.md)
|
|
243
|
+
- [PhoneComClient::FromObject](docs/FromObject.md)
|
|
244
|
+
- [PhoneComClient::GetOauthAccessToken](docs/GetOauthAccessToken.md)
|
|
245
|
+
- [PhoneComClient::Greeting](docs/Greeting.md)
|
|
246
|
+
- [PhoneComClient::GreetingInput](docs/GreetingInput.md)
|
|
247
|
+
- [PhoneComClient::GroupFull](docs/GroupFull.md)
|
|
248
|
+
- [PhoneComClient::GroupListContacts](docs/GroupListContacts.md)
|
|
249
|
+
- [PhoneComClient::GroupSummary](docs/GroupSummary.md)
|
|
250
|
+
- [PhoneComClient::HoldMusic](docs/HoldMusic.md)
|
|
251
|
+
- [PhoneComClient::Line](docs/Line.md)
|
|
252
|
+
- [PhoneComClient::ListAccounts](docs/ListAccounts.md)
|
|
253
|
+
- [PhoneComClient::ListApplications](docs/ListApplications.md)
|
|
254
|
+
- [PhoneComClient::ListAvailableNumbers](docs/ListAvailableNumbers.md)
|
|
255
|
+
- [PhoneComClient::ListCallLogs](docs/ListCallLogs.md)
|
|
256
|
+
- [PhoneComClient::ListCallerIds](docs/ListCallerIds.md)
|
|
257
|
+
- [PhoneComClient::ListContacts](docs/ListContacts.md)
|
|
258
|
+
- [PhoneComClient::ListDevices](docs/ListDevices.md)
|
|
259
|
+
- [PhoneComClient::ListExpressServiceCodes](docs/ListExpressServiceCodes.md)
|
|
260
|
+
- [PhoneComClient::ListExtensions](docs/ListExtensions.md)
|
|
261
|
+
- [PhoneComClient::ListGroups](docs/ListGroups.md)
|
|
262
|
+
- [PhoneComClient::ListListeners](docs/ListListeners.md)
|
|
263
|
+
- [PhoneComClient::ListMedia](docs/ListMedia.md)
|
|
264
|
+
- [PhoneComClient::ListMenus](docs/ListMenus.md)
|
|
265
|
+
- [PhoneComClient::ListOauthClients](docs/ListOauthClients.md)
|
|
266
|
+
- [PhoneComClient::ListOauthClientsRedirectUris](docs/ListOauthClientsRedirectUris.md)
|
|
267
|
+
- [PhoneComClient::ListPaymentMethods](docs/ListPaymentMethods.md)
|
|
268
|
+
- [PhoneComClient::ListPhoneNumbers](docs/ListPhoneNumbers.md)
|
|
269
|
+
- [PhoneComClient::ListPhoneNumbersRegions](docs/ListPhoneNumbersRegions.md)
|
|
270
|
+
- [PhoneComClient::ListPricings](docs/ListPricings.md)
|
|
271
|
+
- [PhoneComClient::ListQueues](docs/ListQueues.md)
|
|
272
|
+
- [PhoneComClient::ListRoutes](docs/ListRoutes.md)
|
|
273
|
+
- [PhoneComClient::ListSchedules](docs/ListSchedules.md)
|
|
274
|
+
- [PhoneComClient::ListSms](docs/ListSms.md)
|
|
275
|
+
- [PhoneComClient::ListTrunks](docs/ListTrunks.md)
|
|
276
|
+
- [PhoneComClient::ListVoicemail](docs/ListVoicemail.md)
|
|
277
|
+
- [PhoneComClient::ListenerFull](docs/ListenerFull.md)
|
|
278
|
+
- [PhoneComClient::MediaFull](docs/MediaFull.md)
|
|
279
|
+
- [PhoneComClient::MediaSummary](docs/MediaSummary.md)
|
|
280
|
+
- [PhoneComClient::Member](docs/Member.md)
|
|
281
|
+
- [PhoneComClient::MenuFull](docs/MenuFull.md)
|
|
282
|
+
- [PhoneComClient::MenuSummary](docs/MenuSummary.md)
|
|
283
|
+
- [PhoneComClient::Notification](docs/Notification.md)
|
|
284
|
+
- [PhoneComClient::OauthAccessToken](docs/OauthAccessToken.md)
|
|
285
|
+
- [PhoneComClient::OauthClientFull](docs/OauthClientFull.md)
|
|
286
|
+
- [PhoneComClient::OauthClientRedirectUriFull](docs/OauthClientRedirectUriFull.md)
|
|
287
|
+
- [PhoneComClient::Option](docs/Option.md)
|
|
288
|
+
- [PhoneComClient::PatchPaymentParams](docs/PatchPaymentParams.md)
|
|
289
|
+
- [PhoneComClient::PatchSmsParams](docs/PatchSmsParams.md)
|
|
290
|
+
- [PhoneComClient::PatchVoicemailParams](docs/PatchVoicemailParams.md)
|
|
291
|
+
- [PhoneComClient::PaymentFull](docs/PaymentFull.md)
|
|
292
|
+
- [PhoneComClient::PaymentSummary](docs/PaymentSummary.md)
|
|
293
|
+
- [PhoneComClient::PhoneNumberContact](docs/PhoneNumberContact.md)
|
|
294
|
+
- [PhoneComClient::PhoneNumberFull](docs/PhoneNumberFull.md)
|
|
295
|
+
- [PhoneComClient::PhoneNumbersRegionFull](docs/PhoneNumbersRegionFull.md)
|
|
296
|
+
- [PhoneComClient::PingResponse](docs/PingResponse.md)
|
|
297
|
+
- [PhoneComClient::PricingFull](docs/PricingFull.md)
|
|
298
|
+
- [PhoneComClient::PricingObject](docs/PricingObject.md)
|
|
299
|
+
- [PhoneComClient::QueueFull](docs/QueueFull.md)
|
|
300
|
+
- [PhoneComClient::QueueSummary](docs/QueueSummary.md)
|
|
301
|
+
- [PhoneComClient::Recipient](docs/Recipient.md)
|
|
302
|
+
- [PhoneComClient::RedirectUriFull](docs/RedirectUriFull.md)
|
|
303
|
+
- [PhoneComClient::ReplaceExtensionParams](docs/ReplaceExtensionParams.md)
|
|
304
|
+
- [PhoneComClient::ReplaceMenuParams](docs/ReplaceMenuParams.md)
|
|
305
|
+
- [PhoneComClient::ReplacePhoneNumberParams](docs/ReplacePhoneNumberParams.md)
|
|
306
|
+
- [PhoneComClient::RouteFull](docs/RouteFull.md)
|
|
307
|
+
- [PhoneComClient::RouteSummary](docs/RouteSummary.md)
|
|
308
|
+
- [PhoneComClient::RuleSet](docs/RuleSet.md)
|
|
309
|
+
- [PhoneComClient::RuleSetAction](docs/RuleSetAction.md)
|
|
310
|
+
- [PhoneComClient::RuleSetFilter](docs/RuleSetFilter.md)
|
|
311
|
+
- [PhoneComClient::RuleSetForwardItem](docs/RuleSetForwardItem.md)
|
|
312
|
+
- [PhoneComClient::ScheduleFull](docs/ScheduleFull.md)
|
|
313
|
+
- [PhoneComClient::ScheduleSummary](docs/ScheduleSummary.md)
|
|
314
|
+
- [PhoneComClient::ScopeDetails](docs/ScopeDetails.md)
|
|
315
|
+
- [PhoneComClient::SipAuthentication](docs/SipAuthentication.md)
|
|
316
|
+
- [PhoneComClient::SmsForwarding](docs/SmsForwarding.md)
|
|
317
|
+
- [PhoneComClient::SmsForwardingParams](docs/SmsForwardingParams.md)
|
|
318
|
+
- [PhoneComClient::SmsFull](docs/SmsFull.md)
|
|
319
|
+
- [PhoneComClient::SortCallLogs](docs/SortCallLogs.md)
|
|
320
|
+
- [PhoneComClient::SortId](docs/SortId.md)
|
|
321
|
+
- [PhoneComClient::SortIdCreatedAt](docs/SortIdCreatedAt.md)
|
|
322
|
+
- [PhoneComClient::SortIdExtensionName](docs/SortIdExtensionName.md)
|
|
323
|
+
- [PhoneComClient::SortIdName](docs/SortIdName.md)
|
|
324
|
+
- [PhoneComClient::SortIdNamePhoneNumber](docs/SortIdNamePhoneNumber.md)
|
|
325
|
+
- [PhoneComClient::SortIdUpdatedAt](docs/SortIdUpdatedAt.md)
|
|
326
|
+
- [PhoneComClient::SortListAvailableNumbers](docs/SortListAvailableNumbers.md)
|
|
327
|
+
- [PhoneComClient::SortListPhoneNumbersRegions](docs/SortListPhoneNumbersRegions.md)
|
|
328
|
+
- [PhoneComClient::SortNameNumber](docs/SortNameNumber.md)
|
|
329
|
+
- [PhoneComClient::TrunkFull](docs/TrunkFull.md)
|
|
330
|
+
- [PhoneComClient::TrunkSummary](docs/TrunkSummary.md)
|
|
331
|
+
- [PhoneComClient::Voicemail](docs/Voicemail.md)
|
|
332
|
+
- [PhoneComClient::VoicemailFull](docs/VoicemailFull.md)
|
|
333
|
+
- [PhoneComClient::VoicemailInput](docs/VoicemailInput.md)
|
|
334
|
+
|
|
335
|
+
|
|
336
|
+
## Documentation for Authorization
|
|
337
|
+
|
|
338
|
+
|
|
339
|
+
### apiKey
|
|
340
|
+
|
|
341
|
+
- **Type**: API key
|
|
342
|
+
- **API key parameter name**: Authorization
|
|
343
|
+
- **Location**: HTTP header
|
|
344
|
+
|
data/Rakefile
ADDED
data/docs/AccountFull.md
ADDED
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# PhoneComClient::AccountFull
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**id** | **Integer** | Account ID. Sometimes referred to as \"Voip ID\" or \"voip_id\". | [optional]
|
|
7
|
+
**name** | **String** | Name on the account. Read-only. | [optional]
|
|
8
|
+
**username** | **String** | Account user name | [optional]
|
|
9
|
+
**password** | **String** | Account password. For security reason, this is masked as \"**\" | [optional]
|
|
10
|
+
**master_account** | [**AccountSummary**](AccountSummary.md) | If this account is a subaccount, this property shows the master account that it belongs to. Otherwise it is NULL. Read-only. Output is an Account Summary Object. | [optional]
|
|
11
|
+
**contact** | [**ContactAccount**](ContactAccount.md) | Contact Object. See below for details. | [optional]
|
|
12
|
+
**billing_contact** | [**ContactAccount**](ContactAccount.md) | Contact Object for billing purposes. See below for details. | [optional]
|
|
13
|
+
|
|
14
|
+
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# PhoneComClient::AccountSummary
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**id** | **Integer** | Account ID. Sometimes referred to as \"Voip ID\" or \"voip_id\". | [optional]
|
|
7
|
+
**name** | **String** | Name on the account. Read-only. | [optional]
|
|
8
|
+
|
|
9
|
+
|
data/docs/AccountsApi.md
ADDED
|
@@ -0,0 +1,127 @@
|
|
|
1
|
+
# PhoneComClient::AccountsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.phone.com/v4*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**get_account**](AccountsApi.md#get_account) | **GET** /accounts/{account_id} | Retrieve details of an individual account
|
|
8
|
+
[**list_accounts**](AccountsApi.md#list_accounts) | **GET** /accounts | Get a list of accounts visible to the authenticated user or client.
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
# **get_account**
|
|
12
|
+
> AccountFull get_account(account_id, )
|
|
13
|
+
|
|
14
|
+
Retrieve details of an individual account
|
|
15
|
+
|
|
16
|
+
Retrieve details of an individual account. See Accounts for more info on the properties.
|
|
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::AccountsApi.new
|
|
31
|
+
|
|
32
|
+
account_id = 56 # Integer | Account ID
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
begin
|
|
36
|
+
#Retrieve details of an individual account
|
|
37
|
+
result = api_instance.get_account(account_id, )
|
|
38
|
+
p result
|
|
39
|
+
rescue PhoneComClient::ApiError => e
|
|
40
|
+
puts "Exception when calling AccountsApi->get_account: #{e}"
|
|
41
|
+
end
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
### Parameters
|
|
45
|
+
|
|
46
|
+
Name | Type | Description | Notes
|
|
47
|
+
------------- | ------------- | ------------- | -------------
|
|
48
|
+
**account_id** | **Integer**| Account ID |
|
|
49
|
+
|
|
50
|
+
### Return type
|
|
51
|
+
|
|
52
|
+
[**AccountFull**](AccountFull.md)
|
|
53
|
+
|
|
54
|
+
### Authorization
|
|
55
|
+
|
|
56
|
+
[apiKey](../README.md#apiKey)
|
|
57
|
+
|
|
58
|
+
### HTTP request headers
|
|
59
|
+
|
|
60
|
+
- **Content-Type**: application/json
|
|
61
|
+
- **Accept**: application/json
|
|
62
|
+
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
# **list_accounts**
|
|
66
|
+
> ListAccounts list_accounts(opts)
|
|
67
|
+
|
|
68
|
+
Get a list of accounts visible to the authenticated user or client.
|
|
69
|
+
|
|
70
|
+
Get a list of accounts visible to the authenticated user or client. In most cases, there will only be one such account. See Accounts for more info on the properties.
|
|
71
|
+
|
|
72
|
+
### Example
|
|
73
|
+
```ruby
|
|
74
|
+
# load the gem
|
|
75
|
+
require 'phone_com_client'
|
|
76
|
+
# setup authorization
|
|
77
|
+
PhoneComClient.configure do |config|
|
|
78
|
+
# Configure API key authorization: apiKey
|
|
79
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
80
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
81
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
82
|
+
end
|
|
83
|
+
|
|
84
|
+
api_instance = PhoneComClient::AccountsApi.new
|
|
85
|
+
|
|
86
|
+
opts = {
|
|
87
|
+
filters_id: ['filters_id_example'], # Array<String> | ID filter
|
|
88
|
+
sort_id: 'sort_id_example', # String | ID sorting
|
|
89
|
+
limit: 56, # Integer | Max results
|
|
90
|
+
offset: 56, # Integer | Results to skip
|
|
91
|
+
fields: 'fields_example', # String | Field set
|
|
92
|
+
}
|
|
93
|
+
|
|
94
|
+
begin
|
|
95
|
+
#Get a list of accounts visible to the authenticated user or client.
|
|
96
|
+
result = api_instance.list_accounts(opts)
|
|
97
|
+
p result
|
|
98
|
+
rescue PhoneComClient::ApiError => e
|
|
99
|
+
puts "Exception when calling AccountsApi->list_accounts: #{e}"
|
|
100
|
+
end
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
### Parameters
|
|
104
|
+
|
|
105
|
+
Name | Type | Description | Notes
|
|
106
|
+
------------- | ------------- | ------------- | -------------
|
|
107
|
+
**filters_id** | [**Array<String>**](String.md)| ID filter | [optional]
|
|
108
|
+
**sort_id** | **String**| ID sorting | [optional]
|
|
109
|
+
**limit** | **Integer**| Max results | [optional]
|
|
110
|
+
**offset** | **Integer**| Results to skip | [optional]
|
|
111
|
+
**fields** | **String**| Field set | [optional]
|
|
112
|
+
|
|
113
|
+
### Return type
|
|
114
|
+
|
|
115
|
+
[**ListAccounts**](ListAccounts.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
|
+
|
data/docs/Address.md
ADDED
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# PhoneComClient::Address
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**line_1** | **String** | Street address line 1. Required. |
|
|
7
|
+
**line_2** | **String** | Street address line 2 | [optional]
|
|
8
|
+
**city** | **String** | City. Required. |
|
|
9
|
+
**province** | **String** | Province. Required if country is US | [optional]
|
|
10
|
+
**postal_code** | **String** | Postal code | [optional]
|
|
11
|
+
**country** | **String** | 2-character country code. Required. |
|
|
12
|
+
|
|
13
|
+
|