Booking (Bookeo API 0.1.1 API)

java.lang.Object
- com.bookeo.api.model.Booking

@Generated(value="class io.swagger.codegen.languages.JavaClientCodegen",
           date="2015-12-03T18:48:57.986-05:00")
public class Booking
extends Object

Represents a booking

Constructor Summary

Constructors
Constructor and Description

Booking()

Constructors
Constructor and Description
`Booking()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Boolean`	`getAccepted()` Whether this booking was accepted.
`String`	`getBookingNumber()` The unique booking number.
`String`	`getCancelationAgent()` If the booking is cancelled, this is the person who cancelled [read-only]
`Date`	`getCancelationTime()` If the booking is cancelled, this is the time when it was cancelled [read-only]
`Boolean`	`getCanceled()` Whether this booking is canceled [read-only]
`List<String>`	`getCouponCodes()` If a promotion of type \"multiple coupon codes\" was applied to this booking, this is the list of coupon codes used [read-only]
`String`	`getCreationAgent()` The person that created the booking [read-only]
`Date`	`getCreationTime()` The time when the booking was created [read-only]
`Customer`	`getCustomer()` The customer associated with this booking\n When reading a booking, this field is included only if the parameter expandCustomer is set to true, and the application has the necessary read permission for the customer.\n An application can include this field only when creating a new booking for a new customer.
`String`	`getCustomerId()` The id of the customer this booking is for.
`Date`	`getEndTime()` The end time of the booking.\n When creating a new booking of type flexibleTime, you can specify this field to force an end time.
`String`	`getEventId()` When the booking is for a product of type fixed or fixedCourse, this is the id of the slot (see /availability/slots).\n Note that for fixedCourse, Bookeo always returns the eventId of the first class in a course, even if the customer is enrolled starting from a later class.\n In this case, firstCourseEnrolledEvent will be set.
`String`	`getFirstCourseEnrolledEventId()` If the product is of type fixedCourse, and it is possible to accept late enrolment, this is the id of the event (class) where the actual enrolment starts.
`String`	`getGiftVoucherCodeInput()` A gift voucher code applicable to this booking.
`List<Payment>`	`getInitialPayments()` When creating a new booking, an application can also record one or more payment associated to the booking (ex.
`String`	`getLastChangeAgent()` The person who last updated this booking.
`Date`	`getLastChangeTime()` The time when the booking was last updated.
`List<BookingOption>`	`getOptions()`
`Participants`	`getParticipants()` Participants associated to this booking
`Price`	`getPrice()` Details about price, taxes, etc.
`String`	`getProductId()` The id of the product this booking is for
`String`	`getProductName()` The name of the product this booking is for [read-only]
`String`	`getPromotionCodeInput()` Optional promotion code input, can be used when creating or updating a booking\n It could be a single code, or a list of codes separated by comma (ex.
`String`	`getPromotionName()` The name of the promotion that was applied to this booking.
`List<Resource>`	`getResources()` Resources involved in a booking, if the booking is for a product of type \"flexibleTime\".\n If the booking is for a different type of product, this field is empty/ignored.\n When creating or updating a booking, only the id of a resource is required.
`String`	`getSourceIp()` The IP address from where this booking was created
`String`	`getSpecificVoucherCode()` When the booking used a service specific voucher (i.e.
`Date`	`getStartTime()` The start time of the booking.
`String`	`getTitle()` The title of this booking, same as the one displayed by Bookeo in the calendar [read-only]
`void`	`setAccepted(Boolean accepted)`
`void`	`setBookingNumber(String bookingNumber)`
`void`	`setCancelationAgent(String cancelationAgent)`
`void`	`setCancelationTime(Date cancelationTime)`
`void`	`setCanceled(Boolean canceled)`
`void`	`setCouponCodes(List<String> couponCodes)`
`void`	`setCreationAgent(String creationAgent)`
`void`	`setCreationTime(Date creationTime)`
`void`	`setCustomer(Customer customer)`
`void`	`setCustomerId(String customerId)`
`void`	`setEndTime(Date endTime)`
`void`	`setEventId(String eventId)`
`void`	`setFirstCourseEnrolledEventId(String firstCourseEnrolledEventId)`
`void`	`setGiftVoucherCodeInput(String giftVoucherCodeInput)`
`void`	`setInitialPayments(List<Payment> initialPayments)`
`void`	`setLastChangeAgent(String lastChangeAgent)`
`void`	`setLastChangeTime(Date lastChangeTime)`
`void`	`setOptions(List<BookingOption> options)`
`void`	`setParticipants(Participants participants)`
`void`	`setPrice(Price price)`
`void`	`setProductId(String productId)`
`void`	`setProductName(String productName)`
`void`	`setPromotionCodeInput(String promotionCodeInput)`
`void`	`setPromotionName(String promotionName)`
`void`	`setResources(List<Resource> resources)`
`void`	`setSourceIp(String sourceIp)`
`void`	`setSpecificVoucherCode(String specificVoucherCode)`
`void`	`setStartTime(Date startTime)`
`void`	`setTitle(String title)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Booking
```
public Booking()
```
- Method Detail
  - getBookingNumber
```
public String getBookingNumber()
```
    The unique booking number. Always treat as string [read-only]
  - setBookingNumber
```
public void setBookingNumber(String bookingNumber)
```
  - getEventId
```
public String getEventId()
```
    When the booking is for a product of type fixed or fixedCourse, this is the id of the slot (see /availability/slots).\n Note that for fixedCourse, Bookeo always returns the eventId of the first class in a course, even if the customer is enrolled starting from a later class.\n In this case, firstCourseEnrolledEvent will be set.
  - setEventId
```
public void setEventId(String eventId)
```
  - getFirstCourseEnrolledEventId
```
public String getFirstCourseEnrolledEventId()
```
    If the product is of type fixedCourse, and it is possible to accept late enrolment, this is the id of the event (class) where the actual enrolment starts.
  - setFirstCourseEnrolledEventId
```
public void setFirstCourseEnrolledEventId(String firstCourseEnrolledEventId)
```
  - getStartTime
```
public Date getStartTime()
```
    The start time of the booking. When creating a booking, either this or eventId must be specified
  - setStartTime
```
public void setStartTime(Date startTime)
```
  - getEndTime
```
public Date getEndTime()
```
    The end time of the booking.\n When creating a new booking of type flexibleTime, you can specify this field to force an end time. Or you can omit this field, in which case Bookeo will calculate the end time based on product and options chosen.
  - setEndTime
```
public void setEndTime(Date endTime)
```
  - getCustomerId
```
public String getCustomerId()
```
    The id of the customer this booking is for. When creating a booking, use this to create a booking for an existing customer.
  - setCustomerId
```
public void setCustomerId(String customerId)
```
  - getCustomer
```
public Customer getCustomer()
```
    The customer associated with this booking\n When reading a booking, this field is included only if the parameter expandCustomer is set to true, and the application has the necessary read permission for the customer.\n An application can include this field only when creating a new booking for a new customer. To create a booking for an existing customer, use the customerId field instead
  - setCustomer
```
public void setCustomer(Customer customer)
```
  - getTitle
```
public String getTitle()
```
    The title of this booking, same as the one displayed by Bookeo in the calendar [read-only]
  - setTitle
```
public void setTitle(String title)
```
  - getParticipants
```
public Participants getParticipants()
```
    Participants associated to this booking
  - setParticipants
```
public void setParticipants(Participants participants)
```
  - getResources
```
public List<Resource> getResources()
```
    Resources involved in a booking, if the booking is for a product of type \"flexibleTime\".\n If the booking is for a different type of product, this field is empty/ignored.\n When creating or updating a booking, only the id of a resource is required. Any name passed is ignored.\n If not specified when creating or updating a booking, Bookeo will automatically assign available resources.
  - setResources
```
public void setResources(List<Resource> resources)
```
  - getCanceled
```
public Boolean getCanceled()
```
    Whether this booking is canceled [read-only]
  - setCanceled
```
public void setCanceled(Boolean canceled)
```
  - getCancelationTime
```
public Date getCancelationTime()
```
    If the booking is cancelled, this is the time when it was cancelled [read-only]
  - setCancelationTime
```
public void setCancelationTime(Date cancelationTime)
```
  - getCancelationAgent
```
public String getCancelationAgent()
```
    If the booking is cancelled, this is the person who cancelled [read-only]
  - setCancelationAgent
```
public void setCancelationAgent(String cancelationAgent)
```
  - getAccepted
```
public Boolean getAccepted()
```
    Whether this booking was accepted. If no accept/deny was applicable to the booking, the booking is considered accepted as created. [read-only]
  - setAccepted
```
public void setAccepted(Boolean accepted)
```
  - getSourceIp
```
public String getSourceIp()
```
    The IP address from where this booking was created
  - setSourceIp
```
public void setSourceIp(String sourceIp)
```
  - getCreationTime
```
public Date getCreationTime()
```
    The time when the booking was created [read-only]
  - setCreationTime
```
public void setCreationTime(Date creationTime)
```
  - getCreationAgent
```
public String getCreationAgent()
```
    The person that created the booking [read-only]
  - setCreationAgent
```
public void setCreationAgent(String creationAgent)
```
  - getLastChangeTime
```
public Date getLastChangeTime()
```
    The time when the booking was last updated. If the booking was never changed after creation, this field is not present. [read-only]
  - setLastChangeTime
```
public void setLastChangeTime(Date lastChangeTime)
```
  - getLastChangeAgent
```
public String getLastChangeAgent()
```
    The person who last updated this booking. If the booking was never changed after creation, this field is not present. [read-only]
  - setLastChangeAgent
```
public void setLastChangeAgent(String lastChangeAgent)
```
  - getProductName
```
public String getProductName()
```
    The name of the product this booking is for [read-only]
  - setProductName
```
public void setProductName(String productName)
```
  - getProductId
```
public String getProductId()
```
    The id of the product this booking is for
  - setProductId
```
public void setProductId(String productId)
```
  - getPrice
```
public Price getPrice()
```
    Details about price, taxes, etc. [read-only]
  - setPrice
```
public void setPrice(Price price)
```
  - getOptions
```
public List<BookingOption> getOptions()
```
  - setOptions
```
public void setOptions(List<BookingOption> options)
```
  - getPromotionCodeInput
```
public String getPromotionCodeInput()
```
    Optional promotion code input, can be used when creating or updating a booking\n It could be a single code, or a list of codes separated by comma (ex. multiple coupon/voucher codes)\n In general, applications creating bookings can simply ask the customer to input a promotion code (like they would on Bookeo's web interface) and pass the input in this field.\n Bookeo will then parse and validate any text entered
  - setPromotionCodeInput
```
public void setPromotionCodeInput(String promotionCodeInput)
```
  - getPromotionName
```
public String getPromotionName()
```
    The name of the promotion that was applied to this booking. [read-only]
  - setPromotionName
```
public void setPromotionName(String promotionName)
```
  - getCouponCodes
```
public List<String> getCouponCodes()
```
    If a promotion of type \"multiple coupon codes\" was applied to this booking, this is the list of coupon codes used [read-only]
  - setCouponCodes
```
public void setCouponCodes(List<String> couponCodes)
```
  - getGiftVoucherCodeInput
```
public String getGiftVoucherCodeInput()
```
    A gift voucher code applicable to this booking. This field is only set by the application, when creating or updating a booking.\n It is possible to specify multiple codes, separated by commas.\n No more than one specific (as opposed to \"generic\", value-based) gift voucher can be used per booking.
  - setGiftVoucherCodeInput
```
public void setGiftVoucherCodeInput(String giftVoucherCodeInput)
```
  - getSpecificVoucherCode
```
public String getSpecificVoucherCode()
```
    When the booking used a service specific voucher (i.e. as opposed to a \"generic\" voucher, based on a fixed amount), the code of the voucher is reported here. [read-only]
  - setSpecificVoucherCode
```
public void setSpecificVoucherCode(String specificVoucherCode)
```
  - getInitialPayments
```
public List<Payment> getInitialPayments()
```
    When creating a new booking, an application can also record one or more payment associated to the booking (ex. if the customer has paid a deposit or the full amount online)\n This field is never set by Bookeo, and is ignored unless this is a new booking being created.
  - setInitialPayments
```
public void setInitialPayments(List<Payment> initialPayments)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Booking

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Booking

Method Detail

getBookingNumber

setBookingNumber

getEventId

setEventId

getFirstCourseEnrolledEventId

setFirstCourseEnrolledEventId

getStartTime

setStartTime

getEndTime

setEndTime

getCustomerId

setCustomerId

getCustomer

setCustomer

getTitle

setTitle

getParticipants

setParticipants

getResources

setResources

getCanceled

setCanceled

getCancelationTime

setCancelationTime

getCancelationAgent

setCancelationAgent

getAccepted

setAccepted

getSourceIp

setSourceIp

getCreationTime

setCreationTime

getCreationAgent

setCreationAgent

getLastChangeTime

setLastChangeTime

getLastChangeAgent

setLastChangeAgent

getProductName

setProductName

getProductId

setProductId

getPrice

setPrice

getOptions

setOptions

getPromotionCodeInput

setPromotionCodeInput

getPromotionName

setPromotionName

getCouponCodes

setCouponCodes

getGiftVoucherCodeInput

setGiftVoucherCodeInput

getSpecificVoucherCode

setSpecificVoucherCode

getInitialPayments

setInitialPayments

toString