Module: SmartHR::Client::BizEstablishmentMethods

Included in:
SmartHR::Client
Defined in:
lib/smarthr/client/biz_establishment_methods.rb

Instance Method Summary collapse

Instance Method Details

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

Get the list of business establishments

Parameters:

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

    Whether or not to embed social insurance owner

  • embed_lab_ins_owner (Boolean) (defaults to: false) —

    Whether or not to embed labor insurance owner

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:



16
17
18
19
20
21
22
23
24
25
26
 
# File 'lib/smarthr/client/biz_establishment_methods.rb', line 16

def get_biz_establishments(page: 1, per_page: 10, embed_soc_ins_owner: false, embed_lab_ins_owner: false, &block)
  embed = embed_soc_ins_owner ? 'soc_ins_owner' : nil
  embed = embed_lab_ins_owner ? 'lab_ins_owner' : nil

  get("/biz_establishments",
    page: page,
    per_page: per_page,
    embed: embed,
    &block
  )
end