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