ejabberd_http_client 1.0.0

data/docs/DeleteOldMAMMessagesBatchRequest.md

@@ -0,0 +1,26 @@
+# EjabberdHttpClient::DeleteOldMAMMessagesBatchRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **host** | **String** | Name of host where messages should be deleted. | [optional] |
+| **type** | **String** | Type of messages to delete (chat, groupchat, all). | [optional] |
+| **days** | **Integer** | Days to keep messages. | [optional] |
+| **batch_size** | **Integer** | Number of messages to delete per batch. | [optional] |
+| **rate** | **Integer** | Desired rate of messages to delete per minute. | [optional] |
+
+## Example
+
+```ruby
+require 'ejabberd_http_client'
+
+instance = EjabberdHttpClient::DeleteOldMAMMessagesBatchRequest.new(
+  host: null,
+  type: null,
+  days: null,
+  batch_size: null,
+  rate: null
+)
+```
+

data/docs/DeleteOldMAMMessagesRequest.md

@@ -0,0 +1,20 @@
+# EjabberdHttpClient::DeleteOldMAMMessagesRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | Type of messages to delete (chat, groupchat, all). | [optional] |
+| **days** | **Integer** | Days to keep messages. | [optional] |
+
+## Example
+
+```ruby
+require 'ejabberd_http_client'
+
+instance = EjabberdHttpClient::DeleteOldMAMMessagesRequest.new(
+  type: null,
+  days: null
+)
+```
+

data/docs/DeleteOldMAMMessagesStatusRequest.md

@@ -0,0 +1,18 @@
+# EjabberdHttpClient::DeleteOldMAMMessagesStatusRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **host** | **String** | Name of host where messages should be deleted. | [optional] |
+
+## Example
+
+```ruby
+require 'ejabberd_http_client'
+
+instance = EjabberdHttpClient::DeleteOldMAMMessagesStatusRequest.new(
+  host: null
+)
+```
+

data/docs/DeleteOldMessagesBatchRequest.md

@@ -0,0 +1,24 @@
+# EjabberdHttpClient::DeleteOldMessagesBatchRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **host** | **String** | Name of host where messages should be deleted. | [optional] |
+| **days** | **Integer** | Days to keep messages. | [optional] |
+| **batch_size** | **Integer** | Number of messages to delete per batch. | [optional] |
+| **rate** | **Integer** | Desired rate of messages to delete per minute. | [optional] |
+
+## Example
+
+```ruby
+require 'ejabberd_http_client'
+
+instance = EjabberdHttpClient::DeleteOldMessagesBatchRequest.new(
+  host: null,
+  days: null,
+  batch_size: null,
+  rate: null
+)
+```
+

data/docs/DeleteOldMessagesRequest.md

@@ -0,0 +1,18 @@
+# EjabberdHttpClient::DeleteOldMessagesRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **days** | **Integer** | Number of days. | [optional] |
+
+## Example
+
+```ruby
+require 'ejabberd_http_client'
+
+instance = EjabberdHttpClient::DeleteOldMessagesRequest.new(
+  days: null
+)
+```
+

data/docs/DeleteOldPubsubItemsRequest.md

@@ -0,0 +1,18 @@
+# EjabberdHttpClient::DeleteOldPubsubItemsRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **number** | **Integer** | Number of items to keep per node. | [optional] |
+
+## Example
+
+```ruby
+require 'ejabberd_http_client'
+
+instance = EjabberdHttpClient::DeleteOldPubsubItemsRequest.new(
+  number: null
+)
+```
+

data/docs/DeleteOldUsersRequest.md

@@ -0,0 +1,18 @@
+# EjabberdHttpClient::DeleteOldUsersRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **days** | **Integer** | Last login age in days of accounts that should be removed. | [optional] |
+
+## Example
+
+```ruby
+require 'ejabberd_http_client'
+
+instance = EjabberdHttpClient::DeleteOldUsersRequest.new(
+  days: null
+)
+```
+

data/docs/DocumentationApi.md

@@ -0,0 +1,255 @@
+# EjabberdHttpClient::DocumentationApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**gen_html_doc_for_commands**](DocumentationApi.md#gen_html_doc_for_commands) | **POST** /api/gen_html_doc_for_commands | Generates html documentation for ejabberd_commands. |
+| [**gen_markdown_doc_for_commands**](DocumentationApi.md#gen_markdown_doc_for_commands) | **POST** /api/gen_markdown_doc_for_commands | Generates markdown documentation for ejabberd_commands. |
+| [**gen_markdown_doc_for_tags**](DocumentationApi.md#gen_markdown_doc_for_tags) | **POST** /api/gen_markdown_doc_for_tags | Generates markdown documentation for ejabberd_commands. |
+| [**generate_manpage**](DocumentationApi.md#generate_manpage) | **POST** /api/man | Generate Unix manpage for current ejabberd version. |
+
+
+## gen_html_doc_for_commands
+
+> Integer gen_html_doc_for_commands(gen_html_doc_for_commands_request)
+
+Generates html documentation for ejabberd_commands.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ejabberd_http_client'
+
+api_instance = EjabberdHttpClient::DocumentationApi.new
+gen_html_doc_for_commands_request = EjabberdHttpClient::GenHtmlDocForCommandsRequest.new # GenHtmlDocForCommandsRequest |
+
+begin
+  # Generates html documentation for ejabberd_commands.
+  result = api_instance.gen_html_doc_for_commands(gen_html_doc_for_commands_request)
+  p result
+rescue EjabberdHttpClient::ApiError => e
+  puts "Error when calling DocumentationApi->gen_html_doc_for_commands: #{e}"
+end
+```
+
+#### Using the gen_html_doc_for_commands_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Integer, Integer, Hash)> gen_html_doc_for_commands_with_http_info(gen_html_doc_for_commands_request)
+
+```ruby
+begin
+  # Generates html documentation for ejabberd_commands.
+  data, status_code, headers = api_instance.gen_html_doc_for_commands_with_http_info(gen_html_doc_for_commands_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Integer
+rescue EjabberdHttpClient::ApiError => e
+  puts "Error when calling DocumentationApi->gen_html_doc_for_commands_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **gen_html_doc_for_commands_request** | [**GenHtmlDocForCommandsRequest**](GenHtmlDocForCommandsRequest.md) |  |  |
+
+### Return type
+
+**Integer**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## gen_markdown_doc_for_commands
+
+> Integer gen_markdown_doc_for_commands(gen_html_doc_for_commands_request)
+
+Generates markdown documentation for ejabberd_commands.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ejabberd_http_client'
+
+api_instance = EjabberdHttpClient::DocumentationApi.new
+gen_html_doc_for_commands_request = EjabberdHttpClient::GenHtmlDocForCommandsRequest.new # GenHtmlDocForCommandsRequest |
+
+begin
+  # Generates markdown documentation for ejabberd_commands.
+  result = api_instance.gen_markdown_doc_for_commands(gen_html_doc_for_commands_request)
+  p result
+rescue EjabberdHttpClient::ApiError => e
+  puts "Error when calling DocumentationApi->gen_markdown_doc_for_commands: #{e}"
+end
+```
+
+#### Using the gen_markdown_doc_for_commands_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Integer, Integer, Hash)> gen_markdown_doc_for_commands_with_http_info(gen_html_doc_for_commands_request)
+
+```ruby
+begin
+  # Generates markdown documentation for ejabberd_commands.
+  data, status_code, headers = api_instance.gen_markdown_doc_for_commands_with_http_info(gen_html_doc_for_commands_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Integer
+rescue EjabberdHttpClient::ApiError => e
+  puts "Error when calling DocumentationApi->gen_markdown_doc_for_commands_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **gen_html_doc_for_commands_request** | [**GenHtmlDocForCommandsRequest**](GenHtmlDocForCommandsRequest.md) |  |  |
+
+### Return type
+
+**Integer**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## gen_markdown_doc_for_tags
+
+> Integer gen_markdown_doc_for_tags(gen_markdown_doc_for_tags_request)
+
+Generates markdown documentation for ejabberd_commands.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ejabberd_http_client'
+
+api_instance = EjabberdHttpClient::DocumentationApi.new
+gen_markdown_doc_for_tags_request = EjabberdHttpClient::GenMarkdownDocForTagsRequest.new # GenMarkdownDocForTagsRequest |
+
+begin
+  # Generates markdown documentation for ejabberd_commands.
+  result = api_instance.gen_markdown_doc_for_tags(gen_markdown_doc_for_tags_request)
+  p result
+rescue EjabberdHttpClient::ApiError => e
+  puts "Error when calling DocumentationApi->gen_markdown_doc_for_tags: #{e}"
+end
+```
+
+#### Using the gen_markdown_doc_for_tags_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Integer, Integer, Hash)> gen_markdown_doc_for_tags_with_http_info(gen_markdown_doc_for_tags_request)
+
+```ruby
+begin
+  # Generates markdown documentation for ejabberd_commands.
+  data, status_code, headers = api_instance.gen_markdown_doc_for_tags_with_http_info(gen_markdown_doc_for_tags_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Integer
+rescue EjabberdHttpClient::ApiError => e
+  puts "Error when calling DocumentationApi->gen_markdown_doc_for_tags_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **gen_markdown_doc_for_tags_request** | [**GenMarkdownDocForTagsRequest**](GenMarkdownDocForTagsRequest.md) |  |  |
+
+### Return type
+
+**Integer**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## generate_manpage
+
+> generate_manpage
+
+Generate Unix manpage for current ejabberd version.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ejabberd_http_client'
+
+api_instance = EjabberdHttpClient::DocumentationApi.new
+
+begin
+  # Generate Unix manpage for current ejabberd version.
+  api_instance.generate_manpage
+rescue EjabberdHttpClient::ApiError => e
+  puts "Error when calling DocumentationApi->generate_manpage: #{e}"
+end
+```
+
+#### Using the generate_manpage_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)> generate_manpage_with_http_info
+
+```ruby
+begin
+  # Generate Unix manpage for current ejabberd version.
+  data, status_code, headers = api_instance.generate_manpage_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue EjabberdHttpClient::ApiError => e
+  puts "Error when calling DocumentationApi->generate_manpage_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+

data/docs/DumpConfigRequest.md

@@ -0,0 +1,18 @@
+# EjabberdHttpClient::DumpConfigRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **out** | **String** | Full path to output file. | [optional] |
+
+## Example
+
+```ruby
+require 'ejabberd_http_client'
+
+instance = EjabberdHttpClient::DumpConfigRequest.new(
+  out: null
+)
+```
+

data/docs/DumpRequest.md

@@ -0,0 +1,18 @@
+# EjabberdHttpClient::DumpRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **file** | **String** | Full path for the text file. | [optional] |
+
+## Example
+
+```ruby
+require 'ejabberd_http_client'
+
+instance = EjabberdHttpClient::DumpRequest.new(
+  file: null
+)
+```
+

data/docs/DumpTableRequest.md

@@ -0,0 +1,20 @@
+# EjabberdHttpClient::DumpTableRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **file** | **String** | Full path for the text file. | [optional] |
+| **table** | **String** | Table name. | [optional] |
+
+## Example
+
+```ruby
+require 'ejabberd_http_client'
+
+instance = EjabberdHttpClient::DumpTableRequest.new(
+  file: null,
+  table: null
+)
+```
+

data/docs/ErlangApi.md

@@ -0,0 +1,194 @@
+# EjabberdHttpClient::ErlangApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**compile**](ErlangApi.md#compile) | **POST** /api/compile | Recompile and reload Erlang source code file. |
+| [**get_cookie**](ErlangApi.md#get_cookie) | **POST** /api/get_cookie | Get the Erlang cookie of this node. |
+| [**restart_module**](ErlangApi.md#restart_module) | **POST** /api/restart_module | Stop an ejabberd module, reload code, and start. |
+
+
+## compile
+
+> compile(compile_request)
+
+Recompile and reload Erlang source code file.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ejabberd_http_client'
+
+api_instance = EjabberdHttpClient::ErlangApi.new
+compile_request = EjabberdHttpClient::CompileRequest.new # CompileRequest |
+
+begin
+  # Recompile and reload Erlang source code file.
+  api_instance.compile(compile_request)
+rescue EjabberdHttpClient::ApiError => e
+  puts "Error when calling ErlangApi->compile: #{e}"
+end
+```
+
+#### Using the compile_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)> compile_with_http_info(compile_request)
+
+```ruby
+begin
+  # Recompile and reload Erlang source code file.
+  data, status_code, headers = api_instance.compile_with_http_info(compile_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue EjabberdHttpClient::ApiError => e
+  puts "Error when calling ErlangApi->compile_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **compile_request** | [**CompileRequest**](CompileRequest.md) |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: Not defined
+
+
+## get_cookie
+
+> <GetCookie200Response> get_cookie
+
+Get the Erlang cookie of this node.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ejabberd_http_client'
+
+api_instance = EjabberdHttpClient::ErlangApi.new
+
+begin
+  # Get the Erlang cookie of this node.
+  result = api_instance.get_cookie
+  p result
+rescue EjabberdHttpClient::ApiError => e
+  puts "Error when calling ErlangApi->get_cookie: #{e}"
+end
+```
+
+#### Using the get_cookie_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetCookie200Response>, Integer, Hash)> get_cookie_with_http_info
+
+```ruby
+begin
+  # Get the Erlang cookie of this node.
+  data, status_code, headers = api_instance.get_cookie_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetCookie200Response>
+rescue EjabberdHttpClient::ApiError => e
+  puts "Error when calling ErlangApi->get_cookie_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**GetCookie200Response**](GetCookie200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## restart_module
+
+> <RestartModule200Response> restart_module(opts)
+
+Stop an ejabberd module, reload code, and start.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ejabberd_http_client'
+
+api_instance = EjabberdHttpClient::ErlangApi.new
+opts = {
+  restart_module_request: EjabberdHttpClient::RestartModuleRequest.new # RestartModuleRequest |
+}
+
+begin
+  # Stop an ejabberd module, reload code, and start.
+  result = api_instance.restart_module(opts)
+  p result
+rescue EjabberdHttpClient::ApiError => e
+  puts "Error when calling ErlangApi->restart_module: #{e}"
+end
+```
+
+#### Using the restart_module_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<RestartModule200Response>, Integer, Hash)> restart_module_with_http_info(opts)
+
+```ruby
+begin
+  # Stop an ejabberd module, reload code, and start.
+  data, status_code, headers = api_instance.restart_module_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <RestartModule200Response>
+rescue EjabberdHttpClient::ApiError => e
+  puts "Error when calling ErlangApi->restart_module_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **restart_module_request** | [**RestartModuleRequest**](RestartModuleRequest.md) |  | [optional] |
+
+### Return type
+
+[**RestartModule200Response**](RestartModule200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/Export2sqlRequest.md

@@ -0,0 +1,20 @@
+# EjabberdHttpClient::Export2sqlRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **host** | **String** | Vhost. | [optional] |
+| **file** | **String** | Full path to the destination SQL file. | [optional] |
+
+## Example
+
+```ruby
+require 'ejabberd_http_client'
+
+instance = EjabberdHttpClient::Export2sqlRequest.new(
+  host: null,
+  file: null
+)
+```
+

data/docs/ExportPiefxisHostRequest.md

@@ -0,0 +1,20 @@
+# EjabberdHttpClient::ExportPiefxisHostRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **dir** | **String** | Full path to a directory. | [optional] |
+| **host** | **String** | Vhost to export. | [optional] |
+
+## Example
+
+```ruby
+require 'ejabberd_http_client'
+
+instance = EjabberdHttpClient::ExportPiefxisHostRequest.new(
+  dir: null,
+  host: null
+)
+```
+