Module: SmartHR::Client::CrewCustomFieldTemplateMethods

Included in:

SmartHR::Client

Defined in:

lib/smarthr/client/crew_custom_field_template_methods.rb

Instance Method Summary

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

  Create a new crew custom field template.

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

  Delete the crew custom field template.

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

  Get the crew custom field template.

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

  Get the list of crew custom field templates.

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

  Change the data of the specified template.

Instance Method Details

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

Create a new crew custom field template

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#!/%E5%BE%93%E6%A5%AD%E5%93%A1%E3%82%AB%E3%82%B9%E3%82%BF%E3%83%A0%E9%A0%85%E7%9B%AE%E3%83%86%E3%83%B3%E3%83%97%E3%83%AC%E3%83%BC%E3%83%88/postV1CrewCustomFieldTemplates

# File 'lib/smarthr/client/crew_custom_field_template_methods.rb', line 80

def create_crew_custom_field_template(body:, &block)
  post("/crew_custom_field_templates", body, &block)
end

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

Delete the crew custom field template

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#!/%E5%BE%93%E6%A5%AD%E5%93%A1%E3%82%AB%E3%82%B9%E3%82%BF%E3%83%A0%E9%A0%85%E7%9B%AE%E3%83%86%E3%83%B3%E3%83%97%E3%83%AC%E3%83%BC%E3%83%88/deleteV1CrewCustomFieldTemplatesId

# File 'lib/smarthr/client/crew_custom_field_template_methods.rb', line 11

def destroy_crew_custom_field_template(id:, &block)
  delete("/crew_custom_field_templates/#{id}", &block)
end

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

Get the crew custom field template

Parameters:

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

  Whether or not to embed group

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%E3%82%AB%E3%82%B9%E3%82%BF%E3%83%A0%E9%A0%85%E7%9B%AE%E3%83%86%E3%83%B3%E3%83%97%E3%83%AC%E3%83%BC%E3%83%88/getV1CrewCustomFieldTemplatesId

# File 'lib/smarthr/client/crew_custom_field_template_methods.rb', line 27

def find_crew_custom_field_template(id:, embed_group: false, &block)
  get("/crew_custom_field_templates/#{id}", embed: embed_group ? 'group' : nil, &block)
end

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

Get the list of crew custom field templates

Parameters:

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

  Whether or not to embed group

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%E3%82%AB%E3%82%B9%E3%82%BF%E3%83%A0%E9%A0%85%E7%9B%AE%E3%83%86%E3%83%B3%E3%83%97%E3%83%AC%E3%83%BC%E3%83%88/getV1CrewCustomFieldTemplates

# File 'lib/smarthr/client/crew_custom_field_template_methods.rb', line 60

def get_crew_custom_field_templates(page: 1, per_page: 10, embed_group: false, &block)
  get("/crew_custom_field_templates",
    page: page,
    per_page: per_page,
    embed: embed_group ? 'group' : nil,
    &block
  )
end

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

Change the data of the specified template

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#!/%E5%BE%93%E6%A5%AD%E5%93%A1%E3%82%AB%E3%82%B9%E3%82%BF%E3%83%A0%E9%A0%85%E7%9B%AE%E3%83%86%E3%83%B3%E3%83%97%E3%83%AC%E3%83%BC%E3%83%88/patchV1CrewCustomFieldTemplatesId

# File 'lib/smarthr/client/crew_custom_field_template_methods.rb', line 43

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