mindbody-api-v6 1.0.0

data/lib/swagger_client/api/enrollment_api.rb

@@ -0,0 +1,180 @@
+=begin
+#MINDBODY Public API
+
+#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+
+OpenAPI spec version: v6
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.6
+
+=end
+
+require 'uri'
+
+module SwaggerClient
+  class EnrollmentApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Book a client into an enrollment.
+    # @param request 
+    # @param site_id ID of the site from which to pull data.
+    # @param version 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :authorization A staff user authorization token. (default to )
+    # @return [ClassSchedule]
+    def enrollment_add_client_to_enrollment(request, site_id, version, opts = {})
+      data, _status_code, _headers = enrollment_add_client_to_enrollment_with_http_info(request, site_id, version, opts)
+      data
+    end
+
+    # Book a client into an enrollment.
+    # @param request 
+    # @param site_id ID of the site from which to pull data.
+    # @param version 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :authorization A staff user authorization token.
+    # @return [Array<(ClassSchedule, Fixnum, Hash)>] ClassSchedule data, response status code and response headers
+    def enrollment_add_client_to_enrollment_with_http_info(request, site_id, version, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EnrollmentApi.enrollment_add_client_to_enrollment ...'
+      end
+      # verify the required parameter 'request' is set
+      if @api_client.config.client_side_validation && request.nil?
+        fail ArgumentError, "Missing the required parameter 'request' when calling EnrollmentApi.enrollment_add_client_to_enrollment"
+      end
+      # verify the required parameter 'site_id' is set
+      if @api_client.config.client_side_validation && site_id.nil?
+        fail ArgumentError, "Missing the required parameter 'site_id' when calling EnrollmentApi.enrollment_add_client_to_enrollment"
+      end
+      # verify the required parameter 'version' is set
+      if @api_client.config.client_side_validation && version.nil?
+        fail ArgumentError, "Missing the required parameter 'version' when calling EnrollmentApi.enrollment_add_client_to_enrollment"
+      end
+      # resource path
+      local_var_path = '/public/v{version}/enrollment/addclienttoenrollment'.sub('{' + 'version' + '}', version.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml', 'multipart/form-data'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded', 'multipart/form-data'])
+      header_params[:'siteId'] = site_id
+      header_params[:'authorization'] = opts[:'authorization'] if !opts[:'authorization'].nil?
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(request)
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'ClassSchedule')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EnrollmentApi#enrollment_add_client_to_enrollment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # 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.
+    # @param site_id ID of the site from which to pull data.
+    # @param version 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :authorization A staff user authorization token. (default to )
+    # @option opts [Array<Integer>] :request_class_schedule_ids A list of the requested class schedule IDs. If omitted, all class schedule IDs return.
+    # @option opts [DateTime] :request_end_date The end of the date range. The response returns any active enrollments that occur on or before this day.&lt;br /&gt;  Default: **StartDate**
+    # @option opts [Integer] :request_limit Number of results to include, defaults to 100
+    # @option opts [Array<Integer>] :request_location_ids List of the IDs for the requested locations. If omitted, all location IDs return.
+    # @option opts [Integer] :request_offset Page offset, defaults to 0.
+    # @option opts [Array<Integer>] :request_program_ids List of the IDs for the requested programs. If omitted, all program IDs return.
+    # @option opts [Array<Integer>] :request_session_type_ids List of the IDs for the requested session types. If omitted, all session types IDs return.
+    # @option opts [Array<Integer>] :request_staff_ids List of the IDs for the requested staff IDs. If omitted, all staff IDs return.
+    # @option opts [DateTime] :request_start_date 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**
+    # @return [GetEnrollmentsResponse]
+    def enrollment_get_enrollments(site_id, version, opts = {})
+      data, _status_code, _headers = enrollment_get_enrollments_with_http_info(site_id, version, opts)
+      data
+    end
+
+    # 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.
+    # @param site_id ID of the site from which to pull data.
+    # @param version 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :authorization A staff user authorization token.
+    # @option opts [Array<Integer>] :request_class_schedule_ids A list of the requested class schedule IDs. If omitted, all class schedule IDs return.
+    # @option opts [DateTime] :request_end_date The end of the date range. The response returns any active enrollments that occur on or before this day.&lt;br /&gt;  Default: **StartDate**
+    # @option opts [Integer] :request_limit Number of results to include, defaults to 100
+    # @option opts [Array<Integer>] :request_location_ids List of the IDs for the requested locations. If omitted, all location IDs return.
+    # @option opts [Integer] :request_offset Page offset, defaults to 0.
+    # @option opts [Array<Integer>] :request_program_ids List of the IDs for the requested programs. If omitted, all program IDs return.
+    # @option opts [Array<Integer>] :request_session_type_ids List of the IDs for the requested session types. If omitted, all session types IDs return.
+    # @option opts [Array<Integer>] :request_staff_ids List of the IDs for the requested staff IDs. If omitted, all staff IDs return.
+    # @option opts [DateTime] :request_start_date 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**
+    # @return [Array<(GetEnrollmentsResponse, Fixnum, Hash)>] GetEnrollmentsResponse data, response status code and response headers
+    def enrollment_get_enrollments_with_http_info(site_id, version, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EnrollmentApi.enrollment_get_enrollments ...'
+      end
+      # verify the required parameter 'site_id' is set
+      if @api_client.config.client_side_validation && site_id.nil?
+        fail ArgumentError, "Missing the required parameter 'site_id' when calling EnrollmentApi.enrollment_get_enrollments"
+      end
+      # verify the required parameter 'version' is set
+      if @api_client.config.client_side_validation && version.nil?
+        fail ArgumentError, "Missing the required parameter 'version' when calling EnrollmentApi.enrollment_get_enrollments"
+      end
+      # resource path
+      local_var_path = '/public/v{version}/enrollment/enrollments'.sub('{' + 'version' + '}', version.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'request.classScheduleIds'] = @api_client.build_collection_param(opts[:'request_class_schedule_ids'], :multi) if !opts[:'request_class_schedule_ids'].nil?
+      query_params[:'request.endDate'] = opts[:'request_end_date'] if !opts[:'request_end_date'].nil?
+      query_params[:'request.limit'] = opts[:'request_limit'] if !opts[:'request_limit'].nil?
+      query_params[:'request.locationIds'] = @api_client.build_collection_param(opts[:'request_location_ids'], :multi) if !opts[:'request_location_ids'].nil?
+      query_params[:'request.offset'] = opts[:'request_offset'] if !opts[:'request_offset'].nil?
+      query_params[:'request.programIds'] = @api_client.build_collection_param(opts[:'request_program_ids'], :multi) if !opts[:'request_program_ids'].nil?
+      query_params[:'request.sessionTypeIds'] = @api_client.build_collection_param(opts[:'request_session_type_ids'], :multi) if !opts[:'request_session_type_ids'].nil?
+      query_params[:'request.staffIds'] = @api_client.build_collection_param(opts[:'request_staff_ids'], :multi) if !opts[:'request_staff_ids'].nil?
+      query_params[:'request.startDate'] = opts[:'request_start_date'] if !opts[:'request_start_date'].nil?
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml', 'multipart/form-data'])
+      header_params[:'siteId'] = site_id
+      header_params[:'authorization'] = opts[:'authorization'] if !opts[:'authorization'].nil?
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'GetEnrollmentsResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EnrollmentApi#enrollment_get_enrollments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/swagger_client/api/payroll_api.rb

@@ -0,0 +1,181 @@
+=begin
+#MINDBODY Public API
+
+#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+
+OpenAPI spec version: v6
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.6
+
+=end
+
+require 'uri'
+
+module SwaggerClient
+  class PayrollApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get class payroll for staff members.
+    # A staff authorization token is not required for this endpoint, but if one is passed, its permissions are honored. Depending on the access permissions configured for the staff member whose token is passed, the endpoint returns either only the payroll information for that staff member or it returns the payroll information for all staff members.    Note that if a staff member is not paid for a class, earnings of zero are returned by this endpoint.    Note that this endpoint calculates both bonus and no-reg rates for assistants.These rates are not supported by the Payroll report in the web interface.    Note that this endpoint returns both the teacher’s adjusted rate and the assistant’s pay rate when the assistant is paid by the teacher.The Payroll report in the web interface only returns the teacher’s adjusted rate.
+    # @param site_id ID of the site from which to pull data.
+    # @param version 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :authorization A staff user authorization token. (default to )
+    # @option opts [DateTime] :request_end_date_time The end of the date range for the payroll information to be returned. The maximum allowed date range is 14 days.<br />  Default: **Today’s date**  * If you do not supply an `EndDateTime`, the data returns for the period from the `StartDateTime` that you supply to today’s date.  * If you do not supply an `EndDateTime` or a `StartDateTime`, data returns for the seven days prior to today’s date.
+    # @option opts [BOOLEAN] :request_include_inactive_staff When `true`, payroll information returns for both active and inactive staff members.<br />  Default: **false**
+    # @option opts [Integer] :request_limit Number of results to include, defaults to 100
+    # @option opts [Integer] :request_offset Page offset, defaults to 0.
+    # @option opts [Integer] :request_staff_id A list of staff IDs that you want to retrieve payroll information for. If you do not supply a `StaffId`, all active staff members return, ordered by staff ID.
+    # @option opts [DateTime] :request_start_date_time The beginning of the date range for the payroll information to be returned. The maximum allowed date range is 14 days.  * If you do not supply a `StartDateTime`, data returns for the seven days prior to the `EndDateTime` that you supply.  * If you do not supply either a `StartDateTime` or an `EndDateTime`, the data returns for seven days prior to today’s date.
+    # @return [GetClassPayrollResponse]
+    def payroll_get_class_payroll(site_id, version, opts = {})
+      data, _status_code, _headers = payroll_get_class_payroll_with_http_info(site_id, version, opts)
+      data
+    end
+
+    # Get class payroll for staff members.
+    # A staff authorization token is not required for this endpoint, but if one is passed, its permissions are honored. Depending on the access permissions configured for the staff member whose token is passed, the endpoint returns either only the payroll information for that staff member or it returns the payroll information for all staff members.    Note that if a staff member is not paid for a class, earnings of zero are returned by this endpoint.    Note that this endpoint calculates both bonus and no-reg rates for assistants.These rates are not supported by the Payroll report in the web interface.    Note that this endpoint returns both the teacher’s adjusted rate and the assistant’s pay rate when the assistant is paid by the teacher.The Payroll report in the web interface only returns the teacher’s adjusted rate.
+    # @param site_id ID of the site from which to pull data.
+    # @param version 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :authorization A staff user authorization token.
+    # @option opts [DateTime] :request_end_date_time The end of the date range for the payroll information to be returned. The maximum allowed date range is 14 days.<br />  Default: **Today’s date**  * If you do not supply an `EndDateTime`, the data returns for the period from the `StartDateTime` that you supply to today’s date.  * If you do not supply an `EndDateTime` or a `StartDateTime`, data returns for the seven days prior to today’s date.
+    # @option opts [BOOLEAN] :request_include_inactive_staff When `true`, payroll information returns for both active and inactive staff members.<br />  Default: **false**
+    # @option opts [Integer] :request_limit Number of results to include, defaults to 100
+    # @option opts [Integer] :request_offset Page offset, defaults to 0.
+    # @option opts [Integer] :request_staff_id A list of staff IDs that you want to retrieve payroll information for. If you do not supply a `StaffId`, all active staff members return, ordered by staff ID.
+    # @option opts [DateTime] :request_start_date_time The beginning of the date range for the payroll information to be returned. The maximum allowed date range is 14 days.  * If you do not supply a `StartDateTime`, data returns for the seven days prior to the `EndDateTime` that you supply.  * If you do not supply either a `StartDateTime` or an `EndDateTime`, the data returns for seven days prior to today’s date.
+    # @return [Array<(GetClassPayrollResponse, Fixnum, Hash)>] GetClassPayrollResponse data, response status code and response headers
+    def payroll_get_class_payroll_with_http_info(site_id, version, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PayrollApi.payroll_get_class_payroll ...'
+      end
+      # verify the required parameter 'site_id' is set
+      if @api_client.config.client_side_validation && site_id.nil?
+        fail ArgumentError, "Missing the required parameter 'site_id' when calling PayrollApi.payroll_get_class_payroll"
+      end
+      # verify the required parameter 'version' is set
+      if @api_client.config.client_side_validation && version.nil?
+        fail ArgumentError, "Missing the required parameter 'version' when calling PayrollApi.payroll_get_class_payroll"
+      end
+      # resource path
+      local_var_path = '/public/v{version}/payroll/classes'.sub('{' + 'version' + '}', version.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'request.endDateTime'] = opts[:'request_end_date_time'] if !opts[:'request_end_date_time'].nil?
+      query_params[:'request.includeInactiveStaff'] = opts[:'request_include_inactive_staff'] if !opts[:'request_include_inactive_staff'].nil?
+      query_params[:'request.limit'] = opts[:'request_limit'] if !opts[:'request_limit'].nil?
+      query_params[:'request.offset'] = opts[:'request_offset'] if !opts[:'request_offset'].nil?
+      query_params[:'request.staffId'] = opts[:'request_staff_id'] if !opts[:'request_staff_id'].nil?
+      query_params[:'request.startDateTime'] = opts[:'request_start_date_time'] if !opts[:'request_start_date_time'].nil?
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml', 'multipart/form-data'])
+      header_params[:'siteId'] = site_id
+      header_params[:'authorization'] = opts[:'authorization'] if !opts[:'authorization'].nil?
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'GetClassPayrollResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PayrollApi#payroll_get_class_payroll\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Get time card payroll for staff members.
+    # @param site_id ID of the site from which to pull data.
+    # @param version 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :authorization A staff user authorization token. (default to )
+    # @option opts [DateTime] :request_end_date_time The end of the date range for the time card information to be returned. If you do not supply an &#x60;EndDateTime&#x60;, data returns for the seven days prior to today’s date. Classes that begin before the &#x60;EndDateTime&#x60; are included in the response, regardless of the time that the class ends. The maximum allowed date range is 14 days.&lt;br /&gt;  Default: **Today’s date**
+    # @option opts [BOOLEAN] :request_include_inactive_staff When &#x60;true&#x60;, payroll information returns for both active and inactive staff members.&lt;br /&gt;  Default: **false**
+    # @option opts [Integer] :request_limit Number of results to include, defaults to 100
+    # @option opts [Integer] :request_offset Page offset, defaults to 0.
+    # @option opts [Integer] :request_staff_id The staff ID for whom you want to retrieve time card information. If you do not supply a &#x60;StaffId&#x60;, all active staff members return, ordered by staff ID.
+    # @option opts [DateTime] :request_start_date_time The beginning of the date range for the time card information to be returned. If you do not supply a &#x60;StartDateTime&#x60;, data returns for the seven days prior to the &#x60;EndDateTime&#x60; that you supply. The maximum allowed date range is 14 days.
+    # @return [GetTimeClockResponse]
+    def payroll_get_time_clock(site_id, version, opts = {})
+      data, _status_code, _headers = payroll_get_time_clock_with_http_info(site_id, version, opts)
+      data
+    end
+
+    # Get time card payroll for staff members.
+    # @param site_id ID of the site from which to pull data.
+    # @param version 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :authorization A staff user authorization token.
+    # @option opts [DateTime] :request_end_date_time The end of the date range for the time card information to be returned. If you do not supply an &#x60;EndDateTime&#x60;, data returns for the seven days prior to today’s date. Classes that begin before the &#x60;EndDateTime&#x60; are included in the response, regardless of the time that the class ends. The maximum allowed date range is 14 days.&lt;br /&gt;  Default: **Today’s date**
+    # @option opts [BOOLEAN] :request_include_inactive_staff When &#x60;true&#x60;, payroll information returns for both active and inactive staff members.&lt;br /&gt;  Default: **false**
+    # @option opts [Integer] :request_limit Number of results to include, defaults to 100
+    # @option opts [Integer] :request_offset Page offset, defaults to 0.
+    # @option opts [Integer] :request_staff_id The staff ID for whom you want to retrieve time card information. If you do not supply a &#x60;StaffId&#x60;, all active staff members return, ordered by staff ID.
+    # @option opts [DateTime] :request_start_date_time The beginning of the date range for the time card information to be returned. If you do not supply a &#x60;StartDateTime&#x60;, data returns for the seven days prior to the &#x60;EndDateTime&#x60; that you supply. The maximum allowed date range is 14 days.
+    # @return [Array<(GetTimeClockResponse, Fixnum, Hash)>] GetTimeClockResponse data, response status code and response headers
+    def payroll_get_time_clock_with_http_info(site_id, version, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PayrollApi.payroll_get_time_clock ...'
+      end
+      # verify the required parameter 'site_id' is set
+      if @api_client.config.client_side_validation && site_id.nil?
+        fail ArgumentError, "Missing the required parameter 'site_id' when calling PayrollApi.payroll_get_time_clock"
+      end
+      # verify the required parameter 'version' is set
+      if @api_client.config.client_side_validation && version.nil?
+        fail ArgumentError, "Missing the required parameter 'version' when calling PayrollApi.payroll_get_time_clock"
+      end
+      # resource path
+      local_var_path = '/public/v{version}/payroll/timeclock'.sub('{' + 'version' + '}', version.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'request.endDateTime'] = opts[:'request_end_date_time'] if !opts[:'request_end_date_time'].nil?
+      query_params[:'request.includeInactiveStaff'] = opts[:'request_include_inactive_staff'] if !opts[:'request_include_inactive_staff'].nil?
+      query_params[:'request.limit'] = opts[:'request_limit'] if !opts[:'request_limit'].nil?
+      query_params[:'request.offset'] = opts[:'request_offset'] if !opts[:'request_offset'].nil?
+      query_params[:'request.staffId'] = opts[:'request_staff_id'] if !opts[:'request_staff_id'].nil?
+      query_params[:'request.startDateTime'] = opts[:'request_start_date_time'] if !opts[:'request_start_date_time'].nil?
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml', 'multipart/form-data'])
+      header_params[:'siteId'] = site_id
+      header_params[:'authorization'] = opts[:'authorization'] if !opts[:'authorization'].nil?
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'GetTimeClockResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PayrollApi#payroll_get_time_clock\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/swagger_client/api/sale_api.rb

@@ -0,0 +1,829 @@
+=begin
+#MINDBODY Public API
+
+#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+
+OpenAPI spec version: v6
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.6
+
+=end
+
+require 'uri'
+
+module SwaggerClient
+  class SaleApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Purchase pricing options, packages, retail products, or tips for a client.
+    # This endpoint provides a wide range of functionality. For example, you can use it when a client purchases new pricing options, retail products, packages, and tips. You can also combine purchasing a new pricing option and many other functions, such as booking a client into a class, booking a new appointment for a client, enrolling a client into an enrollment or course, or reconciling an unpaid, already booked appointment or class. Use this call when a client purchases:  * a pricing option, after calling `GET Services` and choosing a specific pricing option’s ID  * a retail product, after calling `GET Products` and choosing a specific retail product’s ID  * a package, after calling `GET Packages` and choosing a specific package’s ID  * a tip to give to a staff member, after calling `GET Staff` and choosing a specific staff member ID, and the amount that the client wants to tip  The documentation provides explanations of the request body and response, as well as the cart item metadata, payment item metadata, and purchased cart items.
+    # @param request 
+    # @param site_id ID of the site from which to pull data.
+    # @param version 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :authorization A staff user authorization token. (default to )
+    # @return [Object]
+    def sale_checkout_shopping_cart(request, site_id, version, opts = {})
+      data, _status_code, _headers = sale_checkout_shopping_cart_with_http_info(request, site_id, version, opts)
+      data
+    end
+
+    # Purchase pricing options, packages, retail products, or tips for a client.
+    # This endpoint provides a wide range of functionality. For example, you can use it when a client purchases new pricing options, retail products, packages, and tips. You can also combine purchasing a new pricing option and many other functions, such as booking a client into a class, booking a new appointment for a client, enrolling a client into an enrollment or course, or reconciling an unpaid, already booked appointment or class. Use this call when a client purchases:  * a pricing option, after calling `GET Services` and choosing a specific pricing option’s ID  * a retail product, after calling `GET Products` and choosing a specific retail product’s ID  * a package, after calling `GET Packages` and choosing a specific package’s ID  * a tip to give to a staff member, after calling `GET Staff` and choosing a specific staff member ID, and the amount that the client wants to tip  The documentation provides explanations of the request body and response, as well as the cart item metadata, payment item metadata, and purchased cart items.
+    # @param request 
+    # @param site_id ID of the site from which to pull data.
+    # @param version 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :authorization A staff user authorization token.
+    # @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
+    def sale_checkout_shopping_cart_with_http_info(request, site_id, version, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SaleApi.sale_checkout_shopping_cart ...'
+      end
+      # verify the required parameter 'request' is set
+      if @api_client.config.client_side_validation && request.nil?
+        fail ArgumentError, "Missing the required parameter 'request' when calling SaleApi.sale_checkout_shopping_cart"
+      end
+      # verify the required parameter 'site_id' is set
+      if @api_client.config.client_side_validation && site_id.nil?
+        fail ArgumentError, "Missing the required parameter 'site_id' when calling SaleApi.sale_checkout_shopping_cart"
+      end
+      # verify the required parameter 'version' is set
+      if @api_client.config.client_side_validation && version.nil?
+        fail ArgumentError, "Missing the required parameter 'version' when calling SaleApi.sale_checkout_shopping_cart"
+      end
+      # resource path
+      local_var_path = '/public/v{version}/sale/checkoutshoppingcart'.sub('{' + 'version' + '}', version.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml', 'multipart/form-data'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded', 'multipart/form-data'])
+      header_params[:'siteId'] = site_id
+      header_params[:'authorization'] = opts[:'authorization'] if !opts[:'authorization'].nil?
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(request)
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Object')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SaleApi#sale_checkout_shopping_cart\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Get credit cards types that a site accepts.
+    # Gets a list of card types that the site accepts. You can also use `GET Sites` to return the Site object, which contains individual accepted card types for requested sites.    This endpoint has no query parameters.The response returns a list of strings. Possible values are:  * Visa  * MasterCard  * Discover  * AMEX
+    # @param site_id ID of the site from which to pull data.
+    # @param version 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :authorization A staff user authorization token. (default to )
+    # @return [Array<String>]
+    def sale_get_accepted_card_types(site_id, version, opts = {})
+      data, _status_code, _headers = sale_get_accepted_card_types_with_http_info(site_id, version, opts)
+      data
+    end
+
+    # Get credit cards types that a site accepts.
+    # Gets a list of card types that the site accepts. You can also use &#x60;GET Sites&#x60; to return the Site object, which contains individual accepted card types for requested sites.    This endpoint has no query parameters.The response returns a list of strings. Possible values are:  * Visa  * MasterCard  * Discover  * AMEX
+    # @param site_id ID of the site from which to pull data.
+    # @param version 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :authorization A staff user authorization token.
+    # @return [Array<(Array<String>, Fixnum, Hash)>] Array<String> data, response status code and response headers
+    def sale_get_accepted_card_types_with_http_info(site_id, version, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SaleApi.sale_get_accepted_card_types ...'
+      end
+      # verify the required parameter 'site_id' is set
+      if @api_client.config.client_side_validation && site_id.nil?
+        fail ArgumentError, "Missing the required parameter 'site_id' when calling SaleApi.sale_get_accepted_card_types"
+      end
+      # verify the required parameter 'version' is set
+      if @api_client.config.client_side_validation && version.nil?
+        fail ArgumentError, "Missing the required parameter 'version' when calling SaleApi.sale_get_accepted_card_types"
+      end
+      # resource path
+      local_var_path = '/public/v{version}/sale/acceptedcardtypes'.sub('{' + 'version' + '}', version.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml', 'multipart/form-data'])
+      header_params[:'siteId'] = site_id
+      header_params[:'authorization'] = opts[:'authorization'] if !opts[:'authorization'].nil?
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Array<String>')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SaleApi#sale_get_accepted_card_types\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Get contracts available for purchase at a site.
+    # @param request_location_id The ID of the location that has the requested contracts and AutoPay options.
+    # @param site_id ID of the site from which to pull data.
+    # @param version 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :authorization A staff user authorization token. (default to )
+    # @option opts [Integer] :request_consumer_id The ID of the client.
+    # @option opts [Array<Integer>] :request_contract_ids When included, the response only contains details about the specified contract IDs.
+    # @option opts [Integer] :request_limit Number of results to include, defaults to 100
+    # @option opts [Integer] :request_offset Page offset, defaults to 0.
+    # @option opts [BOOLEAN] :request_sold_online When &#x60;true&#x60;, the response only contains details about contracts and AutoPay options that can be sold online.&lt;br /&gt;  When &#x60;false&#x60;, only contracts that are not intended to be sold online are returned.&lt;br /&gt;  Default: **all contracts**
+    # @return [GetContractsResponse]
+    def sale_get_contracts(request_location_id, site_id, version, opts = {})
+      data, _status_code, _headers = sale_get_contracts_with_http_info(request_location_id, site_id, version, opts)
+      data
+    end
+
+    # Get contracts available for purchase at a site.
+    # @param request_location_id The ID of the location that has the requested contracts and AutoPay options.
+    # @param site_id ID of the site from which to pull data.
+    # @param version 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :authorization A staff user authorization token.
+    # @option opts [Integer] :request_consumer_id The ID of the client.
+    # @option opts [Array<Integer>] :request_contract_ids When included, the response only contains details about the specified contract IDs.
+    # @option opts [Integer] :request_limit Number of results to include, defaults to 100
+    # @option opts [Integer] :request_offset Page offset, defaults to 0.
+    # @option opts [BOOLEAN] :request_sold_online When &#x60;true&#x60;, the response only contains details about contracts and AutoPay options that can be sold online.&lt;br /&gt;  When &#x60;false&#x60;, only contracts that are not intended to be sold online are returned.&lt;br /&gt;  Default: **all contracts**
+    # @return [Array<(GetContractsResponse, Fixnum, Hash)>] GetContractsResponse data, response status code and response headers
+    def sale_get_contracts_with_http_info(request_location_id, site_id, version, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SaleApi.sale_get_contracts ...'
+      end
+      # verify the required parameter 'request_location_id' is set
+      if @api_client.config.client_side_validation && request_location_id.nil?
+        fail ArgumentError, "Missing the required parameter 'request_location_id' when calling SaleApi.sale_get_contracts"
+      end
+      # verify the required parameter 'site_id' is set
+      if @api_client.config.client_side_validation && site_id.nil?
+        fail ArgumentError, "Missing the required parameter 'site_id' when calling SaleApi.sale_get_contracts"
+      end
+      # verify the required parameter 'version' is set
+      if @api_client.config.client_side_validation && version.nil?
+        fail ArgumentError, "Missing the required parameter 'version' when calling SaleApi.sale_get_contracts"
+      end
+      # resource path
+      local_var_path = '/public/v{version}/sale/contracts'.sub('{' + 'version' + '}', version.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'request.locationId'] = request_location_id
+      query_params[:'request.consumerId'] = opts[:'request_consumer_id'] if !opts[:'request_consumer_id'].nil?
+      query_params[:'request.contractIds'] = @api_client.build_collection_param(opts[:'request_contract_ids'], :multi) if !opts[:'request_contract_ids'].nil?
+      query_params[:'request.limit'] = opts[:'request_limit'] if !opts[:'request_limit'].nil?
+      query_params[:'request.offset'] = opts[:'request_offset'] if !opts[:'request_offset'].nil?
+      query_params[:'request.soldOnline'] = opts[:'request_sold_online'] if !opts[:'request_sold_online'].nil?
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml', 'multipart/form-data'])
+      header_params[:'siteId'] = site_id
+      header_params[:'authorization'] = opts[:'authorization'] if !opts[:'authorization'].nil?
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'GetContractsResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SaleApi#sale_get_contracts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Get payment methods that can be used to pay for sales at a site.
+    # @param site_id ID of the site from which to pull data.
+    # @param version 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :authorization A staff user authorization token. (default to )
+    # @option opts [Integer] :request_limit Number of results to include, defaults to 100
+    # @option opts [Integer] :request_offset Page offset, defaults to 0.
+    # @return [GetCustomPaymentMethodsResponse]
+    def sale_get_custom_payment_methods(site_id, version, opts = {})
+      data, _status_code, _headers = sale_get_custom_payment_methods_with_http_info(site_id, version, opts)
+      data
+    end
+
+    # Get payment methods that can be used to pay for sales at a site.
+    # @param site_id ID of the site from which to pull data.
+    # @param version 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :authorization A staff user authorization token.
+    # @option opts [Integer] :request_limit Number of results to include, defaults to 100
+    # @option opts [Integer] :request_offset Page offset, defaults to 0.
+    # @return [Array<(GetCustomPaymentMethodsResponse, Fixnum, Hash)>] GetCustomPaymentMethodsResponse data, response status code and response headers
+    def sale_get_custom_payment_methods_with_http_info(site_id, version, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SaleApi.sale_get_custom_payment_methods ...'
+      end
+      # verify the required parameter 'site_id' is set
+      if @api_client.config.client_side_validation && site_id.nil?
+        fail ArgumentError, "Missing the required parameter 'site_id' when calling SaleApi.sale_get_custom_payment_methods"
+      end
+      # verify the required parameter 'version' is set
+      if @api_client.config.client_side_validation && version.nil?
+        fail ArgumentError, "Missing the required parameter 'version' when calling SaleApi.sale_get_custom_payment_methods"
+      end
+      # resource path
+      local_var_path = '/public/v{version}/sale/custompaymentmethods'.sub('{' + 'version' + '}', version.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'request.limit'] = opts[:'request_limit'] if !opts[:'request_limit'].nil?
+      query_params[:'request.offset'] = opts[:'request_offset'] if !opts[:'request_offset'].nil?
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml', 'multipart/form-data'])
+      header_params[:'siteId'] = site_id
+      header_params[:'authorization'] = opts[:'authorization'] if !opts[:'authorization'].nil?
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'GetCustomPaymentMethodsResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SaleApi#sale_get_custom_payment_methods\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Get gift cards available for purchase at a site.
+    # @param site_id ID of the site from which to pull data.
+    # @param version 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :authorization A staff user authorization token. (default to )
+    # @option opts [Array<Integer>] :request_ids Filters the results to the requested gift card IDs.&lt;br /&gt;  Default: **all** gift cards.
+    # @option opts [Integer] :request_limit Number of results to include, defaults to 100
+    # @option opts [Integer] :request_location_id When included, returns gift cards that are sold at the provided location ID.
+    # @option opts [Integer] :request_offset Page offset, defaults to 0.
+    # @option opts [BOOLEAN] :request_sold_online When &#x60;true&#x60;, only returns gift cards that are sold online.&lt;br /&gt;  Default: **false**
+    # @return [GetGiftCardResponse]
+    def sale_get_gift_cards(site_id, version, opts = {})
+      data, _status_code, _headers = sale_get_gift_cards_with_http_info(site_id, version, opts)
+      data
+    end
+
+    # Get gift cards available for purchase at a site.
+    # @param site_id ID of the site from which to pull data.
+    # @param version 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :authorization A staff user authorization token.
+    # @option opts [Array<Integer>] :request_ids Filters the results to the requested gift card IDs.&lt;br /&gt;  Default: **all** gift cards.
+    # @option opts [Integer] :request_limit Number of results to include, defaults to 100
+    # @option opts [Integer] :request_location_id When included, returns gift cards that are sold at the provided location ID.
+    # @option opts [Integer] :request_offset Page offset, defaults to 0.
+    # @option opts [BOOLEAN] :request_sold_online When &#x60;true&#x60;, only returns gift cards that are sold online.&lt;br /&gt;  Default: **false**
+    # @return [Array<(GetGiftCardResponse, Fixnum, Hash)>] GetGiftCardResponse data, response status code and response headers
+    def sale_get_gift_cards_with_http_info(site_id, version, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SaleApi.sale_get_gift_cards ...'
+      end
+      # verify the required parameter 'site_id' is set
+      if @api_client.config.client_side_validation && site_id.nil?
+        fail ArgumentError, "Missing the required parameter 'site_id' when calling SaleApi.sale_get_gift_cards"
+      end
+      # verify the required parameter 'version' is set
+      if @api_client.config.client_side_validation && version.nil?
+        fail ArgumentError, "Missing the required parameter 'version' when calling SaleApi.sale_get_gift_cards"
+      end
+      # resource path
+      local_var_path = '/public/v{version}/sale/giftcards'.sub('{' + 'version' + '}', version.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'request.ids'] = @api_client.build_collection_param(opts[:'request_ids'], :multi) if !opts[:'request_ids'].nil?
+      query_params[:'request.limit'] = opts[:'request_limit'] if !opts[:'request_limit'].nil?
+      query_params[:'request.locationId'] = opts[:'request_location_id'] if !opts[:'request_location_id'].nil?
+      query_params[:'request.offset'] = opts[:'request_offset'] if !opts[:'request_offset'].nil?
+      query_params[:'request.soldOnline'] = opts[:'request_sold_online'] if !opts[:'request_sold_online'].nil?
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml', 'multipart/form-data'])
+      header_params[:'siteId'] = site_id
+      header_params[:'authorization'] = opts[:'authorization'] if !opts[:'authorization'].nil?
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'GetGiftCardResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SaleApi#sale_get_gift_cards\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Get packages available for purchase at a site.
+    # A package is typically used to combine multiple services and/or products into a single offering. Staff members can check out multiple appointments while selling the package, and can discount the items included. For example, a spa might bundle a massage, a pedicure, a manicure, a facial, and a few selected beauty products into a package.
+    # @param site_id ID of the site from which to pull data.
+    # @param version 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :authorization A staff user authorization token. (default to )
+    # @option opts [Integer] :request_limit Number of results to include, defaults to 100
+    # @option opts [Integer] :request_offset Page offset, defaults to 0.
+    # @option opts [Array<Integer>] :request_package_ids A list of the packages IDs to filter by.
+    # @option opts [BOOLEAN] :request_sell_online When &#x60;true&#x60;, only returns products that can be sold online.&lt;br /&gt;  When &#x60;false&#x60;, all products are returned.&lt;br /&gt;  Default: **false**
+    # @return [GetPackagesResponse]
+    def sale_get_packages(site_id, version, opts = {})
+      data, _status_code, _headers = sale_get_packages_with_http_info(site_id, version, opts)
+      data
+    end
+
+    # Get packages available for purchase at a site.
+    # A package is typically used to combine multiple services and/or products into a single offering. Staff members can check out multiple appointments while selling the package, and can discount the items included. For example, a spa might bundle a massage, a pedicure, a manicure, a facial, and a few selected beauty products into a package.
+    # @param site_id ID of the site from which to pull data.
+    # @param version 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :authorization A staff user authorization token.
+    # @option opts [Integer] :request_limit Number of results to include, defaults to 100
+    # @option opts [Integer] :request_offset Page offset, defaults to 0.
+    # @option opts [Array<Integer>] :request_package_ids A list of the packages IDs to filter by.
+    # @option opts [BOOLEAN] :request_sell_online When &#x60;true&#x60;, only returns products that can be sold online.&lt;br /&gt;  When &#x60;false&#x60;, all products are returned.&lt;br /&gt;  Default: **false**
+    # @return [Array<(GetPackagesResponse, Fixnum, Hash)>] GetPackagesResponse data, response status code and response headers
+    def sale_get_packages_with_http_info(site_id, version, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SaleApi.sale_get_packages ...'
+      end
+      # verify the required parameter 'site_id' is set
+      if @api_client.config.client_side_validation && site_id.nil?
+        fail ArgumentError, "Missing the required parameter 'site_id' when calling SaleApi.sale_get_packages"
+      end
+      # verify the required parameter 'version' is set
+      if @api_client.config.client_side_validation && version.nil?
+        fail ArgumentError, "Missing the required parameter 'version' when calling SaleApi.sale_get_packages"
+      end
+      # resource path
+      local_var_path = '/public/v{version}/sale/packages'.sub('{' + 'version' + '}', version.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'request.limit'] = opts[:'request_limit'] if !opts[:'request_limit'].nil?
+      query_params[:'request.offset'] = opts[:'request_offset'] if !opts[:'request_offset'].nil?
+      query_params[:'request.packageIds'] = @api_client.build_collection_param(opts[:'request_package_ids'], :multi) if !opts[:'request_package_ids'].nil?
+      query_params[:'request.sellOnline'] = opts[:'request_sell_online'] if !opts[:'request_sell_online'].nil?
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml', 'multipart/form-data'])
+      header_params[:'siteId'] = site_id
+      header_params[:'authorization'] = opts[:'authorization'] if !opts[:'authorization'].nil?
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'GetPackagesResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SaleApi#sale_get_packages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Get retail products available for purchase at a site.
+    # @param site_id ID of the site from which to pull data.
+    # @param version 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :authorization A staff user authorization token. (default to )
+    # @option opts [Array<Integer>] :request_category_ids A list of category IDs to filter by.
+    # @option opts [Integer] :request_limit Number of results to include, defaults to 100
+    # @option opts [Integer] :request_location_id The location ID to use to determine the tax for the products that this request returns.&lt;br /&gt;  Default: **online store**
+    # @option opts [Integer] :request_offset Page offset, defaults to 0.
+    # @option opts [Array<String>] :request_product_ids An ID filter for products.
+    # @option opts [String] :request_search_text A search filter, used for searching by term.
+    # @option opts [BOOLEAN] :request_sell_online When &#x60;true&#x60;, only products that can be sold online are returned.&lt;br /&gt;  When &#x60;false&#x60;, all products are returned.&lt;br /&gt;  Default: **false**
+    # @option opts [Array<Integer>] :request_sub_category_ids A list of subcategory IDs to filter by.
+    # @return [GetProductsResponse]
+    def sale_get_products(site_id, version, opts = {})
+      data, _status_code, _headers = sale_get_products_with_http_info(site_id, version, opts)
+      data
+    end
+
+    # Get retail products available for purchase at a site.
+    # @param site_id ID of the site from which to pull data.
+    # @param version 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :authorization A staff user authorization token.
+    # @option opts [Array<Integer>] :request_category_ids A list of category IDs to filter by.
+    # @option opts [Integer] :request_limit Number of results to include, defaults to 100
+    # @option opts [Integer] :request_location_id The location ID to use to determine the tax for the products that this request returns.&lt;br /&gt;  Default: **online store**
+    # @option opts [Integer] :request_offset Page offset, defaults to 0.
+    # @option opts [Array<String>] :request_product_ids An ID filter for products.
+    # @option opts [String] :request_search_text A search filter, used for searching by term.
+    # @option opts [BOOLEAN] :request_sell_online When &#x60;true&#x60;, only products that can be sold online are returned.&lt;br /&gt;  When &#x60;false&#x60;, all products are returned.&lt;br /&gt;  Default: **false**
+    # @option opts [Array<Integer>] :request_sub_category_ids A list of subcategory IDs to filter by.
+    # @return [Array<(GetProductsResponse, Fixnum, Hash)>] GetProductsResponse data, response status code and response headers
+    def sale_get_products_with_http_info(site_id, version, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SaleApi.sale_get_products ...'
+      end
+      # verify the required parameter 'site_id' is set
+      if @api_client.config.client_side_validation && site_id.nil?
+        fail ArgumentError, "Missing the required parameter 'site_id' when calling SaleApi.sale_get_products"
+      end
+      # verify the required parameter 'version' is set
+      if @api_client.config.client_side_validation && version.nil?
+        fail ArgumentError, "Missing the required parameter 'version' when calling SaleApi.sale_get_products"
+      end
+      # resource path
+      local_var_path = '/public/v{version}/sale/products'.sub('{' + 'version' + '}', version.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'request.categoryIds'] = @api_client.build_collection_param(opts[:'request_category_ids'], :multi) if !opts[:'request_category_ids'].nil?
+      query_params[:'request.limit'] = opts[:'request_limit'] if !opts[:'request_limit'].nil?
+      query_params[:'request.locationId'] = opts[:'request_location_id'] if !opts[:'request_location_id'].nil?
+      query_params[:'request.offset'] = opts[:'request_offset'] if !opts[:'request_offset'].nil?
+      query_params[:'request.productIds'] = @api_client.build_collection_param(opts[:'request_product_ids'], :multi) if !opts[:'request_product_ids'].nil?
+      query_params[:'request.searchText'] = opts[:'request_search_text'] if !opts[:'request_search_text'].nil?
+      query_params[:'request.sellOnline'] = opts[:'request_sell_online'] if !opts[:'request_sell_online'].nil?
+      query_params[:'request.subCategoryIds'] = @api_client.build_collection_param(opts[:'request_sub_category_ids'], :multi) if !opts[:'request_sub_category_ids'].nil?
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml', 'multipart/form-data'])
+      header_params[:'siteId'] = site_id
+      header_params[:'authorization'] = opts[:'authorization'] if !opts[:'authorization'].nil?
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'GetProductsResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SaleApi#sale_get_products\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Get sales completed at a site.
+    # @param site_id ID of the site from which to pull data.
+    # @param version 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :authorization A staff user authorization token. (default to )
+    # @return [GetSalesResponse]
+    def sale_get_sales(site_id, version, opts = {})
+      data, _status_code, _headers = sale_get_sales_with_http_info(site_id, version, opts)
+      data
+    end
+
+    # Get sales completed at a site.
+    # @param site_id ID of the site from which to pull data.
+    # @param version 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :authorization A staff user authorization token.
+    # @return [Array<(GetSalesResponse, Fixnum, Hash)>] GetSalesResponse data, response status code and response headers
+    def sale_get_sales_with_http_info(site_id, version, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SaleApi.sale_get_sales ...'
+      end
+      # verify the required parameter 'site_id' is set
+      if @api_client.config.client_side_validation && site_id.nil?
+        fail ArgumentError, "Missing the required parameter 'site_id' when calling SaleApi.sale_get_sales"
+      end
+      # verify the required parameter 'version' is set
+      if @api_client.config.client_side_validation && version.nil?
+        fail ArgumentError, "Missing the required parameter 'version' when calling SaleApi.sale_get_sales"
+      end
+      # resource path
+      local_var_path = '/public/v{version}/sale/sales'.sub('{' + 'version' + '}', version.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml', 'multipart/form-data'])
+      header_params[:'siteId'] = site_id
+      header_params[:'authorization'] = opts[:'authorization'] if !opts[:'authorization'].nil?
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'GetSalesResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SaleApi#sale_get_sales\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Get pricing options available for purchase at a site
+    # @param site_id ID of the site from which to pull data.
+    # @param version 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :authorization A staff user authorization token. (default to )
+    # @option opts [Integer] :request_class_id Filters to the pricing options for the specified class ID.
+    # @option opts [Integer] :request_class_schedule_id Filters to the pricing options for the specified class schedule ID.
+    # @option opts [BOOLEAN] :request_hide_related_programs When &#x60;true&#x60;, indicates that pricing options of related programs are omitted from the response.&lt;br /&gt;  Default: **false**
+    # @option opts [Integer] :request_limit Number of results to include, defaults to 100
+    # @option opts [Integer] :request_location_id When specified, for each returned pricing option, &#x60;TaxRate&#x60; and &#x60;TaxIncluded&#x60; are calculated according to the specified location. Note that this does not filter results to only services provided at the given location, and for locations where Value-Added Tax (VAT) rules apply, the &#x60;TaxRate&#x60; is set to zero.
+    # @option opts [Integer] :request_offset Page offset, defaults to 0.
+    # @option opts [Array<Integer>] :request_program_ids Filters to pricing options with the specified program IDs.
+    # @option opts [BOOLEAN] :request_sell_online When &#x60;true&#x60;, filters to the pricing options that can be sold online.&lt;br /&gt;  Default: **false**
+    # @option opts [Array<String>] :request_service_ids Filters to the pricing options with the specified IDs. In this context, service and pricing option are used interchangeably.
+    # @option opts [Array<Integer>] :request_session_type_ids Filters to the pricing options with the specified session types IDs.
+    # @option opts [Integer] :request_staff_id Sets &#x60;Price&#x60; and &#x60;OnlinePrice&#x60; to the particular pricing of a specific staff member, if allowed by the business.
+    # @return [GetServicesResponse]
+    def sale_get_services(site_id, version, opts = {})
+      data, _status_code, _headers = sale_get_services_with_http_info(site_id, version, opts)
+      data
+    end
+
+    # Get pricing options available for purchase at a site
+    # @param site_id ID of the site from which to pull data.
+    # @param version 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :authorization A staff user authorization token.
+    # @option opts [Integer] :request_class_id Filters to the pricing options for the specified class ID.
+    # @option opts [Integer] :request_class_schedule_id Filters to the pricing options for the specified class schedule ID.
+    # @option opts [BOOLEAN] :request_hide_related_programs When &#x60;true&#x60;, indicates that pricing options of related programs are omitted from the response.&lt;br /&gt;  Default: **false**
+    # @option opts [Integer] :request_limit Number of results to include, defaults to 100
+    # @option opts [Integer] :request_location_id When specified, for each returned pricing option, &#x60;TaxRate&#x60; and &#x60;TaxIncluded&#x60; are calculated according to the specified location. Note that this does not filter results to only services provided at the given location, and for locations where Value-Added Tax (VAT) rules apply, the &#x60;TaxRate&#x60; is set to zero.
+    # @option opts [Integer] :request_offset Page offset, defaults to 0.
+    # @option opts [Array<Integer>] :request_program_ids Filters to pricing options with the specified program IDs.
+    # @option opts [BOOLEAN] :request_sell_online When &#x60;true&#x60;, filters to the pricing options that can be sold online.&lt;br /&gt;  Default: **false**
+    # @option opts [Array<String>] :request_service_ids Filters to the pricing options with the specified IDs. In this context, service and pricing option are used interchangeably.
+    # @option opts [Array<Integer>] :request_session_type_ids Filters to the pricing options with the specified session types IDs.
+    # @option opts [Integer] :request_staff_id Sets &#x60;Price&#x60; and &#x60;OnlinePrice&#x60; to the particular pricing of a specific staff member, if allowed by the business.
+    # @return [Array<(GetServicesResponse, Fixnum, Hash)>] GetServicesResponse data, response status code and response headers
+    def sale_get_services_with_http_info(site_id, version, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SaleApi.sale_get_services ...'
+      end
+      # verify the required parameter 'site_id' is set
+      if @api_client.config.client_side_validation && site_id.nil?
+        fail ArgumentError, "Missing the required parameter 'site_id' when calling SaleApi.sale_get_services"
+      end
+      # verify the required parameter 'version' is set
+      if @api_client.config.client_side_validation && version.nil?
+        fail ArgumentError, "Missing the required parameter 'version' when calling SaleApi.sale_get_services"
+      end
+      # resource path
+      local_var_path = '/public/v{version}/sale/services'.sub('{' + 'version' + '}', version.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'request.classId'] = opts[:'request_class_id'] if !opts[:'request_class_id'].nil?
+      query_params[:'request.classScheduleId'] = opts[:'request_class_schedule_id'] if !opts[:'request_class_schedule_id'].nil?
+      query_params[:'request.hideRelatedPrograms'] = opts[:'request_hide_related_programs'] if !opts[:'request_hide_related_programs'].nil?
+      query_params[:'request.limit'] = opts[:'request_limit'] if !opts[:'request_limit'].nil?
+      query_params[:'request.locationId'] = opts[:'request_location_id'] if !opts[:'request_location_id'].nil?
+      query_params[:'request.offset'] = opts[:'request_offset'] if !opts[:'request_offset'].nil?
+      query_params[:'request.programIds'] = @api_client.build_collection_param(opts[:'request_program_ids'], :multi) if !opts[:'request_program_ids'].nil?
+      query_params[:'request.sellOnline'] = opts[:'request_sell_online'] if !opts[:'request_sell_online'].nil?
+      query_params[:'request.serviceIds'] = @api_client.build_collection_param(opts[:'request_service_ids'], :multi) if !opts[:'request_service_ids'].nil?
+      query_params[:'request.sessionTypeIds'] = @api_client.build_collection_param(opts[:'request_session_type_ids'], :multi) if !opts[:'request_session_type_ids'].nil?
+      query_params[:'request.staffId'] = opts[:'request_staff_id'] if !opts[:'request_staff_id'].nil?
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml', 'multipart/form-data'])
+      header_params[:'siteId'] = site_id
+      header_params[:'authorization'] = opts[:'authorization'] if !opts[:'authorization'].nil?
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'GetServicesResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SaleApi#sale_get_services\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Purchase a contract for a client.
+    # Allows a client to sign up for a contract or autopay using the information returned from the `GET Contracts` endpoint. The client can pay with a new credit card or with a stored credit card. The client must exist at the site specified before this call is made.    This endpoint allows a developer to specify whether a client pays now or pays on the `StartDate`.If you are building a client-facing experience, you should talk with the business owner to understand the owner’s policies before you give clients a choice of the two payment types.
+    # @param request 
+    # @param site_id ID of the site from which to pull data.
+    # @param version 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :authorization A staff user authorization token. (default to )
+    # @return [PurchaseContractResponse]
+    def sale_purchase_contract(request, site_id, version, opts = {})
+      data, _status_code, _headers = sale_purchase_contract_with_http_info(request, site_id, version, opts)
+      data
+    end
+
+    # Purchase a contract for a client.
+    # Allows a client to sign up for a contract or autopay using the information returned from the &#x60;GET Contracts&#x60; endpoint. The client can pay with a new credit card or with a stored credit card. The client must exist at the site specified before this call is made.    This endpoint allows a developer to specify whether a client pays now or pays on the &#x60;StartDate&#x60;.If you are building a client-facing experience, you should talk with the business owner to understand the owner’s policies before you give clients a choice of the two payment types.
+    # @param request 
+    # @param site_id ID of the site from which to pull data.
+    # @param version 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :authorization A staff user authorization token.
+    # @return [Array<(PurchaseContractResponse, Fixnum, Hash)>] PurchaseContractResponse data, response status code and response headers
+    def sale_purchase_contract_with_http_info(request, site_id, version, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SaleApi.sale_purchase_contract ...'
+      end
+      # verify the required parameter 'request' is set
+      if @api_client.config.client_side_validation && request.nil?
+        fail ArgumentError, "Missing the required parameter 'request' when calling SaleApi.sale_purchase_contract"
+      end
+      # verify the required parameter 'site_id' is set
+      if @api_client.config.client_side_validation && site_id.nil?
+        fail ArgumentError, "Missing the required parameter 'site_id' when calling SaleApi.sale_purchase_contract"
+      end
+      # verify the required parameter 'version' is set
+      if @api_client.config.client_side_validation && version.nil?
+        fail ArgumentError, "Missing the required parameter 'version' when calling SaleApi.sale_purchase_contract"
+      end
+      # resource path
+      local_var_path = '/public/v{version}/sale/purchasecontract'.sub('{' + 'version' + '}', version.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml', 'multipart/form-data'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded', 'multipart/form-data'])
+      header_params[:'siteId'] = site_id
+      header_params[:'authorization'] = opts[:'authorization'] if !opts[:'authorization'].nil?
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(request)
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'PurchaseContractResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SaleApi#sale_purchase_contract\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Purchase a gift card for a client.
+    # Allows a client to purchase a gift card from a business in a variety of designs. The card can be emailed to the recipient on a specific day, and a card title and a personal message can be added.
+    # @param request 
+    # @param site_id ID of the site from which to pull data.
+    # @param version 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :authorization A staff user authorization token. (default to )
+    # @return [PurchaseGiftCardResponse]
+    def sale_purchase_gift_card(request, site_id, version, opts = {})
+      data, _status_code, _headers = sale_purchase_gift_card_with_http_info(request, site_id, version, opts)
+      data
+    end
+
+    # Purchase a gift card for a client.
+    # Allows a client to purchase a gift card from a business in a variety of designs. The card can be emailed to the recipient on a specific day, and a card title and a personal message can be added.
+    # @param request 
+    # @param site_id ID of the site from which to pull data.
+    # @param version 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :authorization A staff user authorization token.
+    # @return [Array<(PurchaseGiftCardResponse, Fixnum, Hash)>] PurchaseGiftCardResponse data, response status code and response headers
+    def sale_purchase_gift_card_with_http_info(request, site_id, version, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SaleApi.sale_purchase_gift_card ...'
+      end
+      # verify the required parameter 'request' is set
+      if @api_client.config.client_side_validation && request.nil?
+        fail ArgumentError, "Missing the required parameter 'request' when calling SaleApi.sale_purchase_gift_card"
+      end
+      # verify the required parameter 'site_id' is set
+      if @api_client.config.client_side_validation && site_id.nil?
+        fail ArgumentError, "Missing the required parameter 'site_id' when calling SaleApi.sale_purchase_gift_card"
+      end
+      # verify the required parameter 'version' is set
+      if @api_client.config.client_side_validation && version.nil?
+        fail ArgumentError, "Missing the required parameter 'version' when calling SaleApi.sale_purchase_gift_card"
+      end
+      # resource path
+      local_var_path = '/public/v{version}/sale/purchasegiftcard'.sub('{' + 'version' + '}', version.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml', 'multipart/form-data'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded', 'multipart/form-data'])
+      header_params[:'siteId'] = site_id
+      header_params[:'authorization'] = opts[:'authorization'] if !opts[:'authorization'].nil?
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(request)
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'PurchaseGiftCardResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SaleApi#sale_purchase_gift_card\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end