ruby-lokalise-api 5.0.0 → 6.0.0

data/lib/ruby-lokalise-api/data/attributes.json

@@ -1,259 +0,0 @@
-{
-  "branch": [
-    "branch_id",
-    "name",
-    "created_at",
-    "created_at_timestamp",
-    "created_by",
-    "created_by_email"
-  ],
-  "comment": [
-    "comment_id",
-    "key_id",
-    "comment",
-    "added_by",
-    "added_by_email",
-    "added_at",
-    "added_at_timestamp"
-  ],
-  "contributor": [
-    "user_id",
-    "email",
-    "fullname",
-    "created_at",
-    "created_at_timestamp",
-    "is_admin",
-    "is_reviewer",
-    "languages",
-    "admin_rights"
-  ],
-  "custom_translation_status": [
-    "status_id",
-    "title",
-    "color"
-  ],
-  "file": [
-    "filename",
-    "key_count"
-  ],
-  "key": [
-    "key_id",
-    "created_at",
-    "created_at_timestamp",
-    "key_name",
-    "filenames",
-    "description",
-    "platforms",
-    "tags",
-    "comments",
-    "screenshots",
-    "translations",
-    "is_plural",
-    "plural_name",
-    "is_hidden",
-    "is_archived",
-    "context",
-    "base_words",
-    "char_limit",
-    "custom_attributes",
-    "modified_at",
-    "modified_at_timestamp",
-    "translations_modified_at",
-    "translations_modified_at_timestamp"
-  ],
-  "language": [
-    "lang_id",
-    "lang_iso",
-    "lang_name",
-    "is_rtl",
-    "plural_forms"
-  ],
-  "order": [
-    "order_id",
-    "project_id",
-    "card_id",
-    "status",
-    "created_at",
-    "created_at_timestamp",
-    "created_by",
-    "created_by_email",
-    "source_language_iso",
-    "target_language_isos",
-    "keys",
-    "source_words",
-    "provider_slug",
-    "translation_style",
-    "translation_tier",
-    "translation_tier_name",
-    "briefing",
-    "total",
-    "payment_method",
-    "dry_run"
-  ],
-  "payment_card": [
-    "card_id",
-    "last4",
-    "brand",
-    "created_at",
-    "created_at_timestamp"
-  ],
-  "project": [
-    "project_id",
-    "name",
-    "description",
-    "created_at",
-    "created_at_timestamp",
-    "created_by",
-    "created_by_email",
-    "team_id",
-    "base_language_id",
-    "base_language_iso",
-    "settings",
-    "statistics"
-  ],
-  "queued_process": [
-    "process_id",
-    "type",
-    "status",
-    "message",
-    "created_by",
-    "created_by_email",
-    "created_at",
-    "created_at_timestamp",
-    "details"
-  ],
-  "screenshot": [
-    "screenshot_id",
-    "key_ids",
-    "url",
-    "title",
-    "description",
-    "screenshot_tags",
-    "width",
-    "height",
-    "created_at",
-    "created_at_timestamp"
-  ],
-  "segment": [
-    "segment_number",
-    "language_iso",
-    "modified_at",
-    "modified_at_timestamp",
-    "modified_by",
-    "modified_by_email",
-    "value",
-    "is_fuzzy",
-    "is_reviewed",
-    "reviewed_by",
-    "words",
-    "custom_translation_statuses"
-  ],
-  "snapshot": [
-    "snapshot_id",
-    "title",
-    "created_at",
-    "created_at_timestamp",
-    "created_by",
-    "created_by_email"
-  ],
-  "task": [
-    "task_id",
-    "title",
-    "description",
-    "status",
-    "progress",
-    "due_date",
-    "due_date_timestamp",
-    "keys_count",
-    "words_count",
-    "created_at",
-    "created_at_timestamp",
-    "created_by",
-    "created_by_email",
-    "can_be_parent",
-    "task_type",
-    "parent_task_id",
-    "closing_tags",
-    "do_lock_translations",
-    "languages",
-    "auto_close_languages",
-    "auto_close_task",
-    "auto_close_items",
-    "completed_at",
-    "completed_at_timestamp",
-    "completed_by",
-    "completed_by_email",
-    "custom_translation_status_ids"
-  ],
-  "team": [
-    "team_id",
-    "name",
-    "created_at",
-    "created_at_timestamp",
-    "plan",
-    "quota_usage",
-    "quota_allowed"
-  ],
-  "team_user": [
-    "user_id",
-    "email",
-    "fullname",
-    "created_at",
-    "created_at_timestamp",
-    "role"
-  ],
-  "team_user_billing_details": [
-    "billing_email",
-    "country_code",
-    "zip",
-    "state_code",
-    "address1",
-    "address2",
-    "city",
-    "phone",
-    "company",
-    "vatnumber"
-  ],
-  "team_user_group": [
-    "group_id",
-    "name",
-    "permissions",
-    "created_at",
-    "created_at_timestamp",
-    "team_id",
-    "projects",
-    "members"
-  ],
-  "translation": [
-    "translation_id",
-    "key_id",
-    "language_iso",
-    "modified_at",
-    "modified_at_timestamp",
-    "modified_by",
-    "modified_by_email",
-    "translation",
-    "is_fuzzy",
-    "is_reviewed",
-    "words",
-    "custom_translation_statuses",
-    "task_id"
-  ],
-  "translation_provider": [
-    "provider_id",
-    "name",
-    "slug",
-    "price_pair_min",
-    "website_url",
-    "description",
-    "tiers",
-    "pairs"
-  ],
-  "webhook": [
-    "webhook_id",
-    "url",
-    "secret",
-    "events",
-    "event_lang_map"
-  ]
-}

data/lib/ruby-lokalise-api/rest/branches.rb

@@ -1,67 +0,0 @@
-# frozen_string_literal: true
-
-module Lokalise
-  class Client
-    # Returns all branches for the given project
-    #
-    # @see https://lokalise.com/api2docs/curl/#transition-list-all-branches-get
-    # @return [Lokalise::Collection::Branch<Lokalise::Resources::Branch>]
-    # @param project_id [String]
-    # @param params [Hash]
-    def branches(project_id, params = {})
-      c_r Lokalise::Collections::Branch, :all, project_id, params
-    end
-
-    # Creates a new branch inside the given project
-    #
-    # @see https://lokalise.com/api2docs/curl/#transition-create-a-branch-post
-    # @return [Lokalise::Resources::Branch]
-    # @param project_id [String]
-    # @param params [Hash]
-    def create_branch(project_id, params)
-      c_r Lokalise::Resources::Branch, :create, project_id, params
-    end
-
-    # Returns a single branch for the given project
-    #
-    # @see https://lokalise.com/api2docs/curl/#transition-retrieve-a-branch-get
-    # @return [Lokalise::Resources::Branch]
-    # @param project_id [String]
-    # @param branch_id [String, Integer]
-    def branch(project_id, branch_id)
-      c_r Lokalise::Resources::Branch, :find, [project_id, branch_id]
-    end
-
-    # Updates the given branch inside the given project
-    #
-    # @see https://lokalise.com/api2docs/curl/#transition-update-a-branch-put
-    # @return [Lokalise::Resources::Branch]
-    # @param project_id [String]
-    # @param branch_id [String, Integer]
-    # @param params [Hash]
-    def update_branch(project_id, branch_id, params)
-      c_r Lokalise::Resources::Branch, :update, [project_id, branch_id], params
-    end
-
-    # Deletes branch inside the given project
-    #
-    # @see https://lokalise.com/api2docs/curl/#transition-delete-a-branch-delete
-    # @return [Hash]
-    # @param project_id [String]
-    # @param branch_id [String, Integer]
-    def destroy_branch(project_id, branch_id)
-      c_r Lokalise::Resources::Branch, :destroy, [project_id, branch_id]
-    end
-
-    # Merges a branch in the project
-    #
-    # @see https://lokalise.com/api2docs/curl/#transition-merge-a-branch-post
-    # @return [Hash]
-    # @param project_id [String]
-    # @param branch_id [String, Integer]
-    # @param params [Hash]
-    def merge_branch(project_id, branch_id, params = {})
-      c_r Lokalise::Resources::Branch, :merge, [project_id, branch_id, :merge], params
-    end
-  end
-end

data/lib/ruby-lokalise-api/rest/comments.rb

@@ -1,59 +0,0 @@
-# frozen_string_literal: true
-
-module Lokalise
-  class Client
-    # Returns a single comment for the given key
-    #
-    # @see https://app.lokalise.com/api2docs/curl/#transition-retrieve-a-comment-get
-    # @return [Lokalise::Resources::Comment]
-    # @param project_id [String]
-    # @param key_id [String, Integer]
-    # @param comment_id [String, Integer]
-    def comment(project_id, key_id, comment_id)
-      c_r Lokalise::Resources::KeyComment, :find, [project_id, key_id, comment_id]
-    end
-
-    # Returns all comments for all keys inside the given project
-    #
-    # @see https://app.lokalise.com/api2docs/curl/#transition-list-project-comments-get
-    # @return [Lokalise::Collection::Comment<Lokalise::Resources::Comment>]
-    # @param project_id [String]
-    # @param params [Hash]
-    def project_comments(project_id, params = {})
-      c_r Lokalise::Collections::ProjectComment, :all, project_id, params
-    end
-
-    # Returns all comments for the given key inside the given project
-    #
-    # @see https://app.lokalise.com/api2docs/curl/#transition-list-key-comments-get
-    # @return [Lokalise::Collection::Comment<Lokalise::Resources::Comment>]
-    # @param project_id [String]
-    # @param key_id [String, Integer]
-    # @param params [Hash]
-    def comments(project_id, key_id, params = {})
-      c_r Lokalise::Collections::KeyComment, :all, [project_id, key_id], params
-    end
-
-    # Creates one or more comments for the given key inside the given project
-    #
-    # @see https://app.lokalise.com/api2docs/curl/#transition-create-comments-post
-    # @return [Lokalise::Collection::Comment<Lokalise::Resources::Comment>]
-    # @param project_id [String]
-    # @param key_id [String, Integer]
-    # @param params [Hash, Array<Hash>]
-    def create_comments(project_id, key_id, params)
-      c_r Lokalise::Resources::KeyComment, :create, [project_id, key_id], params, :comments
-    end
-
-    # Deletes comment for the given key inside the given project
-    #
-    # @see https://app.lokalise.com/api2docs/curl/#transition-delete-a-comment-delete
-    # @return [Hash]
-    # @param project_id [String]
-    # @param key_id [String, Integer]
-    # @param comment_id [String, Integer]
-    def destroy_comment(project_id, key_id, comment_id)
-      c_r Lokalise::Resources::KeyComment, :destroy, [project_id, key_id, comment_id]
-    end
-  end
-end

data/lib/ruby-lokalise-api/rest/contributors.rb

@@ -1,56 +0,0 @@
-# frozen_string_literal: true
-
-module Lokalise
-  class Client
-    # Returns all contributors for the given project
-    #
-    # @see https://app.lokalise.com/api2docs/curl/#transition-list-all-contributors-get
-    # @return [Lokalise::Collection::Contributor<Lokalise::Resources::Contributor>]
-    # @param project_id [String]
-    # @param params [Hash]
-    def contributors(project_id, params = {})
-      c_r Lokalise::Collections::Contributor, :all, project_id, params
-    end
-
-    # Returns a single contributor for the given project
-    #
-    # @see https://app.lokalise.com/api2docs/curl/#transition-retrieve-a-contributor-get
-    # @return [Lokalise::Resources::Contributor]
-    # @param project_id [String]
-    # @param contributor_id [String, Integer]
-    def contributor(project_id, contributor_id)
-      c_r Lokalise::Resources::Contributor, :find, [project_id, contributor_id]
-    end
-
-    # Creates one or more contributors inside the given project
-    #
-    # @see https://app.lokalise.com/api2docs/curl/#transition-create-contributors-post
-    # @return [Lokalise::Collection::Contributor<Lokalise::Resources::Contributor>]
-    # @param project_id [String]
-    # @param params [Hash, Array<Hash>]
-    def create_contributors(project_id, params)
-      c_r Lokalise::Resources::Contributor, :create, project_id, params, :contributors
-    end
-
-    # Updates the given contributor inside the given project
-    #
-    # @see https://app.lokalise.com/api2docs/curl/#transition-update-a-contributor-put
-    # @return [Lokalise::Resources::Contributor]
-    # @param project_id [String]
-    # @param contributor_id [String, Integer]
-    # @param params [Hash]
-    def update_contributor(project_id, contributor_id, params)
-      c_r Lokalise::Resources::Contributor, :update, [project_id, contributor_id], params
-    end
-
-    # Deletes contributor inside the given project
-    #
-    # @see https://app.lokalise.com/api2docs/curl/#transition-delete-a-contributor-delete
-    # @return [Hash]
-    # @param project_id [String]
-    # @param contributor_id [String, Integer]
-    def destroy_contributor(project_id, contributor_id)
-      c_r Lokalise::Resources::Contributor, :destroy, [project_id, contributor_id]
-    end
-  end
-end

data/lib/ruby-lokalise-api/rest/custom_translation_statuses.rb

@@ -1,65 +0,0 @@
-# frozen_string_literal: true
-
-module Lokalise
-  class Client
-    # Returns all translation statuses for the given project
-    #
-    # @see https://app.lokalise.com/api2docs/curl/#transition-list-all-custom-translation-statuses-get
-    # @return [Lokalise::Collection::CustomTranslationStatus<Lokalise::Resources::CustomTranslationStatus>]
-    # @param project_id [String]
-    # @param params [Hash]
-    def translation_statuses(project_id, params = {})
-      c_r Lokalise::Collections::CustomTranslationStatus, :all, project_id, params
-    end
-
-    # Returns a single translation status for the given project
-    #
-    # @see https://app.lokalise.com/api2docs/curl/#transition-retrieve-a-custom-translation-status-get
-    # @return [Lokalise::Resources::CustomTranslationStatus]
-    # @param project_id [String]
-    # @param status_id [String, Integer]
-    def translation_status(project_id, status_id)
-      c_r Lokalise::Resources::CustomTranslationStatus, :find, [project_id, status_id]
-    end
-
-    # Creates translation status inside the given project
-    #
-    # @see https://app.lokalise.com/api2docs/curl/#transition-create-a-custom-translation-status-post
-    # @return Lokalise::Resources::CustomTranslationStatus
-    # @param project_id [String]
-    # @param params Hash
-    def create_translation_status(project_id, params)
-      c_r Lokalise::Resources::CustomTranslationStatus, :create, project_id, params
-    end
-
-    # Updates the given translation status inside the given project
-    #
-    # @see https://app.lokalise.com/api2docs/curl/#transition-update-a-custom-translation-status-put
-    # @return [Lokalise::Resources::CustomTranslationStatus]
-    # @param project_id [String]
-    # @param status_id [String, Integer]
-    # @param params [Hash]
-    def update_translation_status(project_id, status_id, params)
-      c_r Lokalise::Resources::CustomTranslationStatus, :update, [project_id, status_id], params
-    end
-
-    # Deletes translation status inside the given project
-    #
-    # @see https://app.lokalise.com/api2docs/curl/#transition-delete-a-custom-translation-status-delete
-    # @return [Hash]
-    # @param project_id [String]
-    # @param status_id [String, Integer]
-    def destroy_translation_status(project_id, status_id)
-      c_r Lokalise::Resources::CustomTranslationStatus, :destroy, [project_id, status_id]
-    end
-
-    # Returns an array of available colors that can be assigned to custom translation statuses
-    #
-    # @see https://app.lokalise.com/api2docs/curl/#transition-retrieve-available-colors-for-custom-translation-statuses-get
-    # @return [Array]
-    # @param project_id [String]
-    def translation_status_colors(project_id)
-      c_r Lokalise::Resources::CustomTranslationStatus, :colors, [project_id, 'colors']
-    end
-  end
-end

data/lib/ruby-lokalise-api/rest/files.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-module Lokalise
-  class Client
-    # Returns all translation files for the given project
-    #
-    # @see https://app.lokalise.com/api2docs/curl/#transition-list-all-files-get
-    # @return [Lokalise::Collection::File<Lokalise::Resources::File>]
-    # @param project_id [String]
-    # @param params [Hash]
-    def files(project_id, params = {})
-      c_r Lokalise::Collections::File, :all, project_id, params
-    end
-
-    # Exports translation files as .zip bundle, uploads them to Amazon S3 and returns a URL to the generated bundle. The URL is valid for a year
-    #
-    # @see https://app.lokalise.com/api2docs/curl/#transition-download-files-post
-    # @return [Hash]
-    # @param project_id [String]
-    # @param params [Hash]
-    def download_files(project_id, params)
-      c_r Lokalise::Resources::File, :download, [project_id, 'download'], params
-    end
-
-    # Imports translation file to the given project. File data must base64-encoded.
-    # To encode your data in Base64, use `Base64.strict_encode64()` method.
-    #
-    # @see https://app.lokalise.com/api2docs/curl/#transition-upload-a-file-post
-    # @return [Hash]
-    # @param project_id [String]
-    # @param params [Hash]
-    def upload_file(project_id, params)
-      c_r Lokalise::Resources::File, :upload, [project_id, 'upload'], params
-    end
-  end
-end

data/lib/ruby-lokalise-api/rest/keys.rb

@@ -1,77 +0,0 @@
-# frozen_string_literal: true
-
-module Lokalise
-  class Client
-    # Returns all translation keys for the given project
-    #
-    # @see https://app.lokalise.com/api2docs/curl/#transition-list-all-keys-get
-    # @return [Lokalise::Collection::Key<Lokalise::Resources::Key>]
-    # @param project_id [String]
-    # @param params [Hash]
-    def keys(project_id, params = {})
-      c_r Lokalise::Collections::Key, :all, project_id, params
-    end
-
-    # Returns a single translation key for the given project
-    #
-    # @see https://app.lokalise.com/api2docs/curl/#transition-retrieve-a-key-get
-    # @return [Lokalise::Resources::Key]
-    # @param project_id [String]
-    # @param key_id [String, Integer]
-    # @param params [Hash]
-    def key(project_id, key_id, params = {})
-      c_r Lokalise::Resources::Key, :find, [project_id, key_id], params
-    end
-
-    # Creates one or more translation keys for the given project
-    #
-    # @see https://app.lokalise.com/api2docs/curl/#transition-create-keys-post
-    # @return [Lokalise::Collection::Key<Lokalise::Resources::Key>]
-    # @param project_id [String]
-    # @param params [Hash, Array<Hash>]
-    def create_keys(project_id, params = {})
-      c_r Lokalise::Resources::Key, :create, project_id, params, :keys
-    end
-
-    # Updates translation key for the given project
-    #
-    # @see https://app.lokalise.com/api2docs/curl/#transition-update-a-key-put
-    # @return [Lokalise::Resources::Key]
-    # @param project_id [String]
-    # @param key_id [String, Integer]
-    # @param params [Hash]
-    def update_key(project_id, key_id, params = {})
-      c_r Lokalise::Resources::Key, :update, [project_id, key_id], params
-    end
-
-    # Updates one or multiple translation keys for the given project
-    #
-    # @see https://app.lokalise.com/api2docs/curl/#transition-bulk-update-put
-    # @return [Lokalise::Collection::Key<Lokalise::Resources::Key>]
-    # @param project_id [String]
-    # @param params [Hash, Array<Hash>]
-    def update_keys(project_id, params)
-      c_r Lokalise::Resources::Key, :update, project_id, params, :keys
-    end
-
-    # Deletes translation key for the given project
-    #
-    # @see https://app.lokalise.com/api2docs/curl/#transition-delete-a-key-delete
-    # @return [Hash]
-    # @param project_id [String]
-    # @param key_id [String, Integer]
-    def destroy_key(project_id, key_id)
-      c_r Lokalise::Resources::Key, :destroy, [project_id, key_id]
-    end
-
-    # Deletes one or multiple translation keys for the given project
-    #
-    # @see https://app.lokalise.com/api2docs/curl/#transition-delete-multiple-keys-delete
-    # @return [Hash]
-    # @param project_id [String]
-    # @param key_ids [String, Integer, Array<String>, Array<Integer>]
-    def destroy_keys(project_id, key_ids)
-      c_r Lokalise::Resources::Key, :destroy, project_id, key_ids, :keys
-    end
-  end
-end

data/lib/ruby-lokalise-api/rest/languages.rb

@@ -1,65 +0,0 @@
-# frozen_string_literal: true
-
-module Lokalise
-  class Client
-    # Returns all languages supported by Lokalise
-    #
-    # @see https://app.lokalise.com/api2docs/curl/#transition-list-system-languages-get
-    # @return [Lokalise::Collection::SystemLanguage<Lokalise::Resources::SystemLanguage>]
-    # @param params [Hash]
-    def system_languages(params = {})
-      c_r Lokalise::Collections::SystemLanguage, :all, nil, params
-    end
-
-    # Returns all languages for the given project
-    #
-    # @see https://app.lokalise.com/api2docs/curl/#transition-list-project-languages-get
-    # @return [Lokalise::Collection::ProjectLanguage<Lokalise::Resources::ProjectLanguage>]
-    # @param project_id [String, Integer]
-    # @param params [Hash]
-    def project_languages(project_id, params = {})
-      c_r Lokalise::Collections::ProjectLanguage, :all, project_id, params
-    end
-
-    # Returns a single language for the given project
-    #
-    # @see https://app.lokalise.com/api2docs/curl/#transition-retrieve-a-language-get
-    # @return [Lokalise::Resources::ProjectLanguage]
-    # @param project_id [String]
-    # @param language_id [String, Integer]
-    def language(project_id, language_id)
-      c_r Lokalise::Resources::ProjectLanguage, :find, [project_id, language_id]
-    end
-
-    # Creates one or more language for the given project
-    #
-    # @see https://app.lokalise.com/api2docs/curl/#transition-retrieve-a-language-get
-    # @return [Lokalise::Collection::ProjectLanguage<Lokalise::Resources::ProjectLanguage>]
-    # @param project_id [String]
-    # @param params [Hash]
-    def create_languages(project_id, params)
-      c_r Lokalise::Resources::ProjectLanguage, :create, project_id, params, :languages
-    end
-
-    # Updates language for the given project
-    #
-    # @see https://app.lokalise.com/api2docs/curl/#transition-update-a-language-put
-    # @return [Lokalise::Resources::ProjectLanguage]
-    # @param project_id [String]
-    # @param language_id [String, Integer]
-    # @param params [Hash]
-    def update_language(project_id, language_id, params)
-      c_r Lokalise::Resources::ProjectLanguage, :update, [project_id, language_id], params
-    end
-
-    # Deletes language for the given project
-    #
-    # @see https://app.lokalise.com/api2docs/curl/#transition-delete-a-language-delete
-    # @return [Hash]
-    # @param project_id [String]
-    # @param language_id [String, Integer]
-    def destroy_language(project_id, language_id)
-      c_r Lokalise::Resources::ProjectLanguage, :destroy, [project_id, language_id]
-    end
-  end
-end