Repository navigation
feat: follow the latest changes of the 2026-10-22 API document - #69
Merged
Merged
Conversation
- Inbound SIP configuration: codecs (Codec names in priority order) replaces codec ids; new iceMode, rtcpMuxMode and rtcpFeedbackMode. - Voice OUT trunks: new codecs (VoiceOutCodec), iceMode, rtcpMuxMode and rtcpFeedbackMode. - Lowercase values: Voice IN trunk Pop, proof type entity_type, export filters service_type (ExportServiceType), trunk_type and status. - DidwwApiException.getRetryAfter() from the Retry-After of the answer, on API calls, export downloads and encrypted file uploads; a 429 is not retried. uploadEncryptedFile throws DidwwApiException on an error status. - Price file and export downloads use a short temp file name, so a long destination name no longer fails. - README, FILTERS.md and examples: requirement mandatory fields, price file columns, migration notes.
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the
 |
There was a problem hiding this comment.
🟢 Approval recommended
The supplied review reports no active issues with the SDK’s API-contract update.
No open issues 🎉
What changed in this PR
Updates the DIDWW Java SDK to match the latest API 2026-10-22 contract, covering trunk media settings, wire values, error handling, and file downloads.
Changes:
- Replaces inbound codec IDs with named codecs, adds outbound codecs and media modes, and aligns enum wire values.
- Exposes
Retry-Afteron API exceptions, standardizes upload errors, and shortens temporary download filenames. - Updates tests, fixtures, documentation, and examples for the revised API behavior.
| File | Description |
|---|---|
src/test/resources/fixtures/voice_out_trunks/update.json |
Adds updated outbound media values. |
src/test/resources/fixtures/voice_out_trunks/update_request.json |
Adds outbound media update payload. |
src/test/resources/fixtures/voice_out_trunks/show.json |
Adds outbound codec and mode response fields. |
src/test/resources/fixtures/voice_out_trunks/show_twilio.json |
Adds media defaults for Twilio authentication. |
src/test/resources/fixtures/voice_out_trunks/show_ip_only.json |
Adds media defaults for IP authentication. |
src/test/resources/fixtures/voice_out_trunks/index.json |
Adds media fields to listed trunks. |
src/test/resources/fixtures/voice_out_trunks/create.json |
Adds media settings to creation response. |
src/test/resources/fixtures/voice_out_trunks/create_twilio.json |
Adds media defaults to Twilio creation response. |
src/test/resources/fixtures/voice_out_trunks/create_request.json |
Adds codecs and modes to creation payload. |
src/test/resources/fixtures/voice_in_trunks/update_sip.json |
Replaces codec IDs and adds media modes. |
src/test/resources/fixtures/voice_in_trunks/update_sip_request.json |
Updates SIP media request fields. |
src/test/resources/fixtures/voice_in_trunks/index.json |
Updates codecs, modes, and lowercase point of presence. |
src/test/resources/fixtures/voice_in_trunks/create_with_pop.json |
Uses lowercase point-of-presence response value. |
src/test/resources/fixtures/voice_in_trunks/create_with_pop_request.json |
Uses lowercase point-of-presence request value. |
src/test/resources/fixtures/voice_in_trunks/create_sip_with_rerouting.json |
Updates SIP codecs and media modes. |
src/test/resources/fixtures/voice_in_trunks/create_sip_with_rerouting_request.json |
Updates SIP creation media payload. |
src/test/resources/fixtures/voice_in_trunk_groups/index.json |
Updates included trunks’ media fields. |
src/test/resources/fixtures/voice_in_trunk_groups/create.json |
Updates grouped trunks’ media fields. |
src/test/resources/fixtures/proofs/create.json |
Uses lowercase proof entity type. |
src/test/resources/fixtures/proof_types/index.json |
Uses lowercase proof entity types. |
src/test/resources/fixtures/exports/create_sms_in.json |
Uses lowercase export trunk filters. |
src/test/resources/fixtures/exports/create_sms_in_request.json |
Updates export filter request values. |
src/test/resources/fixtures/emergency_requirements/show.json |
Uses current mandatory-field names. |
src/test/resources/fixtures/emergency_requirements/index.json |
Aligns mandatory-field names and lists. |
src/test/resources/fixtures/address_requirements/show.json |
Updates mandatory fields and proof entity values. |
src/test/resources/fixtures/address_requirements/index.json |
Uses field names and empty requirement lists. |
src/test/java/com/didww/sdk/TooManyRequestsTest.java |
Tests retry metadata and non-retried 429 responses. |
src/test/java/com/didww/sdk/support/ObservedBody.java |
Adds download-progress observation helper. |
src/test/java/com/didww/sdk/resource/VoiceOutTrunkTest.java |
Tests media settings and codec order. |
src/test/java/com/didww/sdk/resource/VoiceInTrunkTest.java |
Tests named codecs, modes, and removed codec-ID accessors. |
src/test/java/com/didww/sdk/resource/ProofTypeTest.java |
Verifies lowercase proof entity types. |
src/test/java/com/didww/sdk/resource/ExportTest.java |
Tests revised export filter values. |
src/test/java/com/didww/sdk/resource/enums/EnumWireValuesTest.java |
Verifies codec, mode, and filter serialization. |
src/test/java/com/didww/sdk/resource/EmergencyRequirementTest.java |
Verifies revised mandatory-field lists. |
src/test/java/com/didww/sdk/resource/AddressRequirementTest.java |
Verifies mandatory fields and proof entity values. |
src/test/java/com/didww/sdk/prices/PriceFileTest.java |
Tests short temporary names and long destinations. |
src/test/java/com/didww/sdk/prices/PriceFileReaderTest.java |
Aligns CSV column expectations. |
src/test/java/com/didww/sdk/ExportDownloadTest.java |
Tests long export destination filenames. |
src/test/java/com/didww/sdk/EncryptedFileUploadTest.java |
Expects API exceptions for upload error statuses. |
src/main/java/com/didww/sdk/resource/VoiceOutTrunk.java |
Adds codecs and tracked media-mode setters. |
src/main/java/com/didww/sdk/resource/ProofType.java |
Documents lowercase entity types. |
src/main/java/com/didww/sdk/resource/Identity.java |
Documents the requirement tax_id mapping. |
src/main/java/com/didww/sdk/resource/Export.java |
Documents enum filters and current wire values. |
src/main/java/com/didww/sdk/resource/enums/VoiceOutCodec.java |
Defines outbound codec wire values. |
src/main/java/com/didww/sdk/resource/enums/RtcpMuxMode.java |
Defines RTCP multiplexing modes. |
src/main/java/com/didww/sdk/resource/enums/RtcpFeedbackMode.java |
Defines RTCP feedback modes. |
src/main/java/com/didww/sdk/resource/enums/Pop.java |
Serializes point-of-presence values in lowercase. |
src/main/java/com/didww/sdk/resource/enums/IceMode.java |
Defines ICE negotiation modes. |
src/main/java/com/didww/sdk/resource/enums/ExportTrunkType.java |
Updates wire values and renames the email constant. |
src/main/java/com/didww/sdk/resource/enums/ExportServiceType.java |
Defines SMS export service types. |
src/main/java/com/didww/sdk/resource/enums/Codec.java |
Replaces integer codec values with names. |
src/main/java/com/didww/sdk/resource/EmergencyRequirement.java |
Documents current mandatory-field names. |
src/main/java/com/didww/sdk/resource/configuration/SipConfiguration.java |
Replaces codec IDs and adds media modes. |
src/main/java/com/didww/sdk/resource/AddressRequirement.java |
Documents mandatory-field names and tax mapping. |
src/main/java/com/didww/sdk/repository/ReadOnlyRepository.java |
Carries retry metadata into API exceptions. |
src/main/java/com/didww/sdk/prices/PricesService.java |
Shares retry parsing and documents temporary filenames. |
src/main/java/com/didww/sdk/prices/PriceFileReader.java |
Updates documented CSV header examples. |
src/main/java/com/didww/sdk/internal/RetryAfter.java |
Centralizes seconds-based retry-header parsing. |
src/main/java/com/didww/sdk/internal/AtomicFile.java |
Uses fixed-length temporary filenames. |
src/main/java/com/didww/sdk/exception/DidwwApiException.java |
Adds retry duration constructors and accessor. |
src/main/java/com/didww/sdk/DidwwClient.java |
Standardizes upload errors and exposes retry metadata. |
README.md |
Updates API usage, migration, and error guidance. |
FILTERS.md |
Documents current proof and export filter values. |
examples/src/main/java/com/didww/examples/VoiceOutTrunksExample.java |
Demonstrates outbound codecs and ICE. |
examples/src/main/java/com/didww/examples/VoiceInTrunkSipRegistrationExample.java |
Uses the named-codec setter. |
examples/src/main/java/com/didww/examples/VoiceInTrunkGroupsExample.java |
Updates grouped SIP trunk codec configuration. |
examples/src/main/java/com/didww/examples/TrunksExample.java |
Demonstrates named codecs and ICE. |
examples/src/main/java/com/didww/examples/PricesDownloadExample.java |
Reads the current Rate column. |
examples/src/main/java/com/didww/examples/IdentityAddressProofsExample.java |
Selects proof types using lowercase values. |
examples/src/main/java/com/didww/examples/ExportsSmsExample.java |
Demonstrates typed export filters. |
examples/src/main/java/com/didww/examples/EmergencyRequirementsExample.java |
Displays all mandatory-field lists. |
examples/src/main/java/com/didww/examples/DidTrunkAssignmentExample.java |
Uses the named-codec setter. |
examples/README.md |
Updates trunk example descriptions. |
Review effort: Balanced
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Brings the SDK level with the latest changes of the 2026-10-22 API document.
What changes
Trunk media
SipConfiguration:codecs(List<Codec>, codec names in priority order) replaces the codec ids. NewiceMode,rtcpMuxModeandrtcpFeedbackMode(DISABLED,ACCEPT,INITIATE).VoiceOutTrunk: newcodecs(List<VoiceOutCodec>, its own list),iceMode,rtcpMuxModeandrtcpFeedbackMode, on read, create and update.Lowercase values
Pop:nyc,fra,lac,mia,sg,hk,ams.entity_type:address,business,personal.ExportServiceType(a2p,p2p);ExportTrunkTypevalues aresmpp_smsc,smpp_esme,sms_to_email,http_in(EMAILis nowSMS_TO_EMAIL);statusvalues are snake_case. SDK enum constants in the filters map are sent as their wire values.Rate limit
DidwwApiException.getRetryAfter()is theRetry-Afterof the answer, on API calls, export downloads anduploadEncryptedFile. A 429 is not retried automatically: checkgetHttpStatus() == 429and waitgetRetryAfter().uploadEncryptedFilethrowsDidwwApiExceptionon an error status instead ofDidwwClientException.Files
Pathwrite to.didww-<hex>.tmpin the destination directory, so a long destination name no longer fails.Docs and examples
tax_idinstead ofvat_id; price file columnsRate,Connection fee,Price;FILTERS.mdlists theentity_typeand export filter values; the migration section and "New in 5.0.0" cover these changes.Checks
./gradlew test javadoc compileExamplesJavaon Java 11: 764 tests, 0 failures.Popin lowercase, proof types and requirement fields in the new form, and a burst of requests answered withDidwwApiException429 carryinggetRetryAfter().