class Smartling::File
Public Class Methods
Smartling::Api::new
# File lib/smartling/fileapi.rb, line 21 def initialize(args = {}) super(args) @projectId = args[:projectId] end
Public Instance Methods
Delete - /files-api/v2/projects/{projectId}/file/delete (POST)
# File lib/smartling/fileapi.rb, line 103 def delete(name, params = nil) keys = { :fileUri => name } uri = uri("files-api/v2/projects/#{@projectId}/file/delete", keys, params).require(:fileUri) return post(uri) end
Download Original File
- /files-api/v2/projects/{projectId}/file (GET)
# File lib/smartling/fileapi.rb, line 53 def download(name, params = nil) keys = { :fileUri => name } uri = uri("files-api/v2/projects/#{@projectId}/file", keys, params).require(:fileUri) return get_raw(uri) end
Download Translated File
- All Locales in one File
- CSV - /files-api/v2/projects/{projectId}/locales/all/file (GET)
# File lib/smartling/fileapi.rb, line 81 def download_all_translated_csv(name, params = nil) keys = { :fileUri => name } uri = uri("files-api/v2/projects/#{@projectId}/locales/all/file", keys, params).require(:fileUri) return get_raw(uri) end
Download Translated File
- All Locales as .ZIP - /files-api/v2/projects/{projectId}/locales/all/file/zip (GET)
# File lib/smartling/fileapi.rb, line 74 def download_all_translated_zip(name, params = nil) keys = { :fileUri => name } uri = uri("files-api/v2/projects/#{@projectId}/locales/all/file/zip", keys, params).require(:fileUri) return get_raw(uri) end
Download Translated File
- Single Locale - /files-api/v2/projects/{projectId}/locales/{localeId}/file (GET)
# File lib/smartling/fileapi.rb, line 60 def download_translated(name, locale, params = nil) keys = { :fileUri => name } uri = uri("files-api/v2/projects/#{@projectId}/locales/#{locale}/file", keys, params).require(:fileUri) return get_raw(uri) end
Download Translated Files - Multiple Locales as .ZIP - /files-api/v2/projects/{projectId}/files/zip (GET)
# File lib/smartling/fileapi.rb, line 67 def download_translated_zip(names, params = nil) keys = { :fileUris => names, :localeIds => locales } uri = uri("files-api/v2/projects/#{@projectId}/files/zip", keys, params).require(:fileUris, :localeIds) return get_raw(uri) end
Import Translations - /files-api/v2/projects/{projectId}/locales/{localeId}/file/import (POST or PUT)
# File lib/smartling/fileapi.rb, line 131 def import(locale, file, name, type, state, params = nil) keys = { :fileUri => name, :fileType => type, :translationState => state} uri = uri("files-api/v2/projects/#{@projectId}/locales/#{locale}/file/import", keys, params).require(:fileUri, :fileType, :translationState) file = ::File.open(file, 'rb') if file.is_a?(String) return post_file(uri, :file => file) end
Last Modified (by locale) - /files-api/v2/projects/{projectId}/locales/{localeId}/file/last-modified (GET)
# File lib/smartling/fileapi.rb, line 110 def last_modified(name, locale, params = nil) keys = { :fileUri => name } uri = uri("files-api/v2/projects/#{@projectId}/locales/#{locale}/file/last-modified", keys, params).require(:fileUri) return get(uri) end
Last Modified (all locales) - /files-api/v2/projects/{projectId}/file/last-modified (GET)
# File lib/smartling/fileapi.rb, line 117 def last_modified_all(name, params = nil) keys = { :fileUri => name } uri = uri("files-api/v2/projects/#{@projectId}/file/last-modified", keys, params).require(:fileUri) return get(uri) end
List Files - /files-api/v2/projects/{projectId}/files/list (GET)
# File lib/smartling/fileapi.rb, line 27 def list(params = nil) uri = uri("files-api/v2/projects/#{@projectId}/files/list", params) return get(uri) end
List File
Types - /files-api/v2/projects/{projectId}/file-types (GET)
# File lib/smartling/fileapi.rb, line 33 def list_types(params = nil) uri = uri("files-api/v2/projects/#{@projectId}/file-types", params) return get(uri) end
Rename - /files-api/v2/projects/{projectId}/file/rename (POST)
# File lib/smartling/fileapi.rb, line 96 def rename(name, newname, params = nil) keys = { :fileUri => name, :newFileUri => newname } uri = uri("files-api/v2/projects/#{@projectId}/file/rename", keys, params).require(:fileUri, :newFileUri) return post(uri) end
Status - Single Locale / Extended Response - /files-api/v2/projects/{projectId}/locales/{localeId}/file/status (GET)
# File lib/smartling/fileapi.rb, line 46 def status(name, locale) keys = { :fileUri => name } uri = uri("files-api/v2/projects/#{@projectId}/locales/#{locale}/file/status", keys, {}).require(:fileUri) return get(uri) end
Status - All Locales - /files-api/v2/projects/{projectId}/file/status (GET)
# File lib/smartling/fileapi.rb, line 39 def status_all(name) keys = { :fileUri => name } uri = uri("files-api/v2/projects/#{@projectId}/file/status", keys, {}).require(:fileUri) return get(uri) end
Get Translations - /files-api/v2/projects/{projectId}/locales/{localeId}/file/get-translations (POST)
# File lib/smartling/fileapi.rb, line 124 def translations(locale, file, fileUri, params = nil) keys = { :fileUri => fileUri } uri = uri("files-api/v2/projects/#{@projectId}/locales/#{locale}/file/get-translations", keys, params).require(:fileUri) return post_file_raw(uri, :file => file) end
Upload File
- /files-api/v2/projects/{projectId}/file (POST)
# File lib/smartling/fileapi.rb, line 88 def upload(file, name, type, params = nil) keys = { :fileUri => name, :fileType => type } uri = uri("files-api/v2/projects/#{@projectId}/file", keys, params).require(:fileUri, :fileType) file = ::File.open(file, 'rb') if file.is_a?(String) return post_file(uri, :file => file) end