Contents

# frozen_string_literal: true

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 = {})
      c_r Lokalise::Collections::Project, :all, nil, 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)
      c_r Lokalise::Resources::Project, :find, 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)
      c_r Lokalise::Resources::Project, :create, 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)
      c_r Lokalise::Resources::Project, :update, 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)
      c_r Lokalise::Resources::Project, :empty, [project_id, 'empty']
    end

    # Deletes the project
    #
    # @see https://lokalise.co/api2docs/ruby/#transition-delete-a-project-delete
    # @return [Hash]
    # @param project_id [String, Integer]
    def destroy_project(project_id)
      c_r Lokalise::Resources::Project, :destroy, project_id
    end
  end
end

Version data entries

3 entries across 3 versions & 1 rubygems

Version	Path
ruby-lokalise-api-2.10.0	lib/ruby-lokalise-api/rest/projects.rb
ruby-lokalise-api-2.9.0.1	lib/ruby-lokalise-api/rest/projects.rb
ruby-lokalise-api-2.9.0	lib/ruby-lokalise-api/rest/projects.rb