Release Notes

Supported PHP Versions

Install

composer require bandwidth/iris

Usage

$client =new \Iris\Client($login,$password, ['url' =>'https://dashboard.bandwidth.com/api/']);

Run tests

$ composer install$ php ./bin/phpunit --bootstrap ./vendor/autoload.php tests/

Examples

$cd examples$ composer install$ cp config.php.example config.php

php availableNumbers-sample.php

API Objects

General principles

$account =new \Iris\Account($your_account_id,$client);

$sites =$account->sites();

$items =$sites->getList();// Array(Site1, Site2)

echojson_encode($site->to_array());

Available Numbers

$account->availableNumbers(["areaCode" =>"818" ]);

Available NpaNxx

$account->availableNpaNxx(["state" =>"CA"]);

Cities

$cities =new \Iris\Cities($client);$items =$cities->getList(["state" =>"NC"]);

Covered Rate Centers

$rcs =newIris\CoveredRateCenters($client);$rateCenters =$rcs->getList(["page" =>1,"size" =>10 ]);

Disconnected Numbers

$account->disnumbers(["areaCode" =>"919"]);

Disconnect Numbers

Create Disconnect

$disconnect =$account->disconnects()->create(["name" =>"test disconnect order 4","CustomerOrderId" =>"Disconnect1234","DisconnectTelephoneNumberOrderType" => ["TelephoneNumberList" => ["TelephoneNumber" => ["9192755378","9192755703" ]        ]    ]]]);

Get Disconnect

$disconnect =$account->disconnects()->disconnect("b902dee1-0585-4258-becd-5c7e51ccf5e1",true);// tnDetails: true

Add Note to Disconnect

$disconnect->notes()->create(["UserId" =>"byo_dev","Description" =>"Test Note"]);

Get Notes for Disconnect

$items =$disconnect->notes()->getList();

Dlda

Create Ddla

$order_data = ["CustomerOrderId" =>"123","DldaTnGroups" => ["DldaTnGroup" => [            ["TelephoneNumbers" => ["TelephoneNumber" =>"4352154856"                ],"AccountType" =>"RESIDENTIAL","ListingType" =>"LISTED","ListAddress" =>"true","ListingName" => ["FirstName" =>"FirstName","FirstName2" =>"FirstName2","LastName" =>"LastName","Designation" =>"Designation","TitleOfLineage" =>"TitleOfLineage","TitleOfAddress" =>"TitleOfAddress","TitleOfAddress2" =>"TitleOfAddress2","TitleOfLineageName2" =>"TitleOfLineageName2","TitleOfAddressName2" =>"TitleOfAddressName2","TitleOfAddress2Name2" =>"TitleOfAddress2Name2","PlaceListingAs" =>"PlaceListingAs",                ],"Address" => ["HousePrefix" =>"HousePrefix","HouseNumber" =>"915","HouseSuffix" =>"HouseSuffix","PreDirectional" =>"PreDirectional","StreetName" =>"StreetName","StreetSuffix" =>"StreetSuffix","PostDirectional" =>"PostDirectional","AddressLine2" =>"AddressLine2","City" =>"City","StateCode" =>"StateCode","Zip" =>"Zip","PlusFour" =>"PlusFour","Country" =>"Country","AddressType" =>"AddressType"                ]            ]        ]    ]];$dlda =$account->dldas()->create($order_data);

Get Dlda

$dlda =$account->dldas()->dlda("7802373f-4f52-4387-bdd1-c5b74833d6e2");

Get Dlda History

$dlda->history();

List Dldas

$account->dldas()->getList(["telephoneNumber" =>"9195551212"]);

In Service Numbers

List InService Numbers

$account->inserviceNumbers(["areaCode" =>"919"]);

Lidb

Create

$order_data = ["LidbTnGroups" => ["LidbTnGroup" => [            ["TelephoneNumbers" => ["TelephoneNumber" =>"4352154856"                ],"SubscriberInformation" =>"Steve","UseType" =>"RESIDENTIAL","Visibility" =>"PUBLIC"            ],            ["TelephoneNumbers" => ["TelephoneNumber" =>"4352154855"                ],"SubscriberInformation" =>"Steve","UseType" =>"RESIDENTIAL","Visibility" =>"PUBLIC"            ]        ]    ]];$lidb =$account->lidbs()->create($order_data);

Get Lidb

$lidb =$account->lidbs()->lidb("7802373f-4f52-4387-bdd1-c5b74833d6e2");

List Lidbs

$lidbs =$account->lidbs()->getList(["lastModifiedAfter" =>"mm-dd-yy","telephoneNumber"=>"888"]);

LNP Checker

Check LNP

$account->lnpChecker(["4109255199","9196190594"],"true");

Orders

Create Order

$order =$account->orders()->create(["Name" =>"Available Telephone Number order","SiteId" =>"2297","CustomerOrderId" =>"123456789","ExistingTelephoneNumberOrderType" => ["TelephoneNumberList" => ["TelephoneNumber" => ["9193752369","9193752720","9193752648"]        ]    ]]);

Get Order

$response =$account->orders()->order("f30a31a1-1de4-4939-b094-4521bbe5c8df",true);// tndetail=true$order =$response->Order;

List Orders

$items =$account->orders()->getList();

Add note to order

$order->notes()->create(["UserId" =>"byo_dev","Description" =>"Test Note"]);

Get all Tns for an order

$order->tns()->getList();

Port Ins

Create PortIn

$portin =$account->portins()->create(array("BillingTelephoneNumber" =>"6882015002","Subscriber" =>array("SubscriberType" =>"BUSINESS","BusinessName" =>"Acme Corporation","ServiceAddress" =>array("HouseNumber" =>"1623","StreetName" =>"Brockton Ave","City" =>"Los Angeles","StateCode" =>"CA","Zip" =>"90025","Country" =>"USA"        )    ),"LoaAuthorizingPerson" =>"John Doe","ListOfPhoneNumbers" =>array("PhoneNumber" =>array("9882015025","9882015026")    ),"SiteId" =>"365","Triggered" =>"false"));

Get PortIn

$portin =$account->portins()->portin("d28b36f7-fa96-49eb-9556-a40fca49f7c6"));

List PortIns

$portins =$account->portins()->getList(["pon" =>"a pon" ]);

PortIn Instance methods

$portin->update();$portin->delete();$portin->get_activation_status();$status =$portin->set_activation_status(["AutoActivationDate" =>"2014-08-30T18:30:00+03:00"]);$portin->history();$portin->totals();$portin->notes()->getList();

PortIn File Management

$portin->list_loas(true);// metadata = true$portin->loas_send("./1.txt");$portin->loas_update("./1.txt","1.txt");$portin->loas_delete("1.txt");$portin->get_metadata("1.txt");$meta_new =array("DocumentName" =>"text.txt","DocumentType" =>"INVOICE");$portin->set_metadata('test.txt',$meta_new);$portin->delete_metadata('test.txt');

Rate Centers

List Ratecenters

$rc =new \Iris\RateCenter($client);$cities =$rc->getList(["state" =>"CA","available" =>"true"]);

SIP Peers

Create SIP Peer

$sippeer =$account->sippeers()->create(array("PeerName" =>"Test5 Peer","IsDefaultPeer" =>false,"ShortMessagingProtocol" =>"SMPP","VoiceHosts" =>array("Host" =>array("HostName" =>"192.168.181.90"            )        ),"SmsHosts" =>array("Host" =>array("HostName" =>"192.168.181.90"            )        ),"TerminationHosts" =>array("TerminationHost" =>array("HostName" =>"192.168.181.90","Port" =>0,"CustomerTrafficAllowed" =>"DOMESTIC","DataAllowed" =>true            )        )));

Get SIP Peer

$sippeer =$account->sippeers->sippeer("500651");

List SIP Peers

$sippeers =$account->sippeers()->getList();

Delete SIP Peer

$sippeer->delete();

Move TNs

$sippeer->movetns(["FullNumber" => ["9192000046","9192000047","9192000048" ]]);

Get TNs

$tns =$sippeer->tns()->getList();

Get TN

$tn =$sippeer->tns()->tn("8183386251");

Total TNs

$count =$sippeer->totaltns();

Set TN Options

$sippeer->tns()->tn("8183386251")->set_tn_options(["FullNumber" =>"8183386251","CallForward" =>"9194394706","RewriteUser" =>"JohnDoe","NumberFormat" =>"10digit","RPIDFormat" =>"e164"]);

Sites

Create A Site

$site =$account->sites()->create(array("Name" =>"Test Site","Address" =>array("City" =>"Raleigh","AddressType" =>"Service","HouseNumber" =>"1","StreetName" =>"Avenue","StateCode" =>"NC"    )));

Updating a Site

$site->Name ="New Name";$site->update();

Deleting a Site

$site->delete();

Listing All Sites

$sites =$account->sites()->getList();

Orders of a site

$site->orders()->getList(["status" =>"disabled"]);

Total TNs of a site

$site->totaltns();

Portins of a site

$site->portins()->getList(["status" =>"disabled" ]);

Sippeers

$site->sippeers()->create([...])

Subscriptions

Create Subscription

$subscription =$account->subscriptions()->create(["OrderType" =>"portins","OrderId" =>"98939562-90b0-40e9-8335-5526432d9741","EmailSubscription" => ["Email" =>"test@test.com","DigestRequested" =>"DAILY"    ]]);

Get Subscription

$subscription =$account->subscriptions()->subscription($id);

List Subscriptions

$account->subscriptions()->getList(["orderType" =>"portins"]);

Update

$subscription->OrderType ="portins";$subscription->update();

DELETE

$subscription->delete();

TNs

Get TN

$tns =newIris\Tns(null,$client);$tn =$tns->tn($id);

List TNs

$tns =newIris\Tns(null,$client);$tns_items =$tns->getList(["page" =>1,"size" =>10 ]);

TN Instance Methods

$tn =$tns->tn("7576768750");$site =$tn->site();$sippeer =$tn->sippeer();$tnreservation =$tn->tnreservation();$tn->tndetails();$rc =$tn->ratecenter();$lata =$tn->lata();$lca =$tn->lca();

TN Reservation

Create TN Reservation

$resertation =$account->tnsreservations()->create(["ReservedTn" =>"2512027430"]);

Get TN Reservation

$resertation =$account->tnsreservations()->tnsreservation("0099ff73-da96-4303-8a0a-00ff316c07aa");

Delete TN Reservation

$resertation =$account->tnsreservations()->tnsreservation("0099ff73-da96-4303-8a0a-00ff316c07aa");$resertation->delete();

Billing reports

Listing all Billing Report instances

$billingReports =$account->billingreports()->getList();

Request new billing report

$billingReport =$account->billingreports()->request(array("Type" =>"bdr","DateRange" =>array("StartDate" =>"2018-02-05","EndDate" =>"2018-02-06",    )));

Checking status of the billing report

$billingReport =$account->billingreports()->billingreport('a12b456c8-abcd-1a3b-a1b2-0a2b4c6d8e0f2');

Download zip with content of the billing report

$zipStream =$billingReport->file();

Download zip with content of the billing report and save to file

$outFile ='/tmp/report.zip';$billingReport->file(['stream' =>true,'sink' =>$outFile]);