voicetel 2.2.14 → 2.2.15

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: cd5f5ccd7a80002a64926f5f66347782ab00b632e69d2f95edd362f0c92b6b92
4
- data.tar.gz: '096b5af3dad422f37189da7840bd343278ea2c2302a9a353b0d9a83f03b71709'
3
+ metadata.gz: 1d9aa845db9fec0ae066769005a079cd2d5fb2ad40845f54b7b2ca38056130e3
4
+ data.tar.gz: a0dc00abd681a35831de16412e44b21bcfc47b0abefe4d8f12bbf597b49215a1
5
5
  SHA512:
6
- metadata.gz: '088e89700e06dad3a4be905b29b7588cd70db76d574fbc25be78ec764f7873bdfe87d15edc07a028579b8aa978e704c711d795faab285375f749cfb33bcfb3e0'
7
- data.tar.gz: e1439a7218f43a85bb60bcab70f3d7ff191a4af727336412cb7a6e440a0a2a4738efb717cbaf2a0cae35f8d751d360aa9252d2d26ca023b016daa4ba647ba829
6
+ metadata.gz: b0580ab235ec322d2aa77cf6b1c98bd83759b7b4d5b0314933eec483c45673d6a6994dd277f65a57ef00d82f0ee78f093fcb9e27314a285fbf78129f541a54b8
7
+ data.tar.gz: 6cb92f76357ffaa3a6df0ab8151566d48129004c2a910cbac3abba574efe33562b5f991032fcfb3180032248bdc83386d30269af19155ba7f72afebcd2f4237a
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.14-blue)
5
+ ![Version](https://img.shields.io/badge/version-2.2.15-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)
@@ -43,7 +43,7 @@ The official Ruby client for the [VoiceTel REST API](https://voicetel.com/docs/a
43
43
  - **Account** — profile, sub-accounts, CDRs, credits, payments, MRC, registration, password recovery.
44
44
  - **e911** — record provisioning, address validation, lookup, removal.
45
45
  - **Gateways** — list, create, update, delete, view bound numbers.
46
- - **Messaging** — SMS & MMS sending, message history, 10DLC brand and campaign registration, per-number messaging state.
46
+ - **Messaging** — SMS & MMS sending, message history, 10DLC brand and campaign registration, per-number messaging state, and messaging health (account overview, per-number live check, spam-blocked samples, alert-email setting).
47
47
  - **Lookups** — CNAM and LRN dips.
48
48
  - **iNumbering** — inventory search, coverage queries, number orders, port-in submissions, port-out availability checks (v2.2.10 LRN + rate-center tier fields).
49
49
  - **Support** — ticket create / read / update / delete, threaded messages, replies.
@@ -64,7 +64,7 @@ gem install voicetel
64
64
  Or in your `Gemfile`:
65
65
 
66
66
  ```ruby
67
- gem "voicetel", "~> 2.2.14"
67
+ gem "voicetel", "~> 2.2.15"
68
68
  ```
69
69
 
70
70
  Requires Ruby 3.2 or later. Tested on 3.2, 3.3, and 3.4.
@@ -124,7 +124,7 @@ key = client.login(username: 1_000_000_001, password: "hunter2")
124
124
  | `client.gateways` | Termination routes | `client.gateways.list` |
125
125
  | `client.i_numbering` | Inventory, orders, port-ins | `client.i_numbering.search_inventory(npa: 201)` |
126
126
  | `client.lookups` | CNAM & LRN dips | `client.lookups.lrn("2015551234", "2012548000")` |
127
- | `client.messaging` | SMS/MMS, 10DLC brands & campaigns | `client.messaging.send_message(from_number: "...", to_number: "...", text: "...")` |
127
+ | `client.messaging` | SMS/MMS, 10DLC brands & campaigns, messaging health | `client.messaging.send_message(from_number: "...", to_number: "...", text: "...")` |
128
128
  | `client.numbers` | All operations on TNs on the account | `client.numbers.assign_campaign("2015551234", campaign_id: "CABC123")` |
129
129
  | `client.support` | Tickets, replies, attachments | `client.support.create(subject: "...", message: "...")` |
130
130
 
@@ -178,7 +178,7 @@ end
178
178
 
179
179
  These endpoints are limited to **6 requests per hour per IP**:
180
180
 
181
- - `account/info` (`client.account.get`)
181
+ - `account` (`client.account.get`)
182
182
  - `account/cdr` (`client.account.cdr`)
183
183
  - `account/recurring-charges` (`client.account.recurring_charges`)
184
184
  - `account/payments` (`client.account.payments`)
@@ -69,6 +69,73 @@ module VoiceTel
69
69
  )
70
70
  Models::NumbersMessagingListData.build(@transport.request(:get, "/v2.2/numbers/messaging", query: q))
71
71
  end
72
+
73
+ # GET /v2.2/messaging/health — account-wide messaging health overview.
74
+ #
75
+ # Mirrors the portal Messaging tab: summary counts (numbers, messaging on,
76
+ # healthy, needing attention, in progress), campaigns with carrier-review
77
+ # progress, numbers needing attention (each with a plain-language title,
78
+ # detail and the actions that fix it), 14 days of delivery counts, and the
79
+ # alert-email setting. Updated hourly.
80
+ #
81
+ # The spec defines no response schema for this endpoint, so the unwrapped
82
+ # JSON payload is returned verbatim as a raw Hash (no typed model).
83
+ #
84
+ # @return [Hash]
85
+ def health
86
+ @transport.request(:get, "/v2.2/messaging/health")
87
+ end
88
+
89
+ # GET /v2.2/messaging/health/alerts — the alert-email setting: whether new
90
+ # messaging problems are emailed to the account.
91
+ #
92
+ # The spec defines no response schema, so the unwrapped payload is returned
93
+ # verbatim as a raw Hash.
94
+ #
95
+ # @return [Hash]
96
+ def health_alerts
97
+ @transport.request(:get, "/v2.2/messaging/health/alerts")
98
+ end
99
+
100
+ # PUT /v2.2/messaging/health/alerts — turn alert emails on or off. When
101
+ # enabled, the account is emailed as new messaging problems are found (at
102
+ # most one digest about every 20 hours).
103
+ #
104
+ # The spec defines no response schema, so the unwrapped payload is returned
105
+ # verbatim as a raw Hash.
106
+ #
107
+ # @param enabled [Boolean]
108
+ # @return [Hash]
109
+ def set_health_alerts(enabled:)
110
+ @transport.request(:put, "/v2.2/messaging/health/alerts", body: { enabled: enabled })
111
+ end
112
+
113
+ # POST /v2.2/messaging/health/check — live health check of one number: in
114
+ # service, messaging enabled, campaign approved, assigned to the campaign by
115
+ # the messaging provider, delivery failures in the last 24 hours, and
116
+ # enablement in progress. Limited to 30 checks per hour per account.
117
+ #
118
+ # The spec defines no response schema, so the unwrapped payload is returned
119
+ # verbatim as a raw Hash.
120
+ #
121
+ # @param number [String] 10-digit number on the account
122
+ # @return [Hash]
123
+ def health_check(number:)
124
+ @transport.request(:post, "/v2.2/messaging/health/check", body: { number: number })
125
+ end
126
+
127
+ # GET /v2.2/messaging/health/samples — up to 3 recent outbound messages from
128
+ # the number that carriers blocked as spam (time, masked recipient, text,
129
+ # reason), to help review content.
130
+ #
131
+ # The spec defines no response schema, so the unwrapped payload is returned
132
+ # verbatim (raw Hash or Array).
133
+ #
134
+ # @param number [String] 10-digit number on the account
135
+ # @return [Hash, Array]
136
+ def health_samples(number:)
137
+ @transport.request(:get, "/v2.2/messaging/health/samples", query: { number: number })
138
+ end
72
139
  end
73
140
  end
74
141
  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.14).
6
- VERSION = "2.2.14"
5
+ # it targets (currently v2.2.15).
6
+ VERSION = "2.2.15"
7
7
 
8
8
  # The VoiceTel REST API version this SDK targets.
9
- API_VERSION = "v2.2.14"
9
+ API_VERSION = "v2.2.15"
10
10
 
11
11
  # Default production API endpoint.
12
12
  DEFAULT_BASE_URL = "https://api.voicetel.com"
data/voicetel.gemspec CHANGED
@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
8
8
  spec.authors = ["VoiceTel"]
9
9
  spec.email = ["support@voicetel.com"]
10
10
 
11
- spec.summary = "Official Ruby SDK for the VoiceTel REST API (v2.2.14)."
11
+ spec.summary = "Official Ruby SDK for the VoiceTel REST API (v2.2.15)."
12
12
  spec.description = "Idiomatic Ruby client for the VoiceTel REST API: provision numbers, " \
13
13
  "place orders, validate e911, send SMS/MMS, manage 10DLC campaigns, and " \
14
14
  "run support tickets, all with typed Data models, structured errors, and " \
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.14
4
+ version: 2.2.15
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-14 00:00:00.000000000 Z
11
+ date: 2026-10-16 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: faraday
@@ -121,5 +121,5 @@ requirements: []
121
121
  rubygems_version: 3.4.19
122
122
  signing_key:
123
123
  specification_version: 4
124
- summary: Official Ruby SDK for the VoiceTel REST API (v2.2.14).
124
+ summary: Official Ruby SDK for the VoiceTel REST API (v2.2.15).
125
125
  test_files: []