Download the PHP package icukcomputingservices/php-broadband-api without Composer

On this page you can find all versions of the php package icukcomputingservices/php-broadband-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of icukcomputingservices/php-broadband-api

Informations about the package php-broadband-api

OpenAPIClient-php

The ICUK API provides an interface to the reseller control panel which can be used to control the provisioning and configuration of facilities remotely

For more information, please visit https://control.icuk.net.

Installation & Usage

Requirements

PHP 8.1 and later.

Composer

To install the bindings via Composer, add the following to composer.json:

Then run composer install

Manual Installation

Download the files and include autoload.php:

Getting Started

Please follow the installation procedure and then run the following:

API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
AdminWebhooksApi webhooksPingGet GET /webhooks/ping Test request
AdminWebhooksApi webhooksSimwoodPortPost POST /webhooks/simwood/port Process Simwood port update
BroadbandAddressApi broadbandAddressPostcodeGet GET /broadband/address/{postcode} Search for your postcode and it will return a list of BT address search results
BroadbandAddressApi broadbandAddressSearchPostcodeGet GET /broadband/address_search/{postcode} Search for your postcode and it will return a list of BT address search results
BroadbandAuthenticationLogsApi broadbandAuthenticationLogsUsernameGet GET /broadband/authentication_logs/{username} Retrieves the past 50 authentication attempts for a broadband user
BroadbandAvailabilityApi broadbandAvailabilityInputGet GET /broadband/availability/{input} Search for your phone number, access line ID or postcode and return a list of available broadband products with the speeds available.
BroadbandAvailabilityApi broadbandAvailabilityPost POST /broadband/availability Search with your exact BT address match and return a list of available broadband products with the speeds available
BroadbandAvailabilityApi broadbandAvailabilityUprnInputGet GET /broadband/availability/uprn/{input} Search with a UPRN and return a list of available broadband products with the speeds available.
BroadbandBanApi broadbandBanPut PUT /broadband/ban Updates the ban status for a broadband user
BroadbandBanApi broadbandBanStatusUsernameGet GET /broadband/ban/status/{username} Retrieves the ban status for a broadband user
BroadbandContactDetailsApi broadbandUserContactUsernameGet GET /broadband/user/contact/{username} Retrieves the contact details for a broadband user
BroadbandContactDetailsApi broadbandUserContactUsernamePut PUT /broadband/user/contact/username Changes a broadband users contact
BroadbandDataTransferApi broadbandDataTransferDailyUsernameGet GET /broadband/data_transfer/daily/{username} Retrieves the daily data transfer usage for a broadband user for the current month
BroadbandDataTransferApi broadbandDataTransferDailyUsernameYearMonthGet GET /broadband/data_transfer/daily/{username}/{year}/{month} Retrieves the daily data transfer usage for a broadband user for the specified month and year
BroadbandDataTransferApi broadbandDataTransferHourlyUsernameGet GET /broadband/data_transfer/hourly/{username} Retrieves the hourly data transfer usage for a broadband user for the current day
BroadbandDataTransferApi broadbandDataTransferHourlyUsernameYearMonthDayGet GET /broadband/data_transfer/hourly/{username}/{year}/{month}/{day} Retrieves the hourly data transfer usage for a broadband user for the specified day, month and year
BroadbandDataTransferApi broadbandDataTransferMonthlyGet GET /broadband/data_transfer/monthly Retrieves the monthly data transfer usage for all users for the current month
BroadbandDataTransferApi broadbandDataTransferMonthlyUsernameGet GET /broadband/data_transfer/monthly/{username} Retrieves the monthly data transfer usage for a broadband user for the current month
BroadbandDataTransferApi broadbandDataTransferMonthlyUsernameYearMonthGet GET /broadband/data_transfer/monthly/{username}/{year}/{month} Retrieves the monthly data transfer usage for a broadband user for the specified month and year
BroadbandDataTransferApi broadbandDataTransferMonthlyYearMonthGet GET /broadband/data_transfer/monthly/{year}/{month} Retrieves the monthly data transfer usage for all users for the specified month and year
BroadbandDiagnosticsApi broadbandDiagnosticsResultsUsernameTestIdGet GET /broadband/diagnostics/results/{username}/{test_id} Gets the results of complete diagnostics test for a certain user and test ID for a TTB line
BroadbandDiagnosticsApi broadbandDiagnosticsUsernameGet GET /broadband/diagnostics/{username} Carry out a TalkTalk diagnostics test on the user line
BroadbandDiagnosticsApi broadbandKbdPost POST /broadband/kbd Carry out a Knowledge Based Diagnostics test on a BT Openreach line
BroadbandDiagnosticsApi broadbandKbdResultUsernameGet GET /broadband/kbd/result/{username} Gets the results of complete KBD's for a certain user
BroadbandIPApi broadbandIpRdnsUsernameGet GET /broadband/ip/rdns/{username} Retrieves the broadband Reverse DNS information of a static, routed and Ipv6 addresses of a broadband user
BroadbandIPApi broadbandIpRdnsUsernamePost POST /broadband/ip/rdns/{username} Assigns a Reverse DNS records to a static or routed IP address
BroadbandIPApi broadbandIpRoutedDeleteUsernamePost POST /broadband/ip/routed/delete/{username} Removes a routed subnet from a broadband user
BroadbandIPApi broadbandIpRoutedUsernameDelete DELETE /broadband/ip/routed/{username} Removes a routed subnet from a broadband user [DEPRECATED]
BroadbandIPApi broadbandIpRoutedUsernamePost POST /broadband/ip/routed/{username} Assigns a routed IPv4 address of the supplied size to a broadband user and updates the RIPE database with the supplied RIPE NIC handle. If the current allocation is dynamic a static IP will also be created
BroadbandIPApi broadbandIpStaticUsernameDelete DELETE /broadband/ip/static/{username} Removes a static IP address and all routed subnets from a broadband user
BroadbandIPApi broadbandIpStaticUsernamePost POST /broadband/ip/static/{username} Assigns a static IPv4 address to a broadband user
BroadbandIPApi broadbandIpUsernameGet GET /broadband/ip/{username} Retrieves the static, routed and Ipv6 information of a broadband user
BroadbandIPApi broadbandIpv6UsernameDelete DELETE /broadband/ipv6/{username} Removes a IPv6 address from a broadband user
BroadbandIPApi broadbandIpv6UsernamePost POST /broadband/ipv6/{username} Assigns a IPv6 address to a broadband user
BroadbandNotificationsApi broadbandNotificationsGetGet GET /broadband/notifications/get Returns all broadband notifications for the reseller
BroadbandNotificationsApi broadbandNotificationsQueryPost POST /broadband/notifications/query Queries for broadband notifications
BroadbandNotificationsApi broadbandNotificationsUsernameAllGet GET /broadband/notifications/{username}/{all} Queries for broadband notifications for user@realm
BroadbandOnlineStatusApi broadbandOnlineStatusGet GET /broadband/online_status Retrieves the online statuses for all broadband users
BroadbandOnlineStatusApi broadbandOnlineStatusUsernameDelete DELETE /broadband/online_status/{username} Terminates a user's session if they are online
BroadbandOnlineStatusApi broadbandOnlineStatusUsernameGet GET /broadband/online_status/{username} Retrieves the online status of a broadband user
BroadbandOrderApi broadbandOrderCeaseUsernamePost POST /broadband/order/cease/{username} Places a cease order for an existing broadband connection for a specific date
BroadbandOrderApi broadbandOrderGet GET /broadband/order Retrieves the broadband order summary for all users
BroadbandOrderApi broadbandOrderMigratePost POST /broadband/order/migrate Orders a migration of an existing broadband connection for a telephone line or address
BroadbandOrderApi broadbandOrderOrderIdGet GET /broadband/order/{order_id} Retrieves the broadband order details for a broadband order ID
BroadbandOrderApi broadbandOrderOrderTypeOrderStatusGet GET /broadband/order/{order_type}/{order_status} Retrieves the broadband order summary for all users for the specified order type and status
BroadbandOrderApi broadbandOrderProvidePost POST /broadband/order/provide Orders a new broadband product for a telephone line or address
BroadbandOrderApi broadbandOrderUpdatesOrderIdStartDateEndDateGet GET /broadband/order/updates/{order_id}/{start_date}/{end_date} Retrieves a specific broadband order which has been updated within a datetime range
BroadbandOrderApi broadbandOrderUpdatesStartDateEndDateGet GET /broadband/order/updates/{start_date}/{end_date} Retrieves the broadband orders which have been updated within a datetime range
BroadbandProductsApi broadbandProductsAdslProductIdGet GET /broadband/products/adsl/{product_id} Retrieves the reseller's broadband product details for a specific product ID
BroadbandProductsApi broadbandProductsCareCurrentUsernameGet GET /broadband/products/care/current/{username} Gets the current care level of the broadband product
BroadbandProductsApi broadbandProductsCarePut PUT /broadband/products/care Updates the care level of the broadband product
BroadbandProductsApi broadbandProductsGet GET /broadband/products Retrieves the reseller's available broadband products that can be ordered and their costs
BroadbandProductsApi broadbandProductsQuotaCurrentUsernameGet GET /broadband/products/quota/current/{username} Gets the default action to be taken in future if the account exceeds its quota
BroadbandProductsApi broadbandProductsQuotaPut PUT /broadband/products/quota Choose a default action to be taken in future if the account exceeds its quota
BroadbandProductsApi broadbandProductsSpeedCurrentUsernameGet GET /broadband/products/speed/current/{username} Gets the current speed limit of a broadband product
BroadbandProductsApi broadbandProductsSpeedPut PUT /broadband/products/speed Adjust the speed limit for this connection
BroadbandRIPEApi broadbandRipePersonGet GET /broadband/ripe/person Retrieves the RIPE person contacts that have been created for broadband accounts assigned to the reseller
BroadbandRIPEApi broadbandRipePersonPost POST /broadband/ripe/person Creates a RIPE person contact assigned to the reseller
BroadbandRIPEApi broadbandRipePersonRipeNicHandleDelete DELETE /broadband/ripe/person/{ripe_nic_handle} Deletes the RIPE person contact details for a nic-handle
BroadbandRIPEApi broadbandRipePersonRipeNicHandleGet GET /broadband/ripe/person/{ripe_nic_handle} Retrieves a RIPE person contact for a specific nic-handle that has been created for a broadband account assigned to the reseller
BroadbandRIPEApi broadbandRipePersonRipeNicHandlePut PUT /broadband/ripe/person/{ripe_nic_handle} Changes the RIPE person contact details for a nic-handle
BroadbandRadiusApi broadbandCarrierRadiusGet GET /broadband/carrier_radius Retrieves the carrier RADIUS logs of a broadband user. [TTB only]
BroadbandSessionHistoryApi broadbandSessionHistoryUsernameGet GET /broadband/session_history/{username} Retrieves the past 50 session history of a broadband user
BroadbandSpeedtestApi broadbandSpeedtestUsernameGet GET /broadband/speedtest/{username} Get the speed test history for the specified user
BroadbandSyncProfileApi broadbandSyncProfileUsernameGet GET /broadband/sync_profile/{username} View the current and past sync profile for this connection
BroadbandTariffApi broadbandTariffDeleteTariffIdDelete DELETE /broadband/tariff/delete/{tariff_id} Deletes a broadband tariff
BroadbandTariffApi broadbandTariffGet GET /broadband/tariff Retrieves the broadband tariffs
BroadbandTariffApi broadbandTariffNewPost POST /broadband/tariff/new Creates a new broadband tariff
BroadbandTroubleshootingApi broadbandDlmResetPut PUT /broadband/dlm/reset Perform a DLM reset on a connection
BroadbandTroubleshootingApi broadbandDlmResetResultsUsernameGet GET /broadband/dlm/reset/results/{username} Obtain results from the DLM reset tool. Returns the latest results, if no ID is specified
BroadbandTroubleshootingApi broadbandDlmResetResultsUsernameIdGet GET /broadband/dlm/reset/results/{username}/{id} Obtain results from the DLM reset tool. Returns the latest results, if no ID is specified
BroadbandTroubleshootingApi broadbandInterleavingCurrentUsernameGet GET /broadband/interleaving/current/{username} Retrieves the current interleaving option. Only available for users with BT Wholesale products
BroadbandTroubleshootingApi broadbandInterleavingPut PUT /broadband/interleaving Updates the interleaving profile. Only available for users with BT Wholesale broadband products
BroadbandTroubleshootingApi broadbandPortFlexPut PUT /broadband/port/flex Perform a port flex on a connection
BroadbandTroubleshootingApi broadbandPortFlexResultsUsernameGet GET /broadband/port/flex/results/{username} Obtain results from the port flex tool. Returns the latest results, if no ID is specified
BroadbandTroubleshootingApi broadbandPortFlexResultsUsernameIdGet GET /broadband/port/flex/results/{username}/{id} Obtain results from the port flex tool. Returns the latest results, if no ID is specified
BroadbandTroubleshootingApi broadbandPortRebuildPut PUT /broadband/port/rebuild Perform a port rebuild on a connection
BroadbandTroubleshootingApi broadbandPortRebuildResultsUsernameGet GET /broadband/port/rebuild/results/{username} Obtain results from the port rebuild tool. Returns the latest results, if no ID is specified
BroadbandTroubleshootingApi broadbandPortRebuildResultsUsernameIdGet GET /broadband/port/rebuild/results/{username}/{id} Obtain results from the port rebuild tool. Returns the latest results, if no ID is specified
BroadbandTroubleshootingApi broadbandPortResetPut PUT /broadband/port/reset Perform a port reset on a connection
BroadbandTroubleshootingApi broadbandPortResetResultsUsernameGet GET /broadband/port/reset/results/{username} Obtain results from the port reset tool. Returns the latest results, if no ID is specified
BroadbandTroubleshootingApi broadbandPortResetResultsUsernameIdGet GET /broadband/port/reset/results/{username}/{id} Obtain results from the port reset tool. Returns the latest results, if no ID is specified
BroadbandTroubleshootingApi broadbandProfileCurrentUsernameGet GET /broadband/profile/current/{username} Gets the current SNR and interleaving profile. Only available for users with TalkTalk products
BroadbandTroubleshootingApi broadbandProfilePut PUT /broadband/profile Updates SNR and interleaving profile. Only available for users with TalkTalk products
BroadbandTroubleshootingApi broadbandSessionKillPut PUT /broadband/session_kill Perform a session kill on a connection
BroadbandTroubleshootingApi broadbandSessionKillResultsUsernameGet GET /broadband/session_kill/results/{username} Obtain results from the session kill tool. Returns the latest results, if no ID is specified
BroadbandTroubleshootingApi broadbandSessionKillResultsUsernameIdGet GET /broadband/session_kill/results/{username}/{id} Obtain results from the session kill tool. Returns the latest results, if no ID is specified
BroadbandTroubleshootingApi broadbandSnrLogsUsernameGet GET /broadband/snr/logs/{username} Gets SNR logs for a user. Only available for users with BT Wholesale products
BroadbandTroubleshootingApi broadbandSnrUsernameGet GET /broadband/snr/{username} Reset the SNR of the user line. Only available for users with BT Wholesale products
BroadbandTroubleshootingApi broadbandStabilityCurrentUsernameGet GET /broadband/stability/current/{username} Gets the current stability option of the line. The stability option will change once the order is complete
BroadbandTroubleshootingApi broadbandStabilityPut PUT /broadband/stability Updates the stability of the line
BroadbandUserApi broadbandUserGet GET /broadband/user Retrieves all the broadband users belonging to the API user
BroadbandUserApi broadbandUserPasswordUsernamePut PUT /broadband/user/password/{username} Updates password of a broadband user
BroadbandUserApi broadbandUserUsernameDelete DELETE /broadband/user/{username} Deletes a broadband user belonging to the API user
BroadbandUserApi broadbandUserUsernameGet GET /broadband/user/{username} Retrieves a broadband user belonging to the API user
EchoApi echoGet GET /echo Test Echo API request
FaxApi telecomsFaxGetareacodesGet GET /telecoms/fax/getareacodes Get Area Codes
FaxApi telecomsFaxGetfaxpricesGet GET /telecoms/fax/getfaxprices Get Fax Prices
OAuthApi oauthTokenPost POST /oauth/token Retrieve OAuth 2.0 Authorization token.

Models

Authorization

Authentication schemes defined for the API:

oauth2

Tests

To run the tests, use:

Author

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

All versions of php-broadband-api with dependencies

PHP Build Version
Package Version
Requires php Version ^7.4 || ^8.0
ext-curl Version *
ext-json Version *
ext-mbstring Version *
guzzlehttp/guzzle Version ^6.5 || ^7.3
guzzlehttp/psr7 Version ^1.7 || ^2.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package icukcomputingservices/php-broadband-api contains the following files

Loading the files please wait ...