weblate 0.1.0

data/docs/ScreenshotsApi.md

@@ -0,0 +1,815 @@
+# Weblate::ScreenshotsApi
+
+All URIs are relative to *https://hosted.weblate.org*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**screenshots_create**](ScreenshotsApi.md#screenshots_create) | **POST** /screenshots/ |  |
+| [**screenshots_destroy**](ScreenshotsApi.md#screenshots_destroy) | **DELETE** /screenshots/{id}/ |  |
+| [**screenshots_file_create**](ScreenshotsApi.md#screenshots_file_create) | **POST** /screenshots/{id}/file/ |  |
+| [**screenshots_file_retrieve**](ScreenshotsApi.md#screenshots_file_retrieve) | **GET** /screenshots/{id}/file/ |  |
+| [**screenshots_file_update**](ScreenshotsApi.md#screenshots_file_update) | **PUT** /screenshots/{id}/file/ |  |
+| [**screenshots_list**](ScreenshotsApi.md#screenshots_list) | **GET** /screenshots/ |  |
+| [**screenshots_partial_update**](ScreenshotsApi.md#screenshots_partial_update) | **PATCH** /screenshots/{id}/ |  |
+| [**screenshots_retrieve**](ScreenshotsApi.md#screenshots_retrieve) | **GET** /screenshots/{id}/ |  |
+| [**screenshots_units_create**](ScreenshotsApi.md#screenshots_units_create) | **POST** /screenshots/{id}/units/ |  |
+| [**screenshots_units_destroy**](ScreenshotsApi.md#screenshots_units_destroy) | **DELETE** /screenshots/{id}/units/{unit_id}/ |  |
+| [**screenshots_update**](ScreenshotsApi.md#screenshots_update) | **PUT** /screenshots/{id}/ |  |
+
+
+## screenshots_create
+
+> <Screenshot> screenshots_create(screenshot)
+
+
+
+Screenshots 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::ScreenshotsApi.new
+screenshot = Weblate::Screenshot.new({id: 37, name: 'name_example', translation: 'translation_example', file_url: 'file_url_example', units: ['units_example'], url: 'url_example'}) # Screenshot | 
+
+begin
+  
+  result = api_instance.screenshots_create(screenshot)
+  p result
+rescue Weblate::ApiError => e
+  puts "Error when calling ScreenshotsApi->screenshots_create: #{e}"
+end
+```
+
+#### Using the screenshots_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Screenshot>, Integer, Hash)> screenshots_create_with_http_info(screenshot)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.screenshots_create_with_http_info(screenshot)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Screenshot>
+rescue Weblate::ApiError => e
+  puts "Error when calling ScreenshotsApi->screenshots_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **screenshot** | [**Screenshot**](Screenshot.md) |  |  |
+
+### Return type
+
+[**Screenshot**](Screenshot.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
+## screenshots_destroy
+
+> screenshots_destroy(id)
+
+
+
+Screenshots 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::ScreenshotsApi.new
+id = 'id_example' # String | 
+
+begin
+  
+  api_instance.screenshots_destroy(id)
+rescue Weblate::ApiError => e
+  puts "Error when calling ScreenshotsApi->screenshots_destroy: #{e}"
+end
+```
+
+#### Using the screenshots_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)> screenshots_destroy_with_http_info(id)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.screenshots_destroy_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Weblate::ApiError => e
+  puts "Error when calling ScreenshotsApi->screenshots_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
+
+
+## screenshots_file_create
+
+> <ScreenshotFile> screenshots_file_create(id, image)
+
+
+
+Screenshots 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::ScreenshotsApi.new
+id = 'id_example' # String | 
+image = 'image_example' # String | 
+
+begin
+  
+  result = api_instance.screenshots_file_create(id, image)
+  p result
+rescue Weblate::ApiError => e
+  puts "Error when calling ScreenshotsApi->screenshots_file_create: #{e}"
+end
+```
+
+#### Using the screenshots_file_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ScreenshotFile>, Integer, Hash)> screenshots_file_create_with_http_info(id, image)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.screenshots_file_create_with_http_info(id, image)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ScreenshotFile>
+rescue Weblate::ApiError => e
+  puts "Error when calling ScreenshotsApi->screenshots_file_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **image** | **String** |  |  |
+
+### Return type
+
+[**ScreenshotFile**](ScreenshotFile.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: multipart/form-data, application/x-www-form-urlencoded
+- **Accept**: application/json
+
+
+## screenshots_file_retrieve
+
+> <ScreenshotFile> screenshots_file_retrieve(id)
+
+
+
+Screenshots 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::ScreenshotsApi.new
+id = 'id_example' # String | 
+
+begin
+  
+  result = api_instance.screenshots_file_retrieve(id)
+  p result
+rescue Weblate::ApiError => e
+  puts "Error when calling ScreenshotsApi->screenshots_file_retrieve: #{e}"
+end
+```
+
+#### Using the screenshots_file_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ScreenshotFile>, Integer, Hash)> screenshots_file_retrieve_with_http_info(id)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.screenshots_file_retrieve_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ScreenshotFile>
+rescue Weblate::ApiError => e
+  puts "Error when calling ScreenshotsApi->screenshots_file_retrieve_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+[**ScreenshotFile**](ScreenshotFile.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## screenshots_file_update
+
+> <ScreenshotFile> screenshots_file_update(id, image)
+
+
+
+Screenshots 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::ScreenshotsApi.new
+id = 'id_example' # String | 
+image = 'image_example' # String | 
+
+begin
+  
+  result = api_instance.screenshots_file_update(id, image)
+  p result
+rescue Weblate::ApiError => e
+  puts "Error when calling ScreenshotsApi->screenshots_file_update: #{e}"
+end
+```
+
+#### Using the screenshots_file_update_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ScreenshotFile>, Integer, Hash)> screenshots_file_update_with_http_info(id, image)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.screenshots_file_update_with_http_info(id, image)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ScreenshotFile>
+rescue Weblate::ApiError => e
+  puts "Error when calling ScreenshotsApi->screenshots_file_update_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **image** | **String** |  |  |
+
+### Return type
+
+[**ScreenshotFile**](ScreenshotFile.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: multipart/form-data, application/x-www-form-urlencoded
+- **Accept**: application/json
+
+
+## screenshots_list
+
+> <PaginatedScreenshotList> screenshots_list(opts)
+
+
+
+Screenshots 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::ScreenshotsApi.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.screenshots_list(opts)
+  p result
+rescue Weblate::ApiError => e
+  puts "Error when calling ScreenshotsApi->screenshots_list: #{e}"
+end
+```
+
+#### Using the screenshots_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaginatedScreenshotList>, Integer, Hash)> screenshots_list_with_http_info(opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.screenshots_list_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginatedScreenshotList>
+rescue Weblate::ApiError => e
+  puts "Error when calling ScreenshotsApi->screenshots_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
+
+[**PaginatedScreenshotList**](PaginatedScreenshotList.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## screenshots_partial_update
+
+> <Screenshot> screenshots_partial_update(id, opts)
+
+
+
+Screenshots 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::ScreenshotsApi.new
+id = 'id_example' # String | 
+opts = {
+  patched_screenshot: Weblate::PatchedScreenshot.new # PatchedScreenshot | 
+}
+
+begin
+  
+  result = api_instance.screenshots_partial_update(id, opts)
+  p result
+rescue Weblate::ApiError => e
+  puts "Error when calling ScreenshotsApi->screenshots_partial_update: #{e}"
+end
+```
+
+#### Using the screenshots_partial_update_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Screenshot>, Integer, Hash)> screenshots_partial_update_with_http_info(id, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.screenshots_partial_update_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Screenshot>
+rescue Weblate::ApiError => e
+  puts "Error when calling ScreenshotsApi->screenshots_partial_update_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **patched_screenshot** | [**PatchedScreenshot**](PatchedScreenshot.md) |  | [optional] |
+
+### Return type
+
+[**Screenshot**](Screenshot.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
+## screenshots_retrieve
+
+> <Screenshot> screenshots_retrieve(id)
+
+
+
+Screenshots 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::ScreenshotsApi.new
+id = 'id_example' # String | 
+
+begin
+  
+  result = api_instance.screenshots_retrieve(id)
+  p result
+rescue Weblate::ApiError => e
+  puts "Error when calling ScreenshotsApi->screenshots_retrieve: #{e}"
+end
+```
+
+#### Using the screenshots_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Screenshot>, Integer, Hash)> screenshots_retrieve_with_http_info(id)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.screenshots_retrieve_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Screenshot>
+rescue Weblate::ApiError => e
+  puts "Error when calling ScreenshotsApi->screenshots_retrieve_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+[**Screenshot**](Screenshot.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## screenshots_units_create
+
+> <Screenshot> screenshots_units_create(id, screenshot)
+
+
+
+Screenshots 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::ScreenshotsApi.new
+id = 'id_example' # String | 
+screenshot = Weblate::Screenshot.new({id: 37, name: 'name_example', translation: 'translation_example', file_url: 'file_url_example', units: ['units_example'], url: 'url_example'}) # Screenshot | 
+
+begin
+  
+  result = api_instance.screenshots_units_create(id, screenshot)
+  p result
+rescue Weblate::ApiError => e
+  puts "Error when calling ScreenshotsApi->screenshots_units_create: #{e}"
+end
+```
+
+#### Using the screenshots_units_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Screenshot>, Integer, Hash)> screenshots_units_create_with_http_info(id, screenshot)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.screenshots_units_create_with_http_info(id, screenshot)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Screenshot>
+rescue Weblate::ApiError => e
+  puts "Error when calling ScreenshotsApi->screenshots_units_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **screenshot** | [**Screenshot**](Screenshot.md) |  |  |
+
+### Return type
+
+[**Screenshot**](Screenshot.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
+## screenshots_units_destroy
+
+> screenshots_units_destroy(id, unit_id)
+
+
+
+Screenshots 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::ScreenshotsApi.new
+id = 'id_example' # String | 
+unit_id = 'unit_id_example' # String | 
+
+begin
+  
+  api_instance.screenshots_units_destroy(id, unit_id)
+rescue Weblate::ApiError => e
+  puts "Error when calling ScreenshotsApi->screenshots_units_destroy: #{e}"
+end
+```
+
+#### Using the screenshots_units_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)> screenshots_units_destroy_with_http_info(id, unit_id)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.screenshots_units_destroy_with_http_info(id, unit_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Weblate::ApiError => e
+  puts "Error when calling ScreenshotsApi->screenshots_units_destroy_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **unit_id** | **String** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## screenshots_update
+
+> <Screenshot> screenshots_update(id, screenshot)
+
+
+
+Screenshots 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::ScreenshotsApi.new
+id = 'id_example' # String | 
+screenshot = Weblate::Screenshot.new({id: 37, name: 'name_example', translation: 'translation_example', file_url: 'file_url_example', units: ['units_example'], url: 'url_example'}) # Screenshot | 
+
+begin
+  
+  result = api_instance.screenshots_update(id, screenshot)
+  p result
+rescue Weblate::ApiError => e
+  puts "Error when calling ScreenshotsApi->screenshots_update: #{e}"
+end
+```
+
+#### Using the screenshots_update_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Screenshot>, Integer, Hash)> screenshots_update_with_http_info(id, screenshot)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.screenshots_update_with_http_info(id, screenshot)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Screenshot>
+rescue Weblate::ApiError => e
+  puts "Error when calling ScreenshotsApi->screenshots_update_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **screenshot** | [**Screenshot**](Screenshot.md) |  |  |
+
+### Return type
+
+[**Screenshot**](Screenshot.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+