Module: SmartHR::Client::CrewInputFormMethods

Included in:

SmartHR::Client

Defined in:

lib/smarthr/client/crew_input_form_method.rb

Instance Method Summary

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

  Get the crew input form.

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

  Get the list of crew input forms.

Instance Method Details

#find_crew_input_form(id:, embed_mail_format: false) {|response_body, response_header| ... } ⇒ Hashie::Mash

Get the crew input form

Parameters:

• id (String)
• embed_mail_format (Boolean) (defaults to: false) —

  Whether or not to embed mail format

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#!/%E5%BE%93%E6%A5%AD%E5%93%A1%E6%83%85%E5%A0%B1%E5%8F%8E%E9%9B%86%E3%83%95%E3%82%A9%E3%83%BC%E3%83%A0/getV1CrewInputFormsId

# File 'lib/smarthr/client/crew_input_form_method.rb', line 14

def find_crew_input_form(id:, embed_mail_format: false, &block)
  get("/crew_input_forms/#{id}", embed: embed_mail_format ? 'mail_format' : nil, &block)
end

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

Get the list of crew input forms

Parameters:

• page (Integer) (defaults to: 1)
• per_page (Integer) (defaults to: 10)
• embed_mail_format (Boolean) (defaults to: false) —

  Whether or not to embed mail format

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#!/%E5%BE%93%E6%A5%AD%E5%93%A1%E6%83%85%E5%A0%B1%E5%8F%8E%E9%9B%86%E3%83%95%E3%82%A9%E3%83%BC%E3%83%A0/getV1CrewInputForms

# File 'lib/smarthr/client/crew_input_form_method.rb', line 31

def get_crew_input_forms(page: 1, per_page: 10, embed_mail_format: false, &block)
  get("/crew_input_forms",
    page: page,
    per_page: per_page,
    embed: embed_mail_format ? 'mail_format' : nil,
    &block
  )
end