Class: PayrollHero::Api::V3::DaySchedules

Inherits:
BaseGroup
  • Object
show all
Defined in:
lib/payroll_hero/api/v3/day_schedules.rb

Overview

DaySchedules Endpoint

Instance Attribute Summary

Attributes inherited from BaseGroup

#client

Instance Method Summary collapse

Methods inherited from BaseGroup

#initialize

Constructor Details

This class inherits a constructor from PayrollHero::Api::BaseGroup

Instance Method Details

#list(page: nil, per_page: nil, start_date: nil, end_date: nil, permissions: false, breaks: false, worksite_id: nil, excluded_worksite_id: nil, employee_id: nil) ⇒ Hashie::Mash

implements the interface to the DaySchedules List endpoint

Parameters:

  • page (Fixnum) (defaults to: nil)
  • per_page (Fixnum) (defaults to: nil)
  • start_date (Date) (defaults to: nil)
  • end_date (Date) (defaults to: nil)
  • permissions (TrueClass|FalseClass) (defaults to: false)
  • breaks (TrueClass|FalseClass) (defaults to: false)
  • worksite_id (Fixnum) (defaults to: nil)
  • excluded_worksite_id (Fixnum) (defaults to: nil)
  • employee_id (Fixnum) (defaults to: nil)

Returns:

  • (Hashie::Mash) 


19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/payroll_hero/api/v3/day_schedules.rb', line 19

def list(page: nil, per_page: nil, start_date: nil, end_date: nil, permissions: false, breaks: false, worksite_id: nil, excluded_worksite_id: nil, employee_id: nil)
  params = {
    page: page,
    per_page: per_page,
    start_date: start_date,
    end_date: end_date,
    permissions: permissions,
    breaks: breaks,
    worksite_id: worksite_id,
    excluded_worksite_id: excluded_worksite_id,
    employee_id: employee_id,
  }
  remove_nil_values_from!(params)
  client.get("/api/v3/day_schedules", params)
end