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
data/docs/CallsApi.md
ADDED
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
# PhoneComClient::CallsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.phone.com/v4*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**create_account_call**](CallsApi.md#create_account_call) | **POST** /accounts/{account_id}/calls | Make a phone call
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
# **create_account_call**
|
|
11
|
+
> CallFull create_account_call(account_id, , opts)
|
|
12
|
+
|
|
13
|
+
Make a phone call
|
|
14
|
+
|
|
15
|
+
Make a phone call. See Calls for more details and how to setup caller id's. Note: This API is for users with Account Owner scope access token. Users with Extension User scope token should invoke the Calls API with the following definition: POST https://api.phone.com/v4/accounts/:account_id/extensions/:extension_id/calls
|
|
16
|
+
|
|
17
|
+
### Example
|
|
18
|
+
```ruby
|
|
19
|
+
# load the gem
|
|
20
|
+
require 'phone_com_client'
|
|
21
|
+
# setup authorization
|
|
22
|
+
PhoneComClient.configure do |config|
|
|
23
|
+
# Configure API key authorization: apiKey
|
|
24
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
25
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
26
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
27
|
+
end
|
|
28
|
+
|
|
29
|
+
api_instance = PhoneComClient::CallsApi.new
|
|
30
|
+
|
|
31
|
+
account_id = 56 # Integer | Account ID
|
|
32
|
+
|
|
33
|
+
opts = {
|
|
34
|
+
data: PhoneComClient::CreateCallParams.new # CreateCallParams | Call data
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
begin
|
|
38
|
+
#Make a phone call
|
|
39
|
+
result = api_instance.create_account_call(account_id, , opts)
|
|
40
|
+
p result
|
|
41
|
+
rescue PhoneComClient::ApiError => e
|
|
42
|
+
puts "Exception when calling CallsApi->create_account_call: #{e}"
|
|
43
|
+
end
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
### Parameters
|
|
47
|
+
|
|
48
|
+
Name | Type | Description | Notes
|
|
49
|
+
------------- | ------------- | ------------- | -------------
|
|
50
|
+
**account_id** | **Integer**| Account ID |
|
|
51
|
+
**data** | [**CreateCallParams**](CreateCallParams.md)| Call data | [optional]
|
|
52
|
+
|
|
53
|
+
### Return type
|
|
54
|
+
|
|
55
|
+
[**CallFull**](CallFull.md)
|
|
56
|
+
|
|
57
|
+
### Authorization
|
|
58
|
+
|
|
59
|
+
[apiKey](../README.md#apiKey)
|
|
60
|
+
|
|
61
|
+
### HTTP request headers
|
|
62
|
+
|
|
63
|
+
- **Content-Type**: application/json
|
|
64
|
+
- **Accept**: application/json
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# PhoneComClient::ContactAccount
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**name** | **String** | Name. Required. | [optional]
|
|
7
|
+
**company** | **String** | Company name | [optional]
|
|
8
|
+
**address** | [**Address**](Address.md) | | [optional]
|
|
9
|
+
**phone** | **String** | Phone number. Required. | [optional]
|
|
10
|
+
**fax** | **String** | Fax number | [optional]
|
|
11
|
+
**primary_email** | **String** | Primary email address. Required. | [optional]
|
|
12
|
+
**alternate_email** | **String** | Alternate email address | [optional]
|
|
13
|
+
|
|
14
|
+
|
data/docs/ContactFull.md
ADDED
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# PhoneComClient::ContactFull
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**id** | **Integer** | Integer ID. Read-only. | [optional]
|
|
7
|
+
**prefix** | **String** | Salutation, such as Mr, Mrs, or Dr | [optional]
|
|
8
|
+
**first_name** | **String** | First name or given name | [optional]
|
|
9
|
+
**middle_name** | **String** | Middle or second name | [optional]
|
|
10
|
+
**last_name** | **String** | Last name or surname | [optional]
|
|
11
|
+
**suffix** | **String** | Suffix, such as \"Jr.\", \"Sr.\", \"II\", or \"III\" | [optional]
|
|
12
|
+
**nickname** | **String** | Nickname, or a shortened informal version of the contact's name | [optional]
|
|
13
|
+
**company** | **String** | Name of the contact's company | [optional]
|
|
14
|
+
**phonetic_first_name** | **String** | Phonetic first name. Useful for remembering how to pronounce the contact's name. | [optional]
|
|
15
|
+
**phonetic_middle_name** | **String** | Phonetic middle name. Useful for remembering how to pronounce the contact's name. | [optional]
|
|
16
|
+
**phonetic_last_name** | **String** | Phonetic last name. Useful for remembering how to pronounce the contact's name. | [optional]
|
|
17
|
+
**department** | **String** | Name of the contact's department | [optional]
|
|
18
|
+
**job_title** | **String** | Contact's job title | [optional]
|
|
19
|
+
**emails** | [**Array<Email>**](Email.md) | Array of Contact Email Objects. See below for details. | [optional]
|
|
20
|
+
**phone_numbers** | [**Array<PhoneNumberContact>**](PhoneNumberContact.md) | Array of Contact Phone Number Objects. See below for details. | [optional]
|
|
21
|
+
**addresses** | [**Array<AddressListContacts>**](AddressListContacts.md) | Array of Contact Address Objects. See below for details. | [optional]
|
|
22
|
+
**group** | [**GroupListContacts**](GroupListContacts.md) | | [optional]
|
|
23
|
+
**created_at** | **Integer** | Integer UNIX timestamp when the contact was created. Read-only. | [optional]
|
|
24
|
+
**updated_at** | **Integer** | Integer UNIX timestamp when the contact was created. Read-only. | [optional]
|
|
25
|
+
|
|
26
|
+
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# PhoneComClient::ContactResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**name** | **String** | Contact name | [optional]
|
|
7
|
+
**address** | [**Address**](Address.md) | | [optional]
|
|
8
|
+
**primary_email** | **String** | Primary email address. Required. | [optional]
|
|
9
|
+
**alternate_email** | **String** | Alternate email address | [optional]
|
|
10
|
+
**company** | **String** | Company name | [optional]
|
|
11
|
+
**phone** | **String** | Phone number. Required. | [optional]
|
|
12
|
+
**fax** | **String** | Fax number | [optional]
|
|
13
|
+
|
|
14
|
+
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# PhoneComClient::ContactSummary
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**id** | **Integer** | Integer ID. Read-only. | [optional]
|
|
7
|
+
**prefix** | **String** | Salutation, such as Mr, Mrs, or Dr | [optional]
|
|
8
|
+
**first_name** | **String** | First name or given name | [optional]
|
|
9
|
+
**middle_name** | **String** | Middle or second name | [optional]
|
|
10
|
+
**last_name** | **String** | Last name or surname | [optional]
|
|
11
|
+
**suffix** | **String** | Suffix, such as 'Jr.', 'Sr.', 'II', or 'III' | [optional]
|
|
12
|
+
**nickname** | **String** | Nickname, or a shortened informal version of the contact's name | [optional]
|
|
13
|
+
**company** | **String** | Name of the contact's company | [optional]
|
|
14
|
+
|
|
15
|
+
|
data/docs/ContactsApi.md
ADDED
|
@@ -0,0 +1,333 @@
|
|
|
1
|
+
# PhoneComClient::ContactsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.phone.com/v4*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**create_account_extension_contact**](ContactsApi.md#create_account_extension_contact) | **POST** /accounts/{account_id}/extensions/{extension_id}/contacts | Add a new address book contact for an extension.
|
|
8
|
+
[**delete_account_extension_contact**](ContactsApi.md#delete_account_extension_contact) | **DELETE** /accounts/{account_id}/extensions/{extension_id}/contacts/{contact_id} | Delete a contact from the address book.
|
|
9
|
+
[**get_account_extension_contact**](ContactsApi.md#get_account_extension_contact) | **GET** /accounts/{account_id}/extensions/{extension_id}/contacts/{contact_id} | Retrieve the details of an address book contact.
|
|
10
|
+
[**list_account_extension_contacts**](ContactsApi.md#list_account_extension_contacts) | **GET** /accounts/{account_id}/extensions/{extension_id}/contacts | Show the Caller ID options a given extension can use.
|
|
11
|
+
[**replace_account_extension_contact**](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.
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
# **create_account_extension_contact**
|
|
15
|
+
> ContactFull create_account_extension_contact(account_id, extension_id, , opts)
|
|
16
|
+
|
|
17
|
+
Add a new address book contact for an extension.
|
|
18
|
+
|
|
19
|
+
Add a new address book contact for an extension. See Account Contacts for more info on the fields in each item.
|
|
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::ContactsApi.new
|
|
34
|
+
|
|
35
|
+
account_id = 56 # Integer | Account ID
|
|
36
|
+
|
|
37
|
+
extension_id = 56 # Integer | Extension ID
|
|
38
|
+
|
|
39
|
+
opts = {
|
|
40
|
+
data: PhoneComClient::CreateContactParams.new # CreateContactParams | Contact data
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
begin
|
|
44
|
+
#Add a new address book contact for an extension.
|
|
45
|
+
result = api_instance.create_account_extension_contact(account_id, extension_id, , opts)
|
|
46
|
+
p result
|
|
47
|
+
rescue PhoneComClient::ApiError => e
|
|
48
|
+
puts "Exception when calling ContactsApi->create_account_extension_contact: #{e}"
|
|
49
|
+
end
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
### Parameters
|
|
53
|
+
|
|
54
|
+
Name | Type | Description | Notes
|
|
55
|
+
------------- | ------------- | ------------- | -------------
|
|
56
|
+
**account_id** | **Integer**| Account ID |
|
|
57
|
+
**extension_id** | **Integer**| Extension ID |
|
|
58
|
+
**data** | [**CreateContactParams**](CreateContactParams.md)| Contact data | [optional]
|
|
59
|
+
|
|
60
|
+
### Return type
|
|
61
|
+
|
|
62
|
+
[**ContactFull**](ContactFull.md)
|
|
63
|
+
|
|
64
|
+
### Authorization
|
|
65
|
+
|
|
66
|
+
[apiKey](../README.md#apiKey)
|
|
67
|
+
|
|
68
|
+
### HTTP request headers
|
|
69
|
+
|
|
70
|
+
- **Content-Type**: application/json
|
|
71
|
+
- **Accept**: application/json
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
# **delete_account_extension_contact**
|
|
76
|
+
> DeleteEntry delete_account_extension_contact(account_id, extension_id, contact_id)
|
|
77
|
+
|
|
78
|
+
Delete a contact from the address book.
|
|
79
|
+
|
|
80
|
+
Delete a contact from the address book. See Account Contacts for more info on the fields in each item.
|
|
81
|
+
|
|
82
|
+
### Example
|
|
83
|
+
```ruby
|
|
84
|
+
# load the gem
|
|
85
|
+
require 'phone_com_client'
|
|
86
|
+
# setup authorization
|
|
87
|
+
PhoneComClient.configure do |config|
|
|
88
|
+
# Configure API key authorization: apiKey
|
|
89
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
90
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
91
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
92
|
+
end
|
|
93
|
+
|
|
94
|
+
api_instance = PhoneComClient::ContactsApi.new
|
|
95
|
+
|
|
96
|
+
account_id = 56 # Integer | Account ID
|
|
97
|
+
|
|
98
|
+
extension_id = 56 # Integer | Extension ID
|
|
99
|
+
|
|
100
|
+
contact_id = 56 # Integer | Contact ID
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
begin
|
|
104
|
+
#Delete a contact from the address book.
|
|
105
|
+
result = api_instance.delete_account_extension_contact(account_id, extension_id, contact_id)
|
|
106
|
+
p result
|
|
107
|
+
rescue PhoneComClient::ApiError => e
|
|
108
|
+
puts "Exception when calling ContactsApi->delete_account_extension_contact: #{e}"
|
|
109
|
+
end
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
### Parameters
|
|
113
|
+
|
|
114
|
+
Name | Type | Description | Notes
|
|
115
|
+
------------- | ------------- | ------------- | -------------
|
|
116
|
+
**account_id** | **Integer**| Account ID |
|
|
117
|
+
**extension_id** | **Integer**| Extension ID |
|
|
118
|
+
**contact_id** | **Integer**| Contact ID |
|
|
119
|
+
|
|
120
|
+
### Return type
|
|
121
|
+
|
|
122
|
+
[**DeleteEntry**](DeleteEntry.md)
|
|
123
|
+
|
|
124
|
+
### Authorization
|
|
125
|
+
|
|
126
|
+
[apiKey](../README.md#apiKey)
|
|
127
|
+
|
|
128
|
+
### HTTP request headers
|
|
129
|
+
|
|
130
|
+
- **Content-Type**: application/json
|
|
131
|
+
- **Accept**: application/json
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
# **get_account_extension_contact**
|
|
136
|
+
> ContactFull get_account_extension_contact(account_id, extension_id, contact_id)
|
|
137
|
+
|
|
138
|
+
Retrieve the details of an address book contact.
|
|
139
|
+
|
|
140
|
+
Retrieve the details of an address book contact. See Account Contacts for more info on the fields in each item.
|
|
141
|
+
|
|
142
|
+
### Example
|
|
143
|
+
```ruby
|
|
144
|
+
# load the gem
|
|
145
|
+
require 'phone_com_client'
|
|
146
|
+
# setup authorization
|
|
147
|
+
PhoneComClient.configure do |config|
|
|
148
|
+
# Configure API key authorization: apiKey
|
|
149
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
150
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
151
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
152
|
+
end
|
|
153
|
+
|
|
154
|
+
api_instance = PhoneComClient::ContactsApi.new
|
|
155
|
+
|
|
156
|
+
account_id = 56 # Integer | Account ID
|
|
157
|
+
|
|
158
|
+
extension_id = 56 # Integer | Extension ID
|
|
159
|
+
|
|
160
|
+
contact_id = 56 # Integer | Contact ID
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
begin
|
|
164
|
+
#Retrieve the details of an address book contact.
|
|
165
|
+
result = api_instance.get_account_extension_contact(account_id, extension_id, contact_id)
|
|
166
|
+
p result
|
|
167
|
+
rescue PhoneComClient::ApiError => e
|
|
168
|
+
puts "Exception when calling ContactsApi->get_account_extension_contact: #{e}"
|
|
169
|
+
end
|
|
170
|
+
```
|
|
171
|
+
|
|
172
|
+
### Parameters
|
|
173
|
+
|
|
174
|
+
Name | Type | Description | Notes
|
|
175
|
+
------------- | ------------- | ------------- | -------------
|
|
176
|
+
**account_id** | **Integer**| Account ID |
|
|
177
|
+
**extension_id** | **Integer**| Extension ID |
|
|
178
|
+
**contact_id** | **Integer**| Contact ID |
|
|
179
|
+
|
|
180
|
+
### Return type
|
|
181
|
+
|
|
182
|
+
[**ContactFull**](ContactFull.md)
|
|
183
|
+
|
|
184
|
+
### Authorization
|
|
185
|
+
|
|
186
|
+
[apiKey](../README.md#apiKey)
|
|
187
|
+
|
|
188
|
+
### HTTP request headers
|
|
189
|
+
|
|
190
|
+
- **Content-Type**: application/json
|
|
191
|
+
- **Accept**: application/json
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
# **list_account_extension_contacts**
|
|
196
|
+
> ListContacts list_account_extension_contacts(account_id, extension_id, , opts)
|
|
197
|
+
|
|
198
|
+
Show the Caller ID options a given extension can use.
|
|
199
|
+
|
|
200
|
+
Show the Caller ID options a given extension can use. See Intro to Caller IDs for more on the properties.
|
|
201
|
+
|
|
202
|
+
### Example
|
|
203
|
+
```ruby
|
|
204
|
+
# load the gem
|
|
205
|
+
require 'phone_com_client'
|
|
206
|
+
# setup authorization
|
|
207
|
+
PhoneComClient.configure do |config|
|
|
208
|
+
# Configure API key authorization: apiKey
|
|
209
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
210
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
211
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
212
|
+
end
|
|
213
|
+
|
|
214
|
+
api_instance = PhoneComClient::ContactsApi.new
|
|
215
|
+
|
|
216
|
+
account_id = 56 # Integer | Account ID
|
|
217
|
+
|
|
218
|
+
extension_id = 56 # Integer | Extension ID
|
|
219
|
+
|
|
220
|
+
opts = {
|
|
221
|
+
filters_id: ['filters_id_example'], # Array<String> | ID filter
|
|
222
|
+
filters_group_id: ['filters_group_id_example'], # Array<String> | Group filter
|
|
223
|
+
filters_updated_at: ['filters_updated_at_example'], # Array<String> | Updated At filter
|
|
224
|
+
sort_id: 'sort_id_example', # String | ID sorting
|
|
225
|
+
sort_updated_at: 'sort_updated_at_example', # String | Updated At sorting
|
|
226
|
+
limit: 56, # Integer | Max results
|
|
227
|
+
offset: 56, # Integer | Results to skip
|
|
228
|
+
fields: 'fields_example', # String | Field set
|
|
229
|
+
}
|
|
230
|
+
|
|
231
|
+
begin
|
|
232
|
+
#Show the Caller ID options a given extension can use.
|
|
233
|
+
result = api_instance.list_account_extension_contacts(account_id, extension_id, , opts)
|
|
234
|
+
p result
|
|
235
|
+
rescue PhoneComClient::ApiError => e
|
|
236
|
+
puts "Exception when calling ContactsApi->list_account_extension_contacts: #{e}"
|
|
237
|
+
end
|
|
238
|
+
```
|
|
239
|
+
|
|
240
|
+
### Parameters
|
|
241
|
+
|
|
242
|
+
Name | Type | Description | Notes
|
|
243
|
+
------------- | ------------- | ------------- | -------------
|
|
244
|
+
**account_id** | **Integer**| Account ID |
|
|
245
|
+
**extension_id** | **Integer**| Extension ID |
|
|
246
|
+
**filters_id** | [**Array<String>**](String.md)| ID filter | [optional]
|
|
247
|
+
**filters_group_id** | [**Array<String>**](String.md)| Group filter | [optional]
|
|
248
|
+
**filters_updated_at** | [**Array<String>**](String.md)| Updated At filter | [optional]
|
|
249
|
+
**sort_id** | **String**| ID sorting | [optional]
|
|
250
|
+
**sort_updated_at** | **String**| Updated At sorting | [optional]
|
|
251
|
+
**limit** | **Integer**| Max results | [optional]
|
|
252
|
+
**offset** | **Integer**| Results to skip | [optional]
|
|
253
|
+
**fields** | **String**| Field set | [optional]
|
|
254
|
+
|
|
255
|
+
### Return type
|
|
256
|
+
|
|
257
|
+
[**ListContacts**](ListContacts.md)
|
|
258
|
+
|
|
259
|
+
### Authorization
|
|
260
|
+
|
|
261
|
+
[apiKey](../README.md#apiKey)
|
|
262
|
+
|
|
263
|
+
### HTTP request headers
|
|
264
|
+
|
|
265
|
+
- **Content-Type**: application/json
|
|
266
|
+
- **Accept**: application/json
|
|
267
|
+
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
# **replace_account_extension_contact**
|
|
271
|
+
> ContactFull replace_account_extension_contact(account_id, extension_id, contact_id, opts)
|
|
272
|
+
|
|
273
|
+
Update the info of a contact in the address book.
|
|
274
|
+
|
|
275
|
+
Update the info of a contact in the address book. See Account Contacts for more info on the fields in each item.
|
|
276
|
+
|
|
277
|
+
### Example
|
|
278
|
+
```ruby
|
|
279
|
+
# load the gem
|
|
280
|
+
require 'phone_com_client'
|
|
281
|
+
# setup authorization
|
|
282
|
+
PhoneComClient.configure do |config|
|
|
283
|
+
# Configure API key authorization: apiKey
|
|
284
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
285
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
286
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
287
|
+
end
|
|
288
|
+
|
|
289
|
+
api_instance = PhoneComClient::ContactsApi.new
|
|
290
|
+
|
|
291
|
+
account_id = 56 # Integer | Account ID
|
|
292
|
+
|
|
293
|
+
extension_id = 56 # Integer | Extension ID
|
|
294
|
+
|
|
295
|
+
contact_id = 56 # Integer | Contact ID
|
|
296
|
+
|
|
297
|
+
opts = {
|
|
298
|
+
data: PhoneComClient::CreateContactParams.new # CreateContactParams | Contact data
|
|
299
|
+
}
|
|
300
|
+
|
|
301
|
+
begin
|
|
302
|
+
#Update the info of a contact in the address book.
|
|
303
|
+
result = api_instance.replace_account_extension_contact(account_id, extension_id, contact_id, opts)
|
|
304
|
+
p result
|
|
305
|
+
rescue PhoneComClient::ApiError => e
|
|
306
|
+
puts "Exception when calling ContactsApi->replace_account_extension_contact: #{e}"
|
|
307
|
+
end
|
|
308
|
+
```
|
|
309
|
+
|
|
310
|
+
### Parameters
|
|
311
|
+
|
|
312
|
+
Name | Type | Description | Notes
|
|
313
|
+
------------- | ------------- | ------------- | -------------
|
|
314
|
+
**account_id** | **Integer**| Account ID |
|
|
315
|
+
**extension_id** | **Integer**| Extension ID |
|
|
316
|
+
**contact_id** | **Integer**| Contact ID |
|
|
317
|
+
**data** | [**CreateContactParams**](CreateContactParams.md)| Contact data | [optional]
|
|
318
|
+
|
|
319
|
+
### Return type
|
|
320
|
+
|
|
321
|
+
[**ContactFull**](ContactFull.md)
|
|
322
|
+
|
|
323
|
+
### Authorization
|
|
324
|
+
|
|
325
|
+
[apiKey](../README.md#apiKey)
|
|
326
|
+
|
|
327
|
+
### HTTP request headers
|
|
328
|
+
|
|
329
|
+
- **Content-Type**: application/json
|
|
330
|
+
- **Accept**: application/json
|
|
331
|
+
|
|
332
|
+
|
|
333
|
+
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# PhoneComClient::CreateCallParams
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**caller_phone_number** | **String** | Caller phone number in E.164 format | [optional]
|
|
7
|
+
**caller_extension** | **Integer** | Caller Extension ID | [optional]
|
|
8
|
+
**caller_caller_id** | **String** | Caller caller ID in E.164 format | [optional]
|
|
9
|
+
**caller_private** | **String** | Flag to set caller ID to private | [optional]
|
|
10
|
+
**callee_phone_number** | **String** | Callee phone number in E.164 format | [optional]
|
|
11
|
+
**callee_extension** | **Integer** | Callee Extension ID | [optional]
|
|
12
|
+
**callee_caller_id** | **String** | Callee caller ID in E.164 format | [optional]
|
|
13
|
+
**callee_private** | **String** | Flag to set callee ID to private | [optional]
|
|
14
|
+
|
|
15
|
+
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# PhoneComClient::CreateContactParams
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**first_name** | **String** | First Name | [optional]
|
|
7
|
+
**middle_name** | **String** | Middle Name | [optional]
|
|
8
|
+
**last_name** | **String** | Last Name | [optional]
|
|
9
|
+
**prefix** | **String** | Prefix | [optional]
|
|
10
|
+
**phonetic_first_name** | **String** | Phonetic First Name | [optional]
|
|
11
|
+
**phonetic_middle_name** | **String** | Phonetic Middle Name | [optional]
|
|
12
|
+
**phonetic_last_name** | **String** | Phonetic Last Name | [optional]
|
|
13
|
+
**suffix** | **String** | Suffix | [optional]
|
|
14
|
+
**nickname** | **String** | Nickname | [optional]
|
|
15
|
+
**company** | **String** | Company Name | [optional]
|
|
16
|
+
**department** | **String** | Department Name | [optional]
|
|
17
|
+
**job_title** | **String** | Job Title | [optional]
|
|
18
|
+
**emails** | [**Array<Email>**](Email.md) | Email Addresses | [optional]
|
|
19
|
+
**phone_numbers** | [**Array<PhoneNumberContact>**](PhoneNumberContact.md) | Phone Numbers | [optional]
|
|
20
|
+
**addresses** | [**Array<AddressListContacts>**](AddressListContacts.md) | Addresses | [optional]
|
|
21
|
+
**group** | **Object** | Contact Group | [optional]
|
|
22
|
+
|
|
23
|
+
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# PhoneComClient::CreateDeviceParams
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**name** | **String** | Device Name | [optional]
|
|
7
|
+
**lines** | **Array<Object>** | List of line objects | [optional]
|
|
8
|
+
|
|
9
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# PhoneComClient::CreateExtensionParams
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**voicemail** | [**VoicemailInput**](VoicemailInput.md) | | [optional]
|
|
7
|
+
**call_notifications** | [**CallNotifications**](CallNotifications.md) | | [optional]
|
|
8
|
+
**caller_id** | **String** | Caller ID | [optional]
|
|
9
|
+
**usage_type** | **String** | Extension type | [optional]
|
|
10
|
+
**extension** | **Integer** | Extension number (auto-generated if empty) | [optional]
|
|
11
|
+
**include_in_directory** | **String** | Include in dial-by-name directory | [optional]
|
|
12
|
+
**name** | **String** | Name (auto-generated if empty) | [optional]
|
|
13
|
+
**full_name** | **String** | Contact name | [optional]
|
|
14
|
+
**timezone** | **String** | Timezone | [optional]
|
|
15
|
+
**name_greeting** | **Object** | Recording lookup object | [optional]
|
|
16
|
+
**local_area_code** | **String** | Local area code | [optional]
|
|
17
|
+
**enable_outbound_calls** | **String** | Enable outgoing calls | [optional]
|
|
18
|
+
**enable_call_waiting** | **String** | Enable Call Waiting | [optional]
|
|
19
|
+
|
|
20
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# PhoneComClient::CreateListenerParams
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**type** | **String** | Type of listener. Must be 'callback' | [optional]
|
|
7
|
+
**event_type** | **String** | Type of event to subscribe. 'call.new', 'call.update', 'call.complete' | [optional]
|
|
8
|
+
**callbacks** | [**Array<CallbackObject>**](CallbackObject.md) | Array of Callback Objects. | [optional]
|
|
9
|
+
|
|
10
|
+
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# PhoneComClient::CreateMediaParams
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**name** | **String** | Name of media | [optional]
|
|
7
|
+
**origin** | **String** | 'tts', 'file' | [optional]
|
|
8
|
+
**type** | **String** | 'hold_music', 'greeting' | [optional]
|
|
9
|
+
**tts_voice** | **String** | 'allison', 'amy', 'belle', 'callie', 'callieq', 'dallas', 'damien', 'david', 'designerdave', 'diane', 'diesel', 'dog', 'duchess', 'duncan', 'emily', 'evilgenius', 'frank', 'french-fry', 'gregory', 'isabelle', 'jean-pierre', 'jerkface', 'katrin', 'kayla', 'kidaroo', 'lawrence', 'layo', 'linda', 'marta', 'matthias', 'miguel', 'millie', 'princess', 'ransomnote', 'robin', 'shouty', 'shygirl', 'tamika', 'tophat', 'vittoria', 'vixen', 'vlad', 'walter', 'whispery', 'william', 'wiseguy', 'zach' | [optional]
|
|
10
|
+
**tts_text** | **String** | Text used for text-to-speech conversion, maximum 800 characters | [optional]
|
|
11
|
+
**is_temparary** | **String** | 'Y', 'N'. Media file is temporary, will be deleted after a specified period. | [optional]
|
|
12
|
+
**expiration_date** | **Integer** | If is_temporary is 'Y', media will be deleted after the specified time in seconds | [optional]
|
|
13
|
+
**duration** | **Integer** | Length of media in seconds | [optional]
|
|
14
|
+
**notes** | **String** | Notes about the media object | [optional]
|
|
15
|
+
**randomized** | **String** | 'Y', 'N'. Start playing the media file in random location, instead of from the beginning | [optional]
|
|
16
|
+
|
|
17
|
+
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# PhoneComClient::CreateMenuParams
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**name** | **String** | | [optional]
|
|
7
|
+
**greeting** | **Object** | | [optional]
|
|
8
|
+
**keypress_error** | **Object** | | [optional]
|
|
9
|
+
**allow_extension_dial** | **String** | | [optional]
|
|
10
|
+
**keypress_wait_time** | **Integer** | | [optional]
|
|
11
|
+
**timeout_handler** | **Object** | | [optional]
|
|
12
|
+
**options** | **Array<Object>** | | [optional]
|
|
13
|
+
|
|
14
|
+
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# PhoneComClient::CreateOauthParams
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**grant_type** | **String** | authorization_code, client_credentials, password or refresh_token | [optional]
|
|
7
|
+
**client_id** | **String** | Client ID | [optional]
|
|
8
|
+
**client_secret** | **String** | Client Secret Key | [optional]
|
|
9
|
+
**code** | **String** | Authorization Code created via the /oauth/authorization API | [optional]
|
|
10
|
+
**redirect_uri** | **String** | The redirect URI where user enters authentication information | [optional]
|
|
11
|
+
**scope** | **String** | account-owner, extension-user and/or methods:ALL, separated by space (%20) | [optional]
|
|
12
|
+
**username** | **String** | User name | [optional]
|
|
13
|
+
**password** | **String** | Password | [optional]
|
|
14
|
+
**refresh_token** | **String** | Refresh token | [optional]
|
|
15
|
+
|
|
16
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# PhoneComClient::CreatePaymentParams
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**nickname** | **String** | Name of payment method | [optional]
|
|
7
|
+
**status** | **String** | primary, onfile or hidden | [optional]
|
|
8
|
+
**type** | **String** | Credit Card Type | [optional]
|
|
9
|
+
**cc_token** | **String** | Credit Card Token. Token is obtained by entering credit card info via the Credit Card Entry Form | [optional]
|
|
10
|
+
|
|
11
|
+
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# PhoneComClient::CreatePhoneNumberParams
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**phone_number** | **Object** | Phone number | [optional]
|
|
7
|
+
**route** | **Object** | Route lookup object | [optional]
|
|
8
|
+
**name** | **String** | Phone Name | [optional]
|
|
9
|
+
**block_incoming** | **String** | Block incoming calls | [optional]
|
|
10
|
+
**block_anonymous** | **String** | Block anonymous calls | [optional]
|
|
11
|
+
**caller_id** | [**CallerIdPhoneNumber**](CallerIdPhoneNumber.md) | | [optional]
|
|
12
|
+
**sms_forwarding** | [**SmsForwardingParams**](SmsForwardingParams.md) | | [optional]
|
|
13
|
+
**call_notifications** | [**CallNotifications**](CallNotifications.md) | | [optional]
|
|
14
|
+
|
|
15
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# PhoneComClient::CreatePricingParams
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**pricing_id** | **Integer** | Pricing plan code | [optional]
|
|
7
|
+
**reason** | **String** | Reason this pricing plan is added to the subaccount | [optional]
|
|
8
|
+
**expire_date** | **Integer** | Pricing plan expiration time in UNIX format. Disregard or set it to null for plan which never expires | [optional]
|
|
9
|
+
|
|
10
|
+
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# PhoneComClient::CreateQueueParams
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**name** | **String** | Name of queue | [optional]
|
|
7
|
+
**greeting** | **Object** | Recording lookup object | [optional]
|
|
8
|
+
**hold_music** | **Object** | Recording lookup object | [optional]
|
|
9
|
+
**max_hold_time** | **Integer** | Max seconds for hold | [optional]
|
|
10
|
+
**caller_id_type** | **String** | Type of caller id | [optional]
|
|
11
|
+
**ring_time** | **Integer** | Number of seconds to ring each member | [optional]
|
|
12
|
+
**members** | **Array<Object>** | Extensions or phone numbers | [optional]
|
|
13
|
+
|
|
14
|
+
|