voicetel 2.2.16 → 2.2.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03e0c2caeb528798a8533d147342ea847302ee4c32dafecf231451535aedbc6b
-  data.tar.gz: e3232d0f596e1e2dae71225b23dc04ecc983082b62e36a562b7c9ecfc0d04dec
+  metadata.gz: 437a8240b4ed4d919e23e9ef697a0d3f6e850567e687024c9c77c2323d76d3ef
+  data.tar.gz: 7d3da488bc91fe353049d2bd58d575a192b9c324b99f3c961fa50b339641ed07
 SHA512:
-  metadata.gz: f3cf1046366f40354407c4aeb579e48bd043157b79beeae29dfa9c6b281ddf959b7d16c33ad37721d438814026587f931d58a8163a5de1938194f353c85f72eb
-  data.tar.gz: abdbb7cb92c70c8076b0d1e8a318eb59993dd8910468a506a00d0d7ed015c94faaa8852f01c150854cc050ef9a67d64bb97ee71f96a131bbf8c8395d6d1add69
+  metadata.gz: 17bb4b822a0250b2b5d95edb1f2bb020e988cba2e4ab74dc8b198e73af64d393f85355d290926102b4b0e557e86063f997e36487865a13331ac3cb106878e758
+  data.tar.gz: 3ab27ba58ecfeb51377e705dc2442d6e1c088e838ac97f6b2b5a749149e133d74ded36bc40614aa0e3db85ab1314de93bbb392273b87eda1bb493e711f0cdd81

data/README.md

@@ -2,7 +2,7 @@
 
 The official Ruby client for the [VoiceTel REST API](https://voicetel.com/docs/api/v2.2/) — provision numbers, place orders, validate e911, send messages, and manage your account, all with idiomatic Ruby, structured errors, and zero codegen footprint.
 
-![Version](https://img.shields.io/badge/version-2.2.16-blue)
+![Version](https://img.shields.io/badge/version-2.2.17-blue)
 ![Ruby](https://img.shields.io/badge/ruby-3.2%2B-red)
 ![License](https://img.shields.io/badge/license-MIT-green)
 ![Coverage](https://img.shields.io/badge/coverage-%E2%89%A585%25-brightgreen)
@@ -64,7 +64,7 @@ gem install voicetel
 Or in your `Gemfile`:
 
 ```ruby
-gem "voicetel", "~> 2.2.16"
+gem "voicetel", "~> 2.2.17"
 ```
 
 Requires Ruby 3.2 or later. Tested on 3.2, 3.3, and 3.4.
@@ -123,23 +123,23 @@ key = client.login(username: "1000000001", password: "hunter2")
 | `client.e911` | Records, address validation, provisioning | `client.e911.validate(address1: "...", city: "...", state: "NJ", zip: "07101")` |
 | `client.gateways` | Termination routes | `client.gateways.list` |
 | `client.i_numbering` | Inventory, orders, port-ins | `client.i_numbering.search_inventory(tn_mask: "201555*")` |
-| `client.lookups` | CNAM & LRN dips | `client.lookups.lrn("2015551234", "2012548000")` |
+| `client.lookups` | CNAM & LRN dips | `client.lookups.lrn("2015550123", "2015550100")` |
 | `client.messaging` | SMS/MMS, 10DLC brands & campaigns, messaging health | `client.messaging.send_message(from_number: "...", to_number: "...", text: "...")` |
-| `client.numbers` | All operations on TNs on the account | `client.numbers.assign_campaign("2015551234", campaign_id: "CABC123")` |
+| `client.numbers` | All operations on TNs on the account | `client.numbers.assign_campaign("2015550123", campaign_id: "CABC123")` |
 | `client.support` | Tickets, replies, attachments | `client.support.create(subject: "...", message: "...")` |
 
 Every method that takes a body accepts a plain Ruby Hash with `snake_case` keys; the SDK camelCases them when serializing to JSON:
 
 ```ruby
 client.messaging.send_message(
-  from_number: "2012548000",
-  to_number:   "2015551234",
+  from_number: "2015550100",
+  to_number:   "2015550123",
   text:        "Your code is 482917"
 )
-# → POST /v2.2/messages { "fromNumber": "2012548000", "toNumber": "2015551234", "text": "Your code is 482917" }
+# → POST /v2.2/messages { "fromNumber": "2015550100", "toNumber": "2015550123", "text": "Your code is 482917" }
 
-client.numbers.assign_campaign("2015551234", campaign_id: "CABC123")
-# → PUT /v2.2/numbers/2015551234/messaging-campaign { "campaignId": "CABC123" }
+client.numbers.assign_campaign("2015550123", campaign_id: "CABC123")
+# → PUT /v2.2/numbers/2015550123/messaging-campaign { "campaignId": "CABC123" }
 ```
 
 Responses come back as immutable `Data` model classes (`VoiceTel::Models::...`) with `snake_case` readers — `assign_campaign` returns a `Models::NumberMessagingCampaignAssignData` whose `status` is `"enabled"` (bound now, path B), `"already"` (was already bound — idempotent), or `"pending"` (path C, provisioning asynchronously — poll `client.numbers.get_messaging(n).pending` until its `state` is `"done"` or `"failed"`). Any model converts to a plain Hash with `#to_h` when you need to serialize or pretty-print it.
@@ -221,7 +221,7 @@ gem build voicetel.gemspec
 
 ## 🙌 Contributors
 
-- [Michael Mavroudis](https://github.com/mavroudis) — Lead Developer
+- [Jane Doe](https://github.com/mavroudis) — Lead Developer
 
 Contributions welcome. Open an issue describing the change you want to make, or send a pull request against `main`.
 

data/lib/voicetel/models/i_numbering.rb

@@ -11,7 +11,9 @@ module VoiceTel
       include Request
     end
 
-    # Per-number routing override inside OrderCreateRequest.
+    # Per-number routing override inside OrderCreateRequest. route is the
+    # global route type for numbers in this order: 1 USER, 2 T30,
+    # 3 VOICE_BRIDGE, 4 DID (default), 5 T38, 6 VOICEML, 8 SDN, 9 MOBILE.
     OrderNumberSpec = Data.define(:number, :route) do
       include Request
     end

data/lib/voicetel/models/numbers.rb

@@ -5,12 +5,16 @@ require_relative "base"
 module VoiceTel
   module Models
     # ------------------------------------------------------------- requests ---
-    # Body for POST /v2.2/numbers.
+    # Body for POST /v2.2/numbers. route is the global route type: 1 USER,
+    # 2 T30, 3 VOICE_BRIDGE, 4 DID (default), 5 T38, 6 VOICEML, 8 SDN,
+    # 9 MOBILE.
     NumberAddRequest = Data.define(:number, :route) do
       include Request
     end
 
-    # Body for PUT /v2.2/numbers/{number}/route.
+    # Body for PUT /v2.2/numbers/{number}/route. route is the global route
+    # type: 1 USER, 2 T30, 3 VOICE_BRIDGE, 4 DID (default), 5 T38, 6 VOICEML,
+    # 8 SDN, 9 MOBILE.
     NumberRouteRequest = Data.define(:route) do
       include Request
     end
@@ -61,7 +65,9 @@ module VoiceTel
       include Request
     end
 
-    # Body for PATCH /v2.2/numbers/{number} — move to another account.
+    # Body for PATCH /v2.2/numbers/{number} — move to another account. route
+    # is the global route type on the destination account: 1 USER, 2 T30,
+    # 3 VOICE_BRIDGE, 4 DID (default), 5 T38, 6 VOICEML, 8 SDN, 9 MOBILE.
     NumberMoveRequest = Data.define(:account_id, :route) do
       include Request
     end
@@ -73,7 +79,9 @@ module VoiceTel
 
     # ------------------------------------------------- entities & data ---
     # Per-number routing / feature state. Returned by GET /v2.2/numbers and
-    # GET /v2.2/numbers/{number}.
+    # GET /v2.2/numbers/{number}. route is the global route type: 1 USER,
+    # 2 T30, 3 VOICE_BRIDGE, 4 DID (default), 5 T38, 6 VOICEML, 8 SDN,
+    # 9 MOBILE.
     NumberDetail = Data.define(
       :number, :translated, :route, :gateway, :cnam, :forward, :forward_to, :carrier,
       :sms_enabled, :fax_enabled
@@ -114,7 +122,9 @@ module VoiceTel
       end
     end
 
-    # Data payload from POST /v2.2/numbers.
+    # Data payload from POST /v2.2/numbers. route is the global route type
+    # that was installed: 1 USER, 2 T30, 3 VOICE_BRIDGE, 4 DID (default),
+    # 5 T38, 6 VOICEML, 8 SDN, 9 MOBILE.
     NumberAddData = Data.define(:number, :route) do
       extend Base
     end
@@ -145,12 +155,16 @@ module VoiceTel
       extend Base
     end
 
-    # Data payload from PATCH /v2.2/numbers/{number}.
+    # Data payload from PATCH /v2.2/numbers/{number}. route is the global
+    # route type on the destination account: 1 USER, 2 T30, 3 VOICE_BRIDGE,
+    # 4 DID (default), 5 T38, 6 VOICEML, 8 SDN, 9 MOBILE.
     NumberMoveData = Data.define(:number, :account_id, :route) do
       extend Base
     end
 
-    # Data payload from PUT /v2.2/numbers/{number}/route.
+    # Data payload from PUT /v2.2/numbers/{number}/route. route echoes the
+    # applied global route type: 1 USER, 2 T30, 3 VOICE_BRIDGE, 4 DID
+    # (default), 5 T38, 6 VOICEML, 8 SDN, 9 MOBILE.
     NumberRouteData = Data.define(:number, :route) do
       extend Base
     end
@@ -178,8 +192,8 @@ module VoiceTel
     # sharing record): "B" (assigned synchronously) or "C" (provisioned
     # asynchronously, status "pending").
     #
-    # upstream_cnp_id — CNP ID from the CSP sharing record: SB8TWLO = path
-    # B, BANDW = path C. (Campaigns on path A, SFL9UTQ, are being migrated
+    # upstream_cnp_id — CNP ID from the CSP sharing record: CAMP003 = path
+    # B, BANDW = path C. (Campaigns on path A, CAMP004, are being migrated
     # and take no new numbers.)
     #
     # carrier — outbound carrier id the number routes through once enabled

data/lib/voicetel/version.rb

@@ -2,11 +2,11 @@
 
 module VoiceTel
   # The semantic version of the VoiceTel Ruby SDK. This tracks the API version
-  # it targets (currently v2.2.16).
-  VERSION = "2.2.16"
+  # it targets (currently v2.2.17).
+  VERSION = "2.2.17"
 
   # The VoiceTel REST API version this SDK targets.
-  API_VERSION = "v2.2.16"
+  API_VERSION = "v2.2.17"
 
   # Default production API endpoint.
   DEFAULT_BASE_URL = "https://api.voicetel.com"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: voicetel
 version: !ruby/object:Gem::Version
-  version: 2.2.16
+  version: 2.2.17
 platform: ruby
 authors:
 - VoiceTel