weblate

Weblate - the Ruby gem for the Weblate's REST API

The API is accessible on the /api/ URL and it is based on Django REST framework.

The OpenAPI specification is available as feature preview, feedback welcome!

This SDK is automatically generated by the OpenAPI Generator project:

• API version:
• Package version: 0.1.1
• Generator version: 7.9.0
• Build package: org.openapitools.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build weblate.gemspec

Then either install the gem locally:

gem install ./weblate-0.1.1.gem

(for development, run gem install --dev ./weblate-0.1.1.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'weblate', '~> 0.1.1'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'weblate', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'weblate'

# Setup authorization
Weblate.configure do |config|
  # Configure API key authorization: tokenAuth
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
  # Configure faraday connection
  config.configure_faraday_connection { |connection| 'YOUR CONNECTION CONFIG PROC' }
end

api_instance = Weblate::AddonsApi.new
id = 'id_example' # String | 

begin
  api_instance.addons_destroy(id)
rescue Weblate::ApiError => e
  puts "Exception when calling AddonsApi->addons_destroy: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://hosted.weblate.org

Class	Method	HTTP request	Description
Weblate::AddonsApi	addons_destroy	DELETE /addons/id/
Weblate::AddonsApi	addons_list	GET /addons/
Weblate::AddonsApi	addons_partial_update	PATCH /addons/id/
Weblate::AddonsApi	addons_retrieve	GET /addons/id/
Weblate::AddonsApi	addons_update	PUT /addons/id/
Weblate::CategoriesApi	categories_create	POST /categories/
Weblate::CategoriesApi	categories_destroy	DELETE /categories/id/
Weblate::CategoriesApi	categories_list	GET /categories/
Weblate::CategoriesApi	categories_partial_update	PATCH /categories/id/
Weblate::CategoriesApi	categories_retrieve	GET /categories/id/
Weblate::CategoriesApi	categories_statistics_retrieve	GET /categories/id/statistics/
Weblate::CategoriesApi	categories_update	PUT /categories/id/
Weblate::ChangesApi	changes_list	GET /changes/
Weblate::ChangesApi	changes_retrieve	GET /changes/id/
Weblate::ComponentListsApi	component_lists_components_create	POST /component-lists/slug/components/
Weblate::ComponentListsApi	component_lists_components_destroy	DELETE /component-lists/slug/components/component_slug/
Weblate::ComponentListsApi	component_lists_components_retrieve	GET /component-lists/slug/components/
Weblate::ComponentListsApi	component_lists_create	POST /component-lists/
Weblate::ComponentListsApi	component_lists_destroy	DELETE /component-lists/slug/
Weblate::ComponentListsApi	component_lists_list	GET /component-lists/
Weblate::ComponentListsApi	component_lists_partial_update	PATCH /component-lists/slug/
Weblate::ComponentListsApi	component_lists_retrieve	GET /component-lists/slug/
Weblate::ComponentListsApi	component_lists_update	PUT /component-lists/slug/
Weblate::ComponentsApi	components_addons_create	POST /components/project__slug/slug/addons/
Weblate::ComponentsApi	components_changes_retrieve	GET /components/project__slug/slug/changes/
Weblate::ComponentsApi	components_credits_retrieve	GET /components/project__slug/slug/credits/
Weblate::ComponentsApi	components_destroy	DELETE /components/project__slug/slug/
Weblate::ComponentsApi	components_file_retrieve	GET /components/project__slug/slug/file/
Weblate::ComponentsApi	components_links_create	POST /components/project__slug/slug/links/
Weblate::ComponentsApi	components_links_destroy	DELETE /components/project__slug/slug/links/project_slug/
Weblate::ComponentsApi	components_links_retrieve	GET /components/project__slug/slug/links/
Weblate::ComponentsApi	components_list	GET /components/
Weblate::ComponentsApi	components_lock_create	POST /components/project__slug/slug/lock/
Weblate::ComponentsApi	components_lock_retrieve	GET /components/project__slug/slug/lock/
Weblate::ComponentsApi	components_monolingual_base_retrieve	GET /components/project__slug/slug/monolingual_base/
Weblate::ComponentsApi	components_new_template_retrieve	GET /components/project__slug/slug/new_template/
Weblate::ComponentsApi	components_partial_update	PATCH /components/project__slug/slug/
Weblate::ComponentsApi	components_repository_create	POST /components/project__slug/slug/repository/
Weblate::ComponentsApi	components_repository_retrieve	GET /components/project__slug/slug/repository/
Weblate::ComponentsApi	components_retrieve	GET /components/project__slug/slug/
Weblate::ComponentsApi	components_screenshots_retrieve	GET /components/project__slug/slug/screenshots/
Weblate::ComponentsApi	components_statistics_retrieve	GET /components/project__slug/slug/statistics/
Weblate::ComponentsApi	components_translations_create	POST /components/project__slug/slug/translations/
Weblate::ComponentsApi	components_translations_retrieve	GET /components/project__slug/slug/translations/
Weblate::ComponentsApi	components_update	PUT /components/project__slug/slug/
Weblate::GroupsApi	groups_admins_create	POST /groups/id/admins/
Weblate::GroupsApi	groups_admins_destroy	DELETE /groups/id/admins/user_pk/
Weblate::GroupsApi	groups_componentlists_create	POST /groups/id/componentlists/
Weblate::GroupsApi	groups_componentlists_destroy	DELETE /groups/id/componentlists/component_list_id/
Weblate::GroupsApi	groups_components_create	POST /groups/id/components/
Weblate::GroupsApi	groups_components_destroy	DELETE /groups/id/components/component_id/
Weblate::GroupsApi	groups_create	POST /groups/
Weblate::GroupsApi	groups_destroy	DELETE /groups/id/
Weblate::GroupsApi	groups_languages_create	POST /groups/id/languages/
Weblate::GroupsApi	groups_languages_destroy	DELETE /groups/id/languages/language_code/
Weblate::GroupsApi	groups_list	GET /groups/
Weblate::GroupsApi	groups_partial_update	PATCH /groups/id/
Weblate::GroupsApi	groups_projects_create	POST /groups/id/projects/
Weblate::GroupsApi	groups_projects_destroy	DELETE /groups/id/projects/project_id/
Weblate::GroupsApi	groups_retrieve	GET /groups/id/
Weblate::GroupsApi	groups_roles_create	POST /groups/id/roles/
Weblate::GroupsApi	groups_update	PUT /groups/id/
Weblate::LanguagesApi	languages_create	POST /languages/
Weblate::LanguagesApi	languages_destroy	DELETE /languages/code/
Weblate::LanguagesApi	languages_list	GET /languages/
Weblate::LanguagesApi	languages_partial_update	PATCH /languages/code/
Weblate::LanguagesApi	languages_retrieve	GET /languages/code/
Weblate::LanguagesApi	languages_statistics_retrieve	GET /languages/code/statistics/
Weblate::LanguagesApi	languages_update	PUT /languages/code/
Weblate::MemoryApi	memory_create	POST /memory/
Weblate::MemoryApi	memory_destroy	DELETE /memory/id/
Weblate::MemoryApi	memory_list	GET /memory/
Weblate::MemoryApi	memory_partial_update	PATCH /memory/id/
Weblate::MemoryApi	memory_retrieve	GET /memory/id/
Weblate::MemoryApi	memory_update	PUT /memory/id/
Weblate::MetricsApi	metrics_retrieve	GET /metrics/
Weblate::ProjectsApi	projects_addons_create	POST /projects/slug/addons/
Weblate::ProjectsApi	projects_categories_retrieve	GET /projects/slug/categories/
Weblate::ProjectsApi	projects_changes_retrieve	GET /projects/slug/changes/
Weblate::ProjectsApi	projects_components_create	POST /projects/slug/components/
Weblate::ProjectsApi	projects_components_retrieve	GET /projects/slug/components/
Weblate::ProjectsApi	projects_create	POST /projects/
Weblate::ProjectsApi	projects_credits_retrieve	GET /projects/slug/credits/
Weblate::ProjectsApi	projects_destroy	DELETE /projects/slug/
Weblate::ProjectsApi	projects_file_retrieve	GET /projects/slug/file/
Weblate::ProjectsApi	projects_labels_create	POST /projects/slug/labels/
Weblate::ProjectsApi	projects_labels_retrieve	GET /projects/slug/labels/
Weblate::ProjectsApi	projects_languages_retrieve	GET /projects/slug/languages/
Weblate::ProjectsApi	projects_list	GET /projects/
Weblate::ProjectsApi	projects_partial_update	PATCH /projects/slug/
Weblate::ProjectsApi	projects_repository_create	POST /projects/slug/repository/
Weblate::ProjectsApi	projects_repository_retrieve	GET /projects/slug/repository/
Weblate::ProjectsApi	projects_retrieve	GET /projects/slug/
Weblate::ProjectsApi	projects_statistics_retrieve	GET /projects/slug/statistics/
Weblate::ProjectsApi	projects_update	PUT /projects/slug/
Weblate::RolesApi	roles_create	POST /roles/
Weblate::RolesApi	roles_destroy	DELETE /roles/id/
Weblate::RolesApi	roles_list	GET /roles/
Weblate::RolesApi	roles_partial_update	PATCH /roles/id/
Weblate::RolesApi	roles_retrieve	GET /roles/id/
Weblate::RolesApi	roles_update	PUT /roles/id/
Weblate::ScreenshotsApi	screenshots_create	POST /screenshots/
Weblate::ScreenshotsApi	screenshots_destroy	DELETE /screenshots/id/
Weblate::ScreenshotsApi	screenshots_file_create	POST /screenshots/id/file/
Weblate::ScreenshotsApi	screenshots_file_retrieve	GET /screenshots/id/file/
Weblate::ScreenshotsApi	screenshots_file_update	PUT /screenshots/id/file/
Weblate::ScreenshotsApi	screenshots_list	GET /screenshots/
Weblate::ScreenshotsApi	screenshots_partial_update	PATCH /screenshots/id/
Weblate::ScreenshotsApi	screenshots_retrieve	GET /screenshots/id/
Weblate::ScreenshotsApi	screenshots_units_create	POST /screenshots/id/units/
Weblate::ScreenshotsApi	screenshots_units_destroy	DELETE /screenshots/id/units/unit_id/
Weblate::ScreenshotsApi	screenshots_update	PUT /screenshots/id/
Weblate::SearchApi	search_retrieve	GET /search/
Weblate::TasksApi	tasks_destroy	DELETE /tasks/id/
Weblate::TasksApi	tasks_retrieve	GET /tasks/id/
Weblate::TranslationsApi	translations_autotranslate_create	POST /translations/component_<em>project</em><em>slug/component</em><em>slug/language</em>_code/autotranslate/
Weblate::TranslationsApi	translations_changes_retrieve	GET /translations/component_<em>project</em><em>slug/component</em><em>slug/language</em>_code/changes/
Weblate::TranslationsApi	translations_destroy	DELETE /translations/component_<em>project</em><em>slug/component</em><em>slug/language</em>_code/
Weblate::TranslationsApi	translations_file_create	POST /translations/component_<em>project</em><em>slug/component</em><em>slug/language</em>_code/file/
Weblate::TranslationsApi	translations_file_retrieve	GET /translations/component_<em>project</em><em>slug/component</em><em>slug/language</em>_code/file/
Weblate::TranslationsApi	translations_file_update	PUT /translations/component_<em>project</em><em>slug/component</em><em>slug/language</em>_code/file/
Weblate::TranslationsApi	translations_list	GET /translations/
Weblate::TranslationsApi	translations_repository_create	POST /translations/component_<em>project</em><em>slug/component</em><em>slug/language</em>_code/repository/
Weblate::TranslationsApi	translations_repository_retrieve	GET /translations/component_<em>project</em><em>slug/component</em><em>slug/language</em>_code/repository/
Weblate::TranslationsApi	translations_retrieve	GET /translations/component_<em>project</em><em>slug/component</em><em>slug/language</em>_code/
Weblate::TranslationsApi	translations_statistics_retrieve	GET /translations/component_<em>project</em><em>slug/component</em><em>slug/language</em>_code/statistics/
Weblate::TranslationsApi	translations_units_create	POST /translations/component_<em>project</em><em>slug/component</em><em>slug/language</em>_code/units/
Weblate::TranslationsApi	translations_units_retrieve	GET /translations/component_<em>project</em><em>slug/component</em><em>slug/language</em>_code/units/
Weblate::UnitsApi	units_destroy	DELETE /units/id/
Weblate::UnitsApi	units_list	GET /units/
Weblate::UnitsApi	units_partial_update	PATCH /units/id/
Weblate::UnitsApi	units_retrieve	GET /units/id/
Weblate::UnitsApi	units_update	PUT /units/id/
Weblate::UsersApi	users_create	POST /users/
Weblate::UsersApi	users_destroy	DELETE /users/username/
Weblate::UsersApi	users_groups_create	POST /users/username/groups/
Weblate::UsersApi	users_groups_destroy	DELETE /users/username/groups/
Weblate::UsersApi	users_list	GET /users/
Weblate::UsersApi	users_notifications_create	POST /users/username/notifications/
Weblate::UsersApi	users_notifications_destroy	DELETE /users/username/notifications/subscription_id/
Weblate::UsersApi	users_notifications_list	GET /users/username/notifications/
Weblate::UsersApi	users_notifications_partial_update	PATCH /users/username/notifications/subscription_id/
Weblate::UsersApi	users_notifications_retrieve	GET /users/username/notifications/subscription_id/
Weblate::UsersApi	users_notifications_update	PUT /users/username/notifications/subscription_id/
Weblate::UsersApi	users_partial_update	PATCH /users/username/
Weblate::UsersApi	users_retrieve	GET /users/username/
Weblate::UsersApi	users_statistics_retrieve	GET /users/username/statistics/
Weblate::UsersApi	users_update	PUT /users/username/

Documentation for Models

• Weblate::ActionEnum
• Weblate::Addon
• Weblate::AutoComponentList
• Weblate::BasicUser
• Weblate::BlankEnum
• Weblate::Category
• Weblate::Change
• Weblate::ColorEnum
• Weblate::Component
• Weblate::ComponentLanguageCodeStyle
• Weblate::ComponentList
• Weblate::ConflictsEnum
• Weblate::DirectionEnum
• Weblate::FileFormatEnum
• Weblate::FrequencyEnum
• Weblate::FuzzyEnum
• Weblate::Group
• Weblate::Language
• Weblate::LanguageCodeStyleEnum
• Weblate::LanguagePlural
• Weblate::LanguageSelectionEnum
• Weblate::LicenseEnum
• Weblate::LockRequest
• Weblate::Memory
• Weblate::MergeStyleEnum
• Weblate::MethodEnum
• Weblate::Metrics
• Weblate::NewLangEnum
• Weblate::Notification
• Weblate::NotificationEnum
• Weblate::OperationEnum
• Weblate::PaginatedAddonList
• Weblate::PaginatedBasicUserList
• Weblate::PaginatedCategoryList
• Weblate::PaginatedChangeList
• Weblate::PaginatedComponentList
• Weblate::PaginatedComponentListList
• Weblate::PaginatedGroupList
• Weblate::PaginatedLanguageList
• Weblate::PaginatedMemoryList
• Weblate::PaginatedNotificationList
• Weblate::PaginatedProjectList
• Weblate::PaginatedRoleList
• Weblate::PaginatedScreenshotList
• Weblate::PaginatedTranslationList
• Weblate::PaginatedUnitList
• Weblate::PatchedAddon
• Weblate::PatchedBasicUser
• Weblate::PatchedCategory
• Weblate::PatchedComponent
• Weblate::PatchedComponentList
• Weblate::PatchedGroup
• Weblate::PatchedLanguage
• Weblate::PatchedMemory
• Weblate::PatchedNotification
• Weblate::PatchedProject
• Weblate::PatchedRole
• Weblate::PatchedScreenshot
• Weblate::PatchedUnitWrite
• Weblate::PriorityEnum
• Weblate::Project
• Weblate::ProjectSelectionEnum
• Weblate::RepoRequest
• Weblate::Role
• Weblate::ScopeEnum
• Weblate::Screenshot
• Weblate::ScreenshotFile
• Weblate::SourceEnum
• Weblate::StateEnum
• Weblate::TextDirection
• Weblate::Translation
• Weblate::Unit
• Weblate::UnitFlatLabels
• Weblate::UnitLabels
• Weblate::UnitWrite
• Weblate::UploadRequest
• Weblate::UploadRequestConflicts
• Weblate::UploadRequestFuzzy
• Weblate::VcsEnum

Documentation for Authorization

Authentication schemes defined for the API:

tokenAuth

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header