module SmartHR::Client::EmploymentTypeMethods

Public Instance Methods

create_employment_type(body:, &block) click to toggle source

Create a new employment type

@see developer.smarthr.jp/api/index.html#!/%E9%9B%87%E7%94%A8%E5%BD%A2%E6%85%8B/postV1EmploymentTypes

@param body [Hash]

@yield [response_body, response_header] if block was given, return response body and response header through block arguments @yieldparam response_body [Hashie::Mash] response body @yieldparam response_header [Hash<String, String>] response header (e.g. X-Rate-Limit-Limit, X-Rate-Limit-Reset, X-Rate-Limit-Remaining)

@return [Hashie::Mash]

# File lib/smarthr/client/employment_type_methods.rb, line 77
def create_employment_type(body:, &block)
  post("/employment_types", body, &block)
end
destroy_employment_type(id:, &block) click to toggle source

Delete the crew custom field template group

@see developer.smarthr.jp/api/index.html#!/%E9%9B%87%E7%94%A8%E5%BD%A2%E6%85%8B/deleteV1EmploymentTypesId

@param id [String]

@yield [response_body, response_header] if block was given, return response body and response header through block arguments @yieldparam response_body [Hashie::Mash] response body @yieldparam response_header [Hash<String, String>] response header (e.g. X-Rate-Limit-Limit, X-Rate-Limit-Reset, X-Rate-Limit-Remaining)

# File lib/smarthr/client/employment_type_methods.rb, line 11
def destroy_employment_type(id:, &block)
  delete("/employment_types/#{id}", &block)
end
find_employment_type(id:, &block) click to toggle source

Get the employment type

@see developer.smarthr.jp/api/index.html#!/%E9%9B%87%E7%94%A8%E5%BD%A2%E6%85%8B/getV1EmploymentTypesId

@param id [String]

@yield [response_body, response_header] if block was given, return response body and response header through block arguments @yieldparam response_body [Hashie::Mash] response body @yieldparam response_header [Hash<String, String>] response header (e.g. X-Rate-Limit-Limit, X-Rate-Limit-Reset, X-Rate-Limit-Remaining)

@return [Hashie::Mash]

# File lib/smarthr/client/employment_type_methods.rb, line 26
def find_employment_type(id:, &block)
  get("/employment_types/#{id}", &block)
end
get_employment_types(page: 1, per_page: 10, &block) click to toggle source

Get the list of employment types

@see developer.smarthr.jp/api/index.html#!/%E9%9B%87%E7%94%A8%E5%BD%A2%E6%85%8B/getV1EmploymentTypes

@param page [Integer] @param per_page [Integer]

@yield [response_body, response_header] if block was given, return response body and response header through block arguments @yieldparam response_body [Array<Hashie::Mash>] response body @yieldparam response_header [Hash<String, String>] response header (e.g. X-Rate-Limit-Limit, X-Rate-Limit-Reset, X-Rate-Limit-Remaining)

@return [Array<Hashie::Mash>]

# File lib/smarthr/client/employment_type_methods.rb, line 58
def get_employment_types(page: 1, per_page: 10, &block)
  get("/employment_types",
    page: page,
    per_page: per_page,
    &block
  )
end
update_employment_type(id:, body:, &block) click to toggle source

Change the data of the specified group

@see developer.smarthr.jp/api/index.html#!/%E9%9B%87%E7%94%A8%E5%BD%A2%E6%85%8B/patchV1EmploymentTypesId

@param id [String] @param body [Hash]

@yield [response_body, response_header] if block was given, return response body and response header through block arguments @yieldparam response_body [Hashie::Mash] response body @yieldparam response_header [Hash<String, String>] response header (e.g. X-Rate-Limit-Limit, X-Rate-Limit-Reset, X-Rate-Limit-Remaining)

@return [Hashie::Mash]

# File lib/smarthr/client/employment_type_methods.rb, line 42
def update_employment_type(id:, body:, &block)
  patch("/employment_types/#{id}", body, &block)
end