Package com.zendesk.sunshine_conversations_client.model

Class Client

  • public class Client
extends java.lang.Object
    Client

    • Field Detail

      • JSON_PROPERTY_ID

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

      • JSON_PROPERTY_TYPE

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

      • JSON_PROPERTY_STATUS

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

      • JSON_PROPERTY_INTEGRATION_ID

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

      • JSON_PROPERTY_EXTERNAL_ID

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

      • JSON_PROPERTY_LAST_SEEN

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

      • JSON_PROPERTY_LINKED_AT

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

      • JSON_PROPERTY_DISPLAY_NAME

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

      • JSON_PROPERTY_AVATAR_URL

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

      • JSON_PROPERTY_INFO

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

      • JSON_PROPERTY_RAW

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

    • Constructor Detail

      • Client

        public Client()

    • Method Detail

      • id

        public Client id​(java.lang.String id)

      • getId

        @Nullable
public java.lang.String getId()
        The unique ID of the client.
        Returns:
        id

      • setId

        public void setId​(java.lang.String id)

      • getType

        @Nullable
public ClientType getType()
        Get type
        Returns:
        type

      • setType

        public void setType​(ClientType type)

      • getStatus

        @Nullable
public Client.StatusEnum getStatus()
        The client status. Indicates if the client is able to receive messages or not. Can be pending, inactive, active, or blocked.
        Returns:
        status

      • integrationId

        public Client integrationId​(java.lang.String integrationId)

      • getIntegrationId

        @Nullable
public java.lang.String getIntegrationId()
        The ID of the integration that the client was created for. Unused for clients of type sdk, as they incorporate multiple integrations.
        Returns:
        integrationId

      • getIntegrationId_JsonNullable

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

      • setIntegrationId_JsonNullable

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

      • setIntegrationId

        public void setIntegrationId​(java.lang.String integrationId)

      • externalId

        public Client externalId​(java.lang.String externalId)

      • getExternalId

        @Nullable
public java.lang.String getExternalId()
        The ID of the user on an external channel. For example, the user’s phone number for Twilio, or their page-scoped user ID for Facebook Messenger. Applies only to non-SDK clients.
        Returns:
        externalId

      • getExternalId_JsonNullable

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

      • setExternalId_JsonNullable

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

      • setExternalId

        public void setExternalId​(java.lang.String externalId)

      • lastSeen

        public Client lastSeen​(java.lang.String lastSeen)

      • getLastSeen

        @Nullable
public java.lang.String getLastSeen()
        A datetime string with the format `YYYY-MM-DDThh:mm:ss.SSSZ` representing the last time the user interacted with this client.
        Returns:
        lastSeen

      • getLastSeen_JsonNullable

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

      • setLastSeen_JsonNullable

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

      • setLastSeen

        public void setLastSeen​(java.lang.String lastSeen)

      • linkedAt

        public Client linkedAt​(java.lang.String linkedAt)

      • getLinkedAt

        @Nullable
public java.lang.String getLinkedAt()
        A timestamp signifying when the client was added to the user. Formatted as `YYYY-MM-DDThh:mm:ss.SSSZ`.
        Returns:
        linkedAt

      • getLinkedAt_JsonNullable

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

      • setLinkedAt_JsonNullable

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

      • setLinkedAt

        public void setLinkedAt​(java.lang.String linkedAt)

      • displayName

        public Client displayName​(java.lang.String displayName)

      • getDisplayName

        @Nullable
public java.lang.String getDisplayName()
        The user's display name on the channel.
        Returns:
        displayName

      • getDisplayName_JsonNullable

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

      • setDisplayName_JsonNullable

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

      • setDisplayName

        public void setDisplayName​(java.lang.String displayName)

      • avatarUrl

        public Client avatarUrl​(java.net.URI avatarUrl)

      • getAvatarUrl

        @Nullable
public java.net.URI getAvatarUrl()
        The URL for the user's avatar on the channel.
        Returns:
        avatarUrl

      • getAvatarUrl_JsonNullable

        public org.openapitools.jackson.nullable.JsonNullable<java.net.URI> getAvatarUrl_JsonNullable()

      • setAvatarUrl_JsonNullable

        public void setAvatarUrl_JsonNullable​(org.openapitools.jackson.nullable.JsonNullable<java.net.URI> avatarUrl)

      • setAvatarUrl

        public void setAvatarUrl​(java.net.URI avatarUrl)

      • info

        public Client info​(java.lang.Object info)

      • getInfo

        @Nullable
public java.lang.Object getInfo()
        A flat curated object with properties that vary for each client platform. All keys are optional and not guaranteed to be available.
        Returns:
        info

      • getInfo_JsonNullable

        public org.openapitools.jackson.nullable.JsonNullable<java.lang.Object> getInfo_JsonNullable()

      • setInfo_JsonNullable

        public void setInfo_JsonNullable​(org.openapitools.jackson.nullable.JsonNullable<java.lang.Object> info)

      • setInfo

        public void setInfo​(java.lang.Object info)

      • raw

        public Client raw​(java.lang.Object raw)

      • getRaw

        @Nullable
public java.lang.Object getRaw()
        An object with raw properties that vary for each client platform. All keys are optional and not guaranteed to be available.
        Returns:
        raw

      • getRaw_JsonNullable

        public org.openapitools.jackson.nullable.JsonNullable<java.lang.Object> getRaw_JsonNullable()

      • setRaw_JsonNullable

        public void setRaw_JsonNullable​(org.openapitools.jackson.nullable.JsonNullable<java.lang.Object> raw)

      • setRaw

        public void setRaw​(java.lang.Object raw)

      • equals

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

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object