mindbody-api-v6 1.0.0

data/docs/Size.md

@@ -0,0 +1,9 @@
+# SwaggerClient::Size
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | The ID of the product size. | [optional] 
+**name** | **String** | The name of the product size. | [optional] 
+
+

data/docs/Staff.md

@@ -0,0 +1,31 @@
+# SwaggerClient::Staff
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**address** | **String** | The address of the staff member who is teaching the class. | [optional] 
+**appointment_instructor** | **BOOLEAN** | When `true`, indicates that the staff member offers appointments.<br />  When `false`, indicates that the staff member does not offer appointments. | [optional] 
+**always_allow_double_booking** | **BOOLEAN** | When `true`, indicates that the staff member can be scheduled for overlapping services.<br />  When `false`, indicates that the staff can only be scheduled for one service at a time in any given time-frame. | [optional] 
+**bio** | **String** | The staff member’s biography. This string contains HTML. | [optional] 
+**city** | **String** | The staff member’s city. | [optional] 
+**country** | **String** | The staff member’s country. | [optional] 
+**email** | **String** | The staff member’s email address. | [optional] 
+**first_name** | **String** | The staff member’s first name. | [optional] 
+**home_phone** | **String** | The staff member’s home phone number. | [optional] 
+**id** | **Integer** | The ID assigned to the staff member. | [optional] 
+**independent_contractor** | **BOOLEAN** | When `true`, indicates that the staff member is an independent contractor.  When `false`, indicates that the staff member is not an independent contractor. | [optional] 
+**is_male** | **BOOLEAN** | When `true`, indicates that the staff member is male.  When `false`, indicates that the staff member is female. | [optional] 
+**last_name** | **String** | The staff member’s last name. | [optional] 
+**mobile_phone** | **String** | The staff member’s mobile phone number. | [optional] 
+**name** | **String** | The staff member’s name. | [optional] 
+**postal_code** | **String** | The staff member’s postal code. | [optional] 
+**class_teacher** | **BOOLEAN** | When `true`, indicates that the staff member can teach classes.  When `false`, indicates that the staff member cannot teach classes. | [optional] 
+**sort_order** | **Integer** | If configured by the business owner, this field determines a staff member’s weight when sorting. Use this field to sort staff members on your interface. | [optional] 
+**state** | **String** | The staff member’s state. | [optional] 
+**work_phone** | **String** | The staff member’s work phone number. | [optional] 
+**image_url** | **String** | The URL of the staff member’s image, if one has been uploaded. | [optional] 
+**appointments** | [**Array<Appointment>**](Appointment.md) | A list of appointments for the staff. | [optional] 
+**unavailabilities** | [**Array<Unavailability>**](Unavailability.md) | A list of unavailabilities for the staff. | [optional] 
+**availabilities** | [**Array<Availability>**](Availability.md) | A list of availabilities for the staff. | [optional] 
+
+

data/docs/StaffApi.md

@@ -0,0 +1,131 @@
+# SwaggerClient::StaffApi
+
+All URIs are relative to *https://api.mindbodyonline.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**staff_get_staff**](StaffApi.md#staff_get_staff) | **GET** /public/v{version}/staff/staff | Get staff members at a site.
+[**staff_get_staff_permissions**](StaffApi.md#staff_get_staff_permissions) | **GET** /public/v{version}/staff/staffpermissions | Get configured staff permissions for a staff member.
+
+
+# **staff_get_staff**
+> GetStaffResponse staff_get_staff(site_id, version, opts)
+
+Get staff members at a site.
+
+### Example
+```ruby
+# load the gem
+require 'swagger_client'
+
+api_instance = SwaggerClient::StaffApi.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_filters: ['request_filters_example'], # Array<String> | Filters to apply to the search. Possible values are:  * StaffViewable  * AppointmentInstructor  * ClassInstructor  * Male  * Female
+  request_limit: 56, # Integer | Number of results to include, defaults to 100
+  request_location_id: 56, # Integer | Return only staff members that are available at the specified location. You must supply a valid `SessionTypeID` and `StartDateTime` to use this parameter.
+  request_offset: 56, # Integer | Page offset, defaults to 0.
+  request_session_type_id: 56, # Integer | Return only staff members that are available for the specified session type. You must supply a valid `StartDateTime` and `LocationID` to use this parameter.
+  request_staff_ids: [56], # Array<Integer> | A list of the requested staff IDs.
+  request_start_date_time: DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Return only staff members that are available at the specified date and time. You must supply a valid `SessionTypeID` and `LocationID` to use this parameter.
+}
+
+begin
+  #Get staff members at a site.
+  result = api_instance.staff_get_staff(site_id, version, opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling StaffApi->staff_get_staff: #{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_filters** | [**Array&lt;String&gt;**](String.md)| Filters to apply to the search. Possible values are:  * StaffViewable  * AppointmentInstructor  * ClassInstructor  * Male  * Female | [optional] 
+ **request_limit** | **Integer**| Number of results to include, defaults to 100 | [optional] 
+ **request_location_id** | **Integer**| Return only staff members that are available at the specified location. You must supply a valid &#x60;SessionTypeID&#x60; and &#x60;StartDateTime&#x60; to use this parameter. | [optional] 
+ **request_offset** | **Integer**| Page offset, defaults to 0. | [optional] 
+ **request_session_type_id** | **Integer**| Return only staff members that are available for the specified session type. You must supply a valid &#x60;StartDateTime&#x60; and &#x60;LocationID&#x60; to use this parameter. | [optional] 
+ **request_staff_ids** | [**Array&lt;Integer&gt;**](Integer.md)| A list of the requested staff IDs. | [optional] 
+ **request_start_date_time** | **DateTime**| Return only staff members that are available at the specified date and time. You must supply a valid &#x60;SessionTypeID&#x60; and &#x60;LocationID&#x60; to use this parameter. | [optional] 
+
+### Return type
+
+[**GetStaffResponse**](GetStaffResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json, text/json, application/xml, text/xml, multipart/form-data
+
+
+
+# **staff_get_staff_permissions**
+> GetStaffPermissionsResponse staff_get_staff_permissions(request_staff_id, site_id, version, opts)
+
+Get configured staff permissions for a staff member.
+
+### Example
+```ruby
+# load the gem
+require 'swagger_client'
+
+api_instance = SwaggerClient::StaffApi.new
+
+request_staff_id = 789 # Integer | The ID of the staff member whose permissions you want to return.
+
+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 configured staff permissions for a staff member.
+  result = api_instance.staff_get_staff_permissions(request_staff_id, site_id, version, opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling StaffApi->staff_get_staff_permissions: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **request_staff_id** | **Integer**| The ID of the staff member whose permissions you want to return. | 
+ **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
+
+[**GetStaffPermissionsResponse**](GetStaffPermissionsResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json, text/json, application/xml, text/xml, multipart/form-data
+
+
+

data/docs/StaffPermissionGroup.md

@@ -0,0 +1,11 @@
+# SwaggerClient::StaffPermissionGroup
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**permission_group_name** | **String** | The name of the permission group. | [optional] 
+**ip_restricted** | **BOOLEAN** | When `true`, the staff member’s permissions are restricted to specific IP addresses.<br />  When `false`, the staff member’s permissions are not restricted to specific IP addresses. | [optional] 
+**allowed_permissions** | **Array<String>** | A list of the permissions allowed to the staff member. See [Permission Values](https://developers.mindbodyonline.com/PublicDocumentation/V6#epermission-values) for descriptions of the possible permissions. | [optional] 
+**denied_permissions** | **Array<String>** | A list of the permissions that the staff member is not allowed to exercise. See [Permission Values](https://developers.mindbodyonline.com/PublicDocumentation/V6#epermission-values) for descriptions of the possible permissions. | [optional] 
+
+

data/docs/StoredCardInfo.md

@@ -0,0 +1,8 @@
+# SwaggerClient::StoredCardInfo
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**last_four** | **String** |  | [optional] 
+
+

data/docs/SubstituteClassTeacherRequest.md

@@ -0,0 +1,13 @@
+# SwaggerClient::SubstituteClassTeacherRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**class_id** | **Integer** | The ID of the class to which a substitute teacher needs to be assigned. | 
+**staff_id** | **Integer** | The staff ID of the teacher to substitute. | 
+**override_conflicts** | **BOOLEAN** | When `true`, overrides any conflicts in the schedule. | [optional] 
+**send_client_email** | **BOOLEAN** | When `true`, sends the client an automatic email about the substitution, if the client has opted to receive email. | [optional] 
+**send_original_teacher_email** | **BOOLEAN** | When `true`, sends the originally scheduled teacher an automatic email about the substitution. | [optional] 
+**send_substitute_teacher_email** | **BOOLEAN** | When `true`, sends the substituted teacher an automatic email about the substitution. | [optional] 
+
+

data/docs/SubstituteClassTeacherResponse.md

@@ -0,0 +1,8 @@
+# SwaggerClient::SubstituteClassTeacherResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_class** | [**SubstituteTeacherClass**](SubstituteTeacherClass.md) | Contains information about the class that is being assigned a substitute teacher. | [optional] 
+
+

data/docs/SubstituteTeacherClass.md

@@ -0,0 +1,27 @@
+# SwaggerClient::SubstituteTeacherClass
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**class_schedule_id** | **Integer** | The class schedule ID of the requested class. | [optional] 
+**location** | [**Location**](Location.md) | Contains information about the location where the class is taking place. | [optional] 
+**max_capacity** | **Integer** | The total number of bookings allowed in the class. | [optional] 
+**web_capacity** | **Integer** | The total number of online bookings allowed in the class. | [optional] 
+**total_booked** | **Integer** | The total number of clients who are booked into the class prior to this call being made. | [optional] 
+**total_booked_waitlist** | **Integer** | The total number of booked clients who are on the waiting list for the class prior to this call being made. | [optional] 
+**web_booked** | **Integer** | The total number of bookings in the class made by online users, prior to this call being made. This property is the current number of bookings counted toward the `WebCapacity` limit. | [optional] 
+**semester_id** | **Integer** | Identifies the semester assigned to this class. | [optional] 
+**is_canceled** | **BOOLEAN** | When `true`, indicates that the class has been canceled.<br />  When `false`, indicates that the class has not been canceled and may still be bookable. | [optional] 
+**substitute** | **BOOLEAN** | When `true`, indicates that the class is being taught by a substitute teacher. | [optional] 
+**active** | **BOOLEAN** | When `true`, indicates that the class is being shown to clients in consumer mode. | [optional] 
+**is_waitlist_available** | **BOOLEAN** | When `true`, indicates that the class has a waiting list and there is space available on the waiting list for another client.<br />  When `false`, indicates either that the class does not have a waiting list or there is no space available on the class waiting list. | [optional] 
+**hide_cancel** | **BOOLEAN** | When `true`, indicates that this class is should not be shown to clients when `IsCancelled` is `true`.<br />  When `false`, indicates that this class is should be shown to clients when `IsCancelled` is `true`.<br />  This property can be ignored when the `IsCancelled` property is `false`. | [optional] 
+**id** | **Integer** | The unique identifier of the class. | [optional] 
+**is_available** | **BOOLEAN** | When `true`, indicates that the class can be booked.<br />  When `false`, that the class cannot be booked at this time. | [optional] 
+**start_date_time** | **DateTime** | The date and time that this class is scheduled to start. | [optional] 
+**end_date_time** | **DateTime** | The date and time when this class is scheduled to end. | [optional] 
+**last_modified_date_time** | **DateTime** | The last time the class was modified. | [optional] 
+**class_description** | [**ClassDescription**](ClassDescription.md) | Contains information about this class. | [optional] 
+**staff** | [**Staff**](Staff.md) | Contains information about the teacher of the class. | [optional] 
+
+

data/docs/TimeCardEvent.md

@@ -0,0 +1,10 @@
+# SwaggerClient::TimeCardEvent
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**time_in** | **DateTime** | The time that the staff member started the job task. | [optional] 
+**time_out** | **DateTime** | The time that the staff member stopped doing the job task. | [optional] 
+**hours** | **Float** | The number of hours on this time card. | [optional] 
+
+

data/docs/TimeClockReport.md

@@ -0,0 +1,13 @@
+# SwaggerClient::TimeClockReport
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**staff_id** | **Integer** | The ID of the requested staff member. | [optional] 
+**task** | **String** | The staff member’s job title. | [optional] 
+**hourly_rate** | **Float** | The hourly rate the business pays for this job. | [optional] 
+**total_hours** | **Float** | The sum of the hours worked by the staff member in this time card report. | [optional] 
+**total_pay** | **Float** | The total amount earned by the staff member for this time card report. | [optional] 
+**time_cards** | [**Array<TimeCardEvent>**](TimeCardEvent.md) | Information about when a staff member began and ended a task. | [optional] 
+
+

data/docs/Unavailability.md

@@ -0,0 +1,11 @@
+# SwaggerClient::Unavailability
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | The ID of the unavailability. | [optional] 
+**start_date_time** | **DateTime** | The date and time the unavailability starts. | [optional] 
+**end_date_time** | **DateTime** | The date and time the unavailability ends. | [optional] 
+**description** | **String** | A description of the unavailability. | [optional] 
+
+

data/docs/UpcomingAutopayEvent.md

@@ -0,0 +1,11 @@
+# SwaggerClient::UpcomingAutopayEvent
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**client_contract_id** | **Integer** | The ID of the contract. | [optional] 
+**charge_amount** | **Float** | The amount charged. | [optional] 
+**payment_method** | **String** | The payment method. | [optional] 
+**schedule_date** | **DateTime** | The date and time of the next payment. | [optional] 
+
+

data/docs/UpdateAppointmentRequest.md

@@ -0,0 +1,19 @@
+# SwaggerClient::UpdateAppointmentRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**appointment_id** | **Integer** | The appointments unique ID. | 
+**end_date_time** | **DateTime** | The end date and time of the new appointment.   <br />Default: **StartDateTime**, offset by the staff member’s default appointment duration. | [optional] 
+**execute** | **String** | The action taken to add this appointment. | [optional] 
+**gender_preference** | **String** | The client’s service provider gender preference. | [optional] 
+**notes** | **String** | Any general notes about this appointment. | [optional] 
+**provider_id** | **String** | If a user has Complementary and Alternative Medicine features enabled, this parameter assigns a provider ID to the appointment. | [optional] 
+**resource_ids** | **Array<Integer>** | A list of resource IDs to associate with the new appointment. | [optional] 
+**send_email** | **BOOLEAN** | Whether to send client an email for cancellations. An email is sent only if the client has an email address and automatic emails have been set up.   <br />Default: **false** | [optional] 
+**session_type_id** | **Integer** | The session type associated with the new appointment. | [optional] 
+**staff_id** | **Integer** | The ID of the staff member who is adding the new appointment. | [optional] 
+**start_date_time** | **DateTime** | The start date and time of the new appointment. | [optional] 
+**test** | **BOOLEAN** | When `true`, indicates that the method is to be validated, but no new appointment data is added.   <br />Default: **false** | [optional] 
+
+

data/docs/UpdateAppointmentResponse.md

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

data/docs/UpdateClientRequest.md

@@ -0,0 +1,11 @@
+# SwaggerClient::UpdateClientRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**client** | [**Client**](Client.md) | Contains information about the client to be updated. The client ID is used to look up the existing client to update and any specified values are updated. | 
+**test** | **BOOLEAN** | When `true`, indicates that test mode is enabled. The method is validated, but no client data is added or updated.<br />  Default: **false** | [optional] 
+**cross_regional_update** | **BOOLEAN** | When `true`, the updated information is propagated to all of the region’s sites where the client has a profile.<br />  When `false`, only the local client is updated.<br />  Default: **true** | [optional] 
+**new_id** | **String** | The new RSSID to be used for the client. Use `NewId` to assign a specific number to be a client’s ID. If that number is not available, the call returns an error. This RSSID must be unique within the subscriber’s site. If this is a cross-regional update, the RSSID must be unique across the region. If the requested number is already in use, an error is returned. | [optional] 
+
+

data/docs/UpdateClientResponse.md

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

data/docs/UpdateClientServiceRequest.md

@@ -0,0 +1,11 @@
+# SwaggerClient::UpdateClientServiceRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**service_id** | **Integer** | The ID of the service to update. | 
+**active_date** | **DateTime** | The date that the service became active. | [optional] 
+**expiration_date** | **DateTime** | The date that the service is to expire. | [optional] 
+**test** | **BOOLEAN** | When `true`, indicates that input information is to be validated, but not committed.<br />  When `false` or omitted, the database is affected.<br />  Default: **false** | [optional] 
+
+

data/docs/UpdateClientServiceResponse.md

@@ -0,0 +1,8 @@
+# SwaggerClient::UpdateClientServiceResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**client_service** | [**ClientService**](ClientService.md) | Contains information about the updated service. | [optional] 
+
+

data/docs/UpdateClientVisitRequest.md

@@ -0,0 +1,13 @@
+# SwaggerClient::UpdateClientVisitRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**visit_id** | **Integer** | The ID of the visit to be updated. | 
+**makeup** | **BOOLEAN** | When `true`, indicates that the visit is eligible to be made up. | [optional] 
+**signed_in** | **BOOLEAN** | When `true`, indicates that the client has signed in for the visit. | [optional] 
+**execute** | **String** | The execute code used to update this visit. Possible values are:  * Cancel  * Latecancel  * Unlatecancel | [optional] 
+**test** | **BOOLEAN** | When `true`, indicates that test mode is enabled. When test mode is enabled, 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 for cancellations. Note that email is not sent unless the client has an email address and automatic emails have been set up correctly.<br />  Default: **false** | [optional] 
+
+

data/docs/UpdateClientVisitResponse.md

@@ -0,0 +1,8 @@
+# SwaggerClient::UpdateClientVisitResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**visit** | [**Visit**](Visit.md) | The updated visit. | [optional] 
+
+

data/docs/UpdateContactLogComment.md

@@ -0,0 +1,9 @@
+# SwaggerClient::UpdateContactLogComment
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | The ID of the contact log comment to be updated. Pass a value of `0` to add a new comment to the contact log. | [optional] 
+**text** | **String** | The new text for the comment. | [optional] 
+
+

data/docs/UpdateContactLogRequest.md

@@ -0,0 +1,16 @@
+# SwaggerClient::UpdateContactLogRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | The ID of the contact log being updated. | [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] 
+**assigned_to_staff_id** | **Integer** | The ID of the staff member to whom the contact log is now being assigned. | [optional] 
+**text** | **String** | The contact log’s new text. | [optional] 
+**contact_name** | **String** | The name of the new person to be contacted by the assigned staff member. | [optional] 
+**followup_by_date** | **DateTime** | The new date by which the assigned staff member should complete this contact log. | [optional] 
+**contact_method** | **String** | The new method by which the client wants to be contacted. | [optional] 
+**comments** | [**Array<UpdateContactLogComment>**](UpdateContactLogComment.md) | Contains information about the comments being updated or added to the contact log. Comments that have an ID of `0` are added to the contact log. | [optional] 
+**types** | [**Array<UpdateContactLogType>**](UpdateContactLogType.md) | Contains information about the contact logs types being assigned to the contact log, in addition to the contact log types that are already assigned. | [optional] 
+
+

data/docs/UpdateContactLogType.md

@@ -0,0 +1,9 @@
+# SwaggerClient::UpdateContactLogType
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | The ID of the contact log type to update the subtypes of. | [optional] 
+**sub_types** | **Array<Integer>** | The subtype IDs that are to be added to the contact log. | [optional] 
+
+