streams-contrib/streams-provider-twitter/src/main/jsonschema/org/apache/streams/twitter/pojo/QuickReply.json

{
    "$schema": "http://json-schema.org/draft-03/schema",
    "$license": [
        "http://www.apache.org/licenses/LICENSE-2.0"
    ],
    "id": "#",
    "type": "object",
    "javaType" : "org.apache.streams.twitter.pojo.QuickReply",
    "javaInterfaces": ["java.io.Serializable"],
    "description": "",
    "properties": {
        "type": {
            "type": "string",
            "enum" : [
                "options",
                "location",
                "text_input"
            ]
        },
        "text_input": {
            "type": "object",
            "javaType": "org.apache.streams.twitter.pojo.QuickReplyTextInput",
            "properties": {
                "label": {
                    "type": "string",
                    "description": "The hint text in the text input. String, max length of 36 characters including spaces.",
                    "required": true
                },
                "keyboard": {
                    "type": "string",
                    "description": "The predefined keyboard type. String, value of “default” (standard text entry) or “number” (numeric entry).",
                    "required": false
                },
                "metadata": {
                    "type": "string",
                    "description": "Metadata that will be sent back in the webhook request. String, max length of 1,000 characters including spaces.",
                    "required": false
                }
            }
        },
        "options": {
            "type": "array",
            "items": {
                "type": "object",
                "javaType": "org.apache.streams.twitter.pojo.QuickReplyOption",
                "properties": {
                    "label": {
                        "type": "string",
                        "description": "The text label displayed on the button face. Label text is returned as the user’s message response. String, max length of 36 characters including spaces. Values with URLs are not allowed and will return an error.",
                        "required": true
                    },
                    "description": {
                        "type": "string",
                        "description": "Optional description text displayed under label text. All options must have this property defined if property is present in any option. Text is auto-wrapped and will display on a max of two lines and supports \n for controling line breaks. Description text is not include in the user’s message response. String, max length of 72 characters including spaces.",
                        "required": false
                    },
                    "metadata": {
                        "type": "string",
                        "description": "Metadata that will be sent back in the webhook request. String, max length of 1,000 characters including spaces.",
                        "required": false
                    }
                }
            }
        },
        "location": {
            "type": "object",
            "javaType": "org.apache.streams.twitter.pojo.QuickReplyTextInput",
            "properties": {
                "type": {
                    "type": "string",
                    "description": "String value of shared_coordinate or shared_place",
                    "required": true,
                    "enum": [
                        "shared_coordinate",
                        "shared_place"
                    ]
                },
                "shared_coordinate": {
                    "type": "object",
                    "properties": {
                        "type": {
                            "type": "string",
                            "enum": [
                                "Point"
                            ]
                        },
                        "coordinates": {
                            "type": "array",
                            "items": {
                                "type": "number"
                            }
                        }
                    }
                },
                "shared_place": {
                    "type": "object",
                    "properties": {
                        "place": {
                            "type": "object",
                            "properties": {
                                "id": {
                                    "description": "Not all place IDs are discoverable with `GET geo/search </rest/reference/get/geo/search>`_. To retrieve all available details for a place ID you may also use `GET geo/id/:place_id </rest/reference/get/geo/id/place_id>`_.",
                                    "type": "string"
                                }
                            }
                        }
                    }
                },
                "metadata": {
                    "type": "string",
                    "description": "Metadata that will be sent back in the webhook request. String, max length of 1,000 characters including spaces.",
                    "required": false
                }
            }
        }
    }
}