voicetel 2.2.15 β†’ 2.2.17

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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 1d9aa845db9fec0ae066769005a079cd2d5fb2ad40845f54b7b2ca38056130e3
4
- data.tar.gz: a0dc00abd681a35831de16412e44b21bcfc47b0abefe4d8f12bbf597b49215a1
3
+ metadata.gz: 437a8240b4ed4d919e23e9ef697a0d3f6e850567e687024c9c77c2323d76d3ef
4
+ data.tar.gz: 7d3da488bc91fe353049d2bd58d575a192b9c324b99f3c961fa50b339641ed07
5
5
  SHA512:
6
- metadata.gz: b0580ab235ec322d2aa77cf6b1c98bd83759b7b4d5b0314933eec483c45673d6a6994dd277f65a57ef00d82f0ee78f093fcb9e27314a285fbf78129f541a54b8
7
- data.tar.gz: 6cb92f76357ffaa3a6df0ab8151566d48129004c2a910cbac3abba574efe33562b5f991032fcfb3180032248bdc83386d30269af19155ba7f72afebcd2f4237a
6
+ metadata.gz: 17bb4b822a0250b2b5d95edb1f2bb020e988cba2e4ab74dc8b198e73af64d393f85355d290926102b4b0e557e86063f997e36487865a13331ac3cb106878e758
7
+ data.tar.gz: 3ab27ba58ecfeb51377e705dc2442d6e1c088e838ac97f6b2b5a749149e133d74ded36bc40614aa0e3db85ab1314de93bbb392273b87eda1bb493e711f0cdd81
data/README.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  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.
4
4
 
5
- ![Version](https://img.shields.io/badge/version-2.2.15-blue)
5
+ ![Version](https://img.shields.io/badge/version-2.2.17-blue)
6
6
  ![Ruby](https://img.shields.io/badge/ruby-3.2%2B-red)
7
7
  ![License](https://img.shields.io/badge/license-MIT-green)
8
8
  ![Coverage](https://img.shields.io/badge/coverage-%E2%89%A585%25-brightgreen)
@@ -33,7 +33,7 @@ The official Ruby client for the [VoiceTel REST API](https://voicetel.com/docs/a
33
33
 
34
34
  ### πŸ” Production-Grade Transport
35
35
  - **Faraday 2.x** with connection pooling, persistent HTTP, and pluggable adapters.
36
- - **Automatic retry** on 429 / 5xx via `faraday-retry`, honoring `Retry-After`.
36
+ - **Automatic retry** on 429 / 5xx via `faraday-retry`, honoring `Retry-After` (capped at 8s).
37
37
  - **Configurable timeouts** per client.
38
38
  - **Bearer auth** managed for you; passwordβ†’key exchange handled by `client.login`.
39
39
  - **Structured ApiError** β€” `:rate_limit`, `:not_found`, `:conflict`, ... pattern-match on a Symbol, or call `err.rate_limit?`.
@@ -64,7 +64,7 @@ gem install voicetel
64
64
  Or in your `Gemfile`:
65
65
 
66
66
  ```ruby
67
- gem "voicetel", "~> 2.2.15"
67
+ gem "voicetel", "~> 2.2.17"
68
68
  ```
69
69
 
70
70
  Requires Ruby 3.2 or later. Tested on 3.2, 3.3, and 3.4.
@@ -77,7 +77,7 @@ require "voicetel"
77
77
  client = VoiceTel::Client.new
78
78
 
79
79
  # Exchange username + password for an API key (one-time per session)
80
- client.login(username: 1_000_000_001, password: "hunter2")
80
+ client.login(username: "1000000001", password: "hunter2")
81
81
 
82
82
  me = client.account.get
83
83
  puts "Balance: $#{me.cash} | Caller ID: #{me.caller_id}"
@@ -93,7 +93,7 @@ Or, if you already have an API key:
93
93
  ```ruby
94
94
  client = VoiceTel::Client.new(api_key: ENV.fetch("VOICETEL_API_KEY"))
95
95
 
96
- coverage = client.i_numbering.coverage(state: "NJ")
96
+ coverage = client.i_numbering.coverage(count_by: "npanxx", npa: "201")
97
97
  coverage.coverage.each do |bucket|
98
98
  puts "#{bucket.npa}-#{bucket.nxx}: #{bucket.count} TNs available"
99
99
  end
@@ -109,7 +109,7 @@ Re-fetch the API key after any password change β€” the old one is invalidated.
109
109
 
110
110
  ```ruby
111
111
  client = VoiceTel::Client.new
112
- key = client.login(username: 1_000_000_001, password: "hunter2")
112
+ key = client.login(username: "1000000001", password: "hunter2")
113
113
  # `key` is the freshly minted bearer; the client already has it installed.
114
114
  ```
115
115
 
@@ -122,24 +122,24 @@ key = client.login(username: 1_000_000_001, password: "hunter2")
122
122
  | `client.authentication` | SIP/HTTP auth mode + password | `client.authentication.update(auth_type: 1)` |
123
123
  | `client.e911` | Records, address validation, provisioning | `client.e911.validate(address1: "...", city: "...", state: "NJ", zip: "07101")` |
124
124
  | `client.gateways` | Termination routes | `client.gateways.list` |
125
- | `client.i_numbering` | Inventory, orders, port-ins | `client.i_numbering.search_inventory(npa: 201)` |
126
- | `client.lookups` | CNAM & LRN dips | `client.lookups.lrn("2015551234", "2012548000")` |
125
+ | `client.i_numbering` | Inventory, orders, port-ins | `client.i_numbering.search_inventory(tn_mask: "201555*")` |
126
+ | `client.lookups` | CNAM & LRN dips | `client.lookups.lrn("2015550123", "2015550100")` |
127
127
  | `client.messaging` | SMS/MMS, 10DLC brands & campaigns, messaging health | `client.messaging.send_message(from_number: "...", to_number: "...", text: "...")` |
128
- | `client.numbers` | All operations on TNs on the account | `client.numbers.assign_campaign("2015551234", campaign_id: "CABC123")` |
128
+ | `client.numbers` | All operations on TNs on the account | `client.numbers.assign_campaign("2015550123", campaign_id: "CABC123")` |
129
129
  | `client.support` | Tickets, replies, attachments | `client.support.create(subject: "...", message: "...")` |
130
130
 
131
131
  Every method that takes a body accepts a plain Ruby Hash with `snake_case` keys; the SDK camelCases them when serializing to JSON:
132
132
 
133
133
  ```ruby
134
134
  client.messaging.send_message(
135
- from_number: "2012548000",
136
- to_number: "2015551234",
135
+ from_number: "2015550100",
136
+ to_number: "2015550123",
137
137
  text: "Your code is 482917"
138
138
  )
139
- # β†’ POST /v2.2/messages { "fromNumber": "2012548000", "toNumber": "2015551234", "text": "Your code is 482917" }
139
+ # β†’ POST /v2.2/messages { "fromNumber": "2015550100", "toNumber": "2015550123", "text": "Your code is 482917" }
140
140
 
141
- client.numbers.assign_campaign("2015551234", campaign_id: "CABC123")
142
- # β†’ PUT /v2.2/numbers/2015551234/messaging-campaign { "campaignId": "CABC123" }
141
+ client.numbers.assign_campaign("2015550123", campaign_id: "CABC123")
142
+ # β†’ PUT /v2.2/numbers/2015550123/messaging-campaign { "campaignId": "CABC123" }
143
143
  ```
144
144
 
145
145
  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.
@@ -181,11 +181,11 @@ These endpoints are limited to **6 requests per hour per IP**:
181
181
  - `account` (`client.account.get`)
182
182
  - `account/cdr` (`client.account.cdr`)
183
183
  - `account/recurring-charges` (`client.account.recurring_charges`)
184
- - `account/payments` (`client.account.payments`)
185
- - `account/registration` (`client.account.registration`)
186
184
  - `account/api-key` (`client.login`)
187
185
 
188
- The SDK automatically retries 429 responses with `Retry-After` honored, up to `max_retries` (default `2`). To raise it:
186
+ `POST /v2.2/messaging/health/check` is separately limited to **30 checks per hour per account**.
187
+
188
+ The SDK automatically retries 429 responses with `Retry-After` honored (capped at 8s), up to `max_retries` (default `2`). To raise it:
189
189
 
190
190
  ```ruby
191
191
  VoiceTel::Client.new(api_key: key, max_retries: 4, timeout: 60)
@@ -221,7 +221,7 @@ gem build voicetel.gemspec
221
221
 
222
222
  ## πŸ™Œ Contributors
223
223
 
224
- - [Michael Mavroudis](https://github.com/mavroudis) β€” Lead Developer
224
+ - [Jane Doe](https://github.com/mavroudis) β€” Lead Developer
225
225
 
226
226
  Contributions welcome. Open an issue describing the change you want to make, or send a pull request against `main`.
227
227
 
@@ -1,5 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
 
3
+ require "date"
3
4
  require "faraday"
4
5
  require "faraday/retry"
5
6
  require "faraday/net_http_persistent"
@@ -20,6 +21,25 @@ module VoiceTel
20
21
  class Transport
21
22
  RETRYABLE_STATUSES = [429, 500, 502, 503, 504].freeze
22
23
 
24
+ # Upper bound (seconds) for any single retry sleep β€” exponential backoff
25
+ # and server-supplied Retry-After / RateLimit-Reset hints alike.
26
+ MAX_RETRY_DELAY = 8
27
+
28
+ # Seconds to honor from a Retry-After / RateLimit-Reset header value
29
+ # (integer seconds or an RFC 2822 date), capped at MAX_RETRY_DELAY.
30
+ # Nil/blank/garbage parses to 0.
31
+ def self.retry_after_seconds(value)
32
+ s = value.to_s
33
+ return 0.0 if s.empty?
34
+
35
+ seconds = begin
36
+ DateTime.rfc2822(s).to_time - Time.now.utc
37
+ rescue ArgumentError
38
+ s.to_f
39
+ end
40
+ [seconds, MAX_RETRY_DELAY].min
41
+ end
42
+
23
43
  attr_reader :base_url, :user_agent, :timeout, :max_retries
24
44
  attr_accessor :api_key
25
45
 
@@ -61,6 +81,10 @@ module VoiceTel
61
81
  raise ApiError.new("voicetel: request timed out: #{e.message}", kind: :unknown)
62
82
  rescue Faraday::ConnectionFailed => e
63
83
  raise ApiError.new("voicetel: connection failed: #{e.message}", kind: :unknown)
84
+ rescue Faraday::SSLError => e
85
+ raise ApiError.new("voicetel: SSL error: #{e.message}", kind: :unknown)
86
+ rescue Faraday::Error => e
87
+ raise ApiError.new("voicetel: transport error: #{e.message}", kind: :unknown)
64
88
  end
65
89
 
66
90
  # Recursively transform a Ruby snake_case key Hash/Array structure into
@@ -106,10 +130,11 @@ module VoiceTel
106
130
  interval: 0.5,
107
131
  interval_randomness: 0.0,
108
132
  backoff_factor: 2,
109
- max_interval: 8,
133
+ max_interval: MAX_RETRY_DELAY,
110
134
  retry_statuses: RETRYABLE_STATUSES,
111
135
  methods: %i[get post put patch delete],
112
- retry_if: ->(env, _exception) { RETRYABLE_STATUSES.include?(env.status) }
136
+ retry_if: ->(env, _exception) { RETRYABLE_STATUSES.include?(env.status) },
137
+ header_parser_block: ->(value) { Transport.retry_after_seconds(value) }
113
138
  }
114
139
  end
115
140
 
@@ -118,7 +143,16 @@ module VoiceTel
118
143
  encoding = response.headers["content-encoding"] || response.headers["Content-Encoding"]
119
144
  return raw unless encoding&.downcase&.include?("gzip")
120
145
 
121
- Zlib::GzipReader.new(StringIO.new(raw)).read
146
+ begin
147
+ Zlib::GzipReader.new(StringIO.new(raw)).read
148
+ rescue Zlib::GzipFile::Error => e
149
+ raise ApiError.new(
150
+ "voicetel: decode gzip response: #{e.message}",
151
+ kind: :unknown,
152
+ status_code: response.status,
153
+ body: raw
154
+ )
155
+ end
122
156
  end
123
157
 
124
158
  def build_headers(require_auth)
@@ -168,9 +202,19 @@ module VoiceTel
168
202
  message = nil
169
203
 
170
204
  if parsed.is_a?(Hash)
171
- code = parsed["code"] || parsed["error"]
172
- message = parsed["message"] || parsed["error"]
205
+ error = parsed["error"]
206
+ if error.is_a?(Hash)
207
+ # Spec envelope: {"status":"error","error":{"code":400,"message":"..."}}
208
+ code = error["code"]
209
+ message = error["message"]
210
+ else
211
+ # Legacy flat shapes: {"code":..,"message":..} or {"error":".."}
212
+ code = parsed["code"] || error
213
+ message = parsed["message"] || error
214
+ end
173
215
  end
216
+ code = nil unless code.is_a?(String) || code.is_a?(Integer)
217
+ message = nil unless message.is_a?(String) && !message.empty?
174
218
  message ||= "HTTP #{status}"
175
219
 
176
220
  ApiError.from_response(status, code, "voicetel: HTTP #{status}: #{message}", parsed || raw)
@@ -156,7 +156,7 @@ module VoiceTel
156
156
 
157
157
  # Data payload from GET /v2.2/account/registration β€” current SIP
158
158
  # registration.
159
- AccountRegistrationData = Data.define(:agent, :uri, :expires) do
159
+ AccountRegistrationData = Data.define(:agent, :uri) do
160
160
  extend Base
161
161
  end
162
162
 
@@ -11,7 +11,9 @@ module VoiceTel
11
11
  include Request
12
12
  end
13
13
 
14
- # Per-number routing override inside OrderCreateRequest.
14
+ # Per-number routing override inside OrderCreateRequest. route is the
15
+ # global route type for numbers in this order: 1 USER, 2 T30,
16
+ # 3 VOICE_BRIDGE, 4 DID (default), 5 T38, 6 VOICEML, 8 SDN, 9 MOBILE.
15
17
  OrderNumberSpec = Data.define(:number, :route) do
16
18
  include Request
17
19
  end
@@ -5,12 +5,16 @@ require_relative "base"
5
5
  module VoiceTel
6
6
  module Models
7
7
  # ------------------------------------------------------------- requests ---
8
- # Body for POST /v2.2/numbers.
8
+ # Body for POST /v2.2/numbers. route is the global route type: 1 USER,
9
+ # 2 T30, 3 VOICE_BRIDGE, 4 DID (default), 5 T38, 6 VOICEML, 8 SDN,
10
+ # 9 MOBILE.
9
11
  NumberAddRequest = Data.define(:number, :route) do
10
12
  include Request
11
13
  end
12
14
 
13
- # Body for PUT /v2.2/numbers/{number}/route.
15
+ # Body for PUT /v2.2/numbers/{number}/route. route is the global route
16
+ # type: 1 USER, 2 T30, 3 VOICE_BRIDGE, 4 DID (default), 5 T38, 6 VOICEML,
17
+ # 8 SDN, 9 MOBILE.
14
18
  NumberRouteRequest = Data.define(:route) do
15
19
  include Request
16
20
  end
@@ -61,7 +65,9 @@ module VoiceTel
61
65
  include Request
62
66
  end
63
67
 
64
- # Body for PATCH /v2.2/numbers/{number} β€” move to another account.
68
+ # Body for PATCH /v2.2/numbers/{number} β€” move to another account. route
69
+ # is the global route type on the destination account: 1 USER, 2 T30,
70
+ # 3 VOICE_BRIDGE, 4 DID (default), 5 T38, 6 VOICEML, 8 SDN, 9 MOBILE.
65
71
  NumberMoveRequest = Data.define(:account_id, :route) do
66
72
  include Request
67
73
  end
@@ -73,7 +79,9 @@ module VoiceTel
73
79
 
74
80
  # ------------------------------------------------- entities & data ---
75
81
  # Per-number routing / feature state. Returned by GET /v2.2/numbers and
76
- # GET /v2.2/numbers/{number}.
82
+ # GET /v2.2/numbers/{number}. route is the global route type: 1 USER,
83
+ # 2 T30, 3 VOICE_BRIDGE, 4 DID (default), 5 T38, 6 VOICEML, 8 SDN,
84
+ # 9 MOBILE.
77
85
  NumberDetail = Data.define(
78
86
  :number, :translated, :route, :gateway, :cnam, :forward, :forward_to, :carrier,
79
87
  :sms_enabled, :fax_enabled
@@ -114,7 +122,9 @@ module VoiceTel
114
122
  end
115
123
  end
116
124
 
117
- # Data payload from POST /v2.2/numbers.
125
+ # Data payload from POST /v2.2/numbers. route is the global route type
126
+ # that was installed: 1 USER, 2 T30, 3 VOICE_BRIDGE, 4 DID (default),
127
+ # 5 T38, 6 VOICEML, 8 SDN, 9 MOBILE.
118
128
  NumberAddData = Data.define(:number, :route) do
119
129
  extend Base
120
130
  end
@@ -145,12 +155,16 @@ module VoiceTel
145
155
  extend Base
146
156
  end
147
157
 
148
- # Data payload from PATCH /v2.2/numbers/{number}.
158
+ # Data payload from PATCH /v2.2/numbers/{number}. route is the global
159
+ # route type on the destination account: 1 USER, 2 T30, 3 VOICE_BRIDGE,
160
+ # 4 DID (default), 5 T38, 6 VOICEML, 8 SDN, 9 MOBILE.
149
161
  NumberMoveData = Data.define(:number, :account_id, :route) do
150
162
  extend Base
151
163
  end
152
164
 
153
- # Data payload from PUT /v2.2/numbers/{number}/route.
165
+ # Data payload from PUT /v2.2/numbers/{number}/route. route echoes the
166
+ # applied global route type: 1 USER, 2 T30, 3 VOICE_BRIDGE, 4 DID
167
+ # (default), 5 T38, 6 VOICEML, 8 SDN, 9 MOBILE.
154
168
  NumberRouteData = Data.define(:number, :route) do
155
169
  extend Base
156
170
  end
@@ -178,8 +192,8 @@ module VoiceTel
178
192
  # sharing record): "B" (assigned synchronously) or "C" (provisioned
179
193
  # asynchronously, status "pending").
180
194
  #
181
- # upstream_cnp_id β€” CNP ID from the CSP sharing record: SB8TWLO = path
182
- # B, BANDW = path C. (Campaigns on path A, SFL9UTQ, are being migrated
195
+ # upstream_cnp_id β€” CNP ID from the CSP sharing record: CAMP003 = path
196
+ # B, BANDW = path C. (Campaigns on path A, CAMP004, are being migrated
183
197
  # and take no new numbers.)
184
198
  #
185
199
  # carrier β€” outbound carrier id the number routes through once enabled
@@ -161,7 +161,7 @@ module VoiceTel
161
161
  end
162
162
 
163
163
  # Data payload from GET /v2.2/support/tickets.
164
- TicketsListData = Data.define(:tickets) do
164
+ TicketsListData = Data.define(:total_count, :tickets) do
165
165
  extend Base
166
166
 
167
167
  def self.nested
@@ -7,7 +7,7 @@ module VoiceTel
7
7
  # AccountService β€” Account tag in the OpenAPI spec.
8
8
  #
9
9
  # Rate-limited endpoints (6 req/hour/IP, shared with Client#login):
10
- # `cdr`, `recurring_charges`, `payments`, `registration`, and `info`.
10
+ # `get` (account info), `cdr`, and `recurring_charges`.
11
11
  class Account < Base
12
12
  # GET /v2.2/account β€” the authenticated account profile.
13
13
  #
@@ -30,11 +30,13 @@ module VoiceTel
30
30
  Models::AccountAddData.build(@transport.request(:post, "/v2.2/account", body: payload(body)))
31
31
  end
32
32
 
33
- # POST /v2.2/accounts β€” public sign-up flow.
33
+ # POST /v2.2/accounts β€” public sign-up flow. No auth required.
34
34
  #
35
35
  # @return [Models::AccountSignupData]
36
36
  def signup(body)
37
- Models::AccountSignupData.build(@transport.request(:post, "/v2.2/accounts", body: payload(body)))
37
+ Models::AccountSignupData.build(
38
+ @transport.request(:post, "/v2.2/accounts", body: payload(body), require_auth: false)
39
+ )
38
40
  end
39
41
 
40
42
  # GET /v2.2/account/cdr β€” call detail records. Rate-limited.
@@ -47,9 +49,11 @@ module VoiceTel
47
49
 
48
50
  # GET /v2.2/account/credits β€” credit history.
49
51
  #
52
+ # @param status [String, nil] optional invoice-status filter: "paid" or "unpaid"
50
53
  # @return [Models::AccountCreditsData]
51
- def credits
52
- Models::AccountCreditsData.build(@transport.request(:get, "/v2.2/account/credits"))
54
+ def credits(status: nil)
55
+ q = compact_query("status" => status)
56
+ Models::AccountCreditsData.build(@transport.request(:get, "/v2.2/account/credits", query: q))
53
57
  end
54
58
 
55
59
  # GET /v2.2/account/recurring-charges β€” active monthly recurring
@@ -60,14 +64,14 @@ module VoiceTel
60
64
  Models::AccountMrcData.build(@transport.request(:get, "/v2.2/account/recurring-charges"))
61
65
  end
62
66
 
63
- # GET /v2.2/account/payments β€” payment history. Rate-limited.
67
+ # GET /v2.2/account/payments β€” payment history.
64
68
  #
65
69
  # @return [Models::AccountPaymentsData]
66
70
  def payments
67
71
  Models::AccountPaymentsData.build(@transport.request(:get, "/v2.2/account/payments"))
68
72
  end
69
73
 
70
- # GET /v2.2/account/registration β€” current SIP registration. Rate-limited.
74
+ # GET /v2.2/account/registration β€” current SIP registration.
71
75
  #
72
76
  # @return [Models::AccountRegistrationData]
73
77
  def registration
@@ -25,11 +25,16 @@ module VoiceTel
25
25
  Models::AclAddData.build(@transport.request(:post, "/v2.2/acl", body: payload(body)))
26
26
  end
27
27
 
28
- # DELETE /v2.2/acl β€” returns 200 with a body, not 204.
28
+ # DELETE /v2.2/acl β€” remove CIDR entries. Returns 200 with a body,
29
+ # not 204. No request body: the entries travel in the `cidrs` query
30
+ # parameter.
29
31
  #
32
+ # @param cidrs [Array<String>, String] CIDR blocks to remove (e.g.
33
+ # ["203.0.113.0/24", "203.0.113.1/32"]) or a comma-separated string
30
34
  # @return [Models::AclRemoveData]
31
- def remove(body)
32
- Models::AclRemoveData.build(@transport.request(:delete, "/v2.2/acl", body: payload(body)))
35
+ def remove(cidrs:)
36
+ q = { "cidrs" => (cidrs.is_a?(Array) ? cidrs.join(",") : cidrs) }
37
+ Models::AclRemoveData.build(@transport.request(:delete, "/v2.2/acl", query: q))
33
38
  end
34
39
  end
35
40
  end
@@ -1,5 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
 
3
+ require "erb"
4
+
3
5
  module VoiceTel
4
6
  module Resources
5
7
  # Shared base for every resource service. Each service receives the
@@ -17,6 +19,13 @@ module VoiceTel
17
19
  hash.reject { |_, v| v.nil? || v == "" }
18
20
  end
19
21
 
22
+ # Percent-encode one URL path segment (RFC 3986: everything outside
23
+ # a-z A-Z 0-9 _ - . ~ is escaped). Used for every interpolated path
24
+ # parameter so user input can't break out of its segment.
25
+ def escape_path(value)
26
+ ERB::Util.url_encode(value.to_s)
27
+ end
28
+
20
29
  # Request bodies accept either a plain Hash (snake_case keys) or a
21
30
  # Models request object; the transport only speaks Hashes.
22
31
  def payload(body)
@@ -35,19 +35,19 @@ module VoiceTel
35
35
  #
36
36
  # @return [Models::E911RecordData]
37
37
  def get(dn)
38
- Models::E911RecordData.build(@transport.request(:get, "/v2.2/e911/#{dn}"))
38
+ Models::E911RecordData.build(@transport.request(:get, "/v2.2/e911/#{escape_path(dn)}"))
39
39
  end
40
40
 
41
41
  # PUT /v2.2/e911/{dn} β€” provision with a previously-validated address.
42
42
  #
43
43
  # @return [Models::E911RecordData]
44
44
  def provision(dn, body)
45
- Models::E911RecordData.build(@transport.request(:put, "/v2.2/e911/#{dn}", body: payload(body)))
45
+ Models::E911RecordData.build(@transport.request(:put, "/v2.2/e911/#{escape_path(dn)}", body: payload(body)))
46
46
  end
47
47
 
48
48
  # DELETE /v2.2/e911/{dn}. Returns nil on 204 No Content.
49
49
  def remove(dn)
50
- @transport.request(:delete, "/v2.2/e911/#{dn}")
50
+ @transport.request(:delete, "/v2.2/e911/#{escape_path(dn)}")
51
51
  end
52
52
  end
53
53
  end
@@ -26,26 +26,26 @@ module VoiceTel
26
26
  #
27
27
  # @return [Models::GatewayEntry]
28
28
  def get(id)
29
- Models::GatewayEntry.build(@transport.request(:get, "/v2.2/gateways/#{id}"))
29
+ Models::GatewayEntry.build(@transport.request(:get, "/v2.2/gateways/#{escape_path(id)}"))
30
30
  end
31
31
 
32
32
  # PUT /v2.2/gateways/{id} β€” update a gateway.
33
33
  #
34
34
  # @return [Models::GatewayEntry]
35
35
  def update(id, body)
36
- Models::GatewayEntry.build(@transport.request(:put, "/v2.2/gateways/#{id}", body: payload(body)))
36
+ Models::GatewayEntry.build(@transport.request(:put, "/v2.2/gateways/#{escape_path(id)}", body: payload(body)))
37
37
  end
38
38
 
39
39
  # DELETE /v2.2/gateways/{id}. Returns nil on 204 No Content.
40
40
  def remove(id)
41
- @transport.request(:delete, "/v2.2/gateways/#{id}")
41
+ @transport.request(:delete, "/v2.2/gateways/#{escape_path(id)}")
42
42
  end
43
43
 
44
44
  # GET /v2.2/gateways/{id}/numbers β€” numbers bound to a gateway.
45
45
  #
46
46
  # @return [Models::GatewayNumbersData]
47
47
  def numbers(id)
48
- Models::GatewayNumbersData.build(@transport.request(:get, "/v2.2/gateways/#{id}/numbers"))
48
+ Models::GatewayNumbersData.build(@transport.request(:get, "/v2.2/gateways/#{escape_path(id)}/numbers"))
49
49
  end
50
50
  end
51
51
  end
@@ -11,20 +11,35 @@ module VoiceTel
11
11
  class INumbering < Base
12
12
  # GET /v2.2/inventory β€” search available TNs.
13
13
  #
14
+ # @param tn_mask [String] prefix or wildcard pattern: "201", "201555", "201555*" (required)
15
+ # @param quantity [Integer, nil] max results, 1-1000 (server default 10)
16
+ # @param province [String, nil] 2-letter US state or Canadian province code
17
+ # @param rate_center [String, nil] rate-center name
18
+ # @param lata [String, nil] LATA code
14
19
  # @return [Models::InventorySearchData]
15
- def search_inventory(npa: nil, nxx: nil, state: nil, ratecenter: nil, contains: nil, endswith: nil, limit: nil)
20
+ def search_inventory(tn_mask:, quantity: nil, province: nil, rate_center: nil, lata: nil)
16
21
  q = compact_query(
17
- "npa" => npa, "nxx" => nxx, "state" => state, "ratecenter" => ratecenter,
18
- "contains" => contains, "endswith" => endswith, "limit" => limit
22
+ "tnMask" => tn_mask, "quantity" => quantity, "province" => province,
23
+ "rateCenter" => rate_center, "lata" => lata
19
24
  )
20
25
  Models::InventorySearchData.build(@transport.request(:get, "/v2.2/inventory", query: q))
21
26
  end
22
27
 
23
28
  # GET /v2.2/inventory/coverage β€” aggregated availability buckets.
24
29
  #
30
+ # @param count_by [String] aggregation dimension: "state", "city",
31
+ # "rateCenter", "npanxx", or "block" (required)
32
+ # @param loc_state [String, nil] state/province code filter (e.g. "NJ")
33
+ # @param city [String, nil] city name filter
34
+ # @param rc_abbre [String, nil] rate-center abbreviation filter
35
+ # @param npa [String, nil] area-code filter (e.g. "201")
36
+ # @param lata [String, nil] LATA code filter
25
37
  # @return [Models::InventoryCoverageData]
26
- def coverage(state: nil, ratecenter: nil)
27
- q = compact_query("state" => state, "ratecenter" => ratecenter)
38
+ def coverage(count_by:, loc_state: nil, city: nil, rc_abbre: nil, npa: nil, lata: nil)
39
+ q = compact_query(
40
+ "countBy" => count_by, "locState" => loc_state, "city" => city,
41
+ "rcAbbre" => rc_abbre, "npa" => npa, "lata" => lata
42
+ )
28
43
  Models::InventoryCoverageData.build(@transport.request(:get, "/v2.2/inventory/coverage", query: q))
29
44
  end
30
45
 
@@ -44,9 +59,10 @@ module VoiceTel
44
59
 
45
60
  # GET /v2.2/ports/{id} β€” detail for one port-in.
46
61
  #
62
+ # @param id [String] port-in record id
47
63
  # @return [Models::PortDetailData]
48
64
  def port(id)
49
- Models::PortDetailData.build(@transport.request(:get, "/v2.2/ports/#{id}"))
65
+ Models::PortDetailData.build(@transport.request(:get, "/v2.2/ports/#{escape_path(id)}"))
50
66
  end
51
67
 
52
68
  # POST /v2.2/ports β€” submit a port-in.
@@ -61,7 +77,7 @@ module VoiceTel
61
77
  #
62
78
  # @return [Models::PortAvailabilityData]
63
79
  def port_availability(number)
64
- Models::PortAvailabilityData.build(@transport.request(:get, "/v2.2/ports/availability/#{number}"))
80
+ Models::PortAvailabilityData.build(@transport.request(:get, "/v2.2/ports/availability/#{escape_path(number)}"))
65
81
  end
66
82
  end
67
83
  end
@@ -12,14 +12,14 @@ module VoiceTel
12
12
  #
13
13
  # @return [Models::CnamData]
14
14
  def cnam(number)
15
- Models::CnamData.build(@transport.request(:get, "/v2.2/cnam/#{number}"))
15
+ Models::CnamData.build(@transport.request(:get, "/v2.2/cnam/#{escape_path(number)}"))
16
16
  end
17
17
 
18
18
  # GET /v2.2/lrn/{number}/{ani} β€” LRN dip.
19
19
  #
20
20
  # @return [Models::LrnLookupData]
21
21
  def lrn(number, ani)
22
- Models::LrnLookupData.build(@transport.request(:get, "/v2.2/lrn/#{number}/#{ani}"))
22
+ Models::LrnLookupData.build(@transport.request(:get, "/v2.2/lrn/#{escape_path(number)}/#{escape_path(ani)}"))
23
23
  end
24
24
  end
25
25
  end
@@ -10,14 +10,18 @@ module VoiceTel
10
10
  # snake_case in your Ruby hash (`from_number`, `to_number`) and the
11
11
  # transport will translate them when serializing.
12
12
  class Messaging < Base
13
- # GET /v2.2/messages β€” fetch message history.
13
+ # GET /v2.2/messages β€” fetch message history for one number.
14
14
  #
15
+ # @param number [String] 10-digit TN whose messages are returned (required)
16
+ # @param from [Integer, nil] unix timestamp range start
17
+ # @param to [Integer, nil] unix timestamp range end
18
+ # @param type [String, nil] "sms", "mms", or "dlr"
15
19
  # @return [Models::MessageHistoryData]
16
- def history(number: nil, start: nil, end_at: nil, type: nil)
20
+ def history(number:, from: nil, to: nil, type: nil)
17
21
  q = compact_query(
18
22
  "number" => number,
19
- "start" => start,
20
- "end" => end_at,
23
+ "from" => from,
24
+ "to" => to,
21
25
  "type" => type
22
26
  )
23
27
  Models::MessageHistoryData.build(@transport.request(:get, "/v2.2/messages", query: q))
@@ -42,9 +46,12 @@ module VoiceTel
42
46
  # GET /v2.2/messaging/campaigns β€” current 10DLC campaign statuses,
43
47
  # including carrier (DCA) review progress per campaign.
44
48
  #
49
+ # @param ids [Array<String>, String] campaign ids (max 100) β€” an array
50
+ # of ids or a comma-separated string
45
51
  # @return [Models::MessagingCampaignStatusData]
46
- def campaign_status
47
- Models::MessagingCampaignStatusData.build(@transport.request(:get, "/v2.2/messaging/campaigns"))
52
+ def campaign_status(ids:)
53
+ q = { "ids" => (ids.is_a?(Array) ? ids.join(",") : ids) }
54
+ Models::MessagingCampaignStatusData.build(@transport.request(:get, "/v2.2/messaging/campaigns", query: q))
48
55
  end
49
56
 
50
57
  # POST /v2.2/messaging/campaigns β€” register a 10DLC campaign. The body
@@ -59,14 +66,12 @@ module VoiceTel
59
66
  )
60
67
  end
61
68
 
62
- # GET /v2.2/numbers/messaging β€” messaging state for many numbers.
63
- # Pass an empty array (or omit) for "all numbers on the account".
69
+ # GET /v2.2/numbers/messaging β€” messaging state for a set of numbers.
64
70
  #
71
+ # @param numbers [Array<String>] 10-digit TNs (max 1000)
65
72
  # @return [Models::NumbersMessagingListData]
66
- def numbers_state(numbers: nil)
67
- q = compact_query(
68
- "numbers" => (numbers && !numbers.empty? ? Array(numbers).join(",") : nil)
69
- )
73
+ def numbers_state(numbers:)
74
+ q = { "numbers" => Array(numbers).join(",") }
70
75
  Models::NumbersMessagingListData.build(@transport.request(:get, "/v2.2/numbers/messaging", query: q))
71
76
  end
72
77
 
@@ -30,25 +30,25 @@ module VoiceTel
30
30
  #
31
31
  # @return [Models::NumberDetail]
32
32
  def get(number)
33
- Models::NumberDetail.build(@transport.request(:get, "/v2.2/numbers/#{number}"))
33
+ Models::NumberDetail.build(@transport.request(:get, "/v2.2/numbers/#{escape_path(number)}"))
34
34
  end
35
35
 
36
36
  # DELETE /v2.2/numbers/{number}. Returns nil on 204 No Content.
37
37
  def remove(number)
38
- @transport.request(:delete, "/v2.2/numbers/#{number}")
38
+ @transport.request(:delete, "/v2.2/numbers/#{escape_path(number)}")
39
39
  end
40
40
 
41
41
  # PATCH /v2.2/numbers/{number} β€” move a TN to another account.
42
42
  #
43
43
  # @return [Models::NumberMoveData]
44
44
  def move(number, body)
45
- Models::NumberMoveData.build(@transport.request(:patch, "/v2.2/numbers/#{number}", body: payload(body)))
45
+ Models::NumberMoveData.build(@transport.request(:patch, "/v2.2/numbers/#{escape_path(number)}", body: payload(body)))
46
46
  end
47
47
 
48
48
  # POST /v2.2/numbers/{number}/release β€” release a TN back to the
49
49
  # network. Returns nil on 204 No Content.
50
50
  def release(number)
51
- @transport.request(:post, "/v2.2/numbers/#{number}/release")
51
+ @transport.request(:post, "/v2.2/numbers/#{escape_path(number)}/release")
52
52
  end
53
53
 
54
54
  # PUT /v2.2/numbers/{number}/route.
@@ -56,7 +56,7 @@ module VoiceTel
56
56
  # @return [Models::NumberRouteData]
57
57
  def set_route(number, body)
58
58
  Models::NumberRouteData.build(
59
- @transport.request(:put, "/v2.2/numbers/#{number}/route", body: payload(body))
59
+ @transport.request(:put, "/v2.2/numbers/#{escape_path(number)}/route", body: payload(body))
60
60
  )
61
61
  end
62
62
 
@@ -65,7 +65,7 @@ module VoiceTel
65
65
  # @return [Models::NumberTranslationData]
66
66
  def set_translation(number, body)
67
67
  Models::NumberTranslationData.build(
68
- @transport.request(:put, "/v2.2/numbers/#{number}/translation", body: payload(body))
68
+ @transport.request(:put, "/v2.2/numbers/#{escape_path(number)}/translation", body: payload(body))
69
69
  )
70
70
  end
71
71
 
@@ -74,7 +74,7 @@ module VoiceTel
74
74
  # @return [Models::NumberCnamData]
75
75
  def set_cnam(number, body)
76
76
  Models::NumberCnamData.build(
77
- @transport.request(:put, "/v2.2/numbers/#{number}/cnam", body: payload(body))
77
+ @transport.request(:put, "/v2.2/numbers/#{escape_path(number)}/cnam", body: payload(body))
78
78
  )
79
79
  end
80
80
 
@@ -83,7 +83,7 @@ module VoiceTel
83
83
  # @return [Models::NumberLidbData]
84
84
  def set_lidb(number, body)
85
85
  Models::NumberLidbData.build(
86
- @transport.request(:put, "/v2.2/numbers/#{number}/lidb", body: payload(body))
86
+ @transport.request(:put, "/v2.2/numbers/#{escape_path(number)}/lidb", body: payload(body))
87
87
  )
88
88
  end
89
89
 
@@ -91,7 +91,7 @@ module VoiceTel
91
91
  #
92
92
  # @return [Models::NumberFaxData]
93
93
  def get_fax(number)
94
- Models::NumberFaxData.build(@transport.request(:get, "/v2.2/numbers/#{number}/fax"))
94
+ Models::NumberFaxData.build(@transport.request(:get, "/v2.2/numbers/#{escape_path(number)}/fax"))
95
95
  end
96
96
 
97
97
  # PUT /v2.2/numbers/{number}/fax.
@@ -99,13 +99,13 @@ module VoiceTel
99
99
  # @return [Models::NumberFaxData]
100
100
  def set_fax(number, body)
101
101
  Models::NumberFaxData.build(
102
- @transport.request(:put, "/v2.2/numbers/#{number}/fax", body: payload(body))
102
+ @transport.request(:put, "/v2.2/numbers/#{escape_path(number)}/fax", body: payload(body))
103
103
  )
104
104
  end
105
105
 
106
106
  # DELETE /v2.2/numbers/{number}/fax. Returns nil on 204 No Content.
107
107
  def remove_fax(number)
108
- @transport.request(:delete, "/v2.2/numbers/#{number}/fax")
108
+ @transport.request(:delete, "/v2.2/numbers/#{escape_path(number)}/fax")
109
109
  end
110
110
 
111
111
  # PUT /v2.2/numbers/{number}/forward.
@@ -113,20 +113,20 @@ module VoiceTel
113
113
  # @return [Models::NumberForwardData]
114
114
  def set_forward(number, body)
115
115
  Models::NumberForwardData.build(
116
- @transport.request(:put, "/v2.2/numbers/#{number}/forward", body: payload(body))
116
+ @transport.request(:put, "/v2.2/numbers/#{escape_path(number)}/forward", body: payload(body))
117
117
  )
118
118
  end
119
119
 
120
120
  # DELETE /v2.2/numbers/{number}/forward. Returns nil on 204 No Content.
121
121
  def remove_forward(number)
122
- @transport.request(:delete, "/v2.2/numbers/#{number}/forward")
122
+ @transport.request(:delete, "/v2.2/numbers/#{escape_path(number)}/forward")
123
123
  end
124
124
 
125
125
  # GET /v2.2/numbers/{number}/sms.
126
126
  #
127
127
  # @return [Models::NumberSmsData]
128
128
  def get_sms(number)
129
- Models::NumberSmsData.build(@transport.request(:get, "/v2.2/numbers/#{number}/sms"))
129
+ Models::NumberSmsData.build(@transport.request(:get, "/v2.2/numbers/#{escape_path(number)}/sms"))
130
130
  end
131
131
 
132
132
  # PUT /v2.2/numbers/{number}/sms.
@@ -134,13 +134,13 @@ module VoiceTel
134
134
  # @return [Models::NumberSmsData]
135
135
  def set_sms(number, body)
136
136
  Models::NumberSmsData.build(
137
- @transport.request(:put, "/v2.2/numbers/#{number}/sms", body: payload(body))
137
+ @transport.request(:put, "/v2.2/numbers/#{escape_path(number)}/sms", body: payload(body))
138
138
  )
139
139
  end
140
140
 
141
141
  # DELETE /v2.2/numbers/{number}/sms. Returns nil on 204 No Content.
142
142
  def remove_sms(number)
143
- @transport.request(:delete, "/v2.2/numbers/#{number}/sms")
143
+ @transport.request(:delete, "/v2.2/numbers/#{escape_path(number)}/sms")
144
144
  end
145
145
 
146
146
  # GET /v2.2/numbers/{number}/messaging β€” current messaging routing
@@ -149,7 +149,7 @@ module VoiceTel
149
149
  #
150
150
  # @return [Models::NumberMessagingState]
151
151
  def get_messaging(number)
152
- Models::NumberMessagingState.build(@transport.request(:get, "/v2.2/numbers/#{number}/messaging"))
152
+ Models::NumberMessagingState.build(@transport.request(:get, "/v2.2/numbers/#{escape_path(number)}/messaging"))
153
153
  end
154
154
 
155
155
  # PATCH /v2.2/numbers/{number}/messaging β€” update inbound and/or
@@ -158,7 +158,7 @@ module VoiceTel
158
158
  # @return [Models::NumberMessagingPatchData]
159
159
  def patch_messaging(number, body)
160
160
  Models::NumberMessagingPatchData.build(
161
- @transport.request(:patch, "/v2.2/numbers/#{number}/messaging", body: payload(body))
161
+ @transport.request(:patch, "/v2.2/numbers/#{escape_path(number)}/messaging", body: payload(body))
162
162
  )
163
163
  end
164
164
 
@@ -174,27 +174,34 @@ module VoiceTel
174
174
  # @return [Models::NumberMessagingCampaignAssignData]
175
175
  def assign_campaign(number, body)
176
176
  Models::NumberMessagingCampaignAssignData.build(
177
- @transport.request(:put, "/v2.2/numbers/#{number}/messaging-campaign", body: payload(body))
177
+ @transport.request(:put, "/v2.2/numbers/#{escape_path(number)}/messaging-campaign", body: payload(body))
178
178
  )
179
179
  end
180
180
 
181
181
  # DELETE /v2.2/numbers/{number}/messaging-campaign β€” returns 200 with
182
182
  # a body, not 204.
183
183
  #
184
+ # @param number [String] 10-digit TN on the account
185
+ # @param campaign_id [String] TCR campaign id the number is being removed from (required)
184
186
  # @return [Models::NumberMessagingCampaignUnassignData]
185
- def unassign_campaign(number)
187
+ def unassign_campaign(number, campaign_id:)
186
188
  Models::NumberMessagingCampaignUnassignData.build(
187
- @transport.request(:delete, "/v2.2/numbers/#{number}/messaging-campaign")
189
+ @transport.request(:delete, "/v2.2/numbers/#{escape_path(number)}/messaging-campaign",
190
+ query: { "campaignId" => campaign_id })
188
191
  )
189
192
  end
190
193
 
191
194
  # DELETE /v2.2/numbers/messaging-campaign β€” bulk unassign; returns 200
192
- # with a body, not 204.
195
+ # with a body, not 204. No request body: both parameters travel in the
196
+ # query string.
193
197
  #
198
+ # @param numbers [Array<String>] 10-digit TNs to remove (max 1000)
199
+ # @param campaign_id [String] TCR campaign id the numbers are removed from (required)
194
200
  # @return [Models::NumbersMessagingCampaignUnassignData]
195
- def bulk_unassign_campaign(numbers)
201
+ def bulk_unassign_campaign(numbers:, campaign_id:)
202
+ q = { "numbers" => Array(numbers).join(","), "campaignId" => campaign_id }
196
203
  Models::NumbersMessagingCampaignUnassignData.build(
197
- @transport.request(:delete, "/v2.2/numbers/messaging-campaign", body: { numbers: numbers })
204
+ @transport.request(:delete, "/v2.2/numbers/messaging-campaign", query: q)
198
205
  )
199
206
  end
200
207
 
@@ -205,7 +212,7 @@ module VoiceTel
205
212
  # @return [Models::PortOutPinUpdateData]
206
213
  def set_port_out_pin(number, body)
207
214
  Models::PortOutPinUpdateData.build(
208
- @transport.request(:patch, "/v2.2/numbers/#{number}/port-out-pin", body: payload(body))
215
+ @transport.request(:patch, "/v2.2/numbers/#{escape_path(number)}/port-out-pin", body: payload(body))
209
216
  )
210
217
  end
211
218
  end
@@ -30,7 +30,7 @@ module VoiceTel
30
30
  #
31
31
  # @return [Models::TicketData]
32
32
  def get(id)
33
- Models::TicketData.build(@transport.request(:get, "/v2.2/support/tickets/#{id}"))
33
+ Models::TicketData.build(@transport.request(:get, "/v2.2/support/tickets/#{escape_path(id)}"))
34
34
  end
35
35
 
36
36
  # PUT /v2.2/support/tickets/{id} β€” update a ticket.
@@ -38,13 +38,13 @@ module VoiceTel
38
38
  # @return [Models::TicketUpdateData]
39
39
  def update(id, body)
40
40
  Models::TicketUpdateData.build(
41
- @transport.request(:put, "/v2.2/support/tickets/#{id}", body: payload(body))
41
+ @transport.request(:put, "/v2.2/support/tickets/#{escape_path(id)}", body: payload(body))
42
42
  )
43
43
  end
44
44
 
45
45
  # DELETE /v2.2/support/tickets/{id}. Returns nil on 204 No Content.
46
46
  def delete(id)
47
- @transport.request(:delete, "/v2.2/support/tickets/#{id}")
47
+ @transport.request(:delete, "/v2.2/support/tickets/#{escape_path(id)}")
48
48
  end
49
49
 
50
50
  # GET /v2.2/support/tickets/{id}/messages β€” the ticket's threads.
@@ -52,7 +52,7 @@ module VoiceTel
52
52
  # @return [Models::TicketThreadsData]
53
53
  def messages(id)
54
54
  Models::TicketThreadsData.build(
55
- @transport.request(:get, "/v2.2/support/tickets/#{id}/messages")
55
+ @transport.request(:get, "/v2.2/support/tickets/#{escape_path(id)}/messages")
56
56
  )
57
57
  end
58
58
 
@@ -61,7 +61,7 @@ module VoiceTel
61
61
  # @return [Models::TicketReplyData]
62
62
  def reply(id, body)
63
63
  Models::TicketReplyData.build(
64
- @transport.request(:post, "/v2.2/support/tickets/#{id}/replies", body: payload(body))
64
+ @transport.request(:post, "/v2.2/support/tickets/#{escape_path(id)}/replies", body: payload(body))
65
65
  )
66
66
  end
67
67
  end
@@ -2,11 +2,11 @@
2
2
 
3
3
  module VoiceTel
4
4
  # The semantic version of the VoiceTel Ruby SDK. This tracks the API version
5
- # it targets (currently v2.2.15).
6
- VERSION = "2.2.15"
5
+ # it targets (currently v2.2.17).
6
+ VERSION = "2.2.17"
7
7
 
8
8
  # The VoiceTel REST API version this SDK targets.
9
- API_VERSION = "v2.2.15"
9
+ API_VERSION = "v2.2.17"
10
10
 
11
11
  # Default production API endpoint.
12
12
  DEFAULT_BASE_URL = "https://api.voicetel.com"
data/lib/voicetel.rb CHANGED
@@ -46,14 +46,16 @@ module VoiceTel
46
46
  end
47
47
 
48
48
  # Exchange username + password for a 32-hex API key and install it on
49
- # this client. Shares the 6 req/hour/IP rate limit with the rest of the
50
- # account/* endpoints.
49
+ # this client. Shares the 6 req/hour/IP rate limit with the other
50
+ # rate-limited account endpoints (account info, cdr, recurring-charges).
51
51
  #
52
+ # @param username [String] account username (a 10-digit string, e.g. "1000000001")
53
+ # @param password [String] account password
52
54
  # @return [String] the freshly exchanged bearer token
53
55
  def login(username:, password:)
54
56
  data = @transport.request(
55
57
  :post, "/v2.2/account/api-key",
56
- body: { username: username, password: password },
58
+ body: { username: username.to_s, password: password },
57
59
  require_auth: false
58
60
  )
59
61
  key = data.is_a?(Hash) ? data["apikey"] : nil
data/sig/voicetel.rbs CHANGED
@@ -246,7 +246,6 @@ module VoiceTel
246
246
  class AccountRegistrationData
247
247
  attr_reader agent: String?
248
248
  attr_reader uri: String?
249
- attr_reader expires: Integer?
250
249
  def self.build: (untyped payload) -> AccountRegistrationData?
251
250
  end
252
251
 
@@ -683,7 +682,7 @@ module VoiceTel
683
682
  attr_reader destination_number: String?
684
683
  attr_reader direction: String?
685
684
  attr_reader rate: String?
686
- attr_reader number: Integer?
685
+ attr_reader number: String?
687
686
  attr_reader message: String?
688
687
  def self.build: (untyped payload) -> MessageRecordValue?
689
688
  end
@@ -1185,6 +1184,7 @@ module VoiceTel
1185
1184
  end
1186
1185
 
1187
1186
  class TicketsListData
1187
+ attr_reader total_count: Integer?
1188
1188
  attr_reader tickets: Array[SupportConversation]
1189
1189
  def self.build: (untyped payload) -> TicketsListData?
1190
1190
  end
@@ -1209,6 +1209,7 @@ module VoiceTel
1209
1209
  module Internal
1210
1210
  class Transport
1211
1211
  RETRYABLE_STATUSES: Array[Integer]
1212
+ MAX_RETRY_DELAY: Integer
1212
1213
 
1213
1214
  attr_reader base_url: String
1214
1215
  attr_reader user_agent: String
@@ -1216,6 +1217,8 @@ module VoiceTel
1216
1217
  attr_reader max_retries: Integer
1217
1218
  attr_accessor api_key: String?
1218
1219
 
1220
+ def self.retry_after_seconds: (untyped value) -> Float | Integer
1221
+
1219
1222
  def initialize: (
1220
1223
  base_url: String?,
1221
1224
  ?api_key: String?,
@@ -1238,6 +1241,7 @@ module VoiceTel
1238
1241
  class Base
1239
1242
  def initialize: (Internal::Transport transport) -> void
1240
1243
  def compact_query: (Hash[untyped, untyped]) -> Hash[untyped, untyped]
1244
+ def escape_path: (untyped value) -> String
1241
1245
  def payload: (untyped body) -> untyped
1242
1246
  end
1243
1247
 
@@ -1247,7 +1251,7 @@ module VoiceTel
1247
1251
  def add: (untyped body) -> Models::AccountAddData
1248
1252
  def signup: (untyped body) -> Models::AccountSignupData
1249
1253
  def cdr: (?start: untyped?, ?end_at: untyped?) -> Models::AccountCdrData
1250
- def credits: () -> Models::AccountCreditsData
1254
+ def credits: (?status: String?) -> Models::AccountCreditsData
1251
1255
  def recurring_charges: () -> Models::AccountMrcData
1252
1256
  def payments: () -> Models::AccountPaymentsData
1253
1257
  def registration: () -> Models::AccountRegistrationData
@@ -1257,7 +1261,7 @@ module VoiceTel
1257
1261
  class Acl < Base
1258
1262
  def list: () -> Models::AclListData
1259
1263
  def add: (untyped body) -> Models::AclAddData
1260
- def remove: (untyped body) -> Models::AclRemoveData
1264
+ def remove: (cidrs: Array[String] | String) -> Models::AclRemoveData
1261
1265
  end
1262
1266
 
1263
1267
  class Authentication < Base
@@ -1290,13 +1294,16 @@ module VoiceTel
1290
1294
 
1291
1295
  class INumbering < Base
1292
1296
  def search_inventory: (
1293
- ?npa: Integer?, ?nxx: Integer?, ?state: String?, ?ratecenter: String?,
1294
- ?contains: String?, ?endswith: String?, ?limit: Integer?
1297
+ tn_mask: String, ?quantity: Integer?, ?province: String?,
1298
+ ?rate_center: String?, ?lata: Integer?
1295
1299
  ) -> Models::InventorySearchData
1296
- def coverage: (?state: String?, ?ratecenter: String?) -> Models::InventoryCoverageData
1300
+ def coverage: (
1301
+ count_by: String, ?loc_state: String?, ?city: String?,
1302
+ ?rc_abbre: String?, ?npa: String?, ?lata: Integer?
1303
+ ) -> Models::InventoryCoverageData
1297
1304
  def order: (untyped body) -> Models::OrderCreateData
1298
1305
  def ports: () -> Models::PortListData
1299
- def port: (Integer id) -> Models::PortDetailData
1306
+ def port: (String id) -> Models::PortDetailData
1300
1307
  def submit_port: (untyped body) -> Models::PortSubmitData
1301
1308
  def port_availability: (String number) -> Models::PortAvailabilityData
1302
1309
  end
@@ -1307,12 +1314,12 @@ module VoiceTel
1307
1314
  end
1308
1315
 
1309
1316
  class Messaging < Base
1310
- def history: (?number: String?, ?start: Integer?, ?end_at: Integer?, ?type: String?) -> Models::MessageHistoryData
1317
+ def history: (number: String, ?from: Integer?, ?to: Integer?, ?type: String?) -> Models::MessageHistoryData
1311
1318
  def send_message: (untyped body) -> Models::MessageSendData
1312
1319
  def create_brand: (untyped body) -> Models::MessagingBrandCreateData
1313
- def campaign_status: () -> Models::MessagingCampaignStatusData
1320
+ def campaign_status: (ids: Array[String] | String) -> Models::MessagingCampaignStatusData
1314
1321
  def create_campaign: (untyped body) -> Models::MessagingCampaignCreateData
1315
- def numbers_state: (?numbers: Array[String]?) -> Models::NumbersMessagingListData
1322
+ def numbers_state: (numbers: Array[String]) -> Models::NumbersMessagingListData
1316
1323
  end
1317
1324
 
1318
1325
  class Numbers < Base
@@ -1337,8 +1344,8 @@ module VoiceTel
1337
1344
  def get_messaging: (String number) -> Models::NumberMessagingState
1338
1345
  def patch_messaging: (String number, untyped body) -> Models::NumberMessagingPatchData
1339
1346
  def assign_campaign: (String number, untyped body) -> Models::NumberMessagingCampaignAssignData
1340
- def unassign_campaign: (String number) -> Models::NumberMessagingCampaignUnassignData
1341
- def bulk_unassign_campaign: (Array[String] numbers) -> Models::NumbersMessagingCampaignUnassignData
1347
+ def unassign_campaign: (String number, campaign_id: String) -> Models::NumberMessagingCampaignUnassignData
1348
+ def bulk_unassign_campaign: (numbers: Array[String], campaign_id: String) -> Models::NumbersMessagingCampaignUnassignData
1342
1349
  def set_port_out_pin: (String number, untyped body) -> Models::PortOutPinUpdateData
1343
1350
  end
1344
1351
 
@@ -1361,7 +1368,7 @@ module VoiceTel
1361
1368
  ?max_retries: Integer, ?user_agent: String?, ?adapter: Symbol?
1362
1369
  ) -> void
1363
1370
 
1364
- def login: (username: untyped, password: String) -> String
1371
+ def login: (username: String, password: String) -> String
1365
1372
  def api_key: () -> String?
1366
1373
  def base_url: () -> String
1367
1374
 
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: voicetel
3
3
  version: !ruby/object:Gem::Version
4
- version: 2.2.15
4
+ version: 2.2.17
5
5
  platform: ruby
6
6
  authors:
7
7
  - VoiceTel
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2026-10-16 00:00:00.000000000 Z
11
+ date: 2026-10-17 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: faraday