Class BookingAppointment
- java.lang.Object
-
- odata.msgraph.client.beta.entity.Entity
-
- odata.msgraph.client.beta.entity.BookingAppointment
-
- All Implemented Interfaces:
com.github.davidmoten.odata.client.ODataEntityType,com.github.davidmoten.odata.client.ODataType
public class BookingAppointment extends Entity implements com.github.davidmoten.odata.client.ODataEntityType
“Represents a booked appointment of a service by a customer in a business.”
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classBookingAppointment.Builder
-
Field Summary
-
Fields inherited from class odata.msgraph.client.beta.entity.Entity
changedFields, contextPath, id, odataType, unmappedFields
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedBookingAppointment()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static BookingAppointment.BuilderbuilderBookingAppointment()Returns a builder which is used to create a new instance of this class (given that this class is immutable).com.github.davidmoten.odata.client.ActionRequestNoReturncancel(String cancellationMessage)Optional<String>getAdditionalInformation()com.github.davidmoten.odata.client.internal.ChangedFieldsgetChangedFields()Optional<String>getCustomerEmailAddress()Optional<String>getCustomerId()“If CustomerId is not specified when an appointment is created then a new customer is created based on the appointment customer information.Optional<Location>getCustomerLocation()Optional<String>getCustomerName()Optional<String>getCustomerNotes()“The value of this property is only available when reading an individual booking appointment by id.Optional<String>getCustomerPhone()com.github.davidmoten.odata.client.CollectionPage<BookingCustomerInformationBase>getCustomers()com.github.davidmoten.odata.client.CollectionPage<BookingCustomerInformationBase>getCustomers(com.github.davidmoten.odata.client.HttpRequestOptions options)Optional<String>getCustomerTimeZone()Optional<Duration>getDuration()Org.OData.Core.V1.ComputedOptional<DateTimeTimeZone>getEnd()Optional<Integer>getFilledAttendeesCount()Org.OData.Core.V1.ComputedOptional<Double>getInvoiceAmount()Optional<DateTimeTimeZone>getInvoiceDate()Optional<String>getInvoiceId()Optional<BookingInvoiceStatus>getInvoiceStatus()Optional<String>getInvoiceUrl()Org.OData.Core.V1.IsURLOptional<Boolean>getIsLocationOnline()Optional<String>getJoinWebUrl()Org.OData.Core.V1.IsURLOptional<Integer>getMaximumAttendeesCount()Optional<String>getOnlineMeetingUrl()Org.OData.Core.V1.IsURLOptional<Boolean>getOptOutOfCustomerEmail()Optional<Duration>getPostBuffer()Optional<Duration>getPreBuffer()Optional<Double>getPrice()Optional<BookingPriceType>getPriceType()com.github.davidmoten.odata.client.CollectionPage<BookingReminder>getReminders()“The value of this property is only available when reading an individual booking appointment by id.”com.github.davidmoten.odata.client.CollectionPage<BookingReminder>getReminders(com.github.davidmoten.odata.client.HttpRequestOptions options)“The value of this property is only available when reading an individual booking appointment by id.”Optional<String>getSelfServiceAppointmentId()Optional<String>getServiceId()“The id of the booking service associated with this appointment.”Optional<Location>getServiceLocation()Optional<String>getServiceName()“This property is optional when creating a new appointment.Optional<String>getServiceNotes()“The value of this property is only available when reading an individual booking appointment by id.”Optional<Boolean>getSmsNotificationsEnabled()com.github.davidmoten.odata.client.CollectionPage<String>getStaffMemberIds()com.github.davidmoten.odata.client.CollectionPage<String>getStaffMemberIds(com.github.davidmoten.odata.client.HttpRequestOptions options)Optional<DateTimeTimeZone>getStart()com.github.davidmoten.odata.client.UnmappedFieldsgetUnmappedFields()StringodataTypeName()BookingAppointmentpatch()Submits only changed fields for update and returns an immutable copy ofthiswith changed fields reset.voidpostInject(boolean addKeysToContextPath)BookingAppointmentput()Submits all fields for update and returns an immutable copy ofthiswith changed fields reset (they were ignored anyway).StringtoString()BookingAppointmentwithAdditionalInformation(String additionalInformation)BookingAppointmentwithCustomerEmailAddress(String customerEmailAddress)BookingAppointmentwithCustomerId(String customerId)Returns an immutable copy ofthiswith just thecustomerIdfield changed.BookingAppointmentwithCustomerLocation(Location customerLocation)BookingAppointmentwithCustomerName(String customerName)BookingAppointmentwithCustomerNotes(String customerNotes)Returns an immutable copy ofthiswith just thecustomerNotesfield changed.BookingAppointmentwithCustomerPhone(String customerPhone)BookingAppointmentwithCustomers(List<BookingCustomerInformationBase> customers)BookingAppointmentwithCustomerTimeZone(String customerTimeZone)BookingAppointmentwithDuration(Duration duration)Returns an immutable copy ofthiswith just thedurationfield changed.BookingAppointmentwithEnd(DateTimeTimeZone end)BookingAppointmentwithFilledAttendeesCount(Integer filledAttendeesCount)Returns an immutable copy ofthiswith just thefilledAttendeesCountfield changed.BookingAppointmentwithInvoiceAmount(Double invoiceAmount)BookingAppointmentwithInvoiceDate(DateTimeTimeZone invoiceDate)BookingAppointmentwithInvoiceId(String invoiceId)BookingAppointmentwithInvoiceStatus(BookingInvoiceStatus invoiceStatus)BookingAppointmentwithInvoiceUrl(String invoiceUrl)Returns an immutable copy ofthiswith just theinvoiceUrlfield changed.BookingAppointmentwithIsLocationOnline(Boolean isLocationOnline)BookingAppointmentwithJoinWebUrl(String joinWebUrl)Returns an immutable copy ofthiswith just thejoinWebUrlfield changed.BookingAppointmentwithMaximumAttendeesCount(Integer maximumAttendeesCount)BookingAppointmentwithOnlineMeetingUrl(String onlineMeetingUrl)Returns an immutable copy ofthiswith just theonlineMeetingUrlfield changed.BookingAppointmentwithOptOutOfCustomerEmail(Boolean optOutOfCustomerEmail)BookingAppointmentwithPostBuffer(Duration postBuffer)BookingAppointmentwithPreBuffer(Duration preBuffer)BookingAppointmentwithPrice(Double price)BookingAppointmentwithPriceType(BookingPriceType priceType)BookingAppointmentwithReminders(List<BookingReminder> reminders)Returns an immutable copy ofthiswith just theremindersfield changed.BookingAppointmentwithSelfServiceAppointmentId(String selfServiceAppointmentId)BookingAppointmentwithServiceId(String serviceId)Returns an immutable copy ofthiswith just theserviceIdfield changed.BookingAppointmentwithServiceLocation(Location serviceLocation)BookingAppointmentwithServiceName(String serviceName)Returns an immutable copy ofthiswith just theserviceNamefield changed.BookingAppointmentwithServiceNotes(String serviceNotes)Returns an immutable copy ofthiswith just theserviceNotesfield changed.BookingAppointmentwithSmsNotificationsEnabled(Boolean smsNotificationsEnabled)BookingAppointmentwithStaffMemberIds(List<String> staffMemberIds)BookingAppointmentwithStart(DateTimeTimeZone start)BookingAppointmentwithUnmappedField(String name, String value)
-
-
-
Field Detail
-
additionalInformation
protected String additionalInformation
-
customerEmailAddress
protected String customerEmailAddress
-
customerId
protected String customerId
-
customerLocation
protected Location customerLocation
-
customerName
protected String customerName
-
customerNotes
protected String customerNotes
-
customerPhone
protected String customerPhone
-
customers
protected List<BookingCustomerInformationBase> customers
-
customersNextLink
protected String customersNextLink
-
customerTimeZone
protected String customerTimeZone
-
duration
protected Duration duration
-
end
protected DateTimeTimeZone end
-
filledAttendeesCount
protected Integer filledAttendeesCount
-
invoiceAmount
protected Double invoiceAmount
-
invoiceDate
protected DateTimeTimeZone invoiceDate
-
invoiceId
protected String invoiceId
-
invoiceStatus
protected BookingInvoiceStatus invoiceStatus
-
invoiceUrl
protected String invoiceUrl
-
isLocationOnline
protected Boolean isLocationOnline
-
joinWebUrl
protected String joinWebUrl
-
maximumAttendeesCount
protected Integer maximumAttendeesCount
-
onlineMeetingUrl
protected String onlineMeetingUrl
-
optOutOfCustomerEmail
protected Boolean optOutOfCustomerEmail
-
postBuffer
protected Duration postBuffer
-
preBuffer
protected Duration preBuffer
-
price
protected Double price
-
priceType
protected BookingPriceType priceType
-
reminders
protected List<BookingReminder> reminders
-
remindersNextLink
protected String remindersNextLink
-
selfServiceAppointmentId
protected String selfServiceAppointmentId
-
serviceId
protected String serviceId
-
serviceLocation
protected Location serviceLocation
-
serviceName
protected String serviceName
-
serviceNotes
protected String serviceNotes
-
smsNotificationsEnabled
protected Boolean smsNotificationsEnabled
-
staffMemberIdsNextLink
protected String staffMemberIdsNextLink
-
start
protected DateTimeTimeZone start
-
-
Method Detail
-
odataTypeName
public String odataTypeName()
- Specified by:
odataTypeNamein interfacecom.github.davidmoten.odata.client.ODataType- Overrides:
odataTypeNamein classEntity
-
builderBookingAppointment
public static BookingAppointment.Builder builderBookingAppointment()
Returns a builder which is used to create a new instance of this class (given that this class is immutable).- Returns:
- a new Builder for this class
-
getChangedFields
public com.github.davidmoten.odata.client.internal.ChangedFields getChangedFields()
- Specified by:
getChangedFieldsin interfacecom.github.davidmoten.odata.client.ODataEntityType- Overrides:
getChangedFieldsin classEntity
-
postInject
public void postInject(boolean addKeysToContextPath)
- Specified by:
postInjectin interfacecom.github.davidmoten.odata.client.ODataType- Overrides:
postInjectin classEntity
-
withAdditionalInformation
public BookingAppointment withAdditionalInformation(String additionalInformation)
-
withCustomerEmailAddress
public BookingAppointment withCustomerEmailAddress(String customerEmailAddress)
-
getCustomerId
public Optional<String> getCustomerId()
“If CustomerId is not specified when an appointment is created then a new customer is created based on the appointment customer information. Once set, the customerId should be considered immutable.”- Returns:
- property customerId
-
withCustomerId
public BookingAppointment withCustomerId(String customerId)
Returns an immutable copy ofthiswith just thecustomerIdfield changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that whenthis.patch()is called (if available)on the returned object only the changed fields are submitted.“If CustomerId is not specified when an appointment is created then a new customer is created based on the appointment customer information. Once set, the customerId should be considered immutable.”
- Parameters:
customerId- new value ofcustomerIdfield (as defined in service metadata)- Returns:
- immutable copy of
thiswith just thecustomerIdfield changed
-
withCustomerLocation
public BookingAppointment withCustomerLocation(Location customerLocation)
-
withCustomerName
public BookingAppointment withCustomerName(String customerName)
-
getCustomerNotes
public Optional<String> getCustomerNotes()
“The value of this property is only available when reading an individual booking appointment by id. Its value can only be set when creating a new appointment with a new customer, ie, without specifying a CustomerId. After that, the property is computed from the customer represented by CustomerId.”Org.OData.Core.V1.Immutable
true
- Returns:
- property customerNotes
-
withCustomerNotes
public BookingAppointment withCustomerNotes(String customerNotes)
Returns an immutable copy ofthiswith just thecustomerNotesfield changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that whenthis. patch()is called (if available)on the returned object only the changed fields are submitted.“The value of this property is only available when reading an individual booking appointment by id. Its value can only be set when creating a new appointment with a new customer, ie, without specifying a CustomerId. After that, the property is computed from the customer represented by CustomerId.”
Org.OData.Core.V1.Immutable
true
- Parameters:
customerNotes- new value ofcustomerNotesfield (as defined in service metadata)- Returns:
- immutable copy of
thiswith just thecustomerNotesfield changed
-
withCustomerPhone
public BookingAppointment withCustomerPhone(String customerPhone)
-
getCustomers
public com.github.davidmoten.odata.client.CollectionPage<BookingCustomerInformationBase> getCustomers()
-
withCustomers
public BookingAppointment withCustomers(List<BookingCustomerInformationBase> customers)
-
getCustomers
public com.github.davidmoten.odata.client.CollectionPage<BookingCustomerInformationBase> getCustomers(com.github.davidmoten.odata.client.HttpRequestOptions options)
-
withCustomerTimeZone
public BookingAppointment withCustomerTimeZone(String customerTimeZone)
-
getDuration
public Optional<Duration> getDuration()
Org.OData.Core.V1.Computed
true
- Returns:
- property duration
-
withDuration
public BookingAppointment withDuration(Duration duration)
Returns an immutable copy ofthiswith just thedurationfield changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that whenthis.patch()is called (if available)on the returned object only the changed fields are submitted.Org.OData.Core.V1.Computed
true
- Parameters:
duration- new value ofdurationfield (as defined in service metadata)- Returns:
- immutable copy of
thiswith just thedurationfield changed
-
getEnd
public Optional<DateTimeTimeZone> getEnd()
-
withEnd
public BookingAppointment withEnd(DateTimeTimeZone end)
-
getFilledAttendeesCount
public Optional<Integer> getFilledAttendeesCount()
Org.OData.Core.V1.Computed
true
- Returns:
- property filledAttendeesCount
-
withFilledAttendeesCount
public BookingAppointment withFilledAttendeesCount(Integer filledAttendeesCount)
Returns an immutable copy ofthiswith just thefilledAttendeesCountfield changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that whenthis.patch()is called (if available)on the returned object only the changed fields are submitted.Org.OData.Core.V1.Computed
true
- Parameters:
filledAttendeesCount- new value offilledAttendeesCountfield (as defined in service metadata)- Returns:
- immutable copy of
thiswith just thefilledAttendeesCountfield changed
-
withInvoiceAmount
public BookingAppointment withInvoiceAmount(Double invoiceAmount)
-
getInvoiceDate
public Optional<DateTimeTimeZone> getInvoiceDate()
-
withInvoiceDate
public BookingAppointment withInvoiceDate(DateTimeTimeZone invoiceDate)
-
withInvoiceId
public BookingAppointment withInvoiceId(String invoiceId)
-
getInvoiceStatus
public Optional<BookingInvoiceStatus> getInvoiceStatus()
-
withInvoiceStatus
public BookingAppointment withInvoiceStatus(BookingInvoiceStatus invoiceStatus)
-
getInvoiceUrl
public Optional<String> getInvoiceUrl()
Org.OData.Core.V1.IsURL
true
- Returns:
- property invoiceUrl
-
withInvoiceUrl
public BookingAppointment withInvoiceUrl(String invoiceUrl)
Returns an immutable copy ofthiswith just theinvoiceUrlfield changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that whenthis.patch()is called (if available)on the returned object only the changed fields are submitted.Org.OData.Core.V1.IsURL
true
- Parameters:
invoiceUrl- new value ofinvoiceUrlfield (as defined in service metadata)- Returns:
- immutable copy of
thiswith just theinvoiceUrlfield changed
-
withIsLocationOnline
public BookingAppointment withIsLocationOnline(Boolean isLocationOnline)
-
getJoinWebUrl
public Optional<String> getJoinWebUrl()
Org.OData.Core.V1.IsURL
true
- Returns:
- property joinWebUrl
-
withJoinWebUrl
public BookingAppointment withJoinWebUrl(String joinWebUrl)
Returns an immutable copy ofthiswith just thejoinWebUrlfield changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that whenthis.patch()is called (if available)on the returned object only the changed fields are submitted.Org.OData.Core.V1.IsURL
true
- Parameters:
joinWebUrl- new value ofjoinWebUrlfield (as defined in service metadata)- Returns:
- immutable copy of
thiswith just thejoinWebUrlfield changed
-
withMaximumAttendeesCount
public BookingAppointment withMaximumAttendeesCount(Integer maximumAttendeesCount)
-
getOnlineMeetingUrl
public Optional<String> getOnlineMeetingUrl()
Org.OData.Core.V1.IsURL
true
- Returns:
- property onlineMeetingUrl
-
withOnlineMeetingUrl
public BookingAppointment withOnlineMeetingUrl(String onlineMeetingUrl)
Returns an immutable copy ofthiswith just theonlineMeetingUrlfield changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that whenthis. patch()is called (if available)on the returned object only the changed fields are submitted.Org.OData.Core.V1.IsURL
true
- Parameters:
onlineMeetingUrl- new value ofonlineMeetingUrlfield (as defined in service metadata)- Returns:
- immutable copy of
thiswith just theonlineMeetingUrlfield changed
-
withOptOutOfCustomerEmail
public BookingAppointment withOptOutOfCustomerEmail(Boolean optOutOfCustomerEmail)
-
withPostBuffer
public BookingAppointment withPostBuffer(Duration postBuffer)
-
withPreBuffer
public BookingAppointment withPreBuffer(Duration preBuffer)
-
withPrice
public BookingAppointment withPrice(Double price)
-
getPriceType
public Optional<BookingPriceType> getPriceType()
-
withPriceType
public BookingAppointment withPriceType(BookingPriceType priceType)
-
getReminders
public com.github.davidmoten.odata.client.CollectionPage<BookingReminder> getReminders()
“The value of this property is only available when reading an individual booking appointment by id.”- Returns:
- property reminders
-
withReminders
public BookingAppointment withReminders(List<BookingReminder> reminders)
Returns an immutable copy ofthiswith just theremindersfield changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that whenthis.patch()is called (if available)on the returned object only the changed fields are submitted.“The value of this property is only available when reading an individual booking appointment by id.”
- Parameters:
reminders- new value ofremindersfield (as defined in service metadata)- Returns:
- immutable copy of
thiswith just theremindersfield changed
-
getReminders
public com.github.davidmoten.odata.client.CollectionPage<BookingReminder> getReminders(com.github.davidmoten.odata.client.HttpRequestOptions options)
“The value of this property is only available when reading an individual booking appointment by id.”- Parameters:
options- specify connect and read timeouts- Returns:
- property reminders
-
withSelfServiceAppointmentId
public BookingAppointment withSelfServiceAppointmentId(String selfServiceAppointmentId)
-
getServiceId
public Optional<String> getServiceId()
“The id of the booking service associated with this appointment.”Org.OData.Core.V1.Immutable
true
- Returns:
- property serviceId
-
withServiceId
public BookingAppointment withServiceId(String serviceId)
Returns an immutable copy ofthiswith just theserviceIdfield changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that whenthis.patch()is called (if available)on the returned object only the changed fields are submitted.“The id of the booking service associated with this appointment.”
Org.OData.Core.V1.Immutable
true
- Parameters:
serviceId- new value ofserviceIdfield (as defined in service metadata)- Returns:
- immutable copy of
thiswith just theserviceIdfield changed
-
withServiceLocation
public BookingAppointment withServiceLocation(Location serviceLocation)
-
getServiceName
public Optional<String> getServiceName()
“This property is optional when creating a new appointment. If not specified, it is computed from the service associated with the appointment by the service id.”- Returns:
- property serviceName
-
withServiceName
public BookingAppointment withServiceName(String serviceName)
Returns an immutable copy ofthiswith just theserviceNamefield changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that whenthis. patch()is called (if available)on the returned object only the changed fields are submitted.“This property is optional when creating a new appointment. If not specified, it is computed from the service associated with the appointment by the service id.”
- Parameters:
serviceName- new value ofserviceNamefield (as defined in service metadata)- Returns:
- immutable copy of
thiswith just theserviceNamefield changed
-
getServiceNotes
public Optional<String> getServiceNotes()
“The value of this property is only available when reading an individual booking appointment by id.”- Returns:
- property serviceNotes
-
withServiceNotes
public BookingAppointment withServiceNotes(String serviceNotes)
Returns an immutable copy ofthiswith just theserviceNotesfield changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that whenthis. patch()is called (if available)on the returned object only the changed fields are submitted.“The value of this property is only available when reading an individual booking appointment by id.”
- Parameters:
serviceNotes- new value ofserviceNotesfield (as defined in service metadata)- Returns:
- immutable copy of
thiswith just theserviceNotesfield changed
-
withSmsNotificationsEnabled
public BookingAppointment withSmsNotificationsEnabled(Boolean smsNotificationsEnabled)
-
getStaffMemberIds
public com.github.davidmoten.odata.client.CollectionPage<String> getStaffMemberIds()
-
withStaffMemberIds
public BookingAppointment withStaffMemberIds(List<String> staffMemberIds)
-
getStaffMemberIds
public com.github.davidmoten.odata.client.CollectionPage<String> getStaffMemberIds(com.github.davidmoten.odata.client.HttpRequestOptions options)
-
getStart
public Optional<DateTimeTimeZone> getStart()
-
withStart
public BookingAppointment withStart(DateTimeTimeZone start)
-
withUnmappedField
public BookingAppointment withUnmappedField(String name, String value)
- Overrides:
withUnmappedFieldin classEntity
-
getUnmappedFields
public com.github.davidmoten.odata.client.UnmappedFields getUnmappedFields()
- Specified by:
getUnmappedFieldsin interfacecom.github.davidmoten.odata.client.ODataType- Overrides:
getUnmappedFieldsin classEntity
-
patch
public BookingAppointment patch()
Submits only changed fields for update and returns an immutable copy ofthiswith changed fields reset.
-
put
public BookingAppointment put()
Submits all fields for update and returns an immutable copy ofthiswith changed fields reset (they were ignored anyway).
-
cancel
public com.github.davidmoten.odata.client.ActionRequestNoReturn cancel(String cancellationMessage)
-
-