weblate 0.1.0

data/docs/ChangesApi.md

@@ -0,0 +1,163 @@
+# Weblate::ChangesApi
+
+All URIs are relative to *https://hosted.weblate.org*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**changes_list**](ChangesApi.md#changes_list) | **GET** /changes/ |  |
+| [**changes_retrieve**](ChangesApi.md#changes_retrieve) | **GET** /changes/{id}/ |  |
+
+
+## changes_list
+
+> <PaginatedChangeList> changes_list(opts)
+
+
+
+Changes API.
+
+### Examples
+
+```ruby
+require 'time'
+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'
+end
+
+api_instance = Weblate::ChangesApi.new
+opts = {
+  action: [0], # Array<Integer> | * `0` - Resource updated * `1` - Translation completed * `2` - Translation changed * `5` - Translation added * `3` - Comment added * `4` - Suggestion added * `6` - Automatically translated * `7` - Suggestion accepted * `8` - Translation reverted * `9` - Translation uploaded * `13` - Source string added * `14` - Component locked * `15` - Component unlocked * `17` - Changes committed * `18` - Changes pushed * `19` - Repository reset * `20` - Repository merged * `21` - Repository rebased * `22` - Repository merge failed * `23` - Repository rebase failed * `28` - Repository push failed * `24` - Parsing failed * `25` - Translation removed * `26` - Suggestion removed * `27` - Translation replaced * `29` - Suggestion removed during cleanup * `30` - Source string changed * `31` - String added * `32` - Bulk status changed * `33` - Visibility changed * `34` - User added * `35` - User removed * `36` - Translation approved * `37` - Marked for edit * `38` - Component removed * `39` - Project removed * `41` - Project renamed * `42` - Component renamed * `43` - Moved component * `45` - Contributor joined * `46` - Announcement posted * `47` - Alert triggered * `48` - Language added * `49` - Language requested * `50` - Project created * `51` - Component created * `52` - User invited * `53` - Repository notification received * `54` - Translation replaced file by upload * `55` - License changed * `56` - Contributor agreement changed * `57` - Screenshot added * `58` - Screenshot uploaded * `59` - String updated in the repository * `60` - Add-on installed * `61` - Add-on configuration changed * `62` - Add-on uninstalled * `63` - String removed * `64` - Comment removed * `65` - Comment resolved * `66` - Explanation updated * `67` - Category removed * `68` - Category renamed * `69` - Category moved * `70` - Saving string failed * `71` - String added in the repository * `72` - String updated in the upload * `73` - String added in the upload * `74` - Translation updated by source upload * `75` - Component translation completed
+  page: 56, # Integer | A page number within the paginated result set.
+  page_size: 56, # Integer | Number of results to return per page.
+  timestamp_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | 
+  timestamp_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | 
+  user: 'user_example' # String | 
+}
+
+begin
+  
+  result = api_instance.changes_list(opts)
+  p result
+rescue Weblate::ApiError => e
+  puts "Error when calling ChangesApi->changes_list: #{e}"
+end
+```
+
+#### Using the changes_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaginatedChangeList>, Integer, Hash)> changes_list_with_http_info(opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.changes_list_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginatedChangeList>
+rescue Weblate::ApiError => e
+  puts "Error when calling ChangesApi->changes_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **action** | [**Array&lt;Integer&gt;**](Integer.md) | * &#x60;0&#x60; - Resource updated * &#x60;1&#x60; - Translation completed * &#x60;2&#x60; - Translation changed * &#x60;5&#x60; - Translation added * &#x60;3&#x60; - Comment added * &#x60;4&#x60; - Suggestion added * &#x60;6&#x60; - Automatically translated * &#x60;7&#x60; - Suggestion accepted * &#x60;8&#x60; - Translation reverted * &#x60;9&#x60; - Translation uploaded * &#x60;13&#x60; - Source string added * &#x60;14&#x60; - Component locked * &#x60;15&#x60; - Component unlocked * &#x60;17&#x60; - Changes committed * &#x60;18&#x60; - Changes pushed * &#x60;19&#x60; - Repository reset * &#x60;20&#x60; - Repository merged * &#x60;21&#x60; - Repository rebased * &#x60;22&#x60; - Repository merge failed * &#x60;23&#x60; - Repository rebase failed * &#x60;28&#x60; - Repository push failed * &#x60;24&#x60; - Parsing failed * &#x60;25&#x60; - Translation removed * &#x60;26&#x60; - Suggestion removed * &#x60;27&#x60; - Translation replaced * &#x60;29&#x60; - Suggestion removed during cleanup * &#x60;30&#x60; - Source string changed * &#x60;31&#x60; - String added * &#x60;32&#x60; - Bulk status changed * &#x60;33&#x60; - Visibility changed * &#x60;34&#x60; - User added * &#x60;35&#x60; - User removed * &#x60;36&#x60; - Translation approved * &#x60;37&#x60; - Marked for edit * &#x60;38&#x60; - Component removed * &#x60;39&#x60; - Project removed * &#x60;41&#x60; - Project renamed * &#x60;42&#x60; - Component renamed * &#x60;43&#x60; - Moved component * &#x60;45&#x60; - Contributor joined * &#x60;46&#x60; - Announcement posted * &#x60;47&#x60; - Alert triggered * &#x60;48&#x60; - Language added * &#x60;49&#x60; - Language requested * &#x60;50&#x60; - Project created * &#x60;51&#x60; - Component created * &#x60;52&#x60; - User invited * &#x60;53&#x60; - Repository notification received * &#x60;54&#x60; - Translation replaced file by upload * &#x60;55&#x60; - License changed * &#x60;56&#x60; - Contributor agreement changed * &#x60;57&#x60; - Screenshot added * &#x60;58&#x60; - Screenshot uploaded * &#x60;59&#x60; - String updated in the repository * &#x60;60&#x60; - Add-on installed * &#x60;61&#x60; - Add-on configuration changed * &#x60;62&#x60; - Add-on uninstalled * &#x60;63&#x60; - String removed * &#x60;64&#x60; - Comment removed * &#x60;65&#x60; - Comment resolved * &#x60;66&#x60; - Explanation updated * &#x60;67&#x60; - Category removed * &#x60;68&#x60; - Category renamed * &#x60;69&#x60; - Category moved * &#x60;70&#x60; - Saving string failed * &#x60;71&#x60; - String added in the repository * &#x60;72&#x60; - String updated in the upload * &#x60;73&#x60; - String added in the upload * &#x60;74&#x60; - Translation updated by source upload * &#x60;75&#x60; - Component translation completed | [optional] |
+| **page** | **Integer** | A page number within the paginated result set. | [optional] |
+| **page_size** | **Integer** | Number of results to return per page. | [optional] |
+| **timestamp_after** | **Time** |  | [optional] |
+| **timestamp_before** | **Time** |  | [optional] |
+| **user** | **String** |  | [optional] |
+
+### Return type
+
+[**PaginatedChangeList**](PaginatedChangeList.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## changes_retrieve
+
+> <Change> changes_retrieve(id)
+
+
+
+Changes API.
+
+### Examples
+
+```ruby
+require 'time'
+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'
+end
+
+api_instance = Weblate::ChangesApi.new
+id = 'id_example' # String | 
+
+begin
+  
+  result = api_instance.changes_retrieve(id)
+  p result
+rescue Weblate::ApiError => e
+  puts "Error when calling ChangesApi->changes_retrieve: #{e}"
+end
+```
+
+#### Using the changes_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Change>, Integer, Hash)> changes_retrieve_with_http_info(id)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.changes_retrieve_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Change>
+rescue Weblate::ApiError => e
+  puts "Error when calling ChangesApi->changes_retrieve_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+[**Change**](Change.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/ColorEnum.md

@@ -0,0 +1,15 @@
+# Weblate::ColorEnum
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'weblate'
+
+instance = Weblate::ColorEnum.new()
+```
+

data/docs/Component.md

@@ -0,0 +1,146 @@
+# Weblate::Component
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Display name |  |
+| **slug** | **String** | Name used in URLs and filenames. |  |
+| **id** | **Integer** |  | [readonly] |
+| **source_language** | [**Language**](Language.md) |  | [optional] |
+| **project** | [**Project**](Project.md) |  | [readonly] |
+| **vcs** | [**VcsEnum**](VcsEnum.md) | Version control system to use to access your repository containing translations. You can also choose additional integration with third party providers to submit merge requests.  * `gerrit` - Gerrit * `git` - Git * `git-force-push` - Git with force push * `github` - GitHub pull request * `gitlab` - GitLab merge request * `local` - No remote repository * `mercurial` - Mercurial * `subversion` - Subversion | [optional] |
+| **repo** | **String** |  |  |
+| **git_export** | **String** | URL of repository where users can fetch changes from Weblate | [optional] |
+| **branch** | **String** |  | [optional] |
+| **push_branch** | **String** |  | [optional] |
+| **filemask** | **String** | Path of files to translate relative to repository root, use * instead of language code, for example: po/*.po or locale/*/LC_MESSAGES/django.po. |  |
+| **screenshot_filemask** | **String** | Path of screenshots relative to repository root, for example: docs/screenshots/*.png. | [optional] |
+| **template** | **String** | Filename of translation base file, containing all strings and their source for monolingual translations. | [optional] |
+| **edit_template** | **Boolean** | Whether users will be able to edit the base file for monolingual translations. | [optional] |
+| **intermediate** | **String** | Filename of intermediate translation file. In most cases this is a translation file provided by developers and is used when creating actual source strings. | [optional] |
+| **new_base** | **String** | Filename of file used for creating new translations. For gettext choose .pot file. | [optional] |
+| **file_format** | [**FileFormatEnum**](FileFormatEnum.md) |  |  |
+| **license** | [**LicenseEnum**](LicenseEnum.md) |  | [optional] |
+| **license_url** | **String** |  | [readonly] |
+| **agreement** | **String** | User agreement which needs to be approved before a user can translate this component. | [optional] |
+| **web_url** | **String** |  | [readonly] |
+| **url** | **String** |  | [readonly] |
+| **repository_url** | **String** |  | [readonly] |
+| **translations_url** | **String** |  | [readonly] |
+| **statistics_url** | **String** |  | [readonly] |
+| **lock_url** | **String** |  | [readonly] |
+| **links_url** | **String** |  | [readonly] |
+| **changes_list_url** | **String** |  | [readonly] |
+| **task_url** | **String** |  | [readonly] |
+| **credits_url** | **String** |  | [readonly] |
+| **new_lang** | [**NewLangEnum**](NewLangEnum.md) | How to handle requests for creating new translations.  * `contact` - Contact maintainers * `url` - Point to translation instructions URL * `add` - Create new language file * `none` - Disable adding new translations | [optional] |
+| **language_code_style** | [**ComponentLanguageCodeStyle**](ComponentLanguageCodeStyle.md) |  | [optional] |
+| **push** | **String** |  | [optional] |
+| **check_flags** | **String** | Additional comma-separated flags to influence Weblate behavior. | [optional] |
+| **priority** | [**PriorityEnum**](PriorityEnum.md) | Components with higher priority are offered first to translators.  * `60` - Very high * `80` - High * `100` - Medium * `120` - Low * `140` - Very low | [optional] |
+| **enforced_checks** | **Object** |  | [optional] |
+| **restricted** | **Boolean** | Restrict access to the component to only those explicitly given permission. | [optional] |
+| **repoweb** | **String** | Link to repository browser, use {{branch}} for branch, {{filename}} and {{line}} as filename and line placeholders. You might want to strip leading directory by using {{filename|parentdir}}. | [optional] |
+| **report_source_bugs** | **String** | E-mail address for reports on errors in source strings. Leave empty for no e-mails. | [optional] |
+| **merge_style** | [**MergeStyleEnum**](MergeStyleEnum.md) | Define whether Weblate should merge the upstream repository or rebase changes onto it.  * `merge` - Merge * `rebase` - Rebase * `merge_noff` - Merge without fast-forward | [optional] |
+| **commit_message** | **String** | You can use template language for various info, please consult the documentation for more details. | [optional] |
+| **add_message** | **String** | You can use template language for various info, please consult the documentation for more details. | [optional] |
+| **delete_message** | **String** | You can use template language for various info, please consult the documentation for more details. | [optional] |
+| **merge_message** | **String** | You can use template language for various info, please consult the documentation for more details. | [optional] |
+| **addon_message** | **String** | You can use template language for various info, please consult the documentation for more details. | [optional] |
+| **pull_message** | **String** | You can use template language for various info, please consult the documentation for more details. | [optional] |
+| **allow_translation_propagation** | **Boolean** | Whether translation updates in other components will cause automatic translation in this one | [optional] |
+| **manage_units** | **Boolean** | Enables adding and removing strings straight from Weblate. If your strings are extracted from the source code or managed externally you probably want to keep it disabled. | [optional] |
+| **enable_suggestions** | **Boolean** | Whether to allow translation suggestions at all. | [optional] |
+| **suggestion_voting** | **Boolean** | Users can only vote for suggestions and can’t make direct translations. | [optional] |
+| **suggestion_autoaccept** | **Integer** | Automatically accept suggestions with this number of votes, use 0 to turn it off. | [optional] |
+| **push_on_commit** | **Boolean** | Whether the repository should be pushed upstream on every commit. | [optional] |
+| **commit_pending_age** | **Integer** | Time in hours after which any pending changes will be committed to the VCS. | [optional] |
+| **auto_lock_error** | **Boolean** | Whether the component should be locked on repository errors. | [optional] |
+| **language_regex** | **String** | Regular expression used to filter translation files when scanning for file mask. | [optional] |
+| **key_filter** | **String** | Regular expression used to filter keys. This is only available for monolingual formats. | [optional] |
+| **variant_regex** | **String** | Regular expression used to determine variants of a string. | [optional] |
+| **zipfile** | **String** |  | [optional] |
+| **docfile** | **String** |  | [optional] |
+| **addons** | **Array<String>** |  | [readonly] |
+| **is_glossary** | **Boolean** |  | [optional] |
+| **glossary_color** | [**ColorEnum**](ColorEnum.md) |  | [optional] |
+| **disable_autoshare** | **Boolean** |  | [optional] |
+| **category** | **String** |  | [optional] |
+| **linked_component** | **String** |  | [readonly] |
+
+## Example
+
+```ruby
+require 'weblate'
+
+instance = Weblate::Component.new(
+  name: null,
+  slug: null,
+  id: null,
+  source_language: null,
+  project: null,
+  vcs: null,
+  repo: null,
+  git_export: null,
+  branch: null,
+  push_branch: null,
+  filemask: null,
+  screenshot_filemask: null,
+  template: null,
+  edit_template: null,
+  intermediate: null,
+  new_base: null,
+  file_format: null,
+  license: null,
+  license_url: null,
+  agreement: null,
+  web_url: null,
+  url: null,
+  repository_url: null,
+  translations_url: null,
+  statistics_url: null,
+  lock_url: null,
+  links_url: null,
+  changes_list_url: null,
+  task_url: null,
+  credits_url: null,
+  new_lang: null,
+  language_code_style: null,
+  push: null,
+  check_flags: null,
+  priority: null,
+  enforced_checks: null,
+  restricted: null,
+  repoweb: null,
+  report_source_bugs: null,
+  merge_style: null,
+  commit_message: null,
+  add_message: null,
+  delete_message: null,
+  merge_message: null,
+  addon_message: null,
+  pull_message: null,
+  allow_translation_propagation: null,
+  manage_units: null,
+  enable_suggestions: null,
+  suggestion_voting: null,
+  suggestion_autoaccept: null,
+  push_on_commit: null,
+  commit_pending_age: null,
+  auto_lock_error: null,
+  language_regex: null,
+  key_filter: null,
+  variant_regex: null,
+  zipfile: null,
+  docfile: null,
+  addons: null,
+  is_glossary: null,
+  glossary_color: null,
+  disable_autoshare: null,
+  category: null,
+  linked_component: null
+)
+```
+

data/docs/ComponentLanguageCodeStyle.md

@@ -0,0 +1,49 @@
+# Weblate::ComponentLanguageCodeStyle
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'weblate'
+
+Weblate::ComponentLanguageCodeStyle.openapi_one_of
+# =>
+# [
+#   :'BlankEnum',
+#   :'LanguageCodeStyleEnum'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'weblate'
+
+Weblate::ComponentLanguageCodeStyle.build(data)
+# => #<BlankEnum:0x00007fdd4aab02a0>
+
+Weblate::ComponentLanguageCodeStyle.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `BlankEnum`
+- `LanguageCodeStyleEnum`
+- `nil` (if no type matches)
+

data/docs/ComponentList.md

@@ -0,0 +1,30 @@
+# Weblate::ComponentList
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Display name |  |
+| **slug** | **String** | Name used in URLs and filenames. |  |
+| **id** | **Integer** |  | [readonly] |
+| **show_dashboard** | **Boolean** | When enabled this component list will be shown as a tab on the dashboard | [optional] |
+| **components** | **Array<String>** |  | [readonly] |
+| **auto_assign** | [**Array<AutoComponentList>**](AutoComponentList.md) |  | [readonly] |
+| **url** | **String** |  | [readonly] |
+
+## Example
+
+```ruby
+require 'weblate'
+
+instance = Weblate::ComponentList.new(
+  name: null,
+  slug: null,
+  id: null,
+  show_dashboard: null,
+  components: null,
+  auto_assign: null,
+  url: null
+)
+```
+