ruby-bandwidth-iris 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c3d3a94981e3e3ec40dad3670799281a661d200e80614973326c4cb059a8adb
-  data.tar.gz: d986dd6e52fc04e7f1f648c3a9e45560326da65a5c91208c89f33d09b1eda811
+  metadata.gz: 7b1159ee27c2a2ee423bdd0ce54a1b0943749127da435a611eeb113dec178ad0
+  data.tar.gz: a7e09992b64e938a9dc1c3943ee8be92dc9d6b8a1ed9d3b722268879a35779bd
 SHA512:
-  metadata.gz: 4b0429508a83ff431fc0b29708a78fd64e280650677d1421a08c30e9773224f82f2dc902205c75ceefc46df861104c5d665c0f385c5fdf70d4db79d3f74bb4c0
-  data.tar.gz: 93e9df992af04de3221534fda2c8dac0d74f0e6472322b05e75f8685a313734f9851f157d068bd6f69113d1ce3cc796c02d3efac8ab151f538e5fd16d2887385
+  metadata.gz: bc146c9252add1af25853dd70416d790ba9bb5ad8b74adb6f1575e95b754cd6dcf5d5875112060b643493fcc4b970df156c8d8072db1d054c8f68a6c49faaf87
+  data.tar.gz: 33db19d5c8f58b4632206a82333fd526b708726b8fbed3d71ba8efe6841708a19d29e66e2a9f1357f7a3caab668c2ff132422e34116e45bbdc33b3c7aee79516

data/README.md

@@ -11,6 +11,7 @@ Ruby Client library for IRIS / BBS API
 | 1.0.5 | Fixed incorrect generation of XML for a Disconnect request |
 | 2.0.0 | Added `importTnOrders`, `removeImportedTnOrders`, `inserviceNumbers`, and `importTnChecker` endpoints. This release also changed the response body of `BandwidthIris::InServiceNumber.list()`. Please make sure to update your code to include this change. |
 | 2.0.1 | Updated gem dependencies to be less restrictive |
+| 2.1.0 | Added `csrs` endpoints |
 
 ## Install
 
@@ -694,3 +695,65 @@ remove_imported_tn_order = {
 response = BandwidthIris::RemoveImportedTnOrders.create_remove_imported_tn_order(remove_imported_tn_order)
 puts response
 ```
+
+## CSR
+
+### Create CSR Order
+
+```ruby
+csr_data = {
+    :customer_order_id => "order id",
+    :working_or_billing_telephone_number => "5554443333"
+}
+
+response = BandwidthIris::Csr.create(csr_data)
+puts response[0][:order_id]
+```
+
+### Replace CSR Order
+
+```ruby
+csr_data = {
+    :customer_order_id => "order id",
+    :working_or_billing_telephone_number => "5554443333"
+}
+
+response = BandwidthIris::Csr.replace("csr_id", csr_data)
+puts response[0][:order_id]
+```
+
+### Get CSR Order
+
+```ruby
+response = BandwidthIris::Csr.get("csr_id")
+puts response[0][:order_id]
+```
+
+### Get CSR Order Notes
+
+```ruby
+response = BandwidthIris::Csr.get_notes("csr_id")
+puts response[0][:note][0][:id]
+```
+
+### Add CSR Order Note
+
+```ruby
+note_data = {
+    :user_id => "id",
+    :description => "description"
+}
+
+BandwidthIris::Csr.add_note("csr_id", note_data)
+```
+
+### Update CSR Order Note
+
+```ruby
+note_data = {
+    :user_id => "id",
+    :description => "description"
+}
+
+BandwidthIris::Csr.update_note("csr_id", "note_id", note_data)
+```

data/lib/bandwidth-iris/csr.rb

@@ -0,0 +1,44 @@
+module BandwidthIris
+  CSR_PATH = 'csrs'
+
+  class Csr
+    extend ClientWrapper
+    include ApiItem
+
+    def self.create(client, csr_data)
+      data = client.make_request(:post, client.concat_account_path("#{CSR_PATH}"), {:csr => csr_data})
+      return data
+    end
+    wrap_client_arg :create
+
+    def self.get(client, csr_id)
+      data = client.make_request(:get, client.concat_account_path("#{CSR_PATH}/#{csr_id}"))
+      return data
+    end
+    wrap_client_arg :get
+
+    def self.replace(client, csr_id, csr_data)
+      data = client.make_request(:put, client.concat_account_path("#{CSR_PATH}/#{csr_id}"), {:csr => csr_data})
+      return data
+    end
+    wrap_client_arg :replace
+
+    def self.get_notes(client, csr_id)
+      data = client.make_request(:get, client.concat_account_path("#{CSR_PATH}/#{csr_id}/notes"))
+      return data
+    end
+    wrap_client_arg :get_notes
+
+    def self.add_note(client, csr_id, note_data)
+      data = client.make_request(:post, client.concat_account_path("#{CSR_PATH}/#{csr_id}/notes"), {:note => note_data})
+      return data
+    end
+    wrap_client_arg :add_note
+
+    def self.update_note(client, csr_id, note_id, note_data)
+      data = client.make_request(:put, client.concat_account_path("#{CSR_PATH}/#{csr_id}/notes/#{note_id}"), {:note => note_data})
+      return data
+    end
+    wrap_client_arg :update_note
+  end
+end

data/lib/bandwidth-iris/version.rb

@@ -1,4 +1,4 @@
 module BandwidthIris
   # Version of this gem
-  VERSION = "2.0.1"
+  VERSION = "2.1.0"
 end

data/lib/ruby-bandwidth-iris.rb

@@ -29,5 +29,6 @@ require 'bandwidth-iris/user'
 require 'bandwidth-iris/import_tn_orders'
 require 'bandwidth-iris/import_tn_checker'
 require 'bandwidth-iris/remove_imported_tn_orders'
+require 'bandwidth-iris/csr'
 
 require 'bandwidth-iris/version'

data/spec/bandwidth-iris/csr_spec.rb

@@ -0,0 +1,73 @@
+describe BandwidthIris::Csr do
+  client = nil
+
+  before :each do
+    client = Helper.get_client()
+  end
+
+  after :each do
+    client.stubs.verify_stubbed_calls()
+  end
+
+  describe '#create' do
+    it 'should create a csr' do
+      data = {
+        :customer_order_id => "123",
+        :working_or_billing_telephone_number => "5554443333"
+      }
+      client.stubs.post("/v1.0/accounts/accountId/csrs", client.build_xml({:csr => data})) {|env| [200, {}, Helper.xml['csr']]}
+      item = BandwidthIris::Csr.create(client, data)
+      expect(item[0][:status]).to eql("RECEIVED")
+    end
+  end
+
+  describe '#get' do
+    it 'should get a csr' do
+      client.stubs.get("/v1.0/accounts/accountId/csrs/123") {|env| [200, {}, Helper.xml['csr']]}
+      item = BandwidthIris::Csr.get(client, "123")
+      expect(item[0][:status]).to eql("RECEIVED")
+    end
+  end
+
+  describe '#replace' do
+    it 'should replace a csr' do
+      data = {
+        :customer_order_id => "123",
+        :working_or_billing_telephone_number => "5554443333"
+      }
+      client.stubs.put("/v1.0/accounts/accountId/csrs/123", client.build_xml({:csr => data})) {|env| [200, {}, Helper.xml['csr']]}
+      item = BandwidthIris::Csr.replace(client, "123", data)
+      expect(item[0][:status]).to eql("RECEIVED")
+    end
+  end
+
+  describe '#getnotes' do
+    it 'should get csr notes' do
+      client.stubs.get("/v1.0/accounts/accountId/csrs/123/notes") {|env| [200, {}, Helper.xml['notes']]}
+      item = BandwidthIris::Csr.get_notes(client, "123")
+      expect(item[0][:note][0][:id]).to eql(11299)
+    end
+  end
+
+  describe '#addnote' do
+    it 'should add csr note' do
+      data = {
+        :user_id => "id",
+        :description => "description"
+      }
+      client.stubs.post("/v1.0/accounts/accountId/csrs/123/notes", client.build_xml({:note => data})) {|env| [200, {}, ""]}
+      BandwidthIris::Csr.add_note(client, "123", data)
+    end
+  end
+
+  describe '#updatenote' do
+    it 'should update csr note' do
+      data = {
+        :user_id => "id",
+        :description => "description"
+      }
+      client.stubs.put("/v1.0/accounts/accountId/csrs/123/notes/456", client.build_xml({:note => data})) {|env| [200, {}, ""]}
+      BandwidthIris::Csr.update_note(client, "123", "456", data)
+    end
+  end
+end

data/spec/xml.yml

@@ -46,3 +46,4 @@
   lsr_orders: "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?><LsrOrders><TotalCount>5</TotalCount><LsrOrderSummary><accountId>9999999</accountId><CountOfTNs>2</CountOfTNs><CustomerOrderId>FineCustomerid</CustomerOrderId><userId>team_ua</userId><lastModifiedDate>2015-03-02T09:10:16.193Z</lastModifiedDate><OrderType>lsr</OrderType><OrderDate>2015-03-25T11:44:42.941Z</OrderDate><OrderStatus>PENDING</OrderStatus><ActualFocDate>2015-03-25</ActualFocDate><BillingTelephoneNumber>2526795000</BillingTelephoneNumber><CreatedByUser>lsrOnlyUser</CreatedByUser><OrderId>7d644c88-ef23-4307-96ab-20253666d0c7</OrderId><Pon>ATT-011515-324234</Pon><PonVersion>0</PonVersion><RequestedFocDate>2015-11-15</RequestedFocDate></LsrOrderSummary><!-- SNIP --><LsrOrderSummary><accountId>9999999</accountId><CountOfTNs>2</CountOfTNs><CustomerOrderId>MyId5</CustomerOrderId><lastModifiedDate>2015-03-03T14:07:19.926Z</lastModifiedDate><OrderType>lsr</OrderType><OrderDate>2015-03-25T11:44:42.941Z</OrderDate><OrderStatus>NEW</OrderStatus><ActualFocDate>2015-03-25</ActualFocDate><BillingTelephoneNumber>2526795000</BillingTelephoneNumber><CreatedByUser>lsrOnlyUser</CreatedByUser><OrderId>00cf7e08-cab0-4515-9a77-2d0a7da09415</OrderId><Pon>testpon1002</Pon><PonVersion>0</PonVersion><RequestedFocDate>2015-11-15</RequestedFocDate></LsrOrderSummary></LsrOrders>"
   account: "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?><AccountResponse><Account><AccountId>14</AccountId><CompanyName>CWI Hosting</CompanyName><AccountType>Business</AccountType><NenaId></NenaId><Tiers><Tier>0</Tier></Tiers><Address><HouseNumber>60</HouseNumber><HouseSuffix></HouseSuffix><PreDirectional></PreDirectional><StreetName>Pine</StreetName><StreetSuffix>St</StreetSuffix><PostDirectional></PostDirectional><AddressLine2></AddressLine2><City>Denver</City><StateCode>CO</StateCode><Zip>80016</Zip><PlusFour></PlusFour><County></County><Country>United States</Country><AddressType>Service</AddressType></Address><Contact><FirstName>Sanjay</FirstName><LastName>Rao</LastName><Phone>9195441234</Phone><Email>srao@bandwidth.com</Email></Contact><ReservationAllowed>true</ReservationAllowed><LnpEnabled>true</LnpEnabled><AltSpid>X455</AltSpid><SPID>9999</SPID><PortCarrierType>WIRELINE</PortCarrierType></Account></AccountResponse>"
   import_tn_checker: '<?xml version="1.0" encoding="UTF-8"?><ImportTnCheckerPayload><TelephoneNumbers><TelephoneNumber>5554443333</TelephoneNumber><TelephoneNumber>5553334444</TelephoneNumber></TelephoneNumbers></ImportTnCheckerPayload>'
+  csr: '<?xml version="1.0" encoding="UTF-8"?><CsrResponse><Status>RECEIVED</Status></CsrResponse>'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-bandwidth-iris
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Andrey Belchikov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-26 00:00:00.000000000 Z
+date: 2020-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
@@ -171,6 +171,7 @@ files:
 - lib/bandwidth-iris/client.rb
 - lib/bandwidth-iris/client_wrapper.rb
 - lib/bandwidth-iris/covered_rate_center.rb
+- lib/bandwidth-iris/csr.rb
 - lib/bandwidth-iris/disc_number.rb
 - lib/bandwidth-iris/disconnect.rb
 - lib/bandwidth-iris/dlda.rb
@@ -202,6 +203,7 @@ files:
 - spec/bandwidth-iris/city_spec.rb
 - spec/bandwidth-iris/client_spec.rb
 - spec/bandwidth-iris/covered_rate_center_spec.rb
+- spec/bandwidth-iris/csr_spec.rb
 - spec/bandwidth-iris/disc_number_spec.rb
 - spec/bandwidth-iris/disconnect_spec.rb
 - spec/bandwidth-iris/dlda_spec.rb
@@ -255,6 +257,7 @@ test_files:
 - spec/bandwidth-iris/city_spec.rb
 - spec/bandwidth-iris/client_spec.rb
 - spec/bandwidth-iris/covered_rate_center_spec.rb
+- spec/bandwidth-iris/csr_spec.rb
 - spec/bandwidth-iris/disc_number_spec.rb
 - spec/bandwidth-iris/disconnect_spec.rb
 - spec/bandwidth-iris/dlda_spec.rb