Module: SmartHR::Client::MailFormatMethods

Included in:

SmartHR::Client

Defined in:

lib/smarthr/client/mail_format_methods.rb

Instance Method Summary

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

  Get the mail format.

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

  Get the list of mail formats.

Instance Method Details

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

Get the mail format

Parameters:

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

  Whether or not to embed crew input forms

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#!/%E3%83%A1%E3%83%BC%E3%83%AB%E3%83%95%E3%82%A9%E3%83%BC%E3%83%9E%E3%83%83%E3%83%88/getV1MailFormatsId

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

def find_mail_format(id:, embed_crew_input_forms: false, &block)
  get("/mail_formats/#{id}", embed: embed_crew_input_forms ? 'crew_input_forms' : nil, &block)
end

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

Get the list of mail formats

Parameters:

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

  Whether or not to embed crew input forms

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#!/%E3%83%A1%E3%83%BC%E3%83%AB%E3%83%95%E3%82%A9%E3%83%BC%E3%83%9E%E3%83%83%E3%83%88/getV1MailFormats

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

def get_mail_formats(page: 1, per_page: 10, embed_crew_input_forms: false, &block)
  get("/mail_formats",
    page: page,
    per_page: per_page,
    embed: embed_crew_input_forms ? 'crew_input_forms' : nil,
    &block
  )
end