module Crowdin::ApiResources::SourceFiles

Public Instance Methods

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

@param query [Hash] Request Body

# File lib/crowdin-api/api_resources/source_files.rb, line 24
def add_branch(query = {}, project_id = config.project_id)
  project_id || raise_project_id_is_required_error

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

@param query [Hash] Request Body

# File lib/crowdin-api/api_resources/source_files.rb, line 101
def add_directory(query = {}, project_id = config.project_id)
  project_id || raise_project_id_is_required_error

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

@param query [Hash] Request Body

# File lib/crowdin-api/api_resources/source_files.rb, line 178
def add_file(query = {}, project_id = config.project_id)
  project_id || raise_project_id_is_required_error

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

@param branch_id [Hash] Branch ID

# File lib/crowdin-api/api_resources/source_files.rb, line 54
def delete_branch(branch_id = nil, project_id = config.project_id)
  branch_id  || raise_parameter_is_required_error(:branch_id)
  project_id || raise_project_id_is_required_error

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

@param directory_id [Integer] Directory ID

# File lib/crowdin-api/api_resources/source_files.rb, line 131
def delete_directory(directory_id = nil, project_id = config.project_id)
  directory_id || raise_parameter_is_required_error(:directory_id)
  project_id   || raise_project_id_is_required_error

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

@param file_id [Integer] File ID

# File lib/crowdin-api/api_resources/source_files.rb, line 225
def delete_file(file_id = nil, project_id = config.project_id)
  file_id    || raise_parameter_is_required_error(:file_id)
  project_id || raise_project_id_is_required_error

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

@param file_id [Integer] File ID @param destination [String] Destination of File

# File lib/crowdin-api/api_resources/source_files.rb, line 258
def download_file(file_id = nil, destination = nil, project_id = config.project_id)
  file_id     || raise_parameter_is_required_error(:file_id)
  project_id  || raise_project_id_is_required_error

  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/projects/#{project_id}/files/#{file_id}/download"
  )
  Web::SendRequest.new(request, destination).perform
end
edit_branch(branch_id = nil, query = {}, project_id = config.project_id) click to toggle source

@param query [Hash] Request Body @param branch_id [Integer] Branch ID

# File lib/crowdin-api/api_resources/source_files.rb, line 70
def edit_branch(branch_id = nil, query = {}, project_id = config.project_id)
  branch_id  || raise_parameter_is_required_error(:branch_id)
  project_id || raise_project_id_is_required_error

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

@param query [Hash] Request Body @param directory_id [Integer] Directory ID

# File lib/crowdin-api/api_resources/source_files.rb, line 147
def edit_directory(directory_id = nil, query = {}, project_id = config.project_id)
  directory_id || raise_parameter_is_required_error(:directory_id)
  project_id   || raise_project_id_is_required_error

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

@param query [Hash] Request Body @param file_id [Integer] File ID

# File lib/crowdin-api/api_resources/source_files.rb, line 241
def edit_file(file_id = nil, query = {}, project_id = config.project_id)
  file_id    || raise_parameter_is_required_error(:file_id)
  project_id || raise_project_id_is_required_error

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

@param branch_id [Integer] Branch ID

# File lib/crowdin-api/api_resources/source_files.rb, line 39
def get_branch(branch_id = nil, project_id = config.project_id)
  branch_id  || raise_parameter_is_required_error(:branch_id)
  project_id || raise_project_id_is_required_error

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

@param directory_id [Integer] Directory ID

# File lib/crowdin-api/api_resources/source_files.rb, line 116
def get_directory(directory_id = nil, project_id = config.project_id)
  directory_id || raise_parameter_is_required_error(:directory_id)
  project_id   || raise_project_id_is_required_error

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

@param file_id [Integer] File ID

# File lib/crowdin-api/api_resources/source_files.rb, line 193
def get_file(file_id = nil, project_id = config.project_id)
  file_id    || raise_parameter_is_required_error(:file_id)
  project_id || raise_project_id_is_required_error

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

@param revision_id [Integer] Revision ID @param file_id [Integer] File ID

# File lib/crowdin-api/api_resources/source_files.rb, line 291
def get_file_revision(file_id = nil, revision_id = nil, project_id = config.project_id)
  file_id     || raise_parameter_is_required_error(:file_id)
  revision_id || raise_parameter_is_required_error(:revision_id)
  project_id  || raise_project_id_is_required_error

  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/projects/#{project_id}/files/#{file_id}/revisions/#{revision_id}"
  )
  Web::SendRequest.new(request).perform
end
list_branches(query = {}, project_id = config.project_id) click to toggle source

@param query [Hash] Request Body

# File lib/crowdin-api/api_resources/source_files.rb, line 9
def list_branches(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}/branches",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end
list_directories(query = {}, project_id = config.project_id) click to toggle source

@param query [Hash] Request Body

# File lib/crowdin-api/api_resources/source_files.rb, line 86
def list_directories(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}/directories",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end
list_file_revisions(file_id = nil, query = {}, project_id = config.project_id) click to toggle source

@param query [Hash] Request Body @param file_id [Integer] File ID

# File lib/crowdin-api/api_resources/source_files.rb, line 274
def list_file_revisions(file_id = nil, query = {}, project_id = config.project_id)
  file_id    || raise_parameter_is_required_error(:file_id)
  project_id || raise_project_id_is_required_error

  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/projects/#{project_id}/files/#{file_id}/revisions",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end
list_files(query = {}, project_id = config.project_id) click to toggle source

@param query [Hash] Request Body

# File lib/crowdin-api/api_resources/source_files.rb, line 163
def list_files(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}/files",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end
update_or_restore_file(file_id = nil, query = {}, project_id = config.project_id) click to toggle source

@param query [Hash] Request Body @param file_id [Integer] File ID

# File lib/crowdin-api/api_resources/source_files.rb, line 209
def update_or_restore_file(file_id = nil, query = {}, project_id = config.project_id)
  file_id    || raise_parameter_is_required_error(:file_id)
  project_id || raise_project_id_is_required_error

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