[EN-145] Document custom tracking domains - #548
Open
quzhi1 wants to merge 1 commit into
Open
Conversation
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.
Description
Summary
tracking_options.domain_namehash contract for regular Send.Why
Implements EN-145. The Ruby SDK already forwards hash-based request bodies, so custom tracking hostnames need documented request shapes and regression coverage rather than a new typed model.
Developer impact
Ruby callers can pass an active organization-owned hostname as
tracking_options.domain_namealongsidelinksand/oropens. Requests that omit the field remain unchanged and continue using the default Nylas tracking hostname.The examples also document draft inheritance, scheduled-send revalidation, and the distinction between the Transactional Send route's sender domain and the body field's tracking hostname.
Validation
bundle exec rspec spec- 315 examples, 0 failuresbundle exec rubocop --config .rubocop.yml- 80 files, no offensesbundle exec yard doc --no-output- succeedsgit diff --check- cleanLicense
I confirm that this contribution is made under the terms of the MIT license and that I have the authority necessary to make this contribution on behalf of its copyright owner.