module Crowdin::ApiResources::Bundles

Public Instance Methods

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

@param query [Hash] Request Body

# File lib/crowdin-api/api_resources/bundles.rb, line 24
def add_bundle(query = {}, project_id = config.project_id)
  project_id || raise_project_id_is_required_error
  %i[name format sourcePatterns exportPattern].each do |param|
    query[param] || raise_parameter_is_required_error(param)
  end

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

@param bundle_id [Integer] Bundle ID @param query [Hash] Request Body

# File lib/crowdin-api/api_resources/bundles.rb, line 140
def bundle_list_files(bundle_id, query = {}, project_id = config.project_id)
  bundle_id  || raise_parameter_is_required_error(:bundle_id)
  project_id || raise_project_id_is_required_error

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

@param bundle_id [Integer] Bundle ID @param export_id [String] Export ID

# File lib/crowdin-api/api_resources/bundles.rb, line 58
def check_bundle_export_status(bundle_id, export_id, project_id = config.project_id)
  bundle_id || raise_parameter_is_required_error(:bundle_id)
  export_id || raise_parameter_is_required_error(:export_id)
  project_id || raise_project_id_is_required_error

  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/projects/#{project_id}/bundles/#{bundle_id}/exports/#{export_id}"
  )
  Web::SendRequest.new(request).perform
end
delete_bundle(bundle_id, project_id = config.project_id) click to toggle source

@param bundle_id [Integer] Bundle ID

# File lib/crowdin-api/api_resources/bundles.rb, line 107
def delete_bundle(bundle_id, project_id = config.project_id)
  bundle_id  || raise_parameter_is_required_error(:bundle_id)
  project_id || raise_project_id_is_required_error

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

@param bundle_id [Integer] Bundle ID @param export_id [String] Export ID @param destination [String] Destination of File

# File lib/crowdin-api/api_resources/bundles.rb, line 76
def download_bundle(bundle_id, export_id, destination = nil, project_id = config.project_id)
  bundle_id  || raise_parameter_is_required_error(:bundle_id)
  export_id  || raise_parameter_is_required_error(:export_id)
  project_id || raise_project_id_is_required_error

  request = Web::Request.new(
    connection,
    :get,
    "#{config.target_api_url}/projects/#{project_id}/bundles/#{bundle_id}/exports/#{export_id}/download"
  )
  Web::SendRequest.new(request, destination).perform
end
edit_bundle(bundle_id, query = {}, project_id = config.project_id) click to toggle source

@param bundle_id [Integer] Bundle ID @param query [Hash] Request Body

# File lib/crowdin-api/api_resources/bundles.rb, line 123
def edit_bundle(bundle_id, query = {}, project_id = config.project_id)
  bundle_id  || raise_parameter_is_required_error(:bundle_id)
  project_id || raise_project_id_is_required_error

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

@param bundle_id [Integer] Bundle ID

# File lib/crowdin-api/api_resources/bundles.rb, line 42
def export_bundle(bundle_id, project_id = config.project_id)
  bundle_id  || raise_parameter_is_required_error(:bundle_id)
  project_id || raise_project_id_is_required_error

  request = Web::Request.new(
    connection,
    :post,
    "#{config.target_api_url}/projects/#{project_id}/bundles/#{bundle_id}/exports"
  )
  Web::SendRequest.new(request).perform
end
get_bundle(bundle_id, project_id = config.project_id) click to toggle source

@param bundle_id [Integer] Bundle ID

# File lib/crowdin-api/api_resources/bundles.rb, line 92
def get_bundle(bundle_id, project_id = config.project_id)
  bundle_id  || raise_parameter_is_required_error(:bundle_id)
  project_id || raise_project_id_is_required_error

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

@param query [Hash] Request Body

# File lib/crowdin-api/api_resources/bundles.rb, line 9
def list_bundles(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}/bundles",
    { params: query }
  )
  Web::SendRequest.new(request).perform
end