Serialized Form (FB-BotMill 1.0.0 API)

Package co.aurasphere.botmill.fb
- Class co.aurasphere.botmill.fb.FbBotMillServlet extends javax.servlet.http.HttpServlet implements Serializable
  
  serialVersionUID:
  
  1L
Package co.aurasphere.botmill.fb.exception
- Class co.aurasphere.botmill.fb.exception.FbBotMillIllegalAttachmentException extends IllegalArgumentException implements Serializable
  
  serialVersionUID:
  
  1L
Package co.aurasphere.botmill.fb.model.base
- Class co.aurasphere.botmill.fb.model.base.Attachment extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - title
```
String title
```
      The title.
    - url
```
String url
```
      The url.
    - type
```
AttachmentType type
```
      The attachment type.
    - payload
```
Payload payload
```
      The payload of the attachment.
- Class co.aurasphere.botmill.fb.model.base.QuickReplyLocationPayload extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - coordinates
```
LocationCoordinates coordinates
```
      The coordinates.
- Class co.aurasphere.botmill.fb.model.base.User extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - id
```
String id
```
      The Facebook's user ID.
Package co.aurasphere.botmill.fb.model.incoming
- Class co.aurasphere.botmill.fb.model.incoming.FacebookError extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - message
```
String message
```
      The error message.
    - type
```
String type
```
      The error type.
    - code
```
String code
```
      The error code.
    - fbTraceId
```
String fbTraceId
```
      The error Facebook's trace ID.
- Class co.aurasphere.botmill.fb.model.incoming.FacebookErrorMessage extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - error
```
FacebookError error
```
      The error from Facebook.
- Class co.aurasphere.botmill.fb.model.incoming.MessageEnvelope extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - sender
```
User sender
```
      The message sender.
    - recipient
```
User recipient
```
      The message recipient.
    - timestamp
```
String timestamp
```
      The message timestamp.
    - message
```
ReceivedMessage message
```
      Message content for message and message_echoes callback.
    - postback
```
Postback postback
```
      Postback object for messaging_postbacks callback.
    - optin
```
Optin optin
```
      Optin object for messaging_optins callback.
    - accountLinking
```
AccountLinking accountLinking
```
      Object for Account Linking callback.
    - delivery
```
DeliveredMessage delivery
```
      Delivery object for message_deliveries callback.
    - read
```
Read read
```
      Read object for message_reads callback.
    - referral
```
Referral referral
```
      Referral object for messaging_referral callback.
    - payment
```
Payment payment
```
      Payment object for messaging_payments callback.
    - checkoutUpdate
```
CheckoutUpdate checkoutUpdate
```
      Checkout update object for messaging_checkout_updates callback.
- Class co.aurasphere.botmill.fb.model.incoming.MessengerCallback extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - object
```
String object
```
      The type of callback. This always evaluates to "page".
    - entry
```
List<E> entry
```
      A list of MessengerCallbackEntry for the current callback containing event data.
- Class co.aurasphere.botmill.fb.model.incoming.MessengerCallbackEntry extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - id
```
String id
```
      Page ID of page.
    - time
```
String time
```
      Time of update (epoch time in milliseconds).
    - messaging
```
List<E> messaging
```
      A list of MessageEnvelope that contains all the callback details.
Package co.aurasphere.botmill.fb.model.incoming.callback
- Class co.aurasphere.botmill.fb.model.incoming.callback.AccountLinking extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - status
```
String status
```
      May be linked or unlinked.
    - authorizationCode
```
String authorizationCode
```
      Value of pass-through authorization_code provided in the Linking Account flow. This is only available when status is linked.
- Class co.aurasphere.botmill.fb.model.incoming.callback.CheckoutUpdate extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - payload
```
String payload
```
      Metadata defined in the BuyButton.
    - shippingAddress
```
ShippingAddress shippingAddress
```
      The person's shipping address.
- Class co.aurasphere.botmill.fb.model.incoming.callback.DeliveredMessage extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - mids
```
List<E> mids
```
      Messages IDs.
      
      Both mids and DeliveredMessage.watermark fields are used to determine which messages were delivered. watermark is always present and mids is sometimes present. mids provides delivery receipts on a per-message basis but may not be present (due to backward compatibility reasons with older Messenger clients). watermark is always present and is a timestamp indicating that all messages with a timestamp before watermark were delivered.
    - watermark
```
String watermark
```
      All messages before this timestamp where seen.
      
      Both DeliveredMessage.mids and watermark fields are used to determine which messages were delivered. watermark is always present and mids is sometimes present. mids provides delivery receipts on a per-message basis but may not be present (due to backward compatibility reasons with older Messenger clients). watermark is always present and is a timestamp indicating that all messages with a timestamp before watermark were delivered.
    - seq
```
String seq
```
      Sequence number.
- Class co.aurasphere.botmill.fb.model.incoming.callback.EchoMessage extends Message implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - isEcho
```
boolean isEcho
```
      Indicates the message sent from the page itself.
    - appId
```
String appId
```
      ID of the app from which the message was sent.
    - metadata
```
String metadata
```
      Custom string passed to the Send API as the metadata field.
    - mid
```
String mid
```
      Message ID.
    - seq
```
String seq
```
      Sequence number.
    - text
```
String text
```
      Text message.
    - attachments
```
List<E> attachments
```
      Attachments of the message.
- Class co.aurasphere.botmill.fb.model.incoming.callback.LocationCoordinates extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - latitude
```
String latitude
```
    - longitude
```
String longitude
```
- Class co.aurasphere.botmill.fb.model.incoming.callback.Optin extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - ref
```
String ref
```
      Data-ref parameter that was defined with the entry point.
- Class co.aurasphere.botmill.fb.model.incoming.callback.Postback extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - payload
```
String payload
```
      Payload parameter that was defined with the button.
    - referral
```
Referral referral
```
      Comes only with Get Started postback and if an optional ref param was passed from the entry point, such as m.me link.
      
      See Also:
      Facebook's Messenger Platform m.me links Documentation
- Class co.aurasphere.botmill.fb.model.incoming.callback.Read extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - watermark
```
String watermark
```
      All messages that were sent before this timestamp were read. The watermark field is used to determine which messages were read. It represents a timestamp indicating that all messages with a timestamp before watermark were read by the recipient.
    - seq
```
String seq
```
      Sequence number.
- Class co.aurasphere.botmill.fb.model.incoming.callback.ReceivedMessage extends Message implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - mid
```
String mid
```
      Message ID.
    - seq
```
String seq
```
      Message sequence number.
    - text
```
String text
```
      Text of message.
    - quickReply
```
QuickReply quickReply
```
      Optional custom data provided by the sending app.
    - attachments
```
List<E> attachments
```
      Attachment data.
- Class co.aurasphere.botmill.fb.model.incoming.callback.Referral extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - ref
```
String ref
```
      The arbitrary data that was originally passed in the ref param added to the m.me link.
    - source
```
String source
```
      The source of this referral. Currently, the only possible value is “SHORTLINK”.
    - type
```
String type
```
      The identifier for the referral. For referrals coming from m.me links, it will always be "OPEN_THREAD".
- Class co.aurasphere.botmill.fb.model.incoming.callback.ShippingAddress extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - id
```
String id
```
      ID of shipping address.
    - country
```
String country
```
      Shipping address country.
    - city
```
String city
```
      Shipping address city.
    - street1
```
String street1
```
      Shipping address street, first line.
    - street2
```
String street2
```
      Shipping address street, second line.
    - state
```
String state
```
      Shipping address state.
    - postalCode
```
String postalCode
```
      Shipping address postal code.
Package co.aurasphere.botmill.fb.model.incoming.callback.payment
- Class co.aurasphere.botmill.fb.model.incoming.callback.payment.Payment extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - payload
```
String payload
```
      Metadata defined in the Buy Button.
    - requestedUserInfo
```
RequestedUserInfo requestedUserInfo
```
      Information that was requested from the user by the Buy Button.
    - paymentCredential
```
PaymentCredential paymentCredential
```
      Payment credentials.
    - amount
```
PaymentAmount amount
```
      Total amount of transaction.
    - shippingOptionId
```
String shippingOptionId
```
      The option_id of the selected shipping option sent via the checkout update callback. Only applicable for flexible payments.
      
      See Also:
      Facebook's Messenger Platform Checkout Update Callback Documentation
- Class co.aurasphere.botmill.fb.model.incoming.callback.payment.PaymentAmount extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - currency
```
String currency
```
      Currency of the amount.
    - amount
```
BigDecimal amount
```
      Total amount.
- Class co.aurasphere.botmill.fb.model.incoming.callback.payment.PaymentCredential extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - providerType
```
ProviderType providerType
```
      Payment provider type (one of stripe/paypal/token).
    - chargeId
```
String chargeId
```
      Payment provider charge id (for stripe/paypal, null for tokenization), for a test_payment, the charge id will be test_charge_id_12345.
    - tokenizedCard
```
String tokenizedCard
```
      PGP-signed tokenized charge card (null for stripe/paypal).
    - tokenizedCvv
```
String tokenizedCvv
```
      PGP-signed CVV number (null for stripe/paypal).
    - tokenExpiryMonth
```
String tokenExpiryMonth
```
      Expiry month (null for stripe/paypal).
    - tokenExpiryYear
```
String tokenExpiryYear
```
      Expiry year (null for stripe/paypal).
    - fbPaymentId
```
String fbPaymentId
```
      A facebook issued payment id for tracking. If it is a test payment, the id will be test_payment_id_12345.
Package co.aurasphere.botmill.fb.model.outcoming
- Class co.aurasphere.botmill.fb.model.outcoming.FbBotMillResponse extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - recipient
```
User recipient
```
      The recipient of the message.
Package co.aurasphere.botmill.fb.model.outcoming.action
- Class co.aurasphere.botmill.fb.model.outcoming.action.FbBotMillActionResponse extends FbBotMillResponse implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - action
```
TypingAction action
```
      The typing action to send.
Package co.aurasphere.botmill.fb.model.outcoming.message
- Class co.aurasphere.botmill.fb.model.outcoming.message.AttachmentMessage extends Message implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - attachment
```
Attachment attachment
```
      The attachment associated with this message.
- Class co.aurasphere.botmill.fb.model.outcoming.message.FbBotMillMessageResponse extends FbBotMillResponse implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - message
```
Message message
```
      The message associated with this reply.
- Class co.aurasphere.botmill.fb.model.outcoming.message.Message extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - quickReplies
```
List<E> quickReplies
```
      The quick replies of this message.
- Class co.aurasphere.botmill.fb.model.outcoming.message.TextMessage extends Message implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - text
```
String text
```
      The text of this message.
Package co.aurasphere.botmill.fb.model.outcoming.payload
- Class co.aurasphere.botmill.fb.model.outcoming.payload.UrlPayload extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - url
```
String url
```
      The URL associated with this payload.
Package co.aurasphere.botmill.fb.model.outcoming.payload.template
- Class co.aurasphere.botmill.fb.model.outcoming.payload.template.ButtonTemplatePayload extends TemplateBasePayload implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - text
```
String text
```
      UTF-8 encoded text of up to 320 characters that appears the in main body.
    - buttons
```
List<E> buttons
```
      Set of, one to three, buttons that appear as call-to-actions.
- Class co.aurasphere.botmill.fb.model.outcoming.payload.template.GenericTemplatePayload extends TemplateBasePayload implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - elements
```
List<E> elements
```
      Data for each bubble in message. Elements are limited to .
- Class co.aurasphere.botmill.fb.model.outcoming.payload.template.ListTemplatePayload extends TemplateBasePayload implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - elements
```
List<E> elements
```
      List view elements (maximum of 4 elements and minimum of 2 elements).
    - buttons
```
List<E> buttons
```
      List view elements (maximum of 4 elements and minimum of 2 elements).
    - topElementStyle
```
TopElementStyle topElementStyle
```
      Value must be large or compact. Default to large if not specified.
- Class co.aurasphere.botmill.fb.model.outcoming.payload.template.ReceiptTemplatePayload extends TemplateBasePayload implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - recipientName
```
String recipientName
```
      The recipient name.
    - merchantName
```
String merchantName
```
      The merchant name.
    - orderNumber
```
String orderNumber
```
      The order number.
    - currency
```
String currency
```
      The currency.
    - paymentMethod
```
String paymentMethod
```
      The payment method.
    - timestamp
```
String timestamp
```
      The timestamp.
    - orderUrl
```
String orderUrl
```
      The order url.
    - elements
```
List<E> elements
```
      The elements.
    - address
```
Address address
```
      The address.
    - summary
```
Summary summary
```
      The summary.
    - adjustments
```
List<E> adjustments
```
      The adjustments.
- Class co.aurasphere.botmill.fb.model.outcoming.payload.template.TemplateBasePayload extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - templateType
```
PayloadType templateType
```
      The type of the template content.
Package co.aurasphere.botmill.fb.model.outcoming.payload.template.airline
- Class co.aurasphere.botmill.fb.model.outcoming.payload.template.airline.AirlineBasePnrNumberTemplatePayload extends AirlineBaseTemplatePayload implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - pnrNumber
```
String pnrNumber
```
      The pnr number.
- Class co.aurasphere.botmill.fb.model.outcoming.payload.template.airline.AirlineBaseTemplatePayload extends TemplateBasePayload implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - introMessage
```
String introMessage
```
      The intro message.
    - locale
```
String locale
```
      The locale.
    - themeColor
```
String themeColor
```
      The theme color.
- Class co.aurasphere.botmill.fb.model.outcoming.payload.template.airline.AirlineBoardingPassTemplatePayload extends AirlineBaseTemplatePayload implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - boardingPass
```
List<E> boardingPass
```
      The boarding pass.
- Class co.aurasphere.botmill.fb.model.outcoming.payload.template.airline.AirlineCheckinTemplatePayload extends AirlineBasePnrNumberTemplatePayload implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - flightInfo
```
List<E> flightInfo
```
      The flight info.
    - checkinUrl
```
String checkinUrl
```
      The checkin url.
- Class co.aurasphere.botmill.fb.model.outcoming.payload.template.airline.AirlineFlightUpdateTemplatePayload extends AirlineBasePnrNumberTemplatePayload implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - updateFlightInfo
```
FlightInfo updateFlightInfo
```
      The update flight info.
    - updateType
```
UpdateType updateType
```
      The update type.
- Class co.aurasphere.botmill.fb.model.outcoming.payload.template.airline.AirlineItineraryTemplatePayload extends AirlineBasePnrNumberTemplatePayload implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - flightInfo
```
List<E> flightInfo
```
      The flight info.
    - passengerInfo
```
List<E> passengerInfo
```
      The passenger info.
    - passengerSegmentInfo
```
List<E> passengerSegmentInfo
```
      The passenger segment info.
    - priceInfo
```
List<E> priceInfo
```
      The price info.
    - basePrice
```
BigDecimal basePrice
```
      The base price.
    - tax
```
BigDecimal tax
```
      The tax.
    - totalPrice
```
BigDecimal totalPrice
```
      The total price.
    - currency
```
String currency
```
      The currency.
Package co.aurasphere.botmill.fb.model.outcoming.quickreply
- Class co.aurasphere.botmill.fb.model.outcoming.quickreply.QuickReply extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - contentType
```
QuickReplyType contentType
```
      The content type.
    - imageUrl
```
String imageUrl
```
      The image url.
    - title
```
String title
```
      The title.
    - payload
```
String payload
```
      The payload.
Package co.aurasphere.botmill.fb.model.outcoming.template.airline
- Class co.aurasphere.botmill.fb.model.outcoming.template.airline.Airport extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - airportCode
```
String airportCode
```
      The airport code.
    - city
```
String city
```
      The city.
    - terminal
```
String terminal
```
      The terminal.
    - gate
```
String gate
```
      The gate.
- Class co.aurasphere.botmill.fb.model.outcoming.template.airline.BoardingPass extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - passengerName
```
String passengerName
```
      The passenger name.
    - pnrNumber
```
String pnrNumber
```
      The pnr number.
    - travelClass
```
TravelClass travelClass
```
      The travel class.
    - seat
```
String seat
```
      The seat.
    - auxiliaryFields
```
List<E> auxiliaryFields
```
      The auxiliary fields.
    - secondaryFields
```
List<E> secondaryFields
```
      The secondary fields.
    - logoImageUrl
```
String logoImageUrl
```
      The logo image url.
    - headerImageUrl
```
String headerImageUrl
```
      The header image url.
    - headerTextField
```
String headerTextField
```
      The header text field.
    - qrCode
```
String qrCode
```
      The qr code.
    - barcodeImageUrl
```
String barcodeImageUrl
```
      The barcode image url.
    - aboveBarCodeImageUrl
```
String aboveBarCodeImageUrl
```
      The above bar code image url.
    - flightInfo
```
FlightInfo flightInfo
```
      The flight info.
- Class co.aurasphere.botmill.fb.model.outcoming.template.airline.Field extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - label
```
String label
```
      The label.
    - value
```
String value
```
      The value.
- Class co.aurasphere.botmill.fb.model.outcoming.template.airline.FlightInfo extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - flightNumber
```
String flightNumber
```
      The flight number.
    - departureAirport
```
Airport departureAirport
```
      The departure airport.
    - arrivalAirport
```
Airport arrivalAirport
```
      The arrival airport.
    - flightSchedule
```
FlightSchedule flightSchedule
```
      The flight schedule.
- Class co.aurasphere.botmill.fb.model.outcoming.template.airline.FlightInfoExtended extends FlightInfo implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - connectionId
```
String connectionId
```
      The connection id.
    - segmentId
```
String segmentId
```
      The segment id.
    - aircraftType
```
String aircraftType
```
      The aircraft type.
    - travelClass
```
TravelClass travelClass
```
      The travel class.
- Class co.aurasphere.botmill.fb.model.outcoming.template.airline.FlightSchedule extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - boardingTime
```
Calendar boardingTime
```
      The boarding time.
    - departureTime
```
Calendar departureTime
```
      The departure time.
    - arrivalTime
```
Calendar arrivalTime
```
      The arrival time.
- Class co.aurasphere.botmill.fb.model.outcoming.template.airline.PassengerInfo extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - passengerId
```
String passengerId
```
      The passenger id.
    - ticketNumber
```
String ticketNumber
```
      The ticket number.
    - name
```
String name
```
      The name.
- Class co.aurasphere.botmill.fb.model.outcoming.template.airline.PassengerSegmentInfo extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - segmentId
```
String segmentId
```
      The segment id.
    - passengerId
```
String passengerId
```
      The passenger id.
    - seat
```
String seat
```
      The seat.
    - seatType
```
String seatType
```
      The seat type.
    - productInfo
```
List<E> productInfo
```
      The product info.
- Class co.aurasphere.botmill.fb.model.outcoming.template.airline.PriceInfo extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - title
```
String title
```
      The title.
    - amount
```
BigDecimal amount
```
    - currency
```
String currency
```
      The currency.
- Class co.aurasphere.botmill.fb.model.outcoming.template.airline.ProductInfo extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - title
```
String title
```
      The title.
    - value
```
String value
```
      The value.
Package co.aurasphere.botmill.fb.model.outcoming.template.button
- Class co.aurasphere.botmill.fb.model.outcoming.template.button.Button extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - type
```
ButtonType type
```
      The button type.
- Class co.aurasphere.botmill.fb.model.outcoming.template.button.BuyButton extends Button implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - payload
```
String payload
```
      The payload.
    - paymentSummary
```
PaymentSummary paymentSummary
```
      The payment summary.
    - title
```
String title
```
      The button title.
- Class co.aurasphere.botmill.fb.model.outcoming.template.button.LoginButton extends Button implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - url
```
String url
```
      The url.
- Class co.aurasphere.botmill.fb.model.outcoming.template.button.LogoutButton extends Button implements Serializable
  
  serialVersionUID:
  
  1L
- Class co.aurasphere.botmill.fb.model.outcoming.template.button.PaymentSummary extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - currency
```
String currency
```
      The currency.
    - isTestPayment
```
boolean isTestPayment
```
      The is test payment.
    - paymentType
```
PaymentType paymentType
```
      The payment type.
    - merchantName
```
String merchantName
```
      The merchant name.
    - priceList
```
PriceList priceList
```
      The price list.
    - requestedUserInfo
```
RequestedUserInfo requestedUserInfo
```
      The requested user info.
- Class co.aurasphere.botmill.fb.model.outcoming.template.button.PostbackButton extends Button implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - payload
```
String payload
```
      For postback buttons, this data will be sent back to you via webhook. For phone_number buttons, this must be a well formatted phone number i.e. must be '+' prefix followed by the country code, area code and local number.
    - title
```
String title
```
      The button title.
- Class co.aurasphere.botmill.fb.model.outcoming.template.button.PriceList extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - label
```
String label
```
      The label.
    - amount
```
String amount
```
      The amount.
- Class co.aurasphere.botmill.fb.model.outcoming.template.button.RequestedUserInfo extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - shippingAddress
```
String shippingAddress
```
      The shipping address.
    - contactName
```
String contactName
```
      The contact name.
    - contactPhont
```
String contactPhont
```
      The contact phont.
    - contactEmail
```
String contactEmail
```
      The contact email.
- Class co.aurasphere.botmill.fb.model.outcoming.template.button.ShareButton extends Button implements Serializable
  
  serialVersionUID:
  
  1L
- Class co.aurasphere.botmill.fb.model.outcoming.template.button.WebUrlButton extends Button implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - url
```
String url
```
      The url.
    - webviewHeightRatio
```
WebViewHeightRatioType webviewHeightRatio
```
      The webview height ratio.
    - fallBackUrl
```
String fallBackUrl
```
      The fall back url.
    - messengerExtension
```
boolean messengerExtension
```
      The messenger extension.
    - title
```
String title
```
      The button title.
Package co.aurasphere.botmill.fb.model.outcoming.template.generic
- Class co.aurasphere.botmill.fb.model.outcoming.template.generic.GenericTemplateElement extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - title
```
String title
```
      The title.
    - itemUrl
```
String itemUrl
```
      The item url.
    - imageUrl
```
String imageUrl
```
      The image url.
    - subtitle
```
String subtitle
```
      The subtitle.
    - buttons
```
List<E> buttons
```
      The buttons.
Package co.aurasphere.botmill.fb.model.outcoming.template.list
- Class co.aurasphere.botmill.fb.model.outcoming.template.list.DefaultAction extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - type
```
ButtonType type
```
      The type.
    - url
```
String url
```
      The url.
    - messengerExtensions
```
String messengerExtensions
```
      The messenger extensions.
    - webviewHeightRatio
```
String webviewHeightRatio
```
      The webview height ratio.
    - fallbackUrl
```
String fallbackUrl
```
      The fallback url.
- Class co.aurasphere.botmill.fb.model.outcoming.template.list.ListTemplateElement extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - title
```
String title
```
      The title.
    - imageUrl
```
String imageUrl
```
      The image url.
    - subtitle
```
String subtitle
```
      The subtitle.
    - buttons
```
List<E> buttons
```
      The buttons.
    - defaultAction
```
DefaultAction defaultAction
```
      The default action.
Package co.aurasphere.botmill.fb.model.outcoming.template.receipt
- Class co.aurasphere.botmill.fb.model.outcoming.template.receipt.Address extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - street1
```
String street1
```
      The street 1.
    - street2
```
String street2
```
      The street 2.
    - city
```
String city
```
      The city.
    - postalCode
```
String postalCode
```
      The postal code.
    - state
```
String state
```
      The state.
    - country
```
String country
```
      The country.
- Class co.aurasphere.botmill.fb.model.outcoming.template.receipt.Adjustment extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - name
```
String name
```
      The name.
    - amount
```
BigDecimal amount
```
      The amount.
- Class co.aurasphere.botmill.fb.model.outcoming.template.receipt.ReceiptTemplateElement extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - title
```
String title
```
      The title.
    - subtitle
```
String subtitle
```
      The subtitle.
    - quantity
```
int quantity
```
      The quantity.
    - price
```
BigDecimal price
```
      The price.
    - currency
```
String currency
```
      The currency.
    - imageUrl
```
String imageUrl
```
      The image url.
- Class co.aurasphere.botmill.fb.model.outcoming.template.receipt.Summary extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - subtotal
```
BigDecimal subtotal
```
      The subtotal.
    - shippingCost
```
BigDecimal shippingCost
```
      The shipping cost.
    - totalTax
```
BigDecimal totalTax
```
      The total tax.
    - totalCost
```
BigDecimal totalCost
```
      The total cost.
Package co.aurasphere.botmill.fb.model.threadsettings
- Class co.aurasphere.botmill.fb.model.threadsettings.CallToActionsRequest extends ThreadSettingsBaseRequest implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - threadState
```
ThreadState threadState
```
      The Facebook Thread State.
    - callToActions
```
List<E> callToActions
```
      The list of buttons used by this Thread Setting.
- Class co.aurasphere.botmill.fb.model.threadsettings.ThreadSettingsBaseRequest extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - type
```
SettingType type
```
      The type of setting to change.
- Class co.aurasphere.botmill.fb.model.threadsettings.WhitelistDomainRequest extends ThreadSettingsBaseRequest implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - domainActionType
```
DomainActionType domainActionType
```
      The domain action type.
    - whiteListedDomains
```
List<E> whiteListedDomains
```
      The white listed domains.
Package co.aurasphere.botmill.fb.model.threadsettings.greeting
- Class co.aurasphere.botmill.fb.model.threadsettings.greeting.Greeting extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - text
```
String text
```
      The message that will be shown to the user. This message can include the user name. To do that, add to the String the following placeholders constants from this class:
      - Greeting.USER_FIRST_NAME - Greeting.USER_LAST_NAME - Greeting.USER_FULL_NAME
      This message can be at most characters long. The placeholders for the last and full name use 18 characters, meanwhile the first name uses 19 characters.
- Class co.aurasphere.botmill.fb.model.threadsettings.greeting.SetGreetingTextRequest extends ThreadSettingsBaseRequest implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - greeting
```
Greeting greeting
```
      Greeting text.
Package co.aurasphere.botmill.fb.model.userprofile
- Class co.aurasphere.botmill.fb.model.userprofile.FacebookUserProfile extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - firstName
```
String firstName
```
      First name.
    - lastName
```
String lastName
```
      Last name.
    - profilePic
```
String profilePic
```
      Profile picture.
    - locale
```
String locale
```
      Locale of the user on Facebook.
    - timezone
```
int timezone
```
      Timezone, number relative to GMT.
    - gender
```
Gender gender
```
      Gender.
    - isPaymentEnabled
```
boolean isPaymentEnabled
```
      Is the user eligible to receive messenger platform payment messages.

Serialized Form

Package co.aurasphere.botmill.fb

Class co.aurasphere.botmill.fb.FbBotMillServlet extends javax.servlet.http.HttpServlet implements Serializable

Package co.aurasphere.botmill.fb.exception

Class co.aurasphere.botmill.fb.exception.FbBotMillIllegalAttachmentException extends IllegalArgumentException implements Serializable

Package co.aurasphere.botmill.fb.model.base

Class co.aurasphere.botmill.fb.model.base.Attachment extends Object implements Serializable

Serialized Fields

title

url

type

payload

Class co.aurasphere.botmill.fb.model.base.QuickReplyLocationPayload extends Object implements Serializable

Serialized Fields

coordinates

Class co.aurasphere.botmill.fb.model.base.User extends Object implements Serializable

Serialized Fields

id

Package co.aurasphere.botmill.fb.model.incoming

Class co.aurasphere.botmill.fb.model.incoming.FacebookError extends Object implements Serializable

Serialized Fields

message

type

code

fbTraceId

Class co.aurasphere.botmill.fb.model.incoming.FacebookErrorMessage extends Object implements Serializable

Serialized Fields

error

Class co.aurasphere.botmill.fb.model.incoming.MessageEnvelope extends Object implements Serializable

Serialized Fields

sender

recipient

timestamp

message

postback

optin

accountLinking

delivery

read

referral

payment

checkoutUpdate

Class co.aurasphere.botmill.fb.model.incoming.MessengerCallback extends Object implements Serializable

Serialized Fields

object

entry

Class co.aurasphere.botmill.fb.model.incoming.MessengerCallbackEntry extends Object implements Serializable

Serialized Fields

id

time

messaging

Package co.aurasphere.botmill.fb.model.incoming.callback

Class co.aurasphere.botmill.fb.model.incoming.callback.AccountLinking extends Object implements Serializable

Serialized Fields

status

authorizationCode

Class co.aurasphere.botmill.fb.model.incoming.callback.CheckoutUpdate extends Object implements Serializable

Serialized Fields

payload

shippingAddress

Class co.aurasphere.botmill.fb.model.incoming.callback.DeliveredMessage extends Object implements Serializable

Serialized Fields

mids

watermark

seq

Class co.aurasphere.botmill.fb.model.incoming.callback.EchoMessage extends Message implements Serializable

Serialized Fields

isEcho

appId

metadata

mid

seq

text

attachments

Class co.aurasphere.botmill.fb.model.incoming.callback.LocationCoordinates extends Object implements Serializable

Serialized Fields

latitude

longitude

Class co.aurasphere.botmill.fb.model.incoming.callback.Optin extends Object implements Serializable

Serialized Fields