Class: MicrosoftGraph::Models::BookingBusiness

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

Overview

Represents a Microsot Bookings 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

#initializeObject

Instantiates a new bookingBusiness and sets the default values.



144
145
146
# File 'lib/models/booking_business.rb', line 144

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_business

Raises:

  • (StandardError)


152
153
154
155
# File 'lib/models/booking_business.rb', line 152

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

Instance Method Details

#addressObject

Gets the address property value. The street address of the business. The address property, together with phone and webSiteUrl, appear in the footer of a business scheduling page. The attribute type of physicalAddress is not supported in v1.0. Internally we map the addresses to the type others.

Returns:

  • a physical_address



69
70
71
# File 'lib/models/booking_business.rb', line 69

def address
    return @address
end

#address=(value) ⇒ Object

Sets the address property value. The street address of the business. The address property, together with phone and webSiteUrl, appear in the footer of a business scheduling page. The attribute type of physicalAddress is not supported in v1.0. Internally we map the addresses to the type others.

Parameters:

  • value

    Value to set for the address property.

Returns:

  • a void



77
78
79
# File 'lib/models/booking_business.rb', line 77

def address=(value)
    @address = value
end

#appointmentsObject

Gets the appointments property value. All the appointments of this business. Read-only. Nullable.

Returns:

  • a booking_appointment



84
85
86
# File 'lib/models/booking_business.rb', line 84

def appointments
    return @appointments
end

#appointments=(value) ⇒ Object

Sets the appointments property value. All the appointments of this business. Read-only. Nullable.

Parameters:

  • value

    Value to set for the appointments property.

Returns:

  • a void



92
93
94
# File 'lib/models/booking_business.rb', line 92

def appointments=(value)
    @appointments = value
end

#business_hoursObject

Gets the businessHours property value. The hours of operation for the business.

Returns:

  • a booking_work_hours



99
100
101
# File 'lib/models/booking_business.rb', line 99

def business_hours
    return @business_hours
end

#business_hours=(value) ⇒ Object

Sets the businessHours property value. The hours of operation for the business.

Parameters:

  • value

    Value to set for the businessHours property.

Returns:

  • a void



107
108
109
# File 'lib/models/booking_business.rb', line 107

def business_hours=(value)
    @business_hours = value
end

#business_typeObject

Gets the businessType property value. The type of business.

Returns:

  • a string



114
115
116
# File 'lib/models/booking_business.rb', line 114

def business_type
    return @business_type
end

#business_type=(value) ⇒ Object

Sets the businessType property value. The type of business.

Parameters:

  • value

    Value to set for the businessType property.

Returns:

  • a void



122
123
124
# File 'lib/models/booking_business.rb', line 122

def business_type=(value)
    @business_type = value
end

#calendar_viewObject

Gets the calendarView property value. The set of appointments of this business in a specified date range. Read-only. Nullable.

Returns:

  • a booking_appointment



129
130
131
# File 'lib/models/booking_business.rb', line 129

def calendar_view
    return @calendar_view
end

#calendar_view=(value) ⇒ Object

Sets the calendarView property value. The set of appointments of this business in a specified date range. Read-only. Nullable.

Parameters:

  • value

    Value to set for the calendarView property.

Returns:

  • a void



137
138
139
# File 'lib/models/booking_business.rb', line 137

def calendar_view=(value)
    @calendar_view = value
end

#custom_questionsObject

Gets the customQuestions property value. All the custom questions of this business. Read-only. Nullable.

Returns:

  • a booking_custom_question



160
161
162
# File 'lib/models/booking_business.rb', line 160

def custom_questions
    return @custom_questions
end

#custom_questions=(value) ⇒ Object

Sets the customQuestions property value. All the custom questions of this business. Read-only. Nullable.

Parameters:

  • value

    Value to set for the customQuestions property.

Returns:

  • a void



168
169
170
# File 'lib/models/booking_business.rb', line 168

def custom_questions=(value)
    @custom_questions = value
end

#customersObject

Gets the customers property value. All the customers of this business. Read-only. Nullable.

Returns:

  • a booking_customer_base



175
176
177
# File 'lib/models/booking_business.rb', line 175

def customers
    return @customers
end

#customers=(value) ⇒ Object

Sets the customers property value. All the customers of this business. Read-only. Nullable.

Parameters:

  • value

    Value to set for the customers property.

Returns:

  • a void



183
184
185
# File 'lib/models/booking_business.rb', line 183

def customers=(value)
    @customers = value
end

#default_currency_isoObject

Gets the defaultCurrencyIso property value. The code for the currency that the business operates in on Microsoft Bookings.

Returns:

  • a string



190
191
192
# File 'lib/models/booking_business.rb', line 190

def default_currency_iso
    return @default_currency_iso
end

#default_currency_iso=(value) ⇒ Object

Sets the defaultCurrencyIso property value. The code for the currency that the business operates in on Microsoft Bookings.

Parameters:

  • value

    Value to set for the defaultCurrencyIso property.

Returns:

  • a void



198
199
200
# File 'lib/models/booking_business.rb', line 198

def default_currency_iso=(value)
    @default_currency_iso = value
end

#display_nameObject

Gets the displayName property value. The name of the business, which interfaces with customers. This name appears at the top of the business scheduling page.

Returns:

  • a string



205
206
207
# File 'lib/models/booking_business.rb', line 205

def display_name
    return @display_name
end

#display_name=(value) ⇒ Object

Sets the displayName property value. The name of the business, which interfaces with customers. This name appears at the top of the business scheduling page.

Parameters:

  • value

    Value to set for the displayName property.

Returns:

  • a void



213
214
215
# File 'lib/models/booking_business.rb', line 213

def display_name=(value)
    @display_name = value
end

#emailObject

Gets the email property value. The email address for the business.

Returns:

  • a string



220
221
222
# File 'lib/models/booking_business.rb', line 220

def email
    return @email
end

#email=(value) ⇒ Object

Sets the email property value. The email address for the business.

Parameters:

  • value

    Value to set for the email property.

Returns:

  • a void



228
229
230
# File 'lib/models/booking_business.rb', line 228

def email=(value)
    @email = value
end

#get_field_deserializersObject

The deserialization information for the current model

Returns:

  • a i_dictionary



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
# File 'lib/models/booking_business.rb', line 235

def get_field_deserializers()
    return super.merge({
        "address" => lambda {|n| @address = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::PhysicalAddress.create_from_discriminator_value(pn) }) },
        "appointments" => lambda {|n| @appointments = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::BookingAppointment.create_from_discriminator_value(pn) }) },
        "businessHours" => lambda {|n| @business_hours = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::BookingWorkHours.create_from_discriminator_value(pn) }) },
        "businessType" => lambda {|n| @business_type = n.get_string_value() },
        "calendarView" => lambda {|n| @calendar_view = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::BookingAppointment.create_from_discriminator_value(pn) }) },
        "customQuestions" => lambda {|n| @custom_questions = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::BookingCustomQuestion.create_from_discriminator_value(pn) }) },
        "customers" => lambda {|n| @customers = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::BookingCustomerBase.create_from_discriminator_value(pn) }) },
        "defaultCurrencyIso" => lambda {|n| @default_currency_iso = n.get_string_value() },
        "displayName" => lambda {|n| @display_name = n.get_string_value() },
        "email" => lambda {|n| @email = n.get_string_value() },
        "isPublished" => lambda {|n| @is_published = n.get_boolean_value() },
        "languageTag" => lambda {|n| @language_tag = n.get_string_value() },
        "phone" => lambda {|n| @phone = n.get_string_value() },
        "publicUrl" => lambda {|n| @public_url = n.get_string_value() },
        "schedulingPolicy" => lambda {|n| @scheduling_policy = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::BookingSchedulingPolicy.create_from_discriminator_value(pn) }) },
        "services" => lambda {|n| @services = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::BookingService.create_from_discriminator_value(pn) }) },
        "staffMembers" => lambda {|n| @staff_members = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::BookingStaffMemberBase.create_from_discriminator_value(pn) }) },
        "webSiteUrl" => lambda {|n| @web_site_url = n.get_string_value() },
    })
end

#is_publishedObject

Gets the isPublished property value. The scheduling page has been made available to external customers. Use the publish and unpublish actions to set this property. Read-only.

Returns:

  • a boolean



261
262
263
# File 'lib/models/booking_business.rb', line 261

def is_published
    return @is_published
end

#is_published=(value) ⇒ Object

Sets the isPublished property value. The scheduling page has been made available to external customers. Use the publish and unpublish actions to set this property. Read-only.

Parameters:

  • value

    Value to set for the isPublished property.

Returns:

  • a void



269
270
271
# File 'lib/models/booking_business.rb', line 269

def is_published=(value)
    @is_published = value
end

#language_tagObject

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

Returns:

  • a string



276
277
278
# File 'lib/models/booking_business.rb', line 276

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



284
285
286
# File 'lib/models/booking_business.rb', line 284

def language_tag=(value)
    @language_tag = value
end

#phoneObject

Gets the phone property value. The telephone number for the business. The phone property, together with address and webSiteUrl, appear in the footer of a business scheduling page.

Returns:

  • a string



291
292
293
# File 'lib/models/booking_business.rb', line 291

def phone
    return @phone
end

#phone=(value) ⇒ Object

Sets the phone property value. The telephone number for the business. The phone property, together with address and webSiteUrl, appear in the footer of a business scheduling page.

Parameters:

  • value

    Value to set for the phone property.

Returns:

  • a void



299
300
301
# File 'lib/models/booking_business.rb', line 299

def phone=(value)
    @phone = value
end

#public_urlObject

Gets the publicUrl property value. The URL for the scheduling page, which is set after you publish or unpublish the page. Read-only.

Returns:

  • a string



306
307
308
# File 'lib/models/booking_business.rb', line 306

def public_url
    return @public_url
end

#public_url=(value) ⇒ Object

Sets the publicUrl property value. The URL for the scheduling page, which is set after you publish or unpublish the page. Read-only.

Parameters:

  • value

    Value to set for the publicUrl property.

Returns:

  • a void



314
315
316
# File 'lib/models/booking_business.rb', line 314

def public_url=(value)
    @public_url = value
end

#scheduling_policyObject

Gets the schedulingPolicy property value. Specifies how bookings can be created for this business.

Returns:

  • a booking_scheduling_policy



321
322
323
# File 'lib/models/booking_business.rb', line 321

def scheduling_policy
    return @scheduling_policy
end

#scheduling_policy=(value) ⇒ Object

Sets the schedulingPolicy property value. Specifies how bookings can be created for this business.

Parameters:

  • value

    Value to set for the schedulingPolicy property.

Returns:

  • a void



329
330
331
# File 'lib/models/booking_business.rb', line 329

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)


337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
# File 'lib/models/booking_business.rb', line 337

def serialize(writer)
    raise StandardError, 'writer cannot be null' if writer.nil?
    super
    writer.write_object_value("address", @address)
    writer.write_collection_of_object_values("appointments", @appointments)
    writer.write_collection_of_object_values("businessHours", @business_hours)
    writer.write_string_value("businessType", @business_type)
    writer.write_collection_of_object_values("calendarView", @calendar_view)
    writer.write_collection_of_object_values("customQuestions", @custom_questions)
    writer.write_collection_of_object_values("customers", @customers)
    writer.write_string_value("defaultCurrencyIso", @default_currency_iso)
    writer.write_string_value("displayName", @display_name)
    writer.write_string_value("email", @email)
    writer.write_string_value("languageTag", @language_tag)
    writer.write_string_value("phone", @phone)
    writer.write_object_value("schedulingPolicy", @scheduling_policy)
    writer.write_collection_of_object_values("services", @services)
    writer.write_collection_of_object_values("staffMembers", @staff_members)
    writer.write_string_value("webSiteUrl", @web_site_url)
end

#servicesObject

Gets the services property value. All the services offered by this business. Read-only. Nullable.

Returns:

  • a booking_service



361
362
363
# File 'lib/models/booking_business.rb', line 361

def services
    return @services
end

#services=(value) ⇒ Object

Sets the services property value. All the services offered by this business. Read-only. Nullable.

Parameters:

  • value

    Value to set for the services property.

Returns:

  • a void



369
370
371
# File 'lib/models/booking_business.rb', line 369

def services=(value)
    @services = value
end

#staff_membersObject

Gets the staffMembers property value. All the staff members that provide services in this business. Read-only. Nullable.

Returns:

  • a booking_staff_member_base



376
377
378
# File 'lib/models/booking_business.rb', line 376

def staff_members
    return @staff_members
end

#staff_members=(value) ⇒ Object

Sets the staffMembers property value. All the staff members that provide services in this business. Read-only. Nullable.

Parameters:

  • value

    Value to set for the staffMembers property.

Returns:

  • a void



384
385
386
# File 'lib/models/booking_business.rb', line 384

def staff_members=(value)
    @staff_members = value
end

#web_site_urlObject

Gets the webSiteUrl property value. The URL of the business web site. The webSiteUrl property, together with address, phone, appear in the footer of a business scheduling page.

Returns:

  • a string



391
392
393
# File 'lib/models/booking_business.rb', line 391

def web_site_url
    return @web_site_url
end

#web_site_url=(value) ⇒ Object

Sets the webSiteUrl property value. The URL of the business web site. The webSiteUrl property, together with address, phone, appear in the footer of a business scheduling page.

Parameters:

  • value

    Value to set for the webSiteUrl property.

Returns:

  • a void



399
400
401
# File 'lib/models/booking_business.rb', line 399

def web_site_url=(value)
    @web_site_url = value
end