Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: Rename child TwiML methods to be based on tag name and deprecate old methods #508

Merged
merged 4 commits into from
Nov 22, 2019
Merged

fix: Rename child TwiML methods to be based on tag name and deprecate old methods #508

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0c0d915
rename child TwiML methods to be based on tag name and deprecate old …
eshanholtz Nov 21, 2019
be9242a
improve jsdoc deprecated tag description
eshanholtz Nov 21, 2019
de4bbe8
silence deprecation warnings during testing
eshanholtz Nov 21, 2019
b462512
remove duplicate TS interfaces
eshanholtz Nov 21, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
152 changes: 144 additions & 8 deletions lib/twiml/VoiceResponse.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -660,7 +660,7 @@ declare namespace VoiceResponse {
}

/**
* Options to pass to ssmlBreak
* Options to pass to break_
*
* @property strength - Set a pause based on strength
* @property time - Set a pause to a specific length of time in seconds or milliseconds, available values: [number]s, [number]ms
Expand All @@ -671,7 +671,7 @@ declare namespace VoiceResponse {
}

/**
* Options to pass to ssmlEmphasis
* Options to pass to emphasis
*
* @property level - Specify the degree of emphasis
*/
Expand All @@ -680,7 +680,7 @@ declare namespace VoiceResponse {
}

/**
* Options to pass to ssmlLang
* Options to pass to lang
*
* @property xml:lang - Specify the language
*/
Expand All @@ -689,7 +689,7 @@ declare namespace VoiceResponse {
}

/**
* Options to pass to ssmlPhoneme
* Options to pass to phoneme
*
* @property alphabet - Specify the phonetic alphabet
* @property ph - Specifiy the phonetic symbols for pronunciation
Expand All @@ -700,7 +700,7 @@ declare namespace VoiceResponse {
}

/**
* Options to pass to ssmlProsody
* Options to pass to prosody
*
* @property pitch - Specify the pitch, available values: default, x-low, low, medium, high, x-high, +n%, -n%
* @property rate - Specify the rate, available values: x-slow, slow, medium, fast, x-fast, n%
Expand All @@ -713,7 +713,7 @@ declare namespace VoiceResponse {
}

/**
* Options to pass to ssmlSayAs
* Options to pass to sayAs
*
* @property interpret-as - Specify the type of words are spoken
* @property role - Specify the format of the date when interpret-as is set to date
Expand All @@ -724,7 +724,7 @@ declare namespace VoiceResponse {
}

/**
* Options to pass to ssmlSub
* Options to pass to sub
*
* @property alias - Substitute a different word (or pronunciation) for selected text such as an acronym or abbreviation
*/
Expand All @@ -733,7 +733,7 @@ declare namespace VoiceResponse {
}

/**
* Options to pass to ssmlW
* Options to pass to w
*
* @property role - Customize the pronunciation of words by specifying the word’s part of speech or alternate meaning
*/
Expand Down Expand Up @@ -1029,11 +1029,121 @@ declare namespace VoiceResponse {
* @param sipUrl - SIP URL
*/
referSip(attributes: object, sipUrl: string): void;
/**
* <Sip> TwiML Noun used in <Refer>
*
* @param sipUrl - SIP URL
*/
sip(sipUrl: string): void;
/**
* <Sip> TwiML Noun used in <Refer>
*
* @param attributes - TwiML attributes
* @param sipUrl - SIP URL
*/
sip(attributes: object, sipUrl: string): void;
}


class Say {

/**
* Adding a Pause in <Say>
*
* @param attributes - TwiML attributes
*/
break_(attributes?: VoiceResponse.SsmlBreakAttributes): void;
/**
* Emphasizing Words in <Say>
*
* @param words - Words to emphasize
*/
emphasis(words: string): void;
/**
* Emphasizing Words in <Say>
*
* @param attributes - TwiML attributes
* @param words - Words to emphasize
*/
emphasis(attributes: VoiceResponse.SsmlEmphasisAttributes, words: string): void;
/**
* Specifying Another Language for Specific Words in <Say>
*
* @param words - Words to speak
*/
lang(words: string): void;
/**
* Specifying Another Language for Specific Words in <Say>
*
* @param attributes - TwiML attributes
* @param words - Words to speak
*/
lang(attributes: VoiceResponse.SsmlLangAttributes, words: string): void;
/**
* Adding a Pause Between Paragraphs in <Say>
*
* @param words - Words to speak
*/
p(words: string): void;
/**
* Adding a Pause Between Paragraphs in <Say>
*
* @param attributes - TwiML attributes
* @param words - Words to speak
*/
p(attributes: object, words: string): void;
/**
* Using Phonetic Pronunciation in <Say>
*
* @param words - Words to speak
*/
phoneme(words: string): void;
/**
* Using Phonetic Pronunciation in <Say>
*
* @param attributes - TwiML attributes
* @param words - Words to speak
*/
phoneme(attributes: VoiceResponse.SsmlPhonemeAttributes, words: string): void;
/**
* Controling Volume, Speaking Rate, and Pitch in <Say>
*
* @param words - Words to speak
*/
prosody(words: string): void;
/**
* Controling Volume, Speaking Rate, and Pitch in <Say>
*
* @param attributes - TwiML attributes
* @param words - Words to speak
*/
prosody(attributes: VoiceResponse.SsmlProsodyAttributes, words: string): void;
/**
* Adding A Pause Between Sentences in <Say>
*
* @param words - Words to speak
*/
s(words: string): void;
/**
* Adding A Pause Between Sentences in <Say>
*
* @param attributes - TwiML attributes
* @param words - Words to speak
*/
s(attributes: object, words: string): void;
/**
* Controlling How Special Types of Words Are Spoken in <Say>
*
* @param words - Words to be interpreted
*/
sayAs(words: string): void;
/**
* Controlling How Special Types of Words Are Spoken in <Say>
*
* @param attributes - TwiML attributes
* @param words - Words to be interpreted
*/
sayAs(attributes: VoiceResponse.SsmlSayAsAttributes, words: string): void;
/**
* Adding a Pause in <Say>
*
Expand Down Expand Up @@ -1157,6 +1267,32 @@ declare namespace VoiceResponse {
* @param words - Words to speak
*/
ssmlW(attributes: VoiceResponse.SsmlWAttributes, words: string): void;
/**
* Pronouncing Acronyms and Abbreviations in <Say>
*
* @param words - Words to be substituted
*/
sub(words: string): void;
/**
* Pronouncing Acronyms and Abbreviations in <Say>
*
* @param attributes - TwiML attributes
* @param words - Words to be substituted
*/
sub(attributes: VoiceResponse.SsmlSubAttributes, words: string): void;
/**
* Improving Pronunciation by Specifying Parts of Speech in <Say>
*
* @param words - Words to speak
*/
w(words: string): void;
/**
* Improving Pronunciation by Specifying Parts of Speech in <Say>
*
* @param attributes - TwiML attributes
* @param words - Words to speak
*/
w(attributes: VoiceResponse.SsmlWAttributes, words: string): void;
}


Expand Down
Loading