crowdin-api 1.1.0 → 1.2.1

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

@@ -0,0 +1,220 @@
+# 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(
+          self,
+          :get,
+          "/projects/#{project_id}/approvals",
+          query
+        )
+
+        request.perform
+      end
+
+      def add_approval(query = {}, project_id = config.project_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          self,
+          :post,
+          "/projects/#{project_id}/approvals",
+          query
+        )
+
+        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(
+          self,
+          :get,
+          "/projects/#{project_id}/approvals/#{approval_id}"
+        )
+
+        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(
+          self,
+          :delete,
+          "/projects/#{project_id}/approvals/#{approval_id}"
+        )
+
+        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(
+          self,
+          :get,
+          "/projects/#{project_id}/languages/#{language_id}/translations",
+          query
+        )
+
+        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(
+          self,
+          :get,
+          "/projects/#{project_id}/translations",
+          query
+        )
+
+        request.perform
+      end
+
+      def add_translation(query = {}, project_id = config.project_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          self,
+          :post,
+          "/projects/#{project_id}/translations",
+          query
+        )
+
+        request.perform
+      end
+
+      # For now Rest Client Resource aren't support payload for DELETE requests.
+      # So we have workaround through Rest Client Execute for this case
+      def delete_string_translations(query = {}, project_id = config.project_id)
+        # project_id || raise_project_id_is_required_error
+        #
+        # request = Web::Request.new(
+        #   self,
+        #   :delete,
+        #   "/projects/#{project_id}/translations",
+        #   query
+        # )
+        #
+        # request.perform
+
+        response = ::RestClient::Request.execute(
+          {
+            method: :delete,
+            url: config.base_url + config.target_api_url + "/projects/#{project_id}/translations",
+            payload: query.to_json
+          }.merge(@options)
+        )
+
+        begin
+          JSON.parse(response)
+        rescue
+          {}
+        end
+      end
+
+      def get_translation(trnslation_id = nil, query = {}, project_id = config.project_id)
+        trnslation_id || raise_parameter_is_required_error(:trnslation_id)
+        project_id    || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          self,
+          :get,
+          "/projects/#{project_id}/translations/#{trnslation_id}",
+          query
+        )
+
+        request.perform
+      end
+
+      def restore_translation(trnslation_id = nil, project_id = config.project_id)
+        trnslation_id || raise_parameter_is_required_error(:trnslation_id)
+        project_id    || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          self,
+          :put,
+          "/projects/#{project_id}/translations/#{trnslation_id}"
+        )
+
+        request.perform
+      end
+
+      def delete_translation(trnslation_id = nil, project_id = config.project_id)
+        trnslation_id || raise_parameter_is_required_error(:trnslation_id)
+        project_id    || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          self,
+          :delete,
+          "/projects/#{project_id}/translations/#{trnslation_id}"
+        )
+
+        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(
+          self,
+          :get,
+          "/projects/#{project_id}/votes",
+          query
+        )
+
+        request.perform
+      end
+
+      def add_vote(query = {}, project_id = config.project_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          self,
+          :post,
+          "/projects/#{project_id}/votes",
+          query
+        )
+
+        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(
+          self,
+          :get,
+          "/projects/#{project_id}/votes/#{vote_id}"
+        )
+
+        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(
+          self,
+          :delete,
+          "/projects/#{project_id}/votes/#{vote_id}"
+        )
+
+        request.perform
+      end
+    end
+  end
+end

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

@@ -0,0 +1,113 @@
+# 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(
+          self,
+          :get,
+          "/projects/#{project_id}/tasks",
+          query
+        )
+
+        request.perform
+      end
+
+      def add_task(query = {}, project_id = config.project_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          self,
+          :post,
+          "/projects/#{project_id}/tasks",
+          query
+        )
+
+        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(
+          self,
+          :post,
+          "/projects/#{project_id}/tasks/#{task_id}/exports",
+          {},
+          {},
+          destination
+        )
+
+        request.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(
+          self,
+          :get,
+          "/projects/#{project_id}/tasks/#{task_id}"
+        )
+
+        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(
+          self,
+          :delete,
+          "/projects/#{project_id}/tasks/#{task_id}"
+        )
+
+        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(
+          self,
+          :patch,
+          "/projects/#{project_id}/tasks/#{task_id}",
+          query
+        )
+
+        request.perform
+      end
+
+      def list_user_tasks(query = {})
+        request = Web::Request.new(
+          self,
+          :get,
+          '/user/tasks',
+          query
+        )
+
+        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(
+          self,
+          :get,
+          "/user/tasks/#{task_id}",
+          query
+        )
+
+        request.perform
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,145 @@
+# frozen_string_literal: true
+
+module Crowdin
+  module ApiResources
+    module TranslationMemory
+      def list_tms(query = {})
+        request = Web::Request.new(
+          self,
+          :get,
+          '/tms',
+          query
+        )
+
+        request.perform
+      end
+
+      def add_tm(query = {})
+        request = Web::Request.new(
+          self,
+          :post,
+          '/tms',
+          query
+        )
+
+        request.perform
+      end
+
+      def get_tm(tm_id = nil)
+        tm_id || raise_parameter_is_required_error(:tm_id)
+
+        request = Web::Request.new(
+          self,
+          :get,
+          "/tms/#{tm_id}"
+        )
+
+        request.perform
+      end
+
+      def delete_tm(tm_id = nil)
+        tm_id || raise_parameter_is_required_error(:tm_id)
+
+        request = Web::Request.new(
+          self,
+          :delete,
+          "/tms/#{tm_id}"
+        )
+
+        request.perform
+      end
+
+      def edit_tm(tm_id = nil, query = {})
+        tm_id || raise_parameter_is_required_error(:tm_id)
+
+        request = Web::Request.new(
+          self,
+          :delete,
+          "/tms/#{tm_id}",
+          query
+        )
+
+        request.perform
+      end
+
+      def clear_tm(tm_id = nil)
+        tm_id || raise_parameter_is_required_error(:tm_id)
+
+        request = Web::Request.new(
+          self,
+          :delete,
+          "/tms/#{tm_id}/segments"
+        )
+
+        request.perform
+      end
+
+      def export_tm(tm_id = nil)
+        tm_id || raise_parameter_is_required_error(:tm_id)
+
+        request = Web::Request.new(
+          self,
+          :post,
+          "/tms/#{tm_id}/exports"
+        )
+
+        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(
+          self,
+          :get,
+          "/tms/#{tm_id}/exports/#{export_id}"
+        )
+
+        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(
+          self,
+          :get,
+          "/tms/#{tm_id}/exports/#{export_id}/download",
+          {},
+          {},
+          destination
+        )
+
+        request.perform
+      end
+
+      def import_tm(tm_id = nil, query = {})
+        tm_id || raise_parameter_is_required_error(:tm_id)
+
+        request = Web::Request.new(
+          self,
+          :post,
+          "/tms/#{tm_id}/imports",
+          query
+        )
+
+        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(
+          self,
+          :get,
+          "/tms/#{tm_id}/imports/#{import_id}"
+        )
+
+        request.perform
+      end
+    end
+  end
+end

data/lib/crowdin-api/api-resources/translations.rb

@@ -43,7 +43,7 @@ module Crowdin
         request.perform
       end
 
-      def build_project_file_translation(file_id = nil, query = {}, project_id = config.project_id)
+      def build_project_file_translation(file_id = nil, query = {}, destination = nil, project_id = config.project_id)
         file_id    || raise_parameter_is_required_error(:file_id)
         project_id || raise_project_id_is_required_error
 
@@ -54,7 +54,8 @@ module Crowdin
           :post,
           "/projects/#{project_id}/translations/builds/files/#{file_id}",
           query,
-          headers
+          headers,
+          destination
         )
 
         request.perform
@@ -100,8 +101,7 @@ module Crowdin
         request.perform
       end
 
-      def download_project_translations(destination = nil, build_id = nil, project_id = config.project_id)
-        destination || raise_parameter_is_required_error(:destination)
+      def download_project_translations(build_id = nil, destination = nil, project_id = config.project_id)
         build_id    || raise_parameter_is_required_error(:build_id)
         project_id  || raise_project_id_is_required_error
 
@@ -143,14 +143,16 @@ module Crowdin
         request.perform
       end
 
-      def export_project_translation(query = {}, project_id = config.project_id)
+      def export_project_translation(query = {}, destination = nil, project_id = config.project_id)
         project_id || raise_project_id_is_required_error
 
         request = Web::Request.new(
           self,
           :post,
           "/projects/#{project_id}/translations/exports",
-          query
+          query,
+          {},
+          destination
         )
 
         request.perform