mindbody-api-v6 1.0.0

data/docs/GetClientVisitsResponse.md

@@ -0,0 +1,9 @@
+# SwaggerClient::GetClientVisitsResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pagination_response** | [**PaginationResponse**](PaginationResponse.md) | Contains information about the pagination used. | [optional] 
+**visits** | [**Array<Visit>**](Visit.md) | Contains information about client visits. | [optional] 
+
+

data/docs/GetClientsRequest.md

@@ -0,0 +1,13 @@
+# SwaggerClient::GetClientsRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**client_i_ds** | **Array<String>** | The requested client IDs.  Default: **all IDs** that the authenticated user’s access level allows. | [optional] 
+**search_text** | **String** | Text to use in the search. Can include FirstName, LastName, and Email. Note that user credentials must be provided. | [optional] 
+**is_prospect** | **BOOLEAN** | When `true`, filters the results to include only those clients marked as prospects for the business.<br />  When `false`, indicates that only those clients who are not marked prospects should be returned. | [optional] 
+**last_modified_date** | **DateTime** | Filters the results to include only the clients that have been modified on or after this date. | [optional] 
+**limit** | **Integer** | Number of results to include, defaults to 100 | [optional] 
+**offset** | **Integer** | Page offset, defaults to 0. | [optional] 
+
+

data/docs/GetClientsResponse.md

@@ -0,0 +1,9 @@
+# SwaggerClient::GetClientsResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pagination_response** | [**PaginationResponse**](PaginationResponse.md) | Contains information about the pagination used. | [optional] 
+**clients** | [**Array<Client>**](Client.md) | The requested clients. | [optional] 
+
+

data/docs/GetContactLogsRequest.md

@@ -0,0 +1,16 @@
+# SwaggerClient::GetContactLogsRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**client_id** | **String** | The ID of the client whose contact logs are being requested. | 
+**start_date** | **DateTime** | Filters the results to contact logs created on or after this date.<br />  Default: **the current date** | [optional] 
+**end_date** | **DateTime** | Filters the results to contact logs created before this date.<br />  Default: **the start date** | [optional] 
+**staff_ids** | **Array<Integer>** | Filters the results to return contact logs assigned to one or more staff IDs. | [optional] 
+**show_system_generated** | **BOOLEAN** | When `true`, system-generated contact logs are returned in the results.<br />  Default: **false** | [optional] 
+**type_ids** | **Array<Integer>** | Filters the results to contact logs assigned one or more of these type IDs. | [optional] 
+**subtype_ids** | **Array<Integer>** | Filters the results to contact logs assigned one or more of these subtype IDs. | [optional] 
+**limit** | **Integer** | Number of results to include, defaults to 100 | [optional] 
+**offset** | **Integer** | Page offset, defaults to 0. | [optional] 
+
+

data/docs/GetContactLogsResponse.md

@@ -0,0 +1,9 @@
+# SwaggerClient::GetContactLogsResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pagination_response** | [**PaginationResponse**](PaginationResponse.md) | Contains information about the pagination used. | [optional] 
+**contact_logs** | [**Array<ContactLog>**](ContactLog.md) | Contains the information about the contact logs. | [optional] 
+
+

data/docs/GetContractsRequest.md

@@ -0,0 +1,13 @@
+# SwaggerClient::GetContractsRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**contract_ids** | **Array<Integer>** | When included, the response only contains details about the specified contract IDs. | [optional] 
+**sold_online** | **BOOLEAN** | When `true`, the response only contains details about contracts and AutoPay options that can be sold online.<br />  When `false`, only contracts that are not intended to be sold online are returned.<br />  Default: **all contracts** | [optional] 
+**location_id** | **Integer** | The ID of the location that has the requested contracts and AutoPay options. | 
+**consumer_id** | **Integer** | The ID of the client. | [optional] 
+**limit** | **Integer** | Number of results to include, defaults to 100 | [optional] 
+**offset** | **Integer** | Page offset, defaults to 0. | [optional] 
+
+

data/docs/GetContractsResponse.md

@@ -0,0 +1,9 @@
+# SwaggerClient::GetContractsResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pagination_response** | [**PaginationResponse**](PaginationResponse.md) | Contains information about the pagination used. | [optional] 
+**contracts** | [**Array<Contract>**](Contract.md) | Contains information about each contract. | [optional] 
+
+

data/docs/GetCrossRegionalClientAssociationsRequest.md

@@ -0,0 +1,11 @@
+# SwaggerClient::GetCrossRegionalClientAssociationsRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**client_id** | **String** | Looks up the cross regional associations by the client’s ID. Either `ClientId` or `Email` must be provided. If both are provided, the `ClientId` is used by default. | [optional] 
+**email** | **String** | Looks up the cross regional associations by the client’s email address. Either `ClientId` or `Email` must be provided. If both are provided, the `ClientId` is used by default. | [optional] 
+**limit** | **Integer** | Number of results to include, defaults to 100 | [optional] 
+**offset** | **Integer** | Page offset, defaults to 0. | [optional] 
+
+

data/docs/GetCrossRegionalClientAssociationsResponse.md

@@ -0,0 +1,9 @@
+# SwaggerClient::GetCrossRegionalClientAssociationsResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pagination_response** | [**PaginationResponse**](PaginationResponse.md) | Contains information about the pagination used. | [optional] 
+**cross_regional_client_associations** | [**Array<CrossRegionalClientAssociation>**](CrossRegionalClientAssociation.md) | Contains information about the client’s cross regional associations. | [optional] 
+
+

data/docs/GetCustomClientFieldsRequest.md

@@ -0,0 +1,9 @@
+# SwaggerClient::GetCustomClientFieldsRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**limit** | **Integer** | Number of results to include, defaults to 100 | [optional] 
+**offset** | **Integer** | Page offset, defaults to 0. | [optional] 
+
+

data/docs/GetCustomClientFieldsResponse.md

@@ -0,0 +1,9 @@
+# SwaggerClient::GetCustomClientFieldsResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pagination_response** | [**PaginationResponse**](PaginationResponse.md) | Contains information about the pagination used. | [optional] 
+**custom_client_fields** | [**Array<CustomClientField>**](CustomClientField.md) | Contains information about the available custom client fields. | [optional] 
+
+

data/docs/GetCustomPaymentMethodsRequest.md

@@ -0,0 +1,9 @@
+# SwaggerClient::GetCustomPaymentMethodsRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**limit** | **Integer** | Number of results to include, defaults to 100 | [optional] 
+**offset** | **Integer** | Page offset, defaults to 0. | [optional] 
+
+

data/docs/GetCustomPaymentMethodsResponse.md

@@ -0,0 +1,9 @@
+# SwaggerClient::GetCustomPaymentMethodsResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pagination_response** | [**PaginationResponse**](PaginationResponse.md) | Contains information about the pagination used. | [optional] 
+**payment_methods** | [**Array<CustomPaymentMethod>**](CustomPaymentMethod.md) | Contains information about the custom payment methods. | [optional] 
+
+

data/docs/GetEnrollmentsRequest.md

@@ -0,0 +1,16 @@
+# SwaggerClient::GetEnrollmentsRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**class_schedule_ids** | **Array<Integer>** | A list of the requested class schedule IDs. If omitted, all class schedule IDs return. | [optional] 
+**end_date** | **DateTime** | The end of the date range. The response returns any active enrollments that occur on or before this day.<br />  Default: **StartDate** | [optional] 
+**location_ids** | **Array<Integer>** | List of the IDs for the requested locations. If omitted, all location IDs return. | [optional] 
+**program_ids** | **Array<Integer>** | List of the IDs for the requested programs. If omitted, all program IDs return. | [optional] 
+**session_type_ids** | **Array<Integer>** | List of the IDs for the requested session types. If omitted, all session types IDs return. | [optional] 
+**staff_ids** | **Array<Integer>** | List of the IDs for the requested staff IDs. If omitted, all staff IDs return. | [optional] 
+**start_date** | **DateTime** | The start of the date range. The response returns any active enrollments that occur on or after this day.<br />  Default: **today’s date** | [optional] 
+**limit** | **Integer** | Number of results to include, defaults to 100 | [optional] 
+**offset** | **Integer** | Page offset, defaults to 0. | [optional] 
+
+

data/docs/GetEnrollmentsResponse.md

@@ -0,0 +1,9 @@
+# SwaggerClient::GetEnrollmentsResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pagination_response** | [**PaginationResponse**](PaginationResponse.md) | Contains information about the pagination used. | [optional] 
+**enrollments** | [**Array<ClassSchedule>**](ClassSchedule.md) | Contains information about the enrollments. | [optional] 
+
+

data/docs/GetGiftCardResponse.md

@@ -0,0 +1,9 @@
+# SwaggerClient::GetGiftCardResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pagination_response** | [**PaginationResponse**](PaginationResponse.md) | Contains information about the pagination used. | [optional] 
+**gift_cards** | [**Array<GiftCard>**](GiftCard.md) | Contains information about the gift cards. | [optional] 
+
+

data/docs/GetGiftCardsRequest.md

@@ -0,0 +1,12 @@
+# SwaggerClient::GetGiftCardsRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**location_id** | **Integer** | When included, returns gift cards that are sold at the provided location ID. | [optional] 
+**sold_online** | **BOOLEAN** | When `true`, only returns gift cards that are sold online.<br />  Default: **false** | [optional] 
+**ids** | **Array<Integer>** | Filters the results to the requested gift card IDs.<br />  Default: **all** gift cards. | [optional] 
+**limit** | **Integer** | Number of results to include, defaults to 100 | [optional] 
+**offset** | **Integer** | Page offset, defaults to 0. | [optional] 
+
+

data/docs/GetLocationsRequest.md

@@ -0,0 +1,9 @@
+# SwaggerClient::GetLocationsRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**limit** | **Integer** | Number of results to include, defaults to 100 | [optional] 
+**offset** | **Integer** | Page offset, defaults to 0. | [optional] 
+
+

data/docs/GetLocationsResponse.md

@@ -0,0 +1,9 @@
+# SwaggerClient::GetLocationsResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pagination_response** | [**PaginationResponse**](PaginationResponse.md) | Contains information about the pagination used. | [optional] 
+**locations** | [**Array<Location>**](Location.md) | Contains information about the locations. | [optional] 
+
+

data/docs/GetPackagesRequest.md

@@ -0,0 +1,11 @@
+# SwaggerClient::GetPackagesRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**package_ids** | **Array<Integer>** | A list of the packages IDs to filter by. | [optional] 
+**sell_online** | **BOOLEAN** | When `true`, only returns products that can be sold online.<br />  When `false`, all products are returned.<br />  Default: **false** | [optional] 
+**limit** | **Integer** | Number of results to include, defaults to 100 | [optional] 
+**offset** | **Integer** | Page offset, defaults to 0. | [optional] 
+
+

data/docs/GetPackagesResponse.md

@@ -0,0 +1,9 @@
+# SwaggerClient::GetPackagesResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**packages** | [**Array<Package>**](Package.md) | Contains information about the resulting packages. | [optional] 
+**pagination_response** | [**PaginationResponse**](PaginationResponse.md) | Contains information about the pagination used. | [optional] 
+
+

data/docs/GetProductsRequest.md

@@ -0,0 +1,15 @@
+# SwaggerClient::GetProductsRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**product_ids** | **Array<String>** | An ID filter for products. | [optional] 
+**search_text** | **String** | A search filter, used for searching by term. | [optional] 
+**category_ids** | **Array<Integer>** | A list of category IDs to filter by. | [optional] 
+**sub_category_ids** | **Array<Integer>** | A list of subcategory IDs to filter by. | [optional] 
+**sell_online** | **BOOLEAN** | When `true`, only products that can be sold online are returned.<br />  When `false`, all products are returned.<br />  Default: **false** | [optional] 
+**location_id** | **Integer** | The location ID to use to determine the tax for the products that this request returns.<br />  Default: **online store** | [optional] 
+**limit** | **Integer** | Number of results to include, defaults to 100 | [optional] 
+**offset** | **Integer** | Page offset, defaults to 0. | [optional] 
+
+

data/docs/GetProductsResponse.md

@@ -0,0 +1,9 @@
+# SwaggerClient::GetProductsResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pagination_response** | [**PaginationResponse**](PaginationResponse.md) | Contains information about the pagination used. | [optional] 
+**products** | [**Array<Product>**](Product.md) | Contains information about the products. | [optional] 
+
+

data/docs/GetProgramsRequest.md

@@ -0,0 +1,11 @@
+# SwaggerClient::GetProgramsRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**schedule_type** | **String** | A schedule type used to filter the returned results. | [optional] 
+**online_only** | **BOOLEAN** | If `true`, filters results to show only those programs that are shown online.<br />  If `false`, all programs are returned.<br />  Default: **false** | [optional] 
+**limit** | **Integer** | Number of results to include, defaults to 100 | [optional] 
+**offset** | **Integer** | Page offset, defaults to 0. | [optional] 
+
+

data/docs/GetProgramsResponse.md

@@ -0,0 +1,9 @@
+# SwaggerClient::GetProgramsResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pagination_response** | [**PaginationResponse**](PaginationResponse.md) | Contains information about the pagination used. | [optional] 
+**programs** | [**Array<Program>**](Program.md) | Contains information about the programs. | [optional] 
+
+

data/docs/GetRequiredClientFieldsResponse.md

@@ -0,0 +1,8 @@
+# SwaggerClient::GetRequiredClientFieldsResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**required_client_fields** | **Array<String>** | A list of strings that maps to the client fields that are required by the site. | [optional] 
+
+

data/docs/GetResourcesRequest.md

@@ -0,0 +1,13 @@
+# SwaggerClient::GetResourcesRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**session_type_ids** | **Array<Integer>** | List of session type IDs.<br />  Default: **all** | [optional] 
+**location_id** | **Integer** | The location of the resource. This parameter is ignored if `EndDateTime` or `LocationID` is not set.<br />  Default: **all** | [optional] 
+**start_date_time** | **DateTime** | The time the resource starts. This parameter is ignored if `EndDateTime` or `LocationID` is not set. | [optional] 
+**end_date_time** | **DateTime** | The time the resource ends. This parameter is ignored if `EndDateTime` or `LocationID` is not set. | [optional] 
+**limit** | **Integer** | Number of results to include, defaults to 100 | [optional] 
+**offset** | **Integer** | Page offset, defaults to 0. | [optional] 
+
+

data/docs/GetResourcesResponse.md

@@ -0,0 +1,9 @@
+# SwaggerClient::GetResourcesResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pagination_response** | [**PaginationResponse**](PaginationResponse.md) | Contains information about the pagination used. | [optional] 
+**resources** | [**Array<Resource>**](Resource.md) | Contains information about resources as the business. | [optional] 
+
+

data/docs/GetSalesRequest.md

@@ -0,0 +1,7 @@
+# SwaggerClient::GetSalesRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/GetSalesResponse.md

@@ -0,0 +1,9 @@
+# SwaggerClient::GetSalesResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pagination_response** | [**PaginationResponse**](PaginationResponse.md) | Contains information about the pagination used. | [optional] 
+**sales** | [**Array<Sale>**](Sale.md) | Contains the Sale objects, each of which describes the sale and payment for a purchase event. | [optional] 
+
+

data/docs/GetScheduleItemsRequest.md

@@ -0,0 +1,14 @@
+# SwaggerClient::GetScheduleItemsRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**location_ids** | **Array<Integer>** | A list of requested location IDs. | [optional] 
+**staff_ids** | **Array<Integer>** | A list of requested staff IDs. | [optional] 
+**start_date** | **DateTime** | The start date of the requested date range.   <br />Default: **today’s date** | [optional] 
+**end_date** | **DateTime** | The end date of the requested date range.   <br />Default: **today’s date** | [optional] 
+**ignore_prep_finish_times** | **BOOLEAN** | When `true`, appointment preparation and finish unavailabilities are not returned.   <br />Default: **false** | [optional] 
+**limit** | **Integer** | Number of results to include, defaults to 100 | [optional] 
+**offset** | **Integer** | Page offset, defaults to 0. | [optional] 
+
+

data/docs/GetScheduleItemsResponse.md

@@ -0,0 +1,9 @@
+# SwaggerClient::GetScheduleItemsResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pagination_response** | [**PaginationResponse**](PaginationResponse.md) | Contains information about the pagination used. | [optional] 
+**staff_members** | [**Array<Staff>**](Staff.md) | Contains information about staff members with schedule items. | [optional] 
+
+

data/docs/GetServicesRequest.md

@@ -0,0 +1,18 @@
+# SwaggerClient::GetServicesRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**program_ids** | **Array<Integer>** | Filters to pricing options with the specified program IDs. | [optional] 
+**session_type_ids** | **Array<Integer>** | Filters to the pricing options with the specified session types IDs. | [optional] 
+**service_ids** | **Array<String>** | Filters to the pricing options with the specified IDs. In this context, service and pricing option are used interchangeably. | [optional] 
+**class_id** | **Integer** | Filters to the pricing options for the specified class ID. | [optional] 
+**class_schedule_id** | **Integer** | Filters to the pricing options for the specified class schedule ID. | [optional] 
+**sell_online** | **BOOLEAN** | When `true`, filters to the pricing options that can be sold online.<br />  Default: **false** | [optional] 
+**location_id** | **Integer** | When specified, for each returned pricing option, `TaxRate` and `TaxIncluded` are calculated according to the specified location. Note that this does not filter results to only services provided at the given location, and for locations where Value-Added Tax (VAT) rules apply, the `TaxRate` is set to zero. | [optional] 
+**hide_related_programs** | **BOOLEAN** | When `true`, indicates that pricing options of related programs are omitted from the response.<br />  Default: **false** | [optional] 
+**staff_id** | **Integer** | Sets `Price` and `OnlinePrice` to the particular pricing of a specific staff member, if allowed by the business. | [optional] 
+**limit** | **Integer** | Number of results to include, defaults to 100 | [optional] 
+**offset** | **Integer** | Page offset, defaults to 0. | [optional] 
+
+

data/docs/GetServicesResponse.md

@@ -0,0 +1,9 @@
+# SwaggerClient::GetServicesResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pagination_response** | [**PaginationResponse**](PaginationResponse.md) | Contains information about the pagination used. | [optional] 
+**services** | [**Array<Service>**](Service.md) | Contains information about the services. | [optional] 
+
+

data/docs/GetSessionTypesRequest.md

@@ -0,0 +1,11 @@
+# SwaggerClient::GetSessionTypesRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**program_i_ds** | **Array<Integer>** | Filters results to session types that belong to one of the given program IDs. If omitted, all program IDs return. | [optional] 
+**online_only** | **BOOLEAN** | When `true`, indicates that only the session types that can be booked online should be returned.<br />  Default: **false** | [optional] 
+**limit** | **Integer** | Number of results to include, defaults to 100 | [optional] 
+**offset** | **Integer** | Page offset, defaults to 0. | [optional] 
+
+