crowdin-api 1.1.1 → 1.5.0

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

@@ -0,0 +1,151 @@
+# frozen_string_literal: true
+
+module Crowdin
+  module ApiResources
+    module Projects
+      # * {https://developer.crowdin.com/api/v2/#operation/api.projects.getMany  API Documentation}
+      # * {https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.getMany  Enterprise API Documentation}
+      # @param query [Hash] Request Body
+      def list_projects(query = {})
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/projects",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      # * {https://developer.crowdin.com/api/v2/#operation/api.projects.post  API Documentation}
+      # * {https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.post  Enterprise API Documentation}
+      # @param query [Hash] Request Body
+      def add_project(query = {})
+        request = Web::Request.new(
+          connection,
+          :post,
+          "#{config.target_api_url}/projects",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      # * {https://developer.crowdin.com/api/v2/#operation/api.projects.get  API Documentation}
+      # * {https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.get  Enterprise API Documentation}
+      # @param project_id [Integer] Project ID
+      def get_project(project_id = nil)
+        project_id || raise_parameter_is_required_error(:project_id)
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/projects/#{project_id}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      # * {https://developer.crowdin.com/api/v2/#operation/api.projects.delete  API Documentation}
+      # * {https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.delete  Enterprise API Documentation}
+      # @param project_id [Integer] Project ID
+      def delete_project(project_id = nil)
+        project_id || raise_parameter_is_required_error(:project_id)
+
+        request = Web::Request.new(
+          connection,
+          :delete,
+          "#{config.target_api_url}/projects/#{project_id}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      # @param project_id [Integer] Project ID
+      # @param query [Hash] Request Body
+      # * {https://developer.crowdin.com/api/v2/#operation/api.projects.patch  API Documentation}
+      # * {https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.patch  Enterprise API Documentation}
+      def edit_project(project_id = nil, query = {})
+        project_id || raise_parameter_is_required_error(:project_id)
+
+        request = Web::Request.new(
+          connection,
+          :patch,
+          "#{config.target_api_url}/projects/#{project_id}",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      # -- For Enterprise mode only --
+
+      # @param query [Hash] Request Body
+      # * {https://developer.crowdin.com/enterprise/api/v2/#operation/api.groups.getMany  Enterprise API Documentation}
+      def list_groups(query = {})
+        enterprise_mode? || raise_only_for_enterprise_mode_error
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/groups",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      # @param query [Hash] Request Body
+      # * {https://developer.crowdin.com/enterprise/api/v2/#operation/api.groups.post  Enterprise API Documentation}
+      def add_group(query = {})
+        enterprise_mode? || raise_only_for_enterprise_mode_error
+
+        request = Web::Request.new(
+          connection,
+          :post,
+          "#{config.target_api_url}/groups",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      # @param group_id [Integer] Group ID
+      # * {https://developer.crowdin.com/enterprise/api/v2/#operation/api.groups.get  Enterprise API Documentation}
+      def get_group(group_id = nil)
+        enterprise_mode? || raise_only_for_enterprise_mode_error
+        group_id         || raise_parameter_is_required_error(:group_id)
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/groups/#{group_id}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      # @param group_id [Integer] Group ID
+      # * {https://developer.crowdin.com/enterprise/api/v2/#operation/api.groups.delete  Enterprise API Documentation}
+      def delete_group(group_id = nil)
+        enterprise_mode? || raise_only_for_enterprise_mode_error
+        group_id         || raise_parameter_is_required_error(:group_id)
+
+        request = Web::Request.new(
+          connection,
+          :delete,
+          "#{config.target_api_url}/groups/#{group_id}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      # @param group_id [Integer] Group ID
+      # @param query [Hash] Request Body
+      # * {https://developer.crowdin.com/enterprise/api/v2/#operation/api.groups.patch  Enterprise API Documentation}
+      def edit_group(group_id = nil, query = {})
+        enterprise_mode? || raise_only_for_enterprise_mode_error
+        group_id         || raise_parameter_is_required_error(:group_id)
+
+        request = Web::Request.new(
+          connection,
+          :patch,
+          "#{config.target_api_url}/groups/#{group_id}",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+    end
+  end
+end

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

@@ -0,0 +1,184 @@
+# frozen_string_literal: true
+
+module Crowdin
+  module ApiResources
+    module Reports
+      def generate_report(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}/reports",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def check_report_generation_status(report_id = nil, project_id = config.project_id)
+        report_id  || raise_parameter_is_required_error(:report_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/projects/#{project_id}/reports/#{report_id}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def download_report(report_id = nil, destination = nil, project_id = config.project_id)
+        report_id  || raise_parameter_is_required_error(:report_id)
+        project_id || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/projects/#{project_id}/reports/#{report_id}/download"
+        )
+        Web::SendRequest.new(request, destination).perform
+      end
+
+      # -- For Enterprise mode only --
+
+      def generate_group_report(group_id = nil, query = {})
+        enterprise_mode? || raise_only_for_enterprise_mode_error
+        group_id         || raise_parameter_is_required_error(:group_id)
+
+        request = Web::Request.new(
+          connection,
+          :post,
+          "#{config.target_api_url}/groups/#{group_id}/reports",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def check_group_report_generation_status(group_id = nil, report_id = nil)
+        enterprise_mode? || raise_only_for_enterprise_mode_error
+        group_id         || raise_parameter_is_required_error(:group_id)
+        report_id        || raise_parameter_is_required_error(:report_id)
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/groups/#{group_id}/reports/#{report_id}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def download_group_report(group_id = nil, report_id = nil, destination = nil)
+        enterprise_mode? || raise_only_for_enterprise_mode_error
+        group_id         || raise_parameter_is_required_error(:group_id)
+        report_id        || raise_parameter_is_required_error(:report_id)
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/groups/#{group_id}/reports/#{report_id}/download"
+        )
+        Web::SendRequest.new(request, destination).perform
+      end
+
+      def generate_organization_report(query = {})
+        enterprise_mode? || raise_only_for_enterprise_mode_error
+
+        request = Web::Request.new(
+          connection,
+          :post,
+          "#{config.target_api_url}/reports",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def check_organization_report_generation_status(report_id = nil)
+        enterprise_mode? || raise_only_for_enterprise_mode_error
+        report_id        || raise_parameter_is_required_error(:report_id)
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/reports/#{report_id}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def download_organization_report(report_id = nil, destination = nil)
+        enterprise_mode? || raise_only_for_enterprise_mode_error
+        report_id        || raise_parameter_is_required_error(:report_id)
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/reports/#{report_id}/download"
+        )
+        Web::SendRequest.new(request, destination).perform
+      end
+
+      def list_report_settings_templates(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}/reports/settings-templates",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def add_report_settings_template(query = {}, project_id = config.project_id)
+        project_id || raise_project_id_is_required_error
+        %i[name currency unit mode config].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}/reports/settings-templates",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def get_report_settings_template(template_id = nil, project_id = config.project_id)
+        project_id || raise_project_id_is_required_error
+        template_id || raise_parameter_is_required_error(:template_id)
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/projects/#{project_id}/reports/settings-templates/#{template_id}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def edit_report_settings_template(query = {}, template_id = nil, project_id = config.project_id)
+        project_id || raise_project_id_is_required_error
+        template_id || raise_parameter_is_required_error(:template_id)
+
+        request = Web::Request.new(
+          connection,
+          :patch,
+          "#{config.target_api_url}/projects/#{project_id}/reports/settings-templates/#{template_id}",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def delete_report_settings_template(template_id = nil, project_id = config.project_id)
+        project_id || raise_project_id_is_required_error
+        template_id || raise_parameter_is_required_error(:template_id)
+
+        request = Web::Request.new(
+          connection,
+          :delete,
+          "#{config.target_api_url}/projects/#{project_id}/reports/settings-templates/#{template_id}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+    end
+  end
+end

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

@@ -0,0 +1,172 @@
+# frozen_string_literal: true
+
+module Crowdin
+  module ApiResources
+    module Screenshots
+      def list_screenshots(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}/screenshots",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def add_screenshot(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}/screenshots",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def get_screenshot(screenshot_id = nil, project_id = config.project_id)
+        screenshot_id || raise_parameter_is_required_error(:screenshot_id)
+        project_id    || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/projects/#{project_id}/screenshots/#{screenshot_id}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def update_screenshot(screenshot_id = nil, query = {}, project_id = config.project_id)
+        screenshot_id || raise_parameter_is_required_error(:screenshot_id)
+        project_id    || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :put,
+          "#{config.target_api_url}/projects/#{project_id}/screenshots/#{screenshot_id}",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def delete_screenshot(screenshot_id = nil, project_id = config.project_id)
+        screenshot_id || raise_parameter_is_required_error(:screenshot_id)
+        project_id    || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :delete,
+          "#{config.target_api_url}/projects/#{project_id}/screenshots/#{screenshot_id}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def edit_screenshot(screenshot_id = nil, query = {}, project_id = config.project_id)
+        screenshot_id || raise_parameter_is_required_error(:screenshot_id)
+        project_id    || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :patch,
+          "#{config.target_api_url}/projects/#{project_id}/screenshots/#{screenshot_id}",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def list_tags(screenshot_id = nil, query = {}, project_id = config.project_id)
+        screenshot_id || raise_parameter_is_required_error(:screenshot_id)
+        project_id    || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/projects/#{project_id}/screenshots/#{screenshot_id}/tags",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def replace_tags(screenshot_id = nil, query = {}, project_id = config.project_id)
+        screenshot_id || raise_parameter_is_required_error(:screenshot_id)
+        project_id    || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :put,
+          "#{config.target_api_url}/projects/#{project_id}/screenshots/#{screenshot_id}/tags",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def add_tag(screenshot_id = nil, query = {}, project_id = config.project_id)
+        screenshot_id || raise_parameter_is_required_error(:screenshot_id)
+        project_id    || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :post,
+          "#{config.target_api_url}/projects/#{project_id}/screenshots/#{screenshot_id}/tags",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def clear_tags(screenshot_id = nil, project_id = config.project_id)
+        screenshot_id || raise_parameter_is_required_error(:screenshot_id)
+        project_id    || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :delete,
+          "#{config.target_api_url}/projects/#{project_id}/screenshots/#{screenshot_id}/tags"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def get_tag(screenshot_id = nil, tag_id = nil, project_id = config.project_id)
+        screenshot_id || raise_parameter_is_required_error(:screenshot_id)
+        tag_id        || raise_parameter_is_required_error(:tag_id)
+        project_id    || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :get,
+          "#{config.target_api_url}/projects/#{project_id}/screenshots/#{screenshot_id}/tags/#{tag_id}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def delete_tag(screenshot_id = nil, tag_id = nil, project_id = config.project_id)
+        screenshot_id || raise_parameter_is_required_error(:screenshot_id)
+        tag_id        || raise_parameter_is_required_error(:tag_id)
+        project_id    || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :delete,
+          "#{config.target_api_url}/projects/#{project_id}/screenshots/#{screenshot_id}/tags/#{tag_id}"
+        )
+        Web::SendRequest.new(request).perform
+      end
+
+      def edit_tag(screenshot_id = nil, tag_id = nil, query = {}, project_id = config.project_id)
+        screenshot_id || raise_parameter_is_required_error(:screenshot_id)
+        tag_id        || raise_parameter_is_required_error(:tag_id)
+        project_id    || raise_project_id_is_required_error
+
+        request = Web::Request.new(
+          connection,
+          :patch,
+          "#{config.target_api_url}/projects/#{project_id}/screenshots/#{screenshot_id}/tags/#{tag_id}",
+          { params: query }
+        )
+        Web::SendRequest.new(request).perform
+      end
+    end
+  end
+end