module Crowdin::ApiResources::SourceFiles
Public Instance Methods
@param query [Hash] Request Body
-
{developer.crowdin.com/api/v2/#operation/api.projects.branches.post API Documentation}
-
{developer.crowdin.com/enterprise/api/v2/#operation/api.projects.branches.post Enterprise API Documentation}
# 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
@param query [Hash] Request Body
-
{developer.crowdin.com/api/v2/#operation/api.projects.directories.post API Documentation}
-
{developer.crowdin.com/enterprise/api/v2/#operation/api.projects.directories.post Enterprise API Documentation}
# 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
@param query [Hash] Request Body
-
{developer.crowdin.com/api/v2/#operation/api.projects.files.post API Documentation}
-
{developer.crowdin.com/enterprise/api/v2/#operation/api.projects.files.post Enterprise API Documentation}
# 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
@param branch_id [Hash] Branch ID
-
{developer.crowdin.com/api/v2/#operation/api.projects.branches.delete API Documentation}
-
{developer.crowdin.com/enterprise/api/v2/#operation/api.projects.branches.delete Enterprise API Documentation}
# 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
@param directory_id [Integer] Directory ID
-
{developer.crowdin.com/api/v2/#operation/api.projects.directories.delete API Documentation}
-
{developer.crowdin.com/enterprise/api/v2/#operation/api.projects.directories.delete Enterprise API Documentation}
# 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
@param file_id [Integer] File ID
-
{developer.crowdin.com/api/v2/#operation/api.projects.files.delete API Documentation}
-
{developer.crowdin.com/enterprise/api/v2/#operation/api.projects.files.delete Enterprise API Documentation}
# 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
@param file_id [Integer] File ID @param destination [String] Destination of File
-
{developer.crowdin.com/api/v2/#operation/api.projects.files.download.get API Documentation}
-
{developer.crowdin.com/enterprise/api/v2/#operation/api.projects.files.download.get Enterprise API Documentation}
# 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
@param query [Hash] Request Body @param branch_id [Integer] Branch ID
-
{developer.crowdin.com/api/v2/#operation/api.projects.branches.patch API Documentation}
-
{developer.crowdin.com/enterprise/api/v2/#operation/api.projects.branches.patch Enterprise API Documentation}
# 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
@param query [Hash] Request Body @param directory_id [Integer] Directory ID
-
{developer.crowdin.com/api/v2/#operation/api.projects.directories.patch API Documentation}
-
{developer.crowdin.com/enterprise/api/v2/#operation/api.projects.directories.patch Enterprise API Documentation}
# 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
@param query [Hash] Request Body @param file_id [Integer] File ID
-
{developer.crowdin.com/api/v2/#operation/api.projects.files.patch API Documentation}
-
{developer.crowdin.com/enterprise/api/v2/#operation/api.projects.files.patch Enterprise API Documentation}
# 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
@param branch_id [Integer] Branch ID
-
{developer.crowdin.com/api/v2/#operation/api.projects.branches.get API Documentation}
-
{developer.crowdin.com/enterprise/api/v2/#operation/api.projects.branches.get Enterprise API Documentation}
# 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
@param directory_id [Integer] Directory ID
-
{developer.crowdin.com/api/v2/#operation/api.projects.directories.get API Documentation}
-
{developer.crowdin.com/enterprise/api/v2/#operation/api.projects.directories.get Enterprise API Documentation}
# 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
@param file_id [Integer] File ID
-
{developer.crowdin.com/api/v2/#operation/api.projects.files.get API Documentation}
-
{developer.crowdin.com/enterprise/api/v2/#operation/api.projects.files.get Enterprise API Documentation}
# 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
@param revision_id [Integer] Revision ID @param file_id [Integer] File ID
-
{developer.crowdin.com/api/v2/#operation/api.projects.files.revisions.get API Documentation}
-
{developer.crowdin.com/enterprise/api/v2/#operation/api.projects.files.revisions.get Enterprise API Documentation}
# 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
@param query [Hash] Request Body
-
{developer.crowdin.com/api/v2/#operation/api.projects.branches.getMany API Documentation}
-
{developer.crowdin.com/enterprise/api/v2/#operation/api.projects.branches.getMany Enterprise API Documentation}
# 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
@param query [Hash] Request Body
-
{developer.crowdin.com/api/v2/#operation/api.projects.directories.getMany API Documentation}
-
{developer.crowdin.com/enterprise/api/v2/#operation/api.projects.directories.getMany Enterprise API Documentation}
# 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
@param query [Hash] Request Body @param file_id [Integer] File ID
-
{developer.crowdin.com/api/v2/#operation/api.projects.files.revisions.getMany API Documentation}
-
{developer.crowdin.com/enterprise/api/v2/#operation/api.projects.files.revisions.getMany Enterprise API Documentation}
# 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
@param query [Hash] Request Body
-
{developer.crowdin.com/api/v2/#operation/api.projects.files.getMany API Documentation}
-
{developer.crowdin.com/enterprise/api/v2/#operation/api.projects.files.getMany Enterprise API Documentation}
# 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
@param query [Hash] Request Body @param file_id [Integer] File ID
-
{developer.crowdin.com/api/v2/#operation/api.projects.files.put API Documentation}
-
{developer.crowdin.com/enterprise/api/v2/#operation/api.projects.files.put Enterprise API Documentation}
# 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