crowdin-api 1.2.1 → 1.3.0

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

@@ -1,148 +0,0 @@
-# frozen_string_literal: true
-
-module Crowdin
-  module ApiResources
-    module Projects
-      def list_projects(query = {})
-        request = Web::Request.new(
-          self,
-          :get,
-          '/projects',
-          query
-        )
-
-        request.perform
-      end
-
-      def add_project(query = {})
-        request = Web::Request.new(
-          self,
-          :post,
-          '/projects',
-          query
-        )
-
-        request.perform
-      end
-
-      def get_project(project_id = nil)
-        project_id || raise_parameter_is_required_error(:project_id)
-
-        request = Web::Request.new(
-          self,
-          :get,
-          "/projects/#{project_id}"
-        )
-
-        request.perform
-      end
-
-      def delete_project(project_id = nil)
-        project_id || raise_parameter_is_required_error(:project_id)
-
-        request = Web::Request.new(
-          self,
-          :delete,
-          "/projects/#{project_id}"
-        )
-
-        request.perform
-      end
-
-      #
-      # Edit project.
-      #
-      # === Parameters
-      #
-      # * +:projectId+ [Integer] - Project Identifier. Get via list_projects. Can be initialized with the Crowdin Client
-      # * +:value+ [String] - String or Array of strings.
-      # * +:op+ [String] - Path operation to perform.
-      # * +:projectId+ [String <json-pointer>] - Enum, for instance '/name'. Full list you can see on the developers site.
-      #
-      # === Example
-      #
-      #  crowdin.edit_project(project_id, [{op: 'replace', path: '/name', value: 'your_new_project_name'}])
-      #
-      def edit_project(project_id = nil, query = {})
-        project_id || raise_parameter_is_required_error(:project_id)
-
-        request = Web::Request.new(
-          self,
-          :patch,
-          "/projects/#{project_id}",
-          query
-        )
-
-        request.perform
-      end
-
-      # -- For Enterprise mode only --
-
-      def list_groups(query = {})
-        config.enterprise_mode? || raise_only_for_enterprise_mode_error
-
-        request = Web::Request.new(
-          self,
-          :get,
-          '/groups',
-          query
-        )
-
-        request.perform
-      end
-
-      def add_group(query = {})
-        config.enterprise_mode? || raise_only_for_enterprise_mode_error
-
-        request = Web::Request.new(
-          self,
-          :post,
-          '/groups',
-          query
-        )
-
-        request.perform
-      end
-
-      def get_group(group_id = nil)
-        config.enterprise_mode? || raise_only_for_enterprise_mode_error
-        group_id                || raise_parameter_is_required_error(:group_id)
-
-        request = Web::Request.new(
-          self,
-          :get,
-          "/groups/#{group_id}"
-        )
-
-        request.perform
-      end
-
-      def delete_group(group_id = nil)
-        config.enterprise_mode? || raise_only_for_enterprise_mode_error
-        group_id                || raise_parameter_is_required_error(:group_id)
-
-        request = Web::Request.new(
-          self,
-          :delete,
-          "/groups/#{group_id}"
-        )
-
-        request.perform
-      end
-
-      def edit_group(group_id = nil, query = {})
-        config.enterprise_mode? || raise_only_for_enterprise_mode_error
-        group_id                || raise_parameter_is_required_error(:group_id)
-
-        request = Web::Request.new(
-          self,
-          :patch,
-          "/groups/#{group_id}",
-          query
-        )
-
-        request.perform
-      end
-    end
-  end
-end

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

@@ -1,138 +0,0 @@
-# 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(
-          self,
-          :post,
-          "/projects/#{project_id}/reports",
-          query
-        )
-
-        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(
-          self,
-          :get,
-          "/projects/#{project_id}/reports/#{report_id}"
-        )
-
-        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(
-          self,
-          :get,
-          "/projects/#{project_id}/reports/#{report_id}/download",
-          {},
-          {},
-          destination
-        )
-
-        request.perform
-      end
-
-      # -- For Enterprise mode only --
-
-      def generate_group_report(group_id = nil, query = {})
-        config.enterprise_mode? || raise_only_for_enterprise_mode_error
-        group_id                || raise_parameter_is_required_error(:group_id)
-
-        request = Web::Request.new(
-          self,
-          :post,
-          "/groups/#{group_id}/reports",
-          query
-        )
-
-        request.perform
-      end
-
-      def check_group_report_generation_status(group_id = nil, report_id = nil)
-        config.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(
-          self,
-          :get,
-          "/groups/#{group_id}/reports/#{report_id}"
-        )
-
-        request.perform
-      end
-
-      def download_group_report(group_id = nil, report_id = nil, destination = nil)
-        config.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(
-          self,
-          :get,
-          "/groups/#{group_id}/reports/#{report_id}/download",
-          {},
-          {},
-          destination
-        )
-
-        request.perform
-      end
-
-      def generate_organization_report(query = {})
-        config.enterprise_mode? || raise_only_for_enterprise_mode_error
-
-        request = Web::Request.new(
-          self,
-          :post,
-          '/reports',
-          query
-        )
-
-        request.perform
-      end
-
-      def check_organization_report_generation_status(report_id = nil)
-        config.enterprise_mode? || raise_only_for_enterprise_mode_error
-        report_id               || raise_parameter_is_required_error(:report_id)
-
-        request = Web::Request.new(
-          self,
-          :get,
-          "/reports/#{report_id}"
-        )
-
-        request.perform
-      end
-
-      def download_organization_report(report_id = nil, destination = nil)
-        config.enterprise_mode? || raise_only_for_enterprise_mode_error
-        report_id               || raise_parameter_is_required_error(:report_id)
-
-        request = Web::Request.new(
-          self,
-          :get,
-          "/reports/#{report_id}/download",
-          {},
-          {},
-          destination
-        )
-
-        request.perform
-      end
-    end
-  end
-end

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

@@ -1,106 +0,0 @@
-# frozen_string_literal: true
-
-module Crowdin
-  module ApiResources
-    module Storages
-      #
-      # Get storages list.
-      #
-      # === Parameters
-      #
-      # Optional:
-      # * +:limit+ [Integer 1..500] - A maximum number of items to retrieve, default - 25
-      # * +:offset+ [Integer >= 0] - A starting offset in the collection, default - 0
-      #
-      # === Example
-      #
-      #  crowdin.list_projects(limit: your_value)
-      #
-      def list_storages(query = {})
-        request = Web::Request.new(
-          self,
-          :get,
-          '/storages',
-          query
-        )
-
-        request.perform
-      end
-
-      #
-      # Add storage.
-      #
-      # === Parameters
-      #
-      # * +File+ - File class object or full path to file
-      #
-      # === Example
-      #
-      #  crowdin.add_storage(File.open('your_filename.extension', 'r'))
-      # or
-      #  crowdin.add_storage('your_filename.extension')
-      #
-      def add_storage(file = nil)
-        file || raise_parameter_is_required_error(:file)
-
-        file = file.is_a?(File) ? file : File.open(file, 'r')
-
-        request = Web::Request.new(
-          self,
-          :post,
-          '/storages',
-          file,
-          { 'Content-Type' => 'application/octet-stream', 'Crowdin-API-FileName' => File.basename(file) }
-        )
-
-        request.perform
-      end
-
-      #
-      # Get storage information.
-      #
-      # === Parameters
-      #
-      # * +:storage_id+ [Integer] - Storage Identifier. Get via list_storages
-      #
-      # === Example
-      #
-      #  crowdin.get_storage(your_storage_id)
-      #
-      def get_storage(storage_id = nil)
-        storage_id || raise_parameter_is_required_error(:storage_id)
-
-        request = Web::Request.new(
-          self,
-          :get,
-          "/storages/#{storage_id}"
-        )
-
-        request.perform
-      end
-
-      #
-      # Delete storage.
-      #
-      # === Parameters
-      #
-      # * +:storage_id+ [Integer] - Storage Identifier. Get via list_storages
-      #
-      # === Example
-      #
-      #  crowdin.delete_storage(your_storage_id)
-      #
-      def delete_storage(storage_id = nil)
-        storage_id || raise_parameter_is_required_error(:storage_id)
-
-        request = Web::Request.new(
-          self,
-          :delete,
-          "/storages/#{storage_id}"
-        )
-
-        request.perform
-      end
-    end
-  end
-end

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

@@ -1,144 +0,0 @@
-# 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/users.rb

@@ -1,129 +0,0 @@
-# frozen_string_literal: true
-
-module Crowdin
-  module ApiResources
-    module Users
-      def get_authenticated_user
-        request = Web::Request.new(
-          self,
-          :get,
-          '/user'
-        )
-
-        request.perform
-      end
-
-      def list_project_members(query = {}, project_id = config.project_id)
-        project_id || raise_project_id_is_required_error
-
-        request = Web::Request.new(
-          self,
-          :get,
-          "/projects/#{project_id}/members",
-          query
-        )
-
-        request.perform
-      end
-
-      def get_member_info(member_id = nil, project_id = config.project_id)
-        member_id  || raise_parameter_is_required_error(:member_id)
-        project_id || raise_project_id_is_required_error
-
-        request = Web::Request.new(
-          self,
-          :get,
-          "/projects/#{project_id}/members/#{member_id}"
-        )
-
-        request.perform
-      end
-
-      # -- For Enterprise mode only --
-
-      def add_project_member(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}/members",
-          query
-        )
-
-        request.perform
-      end
-
-      def get_project_member_permissions(member_id = nil, project_id = config.project_id)
-        config.enterprise_mode? || raise_only_for_enterprise_mode_error
-        member_id               || raise_parameter_is_required_error(:member_id)
-        project_id              || raise_project_id_is_required_error
-
-        request = Web::Request.new(
-          self,
-          :get,
-          "/projects/#{project_id}/members/#{member_id}"
-        )
-
-        request.perform
-      end
-
-      def replace_project_permissions(member_id = nil, query = {}, project_id = config.project_id)
-        config.enterprise_mode? || raise_only_for_enterprise_mode_error
-        member_id               || raise_parameter_is_required_error(:member_id)
-        project_id              || raise_project_id_is_required_error
-
-        request = Web::Request.new(
-          self,
-          :put,
-          "/projects/#{project_id}/members/#{member_id}",
-          query
-        )
-
-        request.perform
-      end
-
-      def delete_member_from_project(member_id = nil, query = {}, project_id = config.project_id)
-        config.enterprise_mode? || raise_only_for_enterprise_mode_error
-        member_id               || raise_parameter_is_required_error(:member_id)
-        project_id              || raise_project_id_is_required_error
-
-        request = Web::Request.new(
-          self,
-          :delete,
-          "/projects/#{project_id}/members/#{member_id}",
-          query
-        )
-
-        request.perform
-      end
-
-      def list_users(query = {})
-        config.enterprise_mode? || raise_only_for_enterprise_mode_error
-
-        request = Web::Request.new(
-          self,
-          :get,
-          '/users',
-          query
-        )
-
-        request.perform
-      end
-
-      def get_user(user_id = nil)
-        config.enterprise_mode? || raise_only_for_enterprise_mode_error
-        user_id                 || raise_parameter_is_required_error(:user_id)
-
-        request = Web::Request.new(
-          self,
-          :get,
-          "/users/#{user_id}"
-        )
-
-        request.perform
-      end
-    end
-  end
-end

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

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module Crowdin
-  module ApiResources
-    # -- For Enterprise mode only --
-    module Vendors
-      def list_vendors(query = {})
-        config.enterprise_mode? || raise_only_for_enterprise_mode_error
-
-        request = Web::Request.new(
-          self,
-          :get,
-          '/vendors',
-          query
-        )
-
-        request.perform
-      end
-    end
-  end
-end