Class: MicrosoftGraph::Models::BookingService

Inherits:
Entity
  • Object
show all
Includes:
MicrosoftKiotaAbstractions::Parsable
Defined in:
lib/models/booking_service.rb

Overview

Represents a particular service offered by a booking business.

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Entity

#additional_data, #additional_data=, #id, #id=, #odata_type, #odata_type=

Constructor Details

#initialize ⇒ Object

Instantiates a new bookingService and sets the default values.



93
94
95
 
# File 'lib/models/booking_service.rb', line 93

def initialize()
    super
end

Class Method Details

.create_from_discriminator_value(parse_node) ⇒ Object

Creates a new instance of the appropriate class based on discriminator value

Parameters:

  • parse_node —

    The parse node to use to read the discriminator value and create the object

Returns:

  • a booking_service

Raises:

  • (StandardError) 


101
102
103
104
 
# File 'lib/models/booking_service.rb', line 101

def self.create_from_discriminator_value(parse_node)
    raise StandardError, 'parse_node cannot be null' if parse_node.nil?
    return BookingService.new
end

Instance Method Details

#additional_information ⇒ Object

Gets the additionalInformation property value. Additional information that is sent to the customer when an appointment is confirmed.

Returns:

  • a string



78
79
80
 
# File 'lib/models/booking_service.rb', line 78

def additional_information
    return @additional_information
end

#additional_information=(value) ⇒ Object

Sets the additionalInformation property value. Additional information that is sent to the customer when an appointment is confirmed.

Parameters:

  • value —

    Value to set for the additionalInformation property.

Returns:

  • a void



86
87
88
 
# File 'lib/models/booking_service.rb', line 86

def additional_information=(value)
    @additional_information = value
end

#custom_questions ⇒ Object

Gets the customQuestions property value. Contains the set of custom questions associated with a particular service.

Returns:

  • a booking_question_assignment



109
110
111
 
# File 'lib/models/booking_service.rb', line 109

def custom_questions
    return @custom_questions
end

#custom_questions=(value) ⇒ Object

Sets the customQuestions property value. Contains the set of custom questions associated with a particular service.

Parameters:

  • value —

    Value to set for the customQuestions property.

Returns:

  • a void



117
118
119
 
# File 'lib/models/booking_service.rb', line 117

def custom_questions=(value)
    @custom_questions = value
end

#default_duration ⇒ Object

Gets the defaultDuration property value. The default length of the service, represented in numbers of days, hours, minutes, and seconds. For example, P11D23H59M59.999999999999S.

Returns:

  • a microsoft_kiota_abstractions::_i_s_o_duration



124
125
126
 
# File 'lib/models/booking_service.rb', line 124

def default_duration
    return @default_duration
end

#default_duration=(value) ⇒ Object

Sets the defaultDuration property value. The default length of the service, represented in numbers of days, hours, minutes, and seconds. For example, P11D23H59M59.999999999999S.

Parameters:

  • value —

    Value to set for the defaultDuration property.

Returns:

  • a void



132
133
134
 
# File 'lib/models/booking_service.rb', line 132

def default_duration=(value)
    @default_duration = value
end

#default_location ⇒ Object

Gets the defaultLocation property value. The default physical location for the service.

Returns:

  • a location



139
140
141
 
# File 'lib/models/booking_service.rb', line 139

def default_location
    return @default_location
end

#default_location=(value) ⇒ Object

Sets the defaultLocation property value. The default physical location for the service.

Parameters:

  • value —

    Value to set for the defaultLocation property.

Returns:

  • a void



147
148
149
 
# File 'lib/models/booking_service.rb', line 147

def default_location=(value)
    @default_location = value
end

#default_price ⇒ Object

Gets the defaultPrice property value. The default monetary price for the service.

Returns:

  • a double



154
155
156
 
# File 'lib/models/booking_service.rb', line 154

def default_price
    return @default_price
end

#default_price=(value) ⇒ Object

Sets the defaultPrice property value. The default monetary price for the service.

Parameters:

  • value —

    Value to set for the defaultPrice property.

Returns:

  • a void



162
163
164
 
# File 'lib/models/booking_service.rb', line 162

def default_price=(value)
    @default_price = value
end

#default_price_type ⇒ Object

Gets the defaultPriceType property value. Represents the type of pricing of a booking service.

Returns:

  • a booking_price_type



169
170
171
 
# File 'lib/models/booking_service.rb', line 169

def default_price_type
    return @default_price_type
end

#default_price_type=(value) ⇒ Object

Sets the defaultPriceType property value. Represents the type of pricing of a booking service.

Parameters:

  • value —

    Value to set for the defaultPriceType property.

Returns:

  • a void



177
178
179
 
# File 'lib/models/booking_service.rb', line 177

def default_price_type=(value)
    @default_price_type = value
end

#default_reminders ⇒ Object

Gets the defaultReminders property value. The default set of reminders for an appointment of this service. The value of this property is available only when reading this bookingService by its ID.

Returns:

  • a booking_reminder



184
185
186
 
# File 'lib/models/booking_service.rb', line 184

def default_reminders
    return @default_reminders
end

#default_reminders=(value) ⇒ Object

Sets the defaultReminders property value. The default set of reminders for an appointment of this service. The value of this property is available only when reading this bookingService by its ID.

Parameters:

  • value —

    Value to set for the defaultReminders property.

Returns:

  • a void



192
193
194
 
# File 'lib/models/booking_service.rb', line 192

def default_reminders=(value)
    @default_reminders = value
end

#description ⇒ Object

Gets the description property value. A text description for the service.

Returns:

  • a string



199
200
201
 
# File 'lib/models/booking_service.rb', line 199

def description
    return @description
end

#description=(value) ⇒ Object

Sets the description property value. A text description for the service.

Parameters:

  • value —

    Value to set for the description property.

Returns:

  • a void



207
208
209
 
# File 'lib/models/booking_service.rb', line 207

def description=(value)
    @description = value
end

#display_name ⇒ Object

Gets the displayName property value. A service name.

Returns:

  • a string



214
215
216
 
# File 'lib/models/booking_service.rb', line 214

def display_name
    return @display_name
end

#display_name=(value) ⇒ Object

Sets the displayName property value. A service name.

Parameters:

  • value —

    Value to set for the displayName property.

Returns:

  • a void



222
223
224
 
# File 'lib/models/booking_service.rb', line 222

def display_name=(value)
    @display_name = value
end

#get_field_deserializers ⇒ Object

The deserialization information for the current model

Returns:

  • a i_dictionary



229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/models/booking_service.rb', line 229

def get_field_deserializers()
    return super.merge({
        "additionalInformation" => lambda {|n| @additional_information = n.get_string_value() },
        "customQuestions" => lambda {|n| @custom_questions = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::BookingQuestionAssignment.create_from_discriminator_value(pn) }) },
        "defaultDuration" => lambda {|n| @default_duration = n.get_duration_value() },
        "defaultLocation" => lambda {|n| @default_location = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::Location.create_from_discriminator_value(pn) }) },
        "defaultPrice" => lambda {|n| @default_price = n.get_object_value(lambda {|pn| Double.create_from_discriminator_value(pn) }) },
        "defaultPriceType" => lambda {|n| @default_price_type = n.get_enum_value(MicrosoftGraph::Models::BookingPriceType) },
        "defaultReminders" => lambda {|n| @default_reminders = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::BookingReminder.create_from_discriminator_value(pn) }) },
        "description" => lambda {|n| @description = n.get_string_value() },
        "displayName" => lambda {|n| @display_name = n.get_string_value() },
        "isAnonymousJoinEnabled" => lambda {|n| @is_anonymous_join_enabled = n.get_boolean_value() },
        "isHiddenFromCustomers" => lambda {|n| @is_hidden_from_customers = n.get_boolean_value() },
        "isLocationOnline" => lambda {|n| @is_location_online = n.get_boolean_value() },
        "languageTag" => lambda {|n| @language_tag = n.get_string_value() },
        "maximumAttendeesCount" => lambda {|n| @maximum_attendees_count = n.get_number_value() },
        "notes" => lambda {|n| @notes = n.get_string_value() },
        "postBuffer" => lambda {|n| @post_buffer = n.get_duration_value() },
        "preBuffer" => lambda {|n| @pre_buffer = n.get_duration_value() },
        "schedulingPolicy" => lambda {|n| @scheduling_policy = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::BookingSchedulingPolicy.create_from_discriminator_value(pn) }) },
        "smsNotificationsEnabled" => lambda {|n| @sms_notifications_enabled = n.get_boolean_value() },
        "staffMemberIds" => lambda {|n| @staff_member_ids = n.get_collection_of_primitive_values(String) },
        "webUrl" => lambda {|n| @web_url = n.get_string_value() },
    })
end

#is_anonymous_join_enabled ⇒ Object

Gets the isAnonymousJoinEnabled property value. True if the URL to join the appointment anonymously (anonymousJoinWebUrl) will be generated for the appointment booked for this service.

Returns:

  • a boolean



258
259
260
 
# File 'lib/models/booking_service.rb', line 258

def is_anonymous_join_enabled
    return @is_anonymous_join_enabled
end

#is_anonymous_join_enabled=(value) ⇒ Object

Sets the isAnonymousJoinEnabled property value. True if the URL to join the appointment anonymously (anonymousJoinWebUrl) will be generated for the appointment booked for this service.

Parameters:

  • value —

    Value to set for the isAnonymousJoinEnabled property.

Returns:

  • a void



266
267
268
 
# File 'lib/models/booking_service.rb', line 266

def is_anonymous_join_enabled=(value)
    @is_anonymous_join_enabled = value
end

#is_hidden_from_customers ⇒ Object

Gets the isHiddenFromCustomers property value. True means this service is not available to customers for booking.

Returns:

  • a boolean



273
274
275
 
# File 'lib/models/booking_service.rb', line 273

def is_hidden_from_customers
    return @is_hidden_from_customers
end

#is_hidden_from_customers=(value) ⇒ Object

Sets the isHiddenFromCustomers property value. True means this service is not available to customers for booking.

Parameters:

  • value —

    Value to set for the isHiddenFromCustomers property.

Returns:

  • a void



281
282
283
 
# File 'lib/models/booking_service.rb', line 281

def is_hidden_from_customers=(value)
    @is_hidden_from_customers = value
end

#is_location_online ⇒ Object

Gets the isLocationOnline property value. True indicates that the appointments for the service will be held online. Default value is false.

Returns:

  • a boolean



288
289
290
 
# File 'lib/models/booking_service.rb', line 288

def is_location_online
    return @is_location_online
end

#is_location_online=(value) ⇒ Object

Sets the isLocationOnline property value. True indicates that the appointments for the service will be held online. Default value is false.

Parameters:

  • value —

    Value to set for the isLocationOnline property.

Returns:

  • a void



296
297
298
 
# File 'lib/models/booking_service.rb', line 296

def is_location_online=(value)
    @is_location_online = value
end

#language_tag ⇒ Object

Gets the languageTag property value. The language of the self-service booking page.

Returns:

  • a string



303
304
305
 
# File 'lib/models/booking_service.rb', line 303

def language_tag
    return @language_tag
end

#language_tag=(value) ⇒ Object

Sets the languageTag property value. The language of the self-service booking page.

Parameters:

  • value —

    Value to set for the languageTag property.

Returns:

  • a void



311
312
313
 
# File 'lib/models/booking_service.rb', line 311

def language_tag=(value)
    @language_tag = value
end

#maximum_attendees_count ⇒ Object

Gets the maximumAttendeesCount property value. The maximum number of customers allowed in a service. If maximumAttendeesCount of the service is greater than 1, pass valid customer IDs while creating or updating an appointment. To create a customer, use the Create bookingCustomer operation.

Returns:

  • a integer



318
319
320
 
# File 'lib/models/booking_service.rb', line 318

def maximum_attendees_count
    return @maximum_attendees_count
end

#maximum_attendees_count=(value) ⇒ Object

Sets the maximumAttendeesCount property value. The maximum number of customers allowed in a service. If maximumAttendeesCount of the service is greater than 1, pass valid customer IDs while creating or updating an appointment. To create a customer, use the Create bookingCustomer operation.

Parameters:

  • value —

    Value to set for the maximumAttendeesCount property.

Returns:

  • a void



326
327
328
 
# File 'lib/models/booking_service.rb', line 326

def maximum_attendees_count=(value)
    @maximum_attendees_count = value
end

#notes ⇒ Object

Gets the notes property value. Additional information about this service.

Returns:

  • a string



333
334
335
 
# File 'lib/models/booking_service.rb', line 333

def notes
    return @notes
end

#notes=(value) ⇒ Object

Sets the notes property value. Additional information about this service.

Parameters:

  • value —

    Value to set for the notes property.

Returns:

  • a void



341
342
343
 
# File 'lib/models/booking_service.rb', line 341

def notes=(value)
    @notes = value
end

#post_buffer ⇒ Object

Gets the postBuffer property value. The time to buffer after an appointment for this service ends, and before the next customer appointment can be booked.

Returns:

  • a microsoft_kiota_abstractions::_i_s_o_duration



348
349
350
 
# File 'lib/models/booking_service.rb', line 348

def post_buffer
    return @post_buffer
end

#post_buffer=(value) ⇒ Object

Sets the postBuffer property value. The time to buffer after an appointment for this service ends, and before the next customer appointment can be booked.

Parameters:

  • value —

    Value to set for the postBuffer property.

Returns:

  • a void



356
357
358
 
# File 'lib/models/booking_service.rb', line 356

def post_buffer=(value)
    @post_buffer = value
end

#pre_buffer ⇒ Object

Gets the preBuffer property value. The time to buffer before an appointment for this service can start.

Returns:

  • a microsoft_kiota_abstractions::_i_s_o_duration



363
364
365
 
# File 'lib/models/booking_service.rb', line 363

def pre_buffer
    return @pre_buffer
end

#pre_buffer=(value) ⇒ Object

Sets the preBuffer property value. The time to buffer before an appointment for this service can start.

Parameters:

  • value —

    Value to set for the preBuffer property.

Returns:

  • a void



371
372
373
 
# File 'lib/models/booking_service.rb', line 371

def pre_buffer=(value)
    @pre_buffer = value
end

#scheduling_policy ⇒ Object

Gets the schedulingPolicy property value. The set of policies that determine how appointments for this type of service should be created and managed.

Returns:

  • a booking_scheduling_policy



378
379
380
 
# File 'lib/models/booking_service.rb', line 378

def scheduling_policy
    return @scheduling_policy
end

#scheduling_policy=(value) ⇒ Object

Sets the schedulingPolicy property value. The set of policies that determine how appointments for this type of service should be created and managed.

Parameters:

  • value —

    Value to set for the schedulingPolicy property.

Returns:

  • a void



386
387
388
 
# File 'lib/models/booking_service.rb', line 386

def scheduling_policy=(value)
    @scheduling_policy = value
end

#serialize(writer) ⇒ Object

Serializes information the current object

Parameters:

  • writer —

    Serialization writer to use to serialize this model

Returns:

  • a void

Raises:

  • (StandardError) 


394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
 
# File 'lib/models/booking_service.rb', line 394

def serialize(writer)
    raise StandardError, 'writer cannot be null' if writer.nil?
    super
    writer.write_string_value("additionalInformation", @additional_information)
    writer.write_collection_of_object_values("customQuestions", @custom_questions)
    writer.write_duration_value("defaultDuration", @default_duration)
    writer.write_object_value("defaultLocation", @default_location)
    writer.write_object_value("defaultPrice", @default_price)
    writer.write_enum_value("defaultPriceType", @default_price_type)
    writer.write_collection_of_object_values("defaultReminders", @default_reminders)
    writer.write_string_value("description", @description)
    writer.write_string_value("displayName", @display_name)
    writer.write_boolean_value("isAnonymousJoinEnabled", @is_anonymous_join_enabled)
    writer.write_boolean_value("isHiddenFromCustomers", @is_hidden_from_customers)
    writer.write_boolean_value("isLocationOnline", @is_location_online)
    writer.write_string_value("languageTag", @language_tag)
    writer.write_number_value("maximumAttendeesCount", @maximum_attendees_count)
    writer.write_string_value("notes", @notes)
    writer.write_duration_value("postBuffer", @post_buffer)
    writer.write_duration_value("preBuffer", @pre_buffer)
    writer.write_object_value("schedulingPolicy", @scheduling_policy)
    writer.write_boolean_value("smsNotificationsEnabled", @sms_notifications_enabled)
    writer.write_collection_of_primitive_values("staffMemberIds", @staff_member_ids)
end

#sms_notifications_enabled ⇒ Object

Gets the smsNotificationsEnabled property value. True indicates SMS notifications can be sent to the customers for the appointment of the service. Default value is false.

Returns:

  • a boolean



422
423
424
 
# File 'lib/models/booking_service.rb', line 422

def sms_notifications_enabled
    return @sms_notifications_enabled
end

#sms_notifications_enabled=(value) ⇒ Object

Sets the smsNotificationsEnabled property value. True indicates SMS notifications can be sent to the customers for the appointment of the service. Default value is false.

Parameters:

  • value —

    Value to set for the smsNotificationsEnabled property.

Returns:

  • a void



430
431
432
 
# File 'lib/models/booking_service.rb', line 430

def sms_notifications_enabled=(value)
    @sms_notifications_enabled = value
end

#staff_member_ids ⇒ Object

Gets the staffMemberIds property value. Represents those staff members who provide this service.

Returns:

  • a string



437
438
439
 
# File 'lib/models/booking_service.rb', line 437

def staff_member_ids
    return @staff_member_ids
end

#staff_member_ids=(value) ⇒ Object

Sets the staffMemberIds property value. Represents those staff members who provide this service.

Parameters:

  • value —

    Value to set for the staffMemberIds property.

Returns:

  • a void



445
446
447
 
# File 'lib/models/booking_service.rb', line 445

def staff_member_ids=(value)
    @staff_member_ids = value
end

#web_url ⇒ Object

Gets the webUrl property value. The URL a customer uses to access the service.

Returns:

  • a string



452
453
454
 
# File 'lib/models/booking_service.rb', line 452

def web_url
    return @web_url
end

#web_url=(value) ⇒ Object

Sets the webUrl property value. The URL a customer uses to access the service.

Parameters:

  • value —

    Value to set for the webUrl property.

Returns:

  • a void



460
461
462
 
# File 'lib/models/booking_service.rb', line 460

def web_url=(value)
    @web_url = value
end