smarthr 0.0.1

data/lib/smarthr/client/crew_input_form_method.rb

@@ -0,0 +1,39 @@
+module SmartHR::Client::CrewInputFormMethods
+  # Get the crew input form
+  #
+  # @see 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
+  #
+  # @param id                [String]
+  # @param embed_mail_format [Boolean] Whether or not to embed mail format
+  #
+  # @yield [response_body, response_header] if block was given, return response body and response header through block arguments
+  # @yieldparam response_body [Hashie::Mash] response body
+  # @yieldparam response_header [Hash<String, String>] response header (e.g. X-Rate-Limit-Limit, X-Rate-Limit-Reset, X-Rate-Limit-Remaining)
+  #
+  # @return [Hashie::Mash]
+  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 the list of crew input forms
+  #
+  # @see 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
+  #
+  # @param page              [Integer]
+  # @param per_page          [Integer]
+  # @param embed_mail_format [Boolean] Whether or not to embed mail format
+  #
+  # @yield [response_body, response_header] if block was given, return response body and response header through block arguments
+  # @yieldparam response_body [Array<Hashie::Mash>] response body
+  # @yieldparam response_header [Hash<String, String>] response header (e.g. X-Rate-Limit-Limit, X-Rate-Limit-Reset, X-Rate-Limit-Remaining)
+  #
+  # @return [Array<Hashie::Mash>]
+  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
+end

data/lib/smarthr/client/crew_methods.rb

@@ -0,0 +1,132 @@
+module SmartHR::Client::CrewMethods
+  # Invite a crew
+  #
+  # @see https://developer.smarthr.jp/api/index.html#!/%E5%BE%93%E6%A5%AD%E5%93%A1/putV1CrewsIdInvite
+  #
+  # @param id                 [String]
+  # @param invite_user_id     [String] User ID of invitee
+  # @param crew_input_form_id [String]
+  #
+  # @yield [response_body, response_header] if block was given, return response body and response header through block arguments
+  # @yieldparam response_body [Hashie::Mash] response body
+  # @yieldparam response_header [Hash<String, String>] response header (e.g. X-Rate-Limit-Limit, X-Rate-Limit-Reset, X-Rate-Limit-Remaining)
+  #
+  # @return [Hashie::Mash]
+  def invite_crew(id:, invite_user_id:, crew_input_form_id: nil, &block)
+    put("/crews/#{id}/invite",
+      invite_user_id: invite_user_id,
+      crew_input_form_id: crew_input_form_id,
+      &block
+    )
+  end
+
+  # Delete the crew
+  #
+  # @see https://developer.smarthr.jp/api/index.html#!/%E5%BE%93%E6%A5%AD%E5%93%A1/deleteV1CrewsId
+  #
+  # @param id [String]
+  #
+  # @yield [response_body, response_header] if block was given, return response body and response header through block arguments
+  # @yieldparam response_body [Hashie::Mash] response body
+  # @yieldparam response_header [Hash<String, String>] response header (e.g. X-Rate-Limit-Limit, X-Rate-Limit-Reset, X-Rate-Limit-Remaining)
+  def destroy_crew(id:, &block)
+    delete("/crews/#{id}", &block)
+  end
+
+  # Get the crew
+  #
+  # @see https://developer.smarthr.jp/api/index.html#!/%E5%BE%93%E6%A5%AD%E5%93%A1/getV1CrewsId
+  #
+  # @param id [String]
+  #
+  # @yield [response_body, response_header] if block was given, return response body and response header through block arguments
+  # @yieldparam response_body [Hashie::Mash] response body
+  # @yieldparam response_header [Hash<String, String>] response header (e.g. X-Rate-Limit-Limit, X-Rate-Limit-Reset, X-Rate-Limit-Remaining)
+  #
+  # @return [Hashie::Mash]
+  def find_crew(id:, &block)
+    get("/crews/#{id}", &block)
+  end
+
+  # Change the data of the specified crew
+  #
+  # @see https://developer.smarthr.jp/api/index.html#!/%E5%BE%93%E6%A5%AD%E5%93%A1/patchV1CrewsId
+  #
+  # @param id   [String]
+  # @param body [Hash]
+  #
+  # @yield [response_body, response_header] if block was given, return response body and response header through block arguments
+  # @yieldparam response_body [Hashie::Mash] response body
+  # @yieldparam response_header [Hash<String, String>] response header (e.g. X-Rate-Limit-Limit, X-Rate-Limit-Reset, X-Rate-Limit-Remaining)
+  #
+  # @return [Hashie::Mash]
+  def update_crew(id:, body:, &block)
+    patch("/crews/#{id}", body, &block)
+  end
+
+  # Get the list of crew custom field template groups
+  #
+  # @see https://developer.smarthr.jp/api/index.html#!/%E5%BE%93%E6%A5%AD%E5%93%A1/getV1Crews
+  #
+  # @param page            [Integer]
+  # @param per_page        [Integer]
+  # @param emp_code        [String] Employee code
+  # @param emp_type        [String] Employee type
+  # @param emp_status      [String] Employee status
+  # @param gender          [String] Gender
+  # @param sort            [String] Sort
+  # @param entered_at_from [String] Filter to employees who joined the company after the specified date.
+  # @param entered_at_to   [String] Filter to employees who joined the company before the specified date.
+  # @param q               [String] Free word search by name, business name, department name, or job title.
+  # @param fields          [Array]  Name list of the item to get.
+  #
+  # @yield [response_body, response_header] if block was given, return response body and response header through block arguments
+  # @yieldparam response_body [Array<Hashie::Mash>] response body
+  # @yieldparam response_header [Hash<String, String>] response header (e.g. X-Rate-Limit-Limit, X-Rate-Limit-Reset, X-Rate-Limit-Remaining)
+  #
+  # @return [Array<Hashie::Mash>]
+  def get_crews(page: 1, per_page: 10, emp_code: nil, emp_type: nil, emp_status: nil, gender: nil, sort: nil, entered_at_from: nil, entered_at_to: nil, q: nil, fields: [], &block)
+    get("/crews",
+      page: page,
+      per_page: per_page,
+      emp_code: emp_code,
+      emp_type: emp_type,
+      emp_status: emp_status,
+      gender: gender,
+      sort: sort,
+      entered_at_from: entered_at_from,
+      entered_at_to: entered_at_to,
+      q: q,
+      fields: fields.join(','),
+      &block
+    )
+  end
+
+  # Create a new crew
+  #
+  # @see https://developer.smarthr.jp/api/index.html#!/%E5%BE%93%E6%A5%AD%E5%93%A1/postV1Crews
+  #
+  # @param body [Hash]
+  #
+  # @yield [response_body, response_header] if block was given, return response body and response header through block arguments
+  # @yieldparam response_body [Hashie::Mash] response body
+  # @yieldparam response_header [Hash<String, String>] response header (e.g. X-Rate-Limit-Limit, X-Rate-Limit-Reset, X-Rate-Limit-Remaining)
+  #
+  # @return [Hashie::Mash]
+  def create_crew(body:, &block)
+    post("/crews", body, &block)
+  end
+
+  # Delete the crew departments
+  #
+  # @see https://developer.smarthr.jp/api/index.html#!/%E5%BE%93%E6%A5%AD%E5%93%A1/deleteV1CrewsCrewIdDepartments
+  #
+  # @param crew_id [String]
+  #
+  # @yield [response_body, response_header] if block was given, return response body and response header through block arguments
+  # @yieldparam response_body [Hashie::Mash] response body
+  # @yieldparam response_header [Hash<String, String>] response header (e.g. X-Rate-Limit-Limit, X-Rate-Limit-Reset, X-Rate-Limit-Remaining)
+  def destroy_crew_departments(crew_id:, &block)
+    delete("/crews/#{crew_id}/departments", &block)
+  end
+end

data/lib/smarthr/client/department_methods.rb

@@ -0,0 +1,84 @@
+module SmartHR::Client::DepartmentMethods
+  # Delete the department
+  #
+  # @see https://developer.smarthr.jp/api/index.html#!/%E9%83%A8%E7%BD%B2/deleteV1DepartmentsId
+  #
+  # @param id [String]
+  #
+  # @yield [response_body, response_header] if block was given, return response body and response header through block arguments
+  # @yieldparam response_body [Hashie::Mash] response body
+  # @yieldparam response_header [Hash<String, String>] response header (e.g. X-Rate-Limit-Limit, X-Rate-Limit-Reset, X-Rate-Limit-Remaining)
+  def destroy_department(id:, &block)
+    delete("/departments/#{id}", &block)
+  end
+
+  # Get the department
+  #
+  # @see https://developer.smarthr.jp/api/index.html#!/%E9%83%A8%E7%BD%B2/getV1DepartmentsId
+  #
+  # @param id [String]
+  #
+  # @yield [response_body, response_header] if block was given, return response body and response header through block arguments
+  # @yieldparam response_body [Hashie::Mash] response body
+  # @yieldparam response_header [Hash<String, String>] response header (e.g. X-Rate-Limit-Limit, X-Rate-Limit-Reset, X-Rate-Limit-Remaining)
+  #
+  # @return [Hashie::Mash]
+  def find_department(id:, &block)
+    get("/departments/#{id}", &block)
+  end
+
+  # Change the data of the specified department
+  #
+  # @see https://developer.smarthr.jp/api/index.html#!/%E9%83%A8%E7%BD%B2/patchV1DepartmentsId
+  #
+  # @param id   [String]
+  # @param body [Hash]
+  #
+  # @yield [response_body, response_header] if block was given, return response body and response header through block arguments
+  # @yieldparam response_body [Hashie::Mash] response body
+  # @yieldparam response_header [Hash<String, String>] response header (e.g. X-Rate-Limit-Limit, X-Rate-Limit-Reset, X-Rate-Limit-Remaining)
+  #
+  # @return [Hashie::Mash]
+  def update_department(id:, body:, &block)
+    patch("/departments/#{id}", body, &block)
+  end
+
+  # Get the list of departments
+  #
+  # @see https://developer.smarthr.jp/api/index.html#!/%E9%83%A8%E7%BD%B2/getV1Departments
+  #
+  # @param page     [Integer]
+  # @param per_page [Integer]
+  # @param code     [String]
+  # @param sort     [String]
+  #
+  # @yield [response_body, response_header] if block was given, return response body and response header through block arguments
+  # @yieldparam response_body [Array<Hashie::Mash>] response body
+  # @yieldparam response_header [Hash<String, String>] response header (e.g. X-Rate-Limit-Limit, X-Rate-Limit-Reset, X-Rate-Limit-Remaining)
+  #
+  # @return [Array<Hashie::Mash>]
+  def get_departments(page: 1, per_page: 10, code: nil, sort: nil, &block)
+    get("/departments",
+      page: page,
+      per_page: per_page,
+      code: code,
+      sort: sort,
+      &block
+    )
+  end
+
+  # Create a new department
+  #
+  # @see https://developer.smarthr.jp/api/index.html#!/%E9%83%A8%E7%BD%B2/postV1Departments
+  #
+  # @param body [Hash]
+  #
+  # @yield [response_body, response_header] if block was given, return response body and response header through block arguments
+  # @yieldparam response_body [Hashie::Mash] response body
+  # @yieldparam response_header [Hash<String, String>] response header (e.g. X-Rate-Limit-Limit, X-Rate-Limit-Reset, X-Rate-Limit-Remaining)
+  #
+  # @return [Hashie::Mash]
+  def create_department(body:, &block)
+    post("/departments", body, &block)
+  end
+end

data/lib/smarthr/client/dependent_methods.rb

@@ -0,0 +1,85 @@
+module SmartHR::Client::DependentMethods
+  # Delete the crew dependent
+  #
+  # @see https://developer.smarthr.jp/api/index.html#!/%E5%AE%B6%E6%97%8F%E6%83%85%E5%A0%B1/deleteV1CrewsCrewIdDependentsId
+  #
+  # @param crew_id [String]
+  # @param id      [String]
+  #
+  # @yield [response_body, response_header] if block was given, return response body and response header through block arguments
+  # @yieldparam response_body [Hashie::Mash] response body
+  # @yieldparam response_header [Hash<String, String>] response header (e.g. X-Rate-Limit-Limit, X-Rate-Limit-Reset, X-Rate-Limit-Remaining)
+  def destroy_crew_dependent(crew_id:, id:, &block)
+    delete("/crews/#{crew_id}/dependents/#{id}", &block)
+  end
+
+  # Get the crew dependent
+  #
+  # @see https://developer.smarthr.jp/api/index.html#!/%E5%AE%B6%E6%97%8F%E6%83%85%E5%A0%B1/getV1CrewsCrewIdDependentsId
+  #
+  # @param crew_id [String]
+  # @param id      [String]
+  #
+  # @yield [response_body, response_header] if block was given, return response body and response header through block arguments
+  # @yieldparam response_body [Hashie::Mash] response body
+  # @yieldparam response_header [Hash<String, String>] response header (e.g. X-Rate-Limit-Limit, X-Rate-Limit-Reset, X-Rate-Limit-Remaining)
+  #
+  # @return [Hashie::Mash]
+  def find_crew_dependent(crew_id:, id:, &block)
+    get("/crews/#{crew_id}/dependents/#{id}", &block)
+  end
+
+  # Change the data of the specified crew dependent
+  #
+  # @see https://developer.smarthr.jp/api/index.html#!/%E5%AE%B6%E6%97%8F%E6%83%85%E5%A0%B1/patchV1CrewsCrewIdDependentsId
+  #
+  # @param crew_id [String]
+  # @param id      [String]
+  # @param body    [Hash]
+  #
+  # @yield [response_body, response_header] if block was given, return response body and response header through block arguments
+  # @yieldparam response_body [Hashie::Mash] response body
+  # @yieldparam response_header [Hash<String, String>] response header (e.g. X-Rate-Limit-Limit, X-Rate-Limit-Reset, X-Rate-Limit-Remaining)
+  #
+  # @return [Hashie::Mash]
+  def update_crew_dependent(crew_id:, id:, body:, &block)
+    patch("/crews/#{crew_id}/dependents/#{id}", body, &block)
+  end
+
+  # Get the list of crew dependents
+  #
+  # @see https://developer.smarthr.jp/api/index.html#!/%E5%AE%B6%E6%97%8F%E6%83%85%E5%A0%B1/getV1CrewsCrewIdDependents
+  #
+  # @param crew_id  [String]
+  # @param page     [Integer]
+  # @param per_page [Integer]
+  #
+  # @yield [response_body, response_header] if block was given, return response body and response header through block arguments
+  # @yieldparam response_body [Array<Hashie::Mash>] response body
+  # @yieldparam response_header [Hash<String, String>] response header (e.g. X-Rate-Limit-Limit, X-Rate-Limit-Reset, X-Rate-Limit-Remaining)
+  #
+  # @return [Array<Hashie::Mash>]
+  def get_crew_dependents(crew_id:, page: 1, per_page: 10, &block)
+    get("/crews/#{crew_id}/dependents",
+      page: page,
+      per_page: per_page,
+      &block
+    )
+  end
+
+  # Create a new crew dependent
+  #
+  # @see https://developer.smarthr.jp/api/index.html#!/%E5%AE%B6%E6%97%8F%E6%83%85%E5%A0%B1/postV1CrewsCrewIdDependents
+  #
+  # @param crew_id [String]
+  # @param body    [Hash]
+  #
+  # @yield [response_body, response_header] if block was given, return response body and response header through block arguments
+  # @yieldparam response_body [Hashie::Mash] response body
+  # @yieldparam response_header [Hash<String, String>] response header (e.g. X-Rate-Limit-Limit, X-Rate-Limit-Reset, X-Rate-Limit-Remaining)
+  #
+  # @return [Hashie::Mash]
+  def create_crew_dependent(crew_id:, body:, &block)
+    post("/crews/#{crew_id}/dependents", body, &block)
+  end
+end

data/lib/smarthr/client/dependent_relation_methods.rb

@@ -0,0 +1,23 @@
+module SmartHR::Client::DependentRelationMethods
+  # Get the list of dependent relations
+  #
+  # @see https://developer.smarthr.jp/api/index.html#!/%E7%B6%9A%E6%9F%84/getV1DependentRelations
+  #
+  # @param page          [Integer]
+  # @param per_page      [Integer]
+  # @param filter_spouse [Boolean] Whether or not to filter spouse
+  #
+  # @yield [response_body, response_header] if block was given, return response body and response header through block arguments
+  # @yieldparam response_body [Array<Hashie::Mash>] response body
+  # @yieldparam response_header [Hash<String, String>] response header (e.g. X-Rate-Limit-Limit, X-Rate-Limit-Reset, X-Rate-Limit-Remaining)
+  #
+  # @return [Array<Hashie::Mash>]
+  def get_dependent_relations(page: 1, per_page: 10, filter_spouse: false, &block)
+    get("/dependent_relations",
+      page: page,
+      per_page: per_page,
+      filter: filter_spouse ? 'spouse' : nil,
+      &block
+    )
+  end
+end

data/lib/smarthr/client/employment_type_methods.rb

@@ -0,0 +1,80 @@
+module SmartHR::Client::EmploymentTypeMethods
+  # Delete the crew custom field template group
+  #
+  # @see https://developer.smarthr.jp/api/index.html#!/%E9%9B%87%E7%94%A8%E5%BD%A2%E6%85%8B/deleteV1EmploymentTypesId
+  #
+  # @param id [String]
+  #
+  # @yield [response_body, response_header] if block was given, return response body and response header through block arguments
+  # @yieldparam response_body [Hashie::Mash] response body
+  # @yieldparam response_header [Hash<String, String>] response header (e.g. X-Rate-Limit-Limit, X-Rate-Limit-Reset, X-Rate-Limit-Remaining)
+  def destroy_employment_type(id:, &block)
+    delete("/employment_types/#{id}", &block)
+  end
+
+  # Get the employment type
+  #
+  # @see https://developer.smarthr.jp/api/index.html#!/%E9%9B%87%E7%94%A8%E5%BD%A2%E6%85%8B/getV1EmploymentTypesId
+  #
+  # @param id [String]
+  #
+  # @yield [response_body, response_header] if block was given, return response body and response header through block arguments
+  # @yieldparam response_body [Hashie::Mash] response body
+  # @yieldparam response_header [Hash<String, String>] response header (e.g. X-Rate-Limit-Limit, X-Rate-Limit-Reset, X-Rate-Limit-Remaining)
+  #
+  # @return [Hashie::Mash]
+  def find_employment_type(id:, &block)
+    get("/employment_types/#{id}", &block)
+  end
+
+  # Change the data of the specified group
+  #
+  # @see https://developer.smarthr.jp/api/index.html#!/%E9%9B%87%E7%94%A8%E5%BD%A2%E6%85%8B/patchV1EmploymentTypesId
+  #
+  # @param id   [String]
+  # @param body [Hash]
+  #
+  # @yield [response_body, response_header] if block was given, return response body and response header through block arguments
+  # @yieldparam response_body [Hashie::Mash] response body
+  # @yieldparam response_header [Hash<String, String>] response header (e.g. X-Rate-Limit-Limit, X-Rate-Limit-Reset, X-Rate-Limit-Remaining)
+  #
+  # @return [Hashie::Mash]
+  def update_employment_type(id:, body:, &block)
+    patch("/employment_types/#{id}", body, &block)
+  end
+
+  # Get the list of employment types
+  #
+  # @see https://developer.smarthr.jp/api/index.html#!/%E9%9B%87%E7%94%A8%E5%BD%A2%E6%85%8B/getV1EmploymentTypes
+  #
+  # @param page            [Integer]
+  # @param per_page        [Integer]
+  #
+  # @yield [response_body, response_header] if block was given, return response body and response header through block arguments
+  # @yieldparam response_body [Array<Hashie::Mash>] response body
+  # @yieldparam response_header [Hash<String, String>] response header (e.g. X-Rate-Limit-Limit, X-Rate-Limit-Reset, X-Rate-Limit-Remaining)
+  #
+  # @return [Array<Hashie::Mash>]
+  def get_employment_types(page: 1, per_page: 10, &block)
+    get("/employment_types",
+      page: page,
+      per_page: per_page,
+      &block
+    )
+  end
+
+  # Create a new employment type
+  #
+  # @see https://developer.smarthr.jp/api/index.html#!/%E9%9B%87%E7%94%A8%E5%BD%A2%E6%85%8B/postV1EmploymentTypes
+  #
+  # @param body [Hash]
+  #
+  # @yield [response_body, response_header] if block was given, return response body and response header through block arguments
+  # @yieldparam response_body [Hashie::Mash] response body
+  # @yieldparam response_header [Hash<String, String>] response header (e.g. X-Rate-Limit-Limit, X-Rate-Limit-Reset, X-Rate-Limit-Remaining)
+  #
+  # @return [Hashie::Mash]
+  def create_employment_type(body:, &block)
+    post("/employment_types", body, &block)
+  end
+end