Skip to content

Commit

Permalink
fix javadoc warnings
Browse files Browse the repository at this point in the history
  • Loading branch information
ckoegel committed Aug 15, 2024
1 parent 3cf7d2e commit c622ebc
Show file tree
Hide file tree
Showing 12 changed files with 136 additions and 135 deletions.
12 changes: 6 additions & 6 deletions src/main/java/com/bandwidth/sdk/model/bxml/Ring.java
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,13 @@
@Builder
@Getter
@EqualsAndHashCode
/**
*
* @param duration (double, optional): How many seconds to play ringing on the call. Default value is 5. Range: decimal values between 0.1 - 86400.
* @param answerCall (bool, optional): A boolean indicating whether or not to answer the call when Ring is executed on an unanswered incoming call. Default value is 'true'.
*
*/
public class Ring implements Verb {
/**
*
* @param duration (double, optional): How many seconds to play ringing on the call. Default value is 5. Range: decimal values between 0.1 - 86400.
* @param answerCall (bool, optional): A boolean indicating whether or not to answer the call when Ring is executed on an unanswered incoming call. Default value is 'true'.
*
*/

public static final String TYPE_NAME = "Ring";

Expand Down
14 changes: 7 additions & 7 deletions src/main/java/com/bandwidth/sdk/model/bxml/SendDtmf.java
Original file line number Diff line number Diff line change
Expand Up @@ -28,14 +28,14 @@
@Builder
@Getter
@EqualsAndHashCode
/**
*
* @param digits (str): String containing the DTMF characters to be sent in a call. Allows a maximum of 50 characters. The digits will be sent one-by-one with a marginal delay.
* @param toneDuration (int, optional): The length (in milliseconds) of each DTMF tone. Default value is 200. Range: decimal values between 50 - 5000.
* @param toneInterval (int, optional): The duration of silence (in milliseconds) following each DTMF tone. Default value is 400. Range: decimal values between 50 - 5000.
*
*/
public class SendDtmf implements Verb {
/**
*
* @param digits (str): String containing the DTMF characters to be sent in a call. Allows a maximum of 50 characters. The digits will be sent one-by-one with a marginal delay.
* @param toneDuration (int, optional): The length (in milliseconds) of each DTMF tone. Default value is 200. Range: decimal values between 50 - 5000.
* @param toneInterval (int, optional): The duration of silence (in milliseconds) following each DTMF tone. Default value is 400. Range: decimal values between 50 - 5000.
*
*/

public static final String TYPE_NAME = "SendDtmf";

Expand Down
20 changes: 10 additions & 10 deletions src/main/java/com/bandwidth/sdk/model/bxml/SpeakSentence.java
Original file line number Diff line number Diff line change
Expand Up @@ -30,17 +30,17 @@
@Builder
@Getter
@EqualsAndHashCode
/**
*
* @param text (str): The text to speak. Cannot be blank. Can be a mixture of plain text and SSML tags.
* You can find a list of supported SSML tags here: https://dev.bandwidth.com/docs/voice/bxml/speakSentence/#supported-ssml-tags
* @param voice (str, optional): Selects the voice of the speaker. Consult the voice column in the below table for valid values.
* If the voice attribute is present, gender and locale are ignored. You can find a list of supported voices here: https://dev.bandwidth.com/docs/voice/bxml/speakSentence/#supported-voices
* @param gender (str, optional): Selects the gender of the speaker. Valid values are "male" or "female". Default "female".
* @param locale (str, optional): Selects the locale of the speaker. Consult the locale column in the below table for valid values. Default "en_US"
*
*/
public class SpeakSentence implements AudioProducer {
/**
*
* @param text (str): The text to speak. Cannot be blank. Can be a mixture of plain text and SSML tags.
* You can find a list of supported SSML tags here: https://dev.bandwidth.com/docs/voice/bxml/speakSentence/#supported-ssml-tags
* @param voice (str, optional): Selects the voice of the speaker. Consult the voice column in the below table for valid values.
* If the voice attribute is present, gender and locale are ignored. You can find a list of supported voices here: https://dev.bandwidth.com/docs/voice/bxml/speakSentence/#supported-voices
* @param gender (str, optional): Selects the gender of the speaker. Valid values are "male" or "female". Default "female".
* @param locale (str, optional): Selects the locale of the speaker. Consult the locale column in the below table for valid values. Default "en_US"
*
*/

public static final String TYPE_NAME = "SpeakSentence";

Expand Down
18 changes: 9 additions & 9 deletions src/main/java/com/bandwidth/sdk/model/bxml/StartGather.java
Original file line number Diff line number Diff line change
Expand Up @@ -24,16 +24,16 @@
@Builder
@Getter
@EqualsAndHashCode
/**
*
* @param dtmfUrl (str): URL to send the DTMF event to. May be a relative URL..
* @param dtmfMethod (str, optional): The HTTP method to use for the request to dtmfUrl. GET or POST. Default value is POST. Defaults to None.
* @param username (str, optional): The username to send in the HTTP request to dtmfUrl. Defaults to None.
* @param password (str, optional): The password to send in the HTTP request to dtmfUrl. Defaults to None.
* @param tag (str, optional): A custom string that will be sent with these and all future callbacks unless overwritten by a future tag attribute or cleared. May be cleared by setting tag="" Max length 256 characters. Defaults to None.
*
*/
public class StartGather implements Verb {
/**
*
* @param dtmfUrl (str): URL to send the DTMF event to. May be a relative URL..
* @param dtmfMethod (str, optional): The HTTP method to use for the request to dtmfUrl. GET or POST. Default value is POST. Defaults to None.
* @param username (str, optional): The username to send in the HTTP request to dtmfUrl. Defaults to None.
* @param password (str, optional): The password to send in the HTTP request to dtmfUrl. Defaults to None.
* @param tag (str, optional): A custom string that will be sent with these and all future callbacks unless overwritten by a future tag attribute or cleared. May be cleared by setting tag="" Max length 256 characters. Defaults to None.
*
*/

public static final String TYPE_NAME = "StartGather";

Expand Down
28 changes: 14 additions & 14 deletions src/main/java/com/bandwidth/sdk/model/bxml/StartRecording.java
Original file line number Diff line number Diff line change
Expand Up @@ -25,21 +25,21 @@
@Builder
@Getter
@EqualsAndHashCode
/**
*
* @param recordingAvailableUrl (str, optional): URL to send the Recording Available event to once it has been processed. Does not accept BXML. May be a relative URL. Defaults to None.
* @param recordingAvailableMethod (str, optional): The HTTP method to use for the request to recordingAvailableUrl. GET or POST. Default value is POST.
* @param transcribe (str, optional): A boolean value to indicate that recording should be transcribed. Transcription can succeed only for recordings of length greater than 500 milliseconds and less than 4 hours. Default is false. Defaults to None.
* @param transcriptionAvailableUrl (str, optional): URL to send the Transcription Available event to once it has been processed. Does not accept BXML. May be a relative URL. Defaults to None.
* @param transcriptionAvailableMethod (str, optional): The HTTP method to use for the request to transcriptionAvailableUrl. GET or POST. Default value is POST. Defaults to None.
* @param username (str, optional): The username to send in the HTTP request to recordCompleteUrl, recordingAvailableUrl or transcriptionAvailableUrl. If specified, the URLs must be TLS-encrypted (i.e., https). Defaults to None.
* @param password (str, optional): The password to send in the HTTP request to recordCompleteUrl, recordingAvailableUrl or transcriptionAvailableUrl. If specified, the URLs must be TLS-encrypted (i.e., https). Defaults to None.
* @param tag (str, optional): A custom string that will be sent with this and all future callbacks unless overwritten by a future tag attribute or <Tag> verb, or cleared. May be cleared by setting tag="". Max length 256 characters. Defaults to None.
* @param fileFormat (str, optional): The audio format that the recording will be saved as: mp3 or wav. Default value is wav. Defaults to None. max_duration (str, optional): Maximum length of recording (in seconds). Max 10800 (3 hours). Default value is 60. Defaults to None.
* @param multiChannel (str, optional): A boolean value indicating whether or not the recording file should separate each side of the call into its own audio channel. Default value is false.
*
*/
public class StartRecording implements TranscriptionProducer {
/**
*
* @param recordingAvailableUrl (str, optional): URL to send the Recording Available event to once it has been processed. Does not accept BXML. May be a relative URL. Defaults to None.
* @param recordingAvailableMethod (str, optional): The HTTP method to use for the request to recordingAvailableUrl. GET or POST. Default value is POST.
* @param transcribe (str, optional): A boolean value to indicate that recording should be transcribed. Transcription can succeed only for recordings of length greater than 500 milliseconds and less than 4 hours. Default is false. Defaults to None.
* @param transcriptionAvailableUrl (str, optional): URL to send the Transcription Available event to once it has been processed. Does not accept BXML. May be a relative URL. Defaults to None.
* @param transcriptionAvailableMethod (str, optional): The HTTP method to use for the request to transcriptionAvailableUrl. GET or POST. Default value is POST. Defaults to None.
* @param username (str, optional): The username to send in the HTTP request to recordCompleteUrl, recordingAvailableUrl or transcriptionAvailableUrl. If specified, the URLs must be TLS-encrypted (i.e., https). Defaults to None.
* @param password (str, optional): The password to send in the HTTP request to recordCompleteUrl, recordingAvailableUrl or transcriptionAvailableUrl. If specified, the URLs must be TLS-encrypted (i.e., https). Defaults to None.
* @param tag (str, optional): A custom string that will be sent with this and all future callbacks unless overwritten by a future tag attribute or <Tag> verb, or cleared. May be cleared by setting tag="". Max length 256 characters. Defaults to None.
* @param fileFormat (str, optional): The audio format that the recording will be saved as: mp3 or wav. Default value is wav. Defaults to None. max_duration (str, optional): Maximum length of recording (in seconds). Max 10800 (3 hours). Default value is 60. Defaults to None.
* @param multiChannel (str, optional): A boolean value indicating whether or not the recording file should separate each side of the call into its own audio channel. Default value is false.
*
*/

public static final String TYPE_NAME = "StartRecording";

Expand Down
30 changes: 15 additions & 15 deletions src/main/java/com/bandwidth/sdk/model/bxml/StartStream.java
Original file line number Diff line number Diff line change
Expand Up @@ -31,22 +31,22 @@
@Builder
@Getter
@EqualsAndHashCode
/**
*
* @param name (str, optional): A name to refer to this stream by. Used when sending <StopStream>. If not provided, it will default to the generated stream id as sent in the Media Stream Started webhook.
* @param tracks (str, optional): The part of the call to send a stream from. inbound, outbound or both. Default is inbound.
* @param destination (str, optional): A websocket URI to send the stream to. The audio from the specified tracks will be sent via websocket to this URL as base64-encoded PCMU/G711 audio. See below for more details on the websocket packet format.
* @param streamEventUrl (str, optional): URL to send the associated Webhook events to during this stream's lifetime. Does not accept BXML. May be a relative URL.
* @param streamEventMethod (str, optional): The HTTP method to use for the request to streamEventUrl. GET or POST. Default value is POST.
* @param username (str, optional): The username to send in the HTTP request to streamEventUrl. If specified, the URLs must be TLS-encrypted (i.e., https).
* @param password (str, optional): The password to send in the HTTP request to streamEventUrl. If specified, the URLs must be TLS-encrypted (i.e., https).
*
* Nested Verbs:
* @param StreamParam: (optional) You may specify up to 12 <StreamParam/> elements nested within a <StartStream> tag.
* These elements define optional user specified parameters that will be sent to the destination URL when the stream is first started.
*
*/
public class StartStream implements Verb {
/**
*
* @param name (str, optional): A name to refer to this stream by. Used when sending <StopStream>. If not provided, it will default to the generated stream id as sent in the Media Stream Started webhook.
* @param tracks (str, optional): The part of the call to send a stream from. inbound, outbound or both. Default is inbound.
* @param destination (str, optional): A websocket URI to send the stream to. The audio from the specified tracks will be sent via websocket to this URL as base64-encoded PCMU/G711 audio. See below for more details on the websocket packet format.
* @param streamEventUrl (str, optional): URL to send the associated Webhook events to during this stream's lifetime. Does not accept BXML. May be a relative URL.
* @param streamEventMethod (str, optional): The HTTP method to use for the request to streamEventUrl. GET or POST. Default value is POST.
* @param username (str, optional): The username to send in the HTTP request to streamEventUrl. If specified, the URLs must be TLS-encrypted (i.e., https).
* @param password (str, optional): The password to send in the HTTP request to streamEventUrl. If specified, the URLs must be TLS-encrypted (i.e., https).
*
* Nested Verbs:
* @param StreamParam: (optional) You may specify up to 12 <StreamParam/> elements nested within a <StartStream> tag.
* These elements define optional user specified parameters that will be sent to the destination URL when the stream is first started.
*
*/

public static final String TYPE_NAME = "StartStream";

Expand Down
32 changes: 16 additions & 16 deletions src/main/java/com/bandwidth/sdk/model/bxml/StartTranscription.java
Original file line number Diff line number Diff line change
Expand Up @@ -31,23 +31,23 @@
@Builder
@Getter
@EqualsAndHashCode
/**
*
* @param name (str, optional): A name to refer to this transcription by. Used when sending <StopTranscription>. If not provided, it will default to the generated transcription id as sent in the Real-Time Transcription Started webhook.
* @param tracks (str, optional): The part of the call to send a transcription from. inbound, outbound or both. Default is inbound.
* @param destination (str, optional): A websocket URI to send the stream to. The audio from the specified tracks will be sent via websocket to this URL as base64-encoded PCMU/G711 audio. See below for more details on the websocket packet format.
* @param transcriptionEventUrl (str, optional): URL to send the associated Webhook events to during this real-time transcription's lifetime. Does not accept BXML. May be a relative URL.
* @param transcriptionEventMethod (str, optional): The HTTP method to use for the request to transcriptionEventUrl. GET or POST. Default value is POST.
* @param username (str, optional): The username to send in the HTTP request to transcriptionEventUrl. If specified, the URLs must be TLS-encrypted (i.e., https).
* @param password (str, optional): The password to send in the HTTP request to transcriptionEventUrl. If specified, the URLs must be TLS-encrypted (i.e., https).
* @param stabilized (str, optional): Whether to send transcription update events to the specified destination only after they have become stable. Requires destination. Defaults to true.
*
* Nested Verbs:
* @param CustomParam: (optional) You may specify up to 12 <CustomParam/> elements nested within a <StartTranscription> tag.
* These elements define optional user specified parameters that will be sent to the destination URL when the real-time transcription is first started.
*
*/
public class StartTranscription implements Verb {
/**
*
* @param name (str, optional): A name to refer to this transcription by. Used when sending <StopTranscription>. If not provided, it will default to the generated transcription id as sent in the Real-Time Transcription Started webhook.
* @param tracks (str, optional): The part of the call to send a transcription from. inbound, outbound or both. Default is inbound.
* @param destination (str, optional): A websocket URI to send the stream to. The audio from the specified tracks will be sent via websocket to this URL as base64-encoded PCMU/G711 audio. See below for more details on the websocket packet format.
* @param transcriptionEventUrl (str, optional): URL to send the associated Webhook events to during this real-time transcription's lifetime. Does not accept BXML. May be a relative URL.
* @param transcriptionEventMethod (str, optional): The HTTP method to use for the request to transcriptionEventUrl. GET or POST. Default value is POST.
* @param username (str, optional): The username to send in the HTTP request to transcriptionEventUrl. If specified, the URLs must be TLS-encrypted (i.e., https).
* @param password (str, optional): The password to send in the HTTP request to transcriptionEventUrl. If specified, the URLs must be TLS-encrypted (i.e., https).
* @param stabilized (str, optional): Whether to send transcription update events to the specified destination only after they have become stable. Requires destination. Defaults to true.
*
* Nested Verbs:
* @param CustomParam: (optional) You may specify up to 12 <CustomParam/> elements nested within a <StartTranscription> tag.
* These elements define optional user specified parameters that will be sent to the destination URL when the real-time transcription is first started.
*
*/

public static final String TYPE_NAME = "StartTranscription";

Expand Down
10 changes: 5 additions & 5 deletions src/main/java/com/bandwidth/sdk/model/bxml/StopStream.java
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,12 @@
@Builder
@Getter
@EqualsAndHashCode
/**
*
* @param name (str, optional): The name of the stream to stop.
* This is either the user selected name when sending the <StartStream> verb, or the system generated name returned in the Media Stream Started webhook if <StartStream> was sent with no name attribute.
*/
public class StopStream implements Verb {
/**
*
* @param name (str, optional): The name of the stream to stop.
* This is either the user selected name when sending the <StartStream> verb, or the system generated name returned in the Media Stream Started webhook if <StartStream> was sent with no name attribute.
*/

public static final String TYPE_NAME = "StopStream";

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,12 @@
@Builder
@Getter
@EqualsAndHashCode
/**
*
* @param name (str, optional): The name of the real-time transcription to stop.
* This is either the user selected name when sending the <StartTranscription> verb, or the system generated name returned in the Media Transcription Started webhook if <StartTranscription> was sent with no name attribute.
*/
public class StopTranscription implements Verb {
/**
*
* @param name (str, optional): The name of the real-time transcription to stop.
* This is either the user selected name when sending the <StartTranscription> verb, or the system generated name returned in the Media Transcription Started webhook if <StartTranscription> was sent with no name attribute.
*/

public static final String TYPE_NAME = "StopTranscription";

Expand Down
13 changes: 7 additions & 6 deletions src/main/java/com/bandwidth/sdk/model/bxml/StreamParam.java
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,14 @@
@Builder
@NoArgsConstructor
@AllArgsConstructor
/**
*
* @param name (str): The name of this parameter, up to 256 characters.
* @param value (str): The value of this parameter, up to 2048 characters.
*
*/
public class StreamParam {
/**
*
* @param name (str): The name of this parameter, up to 256 characters.
* @param value (str): The value of this parameter, up to 2048 characters.
*
*/

public static final String TYPE_NAME = "StreamParam";

@XmlAttribute
Expand Down
10 changes: 5 additions & 5 deletions src/main/java/com/bandwidth/sdk/model/bxml/Tag.java
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,12 @@
@Builder
@Getter
@EqualsAndHashCode
/**
*
* @param tag (str, optional): Custom tag value. Defaults to "".
*
*/
public class Tag implements Verb {
/**
*
* @param tag (str, optional): Custom tag value. Defaults to "".
*
*/

public static final String TYPE_NAME = "Tag";

Expand Down
Loading

0 comments on commit c622ebc

Please sign in to comment.