Class 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.”
    • 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
      • customersNextLink

        protected String customersNextLink
      • customerTimeZone

        protected String customerTimeZone
      • filledAttendeesCount

        protected Integer filledAttendeesCount
      • invoiceAmount

        protected Double invoiceAmount
      • invoiceId

        protected String invoiceId
      • 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
      • 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
      • staffMemberIds

        protected List<String> staffMemberIds
      • staffMemberIdsNextLink

        protected String staffMemberIdsNextLink
    • Constructor Detail

      • BookingAppointment

        protected BookingAppointment()
    • Method Detail

      • odataTypeName

        public String odataTypeName()
        Specified by:
        odataTypeName in interface com.github.davidmoten.odata.client.ODataType
        Overrides:
        odataTypeName in class Entity
      • 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:
        getChangedFields in interface com.github.davidmoten.odata.client.ODataEntityType
        Overrides:
        getChangedFields in class Entity
      • postInject

        public void postInject​(boolean addKeysToContextPath)
        Specified by:
        postInject in interface com.github.davidmoten.odata.client.ODataType
        Overrides:
        postInject in class Entity
      • getAdditionalInformation

        public Optional<String> getAdditionalInformation()
      • getCustomerEmailAddress

        public Optional<String> getCustomerEmailAddress()
      • 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 of this with just the customerId field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.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 of customerId field (as defined in service metadata)
        Returns:
        immutable copy of this with just the customerId field changed
      • 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 of this with just the customerNotes field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this. 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 of customerNotes field (as defined in service metadata)
        Returns:
        immutable copy of this with just the customerNotes field changed
      • getCustomers

        public com.github.davidmoten.odata.client.CollectionPage<BookingCustomerInformationBase> getCustomers​(com.github.davidmoten.odata.client.HttpRequestOptions options)
      • getDuration

        public Optional<Duration> getDuration()

        Org.OData.Core.V1.Computed

        true

        Returns:
        property duration
      • withDuration

        public BookingAppointment withDuration​(Duration duration)
        Returns an immutable copy of this with just the duration field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.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 of duration field (as defined in service metadata)
        Returns:
        immutable copy of this with just the duration field changed
      • getFilledAttendeesCount

        public Optional<Integer> getFilledAttendeesCount()

        Org.OData.Core.V1.Computed

        true

        Returns:
        property filledAttendeesCount
      • withFilledAttendeesCount

        public BookingAppointment withFilledAttendeesCount​(Integer filledAttendeesCount)
        Returns an immutable copy of this with just the filledAttendeesCount field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.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 of filledAttendeesCount field (as defined in service metadata)
        Returns:
        immutable copy of this with just the filledAttendeesCount field changed
      • getInvoiceUrl

        public Optional<String> getInvoiceUrl()

        Org.OData.Core.V1.IsURL

        true

        Returns:
        property invoiceUrl
      • withInvoiceUrl

        public BookingAppointment withInvoiceUrl​(String invoiceUrl)
        Returns an immutable copy of this with just the invoiceUrl field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.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 of invoiceUrl field (as defined in service metadata)
        Returns:
        immutable copy of this with just the invoiceUrl field changed
      • getJoinWebUrl

        public Optional<String> getJoinWebUrl()

        Org.OData.Core.V1.IsURL

        true

        Returns:
        property joinWebUrl
      • withJoinWebUrl

        public BookingAppointment withJoinWebUrl​(String joinWebUrl)
        Returns an immutable copy of this with just the joinWebUrl field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.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 of joinWebUrl field (as defined in service metadata)
        Returns:
        immutable copy of this with just the joinWebUrl field changed
      • getMaximumAttendeesCount

        public Optional<Integer> getMaximumAttendeesCount()
      • getOnlineMeetingUrl

        public Optional<String> getOnlineMeetingUrl()

        Org.OData.Core.V1.IsURL

        true

        Returns:
        property onlineMeetingUrl
      • withOnlineMeetingUrl

        public BookingAppointment withOnlineMeetingUrl​(String onlineMeetingUrl)
        Returns an immutable copy of this with just the onlineMeetingUrl field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this. 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 of onlineMeetingUrl field (as defined in service metadata)
        Returns:
        immutable copy of this with just the onlineMeetingUrl field changed
      • getOptOutOfCustomerEmail

        public Optional<Boolean> getOptOutOfCustomerEmail()
      • 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 of this with just the reminders field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.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 of reminders field (as defined in service metadata)
        Returns:
        immutable copy of this with just the reminders field 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
      • getSelfServiceAppointmentId

        public Optional<String> getSelfServiceAppointmentId()
      • 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 of this with just the serviceId field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.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 of serviceId field (as defined in service metadata)
        Returns:
        immutable copy of this with just the serviceId field changed
      • 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 of this with just the serviceName field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this. 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 of serviceName field (as defined in service metadata)
        Returns:
        immutable copy of this with just the serviceName field 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 of this with just the serviceNotes field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this. 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 of serviceNotes field (as defined in service metadata)
        Returns:
        immutable copy of this with just the serviceNotes field changed
      • getSmsNotificationsEnabled

        public Optional<Boolean> getSmsNotificationsEnabled()
      • getStaffMemberIds

        public com.github.davidmoten.odata.client.CollectionPage<String> getStaffMemberIds()
      • getStaffMemberIds

        public com.github.davidmoten.odata.client.CollectionPage<String> getStaffMemberIds​(com.github.davidmoten.odata.client.HttpRequestOptions options)
      • getUnmappedFields

        public com.github.davidmoten.odata.client.UnmappedFields getUnmappedFields()
        Specified by:
        getUnmappedFields in interface com.github.davidmoten.odata.client.ODataType
        Overrides:
        getUnmappedFields in class Entity
      • patch

        public BookingAppointment patch()
        Submits only changed fields for update and returns an immutable copy of this with changed fields reset.
        Overrides:
        patch in class Entity
        Returns:
        a copy of this with changed fields reset
        Throws:
        com.github.davidmoten.odata.client.ClientException - if HTTP response is not as expected
      • put

        public BookingAppointment put()
        Submits all fields for update and returns an immutable copy of this with changed fields reset (they were ignored anyway).
        Overrides:
        put in class Entity
        Returns:
        a copy of this with changed fields reset
        Throws:
        com.github.davidmoten.odata.client.ClientException - if HTTP response is not as expected
      • cancel

        public com.github.davidmoten.odata.client.ActionRequestNoReturn cancel​(String cancellationMessage)