weblate 0.1.0

data/docs/ComponentListsApi.md

@@ -0,0 +1,667 @@
+# Weblate::ComponentListsApi
+
+All URIs are relative to *https://hosted.weblate.org*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**component_lists_components_create**](ComponentListsApi.md#component_lists_components_create) | **POST** /component-lists/{slug}/components/ |  |
+| [**component_lists_components_destroy**](ComponentListsApi.md#component_lists_components_destroy) | **DELETE** /component-lists/{slug}/components/{component_slug}/ |  |
+| [**component_lists_components_retrieve**](ComponentListsApi.md#component_lists_components_retrieve) | **GET** /component-lists/{slug}/components/ |  |
+| [**component_lists_create**](ComponentListsApi.md#component_lists_create) | **POST** /component-lists/ |  |
+| [**component_lists_destroy**](ComponentListsApi.md#component_lists_destroy) | **DELETE** /component-lists/{slug}/ |  |
+| [**component_lists_list**](ComponentListsApi.md#component_lists_list) | **GET** /component-lists/ |  |
+| [**component_lists_partial_update**](ComponentListsApi.md#component_lists_partial_update) | **PATCH** /component-lists/{slug}/ |  |
+| [**component_lists_retrieve**](ComponentListsApi.md#component_lists_retrieve) | **GET** /component-lists/{slug}/ |  |
+| [**component_lists_update**](ComponentListsApi.md#component_lists_update) | **PUT** /component-lists/{slug}/ |  |
+
+
+## component_lists_components_create
+
+> <ComponentList> component_lists_components_create(slug, component_list)
+
+
+
+Component lists 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::ComponentListsApi.new
+slug = 'slug_example' # String | 
+component_list = Weblate::ComponentList.new({name: 'name_example', slug: 'slug_example', id: 37, components: ['components_example'], auto_assign: [Weblate::AutoComponentList.new], url: 'url_example'}) # ComponentList | 
+
+begin
+  
+  result = api_instance.component_lists_components_create(slug, component_list)
+  p result
+rescue Weblate::ApiError => e
+  puts "Error when calling ComponentListsApi->component_lists_components_create: #{e}"
+end
+```
+
+#### Using the component_lists_components_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ComponentList>, Integer, Hash)> component_lists_components_create_with_http_info(slug, component_list)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.component_lists_components_create_with_http_info(slug, component_list)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ComponentList>
+rescue Weblate::ApiError => e
+  puts "Error when calling ComponentListsApi->component_lists_components_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **slug** | **String** |  |  |
+| **component_list** | [**ComponentList**](ComponentList.md) |  |  |
+
+### Return type
+
+[**ComponentList**](ComponentList.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
+## component_lists_components_destroy
+
+> component_lists_components_destroy(component_slug, slug)
+
+
+
+Component lists 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::ComponentListsApi.new
+component_slug = 'component_slug_example' # String | 
+slug = 'slug_example' # String | 
+
+begin
+  
+  api_instance.component_lists_components_destroy(component_slug, slug)
+rescue Weblate::ApiError => e
+  puts "Error when calling ComponentListsApi->component_lists_components_destroy: #{e}"
+end
+```
+
+#### Using the component_lists_components_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)> component_lists_components_destroy_with_http_info(component_slug, slug)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.component_lists_components_destroy_with_http_info(component_slug, slug)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Weblate::ApiError => e
+  puts "Error when calling ComponentListsApi->component_lists_components_destroy_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **component_slug** | **String** |  |  |
+| **slug** | **String** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## component_lists_components_retrieve
+
+> <ComponentList> component_lists_components_retrieve(slug)
+
+
+
+Component lists 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::ComponentListsApi.new
+slug = 'slug_example' # String | 
+
+begin
+  
+  result = api_instance.component_lists_components_retrieve(slug)
+  p result
+rescue Weblate::ApiError => e
+  puts "Error when calling ComponentListsApi->component_lists_components_retrieve: #{e}"
+end
+```
+
+#### Using the component_lists_components_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ComponentList>, Integer, Hash)> component_lists_components_retrieve_with_http_info(slug)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.component_lists_components_retrieve_with_http_info(slug)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ComponentList>
+rescue Weblate::ApiError => e
+  puts "Error when calling ComponentListsApi->component_lists_components_retrieve_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **slug** | **String** |  |  |
+
+### Return type
+
+[**ComponentList**](ComponentList.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## component_lists_create
+
+> <ComponentList> component_lists_create(component_list)
+
+
+
+Component lists 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::ComponentListsApi.new
+component_list = Weblate::ComponentList.new({name: 'name_example', slug: 'slug_example', id: 37, components: ['components_example'], auto_assign: [Weblate::AutoComponentList.new], url: 'url_example'}) # ComponentList | 
+
+begin
+  
+  result = api_instance.component_lists_create(component_list)
+  p result
+rescue Weblate::ApiError => e
+  puts "Error when calling ComponentListsApi->component_lists_create: #{e}"
+end
+```
+
+#### Using the component_lists_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ComponentList>, Integer, Hash)> component_lists_create_with_http_info(component_list)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.component_lists_create_with_http_info(component_list)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ComponentList>
+rescue Weblate::ApiError => e
+  puts "Error when calling ComponentListsApi->component_lists_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **component_list** | [**ComponentList**](ComponentList.md) |  |  |
+
+### Return type
+
+[**ComponentList**](ComponentList.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
+## component_lists_destroy
+
+> component_lists_destroy(slug)
+
+
+
+Component lists 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::ComponentListsApi.new
+slug = 'slug_example' # String | 
+
+begin
+  
+  api_instance.component_lists_destroy(slug)
+rescue Weblate::ApiError => e
+  puts "Error when calling ComponentListsApi->component_lists_destroy: #{e}"
+end
+```
+
+#### Using the component_lists_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)> component_lists_destroy_with_http_info(slug)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.component_lists_destroy_with_http_info(slug)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Weblate::ApiError => e
+  puts "Error when calling ComponentListsApi->component_lists_destroy_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **slug** | **String** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## component_lists_list
+
+> <PaginatedComponentListList> component_lists_list(opts)
+
+
+
+Component lists 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::ComponentListsApi.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.component_lists_list(opts)
+  p result
+rescue Weblate::ApiError => e
+  puts "Error when calling ComponentListsApi->component_lists_list: #{e}"
+end
+```
+
+#### Using the component_lists_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaginatedComponentListList>, Integer, Hash)> component_lists_list_with_http_info(opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.component_lists_list_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginatedComponentListList>
+rescue Weblate::ApiError => e
+  puts "Error when calling ComponentListsApi->component_lists_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
+
+[**PaginatedComponentListList**](PaginatedComponentListList.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## component_lists_partial_update
+
+> <ComponentList> component_lists_partial_update(slug, opts)
+
+
+
+Component lists 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::ComponentListsApi.new
+slug = 'slug_example' # String | 
+opts = {
+  patched_component_list: Weblate::PatchedComponentList.new # PatchedComponentList | 
+}
+
+begin
+  
+  result = api_instance.component_lists_partial_update(slug, opts)
+  p result
+rescue Weblate::ApiError => e
+  puts "Error when calling ComponentListsApi->component_lists_partial_update: #{e}"
+end
+```
+
+#### Using the component_lists_partial_update_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ComponentList>, Integer, Hash)> component_lists_partial_update_with_http_info(slug, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.component_lists_partial_update_with_http_info(slug, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ComponentList>
+rescue Weblate::ApiError => e
+  puts "Error when calling ComponentListsApi->component_lists_partial_update_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **slug** | **String** |  |  |
+| **patched_component_list** | [**PatchedComponentList**](PatchedComponentList.md) |  | [optional] |
+
+### Return type
+
+[**ComponentList**](ComponentList.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
+## component_lists_retrieve
+
+> <ComponentList> component_lists_retrieve(slug)
+
+
+
+Component lists 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::ComponentListsApi.new
+slug = 'slug_example' # String | 
+
+begin
+  
+  result = api_instance.component_lists_retrieve(slug)
+  p result
+rescue Weblate::ApiError => e
+  puts "Error when calling ComponentListsApi->component_lists_retrieve: #{e}"
+end
+```
+
+#### Using the component_lists_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ComponentList>, Integer, Hash)> component_lists_retrieve_with_http_info(slug)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.component_lists_retrieve_with_http_info(slug)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ComponentList>
+rescue Weblate::ApiError => e
+  puts "Error when calling ComponentListsApi->component_lists_retrieve_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **slug** | **String** |  |  |
+
+### Return type
+
+[**ComponentList**](ComponentList.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## component_lists_update
+
+> <ComponentList> component_lists_update(slug, component_list)
+
+
+
+Component lists 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::ComponentListsApi.new
+slug = 'slug_example' # String | 
+component_list = Weblate::ComponentList.new({name: 'name_example', slug: 'slug_example', id: 37, components: ['components_example'], auto_assign: [Weblate::AutoComponentList.new], url: 'url_example'}) # ComponentList | 
+
+begin
+  
+  result = api_instance.component_lists_update(slug, component_list)
+  p result
+rescue Weblate::ApiError => e
+  puts "Error when calling ComponentListsApi->component_lists_update: #{e}"
+end
+```
+
+#### Using the component_lists_update_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ComponentList>, Integer, Hash)> component_lists_update_with_http_info(slug, component_list)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.component_lists_update_with_http_info(slug, component_list)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ComponentList>
+rescue Weblate::ApiError => e
+  puts "Error when calling ComponentListsApi->component_lists_update_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **slug** | **String** |  |  |
+| **component_list** | [**ComponentList**](ComponentList.md) |  |  |
+
+### Return type
+
+[**ComponentList**](ComponentList.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+