mindbody-api-v6 1.0.0

data/docs/ClientContract.md

@@ -0,0 +1,16 @@
+# SwaggerClient::ClientContract
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**agreement_date** | **DateTime** | The date on which the contract was signed. | [optional] 
+**autopay_status** | **String** | The status of the client’s autopay. | [optional] 
+**contract_name** | **String** | The name of the contract. | [optional] 
+**end_date** | **DateTime** | The date that the contract expires. | [optional] 
+**id** | **Integer** | The unique ID of the contract. | [optional] 
+**origination_location_id** | **Integer** | The ID of the location where the contract was issued. | [optional] 
+**start_date** | **DateTime** | The date that the contract became active. | [optional] 
+**site_id** | **Integer** | The ID of the site where the contract was issued. | [optional] 
+**upcoming_autopay_events** | [**Array<UpcomingAutopayEvent>**](UpcomingAutopayEvent.md) | Contains details of the autopay events. | [optional] 
+
+

data/docs/ClientCreditCard.md

@@ -0,0 +1,17 @@
+# SwaggerClient::ClientCreditCard
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**address** | **String** | The billing address for the credit card. | [optional] 
+**card_holder** | **String** | The name of the card holder. | [optional] 
+**card_number** | **String** | The credit card number. | [optional] 
+**card_type** | **String** | The type of credit card, for example Visa or MasterCard. | [optional] 
+**city** | **String** | The city in which the billing address is located. | [optional] 
+**exp_month** | **String** | The month in which the credit card expires. | [optional] 
+**exp_year** | **String** | The year in which the credit card expires. | [optional] 
+**last_four** | **String** | The last four digits of the credit card number. | [optional] 
+**postal_code** | **String** | The postal code where the billing address is located. | [optional] 
+**state** | **String** | The state that the billing address is located in. | [optional] 
+
+

data/docs/ClientDocument.md

@@ -0,0 +1,10 @@
+# SwaggerClient::ClientDocument
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**file_name** | **String** | The name of the file to be used on the client’s documents page when it is uploaded. | 
+**media_type** | **String** | The type of file or file extension. Possible values are:  * pdf  * jpg  * jpeg  * tif  * tiff  * png  * doc  * docx  * bmp  * txt  * rtf  * xlsx  * xls  * gif  * zip  * ppt  * pptx  * mov | 
+**buffer** | **String** | A Base64-encoded string representation of the file’s byte array. | 
+
+

data/docs/ClientIndex.md

@@ -0,0 +1,13 @@
+# SwaggerClient::ClientIndex
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | The unique ID of the client index. | [optional] 
+**name** | **String** | The name of the client index. | [optional] 
+**required_business_mode** | **BOOLEAN** | When `true`, indicates that the index is required when creating profiles in business mode. | [optional] 
+**required_consumer_mode** | **BOOLEAN** | When `true`, indicates that the index is required when creating profiles in consumer mode. | [optional] 
+**values** | [**Array<ClientIndexValue>**](ClientIndexValue.md) | Contains information about the index's possible values. | [optional] 
+**action** | **String** | The action performed on this object. | [optional] 
+
+

data/docs/ClientIndexValue.md

@@ -0,0 +1,10 @@
+# SwaggerClient::ClientIndexValue
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**active** | **BOOLEAN** | When `true`, indicates that the index value can be assigned to its parent index.<br />  When `false`, indicates that the index value has been deactivated and cannot be assigned to its parent index. | [optional] 
+**id** | **Integer** | The index value’s ID. | [optional] 
+**name** | **String** | The name of the client index value. | [optional] 
+
+

data/docs/ClientMembership.md

@@ -0,0 +1,20 @@
+# SwaggerClient::ClientMembership
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**restricted_locations** | [**Array<Location>**](Location.md) | The locations that the membership is restricted to, if any. | [optional] 
+**icon_code** | **String** | Text code that represents the `MembershipIcon`. | [optional] 
+**active_date** | **DateTime** | The date that this pricing option became active and could be used to pay for services. | [optional] 
+**count** | **Integer** | The number of service sessions this pricing option contained when first purchased. | [optional] 
+**current** | **BOOLEAN** | When `true`, there are service sessions remaining on the pricing option that can be used pay for the current session.<br />  When `false`, the client cannot use this pricing option to pay for other services. | [optional] 
+**expiration_date** | **DateTime** | The date when the pricing option expires and can no longer be used to pay for services, even if unused service sessions remain on the option; expressed as UTC. | [optional] 
+**id** | **Integer** | The unique ID assigned to this pricing option. | [optional] 
+**name** | **String** | The name of this pricing option. | [optional] 
+**payment_date** | **DateTime** | The date on which the client paid for this pricing option. | [optional] 
+**program** | [**Program**](Program.md) | Contains information about the service category this service falls under. | [optional] 
+**remaining** | **Integer** | The number of service sessions remaining in the pricing option that can still be used. | [optional] 
+**site_id** | **Integer** | The ID of the subscriber site associated with this pricing option. | [optional] 
+**action** | **String** | The action taken. | [optional] 
+
+

data/docs/ClientPurchaseRecord.md

@@ -0,0 +1,16 @@
+# SwaggerClient::ClientPurchaseRecord
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sale** | [**Sale**](Sale.md) | Contains details about the sale and payment for a purchase event. | [optional] 
+**description** | **String** | The item name and description. | [optional] 
+**account_payment** | **BOOLEAN** | If `true`, the item was a payment credited to an account. | [optional] 
+**price** | **Float** | The item's price before taxes and discounts. | [optional] 
+**amount_paid** | **Float** | The amount paid for the item. | [optional] 
+**discount** | **Float** | The discount amount that was applied to the item. | [optional] 
+**tax** | **Float** | The amount of tax that was applied to the item. | [optional] 
+**returned** | **BOOLEAN** | The return status of the item. If `true`, this item was returned. | [optional] 
+**quantity** | **Integer** | The quantity of the item purchased. | [optional] 
+
+

data/docs/ClientRelationship.md

@@ -0,0 +1,10 @@
+# SwaggerClient::ClientRelationship
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**related_client_id** | **String** | The RSSID of the related client. | [optional] 
+**relationship** | [**Relationship**](Relationship.md) | Contains details about the relationship between two clients. | [optional] 
+**relationship_name** | **String** | The name of the relationship of the related client. | [optional] 
+
+

data/docs/ClientService.md

@@ -0,0 +1,18 @@
+# SwaggerClient::ClientService
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**active_date** | **DateTime** | The date that this pricing option became active and could be used to pay for services. | [optional] 
+**count** | **Integer** | The number of service sessions this pricing option contained when first purchased. | [optional] 
+**current** | **BOOLEAN** | When `true`, there are service sessions remaining on the pricing option that can be used pay for the current session.<br />  When `false`, the client cannot use this pricing option to pay for other services. | [optional] 
+**expiration_date** | **DateTime** | The date when the pricing option expires and can no longer be used to pay for services, even if unused service sessions remain on the option; expressed as UTC. | [optional] 
+**id** | **Integer** | The unique ID assigned to this pricing option. | [optional] 
+**name** | **String** | The name of this pricing option. | [optional] 
+**payment_date** | **DateTime** | The date on which the client paid for this pricing option. | [optional] 
+**program** | [**Program**](Program.md) | Contains information about the service category this service falls under. | [optional] 
+**remaining** | **Integer** | The number of service sessions remaining in the pricing option that can still be used. | [optional] 
+**site_id** | **Integer** | The ID of the subscriber site associated with this pricing option. | [optional] 
+**action** | **String** | The action taken. | [optional] 
+
+

data/docs/Color.md

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

data/docs/ContactLog.md

@@ -0,0 +1,18 @@
+# SwaggerClient::ContactLog
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | The contact log’s ID. | [optional] 
+**text** | **String** | The contact log’s body text. | [optional] 
+**created_date_time** | **DateTime** | The local date and time when the contact log was created. | [optional] 
+**followup_by_date** | **DateTime** | The date by which the assigned staff member should close or follow up on this contact log. | [optional] 
+**contact_method** | **String** | The method by which the client wants to be contacted. | [optional] 
+**contact_name** | **String** | The name of the client to contact. | [optional] 
+**client** | [**Client**](Client.md) | Information about the client to whom the contact log belongs. | [optional] 
+**created_by** | [**Staff**](Staff.md) | Information about the staff member who created the contact log. | [optional] 
+**assigned_to** | [**Staff**](Staff.md) | Information about the staff member to whom the contact log is assigned for follow up. | [optional] 
+**comments** | [**Array<ContactLogComment>**](ContactLogComment.md) | The contact log’s comments. | [optional] 
+**types** | [**Array<ContactLogType>**](ContactLogType.md) | Contains information about contact log types. | [optional] 
+
+

data/docs/ContactLogComment.md

@@ -0,0 +1,11 @@
+# SwaggerClient::ContactLogComment
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | The comment’s ID. | [optional] 
+**text** | **String** | The comment’s body text. | [optional] 
+**created_date_time** | **DateTime** | The local time when the comment was created. | [optional] 
+**created_by** | [**Staff**](Staff.md) | Information about the staff member who created the comment. | [optional] 
+
+

data/docs/ContactLogSubType.md

@@ -0,0 +1,8 @@
+# SwaggerClient::ContactLogSubType
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | The contact log subtype’s ID. | [optional] 
+
+

data/docs/ContactLogType.md

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

data/docs/Contract.md

@@ -0,0 +1,41 @@
+# SwaggerClient::Contract
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | The contract’s ID at the subscriber’s business. | [optional] 
+**name** | **String** | The name of the contract. | [optional] 
+**description** | **String** | A description of the contract. | [optional] 
+**assigns_membership_id** | **Integer** | The ID of the membership that was assigned to the client when the client signed up for a contract. | [optional] 
+**assigns_membership_name** | **String** | The name of the membership that was assigned to the client when the client signed up for this contract. | [optional] 
+**sold_online** | **BOOLEAN** | When `true`, indicates that this membership is intended to be shown to clients in client experiences.<br />  When `false`, this contract should only be shown to staff members. | [optional] 
+**contract_items** | [**Array<ContractItem>**](ContractItem.md) | Contains information about the items in the contract. | [optional] 
+**intro_offer** | **String** | Defines whether this contract is treated as an introductory offer. If this is an introductory offer, then clients are always charged a set number of times rather than month to month, using their AutoPays. Possible values are:  * None  * NewConsumer  * NewAndReturningConsumer | [optional] 
+**autopay_schedule** | [**AutopaySchedule**](AutopaySchedule.md) | Contains information about the AutoPay schedule. This parameter is null if `AutopayTriggerType` has a value of `PricingOptionRunsOutOrExpires`. | [optional] 
+**number_of_autopays** | **Integer** | The number of times that the AutoPay is to be run. This value is null if `FrequencyType` is `MonthToMonth`. | [optional] 
+**autopay_trigger_type** | **String** | Defines whether the AutoPay, if applicable to this contract, runs on a set schedule or when the pricing option runs out or expires. Possible values are:  * OnSetSchedule  * PricingOptionRunsOutOrExpires | [optional] 
+**action_upon_completion_of_autopays** | **String** | The renewal action to be taken when this AutoPay is completed. Possible values are:  * ContractExpires  * ContractAutomaticallyRenews | [optional] 
+**clients_charged_on** | **String** | The value that indicates when clients are charged. Possible values are:  * OnSaleDate  * FirstOfTheMonth  * FifteenthOfTheMonth  * LastDayOfTheMonth  * FirstOrFifteenthOfTheMonth  * FirstOrSixteenthOfTheMonth  * FifteenthOrEndOfTheMonth  * SpecificDate | [optional] 
+**clients_charged_on_specific_date** | **DateTime** | If `ClientsChargedOn` is defined as a specific date, this property holds the value of that date. Otherwise, this property is null. | [optional] 
+**discount_amount** | **Float** | The calculated discount applied to the items in this contract. | [optional] 
+**deposit_amount** | **Float** | The amount of the deposit required for this contract. | [optional] 
+**first_autopay_free** | **BOOLEAN** | When `true`, indicates that the first payment for the AutoPay is free. | [optional] 
+**last_autopay_free** | **BOOLEAN** | When `true`, indicates that the last payment for the AutoPay is free. | [optional] 
+**client_terminate_online** | **BOOLEAN** | When `true`, indicates that the client can terminate this contract on the Internet. | [optional] 
+**membership_type_restrictions** | [**Array<MembershipTypeRestriction>**](MembershipTypeRestriction.md) | Contains information about the memberships that can purchase this contract. If null, then no membership restrictions exist, and anyone can purchase the contract. | [optional] 
+**location_purchase_restriction_ids** | **Array<Integer>** | The IDs of the locations where this contract may be sold. If there are no restrictions, this value is null. | [optional] 
+**location_purchase_restriction_names** | **Array<String>** | Location names where the contract may be purchased. If this value is null, there are no restrictions. | [optional] 
+**agreement_terms** | **String** | Business-defined terms and conditions for the contract. | [optional] 
+**requires_electronic_confirmation** | **BOOLEAN** | When `true`, clients who purchase the contract are prompted to agree to the terms of the contract the next time that they log in. | [optional] 
+**autopay_enabled** | **BOOLEAN** | When `true`, this contract establishes an AutoPay on the client’s account. | [optional] 
+**first_payment_amount_subtotal** | **Float** | The subtotal of the amount that the client is to be charged when signing up for the contract. | [optional] 
+**first_payment_amount_tax** | **Float** | The amount of tax that the client is to be charged when signing up for the contract. | [optional] 
+**first_payment_amount_total** | **Float** | The total amount that the client is to be charged when signing up for the contract. | [optional] 
+**recurring_payment_amount_subtotal** | **Float** | The subtotal amount that the client is to be charged on an ongoing basis. | [optional] 
+**recurring_payment_amount_tax** | **Float** | The amount of tax the client is to be charged on an ongoing basis. | [optional] 
+**recurring_payment_amount_total** | **Float** | The total amount that the client is to be charged on an ongoing basis. | [optional] 
+**total_contract_amount_subtotal** | **Float** | The subtotal amount that the client is to be charged over the lifespan of the contract. | [optional] 
+**total_contract_amount_tax** | **Float** | The total amount of tax the client is to be charged over the lifespan of the contract. | [optional] 
+**total_contract_amount_total** | **Float** | The total amount the client is to be charged over the lifespan of the contract. | [optional] 
+
+

data/docs/ContractItem.md

@@ -0,0 +1,14 @@
+# SwaggerClient::ContractItem
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The ID of the item. | [optional] 
+**name** | **String** | The name of the item. | [optional] 
+**description** | **String** | A description of the item. | [optional] 
+**type** | **String** | The type of the item. | [optional] 
+**price** | **Float** | The price of the item. | [optional] 
+**quantity** | **Integer** | The quantity of the item. | [optional] 
+**one_time_item** | **BOOLEAN** | When `true`, indicates that the item is charged only once.<br />  When `false`, indicates that the item is charged multiple times. | [optional] 
+
+

data/docs/Course.md

@@ -0,0 +1,17 @@
+# SwaggerClient::Course
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | The course ID. | [optional] 
+**name** | **String** | The course name. | [optional] 
+**description** | **String** | A description of the course. | [optional] 
+**notes** | **String** | Any notes that have been written about the course. | [optional] 
+**start_date** | **DateTime** | Date and time that the course starts. | [optional] 
+**end_date** | **DateTime** | Date and time that the course ends. | [optional] 
+**location** | [**Location**](Location.md) | Contains information about the location. | [optional] 
+**organizer** | [**Staff**](Staff.md) | Contains information about the staff member in charge of organizing the event. | [optional] 
+**program** | [**Program**](Program.md) | Contains information about the service category to which the course belongs. | [optional] 
+**image_url** | **String** | The URL of the image associated with this course, if one exists. | [optional] 
+
+

data/docs/CreditCardInfo.md

@@ -0,0 +1,16 @@
+# SwaggerClient::CreditCardInfo
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**credit_card_number** | **String** |  | [optional] 
+**exp_month** | **String** |  | [optional] 
+**exp_year** | **String** |  | [optional] 
+**billing_name** | **String** |  | [optional] 
+**billing_address** | **String** |  | [optional] 
+**billing_city** | **String** |  | [optional] 
+**billing_state** | **String** |  | [optional] 
+**billing_postal_code** | **String** |  | [optional] 
+**save_info** | **BOOLEAN** |  | [optional] 
+
+

data/docs/CrossRegionalClientAssociation.md

@@ -0,0 +1,10 @@
+# SwaggerClient::CrossRegionalClientAssociation
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**site_id** | **Integer** | The ID of the site to which the client belongs. | [optional] 
+**client_id** | **String** | The client’s RSSID. | [optional] 
+**unique_id** | **Integer** | The client’s unique ID. | [optional] 
+
+

data/docs/CustomClientField.md

@@ -0,0 +1,10 @@
+# SwaggerClient::CustomClientField
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | The ID of the custom client field. | [optional] 
+**data_type** | **String** | The data type of the field. | [optional] 
+**name** | **String** | The name of the field. | [optional] 
+
+

data/docs/CustomClientFieldValue.md

@@ -0,0 +1,11 @@
+# SwaggerClient::CustomClientFieldValue
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **String** | The value of a specific custom field for a client. | [optional] 
+**id** | **Integer** | The ID of the custom client field. | [optional] 
+**data_type** | **String** | The data type of the field. | [optional] 
+**name** | **String** | The name of the field. | [optional] 
+
+

data/docs/CustomPaymentMethod.md

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

data/docs/EnrollmentApi.md

@@ -0,0 +1,137 @@
+# SwaggerClient::EnrollmentApi
+
+All URIs are relative to *https://api.mindbodyonline.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**enrollment_add_client_to_enrollment**](EnrollmentApi.md#enrollment_add_client_to_enrollment) | **POST** /public/v{version}/enrollment/addclienttoenrollment | Book a client into an enrollment.
+[**enrollment_get_enrollments**](EnrollmentApi.md#enrollment_get_enrollments) | **GET** /public/v{version}/enrollment/enrollments | Get enrollments scheduled at a site.
+
+
+# **enrollment_add_client_to_enrollment**
+> ClassSchedule enrollment_add_client_to_enrollment(request, site_id, version, opts)
+
+Book a client into an enrollment.
+
+### Example
+```ruby
+# load the gem
+require 'swagger_client'
+
+api_instance = SwaggerClient::EnrollmentApi.new
+
+request = SwaggerClient::AddClientToEnrollmentRequest.new # AddClientToEnrollmentRequest | 
+
+site_id = 'site_id_example' # String | ID of the site from which to pull data.
+
+version = 'version_example' # String | 
+
+opts = { 
+  authorization: '' # String | A staff user authorization token.
+}
+
+begin
+  #Book a client into an enrollment.
+  result = api_instance.enrollment_add_client_to_enrollment(request, site_id, version, opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling EnrollmentApi->enrollment_add_client_to_enrollment: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **request** | [**AddClientToEnrollmentRequest**](AddClientToEnrollmentRequest.md)|  | 
+ **site_id** | **String**| ID of the site from which to pull data. | 
+ **version** | **String**|  | 
+ **authorization** | **String**| A staff user authorization token. | [optional] [default to ]
+
+### Return type
+
+[**ClassSchedule**](ClassSchedule.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded, multipart/form-data
+ - **Accept**: application/json, text/json, application/xml, text/xml, multipart/form-data
+
+
+
+# **enrollment_get_enrollments**
+> GetEnrollmentsResponse enrollment_get_enrollments(site_id, version, opts)
+
+Get enrollments scheduled at a site.
+
+Returns a list of enrollments. An enrollment is a service, such as a workshop or an event, that a staff member offers to multiple students, who commit to coming to all or most of the scheduled sessions. Enrollments typically run for a limited time only.
+
+### Example
+```ruby
+# load the gem
+require 'swagger_client'
+
+api_instance = SwaggerClient::EnrollmentApi.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_class_schedule_ids: [56], # Array<Integer> | A list of the requested class schedule IDs. If omitted, all class schedule IDs return.
+  request_end_date: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | The end of the date range. The response returns any active enrollments that occur on or before this day.<br />  Default: **StartDate**
+  request_limit: 56, # Integer | Number of results to include, defaults to 100
+  request_location_ids: [56], # Array<Integer> | List of the IDs for the requested locations. If omitted, all location IDs return.
+  request_offset: 56, # Integer | Page offset, defaults to 0.
+  request_program_ids: [56], # Array<Integer> | List of the IDs for the requested programs. If omitted, all program IDs return.
+  request_session_type_ids: [56], # Array<Integer> | List of the IDs for the requested session types. If omitted, all session types IDs return.
+  request_staff_ids: [56], # Array<Integer> | List of the IDs for the requested staff IDs. If omitted, all staff IDs return.
+  request_start_date: DateTime.parse('2013-10-20T19:20:30+01:00') # 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**
+}
+
+begin
+  #Get enrollments scheduled at a site.
+  result = api_instance.enrollment_get_enrollments(site_id, version, opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling EnrollmentApi->enrollment_get_enrollments: #{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_class_schedule_ids** | [**Array&lt;Integer&gt;**](Integer.md)| A list of the requested class schedule IDs. If omitted, all class schedule IDs return. | [optional] 
+ **request_end_date** | **DateTime**| The end of the date range. The response returns any active enrollments that occur on or before this day.&lt;br /&gt;  Default: **StartDate** | [optional] 
+ **request_limit** | **Integer**| Number of results to include, defaults to 100 | [optional] 
+ **request_location_ids** | [**Array&lt;Integer&gt;**](Integer.md)| List of the IDs for the requested locations. If omitted, all location IDs return. | [optional] 
+ **request_offset** | **Integer**| Page offset, defaults to 0. | [optional] 
+ **request_program_ids** | [**Array&lt;Integer&gt;**](Integer.md)| List of the IDs for the requested programs. If omitted, all program IDs return. | [optional] 
+ **request_session_type_ids** | [**Array&lt;Integer&gt;**](Integer.md)| List of the IDs for the requested session types. If omitted, all session types IDs return. | [optional] 
+ **request_staff_ids** | [**Array&lt;Integer&gt;**](Integer.md)| List of the IDs for the requested staff IDs. If omitted, all staff IDs return. | [optional] 
+ **request_start_date** | **DateTime**| The start of the date range. The response returns any active enrollments that occur on or after this day.&lt;br /&gt;  Default: **today’s date** | [optional] 
+
+### Return type
+
+[**GetEnrollmentsResponse**](GetEnrollmentsResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json, text/json, application/xml, text/xml, multipart/form-data
+
+
+