module Crowdin::ApiResources::Users

Public Instance Methods

add_project_member(query = {}, project_id = config.project_id) click to toggle source

– For Enterprise mode only –

# File lib/crowdin-api/api_resources/users.rb, line 41
def add_project_member(query = {}, project_id = config.project_id)
  enterprise_mode? || raise_only_for_enterprise_mode_error
  project_id       || raise_project_id_is_required_error

  request = Web::Request.new(
    connection,
    :post,
    "#{config.target_api_url}/projects/#{project_id}/members",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end
delete_member_from_project(member_id = nil, query = {}, project_id = config.project_id) click to toggle source
# File lib/crowdin-api/api_resources/users.rb, line 81
def delete_member_from_project(member_id = nil, query = {}, project_id = config.project_id)
  enterprise_mode? || raise_only_for_enterprise_mode_error
  member_id        || raise_parameter_is_required_error(:member_id)
  project_id       || raise_project_id_is_required_error

  response = ::RestClient::Request.execute(
    {
      method: :delete,
      url: config.base_url + config.target_api_url + "/projects/#{project_id}/members/#{member_id}",
      payload: query.to_json
    }.merge(@options)
  )

  response.body.empty? ? response.code : JSON.parse(response.body)
rescue StandardError => e
  e.message
end
delete_user(user_id = nil) click to toggle source
# File lib/crowdin-api/api_resources/users.rb, line 135
def delete_user(user_id = nil)
  enterprise_mode? || raise_only_for_enterprise_mode_error
  user_id          || raise_parameter_is_required_error(:user_id)

  request = Web::Request.new(
    connection,
    :delete,
    "#{config.target_api_url}/users/#{user_id}"
  )
  Web::SendRequest.new(request).perform
end
edit_user(user_id = nil, query = {}) click to toggle source
# File lib/crowdin-api/api_resources/users.rb, line 147
def edit_user(user_id = nil, query = {})
  enterprise_mode? || raise_only_for_enterprise_mode_error
  user_id          || raise_parameter_is_required_error(:user_id)

  request = Web::Request.new(
    connection,
    :patch,
    "#{config.target_api_url}/users/#{user_id}",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end
get_authenticated_user() click to toggle source
# File lib/crowdin-api/api_resources/users.rb, line 6
def get_authenticated_user
  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/user"
  )
  Web::SendRequest.new(request).perform
end
get_member_info(member_id = nil, project_id = config.project_id) click to toggle source
# File lib/crowdin-api/api_resources/users.rb, line 27
def get_member_info(member_id = nil, project_id = config.project_id)
  member_id  || raise_parameter_is_required_error(:member_id)
  project_id || raise_project_id_is_required_error

  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/projects/#{project_id}/members/#{member_id}"
  )
  Web::SendRequest.new(request).perform
end
get_project_member_permissions(member_id = nil, project_id = config.project_id) click to toggle source
# File lib/crowdin-api/api_resources/users.rb, line 54
def get_project_member_permissions(member_id = nil, project_id = config.project_id)
  enterprise_mode? || raise_only_for_enterprise_mode_error
  member_id        || raise_parameter_is_required_error(:member_id)
  project_id       || raise_project_id_is_required_error

  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/projects/#{project_id}/members/#{member_id}"
  )
  Web::SendRequest.new(request).perform
end
get_user(user_id = nil) click to toggle source
# File lib/crowdin-api/api_resources/users.rb, line 123
def get_user(user_id = nil)
  enterprise_mode? || raise_only_for_enterprise_mode_error
  user_id          || raise_parameter_is_required_error(:user_id)

  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/users/#{user_id}"
  )
  Web::SendRequest.new(request).perform
end
invite_user(query = {}) click to toggle source
# File lib/crowdin-api/api_resources/users.rb, line 111
def invite_user(query = {})
  enterprise_mode? || raise_only_for_enterprise_mode_error

  request = Web::Request.new(
    connection,
    :post,
    "#{config.target_api_url}/users",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end
list_project_members(query = {}, project_id = config.project_id) click to toggle source
# File lib/crowdin-api/api_resources/users.rb, line 15
def list_project_members(query = {}, project_id = config.project_id)
  project_id || raise_project_id_is_required_error

  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/projects/#{project_id}/members",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end
list_users(query = {}) click to toggle source
# File lib/crowdin-api/api_resources/users.rb, line 99
def list_users(query = {})
  enterprise_mode? || raise_only_for_enterprise_mode_error

  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/users",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end
replace_project_permissions(member_id = nil, query = {}, project_id = config.project_id) click to toggle source
# File lib/crowdin-api/api_resources/users.rb, line 67
def replace_project_permissions(member_id = nil, query = {}, project_id = config.project_id)
  enterprise_mode? || raise_only_for_enterprise_mode_error
  member_id        || raise_parameter_is_required_error(:member_id)
  project_id       || raise_project_id_is_required_error

  request = Web::Request.new(
    connection,
    :put,
    "#{config.target_api_url}/projects/#{project_id}/members/#{member_id}",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end