weblate 0.1.0

data/docs/AddonsApi.md

@@ -0,0 +1,366 @@
+# Weblate::AddonsApi
+
+All URIs are relative to *https://hosted.weblate.org*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**addons_destroy**](AddonsApi.md#addons_destroy) | **DELETE** /addons/{id}/ |  |
+| [**addons_list**](AddonsApi.md#addons_list) | **GET** /addons/ |  |
+| [**addons_partial_update**](AddonsApi.md#addons_partial_update) | **PATCH** /addons/{id}/ |  |
+| [**addons_retrieve**](AddonsApi.md#addons_retrieve) | **GET** /addons/{id}/ |  |
+| [**addons_update**](AddonsApi.md#addons_update) | **PUT** /addons/{id}/ |  |
+
+
+## addons_destroy
+
+> addons_destroy(id)
+
+
+
+### 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::AddonsApi.new
+id = 'id_example' # String | 
+
+begin
+  
+  api_instance.addons_destroy(id)
+rescue Weblate::ApiError => e
+  puts "Error when calling AddonsApi->addons_destroy: #{e}"
+end
+```
+
+#### Using the addons_destroy_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> addons_destroy_with_http_info(id)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.addons_destroy_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Weblate::ApiError => e
+  puts "Error when calling AddonsApi->addons_destroy_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## addons_list
+
+> <PaginatedAddonList> addons_list(opts)
+
+
+
+### 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::AddonsApi.new
+opts = {
+  page: 56, # Integer | A page number within the paginated result set.
+  page_size: 56 # Integer | Number of results to return per page.
+}
+
+begin
+  
+  result = api_instance.addons_list(opts)
+  p result
+rescue Weblate::ApiError => e
+  puts "Error when calling AddonsApi->addons_list: #{e}"
+end
+```
+
+#### Using the addons_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaginatedAddonList>, Integer, Hash)> addons_list_with_http_info(opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.addons_list_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginatedAddonList>
+rescue Weblate::ApiError => e
+  puts "Error when calling AddonsApi->addons_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **page** | **Integer** | A page number within the paginated result set. | [optional] |
+| **page_size** | **Integer** | Number of results to return per page. | [optional] |
+
+### Return type
+
+[**PaginatedAddonList**](PaginatedAddonList.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## addons_partial_update
+
+> <Addon> addons_partial_update(id, opts)
+
+
+
+### 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::AddonsApi.new
+id = 'id_example' # String | 
+opts = {
+  patched_addon: Weblate::PatchedAddon.new # PatchedAddon | 
+}
+
+begin
+  
+  result = api_instance.addons_partial_update(id, opts)
+  p result
+rescue Weblate::ApiError => e
+  puts "Error when calling AddonsApi->addons_partial_update: #{e}"
+end
+```
+
+#### Using the addons_partial_update_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Addon>, Integer, Hash)> addons_partial_update_with_http_info(id, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.addons_partial_update_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Addon>
+rescue Weblate::ApiError => e
+  puts "Error when calling AddonsApi->addons_partial_update_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **patched_addon** | [**PatchedAddon**](PatchedAddon.md) |  | [optional] |
+
+### Return type
+
+[**Addon**](Addon.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
+## addons_retrieve
+
+> <Addon> addons_retrieve(id)
+
+
+
+### 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::AddonsApi.new
+id = 'id_example' # String | 
+
+begin
+  
+  result = api_instance.addons_retrieve(id)
+  p result
+rescue Weblate::ApiError => e
+  puts "Error when calling AddonsApi->addons_retrieve: #{e}"
+end
+```
+
+#### Using the addons_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Addon>, Integer, Hash)> addons_retrieve_with_http_info(id)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.addons_retrieve_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Addon>
+rescue Weblate::ApiError => e
+  puts "Error when calling AddonsApi->addons_retrieve_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+[**Addon**](Addon.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## addons_update
+
+> <Addon> addons_update(id, addon)
+
+
+
+### 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::AddonsApi.new
+id = 'id_example' # String | 
+addon = Weblate::Addon.new({component: 'component_example', project: 'project_example', name: 'name_example', id: 37, url: 'url_example'}) # Addon | 
+
+begin
+  
+  result = api_instance.addons_update(id, addon)
+  p result
+rescue Weblate::ApiError => e
+  puts "Error when calling AddonsApi->addons_update: #{e}"
+end
+```
+
+#### Using the addons_update_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Addon>, Integer, Hash)> addons_update_with_http_info(id, addon)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.addons_update_with_http_info(id, addon)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Addon>
+rescue Weblate::ApiError => e
+  puts "Error when calling AddonsApi->addons_update_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **addon** | [**Addon**](Addon.md) |  |  |
+
+### Return type
+
+[**Addon**](Addon.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+

data/docs/AutoComponentList.md

@@ -0,0 +1,20 @@
+# Weblate::AutoComponentList
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **project_match** | **String** | Regular expression which is used to match project slug. | [optional] |
+| **component_match** | **String** | Regular expression which is used to match component slug. | [optional] |
+
+## Example
+
+```ruby
+require 'weblate'
+
+instance = Weblate::AutoComponentList.new(
+  project_match: null,
+  component_match: null
+)
+```
+

data/docs/BasicUser.md

@@ -0,0 +1,22 @@
+# Weblate::BasicUser
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  | [readonly] |
+| **full_name** | **String** |  |  |
+| **username** | **String** | Username may only contain letters, numbers or the following characters: @ . + - _ |  |
+
+## Example
+
+```ruby
+require 'weblate'
+
+instance = Weblate::BasicUser.new(
+  id: null,
+  full_name: null,
+  username: null
+)
+```
+

data/docs/BlankEnum.md

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