didww-v3 6.1.1 → 6.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d834eeacdcc690b1b19e390a31730342681b1efe94d1e5f124d9b8c82d9ba5ca
-  data.tar.gz: 694e8a57d08a8cd646d715d424a1824aff726b3af40190db4749417de158c3ca
+  metadata.gz: b1101871e7a9f40f264d7d9bfc1f3ab0f51c398fcdcc4a4154b9d8c9f061dfe5
+  data.tar.gz: 4a35ff675a731bb3d886dcbab60d0f112cbad2b8d96f1593b54f1f76c9547581
 SHA512:
-  metadata.gz: 0565f13367337588e62fadcc5464a3aaea268567b8b7af51e1c0f1b221027be039f242d1fae74e3a1b8980edff2add2cd394055b7e4c30a4bc453c0e39e15288
-  data.tar.gz: 44ceb7b1488be5a77b1d1b15a3ed45fd963a09e280941a5a14a7476fa331355ac81768974149aab51d44a38fe1d0f2717fb8fd38fd456704e6e9ccbe505d9879
+  metadata.gz: 49177d8bca07e63922c22b70501adbfd1000703532a55f4e3fae242dd9d61ddac874cfb0bf9182a36ab337b0dc68e08e017fa74553f8e220e2bc6f9a06e13068
+  data.tar.gz: da7bda7235b89f0024510a9824ba38ffffeb2fd8ce9de85c33ce319b8d7c3cb1c44f3a5672597496ebcbcb2faf69a9467b228b921ef508537be16467f324a120

data/.github/workflows/tests.yml

@@ -15,7 +15,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby: [ '3.3', '3.4' ]
+        ruby: [ '3.3', '3.4', '4.0' ]
         rails: [ '~> 7.2', '~> 8.0', '~> 8.1' ]
     name: Tests with Ruby ${{ matrix.ruby }} Activesupport ${{ matrix.rails }}
     env:

data/CHANGELOG.md

@@ -4,6 +4,18 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [6.2.1] - 2026-10-07
+### Changed
+- `DIDWW::Callback::RequestValidator` is keyed with the callback secret enabled in the DIDWW User Panel (**APIs → DIDWW API 3 → Callback Secrets**); its constructor argument is renamed to `callback_secret`. The argument is positional, so existing code keeps working, and the signature algorithm is unchanged.
+
+## [6.2.0] - 2026-06-14
+### Added
+- `VoiceOutTrunk#rtp_ping` (boolean) — exposes the outbound trunk RTP ping toggle.
+- `DidReservation#description` (string) — customer-supplied note attached to a reservation.
+
+### Changed
+- Relaxed the `json_api_client` dependency from the exact pin `1.23.0` to `~> 1.23`, allowing `1.24.0`. This unblocks installation on **Ruby 4.0**: the old exact pin transitively forced `faraday-gzip < 3.0`, whose `required_ruby_version < 4` made bundler resolution fail on Ruby 4. `json_api_client 1.24.0` raised the cap to `faraday-gzip < 4.0` (allowing `3.x`, which supports Ruby 4). CI now exercises Ruby 4.0 against activesupport 7.2 / 8.0 / 8.1. (#89)
+
 ## [6.1.1] - 2026-05-04
 ### Fixed
 - `SipConfiguration#enabled_sip_registration = true` now always emits `host: null` and `port: null` on the wire, not only when the local attribute hash already had them set. The previous conditional cascade (introduced in 6.1.0) silently no-op'd when re-enabling SIP registration on an existing trunk through a fresh `SipConfiguration` instance: the PATCH body carried only `enabled_sip_registration: true`, the server merged it with the trunk's persisted host, and rejected with 422 (`host must be blank when the SIP registration is enabled`). Verified end-to-end against the live sandbox via the new `examples/voice_in_trunk_sip_registration.rb`.

data/FILTERS.md

@@ -0,0 +1,258 @@
+# DIDWW 2026-04-16 — Server-side filter reference
+
+This is the canonical list of `filter[KEY]` query parameters accepted by each list endpoint of the DIDWW API at version `2026-04-16` — the default API version targeted by this SDK.
+
+The SDK passes filters through as untyped string→string maps (e.g. `DIDWW::Client.regions.where(iso: "US")`), so this document is the authoritative source for which keys actually do something on the server.
+
+Every key listed here was verified live against the DIDWW API at version `2026-04-16`.
+
+Pass values URL-encoded as strings. Where the server accepts arrays, comma-separate the values.
+
+## AddressRequirement — `GET /v3/address_requirements`
+
+- `filter[country.id]`
+- `filter[did_group_type.id]`
+
+## Address — `GET /v3/addresses`
+
+- `filter[address]`
+- `filter[address_contains]`
+- `filter[area.id]`
+- `filter[city.id]`
+- `filter[city_name]`
+- `filter[city_name_contains]`
+- `filter[country.id]`
+- `filter[description]`
+- `filter[description_contains]`
+- `filter[external_reference_id]`
+- `filter[identity.external_reference_id]`
+- `filter[identity.id]`
+- `filter[postal_code]`
+- `filter[postal_code_contains]`
+
+## AddressVerification — `GET /v3/address_verifications`
+
+- `filter[address.id]`
+- `filter[address.identity.id]`
+- `filter[external_reference_id]`
+- `filter[reference]`
+- `filter[reference_in]`
+- `filter[status]`
+
+## Area — `GET /v3/areas`
+
+- `filter[country.id]`
+- `filter[name]`
+
+## AvailableDid — `GET /v3/available_dids`
+
+- `filter[city.id]`
+- `filter[country.id]`
+- `filter[did_group.features]`
+- `filter[did_group.id]`
+- `filter[did_group.needs_registration]`
+- `filter[did_group_type.id]`
+- `filter[nanpa_prefix.id]`
+- `filter[number_contains]`
+- `filter[region.id]`
+
+## CapacityPool — `GET /v3/capacity_pools`
+
+- `filter[country.id]`
+- `filter[has_unassigned_channels]`
+- `filter[name]`
+
+## City — `GET /v3/cities`
+
+- `filter[area.id]`
+- `filter[country.id]`
+- `filter[is_available]`
+- `filter[name]`
+- `filter[region.id]`
+
+## Country — `GET /v3/countries`
+
+- `filter[is_available]`
+- `filter[iso]`
+- `filter[name]`
+- `filter[prefix]`
+
+## DidGroup — `GET /v3/did_groups`
+
+- `filter[allow_additional_channels]`
+- `filter[area_name]`
+- `filter[available_dids_enabled]`
+- `filter[city.id]`
+- `filter[country.id]`
+- `filter[did_group_type.id]`
+- `filter[features]`
+- `filter[is_available]`
+- `filter[is_metered]`
+- `filter[meta.total_count_gteq]`
+- `filter[nanpa_prefix.id]`
+- `filter[nanpa_prefix.npanxx]`
+- `filter[needs_registration]`
+- `filter[prefix]`
+- `filter[region.id]`
+
+## DidGroupType — `GET /v3/did_group_types`
+
+- `filter[name]`
+
+## DidHistory — `GET /v3/did_history`
+
+- `filter[action]`
+- `filter[created_at_gteq]`
+- `filter[created_at_lteq]`
+- `filter[did_number]`
+- `filter[method]`
+
+## DidReservation — `GET /v3/did_reservations`
+
+- `filter[description]`
+
+## Did — `GET /v3/dids`
+
+- `filter[address_verification.id]`
+- `filter[awaiting_registration]`
+- `filter[billing_cycles_count]`
+- `filter[blocked]`
+- `filter[capacity_pool.id]`
+- `filter[city.id]`
+- `filter[country.id]`
+- `filter[description]`
+- `filter[did_group.features]`
+- `filter[did_group.id]`
+- `filter[emergency_calling_service.id]`
+- `filter[emergency_enabled]`
+- `filter[number]`
+- `filter[order.id]`
+- `filter[order.reference]`
+- `filter[region.id]`
+- `filter[shared_capacity_group.id]`
+- `filter[terminated]`
+- `filter[voice_in_trunk.id]`
+- `filter[voice_in_trunk_group.id]`
+
+
+## EmergencyCallingService — `GET /v3/emergency_calling_services`
+
+- `filter[address.id]`
+- `filter[country.id]`
+- `filter[did_group_type.id]`
+- `filter[identity.id]`
+- `filter[name]`
+- `filter[reference]`
+- `filter[status]`
+
+## EmergencyRequirement — `GET /v3/emergency_requirements`
+
+- `filter[country.id]`
+- `filter[did_group_type.id]`
+
+## EmergencyVerification — `GET /v3/emergency_verifications`
+
+- `filter[emergency_calling_service.id]`
+- `filter[external_reference_id]`
+- `filter[status]`
+
+## Export — `GET /v3/exports`
+
+- `filter[external_reference_id]`
+
+## Identity — `GET /v3/identities`
+
+- `filter[birth_date]`
+- `filter[company_name]`
+- `filter[company_name_contains]`
+- `filter[company_reg_number]`
+- `filter[company_reg_number_contains]`
+- `filter[country.id]`
+- `filter[description]`
+- `filter[description_contains]`
+- `filter[external_reference_id]`
+- `filter[first_name]`
+- `filter[first_name_contains]`
+- `filter[id_number]`
+- `filter[id_number_contains]`
+- `filter[identity_type]`
+- `filter[last_name]`
+- `filter[last_name_contains]`
+- `filter[personal_tax_id]`
+- `filter[personal_tax_id_contains]`
+- `filter[phone_number]`
+- `filter[phone_number_contains]`
+- `filter[vat_id]`
+- `filter[vat_id_contains]`
+
+## NanpaPrefix — `GET /v3/nanpa_prefixes`
+
+- `filter[country.id]`
+- `filter[did_group.features]`
+- `filter[did_group.is_available]`
+- `filter[npa]`
+- `filter[npanxx]`
+- `filter[nxx]`
+- `filter[region.id]`
+
+## Order — `GET /v3/orders`
+
+- `filter[created_at_gteq]`
+- `filter[created_at_lteq]`
+- `filter[external_reference_id]`
+- `filter[reference]`
+- `filter[status]`
+
+## PermanentSupportingDocument — `GET /v3/permanent_supporting_documents`
+
+- `filter[external_reference_id]`
+
+## Proof — `GET /v3/proofs`
+
+- `filter[external_reference_id]`
+
+## ProofType — `GET /v3/proof_types`
+
+- `filter[entity_type]`
+
+## Region — `GET /v3/regions`
+
+- `filter[country.id]`
+- `filter[iso]`
+- `filter[name]`
+
+## SharedCapacityGroup — `GET /v3/shared_capacity_groups`
+
+- `filter[capacity_pool.id]`
+- `filter[external_reference_id]`
+- `filter[name]`
+
+## SupportingDocumentTemplate — `GET /v3/supporting_document_templates`
+
+- `filter[name]`
+- `filter[name_contains]`
+- `filter[permanent]`
+
+## VoiceInTrunkGroup — `GET /v3/voice_in_trunk_groups`
+
+- `filter[external_reference_id]`
+
+## VoiceInTrunk — `GET /v3/voice_in_trunks`
+
+- `filter[configuration.type]`
+- `filter[external_reference_id]`
+- `filter[name]`
+
+## VoiceOutTrunk — `GET /v3/voice_out_trunks`
+
+- `filter[allow_any_did_as_cli]`
+- `filter[authentication_method.type]`
+- `filter[default_did.id]`
+- `filter[default_dst_action]`
+- `filter[external_reference_id]`
+- `filter[media_encryption_mode]`
+- `filter[name]`
+- `filter[name_contains]`
+- `filter[on_cli_mismatch_action]`
+- `filter[status]`
+- `filter[threshold_reached]`

data/README.md

@@ -361,6 +361,10 @@ recent = DIDWW::Client.did_history
          .all
 ```
 
+## Filter Reference
+
+> See [`FILTERS.md`](FILTERS.md) for the canonical list of `filter[KEY]` keys accepted by every list endpoint, verified live against the DIDWW API at version `2026-04-16`.
+
 ## Error Handling
 
 The SDK uses [json_api_client](https://github.com/JsonApiClient/json_api_client) which raises exceptions for HTTP-level errors. Validation errors from the API are returned on the resource's `errors` collection after a failed `save`.
@@ -438,10 +442,12 @@ See [docs/resource_relationships.md](docs/resource_relationships.md) for a Merma
 
 Validate incoming webhook callbacks from DIDWW using HMAC-SHA1 signature verification.
 
+Initialize the validator with the callback secret that is enabled in the DIDWW User Panel (**APIs → DIDWW API 3 → Callback Secrets**). DIDWW signs every callback with it and sends callbacks only while a callback secret is enabled.
+
 ```ruby
 require 'didww/callback/request_validator'
 
-validator = DIDWW::Callback::RequestValidator.new("YOUR_API_KEY")
+validator = DIDWW::Callback::RequestValidator.new("YOUR_CALLBACK_SECRET")
 
 # In your webhook handler:
 valid = validator.validate(
@@ -460,7 +466,7 @@ class WebhooksController < ApplicationController
   skip_before_action :verify_authenticity_token
 
   def create
-    validator = DIDWW::Callback::RequestValidator.new("YOUR_API_KEY")
+    validator = DIDWW::Callback::RequestValidator.new("YOUR_CALLBACK_SECRET")
     signature = request.headers[DIDWW::Callback::RequestValidator::HEADER]
     params_hash = request.POST
 

data/didww-v3.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'activesupport',     '>= 7.2', '< 9'
   spec.add_dependency 'faraday',           '~> 2.0'
   spec.add_dependency 'faraday-multipart', '~> 1.0'
-  spec.add_dependency 'json_api_client',   '1.23.0'
+  spec.add_dependency 'json_api_client',   '~> 1.23'
   spec.add_dependency 'http',              '~> 5.0'
   spec.add_dependency 'down',              '~> 5.0'
   spec.add_dependency 'openssl-oaep',      '~> 0.1'

data/lib/didww/callback/request_validator.rb

@@ -4,7 +4,7 @@ require 'openssl'
 module DIDWW
   module Callback
     # @example
-    #   validator = DIDWW::Callback::RequestValidator.new(api_key)
+    #   validator = DIDWW::Callback::RequestValidator.new(callback_secret)
     #   uri = request.original_url
     #   if request.post?
     #     # Collect all parameters passed from DIDWW.
@@ -20,8 +20,9 @@ module DIDWW
       DIGEST_ALGO = 'SHA1'
       HEADER = 'X-DIDWW-Signature'
 
-      def initialize(api_key)
-        @api_key = api_key
+      # @param callback_secret [String] the callback secret enabled in the DIDWW User Panel.
+      def initialize(callback_secret)
+        @callback_secret = callback_secret
       end
 
       # @param url [String]
@@ -41,7 +42,7 @@ module DIDWW
       # @return [String] generated signature in URL safe format.
       def valid_signature(url, payload)
         data = normalize_url(url) + normalize_payload(payload)
-        OpenSSL::HMAC.hexdigest(DIGEST_ALGO, @api_key, data)
+        OpenSSL::HMAC.hexdigest(DIGEST_ALGO, @callback_secret, data)
       end
 
       # @param payload [Hash,Array]

data/lib/didww/complex_objects/capacity_order_item.rb

@@ -9,7 +9,7 @@ module DIDWW
       # returned
       property :nrc,                type: :decimal
       property :mrc,                type: :decimal
-      property :propated_mrc,       type: :boolean
+      property :prorated_mrc,       type: :boolean
       property :billed_from,        type: :string
       property :billed_to,          type: :string
     end

data/lib/didww/complex_objects/did_order_item.rb

@@ -15,7 +15,7 @@ module DIDWW
       property :monthly_price,        type: :decimal
       property :nrc,                  type: :decimal
       property :mrc,                  type: :decimal
-      property :propated_mrc,         type: :boolean
+      property :prorated_mrc,         type: :boolean
       property :billed_from,          type: :string
       property :billed_to,            type: :string
       property :did_group_id,         type: :string

data/lib/didww/resource/did_reservation.rb

@@ -12,6 +12,10 @@ module DIDWW
       # Type: DateTime
       # Description: DID reservation created at DateTime.
 
+      property :description, type: :string
+      # Type: String
+      # Description: Customer-supplied note attached to the reservation.
+      # Writable on POST; returned on subsequent GETs.
     end
   end
 end

data/lib/didww/resource/voice_out_trunk.rb

@@ -64,6 +64,7 @@ module DIDWW
       property :media_encryption_mode, type: :string
       property :callback_url, type: :string
       property :force_symmetric_rtp, type: :boolean
+      property :rtp_ping, type: :boolean
       property :allowed_rtp_ips, type: :ip_addresses
 
       # Type: String

data/lib/didww/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module DIDWW
-  VERSION = '6.1.1'.freeze
+  VERSION = '6.2.1'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: didww-v3
 version: !ruby/object:Gem::Version
-  version: 6.1.1
+  version: 6.2.1
 platform: ruby
 authors:
 - Alex Korobeinikov
@@ -61,16 +61,16 @@ dependencies:
   name: json_api_client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.23.0
+        version: '1.23'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.23.0
+        version: '1.23'
 - !ruby/object:Gem::Dependency
   name: http
   requirement: !ruby/object:Gem::Requirement
@@ -128,6 +128,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - CHANGELOG.md
+- FILTERS.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -253,7 +254,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.1
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Ruby client for DIDWW API v3
 test_files: []