Package com.zendesk.sunshine_conversations_client.model

Class Web

    • Field Detail

      • JSON_PROPERTY_TYPE

        public static final java.lang.String JSON_PROPERTY_TYPE
        See Also:
        Constant Field Values

      • type

        protected java.lang.String type

      • JSON_PROPERTY_BRAND_COLOR

        public static final java.lang.String JSON_PROPERTY_BRAND_COLOR
        See Also:
        Constant Field Values

      • JSON_PROPERTY_FIXED_INTRO_PANE

        public static final java.lang.String JSON_PROPERTY_FIXED_INTRO_PANE
        See Also:
        Constant Field Values

      • JSON_PROPERTY_CONVERSATION_COLOR

        public static final java.lang.String JSON_PROPERTY_CONVERSATION_COLOR
        See Also:
        Constant Field Values

      • JSON_PROPERTY_ACTION_COLOR

        public static final java.lang.String JSON_PROPERTY_ACTION_COLOR
        See Also:
        Constant Field Values

      • JSON_PROPERTY_DISPLAY_STYLE

        public static final java.lang.String JSON_PROPERTY_DISPLAY_STYLE
        See Also:
        Constant Field Values

      • JSON_PROPERTY_BUTTON_ICON_URL

        public static final java.lang.String JSON_PROPERTY_BUTTON_ICON_URL
        See Also:
        Constant Field Values

      • JSON_PROPERTY_BUTTON_WIDTH

        public static final java.lang.String JSON_PROPERTY_BUTTON_WIDTH
        See Also:
        Constant Field Values

      • JSON_PROPERTY_BUTTON_HEIGHT

        public static final java.lang.String JSON_PROPERTY_BUTTON_HEIGHT
        See Also:
        Constant Field Values

      • JSON_PROPERTY_INTEGRATION_ORDER

        public static final java.lang.String JSON_PROPERTY_INTEGRATION_ORDER
        See Also:
        Constant Field Values

      • JSON_PROPERTY_BUSINESS_NAME

        public static final java.lang.String JSON_PROPERTY_BUSINESS_NAME
        See Also:
        Constant Field Values

      • JSON_PROPERTY_BUSINESS_ICON_URL

        public static final java.lang.String JSON_PROPERTY_BUSINESS_ICON_URL
        See Also:
        Constant Field Values

      • JSON_PROPERTY_BACKGROUND_IMAGE_URL

        public static final java.lang.String JSON_PROPERTY_BACKGROUND_IMAGE_URL
        See Also:
        Constant Field Values

      • JSON_PROPERTY_ORIGIN_WHITELIST

        public static final java.lang.String JSON_PROPERTY_ORIGIN_WHITELIST
        See Also:
        Constant Field Values

      • JSON_PROPERTY_PRECHAT_CAPTURE

        public static final java.lang.String JSON_PROPERTY_PRECHAT_CAPTURE
        See Also:
        Constant Field Values

      • JSON_PROPERTY_CAN_USER_SEE_CONVERSATION_LIST

        public static final java.lang.String JSON_PROPERTY_CAN_USER_SEE_CONVERSATION_LIST
        See Also:
        Constant Field Values

      • JSON_PROPERTY_CAN_USER_CREATE_MORE_CONVERSATIONS

        public static final java.lang.String JSON_PROPERTY_CAN_USER_CREATE_MORE_CONVERSATIONS
        See Also:
        Constant Field Values

      • JSON_PROPERTY_ATTACHMENTS_ENABLED

        public static final java.lang.String JSON_PROPERTY_ATTACHMENTS_ENABLED
        See Also:
        Constant Field Values

      • JSON_PROPERTY_DEFAULT_RESPONDER_ID

        public static final java.lang.String JSON_PROPERTY_DEFAULT_RESPONDER_ID
        See Also:
        Constant Field Values

      • JSON_PROPERTY_DEFAULT_RESPONDER

        public static final java.lang.String JSON_PROPERTY_DEFAULT_RESPONDER
        See Also:
        Constant Field Values

    • Constructor Detail

      • Web

        public Web()

    • Method Detail

      • type

        public Web type​(java.lang.String type)
        Overrides:
        type in class Integration

      • getType

        @Nullable
public java.lang.String getType()
        To configure a Web Messenger integration, acquire the required information and call the Create Integration endpoint.
        Overrides:
        getType in class Integration
        Returns:
        type

      • setType

        public void setType​(java.lang.String type)
        Overrides:
        setType in class Integration

      • brandColor

        public Web brandColor​(java.lang.String brandColor)

      • getBrandColor

        @Nullable
public java.lang.String getBrandColor()
        This color will be used in the messenger header and the button or tab in idle state. Must be a 3 or 6-character hexadecimal color.
        Returns:
        brandColor

      • setBrandColor

        public void setBrandColor​(java.lang.String brandColor)

      • fixedIntroPane

        public Web fixedIntroPane​(java.lang.Boolean fixedIntroPane)

      • getFixedIntroPane

        @Nullable
public java.lang.Boolean getFixedIntroPane()
        When true, the introduction pane will be pinned at the top of the conversation instead of scrolling with it.
        Returns:
        fixedIntroPane

      • setFixedIntroPane

        public void setFixedIntroPane​(java.lang.Boolean fixedIntroPane)

      • conversationColor

        public Web conversationColor​(java.lang.String conversationColor)

      • getConversationColor

        @Nullable
public java.lang.String getConversationColor()
        This color will be used for customer messages, quick replies and actions in the footer. Must be a 3 or 6-character hexadecimal color.
        Returns:
        conversationColor

      • setConversationColor

        public void setConversationColor​(java.lang.String conversationColor)

      • actionColor

        public Web actionColor​(java.lang.String actionColor)

      • getActionColor

        @Nullable
public java.lang.String getActionColor()
        This color will be used for call-to-actions inside your messages. Must be a 3 or 6-character hexadecimal color.
        Returns:
        actionColor

      • setActionColor

        public void setActionColor​(java.lang.String actionColor)

      • displayStyle

        public Web displayStyle​(java.lang.String displayStyle)

      • getDisplayStyle

        @Nullable
public java.lang.String getDisplayStyle()
        Choose how the messenger will appear on your website. Must be either button or tab.
        Returns:
        displayStyle

      • setDisplayStyle

        public void setDisplayStyle​(java.lang.String displayStyle)

      • buttonIconUrl

        public Web buttonIconUrl​(java.lang.String buttonIconUrl)

      • getButtonIconUrl

        @Nullable
public java.lang.String getButtonIconUrl()
        With the button style Web Messenger, you have the option of selecting your own button icon. The image must be at least 200 x 200 pixels and must be in either JPG, PNG, or GIF format.
        Returns:
        buttonIconUrl

      • getButtonIconUrl_JsonNullable

        public org.openapitools.jackson.nullable.JsonNullable<java.lang.String> getButtonIconUrl_JsonNullable()

      • setButtonIconUrl_JsonNullable

        public void setButtonIconUrl_JsonNullable​(org.openapitools.jackson.nullable.JsonNullable<java.lang.String> buttonIconUrl)

      • setButtonIconUrl

        public void setButtonIconUrl​(java.lang.String buttonIconUrl)

      • buttonWidth

        public Web buttonWidth​(java.lang.String buttonWidth)

      • getButtonWidth

        @Nullable
public java.lang.String getButtonWidth()
        With the button style Web Messenger, you have the option of specifying the button width.
        Returns:
        buttonWidth

      • setButtonWidth

        public void setButtonWidth​(java.lang.String buttonWidth)

      • buttonHeight

        public Web buttonHeight​(java.lang.String buttonHeight)

      • getButtonHeight

        @Nullable
public java.lang.String getButtonHeight()
        With the button style Web Messenger, you have the option of specifying the button height.
        Returns:
        buttonHeight

      • setButtonHeight

        public void setButtonHeight​(java.lang.String buttonHeight)

      • integrationOrder

        public Web integrationOrder​(java.util.List<java.lang.String> integrationOrder)

      • addIntegrationOrderItem

        public Web addIntegrationOrderItem​(java.lang.String integrationOrderItem)

      • getIntegrationOrder

        @Nullable
public java.util.List<java.lang.String> getIntegrationOrder()
        Array of integration IDs, order will be reflected in the Web Messenger. When set, only integrations from this list will be displayed in the Web Messenger. If unset, all integrations will be displayed.
        Returns:
        integrationOrder

      • getIntegrationOrder_JsonNullable

        public org.openapitools.jackson.nullable.JsonNullable<java.util.List<java.lang.String>> getIntegrationOrder_JsonNullable()

      • setIntegrationOrder_JsonNullable

        public void setIntegrationOrder_JsonNullable​(org.openapitools.jackson.nullable.JsonNullable<java.util.List<java.lang.String>> integrationOrder)

      • setIntegrationOrder

        public void setIntegrationOrder​(java.util.List<java.lang.String> integrationOrder)

      • businessName

        public Web businessName​(java.lang.String businessName)

      • getBusinessName

        @Nullable
public java.lang.String getBusinessName()
        A custom business name for the Web Messenger.
        Returns:
        businessName

      • setBusinessName

        public void setBusinessName​(java.lang.String businessName)

      • businessIconUrl

        public Web businessIconUrl​(java.lang.String businessIconUrl)

      • getBusinessIconUrl

        @Nullable
public java.lang.String getBusinessIconUrl()
        A custom business icon url for the Web Messenger. The image must be at least 200 x 200 pixels and must be in either JPG, PNG, or GIF format.
        Returns:
        businessIconUrl

      • setBusinessIconUrl

        public void setBusinessIconUrl​(java.lang.String businessIconUrl)

      • backgroundImageUrl

        public Web backgroundImageUrl​(java.lang.String backgroundImageUrl)

      • getBackgroundImageUrl

        @Nullable
public java.lang.String getBackgroundImageUrl()
        A background image url for the conversation. Image will be tiled to fit the window.
        Returns:
        backgroundImageUrl

      • setBackgroundImageUrl

        public void setBackgroundImageUrl​(java.lang.String backgroundImageUrl)

      • originWhitelist

        public Web originWhitelist​(java.util.List<java.lang.String> originWhitelist)

      • addOriginWhitelistItem

        public Web addOriginWhitelistItem​(java.lang.String originWhitelistItem)

      • getOriginWhitelist

        @Nullable
public java.util.List<java.lang.String> getOriginWhitelist()
        A list of origins to whitelist. When set, only the origins from this list will be able to initialize the Web Messenger. If unset, all origins are whitelisted. The elements in the list should follow the serialized-origin format from RFC 6454: scheme \"://\" host [ \":\" port ], where scheme is http or https.
        Returns:
        originWhitelist

      • getOriginWhitelist_JsonNullable

        public org.openapitools.jackson.nullable.JsonNullable<java.util.List<java.lang.String>> getOriginWhitelist_JsonNullable()

      • setOriginWhitelist_JsonNullable

        public void setOriginWhitelist_JsonNullable​(org.openapitools.jackson.nullable.JsonNullable<java.util.List<java.lang.String>> originWhitelist)

      • setOriginWhitelist

        public void setOriginWhitelist​(java.util.List<java.lang.String> originWhitelist)

      • getPrechatCapture

        @Nullable
public PrechatCapture getPrechatCapture()
        Object whose properties can be set to specify the add-on’s options. See the [guide](https://docs.smooch.io/guide/web-messenger/#prechat-capture) to learn more about Prechat Capture.
        Returns:
        prechatCapture

      • setPrechatCapture

        public void setPrechatCapture​(PrechatCapture prechatCapture)

      • canUserSeeConversationList

        public Web canUserSeeConversationList​(java.lang.Boolean canUserSeeConversationList)

      • getCanUserSeeConversationList

        @Nullable
public java.lang.Boolean getCanUserSeeConversationList()
        Allows users to view their list of conversations. By default, the list of conversations will be visible. *This setting only applies to apps where `settings.multiConvoEnabled` is set to `true`*.
        Returns:
        canUserSeeConversationList

      • setCanUserSeeConversationList

        public void setCanUserSeeConversationList​(java.lang.Boolean canUserSeeConversationList)

      • canUserCreateMoreConversations

        public Web canUserCreateMoreConversations​(java.lang.Boolean canUserCreateMoreConversations)

      • getCanUserCreateMoreConversations

        @Nullable
public java.lang.Boolean getCanUserCreateMoreConversations()
        Allows users to create more than one conversation on the web messenger integration.
        Returns:
        canUserCreateMoreConversations

      • setCanUserCreateMoreConversations

        public void setCanUserCreateMoreConversations​(java.lang.Boolean canUserCreateMoreConversations)

      • getAttachmentsEnabled

        @Nullable
public java.lang.Boolean getAttachmentsEnabled()
        Allows users to send attachments. By default, the setting is set to true. This setting can only be configured in Zendesk Admin Center.
        Returns:
        attachmentsEnabled

      • defaultResponderId

        public Web defaultResponderId​(java.lang.String defaultResponderId)

      • getDefaultResponderId

        @Nullable
public java.lang.String getDefaultResponderId()
        The default responder ID for the integration. This is the ID of the responder that will be used to send messages to the user. For more information, refer to <a href=\"https://docs.smooch.io/guide/switchboard/#per-channel-default-responder\">Per-channel default responder</a> guide.
        Returns:
        defaultResponderId

      • getDefaultResponderId_JsonNullable

        public org.openapitools.jackson.nullable.JsonNullable<java.lang.String> getDefaultResponderId_JsonNullable()

      • setDefaultResponderId_JsonNullable

        public void setDefaultResponderId_JsonNullable​(org.openapitools.jackson.nullable.JsonNullable<java.lang.String> defaultResponderId)

      • setDefaultResponderId

        public void setDefaultResponderId​(java.lang.String defaultResponderId)

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class Integration