Module: SmartHR::Client::PaymentPeriodMethods

Included in:

SmartHR::Client

Defined in:

lib/smarthr/client/payment_period_methods.rb

Instance Method Summary

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

  Get the payment period.

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

  Get the list of payment periods.

Instance Method Details

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

Get the payment period

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#!/%E7%B5%A6%E4%B8%8E%E6%94%AF%E7%B5%A6%E5%BD%A2%E6%85%8B/getV1PaymentPeriodsId

# File 'lib/smarthr/client/payment_period_methods.rb', line 13

def find_payment_period(id:, &block)
  get("/payment_periods/#{id}", &block)
end

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

Get the list of payment periods

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#!/%E7%B5%A6%E4%B8%8E%E6%94%AF%E7%B5%A6%E5%BD%A2%E6%85%8B/getV1PaymentPeriods

# File 'lib/smarthr/client/payment_period_methods.rb', line 29

def get_payment_periods(page: 1, per_page: 10, &block)
  get("/payment_periods",
    page: page,
    per_page: per_page,
    &block
  )
end