module Crowdin::ApiResources::Projects

Public Instance Methods

add_group(query = {}) click to toggle source

@param query [Hash] Request Body

# File lib/crowdin-api/api_resources/projects.rb, line 177
def add_group(query = {})
  enterprise_mode? || raise_only_for_enterprise_mode_error

  request = Web::Request.new(
    connection,
    :post,
    "#{config.target_api_url}/groups",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end
add_project(query = {}) click to toggle source

@param query [Hash] Request Body

# File lib/crowdin-api/api_resources/projects.rb, line 22
def add_project(query = {})
  request = Web::Request.new(
    connection,
    :post,
    "#{config.target_api_url}/projects",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end
add_project_strings_exporter_settings(project_id = nil, query = {}) click to toggle source

@param project_id [Integer] Project ID @param query [Hash] Request Body

# File lib/crowdin-api/api_resources/projects.rb, line 94
def add_project_strings_exporter_settings(project_id = nil, query = {})
  project_id || raise_parameter_is_required_error(:project_id)

  request = Web::Request.new(
    connection,
    :post,
    "#{config.target_api_url}/projects/#{project_id}/strings-exporter-settings",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end
delete_group(group_id = nil) click to toggle source

@param group_id [Integer] Group ID

# File lib/crowdin-api/api_resources/projects.rb, line 205
def delete_group(group_id = nil)
  enterprise_mode? || raise_only_for_enterprise_mode_error
  group_id         || raise_parameter_is_required_error(:group_id)

  request = Web::Request.new(
    connection,
    :delete,
    "#{config.target_api_url}/groups/#{group_id}"
  )
  Web::SendRequest.new(request).perform
end
delete_project(project_id = nil) click to toggle source

@param project_id [Integer] Project ID

# File lib/crowdin-api/api_resources/projects.rb, line 49
def delete_project(project_id = nil)
  project_id || raise_parameter_is_required_error(:project_id)

  request = Web::Request.new(
    connection,
    :delete,
    "#{config.target_api_url}/projects/#{project_id}"
  )
  Web::SendRequest.new(request).perform
end
delete_project_strings_exporter_settings(project_id = nil, system_strings_exporter_settings_id = nil) click to toggle source

@param project_id [Integer] Project ID @param system_strings_exporter_settings_id [Integer] Request Body

# File lib/crowdin-api/api_resources/projects.rb, line 127
def delete_project_strings_exporter_settings(project_id = nil, system_strings_exporter_settings_id = nil)
  project_id || raise_parameter_is_required_error(:project_id)
  system_strings_exporter_settings_id || raise_parameter_is_required_error(:system_strings_exporter_settings_id)

  path = "projects/#{project_id}/strings-exporter-settings/#{system_strings_exporter_settings_id}"
  request = Web::Request.new(
    connection,
    :delete,
    "#{config.target_api_url}/#{path}"
  )
  Web::SendRequest.new(request).perform
end
edit_group(group_id = nil, query = {}) click to toggle source

@param group_id [Integer] Group ID @param query [Hash] Request Body

# File lib/crowdin-api/api_resources/projects.rb, line 220
def edit_group(group_id = nil, query = {})
  enterprise_mode? || raise_only_for_enterprise_mode_error
  group_id         || raise_parameter_is_required_error(:group_id)

  request = Web::Request.new(
    connection,
    :patch,
    "#{config.target_api_url}/groups/#{group_id}",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end
edit_project(project_id = nil, query = {}) click to toggle source

@param project_id [Integer] Project ID @param query [Hash] Request Body

# File lib/crowdin-api/api_resources/projects.rb, line 64
def edit_project(project_id = nil, query = {})
  project_id || raise_parameter_is_required_error(:project_id)

  request = Web::Request.new(
    connection,
    :patch,
    "#{config.target_api_url}/projects/#{project_id}",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end
edit_project_strings_exporter_settings(project_id = nil, system_strings_exporter_settings_id = nil, query = {}) click to toggle source

@param project_id [Integer] Project ID @param system_strings_exporter_settings_id [Integer] Request Body @param query [Hash] Request Body

# File lib/crowdin-api/api_resources/projects.rb, line 145
def edit_project_strings_exporter_settings(project_id = nil, system_strings_exporter_settings_id = nil, query = {})
  project_id || raise_parameter_is_required_error(:project_id)
  system_strings_exporter_settings_id || raise_parameter_is_required_error(:system_strings_exporter_settings_id)

  path = "projects/#{project_id}/strings-exporter-settings/#{system_strings_exporter_settings_id}"
  request = Web::Request.new(
    connection,
    :patch,
    "#{config.target_api_url}/#{path}",
    params: query
  )
  Web::SendRequest.new(request).perform
end
get_group(group_id = nil) click to toggle source

@param group_id [Integer] Group ID

# File lib/crowdin-api/api_resources/projects.rb, line 191
def get_group(group_id = nil)
  enterprise_mode? || raise_only_for_enterprise_mode_error
  group_id         || raise_parameter_is_required_error(:group_id)

  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/groups/#{group_id}"
  )
  Web::SendRequest.new(request).perform
end
get_project(project_id = nil) click to toggle source

@param project_id [Integer] Project ID

# File lib/crowdin-api/api_resources/projects.rb, line 35
def get_project(project_id = nil)
  project_id || raise_parameter_is_required_error(:project_id)

  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/projects/#{project_id}"
  )
  Web::SendRequest.new(request).perform
end
get_project_strings_exporter_settings(project_id = nil, system_strings_exporter_settings_id = nil) click to toggle source

@param project_id [Integer] Project ID @param system_strings_exporter_settings_id [Integer] Request Body

# File lib/crowdin-api/api_resources/projects.rb, line 110
def get_project_strings_exporter_settings(project_id = nil, system_strings_exporter_settings_id = nil)
  project_id || raise_parameter_is_required_error(:project_id)
  system_strings_exporter_settings_id || raise_parameter_is_required_error(:system_strings_exporter_settings_id)

  path = "projects/#{project_id}/strings-exporter-settings/#{system_strings_exporter_settings_id}"
  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/#{path}"
  )
  Web::SendRequest.new(request).perform
end
list_groups(query = {}) click to toggle source

@param query [Hash] Request Body

# File lib/crowdin-api/api_resources/projects.rb, line 163
def list_groups(query = {})
  enterprise_mode? || raise_only_for_enterprise_mode_error

  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/groups",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end
list_project_strings_exporter_settings(project_id = nil) click to toggle source

@param project_id [Integer] Project ID

# File lib/crowdin-api/api_resources/projects.rb, line 79
def list_project_strings_exporter_settings(project_id = nil)
  project_id || raise_parameter_is_required_error(:project_id)

  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/projects/#{project_id}/strings-exporter-settings"
  )
  Web::SendRequest.new(request).perform
end
list_projects(query = {}) click to toggle source

@param query [Hash] Request Body

# File lib/crowdin-api/api_resources/projects.rb, line 9
def list_projects(query = {})
  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/projects",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end