mindbody-api-v6 1.0.0

data/docs/ClassDescription.md

@@ -0,0 +1,22 @@
+# SwaggerClient::ClassDescription
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**active** | **BOOLEAN** | When `true`, indicates that the business can assign this class description to new class schedules.<br />  When `false`, indicates that the business cannot assign this class description to new class schedules. | [optional] 
+**description** | **String** | The long version of the class description. | [optional] 
+**id** | **Integer** | The class description's ID. | [optional] 
+**image_url** | **String** | The class description's image URL, if any. If it does not exist, nothing is returned. | [optional] 
+**last_updated** | **DateTime** | The date this class description was last modified. | [optional] 
+**level** | [**Level**](Level.md) | The level information about this class. | [optional] 
+**name** | **String** | The name of this class description. | [optional] 
+**notes** | **String** | Any notes about the class description. | [optional] 
+**prereq** | **String** | Any prerequisites for the class. | [optional] 
+**program** | [**Program**](Program.md) | Contains information about the class description's program. | [optional] 
+**session_type** | [**SessionType**](SessionType.md) | Contains information about the class description's session type. | [optional] 
+**category** | **String** | The category of this class description. | [optional] 
+**category_id** | **Integer** | The category ID of this class description. | [optional] 
+**subcategory** | **String** | The subcategory of this class description. | [optional] 
+**subcategory_id** | **Integer** | The subcategory ID of this class description. | [optional] 
+
+

data/docs/ClassPayrollEvent.md

@@ -0,0 +1,10 @@
+# SwaggerClient::ClassPayrollEvent
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**staff_id** | **Integer** | The ID of the staff member who taught the class. | [optional] 
+**class_id** | **Integer** | The class' ID. | [optional] 
+**earnings** | **Float** | The total monetary amount the staff is to be paid for this class. | [optional] 
+
+

data/docs/ClassSchedule.md

@@ -0,0 +1,29 @@
+# SwaggerClient::ClassSchedule
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**classes** | [**Array<ModelClass>**](ModelClass.md) | Contains information about classes. | [optional] 
+**clients** | [**Array<Client>**](Client.md) | Contains information about clients. | [optional] 
+**course** | [**Course**](Course.md) | Contains information about the course that the enrollment is a part of. | [optional] 
+**semester_id** | **Integer** | The semester ID for the enrollment (if any). | [optional] 
+**is_available** | **BOOLEAN** | When `true`, indicates that the enrollment shows in consumer mode, has not started yet, and there is room in each class of the enrollment.<br />  When `false`, indicates that either the enrollment does not show in consumer mode, has already started, or there is no room in some classes of the enrollment. | [optional] 
+**id** | **Integer** | The unique ID of the class schedule. | [optional] 
+**class_description** | [**ClassDescription**](ClassDescription.md) | Contains information about the class. | [optional] 
+**day_sunday** | **BOOLEAN** | When `true`, indicates that this schedule occurs on Sundays. | [optional] 
+**day_monday** | **BOOLEAN** | When `true`, indicates that this schedule occurs on Mondays. | [optional] 
+**day_tuesday** | **BOOLEAN** | When `true`, indicates that this schedule occurs on Tuesdays. | [optional] 
+**day_wednesday** | **BOOLEAN** | When `true`, indicates that this schedule occurs on Wednesdays. | [optional] 
+**day_thursday** | **BOOLEAN** | When `true`, indicates that this schedule occurs on Thursdays. | [optional] 
+**day_friday** | **BOOLEAN** | When `true`, indicates that this schedule occurs on Fridays. | [optional] 
+**day_saturday** | **BOOLEAN** | When `true`, indicates that this schedule occurs on Saturdays. | [optional] 
+**allow_open_enrollment** | **BOOLEAN** | When `true`, indicates that the enrollment allows booking after the enrollment has started. | [optional] 
+**allow_date_forward_enrollment** | **BOOLEAN** | When `true`, indicates that this the enrollment shows in consumer mode, the enrollment has not started yet, and there is room in each class of the enrollment. | [optional] 
+**start_time** | **DateTime** | The time this class schedule starts. | [optional] 
+**end_time** | **DateTime** | The time this class schedule ends. | [optional] 
+**start_date** | **DateTime** | The date this class schedule starts. | [optional] 
+**end_date** | **DateTime** | The date this class schedule ends. | [optional] 
+**staff** | [**Staff**](Staff.md) | Contains information about the staff member who is regularly scheduled to teach the class. | [optional] 
+**location** | [**Location**](Location.md) | Contains information about the regularly scheduled location of this class. | [optional] 
+
+

data/docs/Client.md

@@ -0,0 +1,61 @@
+# SwaggerClient::Client
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**appointment_gender_preference** | **String** | The gender of staff member with whom the client prefers to book appointments. | [optional] 
+**birth_date** | **DateTime** | The client’s date of birth. | [optional] 
+**country** | **String** | The client’s country. | [optional] 
+**creation_date** | **DateTime** | The date the client’s profile was created and added to the business, either by the client from the online store, or by a staff member. This value always returns in the format `yyyy-mm-ddThh:mm:ss:ms`. | [optional] 
+**custom_client_fields** | [**Array<CustomClientFieldValue>**](CustomClientFieldValue.md) | Contains information about the custom client fields assigned to the client. | [optional] 
+**client_credit_card** | [**ClientCreditCard**](ClientCreditCard.md) | Contains information about the client’s credit card. | [optional] 
+**client_indexes** | [**Array<AssignedClientIndex>**](AssignedClientIndex.md) | Contains the IDs of the client’s assigned ClientIndexes and ClientIndexValues. | [optional] 
+**client_relationships** | [**Array<ClientRelationship>**](ClientRelationship.md) | Contains information about the relationship between two clients. | [optional] 
+**first_appointment_date** | **DateTime** | The date of the client’s first booked appointment at the business. | [optional] 
+**first_name** | **String** | The client’s first name. | [optional] 
+**id** | **String** | The client’s ID, as configured by the business owner. This is the client’s barcode ID if the business owner assigns barcodes to clients. This ID is used throughout the Public API for client-related Public API calls. When used in a POST `UpdateClient` request, the `Id` is used to identify the client for the update. | [optional] 
+**is_company** | **BOOLEAN** | When `true`, indicates that the client should be marked as a company at the business.<br />  When `false`, indicates the client is an individual and does not represent a company. | [optional] 
+**is_prospect** | **BOOLEAN** | This value is set only if the business owner allows individuals to be prospects.<br />  When `true`, indicates that the client should be marked as a prospect for the business.<br />  When `false`, indicates that the client should not be marked as a prospect for the business. | [optional] 
+**last_name** | **String** | The client’s last name. | [optional] 
+**liability** | [**Liability**](Liability.md) | Contains the client’s liability agreement information for the business. | [optional] 
+**liability_release** | **BOOLEAN** | Passing `true` sets the client’s liability information as follows:  * `IsReleased` is set to `true`.  * `AgreementDate` is set to the time zone of the business when the call was processed.  * `ReleasedBy` is set to `null` if the call is made by the client, `0` if the call was made by the business owner, or to a specific staff member’s ID if a staff member made the call.  Passing `false` sets the client’s liability information as follows:  * `IsReleased` is set to `false`.  * `AgreementDate` is set to `null`.  * `ReleasedBy` is set to `null`. | [optional] 
+**membership_icon** | **Integer** | The ID of the [membership icon](https://support.mindbodyonline.com/s/article/203259703-Membership-Setup-screen?language=en_US) displayed next to the client’s name, if the client has a membership on their account. | [optional] 
+**mobile_provider** | **Integer** | The client’s mobile provider. | [optional] 
+**notes** | **String** | Any notes entered on the client’s account by staff members. This value should never be shown to clients unless the business owner has a specific reason for showing them. | [optional] 
+**state** | **String** | The client’s state. | [optional] 
+**unique_id** | **Integer** | The client’s system-generated ID at the business. This value cannot be changed by business owners and is always unique across all clients at the business. This ID is not widely used in the Public API, but can be used by your application to uniquely identify clients. | [optional] 
+**last_modified_date_time** | **DateTime** | The UTC date and time when the client’s information was last modified. | [optional] 
+**red_alert** | **String** | Contains any red alert information entered by the business owner for the client. | [optional] 
+**yellow_alert** | **String** | Contains any yellow alert information entered by the business owner for the client. | [optional] 
+**middle_name** | **String** | The client’s middle name. | [optional] 
+**prospect_stage** | [**ProspectStage**](ProspectStage.md) | Contains information about the client [prospect stage](https://support.mindbodyonline.com/s/article/206176457-Prospect-Stages?language=en_US). | [optional] 
+**email** | **String** | The client’s email address. | [optional] 
+**mobile_phone** | **String** | The client’s mobile phone number. | [optional] 
+**home_phone** | **String** | The client’s home phone number. | [optional] 
+**work_phone** | **String** | The client’s work phone number. | [optional] 
+**account_balance** | **Float** | The client’s current [account balance](https://mindbody-online-support.force.com/support/s/article/203262013-Adding-account-payments-video-tutorial?language=en_US). | [optional] 
+**address_line1** | **String** | The first line of the client’s street address. | [optional] 
+**address_line2** | **String** | The second line of the client’s street address, if needed. | [optional] 
+**city** | **String** | The client’s city. | [optional] 
+**postal_code** | **String** | The client’s postal code. | [optional] 
+**work_extension** | **String** | The client’s work phone extension number. | [optional] 
+**referred_by** | **String** | Specifies how the client was referred to the business. You can get a list of possible strings using the `GetClientReferralTypes` endpoint. | [optional] 
+**photo_url** | **String** | The URL of the client’s photo for the client profile. | [optional] 
+**emergency_contact_info_name** | **String** | The name of the client’s emergency contact. | [optional] 
+**emergency_contact_info_email** | **String** | The email address of the client’s emergency contact. | [optional] 
+**emergency_contact_info_phone** | **String** | The phone number of the client’s emergency contact. | [optional] 
+**emergency_contact_info_relationship** | **String** | The client’s relationship with the emergency contact. | [optional] 
+**gender** | **String** | The gender of the client. | [optional] 
+**last_formula_notes** | **String** | The last [formula note](https://support.mindbodyonline.com/s/article/203259903-Appointments-Formula-notes?language=en_US) entered for the client. | [optional] 
+**active** | **BOOLEAN** | When `true`, indicates that the client’s profile is marked as active on the site.<br />  When `false`, the client’s profile is inactive. | [optional] 
+**sales_reps** | [**Array<SalesRep>**](SalesRep.md) | A list of sales representatives. | [optional] 
+**status** | **String** | The status of the client in the business. Possible values are:  * Declined  * Non-Member  * Active  * Expired  * Suspended  * Terminated | [optional] 
+**action** | **String** | The action taken. | [optional] 
+**send_account_emails** | **BOOLEAN** | When `true`, indicates that the client has opted to receive general account notifications by email. This property is editable.   <br />Default: **false** | [optional] 
+**send_account_texts** | **BOOLEAN** | When `true`, indicates that the client has opted to receive general account notifications by text message. This parameter cannot be updated by developers. If included in a request, it is ignored. | [optional] 
+**send_promotional_emails** | **BOOLEAN** | When `true`, indicates that the client has opted to receive promotional notifications by email. This property is editable.   <br />Default: **false** | [optional] 
+**send_promotional_texts** | **BOOLEAN** | When `true`, indicates that the client has opted to receive promotional notifications by text message. This parameter cannot be updated by developers. If included in a request, it is ignored. | [optional] 
+**send_schedule_emails** | **BOOLEAN** | When `true`, indicates that the client has opted to receive schedule notifications by email. This property is editable.   <br />Default: **false** | [optional] 
+**send_schedule_texts** | **BOOLEAN** | When `true`, indicates that the client has opted to receive schedule notifications by text message. This parameter cannot be updated by developers. If included in a request, it is ignored. | [optional] 
+
+

data/docs/ClientApi.md

@@ -0,0 +1,1473 @@
+# SwaggerClient::ClientApi
+
+All URIs are relative to *https://api.mindbodyonline.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**client_add_arrival**](ClientApi.md#client_add_arrival) | **POST** /public/v{version}/client/addarrival | Add an arrival for a client.
+[**client_add_client**](ClientApi.md#client_add_client) | **POST** /public/v{version}/client/addclient | Add a client to a site.
+[**client_add_contact_log**](ClientApi.md#client_add_contact_log) | **POST** /public/v{version}/client/addcontactlog | Add a contact log to a client's account.
+[**client_get_active_client_memberships**](ClientApi.md#client_get_active_client_memberships) | **GET** /public/v{version}/client/activeclientmemberships | Get a client's active memberships.
+[**client_get_client_account_balances**](ClientApi.md#client_get_client_account_balances) | **GET** /public/v{version}/client/clientaccountbalances | Get account balance information for one or more client(s).
+[**client_get_client_contracts**](ClientApi.md#client_get_client_contracts) | **GET** /public/v{version}/client/clientcontracts | Get contracts that a client has purchased.
+[**client_get_client_formula_notes**](ClientApi.md#client_get_client_formula_notes) | **GET** /public/v{version}/client/clientformulanotes | Get a client's formula notes.
+[**client_get_client_indexes**](ClientApi.md#client_get_client_indexes) | **GET** /public/v{version}/client/clientindexes | Get a site's configured client indexes and client index values.
+[**client_get_client_purchases**](ClientApi.md#client_get_client_purchases) | **GET** /public/v{version}/client/clientpurchases | Get a client's purchase history.
+[**client_get_client_referral_types**](ClientApi.md#client_get_client_referral_types) | **GET** /public/v{version}/client/clientreferraltypes | Get a site's configured client referral types.
+[**client_get_client_services**](ClientApi.md#client_get_client_services) | **GET** /public/v{version}/client/clientservices | Get pricing options that a client has purchased.
+[**client_get_client_visits**](ClientApi.md#client_get_client_visits) | **GET** /public/v{version}/client/clientvisits | Get a client's visit history.
+[**client_get_clients**](ClientApi.md#client_get_clients) | **GET** /public/v{version}/client/clients | Get clients.
+[**client_get_contact_logs**](ClientApi.md#client_get_contact_logs) | **GET** /public/v{version}/client/contactlogs | Get contact logs on a client's account.
+[**client_get_cross_regional_client_associations**](ClientApi.md#client_get_cross_regional_client_associations) | **GET** /public/v{version}/client/crossregionalclientassociations | Get a client's cross regional site associations.
+[**client_get_custom_client_fields**](ClientApi.md#client_get_custom_client_fields) | **GET** /public/v{version}/client/customclientfields | Get a site's configured custom client fields.
+[**client_get_required_client_fields**](ClientApi.md#client_get_required_client_fields) | **GET** /public/v{version}/client/requiredclientfields | Get client required fields for a site.
+[**client_send_password_reset_email**](ClientApi.md#client_send_password_reset_email) | **POST** /public/v{version}/client/sendpasswordresetemail | Send a password reset email to a client.
+[**client_update_client**](ClientApi.md#client_update_client) | **POST** /public/v{version}/client/updateclient | Update a client at a site.
+[**client_update_client_service**](ClientApi.md#client_update_client_service) | **POST** /public/v{version}/client/updateclientservice | Update a client's purchase pricing option.
+[**client_update_client_visit**](ClientApi.md#client_update_client_visit) | **POST** /public/v{version}/client/updateclientvisit | Update a client's visit.
+[**client_update_contact_log**](ClientApi.md#client_update_contact_log) | **POST** /public/v{version}/client/updatecontactlog | Update a contact log on a client's account.
+[**client_upload_client_document**](ClientApi.md#client_upload_client_document) | **POST** /public/v{version}/client/uploadclientdocument | Upload a document to a client's profile.
+[**client_upload_client_photo**](ClientApi.md#client_upload_client_photo) | **POST** /public/v{version}/client/uploadclientphoto | Upload a profile photo to a client's profile.
+
+
+# **client_add_arrival**
+> AddArrivalResponse client_add_arrival(request, site_id, version, opts)
+
+Add an arrival for a client.
+
+### Example
+```ruby
+# load the gem
+require 'swagger_client'
+
+api_instance = SwaggerClient::ClientApi.new
+
+request = SwaggerClient::AddArrivalRequest.new # AddArrivalRequest | 
+
+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
+  #Add an arrival for a client.
+  result = api_instance.client_add_arrival(request, site_id, version, opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling ClientApi->client_add_arrival: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **request** | [**AddArrivalRequest**](AddArrivalRequest.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
+
+[**AddArrivalResponse**](AddArrivalResponse.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
+
+
+
+# **client_add_client**
+> AddClientResponse client_add_client(request, site_id, version, opts)
+
+Add a client to a site.
+
+The `FirstName` and `LastName` parameters are always required in this request. All other parameters are optional, but note that any of the optional parameters could be required by a particular business, depending on how the business has configured the site settings.    Use after calling the `GetRequiredClientFields` endpoint to make sure you are collecting all required pieces of information.
+
+### Example
+```ruby
+# load the gem
+require 'swagger_client'
+
+api_instance = SwaggerClient::ClientApi.new
+
+request = SwaggerClient::AddClientRequest.new # AddClientRequest | 
+
+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
+  #Add a client to a site.
+  result = api_instance.client_add_client(request, site_id, version, opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling ClientApi->client_add_client: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **request** | [**AddClientRequest**](AddClientRequest.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
+
+[**AddClientResponse**](AddClientResponse.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
+
+
+
+# **client_add_contact_log**
+> ContactLog client_add_contact_log(request, site_id, version, opts)
+
+Add a contact log to a client's account.
+
+### Example
+```ruby
+# load the gem
+require 'swagger_client'
+
+api_instance = SwaggerClient::ClientApi.new
+
+request = SwaggerClient::AddContactLogRequest.new # AddContactLogRequest | 
+
+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
+  #Add a contact log to a client's account.
+  result = api_instance.client_add_contact_log(request, site_id, version, opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling ClientApi->client_add_contact_log: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **request** | [**AddContactLogRequest**](AddContactLogRequest.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
+
+[**ContactLog**](ContactLog.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
+
+
+
+# **client_get_active_client_memberships**
+> GetActiveClientMembershipsResponse client_get_active_client_memberships(request_client_id, site_id, version, opts)
+
+Get a client's active memberships.
+
+### Example
+```ruby
+# load the gem
+require 'swagger_client'
+
+api_instance = SwaggerClient::ClientApi.new
+
+request_client_id = 'request_client_id_example' # String | The ID of the client whose membership was requested.
+
+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_limit: 56, # Integer | Number of results to include, defaults to 100
+  request_location_id: 56, # Integer | The ID of the location where the requested membership was created.
+  request_offset: 56 # Integer | Page offset, defaults to 0.
+}
+
+begin
+  #Get a client's active memberships.
+  result = api_instance.client_get_active_client_memberships(request_client_id, site_id, version, opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling ClientApi->client_get_active_client_memberships: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **request_client_id** | **String**| The ID of the client whose membership was requested. | 
+ **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_limit** | **Integer**| Number of results to include, defaults to 100 | [optional] 
+ **request_location_id** | **Integer**| The ID of the location where the requested membership was created. | [optional] 
+ **request_offset** | **Integer**| Page offset, defaults to 0. | [optional] 
+
+### Return type
+
+[**GetActiveClientMembershipsResponse**](GetActiveClientMembershipsResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json, text/json, application/xml, text/xml, multipart/form-data
+
+
+
+# **client_get_client_account_balances**
+> GetClientAccountBalancesResponse client_get_client_account_balances(request_client_ids, site_id, version, opts)
+
+Get account balance information for one or more client(s).
+
+### Example
+```ruby
+# load the gem
+require 'swagger_client'
+
+api_instance = SwaggerClient::ClientApi.new
+
+request_client_ids = ['request_client_ids_example'] # Array<String> | The list of clients IDs for which you want account balances.
+
+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_balance_date: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | The date you want a balance relative to.   Default: **the current date**
+  request_class_id: 56, # Integer | The class ID of the event for which you want a balance.
+  request_limit: 56, # Integer | Number of results to include, defaults to 100
+  request_offset: 56 # Integer | Page offset, defaults to 0.
+}
+
+begin
+  #Get account balance information for one or more client(s).
+  result = api_instance.client_get_client_account_balances(request_client_ids, site_id, version, opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling ClientApi->client_get_client_account_balances: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **request_client_ids** | [**Array&lt;String&gt;**](String.md)| The list of clients IDs for which you want account balances. | 
+ **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_balance_date** | **DateTime**| The date you want a balance relative to.   Default: **the current date** | [optional] 
+ **request_class_id** | **Integer**| The class ID of the event for which you want a balance. | [optional] 
+ **request_limit** | **Integer**| Number of results to include, defaults to 100 | [optional] 
+ **request_offset** | **Integer**| Page offset, defaults to 0. | [optional] 
+
+### Return type
+
+[**GetClientAccountBalancesResponse**](GetClientAccountBalancesResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json, text/json, application/xml, text/xml, multipart/form-data
+
+
+
+# **client_get_client_contracts**
+> GetClientContractsResponse client_get_client_contracts(request_client_id, site_id, version, opts)
+
+Get contracts that a client has purchased.
+
+### Example
+```ruby
+# load the gem
+require 'swagger_client'
+
+api_instance = SwaggerClient::ClientApi.new
+
+request_client_id = 'request_client_id_example' # String | The ID of the client.
+
+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_client_associated_sites_offset: 56, # 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**
+  request_cross_regional_lookup: true, # 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.
+  request_limit: 56, # Integer | Number of results to include, defaults to 100
+  request_offset: 56 # Integer | Page offset, defaults to 0.
+}
+
+begin
+  #Get contracts that a client has purchased.
+  result = api_instance.client_get_client_contracts(request_client_id, site_id, version, opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling ClientApi->client_get_client_contracts: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **request_client_id** | **String**| The ID of the client. | 
+ **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_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 &#x60;CrossRegionalLookup&#x60; is set to &#x60;true&#x60;. To change which sites are queried, change this offset value.  Default: **0** | [optional] 
+ **request_cross_regional_lookup** | **BOOLEAN**| When &#x60;true&#x60;, indicates that the requesting client’s cross regional contracts are returned, if any.&lt;br /&gt;  When &#x60;false&#x60;, indicates that cross regional contracts are not returned. | [optional] 
+ **request_limit** | **Integer**| Number of results to include, defaults to 100 | [optional] 
+ **request_offset** | **Integer**| Page offset, defaults to 0. | [optional] 
+
+### Return type
+
+[**GetClientContractsResponse**](GetClientContractsResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json, text/json, application/xml, text/xml, multipart/form-data
+
+
+
+# **client_get_client_formula_notes**
+> GetClientFormulaNotesResponse client_get_client_formula_notes(site_id, version, opts)
+
+Get a client's formula notes.
+
+### Example
+```ruby
+# load the gem
+require 'swagger_client'
+
+api_instance = SwaggerClient::ClientApi.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_appointment_id: 789, # Integer | The appointment ID of the appointment that the formula notes are related to.
+  request_client_id: 'request_client_id_example', # String | The client ID of the client whose formula notes are being requested.
+  request_limit: 56, # Integer | Number of results to include, defaults to 100
+  request_offset: 56 # Integer | Page offset, defaults to 0.
+}
+
+begin
+  #Get a client's formula notes.
+  result = api_instance.client_get_client_formula_notes(site_id, version, opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling ClientApi->client_get_client_formula_notes: #{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_appointment_id** | **Integer**| The appointment ID of the appointment that the formula notes are related to. | [optional] 
+ **request_client_id** | **String**| The client ID of the client whose formula notes are being requested. | [optional] 
+ **request_limit** | **Integer**| Number of results to include, defaults to 100 | [optional] 
+ **request_offset** | **Integer**| Page offset, defaults to 0. | [optional] 
+
+### Return type
+
+[**GetClientFormulaNotesResponse**](GetClientFormulaNotesResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json, text/json, application/xml, text/xml, multipart/form-data
+
+
+
+# **client_get_client_indexes**
+> GetClientIndexesResponse client_get_client_indexes(site_id, version, opts)
+
+Get a site's configured client indexes and client index values.
+
+Client indexes are used to analyze client demographics. A business owner can set up different categories with sets of values which they can assign to each client. Client indexes are used in client searches, for tagging clients so that the owner can send mass emails to similar groups, and for many reports.    For more information, see Client Indexes and [Client Index Values (video tutorial)](https://support.mindbodyonline.com/s/article/203261653-Client-indexes-and-client-index-values-video-tutorial?language=en_USclient).
+
+### Example
+```ruby
+# load the gem
+require 'swagger_client'
+
+api_instance = SwaggerClient::ClientApi.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_required_only: true # 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.
+}
+
+begin
+  #Get a site's configured client indexes and client index values.
+  result = api_instance.client_get_client_indexes(site_id, version, opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling ClientApi->client_get_client_indexes: #{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_required_only** | **BOOLEAN**| When &#x60;true&#x60;, filters the results to only indexes that are required on creation.&lt;br /&gt;  When &#x60;false&#x60; or omitted, returns all of the client indexes. | [optional] 
+
+### Return type
+
+[**GetClientIndexesResponse**](GetClientIndexesResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json, text/json, application/xml, text/xml, multipart/form-data
+
+
+
+# **client_get_client_purchases**
+> GetClientPurchasesResponse client_get_client_purchases(request_client_id, site_id, version, opts)
+
+Get a client's purchase history.
+
+### Example
+```ruby
+# load the gem
+require 'swagger_client'
+
+api_instance = SwaggerClient::ClientApi.new
+
+request_client_id = 'request_client_id_example' # String | The ID of the client you are querying for purchases.
+
+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: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filters results to purchases made before this timestamp.<br />  Default: **end of today**
+  request_limit: 56, # Integer | Number of results to include, defaults to 100
+  request_offset: 56, # Integer | Page offset, defaults to 0.
+  request_sale_id: 56, # Integer | Filters results to the single record associated with this ID.
+  request_start_date: DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Filters results to purchases made on or after this timestamp.<br />  Default: **now**
+}
+
+begin
+  #Get a client's purchase history.
+  result = api_instance.client_get_client_purchases(request_client_id, site_id, version, opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling ClientApi->client_get_client_purchases: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **request_client_id** | **String**| The ID of the client you are querying for purchases. | 
+ **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** | **DateTime**| Filters results to purchases made before this timestamp.&lt;br /&gt;  Default: **end of today** | [optional] 
+ **request_limit** | **Integer**| Number of results to include, defaults to 100 | [optional] 
+ **request_offset** | **Integer**| Page offset, defaults to 0. | [optional] 
+ **request_sale_id** | **Integer**| Filters results to the single record associated with this ID. | [optional] 
+ **request_start_date** | **DateTime**| Filters results to purchases made on or after this timestamp.&lt;br /&gt;  Default: **now** | [optional] 
+
+### Return type
+
+[**GetClientPurchasesResponse**](GetClientPurchasesResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json, text/json, application/xml, text/xml, multipart/form-data
+
+
+
+# **client_get_client_referral_types**
+> GetClientReferralTypesResponse client_get_client_referral_types(site_id, version, opts)
+
+Get a site's configured client referral types.
+
+Gets a list of referral types. Referral types are options that new clients can choose to identify how they learned about the business. Referral types are typically used for the sign-up process.
+
+### Example
+```ruby
+# load the gem
+require 'swagger_client'
+
+api_instance = SwaggerClient::ClientApi.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_include_inactive: true # BOOLEAN | When `true`, filters the results to include subtypes and inactive referral types.<br />  When `false`, includes no subtypes and only active types.
+}
+
+begin
+  #Get a site's configured client referral types.
+  result = api_instance.client_get_client_referral_types(site_id, version, opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling ClientApi->client_get_client_referral_types: #{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_include_inactive** | **BOOLEAN**| When &#x60;true&#x60;, filters the results to include subtypes and inactive referral types.&lt;br /&gt;  When &#x60;false&#x60;, includes no subtypes and only active types. | [optional] 
+
+### Return type
+
+[**GetClientReferralTypesResponse**](GetClientReferralTypesResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json, text/json, application/xml, text/xml, multipart/form-data
+
+
+
+# **client_get_client_services**
+> GetClientServicesResponse client_get_client_services(request_client_id, site_id, version, opts)
+
+Get pricing options that a client has purchased.
+
+### Example
+```ruby
+# load the gem
+require 'swagger_client'
+
+api_instance = SwaggerClient::ClientApi.new
+
+request_client_id = 'request_client_id_example' # 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.
+
+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_id: 56, # Integer | Filters results to only those pricing options that can be used to pay for this class.
+  request_client_associated_sites_offset: 56, # 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
+  request_cross_regional_lookup: true, # 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**
+  request_end_date: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filters results to pricing options that are valid on or before this date.
+  request_limit: 56, # Integer | Number of results to include, defaults to 100
+  request_location_ids: [56], # Array<Integer> | Filters results to pricing options that can be used at the listed location IDs.
+  request_offset: 56, # Integer | Page offset, defaults to 0.
+  request_program_ids: [56], # Array<Integer> | Filters results to pricing options that belong to one of the given program IDs.
+  request_session_type_id: 56, # 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.
+  request_show_active_only: true, # BOOLEAN | When `true`, includes active services only.  Default: **false**
+  request_start_date: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filters results to pricing options that are valid on or after this date.
+  request_visit_count: 56 # Integer | A filter on the minimum number of visits a service can pay for.
+}
+
+begin
+  #Get pricing options that a client has purchased.
+  result = api_instance.client_get_client_services(request_client_id, site_id, version, opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling ClientApi->client_get_client_services: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **request_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. | 
+ **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_id** | **Integer**| Filters results to only those pricing options that can be used to pay for this class. | [optional] 
+ **request_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 &#x60;CrossRegionalClientAssociations&#x60; value from &#x60;GET CrossRegionalClientAssociations&#x60; to determine how many sites the client is associated with. Note that you must always have &#x60;CrossRegionalLookup&#x60; set to &#x60;true&#x60; to use this parameter.&lt;br /&gt;  Default: **0**    For example, if a client is associated with 25 sites, you need to call &#x60;GetClientServices&#x60; three times, as follows:  * Use &#x60;GET CrossRegionalClientAssociations&#x60; to determine how many sites a client is associated with, which tells you how many additional calls you need to make.  * Either omit &#x60;ClientAssociatedSitesOffset&#x60; or set it to 0 to return the client’s services (pricing options) from sites 1-10.  * Set &#x60;ClientAssociatedSitesOffset&#x60; to 10 to return the client pricing options from sites 11-20  * Set &#x60;ClientAssociatedSitesOffset&#x60; to 20 to return the client pricing options from sites 21-25 | [optional] 
+ **request_cross_regional_lookup** | **BOOLEAN**| Used to retrieve a client’s pricing options from multiple sites within an organization. When included and set to &#x60;true&#x60;, it searches a maximum of ten sites with which this client is associated. When a client is associated with more than ten sites, use &#x60;ClientAssociatedSitesOffset&#x60; as many times as needed to search the additional sites with which the client is associated. You can use the &#x60;CrossRegionalClientAssociations&#x60; value from &#x60;GET CrossRegionalClientAssociations&#x60; to determine how many sites the client is associated with. Note that a &#x60;SiteID&#x60; is returned and populated in the &#x60;ClientServices&#x60; response when &#x60;CrossRegionalLookup&#x60; is set to &#x60;true&#x60;.  Default: **false** | [optional] 
+ **request_end_date** | **DateTime**| Filters results to pricing options that are valid on or before this date. | [optional] 
+ **request_limit** | **Integer**| Number of results to include, defaults to 100 | [optional] 
+ **request_location_ids** | [**Array&lt;Integer&gt;**](Integer.md)| Filters results to pricing options that can be used at the listed location IDs. | [optional] 
+ **request_offset** | **Integer**| Page offset, defaults to 0. | [optional] 
+ **request_program_ids** | [**Array&lt;Integer&gt;**](Integer.md)| Filters results to pricing options that belong to one of the given program IDs. | [optional] 
+ **request_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] 
+ **request_show_active_only** | **BOOLEAN**| When &#x60;true&#x60;, includes active services only.  Default: **false** | [optional] 
+ **request_start_date** | **DateTime**| Filters results to pricing options that are valid on or after this date. | [optional] 
+ **request_visit_count** | **Integer**| A filter on the minimum number of visits a service can pay for. | [optional] 
+
+### Return type
+
+[**GetClientServicesResponse**](GetClientServicesResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json, text/json, application/xml, text/xml, multipart/form-data
+
+
+
+# **client_get_client_visits**
+> GetClientVisitsResponse client_get_client_visits(request_client_id, site_id, version, opts)
+
+Get a client's visit history.
+
+### Example
+```ruby
+# load the gem
+require 'swagger_client'
+
+api_instance = SwaggerClient::ClientApi.new
+
+request_client_id = 'request_client_id_example' # String | The ID of the requested client.
+
+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_client_associated_sites_offset: 56, # Integer | The number of sites to skip when returning the site associated with a client.
+  request_cross_regional_lookup: true, # 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.
+  request_end_date: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | The date past which class visits are not returned.  Default: **today’s date**
+  request_limit: 56, # Integer | Number of results to include, defaults to 100
+  request_offset: 56, # Integer | Page offset, defaults to 0.
+  request_start_date: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | The date before which class visits are not returned.  Default: **the end date**
+  request_unpaids_only: true # 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**
+}
+
+begin
+  #Get a client's visit history.
+  result = api_instance.client_get_client_visits(request_client_id, site_id, version, opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling ClientApi->client_get_client_visits: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **request_client_id** | **String**| The ID of the requested client. | 
+ **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_client_associated_sites_offset** | **Integer**| The number of sites to skip when returning the site associated with a client. | [optional] 
+ **request_cross_regional_lookup** | **BOOLEAN**| When &#x60;true&#x60;, indicates that past and scheduled client visits across all sites in the region are returned.&lt;br /&gt;  When &#x60;false&#x60;, indicates that only visits at the current site are returned. | [optional] 
+ **request_end_date** | **DateTime**| The date past which class visits are not returned.  Default: **today’s date** | [optional] 
+ **request_limit** | **Integer**| Number of results to include, defaults to 100 | [optional] 
+ **request_offset** | **Integer**| Page offset, defaults to 0. | [optional] 
+ **request_start_date** | **DateTime**| The date before which class visits are not returned.  Default: **the end date** | [optional] 
+ **request_unpaids_only** | **BOOLEAN**| When &#x60;true&#x60;, indicates that only visits that have not been paid for are returned.&lt;br /&gt;  When &#x60;false&#x60;, indicates that all visits are returned, regardless of whether they have been paid for.&lt;br /&gt;  Default: **false** | [optional] 
+
+### Return type
+
+[**GetClientVisitsResponse**](GetClientVisitsResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json, text/json, application/xml, text/xml, multipart/form-data
+
+
+
+# **client_get_clients**
+> GetClientsResponse client_get_clients(site_id, version, opts)
+
+Get clients.
+
+### Example
+```ruby
+# load the gem
+require 'swagger_client'
+
+api_instance = SwaggerClient::ClientApi.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_client_i_ds: ['request_client_i_ds_example'], # Array<String> | The requested client IDs.  Default: **all IDs** that the authenticated user’s access level allows.
+  request_is_prospect: true, # 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.
+  request_last_modified_date: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filters the results to include only the clients that have been modified on or after this date.
+  request_limit: 56, # Integer | Number of results to include, defaults to 100
+  request_offset: 56, # Integer | Page offset, defaults to 0.
+  request_search_text: 'request_search_text_example' # String | Text to use in the search. Can include FirstName, LastName, and Email. Note that user credentials must be provided.
+}
+
+begin
+  #Get clients.
+  result = api_instance.client_get_clients(site_id, version, opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling ClientApi->client_get_clients: #{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_client_i_ds** | [**Array&lt;String&gt;**](String.md)| The requested client IDs.  Default: **all IDs** that the authenticated user’s access level allows. | [optional] 
+ **request_is_prospect** | **BOOLEAN**| When &#x60;true&#x60;, filters the results to include only those clients marked as prospects for the business.&lt;br /&gt;  When &#x60;false&#x60;, indicates that only those clients who are not marked prospects should be returned. | [optional] 
+ **request_last_modified_date** | **DateTime**| Filters the results to include only the clients that have been modified on or after this date. | [optional] 
+ **request_limit** | **Integer**| Number of results to include, defaults to 100 | [optional] 
+ **request_offset** | **Integer**| Page offset, defaults to 0. | [optional] 
+ **request_search_text** | **String**| Text to use in the search. Can include FirstName, LastName, and Email. Note that user credentials must be provided. | [optional] 
+
+### Return type
+
+[**GetClientsResponse**](GetClientsResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json, text/json, application/xml, text/xml, multipart/form-data
+
+
+
+# **client_get_contact_logs**
+> GetContactLogsResponse client_get_contact_logs(request_client_id, site_id, version, opts)
+
+Get contact logs on a client's account.
+
+This endpoint contains a variety of filters that can return not just all contact logs, but also system-generated contact logs, contact logs assigned to specific staff members, and contact logs of specific types or subtypes.
+
+### Example
+```ruby
+# load the gem
+require 'swagger_client'
+
+api_instance = SwaggerClient::ClientApi.new
+
+request_client_id = 'request_client_id_example' # String | The ID of the client whose contact logs are being requested.
+
+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: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filters the results to contact logs created before this date.<br />  Default: **the start date**
+  request_limit: 56, # Integer | Number of results to include, defaults to 100
+  request_offset: 56, # Integer | Page offset, defaults to 0.
+  request_show_system_generated: true, # BOOLEAN | When `true`, system-generated contact logs are returned in the results.<br />  Default: **false**
+  request_staff_ids: [56], # Array<Integer> | Filters the results to return contact logs assigned to one or more staff IDs.
+  request_start_date: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filters the results to contact logs created on or after this date.<br />  Default: **the current date**
+  request_subtype_ids: [56], # Array<Integer> | Filters the results to contact logs assigned one or more of these subtype IDs.
+  request_type_ids: [56] # Array<Integer> | Filters the results to contact logs assigned one or more of these type IDs.
+}
+
+begin
+  #Get contact logs on a client's account.
+  result = api_instance.client_get_contact_logs(request_client_id, site_id, version, opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling ClientApi->client_get_contact_logs: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **request_client_id** | **String**| The ID of the client whose contact logs are being requested. | 
+ **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** | **DateTime**| Filters the results to contact logs created before this date.&lt;br /&gt;  Default: **the start date** | [optional] 
+ **request_limit** | **Integer**| Number of results to include, defaults to 100 | [optional] 
+ **request_offset** | **Integer**| Page offset, defaults to 0. | [optional] 
+ **request_show_system_generated** | **BOOLEAN**| When &#x60;true&#x60;, system-generated contact logs are returned in the results.&lt;br /&gt;  Default: **false** | [optional] 
+ **request_staff_ids** | [**Array&lt;Integer&gt;**](Integer.md)| Filters the results to return contact logs assigned to one or more staff IDs. | [optional] 
+ **request_start_date** | **DateTime**| Filters the results to contact logs created on or after this date.&lt;br /&gt;  Default: **the current date** | [optional] 
+ **request_subtype_ids** | [**Array&lt;Integer&gt;**](Integer.md)| Filters the results to contact logs assigned one or more of these subtype IDs. | [optional] 
+ **request_type_ids** | [**Array&lt;Integer&gt;**](Integer.md)| Filters the results to contact logs assigned one or more of these type IDs. | [optional] 
+
+### Return type
+
+[**GetContactLogsResponse**](GetContactLogsResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json, text/json, application/xml, text/xml, multipart/form-data
+
+
+
+# **client_get_cross_regional_client_associations**
+> GetCrossRegionalClientAssociationsResponse client_get_cross_regional_client_associations(site_id, version, opts)
+
+Get a client's cross regional site associations.
+
+Returns a list of sites that a particular client ID (also referred to as an RSSID) or a client email address is associated with in a cross-regional organization. Either the `ClientID` or `Email` parameter is required. If both are provided, the `ClientID` is used.    Use this endpoint to retrieve information for other Public API endpoints, about the same client at multiple sites within an organization. To use this endpoint, your developer account must have been granted permission to the site’s entire organization.    Note that this endpoint does not work on the Developer Sandbox site, as it is not set up for cross-regional use cases.
+
+### Example
+```ruby
+# load the gem
+require 'swagger_client'
+
+api_instance = SwaggerClient::ClientApi.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_client_id: 'request_client_id_example', # 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.
+  request_email: 'request_email_example', # 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.
+  request_limit: 56, # Integer | Number of results to include, defaults to 100
+  request_offset: 56 # Integer | Page offset, defaults to 0.
+}
+
+begin
+  #Get a client's cross regional site associations.
+  result = api_instance.client_get_cross_regional_client_associations(site_id, version, opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling ClientApi->client_get_cross_regional_client_associations: #{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_client_id** | **String**| Looks up the cross regional associations by the client’s ID. Either &#x60;ClientId&#x60; or &#x60;Email&#x60; must be provided. If both are provided, the &#x60;ClientId&#x60; is used by default. | [optional] 
+ **request_email** | **String**| Looks up the cross regional associations by the client’s email address. Either &#x60;ClientId&#x60; or &#x60;Email&#x60; must be provided. If both are provided, the &#x60;ClientId&#x60; is used by default. | [optional] 
+ **request_limit** | **Integer**| Number of results to include, defaults to 100 | [optional] 
+ **request_offset** | **Integer**| Page offset, defaults to 0. | [optional] 
+
+### Return type
+
+[**GetCrossRegionalClientAssociationsResponse**](GetCrossRegionalClientAssociationsResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json, text/json, application/xml, text/xml, multipart/form-data
+
+
+
+# **client_get_custom_client_fields**
+> GetCustomClientFieldsResponse client_get_custom_client_fields(site_id, version, opts)
+
+Get a site's configured custom client fields.
+
+### Example
+```ruby
+# load the gem
+require 'swagger_client'
+
+api_instance = SwaggerClient::ClientApi.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_limit: 56, # Integer | Number of results to include, defaults to 100
+  request_offset: 56 # Integer | Page offset, defaults to 0.
+}
+
+begin
+  #Get a site's configured custom client fields.
+  result = api_instance.client_get_custom_client_fields(site_id, version, opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling ClientApi->client_get_custom_client_fields: #{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_limit** | **Integer**| Number of results to include, defaults to 100 | [optional] 
+ **request_offset** | **Integer**| Page offset, defaults to 0. | [optional] 
+
+### Return type
+
+[**GetCustomClientFieldsResponse**](GetCustomClientFieldsResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json, text/json, application/xml, text/xml, multipart/form-data
+
+
+
+# **client_get_required_client_fields**
+> GetRequiredClientFieldsResponse client_get_required_client_fields(site_id, version, opts)
+
+Get client required fields for a site.
+
+Gets the list of fields that a new client has to fill out in business mode, specifically for the sign-up process. `AddClient` and `UpdateClient` validate against these fields.    This endpoint has no query parameters.
+
+### Example
+```ruby
+# load the gem
+require 'swagger_client'
+
+api_instance = SwaggerClient::ClientApi.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.
+}
+
+begin
+  #Get client required fields for a site.
+  result = api_instance.client_get_required_client_fields(site_id, version, opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling ClientApi->client_get_required_client_fields: #{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 ]
+
+### Return type
+
+[**GetRequiredClientFieldsResponse**](GetRequiredClientFieldsResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json, text/json, application/xml, text/xml, multipart/form-data
+
+
+
+# **client_send_password_reset_email**
+> Object client_send_password_reset_email(request, site_id, version, opts)
+
+Send a password reset email to a client.
+
+### Example
+```ruby
+# load the gem
+require 'swagger_client'
+
+api_instance = SwaggerClient::ClientApi.new
+
+request = SwaggerClient::SendPasswordResetEmailRequest.new # SendPasswordResetEmailRequest | 
+
+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
+  #Send a password reset email to a client.
+  result = api_instance.client_send_password_reset_email(request, site_id, version, opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling ClientApi->client_send_password_reset_email: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **request** | [**SendPasswordResetEmailRequest**](SendPasswordResetEmailRequest.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
+
+**Object**
+
+### 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
+
+
+
+# **client_update_client**
+> UpdateClientResponse client_update_client(request, site_id, version, opts)
+
+Update a client at a site.
+
+Updates an existing client for a specific subscriber. Use this endpoint as follows:  * If you need to update the `ReferredBy` parameter, use this endpoint after calling `GET ClientReferralTypes`.  * When updating a client’s home location, use after calling `GET Locations`.  * If you are updating a client’s stored credit card, use after calling `GET AcceptedCardTypes` so that you can make sure the card is a type that is accepted at the subscriber.  If this endpoint is used on a cross-regional site, passing in a client’s RSSID and email address creates a cross-regional link. This means that the client is created in cross-regional sites where the client does not exist and `GET CrossRegionalClientAssociations` returns all appropriate cross-regional sites. When `CrossRegionalUpdate` is omitted or set to `true`, the client’s updated information is propagated to all of the region’s sites. If `CrossRegionalUpdate` is set to `false`, only the local client is updated.    Note that the following items cannot be updated for a cross-regional client:  * `ClientIndexes`  * `ClientRelationships`  * `CustomClientFields`  * `SalesReps`  * `SendAccountEmails`  * `SendAccountTexts`  * `SendPromotionalEmails`  * `SendPromotionalTexts`  * `SendScheduleEmails`  * `SendScheduleTexts`
+
+### Example
+```ruby
+# load the gem
+require 'swagger_client'
+
+api_instance = SwaggerClient::ClientApi.new
+
+request = SwaggerClient::UpdateClientRequest.new # UpdateClientRequest | 
+
+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
+  #Update a client at a site.
+  result = api_instance.client_update_client(request, site_id, version, opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling ClientApi->client_update_client: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **request** | [**UpdateClientRequest**](UpdateClientRequest.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
+
+[**UpdateClientResponse**](UpdateClientResponse.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
+
+
+
+# **client_update_client_service**
+> UpdateClientServiceResponse client_update_client_service(request, site_id, version, opts)
+
+Update a client's purchase pricing option.
+
+Updates the active date and/or expiration date of a client pricing option. This request requires staff user credentials. If the active date is modified, the expiration date is also modified accordingly. If the expiration date is modified, the active date is unchanged.
+
+### Example
+```ruby
+# load the gem
+require 'swagger_client'
+
+api_instance = SwaggerClient::ClientApi.new
+
+request = SwaggerClient::UpdateClientServiceRequest.new # UpdateClientServiceRequest | 
+
+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
+  #Update a client's purchase pricing option.
+  result = api_instance.client_update_client_service(request, site_id, version, opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling ClientApi->client_update_client_service: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **request** | [**UpdateClientServiceRequest**](UpdateClientServiceRequest.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
+
+[**UpdateClientServiceResponse**](UpdateClientServiceResponse.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
+
+
+
+# **client_update_client_visit**
+> UpdateClientVisitResponse client_update_client_visit(request, site_id, version, opts)
+
+Update a client's visit.
+
+### Example
+```ruby
+# load the gem
+require 'swagger_client'
+
+api_instance = SwaggerClient::ClientApi.new
+
+request = SwaggerClient::UpdateClientVisitRequest.new # UpdateClientVisitRequest | 
+
+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
+  #Update a client's visit.
+  result = api_instance.client_update_client_visit(request, site_id, version, opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling ClientApi->client_update_client_visit: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **request** | [**UpdateClientVisitRequest**](UpdateClientVisitRequest.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
+
+[**UpdateClientVisitResponse**](UpdateClientVisitResponse.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
+
+
+
+# **client_update_contact_log**
+> ContactLog client_update_contact_log(request, site_id, version, opts)
+
+Update a contact log on a client's account.
+
+### Example
+```ruby
+# load the gem
+require 'swagger_client'
+
+api_instance = SwaggerClient::ClientApi.new
+
+request = SwaggerClient::UpdateContactLogRequest.new # UpdateContactLogRequest | 
+
+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
+  #Update a contact log on a client's account.
+  result = api_instance.client_update_contact_log(request, site_id, version, opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling ClientApi->client_update_contact_log: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **request** | [**UpdateContactLogRequest**](UpdateContactLogRequest.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
+
+[**ContactLog**](ContactLog.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
+
+
+
+# **client_upload_client_document**
+> UploadClientDocumentResponse client_upload_client_document(request, site_id, version, opts)
+
+Upload a document to a client's profile.
+
+Returns a string representation of the image byte array. The maximum document size is 1MB.    The maximum size file that can be uploaded is 4 MB.
+
+### Example
+```ruby
+# load the gem
+require 'swagger_client'
+
+api_instance = SwaggerClient::ClientApi.new
+
+request = SwaggerClient::UploadClientDocumentRequest.new # UploadClientDocumentRequest | 
+
+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
+  #Upload a document to a client's profile.
+  result = api_instance.client_upload_client_document(request, site_id, version, opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling ClientApi->client_upload_client_document: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **request** | [**UploadClientDocumentRequest**](UploadClientDocumentRequest.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
+
+[**UploadClientDocumentResponse**](UploadClientDocumentResponse.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
+
+
+
+# **client_upload_client_photo**
+> UploadClientPhotoResponse client_upload_client_photo(request, site_id, version, opts)
+
+Upload a profile photo to a client's profile.
+
+The maximum file size is 4 MB and acceptable file types are:  * bmp  * jpeg  * gif  * tiff  * png
+
+### Example
+```ruby
+# load the gem
+require 'swagger_client'
+
+api_instance = SwaggerClient::ClientApi.new
+
+request = SwaggerClient::UploadClientPhotoRequest.new # UploadClientPhotoRequest | 
+
+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
+  #Upload a profile photo to a client's profile.
+  result = api_instance.client_upload_client_photo(request, site_id, version, opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling ClientApi->client_upload_client_photo: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **request** | [**UploadClientPhotoRequest**](UploadClientPhotoRequest.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
+
+[**UploadClientPhotoResponse**](UploadClientPhotoResponse.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
+
+
+