square_connect 2.0.2.69 → 2.1.0.beta

data/lib/square_connect/api/v1_employees_api.rb

@@ -0,0 +1,974 @@
+=begin
+#Square Connect API
+
+OpenAPI spec version: 2.0
+Contact: developers@squareup.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+=end
+
+require "uri"
+
+module SquareConnect
+  class V1EmployeesApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    # Creates an employee for a business.
+    # Creates an employee for a business.
+    # @param body An object containing the fields to POST for the request.  See the corresponding object definition for field details.
+    # @param [Hash] opts the optional parameters
+    # @return [V1Employee]
+    def create_employee(body, opts = {})
+      data, _status_code, _headers = create_employee_with_http_info(body, opts)
+      return data
+    end
+
+    # Creates an employee for a business.
+    # Creates an employee for a business.
+    # @param body An object containing the fields to POST for the request.  See the corresponding object definition for field details.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(V1Employee, Fixnum, Hash)>] V1Employee data, response status code and response headers
+    def create_employee_with_http_info(body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: V1EmployeesApi.create_employee ..."
+      end
+      # verify the required parameter 'body' is set
+      fail ArgumentError, "Missing the required parameter 'body' when calling V1EmployeesApi.create_employee" if body.nil?
+      # resource path
+      local_var_path = "/v1/me/employees".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(body)
+      auth_names = ['oauth2']
+      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 => 'V1Employee')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: V1EmployeesApi#create_employee\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Creates an employee role you can then assign to employees.
+    # Creates an employee role you can then assign to employees.
+    # @param employee_role An EmployeeRole object with a name and permissions, and an optional owner flag.
+    # @param [Hash] opts the optional parameters
+    # @return [V1EmployeeRole]
+    def create_employee_role(employee_role, opts = {})
+      data, _status_code, _headers = create_employee_role_with_http_info(employee_role, opts)
+      return data
+    end
+
+    # Creates an employee role you can then assign to employees.
+    # Creates an employee role you can then assign to employees.
+    # @param employee_role An EmployeeRole object with a name and permissions, and an optional owner flag.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(V1EmployeeRole, Fixnum, Hash)>] V1EmployeeRole data, response status code and response headers
+    def create_employee_role_with_http_info(employee_role, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: V1EmployeesApi.create_employee_role ..."
+      end
+      # verify the required parameter 'employee_role' is set
+      fail ArgumentError, "Missing the required parameter 'employee_role' when calling V1EmployeesApi.create_employee_role" if employee_role.nil?
+      # resource path
+      local_var_path = "/v1/me/roles".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(employee_role)
+      auth_names = ['oauth2']
+      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 => 'V1EmployeeRole')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: V1EmployeesApi#create_employee_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Creates a timecard for an employee. Each timecard corresponds to a single shift.
+    # Creates a timecard for an employee. Each timecard corresponds to a single shift.
+    # @param body An object containing the fields to POST for the request.  See the corresponding object definition for field details.
+    # @param [Hash] opts the optional parameters
+    # @return [V1Timecard]
+    def create_timecard(body, opts = {})
+      data, _status_code, _headers = create_timecard_with_http_info(body, opts)
+      return data
+    end
+
+    # Creates a timecard for an employee. Each timecard corresponds to a single shift.
+    # Creates a timecard for an employee. Each timecard corresponds to a single shift.
+    # @param body An object containing the fields to POST for the request.  See the corresponding object definition for field details.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(V1Timecard, Fixnum, Hash)>] V1Timecard data, response status code and response headers
+    def create_timecard_with_http_info(body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: V1EmployeesApi.create_timecard ..."
+      end
+      # verify the required parameter 'body' is set
+      fail ArgumentError, "Missing the required parameter 'body' when calling V1EmployeesApi.create_timecard" if body.nil?
+      # resource path
+      local_var_path = "/v1/me/timecards".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(body)
+      auth_names = ['oauth2']
+      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 => 'V1Timecard')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: V1EmployeesApi#create_timecard\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Deletes a timecard. Deleted timecards are still accessible from Connect API endpoints, but the value of their deleted field is set to true. See Handling deleted timecards for more information.
+    # Deletes a timecard. Deleted timecards are still accessible from Connect API endpoints, but the value of their deleted field is set to true. See Handling deleted timecards for more information.
+    # @param timecard_id The ID of the timecard to delete.
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def delete_timecard(timecard_id, opts = {})
+      data, _status_code, _headers = delete_timecard_with_http_info(timecard_id, opts)
+      return data
+    end
+
+    # Deletes a timecard. Deleted timecards are still accessible from Connect API endpoints, but the value of their deleted field is set to true. See Handling deleted timecards for more information.
+    # Deletes a timecard. Deleted timecards are still accessible from Connect API endpoints, but the value of their deleted field is set to true. See Handling deleted timecards for more information.
+    # @param timecard_id The ID of the timecard to delete.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
+    def delete_timecard_with_http_info(timecard_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: V1EmployeesApi.delete_timecard ..."
+      end
+      # verify the required parameter 'timecard_id' is set
+      fail ArgumentError, "Missing the required parameter 'timecard_id' when calling V1EmployeesApi.delete_timecard" if timecard_id.nil?
+      # resource path
+      local_var_path = "/v1/me/timecards/{timecard_id}".sub('{format}','json').sub('{' + 'timecard_id' + '}', timecard_id.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'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['oauth2']
+      data, status_code, headers = @api_client.call_api(:DELETE, 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: V1EmployeesApi#delete_timecard\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Provides the details for all of a location's cash drawer shifts during a date range. The date range you specify cannot exceed 90 days.
+    # Provides the details for all of a location's cash drawer shifts during a date range. The date range you specify cannot exceed 90 days.
+    # @param location_id The ID of the location to list cash drawer shifts for.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :order The order in which cash drawer shifts are listed in the response, based on their created_at field. Default value: ASC
+    # @option opts [String] :begin_time The beginning of the requested reporting period, in ISO 8601 format. Default value: The current time minus 90 days.
+    # @option opts [String] :end_time The beginning of the requested reporting period, in ISO 8601 format. Default value: The current time.
+    # @return [Array<V1CashDrawerShift>]
+    def list_cash_drawer_shifts(location_id, opts = {})
+      data, _status_code, _headers = list_cash_drawer_shifts_with_http_info(location_id, opts)
+      return data
+    end
+
+    # Provides the details for all of a location&#39;s cash drawer shifts during a date range. The date range you specify cannot exceed 90 days.
+    # Provides the details for all of a location&#39;s cash drawer shifts during a date range. The date range you specify cannot exceed 90 days.
+    # @param location_id The ID of the location to list cash drawer shifts for.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :order The order in which cash drawer shifts are listed in the response, based on their created_at field. Default value: ASC
+    # @option opts [String] :begin_time The beginning of the requested reporting period, in ISO 8601 format. Default value: The current time minus 90 days.
+    # @option opts [String] :end_time The beginning of the requested reporting period, in ISO 8601 format. Default value: The current time.
+    # @return [Array<(Array<V1CashDrawerShift>, Fixnum, Hash)>] Array<V1CashDrawerShift> data, response status code and response headers
+    def list_cash_drawer_shifts_with_http_info(location_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: V1EmployeesApi.list_cash_drawer_shifts ..."
+      end
+      # verify the required parameter 'location_id' is set
+      fail ArgumentError, "Missing the required parameter 'location_id' when calling V1EmployeesApi.list_cash_drawer_shifts" if location_id.nil?
+      if opts[:'order'] && !['ASC', 'DESC'].include?(opts[:'order'])
+        fail ArgumentError, 'invalid value for "order", must be one of ASC, DESC'
+      end
+      # resource path
+      local_var_path = "/v1/{location_id}/cash-drawer-shifts".sub('{format}','json').sub('{' + 'location_id' + '}', location_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
+      query_params[:'begin_time'] = opts[:'begin_time'] if !opts[:'begin_time'].nil?
+      query_params[:'end_time'] = opts[:'end_time'] if !opts[:'end_time'].nil?
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['oauth2']
+      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<V1CashDrawerShift>')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: V1EmployeesApi#list_cash_drawer_shifts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Provides summary information for all of a business's employee roles.
+    # Provides summary information for all of a business's employee roles.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :order The order in which employees are listed in the response, based on their created_at field.Default value: ASC 
+    # @option opts [Integer] :limit The maximum integer number of employee entities to return in a single response. Default 100, maximum 200.
+    # @option opts [String] :cursor A pagination cursor to retrieve the next set of results for your original query to the endpoint.
+    # @return [Array<V1EmployeeRole>]
+    def list_employee_roles(opts = {})
+      data, _status_code, _headers = list_employee_roles_with_http_info(opts)
+      return data
+    end
+
+    # Provides summary information for all of a business&#39;s employee roles.
+    # Provides summary information for all of a business&#39;s employee roles.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :order The order in which employees are listed in the response, based on their created_at field.Default value: ASC 
+    # @option opts [Integer] :limit The maximum integer number of employee entities to return in a single response. Default 100, maximum 200.
+    # @option opts [String] :cursor A pagination cursor to retrieve the next set of results for your original query to the endpoint.
+    # @return [Array<(Array<V1EmployeeRole>, Fixnum, Hash)>] Array<V1EmployeeRole> data, response status code and response headers
+    def list_employee_roles_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: V1EmployeesApi.list_employee_roles ..."
+      end
+      if opts[:'order'] && !['ASC', 'DESC'].include?(opts[:'order'])
+        fail ArgumentError, 'invalid value for "order", must be one of ASC, DESC'
+      end
+      if !opts[:'limit'].nil? && opts[:'limit'] > 200
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling V1EmployeesApi.list_employee_roles, must be smaller than or equal to 200.'
+      end
+
+      # resource path
+      local_var_path = "/v1/me/roles".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+      query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['oauth2']
+      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<V1EmployeeRole>')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: V1EmployeesApi#list_employee_roles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Provides summary information for all of a business's employees.
+    # Provides summary information for all of a business's employees.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :order The order in which employees are listed in the response, based on their created_at field.      Default value: ASC 
+    # @option opts [String] :begin_updated_at If filtering results by their updated_at field, the beginning of the requested reporting period, in ISO 8601 format
+    # @option opts [String] :end_updated_at If filtering results by there updated_at field, the end of the requested reporting period, in ISO 8601 format.
+    # @option opts [String] :begin_created_at If filtering results by their created_at field, the beginning of the requested reporting period, in ISO 8601 format.
+    # @option opts [String] :end_created_at If filtering results by their created_at field, the end of the requested reporting period, in ISO 8601 format.
+    # @option opts [String] :status If provided, the endpoint returns only employee entities with the specified status (ACTIVE or INACTIVE).
+    # @option opts [String] :external_id If provided, the endpoint returns only employee entities with the specified external_id.
+    # @option opts [Integer] :limit The maximum integer number of employee entities to return in a single response. Default 100, maximum 200.
+    # @return [Array<V1Employee>]
+    def list_employees(opts = {})
+      data, _status_code, _headers = list_employees_with_http_info(opts)
+      return data
+    end
+
+    # Provides summary information for all of a business&#39;s employees.
+    # Provides summary information for all of a business&#39;s employees.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :order The order in which employees are listed in the response, based on their created_at field.      Default value: ASC 
+    # @option opts [String] :begin_updated_at If filtering results by their updated_at field, the beginning of the requested reporting period, in ISO 8601 format
+    # @option opts [String] :end_updated_at If filtering results by there updated_at field, the end of the requested reporting period, in ISO 8601 format.
+    # @option opts [String] :begin_created_at If filtering results by their created_at field, the beginning of the requested reporting period, in ISO 8601 format.
+    # @option opts [String] :end_created_at If filtering results by their created_at field, the end of the requested reporting period, in ISO 8601 format.
+    # @option opts [String] :status If provided, the endpoint returns only employee entities with the specified status (ACTIVE or INACTIVE).
+    # @option opts [String] :external_id If provided, the endpoint returns only employee entities with the specified external_id.
+    # @option opts [Integer] :limit The maximum integer number of employee entities to return in a single response. Default 100, maximum 200.
+    # @return [Array<(Array<V1Employee>, Fixnum, Hash)>] Array<V1Employee> data, response status code and response headers
+    def list_employees_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: V1EmployeesApi.list_employees ..."
+      end
+      if opts[:'order'] && !['ASC', 'DESC'].include?(opts[:'order'])
+        fail ArgumentError, 'invalid value for "order", must be one of ASC, DESC'
+      end
+      if opts[:'status'] && !['ACTIVE', 'INACTIVE'].include?(opts[:'status'])
+        fail ArgumentError, 'invalid value for "status", must be one of ACTIVE, INACTIVE'
+      end
+      if !opts[:'limit'].nil? && opts[:'limit'] > 200
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling V1EmployeesApi.list_employees, must be smaller than or equal to 200.'
+      end
+
+      # resource path
+      local_var_path = "/v1/me/employees".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+      query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
+      query_params[:'begin_updated_at'] = opts[:'begin_updated_at'] if !opts[:'begin_updated_at'].nil?
+      query_params[:'end_updated_at'] = opts[:'end_updated_at'] if !opts[:'end_updated_at'].nil?
+      query_params[:'begin_created_at'] = opts[:'begin_created_at'] if !opts[:'begin_created_at'].nil?
+      query_params[:'end_created_at'] = opts[:'end_created_at'] if !opts[:'end_created_at'].nil?
+      query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
+      query_params[:'external_id'] = opts[:'external_id'] if !opts[:'external_id'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['oauth2']
+      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<V1Employee>')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: V1EmployeesApi#list_employees\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Provides summary information for all events associated with a particular timecard.
+    # Provides summary information for all events associated with a particular timecard.
+    # @param timecard_id The ID of the timecard to list events for.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<V1TimecardEvent>]
+    def list_timecard_events(timecard_id, opts = {})
+      data, _status_code, _headers = list_timecard_events_with_http_info(timecard_id, opts)
+      return data
+    end
+
+    # Provides summary information for all events associated with a particular timecard.
+    # Provides summary information for all events associated with a particular timecard.
+    # @param timecard_id The ID of the timecard to list events for.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<V1TimecardEvent>, Fixnum, Hash)>] Array<V1TimecardEvent> data, response status code and response headers
+    def list_timecard_events_with_http_info(timecard_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: V1EmployeesApi.list_timecard_events ..."
+      end
+      # verify the required parameter 'timecard_id' is set
+      fail ArgumentError, "Missing the required parameter 'timecard_id' when calling V1EmployeesApi.list_timecard_events" if timecard_id.nil?
+      # resource path
+      local_var_path = "/v1/me/timecards/{timecard_id}/events".sub('{format}','json').sub('{' + 'timecard_id' + '}', timecard_id.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'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['oauth2']
+      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<V1TimecardEvent>')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: V1EmployeesApi#list_timecard_events\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Provides summary information for all of a business's employee timecards.
+    # Provides summary information for all of a business's employee timecards.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :order The order in which timecards are listed in the response, based on their created_at field.
+    # @option opts [String] :employee_id If provided, the endpoint returns only timecards for the employee with the specified ID.
+    # @option opts [String] :begin_clockin_time If filtering results by their clockin_time field, the beginning of the requested reporting period, in ISO 8601 format.
+    # @option opts [String] :end_clockin_time If filtering results by their clockin_time field, the end of the requested reporting period, in ISO 8601 format.
+    # @option opts [String] :begin_clockout_time If filtering results by their clockout_time field, the beginning of the requested reporting period, in ISO 8601 format.
+    # @option opts [String] :end_clockout_time If filtering results by their clockout_time field, the end of the requested reporting period, in ISO 8601 format.
+    # @option opts [String] :begin_updated_at If filtering results by their updated_at field, the beginning of the requested reporting period, in ISO 8601 format.
+    # @option opts [String] :end_updated_at If filtering results by their updated_at field, the end of the requested reporting period, in ISO 8601 format.
+    # @option opts [BOOLEAN] :deleted If true, only deleted timecards are returned. If false, only valid timecards are returned.If you don&#39;t provide this parameter, both valid and deleted timecards are returned.
+    # @option opts [Integer] :limit The maximum integer number of employee entities to return in a single response. Default 100, maximum 200.
+    # @option opts [String] :cursor A pagination cursor to retrieve the next set of results for your original query to the endpoint.
+    # @return [Array<V1Timecard>]
+    def list_timecards(opts = {})
+      data, _status_code, _headers = list_timecards_with_http_info(opts)
+      return data
+    end
+
+    # Provides summary information for all of a business&#39;s employee timecards.
+    # Provides summary information for all of a business&#39;s employee timecards.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :order The order in which timecards are listed in the response, based on their created_at field.
+    # @option opts [String] :employee_id If provided, the endpoint returns only timecards for the employee with the specified ID.
+    # @option opts [String] :begin_clockin_time If filtering results by their clockin_time field, the beginning of the requested reporting period, in ISO 8601 format.
+    # @option opts [String] :end_clockin_time If filtering results by their clockin_time field, the end of the requested reporting period, in ISO 8601 format.
+    # @option opts [String] :begin_clockout_time If filtering results by their clockout_time field, the beginning of the requested reporting period, in ISO 8601 format.
+    # @option opts [String] :end_clockout_time If filtering results by their clockout_time field, the end of the requested reporting period, in ISO 8601 format.
+    # @option opts [String] :begin_updated_at If filtering results by their updated_at field, the beginning of the requested reporting period, in ISO 8601 format.
+    # @option opts [String] :end_updated_at If filtering results by their updated_at field, the end of the requested reporting period, in ISO 8601 format.
+    # @option opts [BOOLEAN] :deleted If true, only deleted timecards are returned. If false, only valid timecards are returned.If you don&#39;t provide this parameter, both valid and deleted timecards are returned.
+    # @option opts [Integer] :limit The maximum integer number of employee entities to return in a single response. Default 100, maximum 200.
+    # @option opts [String] :cursor A pagination cursor to retrieve the next set of results for your original query to the endpoint.
+    # @return [Array<(Array<V1Timecard>, Fixnum, Hash)>] Array<V1Timecard> data, response status code and response headers
+    def list_timecards_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: V1EmployeesApi.list_timecards ..."
+      end
+      if opts[:'order'] && !['ASC', 'DESC'].include?(opts[:'order'])
+        fail ArgumentError, 'invalid value for "order", must be one of ASC, DESC'
+      end
+      if !opts[:'limit'].nil? && opts[:'limit'] > 200
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling V1EmployeesApi.list_timecards, must be smaller than or equal to 200.'
+      end
+
+      # resource path
+      local_var_path = "/v1/me/timecards".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+      query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
+      query_params[:'employee_id'] = opts[:'employee_id'] if !opts[:'employee_id'].nil?
+      query_params[:'begin_clockin_time'] = opts[:'begin_clockin_time'] if !opts[:'begin_clockin_time'].nil?
+      query_params[:'end_clockin_time'] = opts[:'end_clockin_time'] if !opts[:'end_clockin_time'].nil?
+      query_params[:'begin_clockout_time'] = opts[:'begin_clockout_time'] if !opts[:'begin_clockout_time'].nil?
+      query_params[:'end_clockout_time'] = opts[:'end_clockout_time'] if !opts[:'end_clockout_time'].nil?
+      query_params[:'begin_updated_at'] = opts[:'begin_updated_at'] if !opts[:'begin_updated_at'].nil?
+      query_params[:'end_updated_at'] = opts[:'end_updated_at'] if !opts[:'end_updated_at'].nil?
+      query_params[:'deleted'] = opts[:'deleted'] if !opts[:'deleted'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['oauth2']
+      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<V1Timecard>')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: V1EmployeesApi#list_timecards\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Provides the details for a single cash drawer shift, including all events that occurred during the shift.
+    # Provides the details for a single cash drawer shift, including all events that occurred during the shift.
+    # @param location_id The ID of the location to list cash drawer shifts for.
+    # @param shift_id The shift&#39;s ID.
+    # @param [Hash] opts the optional parameters
+    # @return [V1CashDrawerShift]
+    def retrieve_cash_drawer_shift(location_id, shift_id, opts = {})
+      data, _status_code, _headers = retrieve_cash_drawer_shift_with_http_info(location_id, shift_id, opts)
+      return data
+    end
+
+    # Provides the details for a single cash drawer shift, including all events that occurred during the shift.
+    # Provides the details for a single cash drawer shift, including all events that occurred during the shift.
+    # @param location_id The ID of the location to list cash drawer shifts for.
+    # @param shift_id The shift&#39;s ID.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(V1CashDrawerShift, Fixnum, Hash)>] V1CashDrawerShift data, response status code and response headers
+    def retrieve_cash_drawer_shift_with_http_info(location_id, shift_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: V1EmployeesApi.retrieve_cash_drawer_shift ..."
+      end
+      # verify the required parameter 'location_id' is set
+      fail ArgumentError, "Missing the required parameter 'location_id' when calling V1EmployeesApi.retrieve_cash_drawer_shift" if location_id.nil?
+      # verify the required parameter 'shift_id' is set
+      fail ArgumentError, "Missing the required parameter 'shift_id' when calling V1EmployeesApi.retrieve_cash_drawer_shift" if shift_id.nil?
+      # resource path
+      local_var_path = "/v1/{location_id}/cash-drawer-shifts/{shift_id}".sub('{format}','json').sub('{' + 'location_id' + '}', location_id.to_s).sub('{' + 'shift_id' + '}', shift_id.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'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['oauth2']
+      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 => 'V1CashDrawerShift')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: V1EmployeesApi#retrieve_cash_drawer_shift\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Provides the details for a single employee.
+    # Provides the details for a single employee.
+    # @param employee_id The employee&#39;s ID.
+    # @param [Hash] opts the optional parameters
+    # @return [V1Employee]
+    def retrieve_employee(employee_id, opts = {})
+      data, _status_code, _headers = retrieve_employee_with_http_info(employee_id, opts)
+      return data
+    end
+
+    # Provides the details for a single employee.
+    # Provides the details for a single employee.
+    # @param employee_id The employee&#39;s ID.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(V1Employee, Fixnum, Hash)>] V1Employee data, response status code and response headers
+    def retrieve_employee_with_http_info(employee_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: V1EmployeesApi.retrieve_employee ..."
+      end
+      # verify the required parameter 'employee_id' is set
+      fail ArgumentError, "Missing the required parameter 'employee_id' when calling V1EmployeesApi.retrieve_employee" if employee_id.nil?
+      # resource path
+      local_var_path = "/v1/me/employees/{employee_id}".sub('{format}','json').sub('{' + 'employee_id' + '}', employee_id.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'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['oauth2']
+      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 => 'V1Employee')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: V1EmployeesApi#retrieve_employee\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Provides the details for a single employee role.
+    # Provides the details for a single employee role.
+    # @param role_id The role&#39;s ID.
+    # @param [Hash] opts the optional parameters
+    # @return [V1EmployeeRole]
+    def retrieve_employee_role(role_id, opts = {})
+      data, _status_code, _headers = retrieve_employee_role_with_http_info(role_id, opts)
+      return data
+    end
+
+    # Provides the details for a single employee role.
+    # Provides the details for a single employee role.
+    # @param role_id The role&#39;s ID.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(V1EmployeeRole, Fixnum, Hash)>] V1EmployeeRole data, response status code and response headers
+    def retrieve_employee_role_with_http_info(role_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: V1EmployeesApi.retrieve_employee_role ..."
+      end
+      # verify the required parameter 'role_id' is set
+      fail ArgumentError, "Missing the required parameter 'role_id' when calling V1EmployeesApi.retrieve_employee_role" if role_id.nil?
+      # resource path
+      local_var_path = "/v1/me/roles/{role_id}".sub('{format}','json').sub('{' + 'role_id' + '}', role_id.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'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['oauth2']
+      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 => 'V1EmployeeRole')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: V1EmployeesApi#retrieve_employee_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Provides the details for a single timecard.
+    # Provides the details for a single timecard.
+    # @param timecard_id The timecard&#39;s ID.
+    # @param [Hash] opts the optional parameters
+    # @return [V1Timecard]
+    def retrieve_timecard(timecard_id, opts = {})
+      data, _status_code, _headers = retrieve_timecard_with_http_info(timecard_id, opts)
+      return data
+    end
+
+    # Provides the details for a single timecard.
+    # Provides the details for a single timecard.
+    # @param timecard_id The timecard&#39;s ID.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(V1Timecard, Fixnum, Hash)>] V1Timecard data, response status code and response headers
+    def retrieve_timecard_with_http_info(timecard_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: V1EmployeesApi.retrieve_timecard ..."
+      end
+      # verify the required parameter 'timecard_id' is set
+      fail ArgumentError, "Missing the required parameter 'timecard_id' when calling V1EmployeesApi.retrieve_timecard" if timecard_id.nil?
+      # resource path
+      local_var_path = "/v1/me/timecards/{timecard_id}".sub('{format}','json').sub('{' + 'timecard_id' + '}', timecard_id.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'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['oauth2']
+      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 => 'V1Timecard')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: V1EmployeesApi#retrieve_timecard\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # V1 UpdateEmployee
+    # 
+    # @param employee_id The ID of the role to modify.
+    # @param body An object containing the fields to POST for the request.  See the corresponding object definition for field details.
+    # @param [Hash] opts the optional parameters
+    # @return [V1Employee]
+    def update_employee(employee_id, body, opts = {})
+      data, _status_code, _headers = update_employee_with_http_info(employee_id, body, opts)
+      return data
+    end
+
+    # V1 UpdateEmployee
+    # 
+    # @param employee_id The ID of the role to modify.
+    # @param body An object containing the fields to POST for the request.  See the corresponding object definition for field details.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(V1Employee, Fixnum, Hash)>] V1Employee data, response status code and response headers
+    def update_employee_with_http_info(employee_id, body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: V1EmployeesApi.update_employee ..."
+      end
+      # verify the required parameter 'employee_id' is set
+      fail ArgumentError, "Missing the required parameter 'employee_id' when calling V1EmployeesApi.update_employee" if employee_id.nil?
+      # verify the required parameter 'body' is set
+      fail ArgumentError, "Missing the required parameter 'body' when calling V1EmployeesApi.update_employee" if body.nil?
+      # resource path
+      local_var_path = "/v1/me/employees/{employee_id}".sub('{format}','json').sub('{' + 'employee_id' + '}', employee_id.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'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(body)
+      auth_names = ['oauth2']
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'V1Employee')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: V1EmployeesApi#update_employee\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Modifies the details of an employee role.
+    # Modifies the details of an employee role.
+    # @param role_id The ID of the role to modify.
+    # @param body An object containing the fields to POST for the request.  See the corresponding object definition for field details.
+    # @param [Hash] opts the optional parameters
+    # @return [V1EmployeeRole]
+    def update_employee_role(role_id, body, opts = {})
+      data, _status_code, _headers = update_employee_role_with_http_info(role_id, body, opts)
+      return data
+    end
+
+    # Modifies the details of an employee role.
+    # Modifies the details of an employee role.
+    # @param role_id The ID of the role to modify.
+    # @param body An object containing the fields to POST for the request.  See the corresponding object definition for field details.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(V1EmployeeRole, Fixnum, Hash)>] V1EmployeeRole data, response status code and response headers
+    def update_employee_role_with_http_info(role_id, body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: V1EmployeesApi.update_employee_role ..."
+      end
+      # verify the required parameter 'role_id' is set
+      fail ArgumentError, "Missing the required parameter 'role_id' when calling V1EmployeesApi.update_employee_role" if role_id.nil?
+      # verify the required parameter 'body' is set
+      fail ArgumentError, "Missing the required parameter 'body' when calling V1EmployeesApi.update_employee_role" if body.nil?
+      # resource path
+      local_var_path = "/v1/me/roles/{role_id}".sub('{format}','json').sub('{' + 'role_id' + '}', role_id.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'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(body)
+      auth_names = ['oauth2']
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'V1EmployeeRole')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: V1EmployeesApi#update_employee_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Modifies a timecard's details. This creates an API_EDIT event for the timecard. You can view a timecard's event history with the List Timecard Events endpoint.
+    # Modifies a timecard's details. This creates an API_EDIT event for the timecard. You can view a timecard's event history with the List Timecard Events endpoint.
+    # @param timecard_id TThe ID of the timecard to modify.
+    # @param body An object containing the fields to POST for the request.  See the corresponding object definition for field details.
+    # @param [Hash] opts the optional parameters
+    # @return [V1Timecard]
+    def update_timecard(timecard_id, body, opts = {})
+      data, _status_code, _headers = update_timecard_with_http_info(timecard_id, body, opts)
+      return data
+    end
+
+    # Modifies a timecard&#39;s details. This creates an API_EDIT event for the timecard. You can view a timecard&#39;s event history with the List Timecard Events endpoint.
+    # Modifies a timecard&#39;s details. This creates an API_EDIT event for the timecard. You can view a timecard&#39;s event history with the List Timecard Events endpoint.
+    # @param timecard_id TThe ID of the timecard to modify.
+    # @param body An object containing the fields to POST for the request.  See the corresponding object definition for field details.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(V1Timecard, Fixnum, Hash)>] V1Timecard data, response status code and response headers
+    def update_timecard_with_http_info(timecard_id, body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: V1EmployeesApi.update_timecard ..."
+      end
+      # verify the required parameter 'timecard_id' is set
+      fail ArgumentError, "Missing the required parameter 'timecard_id' when calling V1EmployeesApi.update_timecard" if timecard_id.nil?
+      # verify the required parameter 'body' is set
+      fail ArgumentError, "Missing the required parameter 'body' when calling V1EmployeesApi.update_timecard" if body.nil?
+      # resource path
+      local_var_path = "/v1/me/timecards/{timecard_id}".sub('{format}','json').sub('{' + 'timecard_id' + '}', timecard_id.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'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(body)
+      auth_names = ['oauth2']
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'V1Timecard')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: V1EmployeesApi#update_timecard\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end