GithubHelp home page GithubHelp logo

swagger-client-trinet's Introduction

swagger_client

SwaggerClient - the Ruby gem for the Trinet API

Config API Specification

This SDK is automatically generated by the Swagger Codegen project:

  • API version: 1.0.0
  • Package version: 1.0.0
  • Build date: 2016-12-14T10:16:02.397-08:00
  • Build package: class io.swagger.codegen.languages.RubyClientCodegen For more information, please visit www.trinet.com

Installation

Build a gem

To build the Ruby code into a gem:

gem build swagger_client.gemspec

Then either install the gem locally:

gem install ./swagger_client-1.0.0.gem

(for development, run gem install --dev ./swagger_client-1.0.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'swagger_client', '~> 1.0.0'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'swagger_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'swagger_client'

api_instance = SwaggerClient::CompanyConfigServicesApi.new

company_id = "company_id_example" # String | companyId

department_id = "department_id_example" # String | departmentId

opts = { 
  dept_name: "dept_name_example", # String | deptName
  include: "include_example", # String | include
  effective_date: "effective_date_example" # String | effectiveDate
}

begin
  #findByDeptId
  result = api_instance.find_by_dept_id_using_get1(company_id, department_id, opts)
  p result
rescue SwaggerClient::ApiError => e
  puts "Exception when calling CompanyConfigServicesApi->find_by_dept_id_using_get1: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://platformbib.hrpassport.com/api-config

Class Method HTTP request Description
SwaggerClient::CompanyConfigServicesApi find_by_dept_id_using_get1 GET /v1/company/{companyId}/departments/{departmentId}{?deptName,include,effectiveDate} findByDeptId
SwaggerClient::CompanyConfigServicesApi find_by_dept_name_using_get3 GET /v1/company/{companyId}/departments{?deptName,include,deptCode,effectiveDate} findByDeptName
SwaggerClient::CompanyConfigServicesApi get_benefit_plan_year_using_get1 GET /v1/company/{companyId}/benefit-plan-year{?effectiveDate} getBenefitPlanYear
SwaggerClient::CompanyConfigServicesApi get_client_current_benefits_using_get1 GET /v1/company/{companyId}/benefits{?efftDate} getClientCurrentBenefits
SwaggerClient::CompanyConfigServicesApi get_company_benefit_classes_using_get1 GET /v1/company/{companyId}/benefit-classes{?effectiveDate} getCompanyBenefitClasses
SwaggerClient::CompanyConfigServicesApi get_company_holiday_using_get3 GET /v1/company/{companyId}/holidays{?dateLimit} getCompanyHoliday
SwaggerClient::CompanyConfigServicesApi get_company_jobs_using_get3 GET /v1/company/{companyId}/jobs getCompanyJobs
SwaggerClient::CompanyConfigServicesApi get_company_leave_plan_details_using_get3 GET /v1/company/{companyId}/leave-plans/{planType} getCompanyLeavePlanDetails
SwaggerClient::CompanyConfigServicesApi get_company_leave_plans_using_get1 GET /v1/company/{companyId}/leave-plans{?leave,employeeId} getCompanyLeavePlans
SwaggerClient::CompanyConfigServicesApi get_company_location_using_get3 GET /v1/company/{companyId}/locations/{locationId}{?effectiveDate} getCompanyLocationByLocationId
SwaggerClient::CompanyConfigServicesApi get_company_locations_using_get1 GET /v1/company/{companyId}/locations{?include,locationName,stateCode,headquarter,effectiveDate} getCompanyLocations
SwaggerClient::CompanyConfigServicesApi get_company_pay_codes_using_get1 GET /v1/company/{companyId}/pay-codes{?type} getCompanyPayCodes
SwaggerClient::CompanyConfigServicesApi get_company_pay_group_using_get1 GET /v1/company/{companyId}/paygroups/{paygroupId}{?effectiveDate} getCompanyPayGroup
SwaggerClient::CompanyConfigServicesApi get_company_pay_groups_using_get3 GET /v1/company/{companyId}/paygroups{?effectiveDate} getCompanyPayGroups
SwaggerClient::CompanyConfigServicesApi get_company_payroll_schedules_by_paygroup_using_get1 GET /v1/company/{companyId}/payroll-schedules/{paygroup}{?startDate,endDate} getCompanyPayrollSchedulesByPaygroup
SwaggerClient::CompanyConfigServicesApi get_company_payroll_schedules_using_get1 GET /v1/company/{companyId}/payroll-schedules{?startDate,endDate} getCompanyPayrollSchedules
SwaggerClient::CompanyConfigServicesApi get_company_policies_using_get1 GET /v1/company/{companyId}/workers-comp-policies{?state} getCompanyPolicies
SwaggerClient::CompanyConfigServicesApi get_company_roles_using_get3 GET /v1/company/{companyId}/roles getCompanyRoles
SwaggerClient::CompanyConfigServicesApi get_company_savings_plans_details_using_get1 GET /v1/company/{companyId}/savings-plans getCompanySavingsPlansDetails
SwaggerClient::CompanyConfigServicesApi get_company_schedule_holiday_using_get3 GET /v1/company/{companyId}/holidays/{schedule}{?year} getCompanyScheduleHoliday
SwaggerClient::CompanyConfigServicesApi get_company_skr_workers_comp_codes_using_get1 GET /v1/company/{companyId}/skr-workers-comp-codes getCompanySKRWorkersCompCodes
SwaggerClient::CompanyConfigServicesApi get_company_supervisors_using_get3 GET /v1/company/{companyId}/supervisors getCompanySupervisors
SwaggerClient::CompanyConfigServicesApi get_company_workers_comp_codes_using_get1 GET /v1/company/{companyId}/workers-comp-codes getCompanyWorkersCompCodes
SwaggerClient::CompanyConfigServicesApi get_current_locations_using_get1 GET /v1/company/{companyId}/{employeeId}/current-location getEmployeeLocation
SwaggerClient::CompanyConfigServicesApi get_delivery_methods_using_get1 GET /v1/company/{companyId}/delivery-methods getDeliveryMethods
SwaggerClient::CompanyConfigServicesApi get_demotion_reasons_using_get3 GET /v1/company/{companyId}/demotion-reasons getDemotionReasons
SwaggerClient::CompanyConfigServicesApi get_direct_manager_using_get1 GET /v1/company/{companyId}/direct-managers getDirectManager
SwaggerClient::CompanyConfigServicesApi get_earn_types_using_get1 GET /v1/company/{companyId}/earn-types getEarnTypes
SwaggerClient::CompanyConfigServicesApi get_employee_job_profile_using_get3 GET /v1/company/{companyId}/{employeeId}/job-profiles getEmployeeJobProfile
SwaggerClient::CompanyConfigServicesApi get_employee_pay_change_reasons_using_get3 GET /v1/company/{companyId}/paychange-reasons getEmployeePayChangeReasons
SwaggerClient::CompanyConfigServicesApi get_employee_transfer_reasons_using_get3 GET /v1/company/{companyId}/transfer-reasons getEmployeeTransferReasons
SwaggerClient::CompanyConfigServicesApi get_job_reclassification_reasons_using_get1 GET /v1/company/{companyId}/job-reclassification-reasons getJobReclassificationReasons
SwaggerClient::CompanyConfigServicesApi get_pay_frequencies_using_get3 GET /v1/company/{companyId}/pay-frequencies getPayFrequencies
SwaggerClient::CompanyConfigServicesApi get_pay_groups_using_get1 GET /v1/company/{companyId}/pay-groups/{paygroupId} Get pay group
SwaggerClient::CompanyConfigServicesApi get_pay_methods_using_get3 GET /v1/company/{companyId}/payment-methods getPayMethods
SwaggerClient::CompanyConfigServicesApi get_performance_mgmt_job_codes_using_get1 GET /v1/company/{companyId}/performance-mgmt-job-codes getPerformanceMgmtJobCodes
SwaggerClient::CompanyConfigServicesApi get_promotion_reasons_using_get3 GET /v1/company/{companyId}/promotion-reasons getPromotionReasons
SwaggerClient::CompanyConfigServicesApi get_roles_using_get1 GET /v1/company/{companyId}/{employeeId}/roles{?roleType} getRoles
SwaggerClient::CompanyConfigServicesApi get_special_pay_desc_using_get3 GET /v1/company/{companyId}/special-payments getSpecialPayDesc
SwaggerClient::CompanyConfigServicesApi get_workers_comp_look_up_using_get1 GET /v1/company/{companyId}/{state}/workers-comp getWorkersCompLookUp
SwaggerClient::GlobalServicesApi create_partner_access_using_post1 POST /v1/global/partner-companies createPartnerAccess
SwaggerClient::GlobalServicesApi generate_location_code_using_get3 GET /v1/global/location-code generateLocationCode
SwaggerClient::GlobalServicesApi get_access_types_list_using_get1 GET /v1/global/access-types getAccessTypesList
SwaggerClient::GlobalServicesApi get_address_types_list_using_get1 GET /v1/global/address-types getAddressTypesList
SwaggerClient::GlobalServicesApi get_citizenships_using_get3 GET /v1/global/{countryCode}/citizenships getCitizenships
SwaggerClient::GlobalServicesApi get_comp_basis_types_using_get3 GET /v1/global/compensation-types getCompBasisTypes
SwaggerClient::GlobalServicesApi get_countries_list_using_get3 GET /v1/global/countries getCountriesList
SwaggerClient::GlobalServicesApi get_employment_types_using_get1 GET /v1/global/employment-types getEmploymentTypes
SwaggerClient::GlobalServicesApi get_ethnicity_list_using_get3 GET /v1/global/{countryCode}/ethnicities getEthnicityList
SwaggerClient::GlobalServicesApi get_flsa_types_using_get1 GET /v1/global/flsa-codes getFlsaTypes
SwaggerClient::GlobalServicesApi get_form_of_address_list_using_get1 GET /v1/global/titles getFormOfAddressList
SwaggerClient::GlobalServicesApi get_gender_list_using_get1 GET /v1/global/genders getGenderList
SwaggerClient::GlobalServicesApi get_marital_status_list_using_get1 GET /v1/global/marital-statuses getMaritalStatusList
SwaggerClient::GlobalServicesApi get_media_list_using_get3 GET /v1/global/media-types getMediaList
SwaggerClient::GlobalServicesApi get_military_status_list_using_get3 GET /v1/global/{countryCode}/military-statuses getMilitaryStatusList
SwaggerClient::GlobalServicesApi get_notification_details_using_get1 GET /v1/global/{companyId}/{notificationId}/notification-details getNotificationDetails
SwaggerClient::GlobalServicesApi get_pay_det_cd_list_using_get3 GET /v1/global/pay-deduction-codes{?payDetCd,taxInd} getPayDetCdList
SwaggerClient::GlobalServicesApi get_preferences_using_get1 GET /v1/global/preferences getPreferences
SwaggerClient::GlobalServicesApi get_relation_ships_using_get3 GET /v1/global/relationships getRelationShips
SwaggerClient::GlobalServicesApi get_states_list_by_country_using_get3 GET /v1/global/countries/{countryCode}/states getStatesListByCountry
SwaggerClient::GlobalServicesApi get_states_provinc_desc_using_get1 GET /v1/global/countries/{countryCode}/states/{stateCode} getStatesProvincDesc
SwaggerClient::GlobalServicesApi get_suffix_list_using_get3 GET /v1/global/suffixes getSuffixList
SwaggerClient::GlobalServicesApi get_tax_marital_status_list_using_get3 GET /v1/global/tax-marital-stats getTaxMaritalStatusList
SwaggerClient::ResterrorhandlerApi handle_not_found_using_get3 GET /handleNotFound handleNotFound
SwaggerClient::VersioncontrollerApi get_data_using_get3 GET /version.json getData

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.

swagger-client-trinet's People

Contributors

sguha00 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.