ruby-lokalise-api 1.0.1

data/lib/ruby-lokalise-api/rest/contributors.rb

@@ -0,0 +1,54 @@
+module Lokalise
+  class Client
+    # Returns all contributors for the given project
+    #
+    # @see https://lokalise.co/api2docs/ruby/#transition-list-all-contributors-get
+    # @return [Lokalise::Collection::Contributor<Lokalise::Resources::Contributor>]
+    # @param project_id [String]
+    # @param params [Hash]
+    def contributors(project_id, params = {})
+      Lokalise::Collections::Contributor.all self, params, project_id
+    end
+
+    # Returns a single contributor for the given project
+    #
+    # @see https://lokalise.co/api2docs/ruby/#transition-retrieve-a-contributor-get
+    # @return [Lokalise::Resources::Contributor]
+    # @param project_id [String]
+    # @param contributor_id [String, Integer]
+    def contributor(project_id, contributor_id)
+      Lokalise::Resources::Contributor.find self, project_id, contributor_id
+    end
+
+    # Creates one or more contributors inside the given project
+    #
+    # @see https://lokalise.co/api2docs/ruby/#transition-create-contributors-post
+    # @return [Lokalise::Collection::Contributor<Lokalise::Resources::Contributor>]
+    # @param project_id [String]
+    # @param params [Hash, Array<Hash>]
+    def create_contributors(project_id, params)
+      Lokalise::Resources::Contributor.create self, project_id, params, :contributors
+    end
+
+    # Updates the given contributor inside the given project
+    #
+    # @see https://lokalise.co/api2docs/ruby/#transition-update-a-contributor-put
+    # @return [Lokalise::Resources::Contributor]
+    # @param project_id [String]
+    # @param contributor_id [String, Integer]
+    # @param params [Hash]
+    def update_contributor(project_id, contributor_id, params)
+      Lokalise::Resources::Contributor.update self, project_id, contributor_id, params
+    end
+
+    # Deletes contributor inside the given project
+    #
+    # @see https://lokalise.co/api2docs/ruby/#transition-delete-a-contributor-delete
+    # @return [Hash]
+    # @param project_id [String]
+    # @param contributor_id [String, Integer]
+    def delete_contributor(project_id, contributor_id)
+      Lokalise::Resources::Contributor.destroy self, project_id, contributor_id
+    end
+  end
+end

data/lib/ruby-lokalise-api/rest/files.rb

@@ -0,0 +1,33 @@
+module Lokalise
+  class Client
+    # Returns all translation files for the given project
+    #
+    # @see https://lokalise.co/api2docs/ruby/#transition-list-all-files-get
+    # @return [Lokalise::Collection::File<Lokalise::Resources::File>]
+    # @param project_id [String]
+    # @param params [Hash]
+    def files(project_id, params = {})
+      Lokalise::Collections::File.all self, params, project_id
+    end
+
+    # Exports translation files as .zip bundle, uploads them to Amazon S3 and returns a URL to the generated bundle. The URL is valid for a year
+    #
+    # @see https://lokalise.co/api2docs/ruby/#transition-download-files-post
+    # @return [Hash]
+    # @param project_id [String]
+    # @param params [Hash]
+    def download_files(project_id, params)
+      Lokalise::Resources::File.download self, project_id, params
+    end
+
+    # Imports translation file to the given project. File data must base64-encoded
+    #
+    # @see https://lokalise.co/api2docs/ruby/#transition-upload-a-file-post
+    # @return [Hash]
+    # @param project_id [String]
+    # @param params [Hash]
+    def upload_file(project_id, params)
+      Lokalise::Resources::File.upload self, project_id, params
+    end
+  end
+end

data/lib/ruby-lokalise-api/rest/keys.rb

@@ -0,0 +1,75 @@
+module Lokalise
+  class Client
+    # Returns all translation keys for the given project
+    #
+    # @see https://lokalise.co/api2docs/ruby/#transition-list-all-keys-get
+    # @return [Lokalise::Collection::Key<Lokalise::Resources::Key>]
+    # @param project_id [String]
+    # @param params [Hash]
+    def keys(project_id, params = {})
+      Lokalise::Collections::Key.all self, params, project_id
+    end
+
+    # Returns a single translation key for the given project
+    #
+    # @see https://lokalise.co/api2docs/ruby/#transition-retrieve-a-key-get
+    # @return [Lokalise::Resources::Key]
+    # @param project_id [String]
+    # @param key_id [String, Integer]
+    # @param params [Hash]
+    def key(project_id, key_id, params = {})
+      Lokalise::Resources::Key.find self, project_id, key_id, params
+    end
+
+    # Creates one or more translation keys for the given project
+    #
+    # @see https://lokalise.co/api2docs/ruby/#transition-create-keys-post
+    # @return [Lokalise::Collection::Key<Lokalise::Resources::Key>]
+    # @param project_id [String]
+    # @param params [Hash, Array<Hash>]
+    def create_keys(project_id, params = {})
+      Lokalise::Resources::Key.create self, project_id, params, :keys
+    end
+
+    # Updates translation key for the given project
+    #
+    # @see https://lokalise.co/api2docs/ruby/#transition-update-a-key-put
+    # @return [Lokalise::Resources::Key]
+    # @param project_id [String]
+    # @param key_id [String, Integer]
+    # @param params [Hash]
+    def update_key(project_id, key_id, params = {})
+      Lokalise::Resources::Key.update self, project_id, key_id, params
+    end
+
+    # Updates one or multiple translation keys for the given project
+    #
+    # @see https://lokalise.co/api2docs/ruby/#transition-bulk-update-put
+    # @return [Lokalise::Collection::Key<Lokalise::Resources::Key>]
+    # @param project_id [String]
+    # @param params [Hash, Array<Hash>]
+    def update_keys(project_id, params)
+      Lokalise::Resources::Key.update self, project_id, nil, params, :keys
+    end
+
+    # Deletes translation key for the given project
+    #
+    # @see https://lokalise.co/api2docs/ruby/#transition-delete-a-key-delete
+    # @return [Hash]
+    # @param project_id [String]
+    # @param key_id [String, Integer]
+    def delete_key(project_id, key_id)
+      Lokalise::Resources::Key.destroy self, project_id, key_id
+    end
+
+    # Deletes one or multiple translation keys for the given project
+    #
+    # @see https://lokalise.co/api2docs/ruby/#transition-delete-multiple-keys-delete
+    # @return [Hash]
+    # @param project_id [String]
+    # @param key_ids [String, Integer, Array<String>, Array<Integer>]
+    def delete_keys(project_id, key_ids)
+      Lokalise::Resources::Key.destroy self, project_id, keys: key_ids
+    end
+  end
+end

data/lib/ruby-lokalise-api/rest/languages.rb

@@ -0,0 +1,63 @@
+module Lokalise
+  class Client
+    # Returns all languages supported by Lokalise
+    #
+    # @see https://lokalise.co/api2docs/ruby/#transition-list-system-languages-get
+    # @return [Lokalise::Collection::SystemLanguage<Lokalise::Resources::SystemLanguage>]
+    # @param params [Hash]
+    def system_languages(params = {})
+      Lokalise::Collections::SystemLanguage.all self, params
+    end
+
+    # Returns all languages for the given project
+    #
+    # @see https://lokalise.co/api2docs/ruby/#transition-list-project-languages-get
+    # @return [Lokalise::Collection::ProjectLanguage<Lokalise::Resources::ProjectLanguage>]
+    # @param project_id [String, Integer]
+    # @param params [Hash]
+    def project_languages(project_id, params = {})
+      Lokalise::Collections::ProjectLanguage.all self, params, project_id
+    end
+
+    # Returns a single language for the given project
+    #
+    # @see https://lokalise.co/api2docs/ruby/#transition-retrieve-a-language-get
+    # @return [Lokalise::Resources::ProjectLanguage]
+    # @param project_id [String]
+    # @param language_id [String, Integer]
+    def language(project_id, language_id)
+      Lokalise::Resources::ProjectLanguage.find self, project_id, language_id
+    end
+
+    # Creates one or more language for the given project
+    #
+    # @see https://lokalise.co/api2docs/ruby/#transition-retrieve-a-language-get
+    # @return [Lokalise::Collection::ProjectLanguage<Lokalise::Resources::ProjectLanguage>]
+    # @param project_id [String]
+    # @param params [Hash]
+    def create_languages(project_id, params)
+      Lokalise::Resources::ProjectLanguage.create self, project_id, params, :languages
+    end
+
+    # Updates language for the given project
+    #
+    # @see https://lokalise.co/api2docs/ruby/#transition-update-a-language-put
+    # @return [Lokalise::Resources::ProjectLanguage]
+    # @param project_id [String]
+    # @param language_id [String, Integer]
+    # @param params [Hash]
+    def update_language(project_id, language_id, params)
+      Lokalise::Resources::ProjectLanguage.update self, project_id, language_id, params
+    end
+
+    # Deletes language for the given project
+    #
+    # @see https://lokalise.co/api2docs/ruby/#transition-delete-a-language-delete
+    # @return [Hash]
+    # @param project_id [String]
+    # @param language_id [String, Integer]
+    def delete_language(project_id, language_id)
+      Lokalise::Resources::ProjectLanguage.destroy self, project_id, language_id
+    end
+  end
+end

data/lib/ruby-lokalise-api/rest/projects.rb

@@ -0,0 +1,58 @@
+module Lokalise
+  class Client
+    # Returns all projects available to the user authorized with the API token
+    #
+    # @see https://lokalise.co/api2docs/ruby/#transition-list-all-projects-get
+    # @return [Lokalise::Collection::Project<Lokalise::Resources::Project>]
+    # @param params [Hash]
+    def projects(params = {})
+      Lokalise::Collections::Project.all self, params
+    end
+
+    # Returns a single project
+    #
+    # @see https://lokalise.co/api2docs/ruby/#transition-retrieve-a-project-get
+    # @return [Lokalise::Resources::Project]
+    # @param project_id [String, Integer]
+    def project(project_id)
+      Lokalise::Resources::Project.find self, nil, project_id
+    end
+
+    # Creates project
+    #
+    # @see https://lokalise.co/api2docs/ruby/#transition-create-a-project-post
+    # @return [Lokalise::Resources::Project]
+    # @param params [Hash]
+    def create_project(params)
+      Lokalise::Resources::Project.create self, nil, params
+    end
+
+    # Updates project
+    #
+    # @see https://lokalise.co/api2docs/ruby/#transition-update-a-project-put
+    # @return [Lokalise::Resources::Project]
+    # @param project_id [String, Integer]
+    # @param params [Hash]
+    def update_project(project_id, params)
+      Lokalise::Resources::Project.update self, nil, project_id, params
+    end
+
+    # Deletes all keys and translations from the project
+    #
+    # @see https://lokalise.co/api2docs/ruby/#transition-empty-a-project-put
+    # @return [Hash]
+    # @param project_id [String, Integer]
+    def empty_project(project_id)
+      Lokalise::Resources::Project.clear self, project_id
+    end
+
+    # Deletes the project
+    #
+    # @see https://lokalise.co/api2docs/ruby/#transition-delete-a-project-delete
+    # @return [Hash]
+    # @param project_id [String, Integer]
+    def delete_project(project_id)
+      Lokalise::Resources::Project.destroy self, nil, project_id
+    end
+  end
+end

data/lib/ruby-lokalise-api/rest/screenshots.rb

@@ -0,0 +1,54 @@
+module Lokalise
+  class Client
+    # Returns all screenshots for the given project
+    #
+    # @see https://lokalise.co/api2docs/ruby/#transition-list-all-screenshots-get
+    # @return [Lokalise::Collection::Screenshot<Lokalise::Resources::Screenshot>]
+    # @param project_id [String]
+    # @param params [Hash]
+    def screenshots(project_id, params = {})
+      Lokalise::Collections::Screenshot.all self, params, project_id
+    end
+
+    # Returns a single screenshot for the given project
+    #
+    # @see https://lokalise.co/api2docs/ruby/#transition-retrieve-a-screenshot-get
+    # @return [Lokalise::Resources::Screenshot]
+    # @param project_id [String]
+    # @param screenshot_id [String, Integer]
+    def screenshot(project_id, screenshot_id)
+      Lokalise::Resources::Screenshot.find self, project_id, screenshot_id
+    end
+
+    # Creates one or more screenshots for the given project
+    #
+    # @see https://lokalise.co/api2docs/ruby/#transition-create-screenshots-post
+    # @return [Lokalise::Collection::Screenshot<Lokalise::Resources::Screenshot>]
+    # @param project_id [String]
+    # @param params [Hash]
+    def create_screenshots(project_id, params = {})
+      Lokalise::Resources::Screenshot.create self, project_id, params, :screenshots
+    end
+
+    # Updates screenshot
+    #
+    # @see https://lokalise.co/api2docs/ruby/#transition-update-a-screenshot-put
+    # @return [Lokalise::Resources::Screenshot]
+    # @param project_id [String]
+    # @param screenshot_id [String, Integer]
+    # @param params [Hash]
+    def update_screenshot(project_id, screenshot_id, params = {})
+      Lokalise::Resources::Screenshot.update self, project_id, screenshot_id, params
+    end
+
+    # Deletes screenshot
+    #
+    # @see https://lokalise.co/api2docs/ruby/#transition-delete-a-screenshot-delete
+    # @return [Hash]
+    # @param project_id [String]
+    # @param screenshot_id [String, Integer]
+    def delete_screenshot(project_id, screenshot_id)
+      Lokalise::Resources::Screenshot.destroy self, project_id, screenshot_id
+    end
+  end
+end

data/lib/ruby-lokalise-api/rest/snapshots.rb

@@ -0,0 +1,43 @@
+module Lokalise
+  class Client
+    # Returns all snapshots for the given project
+    #
+    # @see https://lokalise.co/api2docs/ruby/#transition-list-all-snapshots-get
+    # @return [Lokalise::Collection::Snapshot<Lokalise::Resources::Snapshot>]
+    # @param project_id [String]
+    # @param params [Hash]
+    def snapshots(project_id, params = {})
+      Lokalise::Collections::Snapshot.all self, params, project_id
+    end
+
+    # Creates snapshot for the given project
+    #
+    # @see https://lokalise.co/api2docs/ruby/#transition-create-a-snapshot-post
+    # @return [Lokalise::Resources::Snapshot]
+    # @param project_id [String]
+    # @param params [Hash]
+    def create_snapshot(project_id, params = {})
+      Lokalise::Resources::Snapshot.create self, project_id, params
+    end
+
+    # Restore project from the given snapshot by producing project's copy
+    #
+    # @see https://lokalise.co/api2docs/ruby/#transition-restore-a-snapshot-post
+    # @return [Lokalise::Resources::Project]
+    # @param project_id [String]
+    # @param snapshot_id [String, Integer]
+    def restore_snapshot(project_id, snapshot_id)
+      Lokalise::Resources::Snapshot.restore self, project_id, snapshot_id
+    end
+
+    # Deletes snapshot
+    #
+    # @see https://lokalise.co/api2docs/ruby/#transition-delete-a-snapshot-delete
+    # @return [Hash]
+    # @param project_id [String]
+    # @param snapshot_id [String, Integer]
+    def delete_snapshot(project_id, snapshot_id)
+      Lokalise::Resources::Snapshot.destroy self, project_id, snapshot_id
+    end
+  end
+end

data/lib/ruby-lokalise-api/rest/tasks.rb

@@ -0,0 +1,54 @@
+module Lokalise
+  class Client
+    # Returns all tasks for the given project
+    #
+    # @see https://lokalise.co/api2docs/ruby/#transition-list-all-tasks-get
+    # @return [Lokalise::Collection::Task<Lokalise::Resources::Task>]
+    # @param project_id [String]
+    # @param params [Hash]
+    def tasks(project_id, params = {})
+      Lokalise::Collections::Task.all self, params, project_id
+    end
+
+    # Returns a single task for the given project
+    #
+    # @see https://lokalise.co/api2docs/ruby/#transition-retrieve-a-task-get
+    # @return [Lokalise::Resources::Task]
+    # @param project_id [String]
+    # @param task_id [String, Integer]
+    def task(project_id, task_id)
+      Lokalise::Resources::Task.find self, project_id, task_id
+    end
+
+    # Creates task for the given project
+    #
+    # @see https://lokalise.co/api2docs/ruby/#transition-create-a-task-post
+    # @return [Lokalise::Resources::Task]
+    # @param project_id [String]
+    # @param params [Hash]
+    def create_task(project_id, params)
+      Lokalise::Resources::Task.create self, project_id, params
+    end
+
+    # Updates task for the given project
+    #
+    # @see https://lokalise.co/api2docs/ruby/#transition-update-a-task-put
+    # @return [Lokalise::Resources::Task]
+    # @param project_id [String]
+    # @param task_id [String, Integer]
+    # @param params [Hash]
+    def update_task(project_id, task_id, params = {})
+      Lokalise::Resources::Task.update self, project_id, task_id, params
+    end
+
+    # Deletes task for the given project
+    #
+    # @see https://lokalise.co/api2docs/ruby/#transition-delete-a-task-delete
+    # @return [Hash]
+    # @param project_id [String]
+    # @param task_id [String, Integer]
+    def delete_task(project_id, task_id)
+      Lokalise::Resources::Task.destroy self, project_id, task_id
+    end
+  end
+end

data/lib/ruby-lokalise-api/rest/team_users.rb

@@ -0,0 +1,44 @@
+module Lokalise
+  class Client
+    # Returns all team users for the given team
+    #
+    # @see https://lokalise.co/api2docs/ruby/#transition-list-all-team-users-get
+    # @return [Lokalise::Collection::TeamUser<Lokalise::Resources::TeamUser>]
+    # @param team_id [String]
+    # @param params [Hash]
+    def team_users(team_id, params = {})
+      Lokalise::Collections::TeamUser.all self, params, team_id
+    end
+
+    # Returns team user from the given team
+    #
+    # @see https://lokalise.co/api2docs/ruby/#transition-retrieve-a-team-user-get
+    # @return [Lokalise::Resources::TeamUser]
+    # @param team_id [String]
+    # @param user_id [String, Integer]
+    def team_user(team_id, user_id)
+      Lokalise::Resources::TeamUser.find self, team_id, user_id
+    end
+
+    # Updates team user for the given team
+    #
+    # @see https://lokalise.co/api2docs/ruby/#transition-update-a-team-user-put
+    # @return [Lokalise::Resources::TeamUser]
+    # @param team_id [String]
+    # @param user_id [String, Integer]
+    # @param params [Hash]
+    def update_team_user(team_id, user_id, params)
+      Lokalise::Resources::TeamUser.update self, team_id, user_id, params
+    end
+
+    # Deletes team user from the given team
+    #
+    # @see https://lokalise.co/api2docs/ruby/#transition-delete-a-team-user-delete
+    # @return [Lokalise::Resources::TeamUser]
+    # @param team_id [String]
+    # @param user_id [String, Integer]
+    def delete_team_user(team_id, user_id)
+      Lokalise::Resources::TeamUser.destroy self, team_id, user_id
+    end
+  end
+end