mb-apimatic-sdk 1.0.0

data/lib/mindbody_public_api/controllers/cross_site_controller.rb

@@ -0,0 +1,43 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module MindbodyPublicApi
+  # CrossSiteController
+  class CrossSiteController < BaseController
+    # Copies the credit card information from one client to another, regardless
+    # of site.
+    # The source and target clients must have the same email address.
+    # @param [String] version Required parameter: version of the api.
+    # @param [CopyCreditCardRequest] request Required parameter: TODO: type
+    # description here
+    # @param [String] site_id Required parameter: ID of the site from which to
+    # pull data.
+    # @param [String] authorization Optional parameter: A staff user
+    # authorization token.
+    # @return [CopyCreditCardResponse] Response from the API call.
+    def copy_credit_card(version,
+                         request,
+                         site_id,
+                         authorization: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/public/v{version}/crossSite/copycreditcard',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(version, key: 'version')
+                                    .should_encode(true))
+                   .body_param(new_parameter(request))
+                   .header_param(new_parameter(site_id, key: 'siteId'))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .header_param(new_parameter(authorization, key: 'authorization'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('API-Key')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(CopyCreditCardResponse.method(:from_hash)))
+        .execute
+    end
+  end
+end

data/lib/mindbody_public_api/controllers/enrollment_controller.rb

@@ -0,0 +1,188 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module MindbodyPublicApi
+  # EnrollmentController
+  class EnrollmentController < BaseController
+    # 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.
+    # 
+    # When a user token is not passed with the request or the passed user token
+    # has insufficient viewing permissions, only the following staff data is
+    # returned in the response:
+    # 
+    # * FirstName
+    # * LastName
+    # * Id
+    # * Bio
+    # * DisplayName
+    # * ImageUrl
+    # @param [String] version Required parameter: version of the api.
+    # @param [String] site_id Required parameter: ID of the site from which to
+    # pull data.
+    # @param [String] authorization Optional parameter: A staff user
+    # authorization token.
+    # @param [Array[Integer]] request_class_schedule_ids Optional parameter: A
+    # list of the requested class schedule IDs. If omitted, all class schedule
+    # IDs return.
+    # @param [DateTime] request_end_date Optional parameter: The end of the date
+    # range. The response returns any active enrollments that occur on or before
+    # this day.<br />  Default: **StartDate**
+    # @param [Integer] request_limit Optional parameter: Number of results to
+    # include, defaults to 100
+    # @param [Array[Integer]] request_location_ids Optional parameter: List of
+    # the IDs for the requested locations. If omitted, all location IDs
+    # return.
+    # @param [Integer] request_offset Optional parameter: Page offset, defaults
+    # to 0.
+    # @param [Array[Integer]] request_program_ids Optional parameter: List of
+    # the IDs for the requested programs. If omitted, all program IDs return.
+    # @param [Array[Integer]] request_session_type_ids Optional parameter: List
+    # of the IDs for the requested session types. If omitted, all session types
+    # IDs return.
+    # @param [Array[Integer]] request_staff_ids Optional parameter: List of the
+    # IDs for the requested staff IDs. If omitted, all staff IDs return.
+    # @param [DateTime] request_start_date Optional parameter: The start of the
+    # date range. The response returns any active enrollments that occur on or
+    # after this day.<br />  Default: **today’s date**
+    # @return [GetEnrollmentsResponse] Response from the API call.
+    def get_enrollments(version,
+                        site_id,
+                        authorization: nil,
+                        request_class_schedule_ids: nil,
+                        request_end_date: nil,
+                        request_limit: nil,
+                        request_location_ids: nil,
+                        request_offset: nil,
+                        request_program_ids: nil,
+                        request_session_type_ids: nil,
+                        request_staff_ids: nil,
+                        request_start_date: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/public/v{version}/enrollment/enrollments',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(version, key: 'version')
+                                    .should_encode(true))
+                   .header_param(new_parameter(site_id, key: 'siteId'))
+                   .header_param(new_parameter(authorization, key: 'authorization'))
+                   .query_param(new_parameter(request_class_schedule_ids, key: 'request.classScheduleIds'))
+                   .query_param(new_parameter(request_end_date, key: 'request.endDate'))
+                   .query_param(new_parameter(request_limit, key: 'request.limit'))
+                   .query_param(new_parameter(request_location_ids, key: 'request.locationIds'))
+                   .query_param(new_parameter(request_offset, key: 'request.offset'))
+                   .query_param(new_parameter(request_program_ids, key: 'request.programIds'))
+                   .query_param(new_parameter(request_session_type_ids, key: 'request.sessionTypeIds'))
+                   .query_param(new_parameter(request_staff_ids, key: 'request.staffIds'))
+                   .query_param(new_parameter(request_start_date, key: 'request.startDate'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('API-Key')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(GetEnrollmentsResponse.method(:from_hash)))
+        .execute
+    end
+
+    # Book a client into an enrollment.
+    # @param [String] version Required parameter: version of the api.
+    # @param [AddClientToEnrollmentRequest] request Required parameter: TODO:
+    # type description here
+    # @param [String] site_id Required parameter: ID of the site from which to
+    # pull data.
+    # @param [String] authorization Optional parameter: A staff user
+    # authorization token.
+    # @return [ClassSchedule] Response from the API call.
+    def add_client_to_enrollment(version,
+                                 request,
+                                 site_id,
+                                 authorization: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/public/v{version}/enrollment/addclienttoenrollment',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(version, key: 'version')
+                                    .should_encode(true))
+                   .body_param(new_parameter(request))
+                   .header_param(new_parameter(site_id, key: 'siteId'))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .header_param(new_parameter(authorization, key: 'authorization'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('API-Key')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ClassSchedule.method(:from_hash)))
+        .execute
+    end
+
+    # This endpoint adds a enrollment schedule. You can require clients to sign
+    # up for the entire enrollment schedule or allow them to pick specific
+    # sessions using the AllowOpenEnrollment parameter.
+    # @param [String] version Required parameter: version of the api.
+    # @param [AddClassEnrollmentScheduleRequest] request Required parameter:
+    # TODO: type description here
+    # @param [String] site_id Required parameter: ID of the site from which to
+    # pull data.
+    # @param [String] authorization Optional parameter: A staff user
+    # authorization token.
+    # @return [WrittenClassSchedulesInfo] Response from the API call.
+    def add_enrollment_schedule(version,
+                                request,
+                                site_id,
+                                authorization: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/public/v{version}/enrollment/addenrollmentschedule',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(version, key: 'version')
+                                    .should_encode(true))
+                   .body_param(new_parameter(request))
+                   .header_param(new_parameter(site_id, key: 'siteId'))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .header_param(new_parameter(authorization, key: 'authorization'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('API-Key')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(WrittenClassSchedulesInfo.method(:from_hash)))
+        .execute
+    end
+
+    # This endpoint update a enrollment schedule.
+    # @param [String] version Required parameter: version of the api.
+    # @param [UpdateClassEnrollmentScheduleRequest] request Required parameter:
+    # TODO: type description here
+    # @param [String] site_id Required parameter: ID of the site from which to
+    # pull data.
+    # @param [String] authorization Optional parameter: A staff user
+    # authorization token.
+    # @return [WrittenClassSchedulesInfo] Response from the API call.
+    def update_enrollment_schedule(version,
+                                   request,
+                                   site_id,
+                                   authorization: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/public/v{version}/enrollment/updateenrollmentschedule',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(version, key: 'version')
+                                    .should_encode(true))
+                   .body_param(new_parameter(request))
+                   .header_param(new_parameter(site_id, key: 'siteId'))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .header_param(new_parameter(authorization, key: 'authorization'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('API-Key')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(WrittenClassSchedulesInfo.method(:from_hash)))
+        .execute
+    end
+  end
+end

data/lib/mindbody_public_api/controllers/payroll_controller.rb

@@ -0,0 +1,290 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module MindbodyPublicApi
+  # PayrollController
+  class PayrollController < BaseController
+    # 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.
+    # @param [String] version Required parameter: version of the api.
+    # @param [String] site_id Required parameter: ID of the site from which to
+    # pull data.
+    # @param [String] authorization Optional parameter: A staff user
+    # authorization token.
+    # @param [DateTime] request_end_date_time Optional parameter: 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.
+    # @param [Integer] request_limit Optional parameter: Number of results to
+    # include, defaults to 100
+    # @param [Integer] request_location_id Optional parameter: A LocationId that
+    # you want to retrieve payroll information for. If you do not supply a
+    # `LocationId`, data from all locations is returned.
+    # @param [Integer] request_offset Optional parameter: Page offset, defaults
+    # to 0.
+    # @param [Integer] request_staff_id Optional parameter: 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.
+    # @param [DateTime] request_start_date_time Optional parameter: 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 [GetCommissionsResponse] Response from the API call.
+    def get_commissions(version,
+                        site_id,
+                        authorization: nil,
+                        request_end_date_time: nil,
+                        request_limit: nil,
+                        request_location_id: nil,
+                        request_offset: nil,
+                        request_staff_id: nil,
+                        request_start_date_time: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/public/v{version}/payroll/commissions',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(version, key: 'version')
+                                    .should_encode(true))
+                   .header_param(new_parameter(site_id, key: 'siteId'))
+                   .header_param(new_parameter(authorization, key: 'authorization'))
+                   .query_param(new_parameter(request_end_date_time, key: 'request.endDateTime'))
+                   .query_param(new_parameter(request_limit, key: 'request.limit'))
+                   .query_param(new_parameter(request_location_id, key: 'request.locationId'))
+                   .query_param(new_parameter(request_offset, key: 'request.offset'))
+                   .query_param(new_parameter(request_staff_id, key: 'request.staffId'))
+                   .query_param(new_parameter(request_start_date_time, key: 'request.startDateTime'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('API-Key')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(GetCommissionsResponse.method(:from_hash)))
+        .execute
+    end
+
+    # 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 [String] version Required parameter: version of the api.
+    # @param [String] site_id Required parameter: ID of the site from which to
+    # pull data.
+    # @param [String] authorization Optional parameter: A staff user
+    # authorization token.
+    # @param [DateTime] request_end_date_time Optional parameter: 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.
+    # @param [Integer] request_limit Optional parameter: Number of results to
+    # include, defaults to 100
+    # @param [Integer] request_location_id Optional parameter: A LocationId that
+    # you want to retrieve payroll information for. If you do not supply a
+    # `LocationId`, data from all locations is returned.
+    # @param [Integer] request_offset Optional parameter: Page offset, defaults
+    # to 0.
+    # @param [Integer] request_scheduled_service_id Optional parameter: Filters
+    # the results to a single scheduled service. This parameter must be used
+    # with a single ScheduledServiceType.
+    # @param [String] request_scheduled_service_type Optional parameter: Filters
+    # the results to schedule service earnings for specific types of services.
+    # Possible values:  * Class  * Appointment
+    # @param [Integer] request_staff_id Optional parameter: 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.
+    # @param [DateTime] request_start_date_time Optional parameter: 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 [GetScheduledServiceEarningsResponse] Response from the API call.
+    def get_scheduled_service_earnings(version,
+                                       site_id,
+                                       authorization: nil,
+                                       request_end_date_time: nil,
+                                       request_limit: nil,
+                                       request_location_id: nil,
+                                       request_offset: nil,
+                                       request_scheduled_service_id: nil,
+                                       request_scheduled_service_type: nil,
+                                       request_staff_id: nil,
+                                       request_start_date_time: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/public/v{version}/payroll/scheduledserviceearnings',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(version, key: 'version')
+                                    .should_encode(true))
+                   .header_param(new_parameter(site_id, key: 'siteId'))
+                   .header_param(new_parameter(authorization, key: 'authorization'))
+                   .query_param(new_parameter(request_end_date_time, key: 'request.endDateTime'))
+                   .query_param(new_parameter(request_limit, key: 'request.limit'))
+                   .query_param(new_parameter(request_location_id, key: 'request.locationId'))
+                   .query_param(new_parameter(request_offset, key: 'request.offset'))
+                   .query_param(new_parameter(request_scheduled_service_id, key: 'request.scheduledServiceId'))
+                   .query_param(new_parameter(request_scheduled_service_type, key: 'request.scheduledServiceType'))
+                   .query_param(new_parameter(request_staff_id, key: 'request.staffId'))
+                   .query_param(new_parameter(request_start_date_time, key: 'request.startDateTime'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('API-Key')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(GetScheduledServiceEarningsResponse.method(:from_hash)))
+        .execute
+    end
+
+    # This endpoint returns information for all locations. The **View reports
+    # for all locations permission **is not supported for staff auth tokens.
+    # @param [String] version Required parameter: version of the api.
+    # @param [String] site_id Required parameter: ID of the site from which to
+    # pull data.
+    # @param [String] authorization Optional parameter: A staff user
+    # authorization token.
+    # @param [DateTime] request_end_date_time Optional parameter: 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.
+    # @param [Integer] request_limit Optional parameter: Number of results to
+    # include, defaults to 100
+    # @param [Integer] request_location_id Optional parameter: A LocationId that
+    # you want to retrieve payroll information for. If you do not supply a
+    # `LocationId`, data from all locations is returned.
+    # @param [Integer] request_offset Optional parameter: Page offset, defaults
+    # to 0.
+    # @param [Integer] request_staff_id Optional parameter: 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.
+    # @param [DateTime] request_start_date_time Optional parameter: 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 [GetTimeCardsResponse] Response from the API call.
+    def get_time_cards(version,
+                       site_id,
+                       authorization: nil,
+                       request_end_date_time: nil,
+                       request_limit: nil,
+                       request_location_id: nil,
+                       request_offset: nil,
+                       request_staff_id: nil,
+                       request_start_date_time: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/public/v{version}/payroll/timecards',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(version, key: 'version')
+                                    .should_encode(true))
+                   .header_param(new_parameter(site_id, key: 'siteId'))
+                   .header_param(new_parameter(authorization, key: 'authorization'))
+                   .query_param(new_parameter(request_end_date_time, key: 'request.endDateTime'))
+                   .query_param(new_parameter(request_limit, key: 'request.limit'))
+                   .query_param(new_parameter(request_location_id, key: 'request.locationId'))
+                   .query_param(new_parameter(request_offset, key: 'request.offset'))
+                   .query_param(new_parameter(request_staff_id, key: 'request.staffId'))
+                   .query_param(new_parameter(request_start_date_time, key: 'request.startDateTime'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('API-Key')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(GetTimeCardsResponse.method(:from_hash)))
+        .execute
+    end
+
+    # 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.
+    # This endpoint returns information for all locations.The** View reports for
+    # all locations **permission is not supported for staff auth tokens.
+    # @param [String] version Required parameter: version of the api.
+    # @param [String] site_id Required parameter: ID of the site from which to
+    # pull data.
+    # @param [String] authorization Optional parameter: A staff user
+    # authorization token.
+    # @param [DateTime] request_end_date_time Optional parameter: 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.
+    # @param [Integer] request_limit Optional parameter: Number of results to
+    # include, defaults to 100
+    # @param [Integer] request_location_id Optional parameter: A LocationId that
+    # you want to retrieve payroll information for. If you do not supply a
+    # `LocationId`, data from all locations is returned.
+    # @param [Integer] request_offset Optional parameter: Page offset, defaults
+    # to 0.
+    # @param [Integer] request_staff_id Optional parameter: 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.
+    # @param [DateTime] request_start_date_time Optional parameter: 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 [GetTipsResponse] Response from the API call.
+    def get_tips(version,
+                 site_id,
+                 authorization: nil,
+                 request_end_date_time: nil,
+                 request_limit: nil,
+                 request_location_id: nil,
+                 request_offset: nil,
+                 request_staff_id: nil,
+                 request_start_date_time: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/public/v{version}/payroll/tips',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(version, key: 'version')
+                                    .should_encode(true))
+                   .header_param(new_parameter(site_id, key: 'siteId'))
+                   .header_param(new_parameter(authorization, key: 'authorization'))
+                   .query_param(new_parameter(request_end_date_time, key: 'request.endDateTime'))
+                   .query_param(new_parameter(request_limit, key: 'request.limit'))
+                   .query_param(new_parameter(request_location_id, key: 'request.locationId'))
+                   .query_param(new_parameter(request_offset, key: 'request.offset'))
+                   .query_param(new_parameter(request_staff_id, key: 'request.staffId'))
+                   .query_param(new_parameter(request_start_date_time, key: 'request.startDateTime'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('API-Key')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(GetTipsResponse.method(:from_hash)))
+        .execute
+    end
+  end
+end