From 110bd41591ade7146f9517b888c3a2d1dad21e51 Mon Sep 17 00:00:00 2001 From: Cameron Koegel <53310569+ckoegel@users.noreply.github.com> Date: Thu, 15 Aug 2024 14:48:41 -0400 Subject: [PATCH] SWI-5869 BXML Library Updates (#151) * move @params to avoid warnings hopefully * bxml formatting changes * add wf dispatch to test wf * not only on main * fix javadoc warnings * formatting * on main only --- .github/workflows/test-pr.yml | 1 + .../com/bandwidth/sdk/model/bxml/Bridge.java | 45 ++++++----- .../com/bandwidth/sdk/model/bxml/Bxml.java | 2 +- .../bandwidth/sdk/model/bxml/Conference.java | 63 ++++++++-------- .../bandwidth/sdk/model/bxml/CustomParam.java | 15 ++-- .../com/bandwidth/sdk/model/bxml/Forward.java | 58 +++++++-------- .../com/bandwidth/sdk/model/bxml/Gather.java | 48 ++++++------ .../com/bandwidth/sdk/model/bxml/Pause.java | 8 +- .../bandwidth/sdk/model/bxml/PhoneNumber.java | 32 ++++---- .../bandwidth/sdk/model/bxml/PlayAudio.java | 16 ++-- .../com/bandwidth/sdk/model/bxml/Record.java | 44 +++++------ .../bandwidth/sdk/model/bxml/Redirect.java | 26 +++---- .../bandwidth/sdk/model/bxml/Response.java | 2 +- .../com/bandwidth/sdk/model/bxml/Ring.java | 12 +-- .../bandwidth/sdk/model/bxml/SendDtmf.java | 14 ++-- .../com/bandwidth/sdk/model/bxml/SipUri.java | 38 +++++----- .../sdk/model/bxml/SpeakSentence.java | 20 ++--- .../bandwidth/sdk/model/bxml/StartGather.java | 18 ++--- .../sdk/model/bxml/StartRecording.java | 28 +++---- .../bandwidth/sdk/model/bxml/StartStream.java | 30 ++++---- .../sdk/model/bxml/StartTranscription.java | 32 ++++---- .../bandwidth/sdk/model/bxml/StopStream.java | 10 +-- .../sdk/model/bxml/StopTranscription.java | 10 +-- .../bandwidth/sdk/model/bxml/StreamParam.java | 15 ++-- .../com/bandwidth/sdk/model/bxml/Tag.java | 12 +-- .../bandwidth/sdk/model/bxml/Transfer.java | 74 +++++++++---------- 26 files changed, 337 insertions(+), 336 deletions(-) diff --git a/.github/workflows/test-pr.yml b/.github/workflows/test-pr.yml index 8f2064b7..eb6ed170 100644 --- a/.github/workflows/test-pr.yml +++ b/.github/workflows/test-pr.yml @@ -4,6 +4,7 @@ on: pull_request: branches: - main + workflow_dispatch: concurrency: group: ${{ github.workflow }}-${{ github.head_ref }} diff --git a/src/main/java/com/bandwidth/sdk/model/bxml/Bridge.java b/src/main/java/com/bandwidth/sdk/model/bxml/Bridge.java index 05085429..0d02ee3d 100644 --- a/src/main/java/com/bandwidth/sdk/model/bxml/Bridge.java +++ b/src/main/java/com/bandwidth/sdk/model/bxml/Bridge.java @@ -31,31 +31,30 @@ @Builder @Getter @EqualsAndHashCode +/** + * + * @param targetCallId (str): String containing the callId of the call to be bridged. + * @param bridgeCompleteUrl (str, optional): URL to send the Bridge Complete event to and request new BXML. + * If this attribute is specified, then Verbs following the verb will be ignored and the BXML returned in this webhook is executed on the call. + * If this attribute is not specified then no webhook will be sent, and execution of the verbs following the verb continues. May be a relative URL. Defaults to None. + * @param bridgeCompleteMethod (str, optional): The HTTP method to use for the request to bridgeCompleteUrl. GET or POST. Default value is POST. + * @param bridgeCompleteFallbackUrl (str, optional): A fallback url which, if provided, will be used to retry the Bridge Complete webhook delivery in case bridgeCompleteUrl fails to respond. Defaults to None. + * @param bridgeCompleteFallbackMethod (str, optional): The HTTP method to use to deliver the Bridge Complete webhook to bridgeCompleteFallbackUrl. GET or POST. Default value is POST. + * @param bridgeTargetCompleteUrl (str, optional):URL to send the Bridge Target Complete event to and request new BXML. + * If this attribute is specified, then the BXML returned in this webhook is executed on the target call. + * If this attribute is not specified then no webhook will be sent, and the target call will be hung up. May be a relative URL. Defaults to None. + * @param bridgeTargetCompleteMethod (str, optional): The HTTP method to use for the request to bridgeTargetCompleteUrl. GET or POST. Default value is POST. + * @param bridgeTargetCompleteFallbackUrl (str, optional): A fallback url which, if provided, will be used to retry the Bridge Target Complete webhook delivery in case bridgeTargetCompleteUrl fails to respond. Defaults to None. + * @param bridgeTargetCompleteFallbackMethod (str, optional): The HTTP method to use to deliver the Bridge Target Complete webhook to bridgeTargetCompleteFallbackUrl. GET or POST. Default value is POST. + * @param username (str, optional): The username to send in the HTTP request to bridgeCompleteUrl and to bridgeTargetCompleteUrl. Defaults to None. + * @param password (str, optional): The password to send in the HTTP request to bridgeCompleteUrl and to bridgeTargetCompleteUrl. Defaults to None. + * @param fallbackUsername (str, optional): The username to send in the HTTP request to bridgeCompleteFallbackUrl and to bridgeTargetCompleteFallbackUrl. Defaults to None. + * @param fallbackPassword (str, optional): The password to send in the HTTP request to bridgeCompleteFallbackUrl and to bridgeTargetCompleteFallbackUrl. Defaults to None. + * @param tag (str, optional): A custom string that will be sent with the bridgeComplete webhook and all future webhooks of the call unless overwritten by a future tag attribute or verb, or cleared. May be cleared by setting tag="". Max length 256 characters. Defaults to None. + * + */ public class Bridge implements Verb { - /** - * - * @param targetCallId (str): String containing the callId of the call to be bridged. - * @param bridgeCompleteUrl (str, optional): URL to send the Bridge Complete event to and request new BXML. - * If this attribute is specified, then Verbs following the verb will be ignored and the BXML returned in this webhook is executed on the call. - * If this attribute is not specified then no webhook will be sent, and execution of the verbs following the verb continues. May be a relative URL. Defaults to None. - * @param bridgeCompleteMethod (str, optional): The HTTP method to use for the request to bridgeCompleteUrl. GET or POST. Default value is POST. - * @param bridgeCompleteFallbackUrl (str, optional): A fallback url which, if provided, will be used to retry the Bridge Complete webhook delivery in case bridgeCompleteUrl fails to respond. Defaults to None. - * @param bridgeCompleteFallbackMethod (str, optional): The HTTP method to use to deliver the Bridge Complete webhook to bridgeCompleteFallbackUrl. GET or POST. Default value is POST. - * @param bridgeTargetCompleteUrl (str, optional):URL to send the Bridge Target Complete event to and request new BXML. - * If this attribute is specified, then the BXML returned in this webhook is executed on the target call. - * If this attribute is not specified then no webhook will be sent, and the target call will be hung up. May be a relative URL. Defaults to None. - * @param bridgeTargetCompleteMethod (str, optional): The HTTP method to use for the request to bridgeTargetCompleteUrl. GET or POST. Default value is POST. - * @param bridgeTargetCompleteFallbackUrl (str, optional): A fallback url which, if provided, will be used to retry the Bridge Target Complete webhook delivery in case bridgeTargetCompleteUrl fails to respond. Defaults to None. - * @param bridgeTargetCompleteFallbackMethod (str, optional): The HTTP method to use to deliver the Bridge Target Complete webhook to bridgeTargetCompleteFallbackUrl. GET or POST. Default value is POST. - * @param username (str, optional): The username to send in the HTTP request to bridgeCompleteUrl and to bridgeTargetCompleteUrl. Defaults to None. - * @param password (str, optional): The password to send in the HTTP request to bridgeCompleteUrl and to bridgeTargetCompleteUrl. Defaults to None. - * @param fallbackUsername (str, optional): The username to send in the HTTP request to bridgeCompleteFallbackUrl and to bridgeTargetCompleteFallbackUrl. Defaults to None. - * @param fallbackPassword (str, optional): The password to send in the HTTP request to bridgeCompleteFallbackUrl and to bridgeTargetCompleteFallbackUrl. Defaults to None. - * @param tag (str, optional): A custom string that will be sent with the bridgeComplete webhook and all future webhooks of the call unless overwritten by a future tag attribute or verb, or cleared. May be cleared by setting tag="". Max length 256 characters. Defaults to None. - * - */ - public static final String TYPE_NAME = "Bridge"; @XmlValue diff --git a/src/main/java/com/bandwidth/sdk/model/bxml/Bxml.java b/src/main/java/com/bandwidth/sdk/model/bxml/Bxml.java index 1a6e5a24..877952f8 100644 --- a/src/main/java/com/bandwidth/sdk/model/bxml/Bxml.java +++ b/src/main/java/com/bandwidth/sdk/model/bxml/Bxml.java @@ -1,6 +1,6 @@ /** * The root {@code } verb. Other verbs get added to BXML and then the JAXB marshaller using the toBxml() method converts this to valid BXML. - * + * */ package com.bandwidth.sdk.model.bxml; diff --git a/src/main/java/com/bandwidth/sdk/model/bxml/Conference.java b/src/main/java/com/bandwidth/sdk/model/bxml/Conference.java index 71ac7327..ee0cc06a 100644 --- a/src/main/java/com/bandwidth/sdk/model/bxml/Conference.java +++ b/src/main/java/com/bandwidth/sdk/model/bxml/Conference.java @@ -1,7 +1,7 @@ /** * The {@code } verb is used to join the current call into a conference. - * Conference names are created and specified by your application. Conferences are implicitly created the first time your application uses a conference name, - * and they are implicitly deleted when the last member leaves the conference. We will create a unique ID for the conference, + * Conference names are created and specified by your application. Conferences are implicitly created the first time your application uses a conference name, + * and they are implicitly deleted when the last member leaves the conference. We will create a unique ID for the conference, * so your conference names can be whatever you want. If the conference ends and then you later use the same conference name, a new unique ID will be created. */ @@ -32,38 +32,37 @@ @Builder @Getter @EqualsAndHashCode +/** + * + * @param name (str): The name of the conference. Can contain up to 100 characters of letters, numbers, and the symbols -, _, and . + * @param mute (str, optional): A boolean value to indicate whether the member should be on mute in the conference. When muted, a member can hear others speak, but others cannot hear them speak. Defaults to false. + * @param hold (str, optional): A boolean value to indicate whether the member should be on hold in the conference. When on hold, a member cannot hear others, and they cannot be heard. Defaults to false. + * @param callIdsToCoach (str, optional): A comma-separated list of call ids to coach. When a call joins a conference with this attribute set, it will coach the listed calls. + * Those calls will be able to hear and be heard by the coach, but other calls in the conference will not hear the coach. + * @param conferenceEventUrl (str, optional): URL to send Conference events to. The URL, method, username, and password are set by the BXML document that creates the conference, + * and all events related to that conference will be delivered to that same endpoint. If more calls join afterwards and also have this property (or any other webhook related properties like username and password), + * they will be ignored and the original webhook information will be used. This URL may be a relative endpoint. + * @param conferenceEventMethod (str, optional): The HTTP method to use for the request to conferenceEventUrl. GET or POST. Default value is POST. + * @param conferenceEventFallbackUrl (str, optional): A fallback url which, if provided, will be used to retry the conference webhook deliveries in case conferenceEventUrl fails to respond. + * @param conferenceEventFallbackMethod (str, optional): The HTTP method to use to deliver the conference webhooks to conferenceEventFallbackUrl. GET or POST. Default value is POST. + * @param username (str, optional):The username to send in the HTTP request to conferenceEventUrl. + * @param password (str, optional): The password to send in the HTTP request to conferenceEventUrl. + * @param fallbackUsername (str, optional): The username to send in the HTTP request to conferenceEventFallbackUrl. + * @param fallbackPassword (str, optional): The password to send in the HTTP request to conferenceEventFallbackUrl. + * @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 verb, or cleared. May be cleared by setting tag="". + * Max length 256 characters. Defaults to None. + * @param callbackTimeout (str, optional): This is the timeout (in seconds) to use when delivering webhooks for the conference. + * If not set, it will inherit the webhook timeout from the call that creates the conference. Can be any numeric value (including decimals) between 1 and 25 * @parameter + * Nested Verbs: + * @param PlayAudio: (optional) + * @param SpeakSentence: (optional) + * @param StartRecording: (optional) + * @param StopRecording: (optional) + * @param PauseRecording: (optional) + * @param ResumeRecording: (optional) + */ public class Conference implements Verb { - /** - * - * @param name (str): The name of the conference. Can contain up to 100 characters of letters, numbers, and the symbols -, _, and . - * @param mute (str, optional): A boolean value to indicate whether the member should be on mute in the conference. When muted, a member can hear others speak, but others cannot hear them speak. Defaults to false. - * @param hold (str, optional): A boolean value to indicate whether the member should be on hold in the conference. When on hold, a member cannot hear others, and they cannot be heard. Defaults to false. - * @param callIdsToCoach (str, optional): A comma-separated list of call ids to coach. When a call joins a conference with this attribute set, it will coach the listed calls. - * Those calls will be able to hear and be heard by the coach, but other calls in the conference will not hear the coach. - * @param conferenceEventUrl (str, optional): URL to send Conference events to. The URL, method, username, and password are set by the BXML document that creates the conference, - * and all events related to that conference will be delivered to that same endpoint. If more calls join afterwards and also have this property (or any other webhook related properties like username and password), - * they will be ignored and the original webhook information will be used. This URL may be a relative endpoint. - * @param conferenceEventMethod (str, optional): The HTTP method to use for the request to conferenceEventUrl. GET or POST. Default value is POST. - * @param conferenceEventFallbackUrl (str, optional): A fallback url which, if provided, will be used to retry the conference webhook deliveries in case conferenceEventUrl fails to respond. - * @param conferenceEventFallbackMethod (str, optional): The HTTP method to use to deliver the conference webhooks to conferenceEventFallbackUrl. GET or POST. Default value is POST. - * @param username (str, optional):The username to send in the HTTP request to conferenceEventUrl. - * @param password (str, optional): The password to send in the HTTP request to conferenceEventUrl. - * @param fallbackUsername (str, optional): The username to send in the HTTP request to conferenceEventFallbackUrl. - * @param fallbackPassword (str, optional): The password to send in the HTTP request to conferenceEventFallbackUrl. - * @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 verb, or cleared. May be cleared by setting tag="". - * Max length 256 characters. Defaults to None. - * @param callbackTimeout (str, optional): This is the timeout (in seconds) to use when delivering webhooks for the conference. - * If not set, it will inherit the webhook timeout from the call that creates the conference. Can be any numeric value (including decimals) between 1 and 25 * @parameter - * Nested Verbs: - * @param PlayAudio: (optional) - * @param SpeakSentence: (optional) - * @param StartRecording: (optional) - * @param StopRecording: (optional) - * @param PauseRecording: (optional) - * @param ResumeRecording: (optional) - */ - public static final String TYPE_NAME = "Conference"; @XmlValue diff --git a/src/main/java/com/bandwidth/sdk/model/bxml/CustomParam.java b/src/main/java/com/bandwidth/sdk/model/bxml/CustomParam.java index 641a0891..eb9edbcd 100644 --- a/src/main/java/com/bandwidth/sdk/model/bxml/CustomParam.java +++ b/src/main/java/com/bandwidth/sdk/model/bxml/CustomParam.java @@ -1,5 +1,5 @@ /** - * The {@code } verb is used to define optional user specified parameters that will be sent to the destination URL when the real-time transcription is first started. + * The {@code } verb is used to define optional user specified parameters that will be sent to the destination URL when the real-time transcription is first started. * You may specify up to 12 {@code } elements nested within a {@code } tag. */ @@ -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 CustomParam { - /** - * - * @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 = "CustomParam"; @XmlAttribute diff --git a/src/main/java/com/bandwidth/sdk/model/bxml/Forward.java b/src/main/java/com/bandwidth/sdk/model/bxml/Forward.java index 8ee5389c..f8e42c1c 100644 --- a/src/main/java/com/bandwidth/sdk/model/bxml/Forward.java +++ b/src/main/java/com/bandwidth/sdk/model/bxml/Forward.java @@ -1,5 +1,5 @@ /** - * The {@code } verb is used to forward an unanswered incoming call to another number. Unlike {@code }, once your call is forwarded, + * The {@code } verb is used to forward an unanswered incoming call to another number. Unlike {@code }, once your call is forwarded, * your application will not have any control over either leg of the call. When either leg hangs up, a Disconnect event will be sent to your Call status webhook URL. */ @@ -26,35 +26,35 @@ @Builder @Getter @EqualsAndHashCode +/** + * + * @param to (str): The phone number destination of the call. + * @param from_ (str, optional): The phone number that the recipient will receive the call from. + * @param callTimeout (str, optional): The number of seconds to wait before timing out the call. + * @param diversionTreatment (str, optional): Can be any of the following: + * none: No diversion headers are sent on the outbound leg of the transferred call. + * propagate: Copy the Diversion header from the inbound leg to the outbound leg. Ignored if there is no Diversion header present on the inbound leg. + * stack: After propagating any Diversion header from the inbound leg to the outbound leg, stack on top another Diversion header based on the Request-URI of the inbound call. + * Defaults to none. If diversionTreatment is not specified, no diversion header will be included for the transfer even if one came with the inbound call. Defaults to None. + * @param diversionReason (str, optional): Can be any of the following values: + * unknown + * user-busy + * no-answer + * unavailable + * unconditional + * time-of-day + * do-not-disturb + * deflection + * follow-me + * out-of-service + * away + * This parameter is considered only when diversionTreatment is set to stack. Defaults is unknown. + * Defaults to None. + * @param uui (str, optional): The value of the User-To-User header to send within the outbound INVITE when forwarding to a SIP URI. + * Must include the encoding parameter as specified in RFC 7433. Only base64 and jwt encoding are currently allowed. + * This value, including the encoding specifier, may not exceed 256 characters. + */ public class Forward implements Verb { - /** - * - * @param to (str): The phone number destination of the call. - * @param from_ (str, optional): The phone number that the recipient will receive the call from. - * @param callTimeout (str, optional): The number of seconds to wait before timing out the call. - * @param diversionTreatment (str, optional): Can be any of the following: - * none: No diversion headers are sent on the outbound leg of the transferred call. - * propagate: Copy the Diversion header from the inbound leg to the outbound leg. Ignored if there is no Diversion header present on the inbound leg. - * stack: After propagating any Diversion header from the inbound leg to the outbound leg, stack on top another Diversion header based on the Request-URI of the inbound call. - * Defaults to none. If diversionTreatment is not specified, no diversion header will be included for the transfer even if one came with the inbound call. Defaults to None. - * @param diversionReason (str, optional): Can be any of the following values: - * unknown - * user-busy - * no-answer - * unavailable - * unconditional - * time-of-day - * do-not-disturb - * deflection - * follow-me - * out-of-service - * away - * This parameter is considered only when diversionTreatment is set to stack. Defaults is unknown. - * Defaults to None. - * @param uui (str, optional): The value of the User-To-User header to send within the outbound INVITE when forwarding to a SIP URI. - * Must include the encoding parameter as specified in RFC 7433. Only base64 and jwt encoding are currently allowed. - * This value, including the encoding specifier, may not exceed 256 characters. - */ public static final String TYPE_NAME = "Forward"; diff --git a/src/main/java/com/bandwidth/sdk/model/bxml/Gather.java b/src/main/java/com/bandwidth/sdk/model/bxml/Gather.java index 59557ef7..8f56ac51 100644 --- a/src/main/java/com/bandwidth/sdk/model/bxml/Gather.java +++ b/src/main/java/com/bandwidth/sdk/model/bxml/Gather.java @@ -32,31 +32,31 @@ @Builder @Getter @EqualsAndHashCode +/** + * + * @param gatherUrl (str, optional): URL to send Gather event to and request new BXML. May be a relative URL. + * @param gatherMethod (str, optional): The HTTP method to use for the request to gather_url. GET or POST. Default value is POST. + * @param gatherFallbackUrl (str, optional): A fallback url which, if provided, will be used to retry the Gather event callback delivery in case gather_url fails to respond. + * @param gatherFallbackMethod (str, optional): The HTTP method to use to deliver the Gather event callback to gather_fallback_url. GET or POST. Default value is POST. + * @param username (str, optional): The username to send in the HTTP request to gather_url. + * @param password (str, optional): The password to send in the HTTP request to gather_url. + * @param fallbackUsername (str, optional): The username to send in the HTTP request to gather_fallback_url. + * @param fallbackPassword (str, optional): The password to send in the HTTP request to gather_fallback_url. + * @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 verb, or cleared. + * May be cleared by setting tag="". Max length 256 characters. + * @param terminatingDigits (str, optional): When any of these digits are pressed, it will terminate the Gather. Default value is "", which disables this feature. + * @param maxDigits (int, optional): Max number of digits to collect. Default value is 50. Range: decimal values between 1 - 50. + * @param interDigitTimeout (int, optional): Time (in seconds) allowed between digit presses before automatically terminating the Gather. Default value is 5. Range: decimal values between 1 - 60. + * @param firstDigitTimeout (int, optional): Time (in seconds) to pause after any audio from nested or verb is played (in seconds) before terminating the Gather. + * Default value is 5. Range: decimal values between 0 - 60. + * @param repeatCount (int, optional): The number of times the audio prompt should be played if no digits are pressed. For example, if this value is 3, the nested audio clip will be played a maximum of three times. + * The delay between repetitions will be equal to first_digit_timeout. Default value is 1. repeat_count * number of verbs must not be greater than 20. + * + * Nested Verbs: + * @param PlayAudio: (optional) Using the PlayAudio inside the Gather verb will play the media until a digit is received. + * @param SpeakSentence: (optional) Using the SpeakSentence inside the Gather verb will speak the text until a digit is received. + */ public class Gather implements Verb { - /** - * - * @param gatherUrl (str, optional): URL to send Gather event to and request new BXML. May be a relative URL. - * @param gatherMethod (str, optional): The HTTP method to use for the request to gather_url. GET or POST. Default value is POST. - * @param gatherFallbackUrl (str, optional): A fallback url which, if provided, will be used to retry the Gather event callback delivery in case gather_url fails to respond. - * @param gatherFallbackMethod (str, optional): The HTTP method to use to deliver the Gather event callback to gather_fallback_url. GET or POST. Default value is POST. - * @param username (str, optional): The username to send in the HTTP request to gather_url. - * @param password (str, optional): The password to send in the HTTP request to gather_url. - * @param fallbackUsername (str, optional): The username to send in the HTTP request to gather_fallback_url. - * @param fallbackPassword (str, optional): The password to send in the HTTP request to gather_fallback_url. - * @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 verb, or cleared. - * May be cleared by setting tag="". Max length 256 characters. - * @param terminatingDigits (str, optional): When any of these digits are pressed, it will terminate the Gather. Default value is "", which disables this feature. - * @param maxDigits (int, optional): Max number of digits to collect. Default value is 50. Range: decimal values between 1 - 50. - * @param interDigitTimeout (int, optional): Time (in seconds) allowed between digit presses before automatically terminating the Gather. Default value is 5. Range: decimal values between 1 - 60. - * @param firstDigitTimeout (int, optional): Time (in seconds) to pause after any audio from nested or verb is played (in seconds) before terminating the Gather. - * Default value is 5. Range: decimal values between 0 - 60. - * @param repeatCount (int, optional): The number of times the audio prompt should be played if no digits are pressed. For example, if this value is 3, the nested audio clip will be played a maximum of three times. - * The delay between repetitions will be equal to first_digit_timeout. Default value is 1. repeat_count * number of verbs must not be greater than 20. - * - * Nested Verbs: - * @param PlayAudio: (optional) Using the PlayAudio inside the Gather verb will play the media until a digit is received. - * @param SpeakSentence: (optional) Using the SpeakSentence inside the Gather verb will speak the text until a digit is received. - */ public static final String TYPE_NAME = "Gather"; diff --git a/src/main/java/com/bandwidth/sdk/model/bxml/Pause.java b/src/main/java/com/bandwidth/sdk/model/bxml/Pause.java index 8f9fb5de..bf121783 100644 --- a/src/main/java/com/bandwidth/sdk/model/bxml/Pause.java +++ b/src/main/java/com/bandwidth/sdk/model/bxml/Pause.java @@ -24,11 +24,11 @@ @Builder @Getter @EqualsAndHashCode +/** + * + * @param duration (str, optional): The time in seconds to pause. Default value is 1. + */ public class Pause implements Verb { - /** - * - * @param duration (str, optional): The time in seconds to pause. Default value is 1. - */ public static final String TYPE_NAME = "Pause"; diff --git a/src/main/java/com/bandwidth/sdk/model/bxml/PhoneNumber.java b/src/main/java/com/bandwidth/sdk/model/bxml/PhoneNumber.java index dfdf67a4..d2a1cd4b 100644 --- a/src/main/java/com/bandwidth/sdk/model/bxml/PhoneNumber.java +++ b/src/main/java/com/bandwidth/sdk/model/bxml/PhoneNumber.java @@ -27,23 +27,23 @@ @Builder @Getter @EqualsAndHashCode +/** + * + * @param number (str): A phone number to transfer the call to. Value must be in E.164 format (e.g. +15555555555). + * @param transferAnswerUrl (str, optional): URL, if any, to send the Transfer Answer event to and request BXML to be executed for the called party before the call is bridged. May be a relative URL. Defaults to None. + * @param transferAnswerMethod (str, optional): The HTTP method to use for the request to transferAnswerUrl. GET or POST. Default value is POST. Defaults to None. + * @param transferAnswerFallbackUrl (str, optional): A fallback url which, if provided, will be used to retry the Transfer Answer callback delivery in case transferAnswerUrl fails to respond. Defaults to None. + * @param transferAnswerFallbackMethod (str, optional): The HTTP method to use to deliver the Transfer Answer callback to transferAnswerFallbackUrl. GET or POST. Default value is POST. Defaults to None. + * @param transferDisconnectUrl (str, optional): URL, if any, to send the Transfer Disconnect event to. This event will be sent regardless of how the transfer ends and may not be responded to with BXML. May be a relative URL. Defaults to None. + * @param transferDisconnectMethod (str, optional): The HTTP method to use for the request to transferDisconnectUrl. GET or POST. Default value is POST. Defaults to Defaults to Defaults to None. + * @param username (str, optional): The username to send in the HTTP request to transferAnswerUrl and transferDisconnectUrl. Defaults to Defaults to None. + * @param password (str, optional): The password to send in the HTTP request to transferAnswerUrl and transferDisconnectUrl. Defaults to Defaults to None. + * @param fallbackUsername (str, optional): The username to send in the HTTP request to transferAnswerFallbackUrl. Defaults to None. + * @param fallbackPassword (str, optional): The password to send in the HTTP request to transferAnswerFallbackUrl. 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 PhoneNumber implements OutboundDestination { - /** - * - * @param number (str): A phone number to transfer the call to. Value must be in E.164 format (e.g. +15555555555). - * @param transferAnswerUrl (str, optional): URL, if any, to send the Transfer Answer event to and request BXML to be executed for the called party before the call is bridged. May be a relative URL. Defaults to None. - * @param transferAnswerMethod (str, optional): The HTTP method to use for the request to transferAnswerUrl. GET or POST. Default value is POST. Defaults to None. - * @param transferAnswerFallbackUrl (str, optional): A fallback url which, if provided, will be used to retry the Transfer Answer callback delivery in case transferAnswerUrl fails to respond. Defaults to None. - * @param transferAnswerFallbackMethod (str, optional): The HTTP method to use to deliver the Transfer Answer callback to transferAnswerFallbackUrl. GET or POST. Default value is POST. Defaults to None. - * @param transferDisconnectUrl (str, optional): URL, if any, to send the Transfer Disconnect event to. This event will be sent regardless of how the transfer ends and may not be responded to with BXML. May be a relative URL. Defaults to None. - * @param transferDisconnectMethod (str, optional): The HTTP method to use for the request to transferDisconnectUrl. GET or POST. Default value is POST. Defaults to Defaults to Defaults to None. - * @param username (str, optional): The username to send in the HTTP request to transferAnswerUrl and transferDisconnectUrl. Defaults to Defaults to None. - * @param password (str, optional): The password to send in the HTTP request to transferAnswerUrl and transferDisconnectUrl. Defaults to Defaults to None. - * @param fallbackUsername (str, optional): The username to send in the HTTP request to transferAnswerFallbackUrl. Defaults to None. - * @param fallbackPassword (str, optional): The password to send in the HTTP request to transferAnswerFallbackUrl. 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 = "PhoneNumber"; diff --git a/src/main/java/com/bandwidth/sdk/model/bxml/PlayAudio.java b/src/main/java/com/bandwidth/sdk/model/bxml/PlayAudio.java index c040f712..5214d852 100644 --- a/src/main/java/com/bandwidth/sdk/model/bxml/PlayAudio.java +++ b/src/main/java/com/bandwidth/sdk/model/bxml/PlayAudio.java @@ -1,5 +1,5 @@ /** - * The {@code } verb is used to play an audio file in the call. + * The {@code } verb is used to play an audio file in the call. * The URL of an audio file should be included in the body of the {@code } tag. If a relative URL is given, it is resolved relative to the endpoint that returned the BXML. */ package com.bandwidth.sdk.model.bxml; @@ -25,14 +25,14 @@ @Builder @Getter @EqualsAndHashCode +/** + * + * @param audioUri (str): The URL of the audio file to play. May be a relative URL. + * @param username (str, optional): The username to send in the HTTP request to audio_uri. + * @param password (str, optional): The password to send in the HTTP request to audio_uri. + * + */ public class PlayAudio implements AudioProducer { - /** - * - * @param audioUri (str): The URL of the audio file to play. May be a relative URL. - * @param username (str, optional): The username to send in the HTTP request to audio_uri. - * @param password (str, optional): The password to send in the HTTP request to audio_uri. - * - */ public static final String TYPE_NAME = "PlayAudio"; diff --git a/src/main/java/com/bandwidth/sdk/model/bxml/Record.java b/src/main/java/com/bandwidth/sdk/model/bxml/Record.java index 53c8bb8d..7ee6bc93 100644 --- a/src/main/java/com/bandwidth/sdk/model/bxml/Record.java +++ b/src/main/java/com/bandwidth/sdk/model/bxml/Record.java @@ -29,29 +29,29 @@ @Builder @Getter @EqualsAndHashCode +/** + * + * @param recordCompleteUrl (str, optional): URL to send the Record Complete event to once the recording has ended. Accepts BXML, and may be a relative URL. This callback will not be sent if the recording ended due to the call hanging up. Defaults to None. + * @param recordCompleteMethod (str, optional): The HTTP method to use for the request to recordCompleteUrl. GET or POST. Default value is POST. Defaults to None. + * @param recordCompleteFallbackUrl (str, optional): A fallback url which, if provided, will be used to retry the Record Complete callback delivery in case recordCompleteUrl fails to respond. Defaults to None. + * @param recordCompleteFallbackMethod (str, optional): The HTTP method to use to deliver the Record Complete callback to recordCompleteFallbackUrl. GET or POST. Default value is POST. Defaults to None. + * @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. Defaults to None. + * @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 fallbackUsername (str, optional): The username to send in the HTTP request to recordCompleteFallbackUrl. If specified, the URLs must be TLS-encrypted (i.e., https). Defaults to None. + * @param fallbackPassword (str, optional): The password to send in the HTTP request to recordCompleteFallbackUrl. 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 verb, or cleared. May be cleared by setting tag="". Max length 256 characters. Defaults to None. + * @param terminatingDigits (str, optional): When pressed, this digit will terminate the recording. Default value is “#”. This feature can be disabled with "". Defaults to None. + * @param maxDuration (int, optional): Maximum length of recording (in seconds). Max 10800 (3 hours). Default value is 60. Defaults to None. + * @param silenceTimeout (str, optional): Length of silence after which to end the recording (in seconds). Max is equivalent to the maximum maxDuration value. Default value is 0, which means no timeout. 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. + * + */ public class Record implements TranscriptionProducer { - /** - * - * @param recordCompleteUrl (str, optional): URL to send the Record Complete event to once the recording has ended. Accepts BXML, and may be a relative URL. This callback will not be sent if the recording ended due to the call hanging up. Defaults to None. - * @param recordCompleteMethod (str, optional): The HTTP method to use for the request to recordCompleteUrl. GET or POST. Default value is POST. Defaults to None. - * @param recordCompleteFallbackUrl (str, optional): A fallback url which, if provided, will be used to retry the Record Complete callback delivery in case recordCompleteUrl fails to respond. Defaults to None. - * @param recordCompleteFallbackMethod (str, optional): The HTTP method to use to deliver the Record Complete callback to recordCompleteFallbackUrl. GET or POST. Default value is POST. Defaults to None. - * @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. Defaults to None. - * @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 fallbackUsername (str, optional): The username to send in the HTTP request to recordCompleteFallbackUrl. If specified, the URLs must be TLS-encrypted (i.e., https). Defaults to None. - * @param fallbackPassword (str, optional): The password to send in the HTTP request to recordCompleteFallbackUrl. 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 verb, or cleared. May be cleared by setting tag="". Max length 256 characters. Defaults to None. - * @param terminatingDigits (str, optional): When pressed, this digit will terminate the recording. Default value is “#”. This feature can be disabled with "". Defaults to None. - * @param maxDuration (int, optional): Maximum length of recording (in seconds). Max 10800 (3 hours). Default value is 60. Defaults to None. - * @param silenceTimeout (str, optional): Length of silence after which to end the recording (in seconds). Max is equivalent to the maximum maxDuration value. Default value is 0, which means no timeout. 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. - * - */ public static final String TYPE_NAME = "Record"; diff --git a/src/main/java/com/bandwidth/sdk/model/bxml/Redirect.java b/src/main/java/com/bandwidth/sdk/model/bxml/Redirect.java index d12bd0f0..fd75db48 100644 --- a/src/main/java/com/bandwidth/sdk/model/bxml/Redirect.java +++ b/src/main/java/com/bandwidth/sdk/model/bxml/Redirect.java @@ -25,20 +25,20 @@ @Builder @Getter @EqualsAndHashCode +/** + * + * @param redirectUrl (str): URL to request new BXML from. A Redirect event will be sent to this endpoint. May be a relative URL. Defaults to None. + * @param redirectMethod (str, optional): The HTTP method to use for the request to redirectUrl. GET or POST. Defaults to None. + * @param redirectFallbackUrl (str, optional): A fallback url which, if provided, will be used to retry the Redirect callback delivery in case redirectUrl fails to respond. Defaults to None. + * @param redirectFallbackMethod (str, optional): The HTTP method to use to deliver the Redirect callback to redirectFallbackUrl. GET or POST. Default value is POST. Defaults to None. + * @param username (str, optional): The username to send in the HTTP request to redirectUrl. Defaults to None. + * @param password (str, optional): The password to send in the HTTP request to redirectUrl. Defaults to None. + * @param fallbackUsername (str, optional): The username to send in the HTTP request to redirectFallbackUrl. Defaults to None. + * @param fallbackPassword (str, optional): The password to send in the HTTP request to redirectFallbackUrl. 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 verb, or cleared. May be cleared by setting tag="". Max length 256 characters. Defaults to None. + * + */ public class Redirect implements Verb { - /** - * - * @param redirectUrl (str): URL to request new BXML from. A Redirect event will be sent to this endpoint. May be a relative URL. Defaults to None. - * @param redirectMethod (str, optional): The HTTP method to use for the request to redirectUrl. GET or POST. Defaults to None. - * @param redirectFallbackUrl (str, optional): A fallback url which, if provided, will be used to retry the Redirect callback delivery in case redirectUrl fails to respond. Defaults to None. - * @param redirectFallbackMethod (str, optional): The HTTP method to use to deliver the Redirect callback to redirectFallbackUrl. GET or POST. Default value is POST. Defaults to None. - * @param username (str, optional): The username to send in the HTTP request to redirectUrl. Defaults to None. - * @param password (str, optional): The password to send in the HTTP request to redirectUrl. Defaults to None. - * @param fallbackUsername (str, optional): The username to send in the HTTP request to redirectFallbackUrl. Defaults to None. - * @param fallbackPassword (str, optional): The password to send in the HTTP request to redirectFallbackUrl. 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 verb, or cleared. May be cleared by setting tag="". Max length 256 characters. Defaults to None. - * - */ public static final String TYPE_NAME = "Redirect"; diff --git a/src/main/java/com/bandwidth/sdk/model/bxml/Response.java b/src/main/java/com/bandwidth/sdk/model/bxml/Response.java index d1e8a532..39d82904 100644 --- a/src/main/java/com/bandwidth/sdk/model/bxml/Response.java +++ b/src/main/java/com/bandwidth/sdk/model/bxml/Response.java @@ -1,6 +1,6 @@ /** * The root {@code } verb. Other verbs get added to Response and then the JAXB marshaller using the toBxml() method converts this to valid BXML. - * + * */ package com.bandwidth.sdk.model.bxml; diff --git a/src/main/java/com/bandwidth/sdk/model/bxml/Ring.java b/src/main/java/com/bandwidth/sdk/model/bxml/Ring.java index d1769661..fc9fa491 100644 --- a/src/main/java/com/bandwidth/sdk/model/bxml/Ring.java +++ b/src/main/java/com/bandwidth/sdk/model/bxml/Ring.java @@ -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"; diff --git a/src/main/java/com/bandwidth/sdk/model/bxml/SendDtmf.java b/src/main/java/com/bandwidth/sdk/model/bxml/SendDtmf.java index 65552976..2c958ab3 100644 --- a/src/main/java/com/bandwidth/sdk/model/bxml/SendDtmf.java +++ b/src/main/java/com/bandwidth/sdk/model/bxml/SendDtmf.java @@ -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"; diff --git a/src/main/java/com/bandwidth/sdk/model/bxml/SipUri.java b/src/main/java/com/bandwidth/sdk/model/bxml/SipUri.java index 7094288a..c611f4af 100644 --- a/src/main/java/com/bandwidth/sdk/model/bxml/SipUri.java +++ b/src/main/java/com/bandwidth/sdk/model/bxml/SipUri.java @@ -28,26 +28,26 @@ @Builder @Getter @EqualsAndHashCode +/** + * + * @param uri (str): A SIP URI to transfer the call to (e.g. sip:user@server.com) + * @param uui (str, optional): he value of the User-To-User header to send within the initial INVITE. Must include the encoding parameter as specified in RFC 7433. Only base64 and jwt encoding are currently allowed. + * This value, including the encoding specifier, may not exceed 256 characters. Defaults to None. + * @param number (str): A phone number to transfer the call to. Value must be in E.164 format (e.g. +15555555555). + * @param transferAnswerUrl (str, optional): URL, if any, to send the Transfer Answer event to and request BXML to be executed for the called party before the call is bridged. May be a relative URL. Defaults to None. + * @param transferAnswerMethod (str, optional): The HTTP method to use for the request to transferAnswerUrl. GET or POST. Default value is POST. Defaults to None. + * @param transferAnswerFallbackUrl (str, optional): A fallback url which, if provided, will be used to retry the Transfer Answer callback delivery in case transferAnswerUrl fails to respond. Defaults to None. + * @param transferAnswerFallbackMethod (str, optional): The HTTP method to use to deliver the Transfer Answer callback to transferAnswerFallbackUrl. GET or POST. Default value is POST. Defaults to None. + * @param transferDisconnectUrl (str, optional): URL, if any, to send the Transfer Disconnect event to. This event will be sent regardless of how the transfer ends and may not be responded to with BXML. May be a relative URL. Defaults to None. + * @param transferDisconnectMethod (str, optional): The HTTP method to use for the request to transferDisconnectUrl. GET or POST. Default value is POST. Defaults to Defaults to Defaults to None. + * @param username (str, optional): The username to send in the HTTP request to transferAnswerUrl and transferDisconnectUrl. Defaults to Defaults to None. + * @param password (str, optional): The password to send in the HTTP request to transferAnswerUrl and transferDisconnectUrl. Defaults to Defaults to None. + * @param fallbackUsername (str, optional): The username to send in the HTTP request to transferAnswerFallbackUrl. Defaults to None. + * @param fallbackPassword (str, optional): The password to send in the HTTP request to transferAnswerFallbackUrl. 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 SipUri implements OutboundDestination { - /** - * - * @param uri (str): A SIP URI to transfer the call to (e.g. sip:user@server.com) - * @param uui (str, optional): he value of the User-To-User header to send within the initial INVITE. Must include the encoding parameter as specified in RFC 7433. Only base64 and jwt encoding are currently allowed. - * This value, including the encoding specifier, may not exceed 256 characters. Defaults to None. - * @param number (str): A phone number to transfer the call to. Value must be in E.164 format (e.g. +15555555555). - * @param transferAnswerUrl (str, optional): URL, if any, to send the Transfer Answer event to and request BXML to be executed for the called party before the call is bridged. May be a relative URL. Defaults to None. - * @param transferAnswerMethod (str, optional): The HTTP method to use for the request to transferAnswerUrl. GET or POST. Default value is POST. Defaults to None. - * @param transferAnswerFallbackUrl (str, optional): A fallback url which, if provided, will be used to retry the Transfer Answer callback delivery in case transferAnswerUrl fails to respond. Defaults to None. - * @param transferAnswerFallbackMethod (str, optional): The HTTP method to use to deliver the Transfer Answer callback to transferAnswerFallbackUrl. GET or POST. Default value is POST. Defaults to None. - * @param transferDisconnectUrl (str, optional): URL, if any, to send the Transfer Disconnect event to. This event will be sent regardless of how the transfer ends and may not be responded to with BXML. May be a relative URL. Defaults to None. - * @param transferDisconnectMethod (str, optional): The HTTP method to use for the request to transferDisconnectUrl. GET or POST. Default value is POST. Defaults to Defaults to Defaults to None. - * @param username (str, optional): The username to send in the HTTP request to transferAnswerUrl and transferDisconnectUrl. Defaults to Defaults to None. - * @param password (str, optional): The password to send in the HTTP request to transferAnswerUrl and transferDisconnectUrl. Defaults to Defaults to None. - * @param fallbackUsername (str, optional): The username to send in the HTTP request to transferAnswerFallbackUrl. Defaults to None. - * @param fallbackPassword (str, optional): The password to send in the HTTP request to transferAnswerFallbackUrl. 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 = "SipUri"; diff --git a/src/main/java/com/bandwidth/sdk/model/bxml/SpeakSentence.java b/src/main/java/com/bandwidth/sdk/model/bxml/SpeakSentence.java index 755e26f7..4b7af097 100644 --- a/src/main/java/com/bandwidth/sdk/model/bxml/SpeakSentence.java +++ b/src/main/java/com/bandwidth/sdk/model/bxml/SpeakSentence.java @@ -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"; diff --git a/src/main/java/com/bandwidth/sdk/model/bxml/StartGather.java b/src/main/java/com/bandwidth/sdk/model/bxml/StartGather.java index be5e11d6..19331173 100644 --- a/src/main/java/com/bandwidth/sdk/model/bxml/StartGather.java +++ b/src/main/java/com/bandwidth/sdk/model/bxml/StartGather.java @@ -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"; diff --git a/src/main/java/com/bandwidth/sdk/model/bxml/StartRecording.java b/src/main/java/com/bandwidth/sdk/model/bxml/StartRecording.java index d770855f..e026f6ad 100644 --- a/src/main/java/com/bandwidth/sdk/model/bxml/StartRecording.java +++ b/src/main/java/com/bandwidth/sdk/model/bxml/StartRecording.java @@ -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 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 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"; diff --git a/src/main/java/com/bandwidth/sdk/model/bxml/StartStream.java b/src/main/java/com/bandwidth/sdk/model/bxml/StartStream.java index 0735c5ab..491512e9 100644 --- a/src/main/java/com/bandwidth/sdk/model/bxml/StartStream.java +++ b/src/main/java/com/bandwidth/sdk/model/bxml/StartStream.java @@ -31,22 +31,22 @@ @Builder @Getter @EqualsAndHashCode +/** + * + * @param name (str, optional): A name to refer to this stream by. Used when sending . 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 elements nested within a 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 . 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 elements nested within a 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"; diff --git a/src/main/java/com/bandwidth/sdk/model/bxml/StartTranscription.java b/src/main/java/com/bandwidth/sdk/model/bxml/StartTranscription.java index 52c8e600..024223ef 100644 --- a/src/main/java/com/bandwidth/sdk/model/bxml/StartTranscription.java +++ b/src/main/java/com/bandwidth/sdk/model/bxml/StartTranscription.java @@ -31,23 +31,23 @@ @Builder @Getter @EqualsAndHashCode +/** + * + * @param name (str, optional): A name to refer to this transcription by. Used when sending . 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 elements nested within a 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 . 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 elements nested within a 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"; diff --git a/src/main/java/com/bandwidth/sdk/model/bxml/StopStream.java b/src/main/java/com/bandwidth/sdk/model/bxml/StopStream.java index 9fd6b7ab..55730aa6 100644 --- a/src/main/java/com/bandwidth/sdk/model/bxml/StopStream.java +++ b/src/main/java/com/bandwidth/sdk/model/bxml/StopStream.java @@ -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 verb, or the system generated name returned in the Media Stream Started webhook if 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 verb, or the system generated name returned in the Media Stream Started webhook if was sent with no name attribute. - */ public static final String TYPE_NAME = "StopStream"; diff --git a/src/main/java/com/bandwidth/sdk/model/bxml/StopTranscription.java b/src/main/java/com/bandwidth/sdk/model/bxml/StopTranscription.java index 51435bfd..e42db0cf 100644 --- a/src/main/java/com/bandwidth/sdk/model/bxml/StopTranscription.java +++ b/src/main/java/com/bandwidth/sdk/model/bxml/StopTranscription.java @@ -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 verb, or the system generated name returned in the Media Transcription Started webhook if 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 verb, or the system generated name returned in the Media Transcription Started webhook if was sent with no name attribute. - */ public static final String TYPE_NAME = "StopTranscription"; diff --git a/src/main/java/com/bandwidth/sdk/model/bxml/StreamParam.java b/src/main/java/com/bandwidth/sdk/model/bxml/StreamParam.java index 65961730..90f196b0 100644 --- a/src/main/java/com/bandwidth/sdk/model/bxml/StreamParam.java +++ b/src/main/java/com/bandwidth/sdk/model/bxml/StreamParam.java @@ -1,5 +1,5 @@ /** - * The {@code } verb is used to define optional user specified parameters that will be sent to the destination URL when the stream is first started. + * The {@code } verb is used to define optional user specified parameters that will be sent to the destination URL when the stream is first started. * You may specify up to 12 {@code } elements nested within a {@code } tag. */ @@ -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 diff --git a/src/main/java/com/bandwidth/sdk/model/bxml/Tag.java b/src/main/java/com/bandwidth/sdk/model/bxml/Tag.java index 1752210a..f70091ca 100644 --- a/src/main/java/com/bandwidth/sdk/model/bxml/Tag.java +++ b/src/main/java/com/bandwidth/sdk/model/bxml/Tag.java @@ -1,5 +1,5 @@ /** - * The {@code } verb is used to set a new tag value without executing a callback. + * The {@code } verb is used to set a new tag value without executing a callback. * This new tag will be sent with all future callbacks unless overwritten by a future tag attribute or {@code } verb, or cleared. */ @@ -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"; diff --git a/src/main/java/com/bandwidth/sdk/model/bxml/Transfer.java b/src/main/java/com/bandwidth/sdk/model/bxml/Transfer.java index d8eb49ca..580647e1 100644 --- a/src/main/java/com/bandwidth/sdk/model/bxml/Transfer.java +++ b/src/main/java/com/bandwidth/sdk/model/bxml/Transfer.java @@ -31,44 +31,44 @@ @AllArgsConstructor @Getter @EqualsAndHashCode +/** + * + * @param destinations (list[PhoneNumber, SipUri], optional): List of recipients to transfer a call to. Defaults to []. + * @param transferCallerId (str, optional): The caller ID to use when the call is transferred, if different. Must be in E.164 format (e.g. +15555555555) or be one of the following strings Restricted, Anonymous, Private, or Unavailable. Leave as default to pass along the number of the remote party. Defaults to None. + * @param transferCallerDisplayName (str, optional): The caller display name to use when the call is transferred. May not exceed 256 characters nor contain control characters such as new lines. + * @param callTimeout (double, optional):The timeout (in seconds) for the callee to answer the call after it starts ringing. If the call does not start ringing within 30s, the call will be cancelled regardless of this value. Range: decimal values between 1 - 300. Default value is 30 seconds. Defaults to None. + * @param transferCompleteUrl (str, optional): URL to send the Transfer Complete event to and request new BXML. Optional but recommended. See below for further details. May be a relative URL. Defaults to None. + * @param transferCompleteMethod (str, optional): The HTTP method to use for the request to transferCompleteUrl. GET or POST. Default value is POST. Defaults to None. + * @param transferCompleteFallbackUrl (str, optional): A fallback url which, if provided, will be used to retry the Transfer Complete callback delivery in case transferCompleteUrl fails to respond. Defaults to None. + * @param transferCompleteFallbackMethod (str, optional): The HTTP method to use to deliver the Transfer Complete callback to transferCompleteFallbackUrl. GET or POST. Default value is POST. Defaults to None. + * @param username (str, optional): The username to send in the HTTP request to transferCompleteUrl. Defaults to None. + * @param password (str, optional): The password to send in the HTTP request to transferCompleteUrl. Defaults to None. + * @param fallbackUsername (str, optional): The username to send in the HTTP request to transferCompleteFallbackUrl. Defaults to None. + * @param fallbackPassword (str, optional): The password to send in the HTTP request to transferCompleteFallbackUrl. 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 cleared. May be cleared by setting tag="" Max length 256 characters. Defaults to None. + * @param diversionTreatment (str, optional): Can be any of the following: + * none: No diversion headers are sent on the outbound leg of the transferred call. + * propagate: Copy the Diversion header from the inbound leg to the outbound leg. Ignored if there is no Diversion header present on the inbound leg. + * stack: After propagating any Diversion header from the inbound leg to the outbound leg, stack on top another Diversion header based on the Request-URI of the inbound call. + * Defaults to none. If diversionTreatment is not specified, no diversion header will be included for the transfer even if one came with the inbound call. Defaults to None. + * @param diversionReason (str, optional): Can be any of the following values: + * unknown + * user-busy + * no-answer + * unavailable + * unconditional + * time-of-day + * do-not-disturb + * deflection + * follow-me + * out-of-service + * away + * + * This parameter is considered only when diversionTreatment is set to stack. Defaults is unknown. + * Defaults to None. + * + */ public class Transfer implements Verb { - /** - * - * @param destinations (list[PhoneNumber, SipUri], optional): List of recipients to transfer a call to. Defaults to []. - * @param transferCallerId (str, optional): The caller ID to use when the call is transferred, if different. Must be in E.164 format (e.g. +15555555555) or be one of the following strings Restricted, Anonymous, Private, or Unavailable. Leave as default to pass along the number of the remote party. Defaults to None. - * @param transferCallerDisplayName (str, optional): The caller display name to use when the call is transferred. May not exceed 256 characters nor contain control characters such as new lines. - * @param callTimeout (double, optional):The timeout (in seconds) for the callee to answer the call after it starts ringing. If the call does not start ringing within 30s, the call will be cancelled regardless of this value. Range: decimal values between 1 - 300. Default value is 30 seconds. Defaults to None. - * @param transferCompleteUrl (str, optional): URL to send the Transfer Complete event to and request new BXML. Optional but recommended. See below for further details. May be a relative URL. Defaults to None. - * @param transferCompleteMethod (str, optional): The HTTP method to use for the request to transferCompleteUrl. GET or POST. Default value is POST. Defaults to None. - * @param transferCompleteFallbackUrl (str, optional): A fallback url which, if provided, will be used to retry the Transfer Complete callback delivery in case transferCompleteUrl fails to respond. Defaults to None. - * @param transferCompleteFallbackMethod (str, optional): The HTTP method to use to deliver the Transfer Complete callback to transferCompleteFallbackUrl. GET or POST. Default value is POST. Defaults to None. - * @param username (str, optional): The username to send in the HTTP request to transferCompleteUrl. Defaults to None. - * @param password (str, optional): The password to send in the HTTP request to transferCompleteUrl. Defaults to None. - * @param fallbackUsername (str, optional): The username to send in the HTTP request to transferCompleteFallbackUrl. Defaults to None. - * @param fallbackPassword (str, optional): The password to send in the HTTP request to transferCompleteFallbackUrl. 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 cleared. May be cleared by setting tag="" Max length 256 characters. Defaults to None. - * @param diversionTreatment (str, optional): Can be any of the following: - * none: No diversion headers are sent on the outbound leg of the transferred call. - * propagate: Copy the Diversion header from the inbound leg to the outbound leg. Ignored if there is no Diversion header present on the inbound leg. - * stack: After propagating any Diversion header from the inbound leg to the outbound leg, stack on top another Diversion header based on the Request-URI of the inbound call. - * Defaults to none. If diversionTreatment is not specified, no diversion header will be included for the transfer even if one came with the inbound call. Defaults to None. - * @param diversionReason (str, optional): Can be any of the following values: - * unknown - * user-busy - * no-answer - * unavailable - * unconditional - * time-of-day - * do-not-disturb - * deflection - * follow-me - * out-of-service - * away - * - * This parameter is considered only when diversionTreatment is set to stack. Defaults is unknown. - * Defaults to None. - * - */ public static final String TYPE_NAME = "Transfer";