mindbody-api-v6 1.0.0

data/docs/FormulaNote.md

@@ -0,0 +1,12 @@
+# SwaggerClient::FormulaNote
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | ID of the formula note. | [optional] 
+**client_id** | **String** | Client ID of the formula note. | [optional] 
+**note** | **String** | The text of the formula note. | [optional] 
+**entry_date_time** | **DateTime** | Date and time that the formula note was entered. | [optional] 
+**appointment_id** | **Integer** | The appointment ID associated with the formula note. | [optional] 
+
+

data/docs/GetActivationCodeResponse.md

@@ -0,0 +1,9 @@
+# SwaggerClient::GetActivationCodeResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**activation_code** | **String** | An activation code used to provide access to a site’s business data through MINDBODY. | [optional] 
+**activation_link** | **String** | A link to the Manage Credentials screen. | [optional] 
+
+

data/docs/GetActiveClientMembershipsRequest.md

@@ -0,0 +1,11 @@
+# SwaggerClient::GetActiveClientMembershipsRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**client_id** | **String** | The ID of the client whose membership was requested. | 
+**location_id** | **Integer** | The ID of the location where the requested membership was created. | [optional] 
+**limit** | **Integer** | Number of results to include, defaults to 100 | [optional] 
+**offset** | **Integer** | Page offset, defaults to 0. | [optional] 
+
+

data/docs/GetActiveClientMembershipsResponse.md

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

data/docs/GetActiveSessionTimesRequest.md

@@ -0,0 +1,13 @@
+# SwaggerClient::GetActiveSessionTimesRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**schedule_type** | **String** | Filters on the provided the schedule type. Either `SessionTypeIds` or `ScheduleType` must be provided. | [optional] 
+**session_type_ids** | **Array<Integer>** | Filters on the provided session type IDs. Either `SessionTypeIds` or `ScheduleType` must be provided. | [optional] 
+**start_time** | **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** | [optional] 
+**end_time** | **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** | [optional] 
+**limit** | **Integer** | Number of results to include, defaults to 100 | [optional] 
+**offset** | **Integer** | Page offset, defaults to 0. | [optional] 
+
+

data/docs/GetActiveSessionTimesResponse.md

@@ -0,0 +1,9 @@
+# SwaggerClient::GetActiveSessionTimesResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pagination_response** | [**PaginationResponse**](PaginationResponse.md) | Contains information about the pagination used. | [optional] 
+**active_session_times** | **Array<String>** | List of available start times for active sessions. Note the following:  * The times returned represent possibilities for scheduling a session, not necessarily currently scheduled sessions.  * The response includes either all schedule types or those filtered by supplying `ScheduleType` or `SessionTypeIds`.  * Each session has an associated schedule type, but when you supply `SessionTypeIds`, they may map to one or more of the schedule types. | [optional] 
+
+

data/docs/GetAppointmentOptionsResponse.md

@@ -0,0 +1,8 @@
+# SwaggerClient::GetAppointmentOptionsResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**options** | [**Array<AppointmentOption>**](AppointmentOption.md) | Contains information about the appointment options. | [optional] 
+
+

data/docs/GetBookableItemsRequest.md

@@ -0,0 +1,16 @@
+# SwaggerClient::GetBookableItemsRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**session_type_ids** | **Array<Integer>** | A list of the requested session type IDs. | 
+**location_ids** | **Array<Integer>** | A list of the requested location IDs. | [optional] 
+**staff_ids** | **Array<Integer>** | A list of the 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: **StartDate** | [optional] 
+**appointment_id** | **Integer** | If provided, filters out the appointment with this ID. | [optional] 
+**ignore_default_session_length** | **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. | [optional] 
+**limit** | **Integer** | Number of results to include, defaults to 100 | [optional] 
+**offset** | **Integer** | Page offset, defaults to 0. | [optional] 
+
+

data/docs/GetBookableItemsResponse.md

@@ -0,0 +1,9 @@
+# SwaggerClient::GetBookableItemsResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pagination_response** | [**PaginationResponse**](PaginationResponse.md) | Contains information about the pagination used. | [optional] 
+**availabilities** | [**Array<Availability>**](Availability.md) | Contains information about the availabilities for appointment booking. | [optional] 
+
+

data/docs/GetClassDescriptionsRequest.md

@@ -0,0 +1,15 @@
+# SwaggerClient::GetClassDescriptionsRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**class_description_id** | **Integer** | Filters to the single result with the given ID. | [optional] 
+**program_ids** | **Array<Integer>** | Filters results to class descriptions belonging to the given programs. | [optional] 
+**start_class_date_time** | **DateTime** | Filters the results to class descriptions for scheduled classes that happen on or after the given date and time. | [optional] 
+**end_class_date_time** | **DateTime** | Filters the results to class descriptions for scheduled classes that happen before the given date and time. | [optional] 
+**staff_id** | **Integer** | Filters results to class descriptions for scheduled classes taught by the given staff member. | [optional] 
+**location_id** | **Integer** | Filters results to classes descriptions for schedule classes as the given location. | [optional] 
+**limit** | **Integer** | Number of results to include, defaults to 100 | [optional] 
+**offset** | **Integer** | Page offset, defaults to 0. | [optional] 
+
+

data/docs/GetClassDescriptionsResponse.md

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

data/docs/GetClassPayrollRequest.md

@@ -0,0 +1,13 @@
+# SwaggerClient::GetClassPayrollRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**staff_id** | **Integer** | A list of staff IDs that you want to retrieve payroll information for. If you do not supply a `StaffId`, all active staff members return, ordered by staff ID. | [optional] 
+**start_date_time** | **DateTime** | The beginning of the date range for the payroll information to be returned. The maximum allowed date range is 14 days.  * If you do not supply a `StartDateTime`, data returns for the seven days prior to the `EndDateTime` that you supply.  * If you do not supply either a `StartDateTime` or an `EndDateTime`, the data returns for seven days prior to today’s date. | [optional] 
+**end_date_time** | **DateTime** | The end of the date range for the payroll information to be returned. The maximum allowed date range is 14 days.<br />  Default: **Today’s date**  * If you do not supply an `EndDateTime`, the data returns for the period from the `StartDateTime` that you supply to today’s date.  * If you do not supply an `EndDateTime` or a `StartDateTime`, data returns for the seven days prior to today’s date. | [optional] 
+**include_inactive_staff** | **BOOLEAN** | When `true`, payroll information returns for both active and inactive staff members.<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/GetClassPayrollResponse.md

@@ -0,0 +1,9 @@
+# SwaggerClient::GetClassPayrollResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pagination_response** | [**PaginationResponse**](PaginationResponse.md) | Contains information about the pagination used. | [optional] 
+**class_payroll** | [**Array<ClassPayrollEvent>**](ClassPayrollEvent.md) | Contains the class payroll events. | [optional] 
+
+

data/docs/GetClassSchedulesRequest.md

@@ -0,0 +1,16 @@
+# SwaggerClient::GetClassSchedulesRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**class_schedule_ids** | **Array<Integer>** | The class schedule IDs.  <br />Default: **all** | [optional] 
+**end_date** | **DateTime** | The end date of the range. Return any active enrollments that occur on or before this day.  <br />Default: **StartDate** | [optional] 
+**location_ids** | **Array<Integer>** | The location IDs.   <br />Default: **all** | [optional] 
+**program_ids** | **Array<Integer>** | The program IDs.   <br />Default: **all** | [optional] 
+**session_type_ids** | **Array<Integer>** | The session type IDs.   <br />Default: **all** | [optional] 
+**staff_ids** | **Array<Integer>** | The staff IDs.   <br />Default: **all** | [optional] 
+**start_date** | **DateTime** | The start date of the range. Return 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/GetClassSchedulesResponse.md

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

data/docs/GetClassVisitsRequest.md

@@ -0,0 +1,9 @@
+# SwaggerClient::GetClassVisitsRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**class_id** | **Integer** | The class ID. | [optional] 
+**last_modified_date** | **DateTime** | When included in the request, only records modified on or after the `LastModifiedDate` specified are included in the response. | [optional] 
+
+

data/docs/GetClassVisitsResponse.md

@@ -0,0 +1,8 @@
+# SwaggerClient::GetClassVisitsResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_class** | [**ModelClass**](ModelClass.md) | Contains class and booking information. | [optional] 
+
+

data/docs/GetClassesRequest.md

@@ -0,0 +1,22 @@
+# SwaggerClient::GetClassesRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**class_description_ids** | **Array<Integer>** | The requested class description IDs. | [optional] 
+**class_ids** | **Array<Integer>** | The requested class IDs. | [optional] 
+**staff_ids** | **Array<Integer>** | The requested IDs of the teaching staff members. | [optional] 
+**start_date_time** | **DateTime** | The requested start date for filtering.   <br />Default: **today’s date** | [optional] 
+**end_date_time** | **DateTime** | The requested end date for filtering.  <br />Default: **today’s date** | [optional] 
+**client_id** | **String** | The client ID of the client who is viewing this class list. Based on identity, the client may be able to see additional information, such as membership specials. | [optional] 
+**program_ids** | **Array<Integer>** | A list of program IDs on which to base the search. | [optional] 
+**session_type_ids** | **Array<Integer>** | A list of session type IDs on which to base the search. | [optional] 
+**location_ids** | **Array<Integer>** | A list of location IDs on which to base the search. | [optional] 
+**semester_ids** | **Array<Integer>** | A list of semester IDs on which to base the search. | [optional] 
+**hide_canceled_classes** | **BOOLEAN** | When `true`, canceled classes are removed from the response.<br />  When `false`, canceled classes are included in the response.<br />  Default: **false** | [optional] 
+**scheduling_window** | **BOOLEAN** | When `true`, classes outside scheduling window are removed from the response.<br />  When `false`, classes are included in the response, regardless of the scheduling window.<br />  Default: **false** | [optional] 
+**last_modified_date** | **DateTime** | When included in the request, only records modified on or after the `LastModifiedDate` specified are included in the response. | [optional] 
+**limit** | **Integer** | Number of results to include, defaults to 100 | [optional] 
+**offset** | **Integer** | Page offset, defaults to 0. | [optional] 
+
+

data/docs/GetClassesResponse.md

@@ -0,0 +1,9 @@
+# SwaggerClient::GetClassesResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pagination_response** | [**PaginationResponse**](PaginationResponse.md) | Contains information about the pagination used. | [optional] 
+**classes** | [**Array<ModelClass>**](ModelClass.md) | A list of the requested classes. | [optional] 
+
+

data/docs/GetClientAccountBalancesRequest.md

@@ -0,0 +1,12 @@
+# SwaggerClient::GetClientAccountBalancesRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**balance_date** | **DateTime** | The date you want a balance relative to.   Default: **the current date** | [optional] 
+**class_id** | **Integer** | The class ID of the event for which you want a balance. | [optional] 
+**client_ids** | **Array<String>** | The list of clients IDs for which you want account balances. | 
+**limit** | **Integer** | Number of results to include, defaults to 100 | [optional] 
+**offset** | **Integer** | Page offset, defaults to 0. | [optional] 
+
+

data/docs/GetClientAccountBalancesResponse.md

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

data/docs/GetClientContractsRequest.md

@@ -0,0 +1,12 @@
+# SwaggerClient::GetClientContractsRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**client_id** | **String** | The ID of the client. | 
+**cross_regional_lookup** | **BOOLEAN** | When `true`, indicates that the requesting client’s cross regional contracts are returned, if any.<br />  When `false`, indicates that cross regional contracts are not returned. | [optional] 
+**client_associated_sites_offset** | **Integer** | Determines how many sites are skipped over when retrieving a client’s cross regional contracts. Used when a client ID is linked to more than ten sites in an organization. Only a maximum of ten site databases are queried when this call is made and `CrossRegionalLookup` is set to `true`. To change which sites are queried, change this offset value.  Default: **0** | [optional] 
+**limit** | **Integer** | Number of results to include, defaults to 100 | [optional] 
+**offset** | **Integer** | Page offset, defaults to 0. | [optional] 
+
+

data/docs/GetClientContractsResponse.md

@@ -0,0 +1,9 @@
+# SwaggerClient::GetClientContractsResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**contracts** | [**Array<ClientContract>**](ClientContract.md) | Contains the details of the client’s contract. | [optional] 
+**pagination_response** | [**PaginationResponse**](PaginationResponse.md) | Contains information about the pagination used. | [optional] 
+
+

data/docs/GetClientFormulaNotesRequest.md

@@ -0,0 +1,11 @@
+# SwaggerClient::GetClientFormulaNotesRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**client_id** | **String** | The client ID of the client whose formula notes are being requested. | [optional] 
+**appointment_id** | **Integer** | The appointment ID of the appointment that the formula notes are related to. | [optional] 
+**limit** | **Integer** | Number of results to include, defaults to 100 | [optional] 
+**offset** | **Integer** | Page offset, defaults to 0. | [optional] 
+
+

data/docs/GetClientFormulaNotesResponse.md

@@ -0,0 +1,9 @@
+# SwaggerClient::GetClientFormulaNotesResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pagination_response** | [**PaginationResponse**](PaginationResponse.md) | Contains information about the pagination used. | [optional] 
+**formula_notes** | [**Array<FormulaNote>**](FormulaNote.md) | Contains details about the client’s formula. | [optional] 
+
+

data/docs/GetClientIndexesRequest.md

@@ -0,0 +1,8 @@
+# SwaggerClient::GetClientIndexesRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**required_only** | **BOOLEAN** | When `true`, filters the results to only indexes that are required on creation.<br />  When `false` or omitted, returns all of the client indexes. | [optional] 
+
+

data/docs/GetClientIndexesResponse.md

@@ -0,0 +1,8 @@
+# SwaggerClient::GetClientIndexesResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**client_indexes** | [**Array<ClientIndex>**](ClientIndex.md) | Contains information about the client indexes. | [optional] 
+
+

data/docs/GetClientPurchasesRequest.md

@@ -0,0 +1,13 @@
+# SwaggerClient::GetClientPurchasesRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**client_id** | **String** | The ID of the client you are querying for purchases. | 
+**start_date** | **DateTime** | Filters results to purchases made on or after this timestamp.<br />  Default: **now** | [optional] 
+**end_date** | **DateTime** | Filters results to purchases made before this timestamp.<br />  Default: **end of today** | [optional] 
+**sale_id** | **Integer** | Filters results to the single record associated with this ID. | [optional] 
+**limit** | **Integer** | Number of results to include, defaults to 100 | [optional] 
+**offset** | **Integer** | Page offset, defaults to 0. | [optional] 
+
+

data/docs/GetClientPurchasesResponse.md

@@ -0,0 +1,9 @@
+# SwaggerClient::GetClientPurchasesResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pagination_response** | [**PaginationResponse**](PaginationResponse.md) | Contains information about the pagination used. | [optional] 
+**purchases** | [**Array<ClientPurchaseRecord>**](ClientPurchaseRecord.md) | Contains information that describes the item sold and the payment. | [optional] 
+
+

data/docs/GetClientReferralTypesRequest.md

@@ -0,0 +1,8 @@
+# SwaggerClient::GetClientReferralTypesRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**include_inactive** | **BOOLEAN** | When `true`, filters the results to include subtypes and inactive referral types.<br />  When `false`, includes no subtypes and only active types. | [optional] 
+
+

data/docs/GetClientReferralTypesResponse.md

@@ -0,0 +1,8 @@
+# SwaggerClient::GetClientReferralTypesResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**referral_types** | **Array<String>** | The list of available referral types. | [optional] 
+
+

data/docs/GetClientServicesRequest.md

@@ -0,0 +1,20 @@
+# SwaggerClient::GetClientServicesRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**client_id** | **String** | The ID of the client to query. The results are a list of pricing options that the client has purchased. Note that “service” and “pricing option” are synonymous in this section of the documentation. | 
+**class_id** | **Integer** | Filters results to only those pricing options that can be used to pay for this class. | [optional] 
+**program_ids** | **Array<Integer>** | Filters results to pricing options that belong to one of the given program IDs. | [optional] 
+**session_type_id** | **Integer** | Filters results to pricing options that will pay for the given session type ID. Use this to find pricing options that will pay for a specific appointment type. | [optional] 
+**location_ids** | **Array<Integer>** | Filters results to pricing options that can be used at the listed location IDs. | [optional] 
+**visit_count** | **Integer** | A filter on the minimum number of visits a service can pay for. | [optional] 
+**start_date** | **DateTime** | Filters results to pricing options that are valid on or after this date. | [optional] 
+**end_date** | **DateTime** | Filters results to pricing options that are valid on or before this date. | [optional] 
+**show_active_only** | **BOOLEAN** | When `true`, includes active services only.  Default: **false** | [optional] 
+**cross_regional_lookup** | **BOOLEAN** | Used to retrieve a client’s pricing options from multiple sites within an organization. When included and set to `true`, it searches a maximum of ten sites with which this client is associated. When a client is associated with more than ten sites, use `ClientAssociatedSitesOffset` as many times as needed to search the additional sites with which the client is associated. You can use the `CrossRegionalClientAssociations` value from `GET CrossRegionalClientAssociations` to determine how many sites the client is associated with. Note that a `SiteID` is returned and populated in the `ClientServices` response when `CrossRegionalLookup` is set to `true`.  Default: **false** | [optional] 
+**client_associated_sites_offset** | **Integer** | Used to retrieve a client’s pricing options from multiple sites within an organization when the client is associated with more than ten sites. To change which ten sites are searched, change this offset value. A value of 0 means that no sites are skipped and the first ten sites are returned. You can use the `CrossRegionalClientAssociations` value from `GET CrossRegionalClientAssociations` to determine how many sites the client is associated with. Note that you must always have `CrossRegionalLookup` set to `true` to use this parameter.<br />  Default: **0**    For example, if a client is associated with 25 sites, you need to call `GetClientServices` three times, as follows:  * Use `GET CrossRegionalClientAssociations` to determine how many sites a client is associated with, which tells you how many additional calls you need to make.  * Either omit `ClientAssociatedSitesOffset` or set it to 0 to return the client’s services (pricing options) from sites 1-10.  * Set `ClientAssociatedSitesOffset` to 10 to return the client pricing options from sites 11-20  * Set `ClientAssociatedSitesOffset` to 20 to return the client pricing options from sites 21-25 | [optional] 
+**limit** | **Integer** | Number of results to include, defaults to 100 | [optional] 
+**offset** | **Integer** | Page offset, defaults to 0. | [optional] 
+
+

data/docs/GetClientServicesResponse.md

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

data/docs/GetClientVisitsRequest.md

@@ -0,0 +1,15 @@
+# SwaggerClient::GetClientVisitsRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**client_id** | **String** | The ID of the requested client. | 
+**client_associated_sites_offset** | **Integer** | The number of sites to skip when returning the site associated with a client. | [optional] 
+**cross_regional_lookup** | **BOOLEAN** | When `true`, indicates that past and scheduled client visits across all sites in the region are returned.<br />  When `false`, indicates that only visits at the current site are returned. | [optional] 
+**end_date** | **DateTime** | The date past which class visits are not returned.  Default: **today’s date** | [optional] 
+**start_date** | **DateTime** | The date before which class visits are not returned.  Default: **the end date** | [optional] 
+**unpaids_only** | **BOOLEAN** | When `true`, indicates that only visits that have not been paid for are returned.<br />  When `false`, indicates that all visits are returned, regardless of whether they have been paid for.<br />  Default: **false** | [optional] 
+**limit** | **Integer** | Number of results to include, defaults to 100 | [optional] 
+**offset** | **Integer** | Page offset, defaults to 0. | [optional] 
+
+