mindbody-api-v6 1.0.0

data/docs/GetSessionTypesResponse.md

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

data/docs/GetSitesRequest.md

@@ -0,0 +1,10 @@
+# SwaggerClient::GetSitesRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**site_ids** | **Array<Integer>** | List of the requested site IDs. When omitted, returns all sites that the source has access to. | [optional] 
+**limit** | **Integer** | Number of results to include, defaults to 100 | [optional] 
+**offset** | **Integer** | Page offset, defaults to 0. | [optional] 
+
+

data/docs/GetSitesResponse.md

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

data/docs/GetStaffAppointmentsRequest.md

@@ -0,0 +1,15 @@
+# SwaggerClient::GetStaffAppointmentsRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**appointment_ids** | **Array<Integer>** | A list of the requested appointment IDs. | [optional] 
+**location_ids** | **Array<Integer>** | A list of the requested location IDs. | [optional] 
+**start_date** | **DateTime** | The start date of the requested date range. If omitted, the default is used.   <br />Default: **today’s date** | [optional] 
+**end_date** | **DateTime** | The end date of the requested date range.   <br />Default: **StartDate** | [optional] 
+**staff_ids** | **Array<Integer>** | List of staff IDs to be returned. Use a value of zero to return all staff appointments. | [optional] 
+**client_ids** | **Array<String>** | List of client IDs to be returned. | [optional] 
+**limit** | **Integer** | Number of results to include, defaults to 100 | [optional] 
+**offset** | **Integer** | Page offset, defaults to 0. | [optional] 
+
+

data/docs/GetStaffAppointmentsResponse.md

@@ -0,0 +1,9 @@
+# SwaggerClient::GetStaffAppointmentsResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pagination_response** | [**PaginationResponse**](PaginationResponse.md) | Contains information about the pagination used. , | [optional] 
+**appointments** | [**Array<Appointment>**](Appointment.md) | Contains information about appointments and their details. | [optional] 
+
+

data/docs/GetStaffPermissionsRequest.md

@@ -0,0 +1,8 @@
+# SwaggerClient::GetStaffPermissionsRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**staff_id** | **Integer** | The ID of the staff member whose permissions you want to return. | 
+
+

data/docs/GetStaffPermissionsResponse.md

@@ -0,0 +1,8 @@
+# SwaggerClient::GetStaffPermissionsResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**user_group** | [**StaffPermissionGroup**](StaffPermissionGroup.md) | Contains information about the requested staff member’s permission group. | [optional] 
+
+

data/docs/GetStaffRequest.md

@@ -0,0 +1,14 @@
+# SwaggerClient::GetStaffRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**staff_ids** | **Array<Integer>** | A list of the requested staff IDs. | [optional] 
+**filters** | **Array<String>** | Filters to apply to the search. Possible values are:  * StaffViewable  * AppointmentInstructor  * ClassInstructor  * Male  * Female | [optional] 
+**session_type_id** | **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. | [optional] 
+**start_date_time** | **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. | [optional] 
+**location_id** | **Integer** | Return only staff members that are available at the specified location. You must supply a valid `SessionTypeID` and `StartDateTime` to use this parameter. | [optional] 
+**limit** | **Integer** | Number of results to include, defaults to 100 | [optional] 
+**offset** | **Integer** | Page offset, defaults to 0. | [optional] 
+
+

data/docs/GetStaffResponse.md

@@ -0,0 +1,9 @@
+# SwaggerClient::GetStaffResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pagination_response** | [**PaginationResponse**](PaginationResponse.md) |  | [optional] 
+**staff_members** | [**Array<Staff>**](Staff.md) | A list of staff members. | [optional] 
+
+

data/docs/GetTimeClockRequest.md

@@ -0,0 +1,13 @@
+# SwaggerClient::GetTimeClockRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**staff_id** | **Integer** | The staff ID for whom you want to retrieve time card information. 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 time card information to be returned. If you do not supply a `StartDateTime`, data returns for the seven days prior to the `EndDateTime` that you supply. The maximum allowed date range is 14 days. | [optional] 
+**end_date_time** | **DateTime** | The end of the date range for the time card information to be returned. If you do not supply an `EndDateTime`, data returns for the seven days prior to today’s date. Classes that begin before the `EndDateTime` are included in the response, regardless of the time that the class ends. The maximum allowed date range is 14 days.<br />  Default: **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/GetTimeClockResponse.md

@@ -0,0 +1,9 @@
+# SwaggerClient::GetTimeClockResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pagination_response** | [**PaginationResponse**](PaginationResponse.md) | Contains information about the pagintation used. | [optional] 
+**time_clock_reports** | [**Array<TimeClockReport>**](TimeClockReport.md) | Information about each specified staff member, organized by task. | [optional] 
+
+

data/docs/GetWaitlistEntriesRequest.md

@@ -0,0 +1,14 @@
+# SwaggerClient::GetWaitlistEntriesRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**class_ids** | **Array<Integer>** | The requested class IDs. If a class ID is present, the request automatically disregards any class schedule IDs in the request. <br />  Either `ClassScheduleIds`, `ClientIds`, `WaitlistEntryIds`, or `ClassIds` is required; the others become optional.<br />  Default: **all ClassIds** | [optional] 
+**class_schedule_ids** | **Array<Integer>** | The requested class schedule IDs. If a class ID is present, the request automatically disregards any class schedule IDs in the request.<br />  Either `ClassScheduleIds`, `ClientIds`, `WaitlistEntryIds`, or `ClassIds` is required; the others become optional.<br />  Default: **all ClassScheduleIds** | [optional] 
+**client_ids** | **Array<String>** | The requested client IDs.<br />  Either `ClassScheduleIds`, `ClientIds`, `WaitlistEntryIds`, or `ClassIds` is required; the others become optional.<br />  Default: **all ClientIds** | [optional] 
+**hide_past_entries** | **BOOLEAN** | When `true`, indicates that past waiting list entries are hidden from clients.<br />  When `false`, indicates that past entries are not hidden from clients.<br />  Default: **false** | [optional] 
+**waitlist_entry_ids** | **Array<Integer>** | The requested waiting list entry IDs.<br />  Either `ClassScheduleIds`, `ClientIds`, `WaitlistEntryIds`, or `ClassIds` is required; the others become optional.<br />  Default: **all WaitlistEntryIds** | [optional] 
+**limit** | **Integer** | Number of results to include, defaults to 100 | [optional] 
+**offset** | **Integer** | Page offset, defaults to 0. | [optional] 
+
+

data/docs/GetWaitlistEntriesResponse.md

@@ -0,0 +1,9 @@
+# SwaggerClient::GetWaitlistEntriesResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pagination_response** | [**PaginationResponse**](PaginationResponse.md) | Contains information about the pagination used. | [optional] 
+**waitlist_entries** | [**Array<WaitlistEntry>**](WaitlistEntry.md) | Contains information about the waiting list entries. | [optional] 
+
+

data/docs/GiftCard.md

@@ -0,0 +1,19 @@
+# SwaggerClient::GiftCard
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | The gift card's `ProductID`. | [optional] 
+**location_ids** | **Array<Integer>** | The IDs of the locations where the gift card is sold. | [optional] 
+**description** | **String** | A description of the gift card. | [optional] 
+**editable_by_consumer** | **BOOLEAN** | When `true`, indicates that the gift card can be edited by the client. | [optional] 
+**card_value** | **Float** | The value of the gift card. | [optional] 
+**sale_price** | **Float** | The sale price of the gift card, if applicable. | [optional] 
+**sold_online** | **BOOLEAN** | When `true`, indicates that the gift card is sold online. | [optional] 
+**membership_restriction_ids** | **Array<Integer>** | A list of IDs for membership restrictions, if this card is restricted to members with certain types of memberships. | [optional] 
+**gift_card_terms** | **String** | The terms of the gift card. | [optional] 
+**contact_info** | **String** | Contact information for the gift card. | [optional] 
+**display_logo** | **BOOLEAN** | When `true`, indicates that the logo should be displayed on the gift card. | [optional] 
+**layouts** | [**Array<GiftCardLayout>**](GiftCardLayout.md) | A list of layouts available for the gift card. | [optional] 
+
+

data/docs/GiftCardLayout.md

@@ -0,0 +1,9 @@
+# SwaggerClient::GiftCardLayout
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**layout_id** | **Integer** | The ID of the layout. | [optional] 
+**layout_name** | **String** | The name of the layout. | [optional] 
+
+

data/docs/IssueRequest.md

@@ -0,0 +1,9 @@
+# SwaggerClient::IssueRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**username** | **String** | The staff member’s username. | [optional] 
+**password** | **String** | The staff member’s password. | [optional] 
+
+

data/docs/IssueResponse.md

@@ -0,0 +1,10 @@
+# SwaggerClient::IssueResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**token_type** | **String** |  | [optional] 
+**access_token** | **String** | The authentication token value. | [optional] 
+**user** | [**User**](User.md) | Contains information about the user represented by the access token. | [optional] 
+
+

data/docs/Level.md

@@ -0,0 +1,10 @@
+# SwaggerClient::Level
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | The level's ID. | [optional] 
+**name** | **String** | The level's name. | [optional] 
+**description** | **String** | The level's description. | [optional] 
+
+

data/docs/Liability.md

@@ -0,0 +1,10 @@
+# SwaggerClient::Liability
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**agreement_date** | **DateTime** | The date and time at which the client agreed to the liability waiver for the business. | [optional] 
+**is_released** | **BOOLEAN** | The client’s liability release status.<br />  When `true`, indicates that the client has agreed to the liability release for the business.<br />  When `false`, indicates that the client has not agreed to the liability release for the business. | [optional] 
+**released_by** | **Integer** | An ID indicating who released liability for the client. If the client agreed to the liability waiver by signing into an account online, this value is `null`. If a staff member marked the waiver as signed on behalf of the client, it is the staff member’s ID. `0` indicates that the business owner marked the liability waiver as signed on behalf of the client. | [optional] 
+
+

data/docs/Location.md

@@ -0,0 +1,32 @@
+# SwaggerClient::Location
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**additional_image_ur_ls** | **Array<String>** | A list of URLs of any images associated with this location. | [optional] 
+**address** | **String** | The first line of the location’s street address. | [optional] 
+**address2** | **String** | A second address line for the location’s street address, if needed. | [optional] 
+**amenities** | [**Array<Amenity>**](Amenity.md) | A list of strings representing amenities available at the location. | [optional] 
+**business_description** | **String** | The business description for the location, as configured by the business owner. | [optional] 
+**city** | **String** | The location’s city. | [optional] 
+**description** | **String** | A description of the location. | [optional] 
+**has_classes** | **BOOLEAN** | When `true`, indicates that classes are held at this location.<br />  When `false`, Indicates that classes are not held at this location. | [optional] 
+**id** | **Integer** | The ID assigned to this location. | [optional] 
+**latitude** | **Float** | The location’s latitude. | [optional] 
+**longitude** | **Float** | The location’s longitude. | [optional] 
+**name** | **String** | The name of this location. | [optional] 
+**phone** | **String** | The location’s phone number. | [optional] 
+**phone_extension** | **String** | The location’s phone extension. | [optional] 
+**postal_code** | **String** | The location’s postal code. | [optional] 
+**site_id** | **Integer** | The ID number assigned to this location. | [optional] 
+**state_prov_code** | **String** | The location’s state or province code. | [optional] 
+**tax1** | **Float** | A decimal representation of the location’s first tax rate. Tax properties are provided to apply all taxes to the purchase price that the purchase is subject to. Use as many tax properties as needed to represent all the taxes that apply in the location. Enter a decimal number that represents the appropriate tax rate. For example, for an 8% sales tax, enter 0.08. | [optional] 
+**tax2** | **Float** | A decimal representation of the location’s second tax rate. See the example in the description of Tax1. | [optional] 
+**tax3** | **Float** | A decimal representation of the location’s third tax rate. See the example in the description of Tax1. | [optional] 
+**tax4** | **Float** | A decimal representation of the location’s fourth tax rate. See the example in the description of Tax1. | [optional] 
+**tax5** | **Float** | A decimal representation of the location’s fifth tax rate. See the example in the description of Tax1. | [optional] 
+**total_number_of_ratings** | **Integer** | The number of reviews that clients have left for this location. | [optional] 
+**average_rating** | **Float** | The average rating for the location, out of five stars. | [optional] 
+**total_number_of_deals** | **Integer** | The number of distinct introductory pricing options available for purchase at this location. | [optional] 
+
+

data/docs/MembershipTypeRestriction.md

@@ -0,0 +1,9 @@
+# SwaggerClient::MembershipTypeRestriction
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | The ID of the membership that is allowed to purchase the contract. | [optional] 
+**name** | **String** | The name of the membership type. | [optional] 
+
+

data/docs/ModelClass.md

@@ -0,0 +1,33 @@
+# SwaggerClient::ModelClass
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**class_schedule_id** | **Integer** | The ID used to retrieve the class schedule for the desired class. | [optional] 
+**visits** | [**Array<Visit>**](Visit.md) | Contains information about visits. | [optional] 
+**clients** | [**Array<Client>**](Client.md) | Contains information about clients. | [optional] 
+**location** | [**Location**](Location.md) | Contains information about a location. | [optional] 
+**resource** | [**Resource**](Resource.md) | Contains information about a resource, such as a room, assigned to a class. | [optional] 
+**max_capacity** | **Integer** | The maximum number of clients allowed in the class. | [optional] 
+**web_capacity** | **Integer** | The maximum number of clients allowed to sign up online for the class. | [optional] 
+**total_booked** | **Integer** | The total number of clients booked in the class. | [optional] 
+**total_booked_waitlist** | **Integer** | The total number of booked clients on the waiting list for the class. | [optional] 
+**web_booked** | **Integer** | The total number of clients who signed up online for the class. | [optional] 
+**semester_id** | **Integer** | The ID of the semester that the class is a part of, if any. | [optional] 
+**is_canceled** | **BOOLEAN** | When `true`, indicates that the class has been cancelled.<br />  When `false`, indicates that the class has not been cancelled. | [optional] 
+**substitute** | **BOOLEAN** | When `true`, indicates that the class is being taught by a substitute teacher.<br />  When `false`, indicates that the class is being taught by its regular teacher. | [optional] 
+**active** | **BOOLEAN** | When `true`, indicates that the class is shown to clients when in consumer mode.<br />  When `false`, indicates that the class is not shown to clients when in consumer mode. | [optional] 
+**is_waitlist_available** | **BOOLEAN** | When `true`, indicates that the clients can be placed on a waiting list for the class.<br />  When `false`, indicates that the clients cannot be placed on a waiting list for the class. | [optional] 
+**is_enrolled** | **BOOLEAN** | When `true`, indicates that the client with the given `ClientId` is enrolled in this class.<br />  When `false`, indicates that the client with the given `ClientId` is not enrolled in this class. | [optional] 
+**hide_cancel** | **BOOLEAN** | When `true`, indicates that this class is hidden when cancelled.<br />  When `false`, indicates that this class is not hidden when cancelled. | [optional] 
+**id** | **Integer** | The unique identifier for the class. | [optional] 
+**is_available** | **BOOLEAN** | When `true`, indicates that the client with the given client ID can book this class.<br />  When `false`, indicates that the client with the given client ID cannot book this class. | [optional] 
+**start_date_time** | **DateTime** | The time this class is scheduled to start. | [optional] 
+**end_date_time** | **DateTime** | The time this class is scheduled to end. | [optional] 
+**last_modified_date_time** | **DateTime** | The last time this class was modified. | [optional] 
+**class_description** | [**ClassDescription**](ClassDescription.md) | Contains information that defines the class. | [optional] 
+**staff** | [**Staff**](Staff.md) | Contains information about the staff member. | [optional] 
+**booking_window** | [**BookingWindow**](BookingWindow.md) | Contains information about the window for booking. | [optional] 
+**booking_status** | **String** | Contains the booking’s payment status. | [optional] 
+
+

data/docs/Package.md

@@ -0,0 +1,13 @@
+# SwaggerClient::Package
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | The ID of the package. | [optional] 
+**name** | **String** | The name of the package. | [optional] 
+**discount_percentage** | **Float** | The discount percentage applied to the package. | [optional] 
+**sell_online** | **BOOLEAN** | When `true`, only products that can be sold online are returned.<br />  When `false`, all products are returned. | [optional] 
+**services** | [**Array<Service>**](Service.md) | Information about the services in the packages. | [optional] 
+**products** | [**Array<Product>**](Product.md) | Information about the products in the packages. | [optional] 
+
+

data/docs/PaginationResponse.md

@@ -0,0 +1,11 @@
+# SwaggerClient::PaginationResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**requested_limit** | **Integer** | Limit from pagination request | [optional] 
+**requested_offset** | **Integer** | Offset from pagination request | [optional] 
+**page_size** | **Integer** | Number of results returned in this response | [optional] 
+**total_results** | **Integer** | Total number of results in dataset | [optional] 
+
+

data/docs/PayrollApi.md

@@ -0,0 +1,140 @@
+# SwaggerClient::PayrollApi
+
+All URIs are relative to *https://api.mindbodyonline.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**payroll_get_class_payroll**](PayrollApi.md#payroll_get_class_payroll) | **GET** /public/v{version}/payroll/classes | Get class payroll for staff members.
+[**payroll_get_time_clock**](PayrollApi.md#payroll_get_time_clock) | **GET** /public/v{version}/payroll/timeclock | Get time card payroll for staff members.
+
+
+# **payroll_get_class_payroll**
+> GetClassPayrollResponse payroll_get_class_payroll(site_id, version, opts)
+
+Get class payroll for staff members.
+
+A staff authorization token is not required for this endpoint, but if one is passed, its permissions are honored. Depending on the access permissions configured for the staff member whose token is passed, the endpoint returns either only the payroll information for that staff member or it returns the payroll information for all staff members.    Note that if a staff member is not paid for a class, earnings of zero are returned by this endpoint.    Note that this endpoint calculates both bonus and no-reg rates for assistants.These rates are not supported by the Payroll report in the web interface.    Note that this endpoint returns both the teacher’s adjusted rate and the assistant’s pay rate when the assistant is paid by the teacher.The Payroll report in the web interface only returns the teacher’s adjusted rate.
+
+### Example
+```ruby
+# load the gem
+require 'swagger_client'
+
+api_instance = SwaggerClient::PayrollApi.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_time: DateTime.parse('2013-10-20T19:20:30+01:00'), # 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.
+  request_include_inactive_staff: true, # BOOLEAN | When `true`, payroll information returns for both active and inactive staff members.<br />  Default: **false**
+  request_limit: 56, # Integer | Number of results to include, defaults to 100
+  request_offset: 56, # Integer | Page offset, defaults to 0.
+  request_staff_id: 789, # 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.
+  request_start_date_time: DateTime.parse('2013-10-20T19:20:30+01:00') # 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.
+}
+
+begin
+  #Get class payroll for staff members.
+  result = api_instance.payroll_get_class_payroll(site_id, version, opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling PayrollApi->payroll_get_class_payroll: #{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_time** | **DateTime**| The end of the date range for the payroll information to be returned. The maximum allowed date range is 14 days.&lt;br /&gt;  Default: **Today’s date**  * If you do not supply an &#x60;EndDateTime&#x60;, the data returns for the period from the &#x60;StartDateTime&#x60; that you supply to today’s date.  * If you do not supply an &#x60;EndDateTime&#x60; or a &#x60;StartDateTime&#x60;, data returns for the seven days prior to today’s date. | [optional] 
+ **request_include_inactive_staff** | **BOOLEAN**| When &#x60;true&#x60;, payroll information returns for both active and inactive staff members.&lt;br /&gt;  Default: **false** | [optional] 
+ **request_limit** | **Integer**| Number of results to include, defaults to 100 | [optional] 
+ **request_offset** | **Integer**| Page offset, defaults to 0. | [optional] 
+ **request_staff_id** | **Integer**| A list of staff IDs that you want to retrieve payroll information for. If you do not supply a &#x60;StaffId&#x60;, all active staff members return, ordered by staff ID. | [optional] 
+ **request_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 &#x60;StartDateTime&#x60;, data returns for the seven days prior to the &#x60;EndDateTime&#x60; that you supply.  * If you do not supply either a &#x60;StartDateTime&#x60; or an &#x60;EndDateTime&#x60;, the data returns for seven days prior to today’s date. | [optional] 
+
+### Return type
+
+[**GetClassPayrollResponse**](GetClassPayrollResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json, text/json, application/xml, text/xml, multipart/form-data
+
+
+
+# **payroll_get_time_clock**
+> GetTimeClockResponse payroll_get_time_clock(site_id, version, opts)
+
+Get time card payroll for staff members.
+
+### Example
+```ruby
+# load the gem
+require 'swagger_client'
+
+api_instance = SwaggerClient::PayrollApi.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_time: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | The end of the date range for the time card information to be returned. If you do not supply an `EndDateTime`, data returns for the seven days prior to today’s date. Classes that begin before the `EndDateTime` are included in the response, regardless of the time that the class ends. The maximum allowed date range is 14 days.<br />  Default: **Today’s date**
+  request_include_inactive_staff: true, # BOOLEAN | When `true`, payroll information returns for both active and inactive staff members.<br />  Default: **false**
+  request_limit: 56, # Integer | Number of results to include, defaults to 100
+  request_offset: 56, # Integer | Page offset, defaults to 0.
+  request_staff_id: 789, # Integer | The staff ID for whom you want to retrieve time card information. If you do not supply a `StaffId`, all active staff members return, ordered by staff ID.
+  request_start_date_time: DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | The beginning of the date range for the time card information to be returned. If you do not supply a `StartDateTime`, data returns for the seven days prior to the `EndDateTime` that you supply. The maximum allowed date range is 14 days.
+}
+
+begin
+  #Get time card payroll for staff members.
+  result = api_instance.payroll_get_time_clock(site_id, version, opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling PayrollApi->payroll_get_time_clock: #{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_time** | **DateTime**| The end of the date range for the time card information to be returned. If you do not supply an &#x60;EndDateTime&#x60;, data returns for the seven days prior to today’s date. Classes that begin before the &#x60;EndDateTime&#x60; are included in the response, regardless of the time that the class ends. The maximum allowed date range is 14 days.&lt;br /&gt;  Default: **Today’s date** | [optional] 
+ **request_include_inactive_staff** | **BOOLEAN**| When &#x60;true&#x60;, payroll information returns for both active and inactive staff members.&lt;br /&gt;  Default: **false** | [optional] 
+ **request_limit** | **Integer**| Number of results to include, defaults to 100 | [optional] 
+ **request_offset** | **Integer**| Page offset, defaults to 0. | [optional] 
+ **request_staff_id** | **Integer**| The staff ID for whom you want to retrieve time card information. If you do not supply a &#x60;StaffId&#x60;, all active staff members return, ordered by staff ID. | [optional] 
+ **request_start_date_time** | **DateTime**| The beginning of the date range for the time card information to be returned. If you do not supply a &#x60;StartDateTime&#x60;, data returns for the seven days prior to the &#x60;EndDateTime&#x60; that you supply. The maximum allowed date range is 14 days. | [optional] 
+
+### Return type
+
+[**GetTimeClockResponse**](GetTimeClockResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json, text/json, application/xml, text/xml, multipart/form-data
+
+
+