com.pulumi.gcp.diagflow.kotlin.inputs.CxPageEventHandlerTriggerFulfillmentMessageArgs.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-gcp-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
There is a newer version: 8.10.0.0
Show newest version
@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.gcp.diagflow.kotlin.inputs

import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.gcp.diagflow.inputs.CxPageEventHandlerTriggerFulfillmentMessageArgs.builder
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.applySuspend
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.jvm.JvmName

/**
 *
 * @property channel The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
 * @property conversationSuccess Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about.
 * Dialogflow only uses this to determine which conversations should be counted as successful and doesn't process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don't return ConversationSuccess.
 * You may set this, for example:
 * * In the entryFulfillment of a Page if entering the page indicates that the conversation succeeded.
 * * In a webhook response when you determine that you handled the customer issue.
 * Structure is documented below.
 * @property liveAgentHandoff Indicates that the conversation should be handed off to a live agent.
 * Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures.
 * You may set this, for example:
 * * In the entryFulfillment of a Page if entering the page indicates something went extremely wrong in the conversation.
 * * In a webhook response when you determine that the customer issue can only be handled by a human.
 * Structure is documented below.
 * @property outputAudioText A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
 * Structure is documented below.
 * @property payload A custom, platform-specific payload.
 * @property playAudio Specifies an audio clip to be played by the client as part of the response.
 * Structure is documented below.
 * @property telephonyTransferCall Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint.
 * Structure is documented below.
 * @property text The text response message.
 * Structure is documented below.
 */
public data class CxPageEventHandlerTriggerFulfillmentMessageArgs(
    public val channel: Output? = null,
    public val conversationSuccess: Output? = null,
    public val liveAgentHandoff: Output? = null,
    public val outputAudioText: Output? = null,
    public val payload: Output? = null,
    public val playAudio: Output? = null,
    public val telephonyTransferCall: Output? = null,
    public val text: Output? = null,
) :
    ConvertibleToJava {
    override fun toJava(): com.pulumi.gcp.diagflow.inputs.CxPageEventHandlerTriggerFulfillmentMessageArgs =
        com.pulumi.gcp.diagflow.inputs.CxPageEventHandlerTriggerFulfillmentMessageArgs.builder()
            .channel(channel?.applyValue({ args0 -> args0 }))
            .conversationSuccess(
                conversationSuccess?.applyValue({ args0 ->
                    args0.let({ args0 ->
                        args0.toJava()
                    })
                }),
            )
            .liveAgentHandoff(liveAgentHandoff?.applyValue({ args0 -> args0.let({ args0 -> args0.toJava() }) }))
            .outputAudioText(outputAudioText?.applyValue({ args0 -> args0.let({ args0 -> args0.toJava() }) }))
            .payload(payload?.applyValue({ args0 -> args0 }))
            .playAudio(playAudio?.applyValue({ args0 -> args0.let({ args0 -> args0.toJava() }) }))
            .telephonyTransferCall(
                telephonyTransferCall?.applyValue({ args0 ->
                    args0.let({ args0 ->
                        args0.toJava()
                    })
                }),
            )
            .text(text?.applyValue({ args0 -> args0.let({ args0 -> args0.toJava() }) })).build()
}

/**
 * Builder for [CxPageEventHandlerTriggerFulfillmentMessageArgs].
 */
@PulumiTagMarker
public class CxPageEventHandlerTriggerFulfillmentMessageArgsBuilder internal constructor() {
    private var channel: Output? = null

    private var conversationSuccess:
        Output? = null

    private var liveAgentHandoff:
        Output? = null

    private var outputAudioText:
        Output? = null

    private var payload: Output? = null

    private var playAudio: Output? = null

    private var telephonyTransferCall:
        Output? = null

    private var text: Output? = null

    /**
     * @param value The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
     */
    @JvmName("cwxtcxpspqpddxcc")
    public suspend fun channel(`value`: Output) {
        this.channel = value
    }

    /**
     * @param value Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about.
     * Dialogflow only uses this to determine which conversations should be counted as successful and doesn't process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don't return ConversationSuccess.
     * You may set this, for example:
     * * In the entryFulfillment of a Page if entering the page indicates that the conversation succeeded.
     * * In a webhook response when you determine that you handled the customer issue.
     * Structure is documented below.
     */
    @JvmName("rhjddwqtaaacyyjb")
    public suspend fun conversationSuccess(`value`: Output) {
        this.conversationSuccess = value
    }

    /**
     * @param value Indicates that the conversation should be handed off to a live agent.
     * Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures.
     * You may set this, for example:
     * * In the entryFulfillment of a Page if entering the page indicates something went extremely wrong in the conversation.
     * * In a webhook response when you determine that the customer issue can only be handled by a human.
     * Structure is documented below.
     */
    @JvmName("tswmoorfayyyfnna")
    public suspend fun liveAgentHandoff(`value`: Output) {
        this.liveAgentHandoff = value
    }

    /**
     * @param value A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
     * Structure is documented below.
     */
    @JvmName("cxuhtfdooofcwpbt")
    public suspend fun outputAudioText(`value`: Output) {
        this.outputAudioText = value
    }

    /**
     * @param value A custom, platform-specific payload.
     */
    @JvmName("ujonjyrwjqhddcyv")
    public suspend fun payload(`value`: Output) {
        this.payload = value
    }

    /**
     * @param value Specifies an audio clip to be played by the client as part of the response.
     * Structure is documented below.
     */
    @JvmName("hvjjltulmxyqcbgf")
    public suspend fun playAudio(`value`: Output) {
        this.playAudio = value
    }

    /**
     * @param value Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint.
     * Structure is documented below.
     */
    @JvmName("kctilcuqybwvmgct")
    public suspend fun telephonyTransferCall(`value`: Output) {
        this.telephonyTransferCall = value
    }

    /**
     * @param value The text response message.
     * Structure is documented below.
     */
    @JvmName("tfumbwritlnvsmdg")
    public suspend fun text(`value`: Output) {
        this.text = value
    }

    /**
     * @param value The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
     */
    @JvmName("dlignkjigimmjkmp")
    public suspend fun channel(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.channel = mapped
    }

    /**
     * @param value Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about.
     * Dialogflow only uses this to determine which conversations should be counted as successful and doesn't process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don't return ConversationSuccess.
     * You may set this, for example:
     * * In the entryFulfillment of a Page if entering the page indicates that the conversation succeeded.
     * * In a webhook response when you determine that you handled the customer issue.
     * Structure is documented below.
     */
    @JvmName("inspxfyhltkwcbgs")
    public suspend fun conversationSuccess(`value`: CxPageEventHandlerTriggerFulfillmentMessageConversationSuccessArgs?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.conversationSuccess = mapped
    }

    /**
     * @param argument Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about.
     * Dialogflow only uses this to determine which conversations should be counted as successful and doesn't process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don't return ConversationSuccess.
     * You may set this, for example:
     * * In the entryFulfillment of a Page if entering the page indicates that the conversation succeeded.
     * * In a webhook response when you determine that you handled the customer issue.
     * Structure is documented below.
     */
    @JvmName("hfuljpcgibvyxskd")
    public suspend fun conversationSuccess(argument: suspend CxPageEventHandlerTriggerFulfillmentMessageConversationSuccessArgsBuilder.() -> Unit) {
        val toBeMapped =
            CxPageEventHandlerTriggerFulfillmentMessageConversationSuccessArgsBuilder().applySuspend {
                argument()
            }.build()
        val mapped = of(toBeMapped)
        this.conversationSuccess = mapped
    }

    /**
     * @param value Indicates that the conversation should be handed off to a live agent.
     * Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures.
     * You may set this, for example:
     * * In the entryFulfillment of a Page if entering the page indicates something went extremely wrong in the conversation.
     * * In a webhook response when you determine that the customer issue can only be handled by a human.
     * Structure is documented below.
     */
    @JvmName("octhtbfnlltrhsnc")
    public suspend fun liveAgentHandoff(`value`: CxPageEventHandlerTriggerFulfillmentMessageLiveAgentHandoffArgs?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.liveAgentHandoff = mapped
    }

    /**
     * @param argument Indicates that the conversation should be handed off to a live agent.
     * Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures.
     * You may set this, for example:
     * * In the entryFulfillment of a Page if entering the page indicates something went extremely wrong in the conversation.
     * * In a webhook response when you determine that the customer issue can only be handled by a human.
     * Structure is documented below.
     */
    @JvmName("hmuhekdvcjtndjul")
    public suspend fun liveAgentHandoff(argument: suspend CxPageEventHandlerTriggerFulfillmentMessageLiveAgentHandoffArgsBuilder.() -> Unit) {
        val toBeMapped =
            CxPageEventHandlerTriggerFulfillmentMessageLiveAgentHandoffArgsBuilder().applySuspend {
                argument()
            }.build()
        val mapped = of(toBeMapped)
        this.liveAgentHandoff = mapped
    }

    /**
     * @param value A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
     * Structure is documented below.
     */
    @JvmName("whpuqmfwkfdbibll")
    public suspend fun outputAudioText(`value`: CxPageEventHandlerTriggerFulfillmentMessageOutputAudioTextArgs?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.outputAudioText = mapped
    }

    /**
     * @param argument A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
     * Structure is documented below.
     */
    @JvmName("bcgigmwjbamnojga")
    public suspend fun outputAudioText(argument: suspend CxPageEventHandlerTriggerFulfillmentMessageOutputAudioTextArgsBuilder.() -> Unit) {
        val toBeMapped =
            CxPageEventHandlerTriggerFulfillmentMessageOutputAudioTextArgsBuilder().applySuspend {
                argument()
            }.build()
        val mapped = of(toBeMapped)
        this.outputAudioText = mapped
    }

    /**
     * @param value A custom, platform-specific payload.
     */
    @JvmName("wsuoebtxfgaxbydo")
    public suspend fun payload(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.payload = mapped
    }

    /**
     * @param value Specifies an audio clip to be played by the client as part of the response.
     * Structure is documented below.
     */
    @JvmName("gjufuksjmpoxomfu")
    public suspend fun playAudio(`value`: CxPageEventHandlerTriggerFulfillmentMessagePlayAudioArgs?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.playAudio = mapped
    }

    /**
     * @param argument Specifies an audio clip to be played by the client as part of the response.
     * Structure is documented below.
     */
    @JvmName("lksnmbnwimcvwtgx")
    public suspend fun playAudio(argument: suspend CxPageEventHandlerTriggerFulfillmentMessagePlayAudioArgsBuilder.() -> Unit) {
        val toBeMapped = CxPageEventHandlerTriggerFulfillmentMessagePlayAudioArgsBuilder().applySuspend {
            argument()
        }.build()
        val mapped = of(toBeMapped)
        this.playAudio = mapped
    }

    /**
     * @param value Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint.
     * Structure is documented below.
     */
    @JvmName("pqxfbssgofjsyvbt")
    public suspend fun telephonyTransferCall(`value`: CxPageEventHandlerTriggerFulfillmentMessageTelephonyTransferCallArgs?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.telephonyTransferCall = mapped
    }

    /**
     * @param argument Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint.
     * Structure is documented below.
     */
    @JvmName("svnaelnvnqhjhrxl")
    public suspend fun telephonyTransferCall(argument: suspend CxPageEventHandlerTriggerFulfillmentMessageTelephonyTransferCallArgsBuilder.() -> Unit) {
        val toBeMapped =
            CxPageEventHandlerTriggerFulfillmentMessageTelephonyTransferCallArgsBuilder().applySuspend {
                argument()
            }.build()
        val mapped = of(toBeMapped)
        this.telephonyTransferCall = mapped
    }

    /**
     * @param value The text response message.
     * Structure is documented below.
     */
    @JvmName("gnsigtgnlvdaroav")
    public suspend fun text(`value`: CxPageEventHandlerTriggerFulfillmentMessageTextArgs?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.text = mapped
    }

    /**
     * @param argument The text response message.
     * Structure is documented below.
     */
    @JvmName("uyqffivsikuxyibo")
    public suspend fun text(argument: suspend CxPageEventHandlerTriggerFulfillmentMessageTextArgsBuilder.() -> Unit) {
        val toBeMapped = CxPageEventHandlerTriggerFulfillmentMessageTextArgsBuilder().applySuspend {
            argument()
        }.build()
        val mapped = of(toBeMapped)
        this.text = mapped
    }

    internal fun build(): CxPageEventHandlerTriggerFulfillmentMessageArgs =
        CxPageEventHandlerTriggerFulfillmentMessageArgs(
            channel = channel,
            conversationSuccess = conversationSuccess,
            liveAgentHandoff = liveAgentHandoff,
            outputAudioText = outputAudioText,
            payload = payload,
            playAudio = playAudio,
            telephonyTransferCall = telephonyTransferCall,
            text = text,
        )
}