weblate 0.1.0

data/docs/CategoriesApi.md

@@ -0,0 +1,520 @@
+# Weblate::CategoriesApi
+
+All URIs are relative to *https://hosted.weblate.org*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**categories_create**](CategoriesApi.md#categories_create) | **POST** /categories/ |  |
+| [**categories_destroy**](CategoriesApi.md#categories_destroy) | **DELETE** /categories/{id}/ |  |
+| [**categories_list**](CategoriesApi.md#categories_list) | **GET** /categories/ |  |
+| [**categories_partial_update**](CategoriesApi.md#categories_partial_update) | **PATCH** /categories/{id}/ |  |
+| [**categories_retrieve**](CategoriesApi.md#categories_retrieve) | **GET** /categories/{id}/ |  |
+| [**categories_statistics_retrieve**](CategoriesApi.md#categories_statistics_retrieve) | **GET** /categories/{id}/statistics/ |  |
+| [**categories_update**](CategoriesApi.md#categories_update) | **PUT** /categories/{id}/ |  |
+
+
+## categories_create
+
+> <Category> categories_create(category)
+
+
+
+Category 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::CategoriesApi.new
+category = Weblate::Category.new({id: 37, name: 'name_example', slug: 'slug_example', project: 'project_example', url: 'url_example', statistics_url: 'statistics_url_example'}) # Category | 
+
+begin
+  
+  result = api_instance.categories_create(category)
+  p result
+rescue Weblate::ApiError => e
+  puts "Error when calling CategoriesApi->categories_create: #{e}"
+end
+```
+
+#### Using the categories_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Category>, Integer, Hash)> categories_create_with_http_info(category)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.categories_create_with_http_info(category)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Category>
+rescue Weblate::ApiError => e
+  puts "Error when calling CategoriesApi->categories_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **category** | [**Category**](Category.md) |  |  |
+
+### Return type
+
+[**Category**](Category.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
+## categories_destroy
+
+> categories_destroy(id)
+
+
+
+Category 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::CategoriesApi.new
+id = 'id_example' # String | 
+
+begin
+  
+  api_instance.categories_destroy(id)
+rescue Weblate::ApiError => e
+  puts "Error when calling CategoriesApi->categories_destroy: #{e}"
+end
+```
+
+#### Using the categories_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)> categories_destroy_with_http_info(id)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.categories_destroy_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Weblate::ApiError => e
+  puts "Error when calling CategoriesApi->categories_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
+
+
+## categories_list
+
+> <PaginatedCategoryList> categories_list(opts)
+
+
+
+Category 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::CategoriesApi.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.categories_list(opts)
+  p result
+rescue Weblate::ApiError => e
+  puts "Error when calling CategoriesApi->categories_list: #{e}"
+end
+```
+
+#### Using the categories_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaginatedCategoryList>, Integer, Hash)> categories_list_with_http_info(opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.categories_list_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginatedCategoryList>
+rescue Weblate::ApiError => e
+  puts "Error when calling CategoriesApi->categories_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
+
+[**PaginatedCategoryList**](PaginatedCategoryList.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## categories_partial_update
+
+> <Category> categories_partial_update(id, opts)
+
+
+
+Category 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::CategoriesApi.new
+id = 'id_example' # String | 
+opts = {
+  patched_category: Weblate::PatchedCategory.new # PatchedCategory | 
+}
+
+begin
+  
+  result = api_instance.categories_partial_update(id, opts)
+  p result
+rescue Weblate::ApiError => e
+  puts "Error when calling CategoriesApi->categories_partial_update: #{e}"
+end
+```
+
+#### Using the categories_partial_update_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Category>, Integer, Hash)> categories_partial_update_with_http_info(id, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.categories_partial_update_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Category>
+rescue Weblate::ApiError => e
+  puts "Error when calling CategoriesApi->categories_partial_update_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **patched_category** | [**PatchedCategory**](PatchedCategory.md) |  | [optional] |
+
+### Return type
+
+[**Category**](Category.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
+## categories_retrieve
+
+> <Category> categories_retrieve(id)
+
+
+
+Category 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::CategoriesApi.new
+id = 'id_example' # String | 
+
+begin
+  
+  result = api_instance.categories_retrieve(id)
+  p result
+rescue Weblate::ApiError => e
+  puts "Error when calling CategoriesApi->categories_retrieve: #{e}"
+end
+```
+
+#### Using the categories_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Category>, Integer, Hash)> categories_retrieve_with_http_info(id)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.categories_retrieve_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Category>
+rescue Weblate::ApiError => e
+  puts "Error when calling CategoriesApi->categories_retrieve_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+[**Category**](Category.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## categories_statistics_retrieve
+
+> <Category> categories_statistics_retrieve(id)
+
+
+
+Category 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::CategoriesApi.new
+id = 'id_example' # String | 
+
+begin
+  
+  result = api_instance.categories_statistics_retrieve(id)
+  p result
+rescue Weblate::ApiError => e
+  puts "Error when calling CategoriesApi->categories_statistics_retrieve: #{e}"
+end
+```
+
+#### Using the categories_statistics_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Category>, Integer, Hash)> categories_statistics_retrieve_with_http_info(id)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.categories_statistics_retrieve_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Category>
+rescue Weblate::ApiError => e
+  puts "Error when calling CategoriesApi->categories_statistics_retrieve_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+[**Category**](Category.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## categories_update
+
+> <Category> categories_update(id, category)
+
+
+
+Category 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::CategoriesApi.new
+id = 'id_example' # String | 
+category = Weblate::Category.new({id: 37, name: 'name_example', slug: 'slug_example', project: 'project_example', url: 'url_example', statistics_url: 'statistics_url_example'}) # Category | 
+
+begin
+  
+  result = api_instance.categories_update(id, category)
+  p result
+rescue Weblate::ApiError => e
+  puts "Error when calling CategoriesApi->categories_update: #{e}"
+end
+```
+
+#### Using the categories_update_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Category>, Integer, Hash)> categories_update_with_http_info(id, category)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.categories_update_with_http_info(id, category)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Category>
+rescue Weblate::ApiError => e
+  puts "Error when calling CategoriesApi->categories_update_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **category** | [**Category**](Category.md) |  |  |
+
+### Return type
+
+[**Category**](Category.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/Category.md

@@ -0,0 +1,30 @@
+# Weblate::Category
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  | [readonly] |
+| **name** | **String** | Display name |  |
+| **slug** | **String** | Name used in URLs and filenames. |  |
+| **project** | **String** |  |  |
+| **category** | **String** |  | [optional] |
+| **url** | **String** |  | [readonly] |
+| **statistics_url** | **String** |  | [readonly] |
+
+## Example
+
+```ruby
+require 'weblate'
+
+instance = Weblate::Category.new(
+  id: null,
+  name: null,
+  slug: null,
+  project: null,
+  category: null,
+  url: null,
+  statistics_url: null
+)
+```
+

data/docs/Change.md

@@ -0,0 +1,42 @@
+# Weblate::Change
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **unit** | **String** |  | [readonly] |
+| **component** | **String** |  | [readonly] |
+| **translation** | **String** |  | [readonly] |
+| **user** | **String** |  | [readonly] |
+| **author** | **String** |  | [readonly] |
+| **timestamp** | **Time** |  | [readonly] |
+| **action** | [**ActionEnum**](ActionEnum.md) |  | [optional] |
+| **target** | **String** |  | [optional] |
+| **old** | **String** |  | [optional] |
+| **details** | **Object** |  | [optional] |
+| **id** | **Integer** |  | [readonly] |
+| **action_name** | **String** |  | [readonly] |
+| **url** | **String** |  | [readonly] |
+
+## Example
+
+```ruby
+require 'weblate'
+
+instance = Weblate::Change.new(
+  unit: null,
+  component: null,
+  translation: null,
+  user: null,
+  author: null,
+  timestamp: null,
+  action: null,
+  target: null,
+  old: null,
+  details: null,
+  id: null,
+  action_name: null,
+  url: null
+)
+```
+