crowdin-api 1.1.1 → 1.3.0

data/lib/crowdin-api/api_resources/string_comments.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Crowdin
+  module ApiResources
+    module StringComments
+      def list_string_comments(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}/comments",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def add_string_comment(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}/comments",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def get_string_comment(string_comment_id = nil, project_id = config.project_id)
+        string_comment_id || raise_parameter_is_required_error(:string_comment_id)
+        project_id        || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/projects/#{project_id}/comments/#{string_comment_id}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def delete_string_comment(string_comment_id = nil, project_id = config.project_id)
+        string_comment_id || raise_parameter_is_required_error(:string_comment_id)
+        project_id        || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :delete,
+          "#{config.target_api_url}/projects/#{project_id}/comments/#{string_comment_id}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def edit_string_comment(string_comment_id = nil, query = {}, project_id = config.project_id)
+        string_comment_id || raise_parameter_is_required_error(:string_comment_id)
+        project_id        || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :patch,
+          "#{config.target_api_url}/projects/#{project_id}/comments/#{string_comment_id}",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+    end
+  end
+end

data/lib/crowdin-api/api_resources/string_translations.rb

@@ -0,0 +1,193 @@
+# frozen_string_literal: true
+
+module Crowdin
+  module ApiResources
+    module StringTranslations
+      def list_translation_approvals(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}/approvals",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def add_approval(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}/approvals",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def get_approval(approval_id = nil, project_id = config.project_id)
+        approval_id || raise_parameter_is_required_error(:approval_id)
+        project_id  || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/projects/#{project_id}/approvals/#{approval_id}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def remove_approval(approval_id = nil, project_id = config.project_id)
+        approval_id || raise_parameter_is_required_error(:approval_id)
+        project_id  || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :delete,
+          "#{config.target_api_url}/projects/#{project_id}/approvals/#{approval_id}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def list_language_translations(language_id = nil, query = {}, project_id = config.project_id)
+        language_id || raise_parameter_is_required_error(:language_id)
+        project_id  || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/projects/#{project_id}/languages/#{language_id}/translations",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def list_string_translations(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}/translations",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def add_translation(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}/translations",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def delete_string_translations(query = {}, project_id = config.project_id)
+        project_id || raise_project_id_is_required_error
+
+        response = ::RestClient::Request.execute(
+          {
+            method: :delete,
+            url: config.base_url + config.target_api_url + "/projects/#{project_id}/translations",
+            payload: query.to_json
+          }.merge(@options)
+        )
+
+        response.body.empty? ? response.code : JSON.parse(response.body)
+      rescue StandardError => e
+        e.message
+      end
+
+      def get_translation(translation_id = nil, query = {}, project_id = config.project_id)
+        translation_id || raise_parameter_is_required_error(:translation_id)
+        project_id     || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/projects/#{project_id}/translations/#{translation_id}",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def restore_translation(translation_id = nil, project_id = config.project_id)
+        translation_id || raise_parameter_is_required_error(:translation_id)
+        project_id     || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :put,
+          "#{config.target_api_url}/projects/#{project_id}/translations/#{translation_id}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def delete_translation(translation_id = nil, project_id = config.project_id)
+        translation_id || raise_parameter_is_required_error(:translation_id)
+        project_id     || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :delete,
+          "#{config.target_api_url}/projects/#{project_id}/translations/#{translation_id}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def list_translation_votes(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}/votes",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def add_vote(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}/votes",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def get_vote(vote_id = nil, project_id = config.project_id)
+        vote_id    || raise_parameter_is_required_error(:vote_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/projects/#{project_id}/votes/#{vote_id}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def edit_screenshot(vote_id = nil, project_id = config.project_id)
+        vote_id    || raise_parameter_is_required_error(:vote_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :delete,
+          "#{config.target_api_url}/projects/#{project_id}/votes/#{vote_id}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+    end
+  end
+end

data/lib/crowdin-api/api_resources/tasks.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+module Crowdin
+  module ApiResources
+    module Tasks
+      def list_tasks(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}/tasks",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def add_task(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}/tasks",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def export_task_strings(task_id = nil, destination = nil, project_id = config.project_id)
+        task_id    || raise_parameter_is_required_error(:task_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :post,
+          "#{config.target_api_url}/projects/#{project_id}/tasks/#{task_id}/exports"
+        )
+        Web::SendRequest.new(request, destination).perform
+      end
+
+      def get_task(task_id = nil, project_id = config.project_id)
+        task_id    || raise_parameter_is_required_error(:task_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/projects/#{project_id}/tasks/#{task_id}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def delete_task(task_id = nil, project_id = config.project_id)
+        task_id    || raise_parameter_is_required_error(:task_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :delete,
+          "#{config.target_api_url}/projects/#{project_id}/tasks/#{task_id}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def edit_task(task_id = nil, query = {}, project_id = config.project_id)
+        task_id    || raise_parameter_is_required_error(:task_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :patch,
+          "#{config.target_api_url}/projects/#{project_id}/tasks/#{task_id}",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def list_user_tasks(query = {})
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/user/tasks",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def edit_task_archived_status(task_id = nil, query = {})
+        task_id || raise_parameter_is_required_error(:task_id)
+
+        request = Web::Request.new(
+          connection,
+          :patch,
+          "#{config.target_api_url}/user/tasks/#{task_id}",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+    end
+  end
+end

data/lib/crowdin-api/api_resources/teams.rb

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+module Crowdin
+  module ApiResources
+    module Teams
+      # -- For Enterprise mode only --
+
+      def add_team_to_project(query = {}, project_id = config.project_id)
+        enterprise_mode? || raise_only_for_enterprise_mode_error
+        project_id       || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :post,
+          "#{config.target_api_url}/projects/#{project_id}/teams",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def list_teams(query = {})
+        enterprise_mode? || raise_only_for_enterprise_mode_error
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/teams",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def add_team(query = {})
+        enterprise_mode? || raise_only_for_enterprise_mode_error
+
+        request = Web::Request.new(
+          connection,
+          :post,
+          "#{config.target_api_url}/teams",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def get_team(team_id = nil, query = {})
+        enterprise_mode? || raise_only_for_enterprise_mode_error
+        team_id          || raise_parameter_is_required_error(:team_id)
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/teams/#{team_id}",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def delete_team(team_id = nil)
+        enterprise_mode? || raise_only_for_enterprise_mode_error
+        team_id          || raise_parameter_is_required_error(:team_id)
+
+        request = Web::Request.new(
+          connection,
+          :delete,
+          "#{config.target_api_url}/teams/#{team_id}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def edit_team(team_id = nil, query = {})
+        enterprise_mode? || raise_only_for_enterprise_mode_error
+        team_id          || raise_parameter_is_required_error(:team_id)
+
+        request = Web::Request.new(
+          connection,
+          :patch,
+          "#{config.target_api_url}/teams/#{team_id}",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def team_members_list(team_id = nil, query = {})
+        enterprise_mode? || raise_only_for_enterprise_mode_error
+        team_id          || raise_parameter_is_required_error(:team_id)
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/teams/#{team_id}/members",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def add_team_members(team_id = nil, query = {})
+        enterprise_mode? || raise_only_for_enterprise_mode_error
+        team_id          || raise_parameter_is_required_error(:team_id)
+
+        request = Web::Request.new(
+          connection,
+          :post,
+          "#{config.target_api_url}/teams/#{team_id}/members",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def delete_all_team_members(team_id = nil)
+        enterprise_mode? || raise_only_for_enterprise_mode_error
+        team_id          || raise_parameter_is_required_error(:team_id)
+
+        request = Web::Request.new(
+          connection,
+          :delete,
+          "#{config.target_api_url}/teams/#{team_id}/members"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def delete_team_member(team_id = nil, member_id = nil)
+        enterprise_mode? || raise_only_for_enterprise_mode_error
+        team_id          || raise_parameter_is_required_error(:team_id)
+        member_id        || raise_parameter_is_required_error(:member_id)
+
+        request = Web::Request.new(
+          connection,
+          :delete,
+          "#{config.target_api_url}/teams/#{team_id}/members/#{member_id}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+    end
+  end
+end

data/lib/crowdin-api/api_resources/translation_memory.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+module Crowdin
+  module ApiResources
+    module TranslationMemory
+      def list_tms(query = {})
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/tms",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def add_tm(query = {})
+        request = Web::Request.new(
+          connection,
+          :post,
+          "#{config.target_api_url}/tms",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def get_tm(tm_id = nil)
+        tm_id || raise_parameter_is_required_error(:tm_id)
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/tms/#{tm_id}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def delete_tm(tm_id = nil)
+        tm_id || raise_parameter_is_required_error(:tm_id)
+
+        request = Web::Request.new(
+          connection,
+          :delete,
+          "#{config.target_api_url}/tms/#{tm_id}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def edit_tm(tm_id = nil, query = {})
+        tm_id || raise_parameter_is_required_error(:tm_id)
+
+        request = Web::Request.new(
+          connection,
+          :patch,
+          "#{config.target_api_url}/tms/#{tm_id}",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def clear_tm(tm_id = nil)
+        tm_id || raise_parameter_is_required_error(:tm_id)
+
+        request = Web::Request.new(
+          connection,
+          :delete,
+          "#{config.target_api_url}/tms/#{tm_id}/segments"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def export_tm(tm_id = nil)
+        tm_id || raise_parameter_is_required_error(:tm_id)
+
+        request = Web::Request.new(
+          connection,
+          :post,
+          "#{config.target_api_url}/tms/#{tm_id}/exports"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def check_tm_export_status(tm_id = nil, export_id = nil)
+        tm_id     || raise_parameter_is_required_error(:tm_id)
+        export_id || raise_parameter_is_required_error(:export_id)
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/tms/#{tm_id}/exports/#{export_id}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def download_tm(tm_id = nil, export_id = nil, destination = nil)
+        tm_id     || raise_parameter_is_required_error(:tm_id)
+        export_id || raise_parameter_is_required_error(:export_id)
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/tms/#{tm_id}/exports/#{export_id}/download"
+        )
+        Web::SendRequest.new(request, destination).perform
+      end
+
+      def import_tm(tm_id = nil, query = {})
+        tm_id || raise_parameter_is_required_error(:tm_id)
+
+        request = Web::Request.new(
+          connection,
+          :post,
+          "#{config.target_api_url}/tms/#{tm_id}/imports",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def check_tm_import_status(tm_id = nil, import_id = nil)
+        tm_id     || raise_parameter_is_required_error(:tm_id)
+        import_id || raise_parameter_is_required_error(:import_id)
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/tms/#{tm_id}/imports/#{import_id}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+    end
+  end
+end