Module: SmartHR::Client::EmploymentTypeMethods

Included in:

SmartHR::Client

Defined in:

lib/smarthr/client/employment_type_methods.rb

Instance Method Summary

• #create_employment_type(body:) {|response_body, response_header| ... } ⇒ Hashie::Mash

  Create a new employment type.

• #destroy_employment_type(id:) {|response_body, response_header| ... } ⇒ Object

  Delete the crew custom field template group.

• #find_employment_type(id:) {|response_body, response_header| ... } ⇒ Hashie::Mash

  Get the employment type.

• #get_employment_types(page: 1, per_page: 10) {|response_body, response_header| ... } ⇒ Array<Hashie::Mash>

  Get the list of employment types.

• #update_employment_type(id:, body:) {|response_body, response_header| ... } ⇒ Hashie::Mash

  Change the data of the specified group.

Instance Method Details

#create_employment_type(body:) {|response_body, response_header| ... } ⇒ Hashie::Mash

Create a new employment type

Parameters:

• body (Hash)

Yields:

• (response_body, response_header) —

  if block was given, return response body and response header through block arguments

Yield Parameters:

• response_body (Hashie::Mash) —

  response body

• response_header (Hash<String, String>) —

  response header (e.g. X-Rate-Limit-Limit, X-Rate-Limit-Reset, X-Rate-Limit-Remaining)

Returns:

• (Hashie::Mash)

See Also:

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

# 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:) {|response_body, response_header| ... } ⇒ Object

Delete the crew custom field template group

Parameters:

• id (String)

Yields:

• (response_body, response_header) —

  if block was given, return response body and response header through block arguments

Yield Parameters:

• response_body (Hashie::Mash) —

  response body

• response_header (Hash<String, String>) —

  response header (e.g. X-Rate-Limit-Limit, X-Rate-Limit-Reset, X-Rate-Limit-Remaining)

See Also:

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

# 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:) {|response_body, response_header| ... } ⇒ Hashie::Mash

Get the employment type

Parameters:

• id (String)

Yields:

• (response_body, response_header) —

  if block was given, return response body and response header through block arguments

Yield Parameters:

• response_body (Hashie::Mash) —

  response body

• response_header (Hash<String, String>) —

  response header (e.g. X-Rate-Limit-Limit, X-Rate-Limit-Reset, X-Rate-Limit-Remaining)

Returns:

• (Hashie::Mash)

See Also:

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

# 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) {|response_body, response_header| ... } ⇒ Array<Hashie::Mash>

Get the list of employment types

Parameters:

• page (Integer) (defaults to: 1)
• per_page (Integer) (defaults to: 10)

Yields:

• (response_body, response_header) —

  if block was given, return response body and response header through block arguments

Yield Parameters:

• response_body (Array<Hashie::Mash>) —

  response body

• response_header (Hash<String, String>) —

  response header (e.g. X-Rate-Limit-Limit, X-Rate-Limit-Reset, X-Rate-Limit-Remaining)

Returns:

• (Array<Hashie::Mash>)

See Also:

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

# 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:) {|response_body, response_header| ... } ⇒ Hashie::Mash

Change the data of the specified group

Parameters:

• id (String)
• body (Hash)

Yields:

• (response_body, response_header) —

  if block was given, return response body and response header through block arguments

Yield Parameters:

• response_body (Hashie::Mash) —

  response body

• response_header (Hash<String, String>) —

  response header (e.g. X-Rate-Limit-Limit, X-Rate-Limit-Reset, X-Rate-Limit-Remaining)

Returns:

• (Hashie::Mash)

See Also:

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

# File 'lib/smarthr/client/employment_type_methods.rb', line 42

def update_employment_type(id:, body:, &block)
  patch("/employment_types/#{id}", body, &block)
end