mindbody-api-v6 1.0.0

data/docs/AddClientResponse.md

@@ -0,0 +1,8 @@
+# SwaggerClient::AddClientResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**client** | [**Client**](Client.md) | Contains information about the client. | [optional] 
+
+

data/docs/AddClientToClassRequest.md

@@ -0,0 +1,17 @@
+# SwaggerClient::AddClientToClassRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**client_id** | **String** | The ID of the client who is being booked into the class | 
+**class_id** | **Integer** | The ID of the class into which the client is being booked | 
+**test** | **BOOLEAN** | When `true`, indicates that input information is validated, but not committed.<br />  When `false`, the information is committed and the database is affected.<br />  Default: **false** | [optional] 
+**require_payment** | **BOOLEAN** | When `true`, the client must have an active, usable pricing option on their account.<br />  When `false` or omitted, an active pricing option is not required to complete the client’s booking. | [optional] 
+**waitlist** | **BOOLEAN** | When `true`, indicates that the client should be added to a specific class waiting list.<br />  When `false`, the client should not be added to the waiting list. | [optional] 
+**send_email** | **BOOLEAN** | When `true`, the subscriber’s configured Booking Confirmation automatic email is sent to the client. Note that an email is sent only if the client has an email address and automatic emails have been set up.<br />  When `false`, indicates that the client does not receive emails.<br />  Default: **false** | [optional] 
+**waitlist_entry_id** | **Integer** | The ID of the waiting list entry from which you are moving a client into a class. | [optional] 
+**client_service_id** | **Integer** | The ID of the pricing option on the client’s account that you want to use to pay for this booking, if payment is required at the time of the update. | [optional] 
+**cross_regional_booking** | **BOOLEAN** | When `true`, cross regional series are checked and used if applicable. | [optional] 
+**cross_regional_booking_client_service_site_id** | **Integer** | If the request is cross regional, use a purchased pricing option from this specified site. If omitted, an attempt is made to use an applicable pricing option from the local site. | [optional] 
+
+

data/docs/AddClientToClassResponse.md

@@ -0,0 +1,8 @@
+# SwaggerClient::AddClientToClassResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**visit** | [**AddClientToClassVisit**](AddClientToClassVisit.md) | Contains information about the created visit. | [optional] 
+
+

data/docs/AddClientToClassVisit.md

@@ -0,0 +1,28 @@
+# SwaggerClient::AddClientToClassVisit
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**cross_regional_booking_performed** | **BOOLEAN** | When `true`, indicates that the client is paying for the visit using a pricing option from one of their associated cross-regional profiles. | [optional] 
+**site_id** | **Integer** | The ID of the business from which cross-regional payment is applied. | [optional] 
+**waitlist_entry_id** | **Integer** | When this value is not null, it indicates that the client is on the waiting list for the requested class. The only additional fields that are populated when this is not null are:  * ClassId  * ClientId    You can call GET WaitlistEntries using `WaitlistEntryId` to obtain more data about this waiting list entry. | [optional] 
+**appointment_id** | **Integer** | The appointment’s ID. | [optional] 
+**appointment_gender_preference** | **String** | The gender of staff member with whom the client prefers to book appointments. | [optional] 
+**appointment_status** | **String** | The status of the appointment. | [optional] 
+**class_id** | **Integer** | The class ID that was used to retrieve the visits. | [optional] 
+**client_id** | **String** | The ID of the client associated with the visit. | [optional] 
+**start_date_time** | **DateTime** | The time this class is scheduled to start. | [optional] 
+**end_date_time** | **DateTime** | The date and time the visit ends. The Public API returns UTC dates and times. For example, a class that occurs on June 25th, 2018 at 2:15PM (EST) appears as “2018-06-25T19:15:00Z” because EST is five hours behind UTC. Date time pairs always return in the format YYYY-MM-DDTHH:mm:ssZ. | [optional] 
+**id** | **Integer** | The ID of the visit. | [optional] 
+**last_modified_date_time** | **DateTime** | When included in the request, only records modified on or after the specified `LastModifiedDate` are included in the response. The Public API returns UTC dates and times. For example, a class that occurs on June 25th, 2018 at 2:15PM (EST) appears as “2018-06-25T19:15:00Z” because EST is five hours behind UTC. Date time pairs always return in the format YYYY-MM-DDTHH:mm:ssZ. | [optional] 
+**late_cancelled** | **BOOLEAN** | When `true`, indicates that the class has been `LateCancelled`.<br />  When `false`, indicates that the class has not been `LateCancelled`. | [optional] 
+**location_id** | **Integer** | The ID of the location where the visit took place or is to take place. | [optional] 
+**make_up** | **BOOLEAN** | When `true`, the client can make up this session and a session is not deducted from the pricing option that was used to sign the client into the enrollment. When the client has the make-up session, a session is automatically removed from a pricing option that matches the service category of the enrollment and is within the same date range of the missed session.<br />  When `false`, the client cannot make up this session. See [Enrollments: Make-ups](https://support.mindbodyonline.com/s/article/203259433-Enrollments-Make-ups?language=en_US) for more information. | [optional] 
+**name** | **String** | The name of the class. | [optional] 
+**service_id** | **Integer** | The ID of the pricing option used to pay for the class visit. | [optional] 
+**signed_in** | **BOOLEAN** | When `true`, indicates that the client has been signed in.<br />  When `false`, indicates that the client has not been signed in. | [optional] 
+**staff_id** | **Integer** | The ID of the staff member who is teaching the class. | [optional] 
+**web_signup** | **BOOLEAN** | When `true`, indicates that the client signed up online.<br />  When `false`, indicates that the client was signed up by a staff member. | [optional] 
+**action** | **String** | The action taken. | [optional] 
+
+

data/docs/AddClientToEnrollmentRequest.md

@@ -0,0 +1,15 @@
+# SwaggerClient::AddClientToEnrollmentRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**client_id** | **String** | The ID of the client who is being booked into the enrollment. | 
+**class_schedule_id** | **Integer** | The ID of the class schedule (enrollment) into which the client is being booked. | 
+**enroll_date_forward** | **DateTime** | Enroll the clients from this date forward. `EnrollDateForward` takes priority over open enrollment. | [optional] 
+**enroll_open** | **Array<DateTime>** | Enroll for selected days. | [optional] 
+**test** | **BOOLEAN** | When `true`, input information is validated, but not committed.<br />  Default: **false** | [optional] 
+**send_email** | **BOOLEAN** | When `true`, indicates that the client should be sent an email. An email is only sent if the client has an email address and automatic emails have been set up.<br />  Default: **false** | [optional] 
+**waitlist** | **BOOLEAN** | When `true`, the client is added to a specific enrollments waiting list. | [optional] 
+**waitlist_entry_id** | **Integer** | The waiting list entry to add. Used to add a client to an enrollment from a waiting list entry. | [optional] 
+
+

data/docs/AddContactLogRequest.md

@@ -0,0 +1,16 @@
+# SwaggerClient::AddContactLogRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**client_id** | **String** | The ID of the client whose contact log is being added. | 
+**assigned_to_staff_id** | **Integer** | The ID of the staff member to whom the contact log is assigned. | [optional] 
+**text** | **String** | The body of the contact log. | [optional] 
+**followup_by_date** | **DateTime** | The date by which the assigned staff member should complete this contact log. | [optional] 
+**contact_method** | **String** | How the client wants to be contacted. | 
+**contact_name** | **String** | The name of the person to be contacted by the assigned staff member. | [optional] 
+**comments** | **Array<String>** | Any comments on the contact log. | [optional] 
+**types** | [**Array<AddContactLogType>**](AddContactLogType.md) | The contact log types used to tag this contact log. | [optional] 
+**test** | **BOOLEAN** | When `true`, indicates that this is a test request and no data is inserted into the subscriber’s database.<br />  When `false`, the database is updated. | [optional] 
+
+

data/docs/AddContactLogType.md

@@ -0,0 +1,9 @@
+# SwaggerClient::AddContactLogType
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | The contact log type’s ID. | [optional] 
+**sub_types** | **Array<Integer>** | A list of the subtype IDs used to tag this contact log type. | [optional] 
+
+

data/docs/Amenity.md

@@ -0,0 +1,9 @@
+# SwaggerClient::Amenity
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | The ID number of the amenity. | [optional] 
+**name** | **String** | The name of the amenity, for example, food or lockers. | [optional] 
+
+

data/docs/Appointment.md

@@ -0,0 +1,24 @@
+# SwaggerClient::Appointment
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**gender_preference** | **String** | The preferred gender of the appointment provider. | [optional] 
+**duration** | **Integer** | The duration of the appointment. | [optional] 
+**provider_id** | **String** | If a user has Complementary and Alternative Medicine features enabled, this property indicates the provider assigned to the appointment. | [optional] 
+**id** | **Integer** | The unique ID of the appointment. | [optional] 
+**status** | **String** | The status of this appointment. | [optional] 
+**start_date_time** | **DateTime** | The date and time the appointment is to start. | [optional] 
+**end_date_time** | **DateTime** | The date and time the appointment is to end. | [optional] 
+**notes** | **String** | Any notes associated with the appointment. | [optional] 
+**staff_requested** | **BOOLEAN** | When `true`, indicates that the staff member was requested specifically by the client. | [optional] 
+**program_id** | **Integer** | The ID of the program to which this appointment belongs. | [optional] 
+**session_type_id** | **Integer** | The ID of the session type of this appointment. | [optional] 
+**location_id** | **Integer** | The ID of the location where this appointment is to take place. | [optional] 
+**staff_id** | **Integer** | The ID of the staff member providing the service for this appointment. | [optional] 
+**client_id** | **String** | The RSSID of the client who is booked for this appointment. | [optional] 
+**first_appointment** | **BOOLEAN** | When `true`, indicates that this is the client’s first appointment at this site. | [optional] 
+**client_service_id** | **Integer** | The ID of the pass on the client’s account that is to pay for this appointment. | [optional] 
+**resources** | [**Array<Resource>**](Resource.md) | The resources this appointment is to use. | [optional] 
+
+

data/docs/AppointmentApi.md

@@ -0,0 +1,460 @@
+# SwaggerClient::AppointmentApi
+
+All URIs are relative to *https://api.mindbodyonline.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**appointment_add_apppointment**](AppointmentApi.md#appointment_add_apppointment) | **POST** /public/v{version}/appointment/addappointment | Book a new appointment.
+[**appointment_get_active_session_times**](AppointmentApi.md#appointment_get_active_session_times) | **GET** /public/v{version}/appointment/activesessiontimes | Get active session times.
+[**appointment_get_appointment_options**](AppointmentApi.md#appointment_get_appointment_options) | **GET** /public/v{version}/appointment/appointmentoptions | Get appointment-related settings.
+[**appointment_get_bookable_items**](AppointmentApi.md#appointment_get_bookable_items) | **GET** /public/v{version}/appointment/bookableitems | Get staff appointment availability.
+[**appointment_get_schedule_items**](AppointmentApi.md#appointment_get_schedule_items) | **GET** /public/v{version}/appointment/scheduleitems | Get appointment schedule.
+[**appointment_get_staff_appointments**](AppointmentApi.md#appointment_get_staff_appointments) | **GET** /public/v{version}/appointment/staffappointments | Get appointments grouped by staff member.
+[**appointment_update_apppointment**](AppointmentApi.md#appointment_update_apppointment) | **POST** /public/v{version}/appointment/updateappointment | Update an existing appointment.
+
+
+# **appointment_add_apppointment**
+> AddAppointmentResponse appointment_add_apppointment(request, site_id, version, opts)
+
+Book a new appointment.
+
+To book an appointment, you must use a location ID, staff ID, client ID, session type ID, and the `StartDateTime` of the appointment. You can get most of this information using `GET BookableItems`.
+
+### Example
+```ruby
+# load the gem
+require 'swagger_client'
+
+api_instance = SwaggerClient::AppointmentApi.new
+
+request = SwaggerClient::AddAppointmentRequest.new # AddAppointmentRequest | 
+
+site_id = 'site_id_example' # String | ID of the site from which to pull data.
+
+version = 'version_example' # String | 
+
+opts = { 
+  authorization: '' # String | A staff user authorization token.
+}
+
+begin
+  #Book a new appointment.
+  result = api_instance.appointment_add_apppointment(request, site_id, version, opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling AppointmentApi->appointment_add_apppointment: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **request** | [**AddAppointmentRequest**](AddAppointmentRequest.md)|  | 
+ **site_id** | **String**| ID of the site from which to pull data. | 
+ **version** | **String**|  | 
+ **authorization** | **String**| A staff user authorization token. | [optional] [default to ]
+
+### Return type
+
+[**AddAppointmentResponse**](AddAppointmentResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded, multipart/form-data
+ - **Accept**: application/json, text/json, application/xml, text/xml, multipart/form-data
+
+
+
+# **appointment_get_active_session_times**
+> GetActiveSessionTimesResponse appointment_get_active_session_times(site_id, version, opts)
+
+Get active session times.
+
+Returns a list of the times that can be booked for a given program schedule type. `ActiveSessionTimes` represent the scheduling increments that can be booked during the active business hours for services.
+
+### Example
+```ruby
+# load the gem
+require 'swagger_client'
+
+api_instance = SwaggerClient::AppointmentApi.new
+
+site_id = 'site_id_example' # String | ID of the site from which to pull data.
+
+version = 'version_example' # String | 
+
+opts = { 
+  authorization: '', # String | A staff user authorization token.
+  request_end_time: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filters results to times that end on or before this time on the current date. Any date provided is ignored..  <br />Default: **23:59:59**
+  request_limit: 56, # Integer | Number of results to include, defaults to 100
+  request_offset: 56, # Integer | Page offset, defaults to 0.
+  request_schedule_type: 'request_schedule_type_example', # String | Filters on the provided the schedule type. Either `SessionTypeIds` or `ScheduleType` must be provided.
+  request_session_type_ids: [56], # Array<Integer> | Filters on the provided session type IDs. Either `SessionTypeIds` or `ScheduleType` must be provided.
+  request_start_time: DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Filters results to times that start on or after this time on the current date. Any date provided is ignored.  <br />Default: **00:00:00**
+}
+
+begin
+  #Get active session times.
+  result = api_instance.appointment_get_active_session_times(site_id, version, opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling AppointmentApi->appointment_get_active_session_times: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **site_id** | **String**| ID of the site from which to pull data. | 
+ **version** | **String**|  | 
+ **authorization** | **String**| A staff user authorization token. | [optional] [default to ]
+ **request_end_time** | **DateTime**| Filters results to times that end on or before this time on the current date. Any date provided is ignored..  &lt;br /&gt;Default: **23:59:59** | [optional] 
+ **request_limit** | **Integer**| Number of results to include, defaults to 100 | [optional] 
+ **request_offset** | **Integer**| Page offset, defaults to 0. | [optional] 
+ **request_schedule_type** | **String**| Filters on the provided the schedule type. Either &#x60;SessionTypeIds&#x60; or &#x60;ScheduleType&#x60; must be provided. | [optional] 
+ **request_session_type_ids** | [**Array&lt;Integer&gt;**](Integer.md)| Filters on the provided session type IDs. Either &#x60;SessionTypeIds&#x60; or &#x60;ScheduleType&#x60; must be provided. | [optional] 
+ **request_start_time** | **DateTime**| Filters results to times that start on or after this time on the current date. Any date provided is ignored.  &lt;br /&gt;Default: **00:00:00** | [optional] 
+
+### Return type
+
+[**GetActiveSessionTimesResponse**](GetActiveSessionTimesResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json, text/json, application/xml, text/xml, multipart/form-data
+
+
+
+# **appointment_get_appointment_options**
+> GetAppointmentOptionsResponse appointment_get_appointment_options(site_id, version, opts)
+
+Get appointment-related settings.
+
+This endpoint has no query parameters.
+
+### Example
+```ruby
+# load the gem
+require 'swagger_client'
+
+api_instance = SwaggerClient::AppointmentApi.new
+
+site_id = 'site_id_example' # String | ID of the site from which to pull data.
+
+version = 'version_example' # String | 
+
+opts = { 
+  authorization: '' # String | A staff user authorization token.
+}
+
+begin
+  #Get appointment-related settings.
+  result = api_instance.appointment_get_appointment_options(site_id, version, opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling AppointmentApi->appointment_get_appointment_options: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **site_id** | **String**| ID of the site from which to pull data. | 
+ **version** | **String**|  | 
+ **authorization** | **String**| A staff user authorization token. | [optional] [default to ]
+
+### Return type
+
+[**GetAppointmentOptionsResponse**](GetAppointmentOptionsResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json, text/json, application/xml, text/xml, multipart/form-data
+
+
+
+# **appointment_get_bookable_items**
+> GetBookableItemsResponse appointment_get_bookable_items(request_session_type_ids, site_id, version, opts)
+
+Get staff appointment availability.
+
+Returns a list of availabilities with the information needed to book appointments. Availabilities include information such as the location and its amenities, staff members, programs, and session types.
+
+### Example
+```ruby
+# load the gem
+require 'swagger_client'
+
+api_instance = SwaggerClient::AppointmentApi.new
+
+request_session_type_ids = [56] # Array<Integer> | A list of the requested session type IDs.
+
+site_id = 'site_id_example' # String | ID of the site from which to pull data.
+
+version = 'version_example' # String | 
+
+opts = { 
+  authorization: '', # String | A staff user authorization token.
+  request_appointment_id: 789, # Integer | If provided, filters out the appointment with this ID.
+  request_end_date: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | The end date of the requested date range.   <br />Default: **StartDate**
+  request_ignore_default_session_length: true, # BOOLEAN | When `true`, availabilities that are non-default return, for example, a 30-minute availability with a 60-minute default session length.<br />  When `false`, only availabilities that have the default session length return.
+  request_limit: 56, # Integer | Number of results to include, defaults to 100
+  request_location_ids: [56], # Array<Integer> | A list of the requested location IDs.
+  request_offset: 56, # Integer | Page offset, defaults to 0.
+  request_staff_ids: [56], # Array<Integer> | A list of the requested staff IDs.
+  request_start_date: DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | The start date of the requested date range.   <br />Default: **today’s date**
+}
+
+begin
+  #Get staff appointment availability.
+  result = api_instance.appointment_get_bookable_items(request_session_type_ids, site_id, version, opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling AppointmentApi->appointment_get_bookable_items: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **request_session_type_ids** | [**Array&lt;Integer&gt;**](Integer.md)| A list of the requested session type IDs. | 
+ **site_id** | **String**| ID of the site from which to pull data. | 
+ **version** | **String**|  | 
+ **authorization** | **String**| A staff user authorization token. | [optional] [default to ]
+ **request_appointment_id** | **Integer**| If provided, filters out the appointment with this ID. | [optional] 
+ **request_end_date** | **DateTime**| The end date of the requested date range.   &lt;br /&gt;Default: **StartDate** | [optional] 
+ **request_ignore_default_session_length** | **BOOLEAN**| When &#x60;true&#x60;, availabilities that are non-default return, for example, a 30-minute availability with a 60-minute default session length.&lt;br /&gt;  When &#x60;false&#x60;, only availabilities that have the default session length return. | [optional] 
+ **request_limit** | **Integer**| Number of results to include, defaults to 100 | [optional] 
+ **request_location_ids** | [**Array&lt;Integer&gt;**](Integer.md)| A list of the requested location IDs. | [optional] 
+ **request_offset** | **Integer**| Page offset, defaults to 0. | [optional] 
+ **request_staff_ids** | [**Array&lt;Integer&gt;**](Integer.md)| A list of the requested staff IDs. | [optional] 
+ **request_start_date** | **DateTime**| The start date of the requested date range.   &lt;br /&gt;Default: **today’s date** | [optional] 
+
+### Return type
+
+[**GetBookableItemsResponse**](GetBookableItemsResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json, text/json, application/xml, text/xml, multipart/form-data
+
+
+
+# **appointment_get_schedule_items**
+> GetScheduleItemsResponse appointment_get_schedule_items(site_id, version, opts)
+
+Get appointment schedule.
+
+Returns a list of schedule items, including appointments, availabilities, and unavailabilities. Unavailabilities are the times at which appointments cannot be booked, for example, on holidays or after hours when the business is closed.
+
+### Example
+```ruby
+# load the gem
+require 'swagger_client'
+
+api_instance = SwaggerClient::AppointmentApi.new
+
+site_id = 'site_id_example' # String | ID of the site from which to pull data.
+
+version = 'version_example' # String | 
+
+opts = { 
+  authorization: '', # String | A staff user authorization token.
+  request_end_date: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | The end date of the requested date range.   <br />Default: **today’s date**
+  request_ignore_prep_finish_times: true, # BOOLEAN | When `true`, appointment preparation and finish unavailabilities are not returned.   <br />Default: **false**
+  request_limit: 56, # Integer | Number of results to include, defaults to 100
+  request_location_ids: [56], # Array<Integer> | A list of requested location IDs.
+  request_offset: 56, # Integer | Page offset, defaults to 0.
+  request_staff_ids: [56], # Array<Integer> | A list of requested staff IDs.
+  request_start_date: DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | The start date of the requested date range.   <br />Default: **today’s date**
+}
+
+begin
+  #Get appointment schedule.
+  result = api_instance.appointment_get_schedule_items(site_id, version, opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling AppointmentApi->appointment_get_schedule_items: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **site_id** | **String**| ID of the site from which to pull data. | 
+ **version** | **String**|  | 
+ **authorization** | **String**| A staff user authorization token. | [optional] [default to ]
+ **request_end_date** | **DateTime**| The end date of the requested date range.   &lt;br /&gt;Default: **today’s date** | [optional] 
+ **request_ignore_prep_finish_times** | **BOOLEAN**| When &#x60;true&#x60;, appointment preparation and finish unavailabilities are not returned.   &lt;br /&gt;Default: **false** | [optional] 
+ **request_limit** | **Integer**| Number of results to include, defaults to 100 | [optional] 
+ **request_location_ids** | [**Array&lt;Integer&gt;**](Integer.md)| A list of requested location IDs. | [optional] 
+ **request_offset** | **Integer**| Page offset, defaults to 0. | [optional] 
+ **request_staff_ids** | [**Array&lt;Integer&gt;**](Integer.md)| A list of requested staff IDs. | [optional] 
+ **request_start_date** | **DateTime**| The start date of the requested date range.   &lt;br /&gt;Default: **today’s date** | [optional] 
+
+### Return type
+
+[**GetScheduleItemsResponse**](GetScheduleItemsResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json, text/json, application/xml, text/xml, multipart/form-data
+
+
+
+# **appointment_get_staff_appointments**
+> GetStaffAppointmentsResponse appointment_get_staff_appointments(site_id, version, opts)
+
+Get appointments grouped by staff member.
+
+Returns a list of appointments by staff member.
+
+### Example
+```ruby
+# load the gem
+require 'swagger_client'
+
+api_instance = SwaggerClient::AppointmentApi.new
+
+site_id = 'site_id_example' # String | ID of the site from which to pull data.
+
+version = 'version_example' # String | 
+
+opts = { 
+  authorization: '', # String | A staff user authorization token.
+  request_appointment_ids: [56], # Array<Integer> | A list of the requested appointment IDs.
+  request_client_ids: ['request_client_ids_example'], # Array<String> | List of client IDs to be returned.
+  request_end_date: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | The end date of the requested date range.   <br />Default: **StartDate**
+  request_limit: 56, # Integer | Number of results to include, defaults to 100
+  request_location_ids: [56], # Array<Integer> | A list of the requested location IDs.
+  request_offset: 56, # Integer | Page offset, defaults to 0.
+  request_staff_ids: [56], # Array<Integer> | List of staff IDs to be returned. Use a value of zero to return all staff appointments.
+  request_start_date: DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | The start date of the requested date range. If omitted, the default is used.   <br />Default: **today’s date**
+}
+
+begin
+  #Get appointments grouped by staff member.
+  result = api_instance.appointment_get_staff_appointments(site_id, version, opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling AppointmentApi->appointment_get_staff_appointments: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **site_id** | **String**| ID of the site from which to pull data. | 
+ **version** | **String**|  | 
+ **authorization** | **String**| A staff user authorization token. | [optional] [default to ]
+ **request_appointment_ids** | [**Array&lt;Integer&gt;**](Integer.md)| A list of the requested appointment IDs. | [optional] 
+ **request_client_ids** | [**Array&lt;String&gt;**](String.md)| List of client IDs to be returned. | [optional] 
+ **request_end_date** | **DateTime**| The end date of the requested date range.   &lt;br /&gt;Default: **StartDate** | [optional] 
+ **request_limit** | **Integer**| Number of results to include, defaults to 100 | [optional] 
+ **request_location_ids** | [**Array&lt;Integer&gt;**](Integer.md)| A list of the requested location IDs. | [optional] 
+ **request_offset** | **Integer**| Page offset, defaults to 0. | [optional] 
+ **request_staff_ids** | [**Array&lt;Integer&gt;**](Integer.md)| List of staff IDs to be returned. Use a value of zero to return all staff appointments. | [optional] 
+ **request_start_date** | **DateTime**| The start date of the requested date range. If omitted, the default is used.   &lt;br /&gt;Default: **today’s date** | [optional] 
+
+### Return type
+
+[**GetStaffAppointmentsResponse**](GetStaffAppointmentsResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json, text/json, application/xml, text/xml, multipart/form-data
+
+
+
+# **appointment_update_apppointment**
+> UpdateAppointmentResponse appointment_update_apppointment(request, site_id, version, opts)
+
+Update an existing appointment.
+
+To update the information for a specific appointment, you must have a staff user token with the proper permissions. Note that you can only update the appointment’s `StartDateTime`, `EndDateTime`, `StaffId`, `Notes`, and `SessionTypeId`.
+
+### Example
+```ruby
+# load the gem
+require 'swagger_client'
+
+api_instance = SwaggerClient::AppointmentApi.new
+
+request = SwaggerClient::UpdateAppointmentRequest.new # UpdateAppointmentRequest | 
+
+site_id = 'site_id_example' # String | ID of the site from which to pull data.
+
+version = 'version_example' # String | 
+
+opts = { 
+  authorization: '' # String | A staff user authorization token.
+}
+
+begin
+  #Update an existing appointment.
+  result = api_instance.appointment_update_apppointment(request, site_id, version, opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling AppointmentApi->appointment_update_apppointment: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **request** | [**UpdateAppointmentRequest**](UpdateAppointmentRequest.md)|  | 
+ **site_id** | **String**| ID of the site from which to pull data. | 
+ **version** | **String**|  | 
+ **authorization** | **String**| A staff user authorization token. | [optional] [default to ]
+
+### Return type
+
+[**UpdateAppointmentResponse**](UpdateAppointmentResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded, multipart/form-data
+ - **Accept**: application/json, text/json, application/xml, text/xml, multipart/form-data
+
+
+