ejabberd_http_client 1.0.0

data/docs/ClusterApi.md

@@ -0,0 +1,256 @@
+# EjabberdHttpClient::ClusterApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**join_cluster**](ClusterApi.md#join_cluster) | **POST** /api/join_cluster | Join this node into the cluster handled by Node. |
+| [**leave_cluster**](ClusterApi.md#leave_cluster) | **POST** /api/leave_cluster | Remove and shutdown Node from the running cluster. |
+| [**list_cluster**](ClusterApi.md#list_cluster) | **POST** /api/list_cluster | List nodes that are part of the cluster handled by Node. |
+| [**set_master**](ClusterApi.md#set_master) | **POST** /api/set_master | Set master node of the clustered Mnesia tables. |
+
+
+## join_cluster
+
+> join_cluster(join_cluster_request)
+
+Join this node into the cluster handled by Node.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ejabberd_http_client'
+
+api_instance = EjabberdHttpClient::ClusterApi.new
+join_cluster_request = EjabberdHttpClient::JoinClusterRequest.new # JoinClusterRequest |
+
+begin
+  # Join this node into the cluster handled by Node.
+  api_instance.join_cluster(join_cluster_request)
+rescue EjabberdHttpClient::ApiError => e
+  puts "Error when calling ClusterApi->join_cluster: #{e}"
+end
+```
+
+#### Using the join_cluster_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)> join_cluster_with_http_info(join_cluster_request)
+
+```ruby
+begin
+  # Join this node into the cluster handled by Node.
+  data, status_code, headers = api_instance.join_cluster_with_http_info(join_cluster_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue EjabberdHttpClient::ApiError => e
+  puts "Error when calling ClusterApi->join_cluster_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **join_cluster_request** | [**JoinClusterRequest**](JoinClusterRequest.md) |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: Not defined
+
+
+## leave_cluster
+
+> leave_cluster(leave_cluster_request)
+
+Remove and shutdown Node from the running cluster.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ejabberd_http_client'
+
+api_instance = EjabberdHttpClient::ClusterApi.new
+leave_cluster_request = EjabberdHttpClient::LeaveClusterRequest.new # LeaveClusterRequest |
+
+begin
+  # Remove and shutdown Node from the running cluster.
+  api_instance.leave_cluster(leave_cluster_request)
+rescue EjabberdHttpClient::ApiError => e
+  puts "Error when calling ClusterApi->leave_cluster: #{e}"
+end
+```
+
+#### Using the leave_cluster_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)> leave_cluster_with_http_info(leave_cluster_request)
+
+```ruby
+begin
+  # Remove and shutdown Node from the running cluster.
+  data, status_code, headers = api_instance.leave_cluster_with_http_info(leave_cluster_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue EjabberdHttpClient::ApiError => e
+  puts "Error when calling ClusterApi->leave_cluster_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **leave_cluster_request** | [**LeaveClusterRequest**](LeaveClusterRequest.md) |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: Not defined
+
+
+## list_cluster
+
+> Array&lt;String&gt; list_cluster
+
+List nodes that are part of the cluster handled by Node.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ejabberd_http_client'
+
+api_instance = EjabberdHttpClient::ClusterApi.new
+
+begin
+  # List nodes that are part of the cluster handled by Node.
+  result = api_instance.list_cluster
+  p result
+rescue EjabberdHttpClient::ApiError => e
+  puts "Error when calling ClusterApi->list_cluster: #{e}"
+end
+```
+
+#### Using the list_cluster_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Array&lt;String&gt;, Integer, Hash)> list_cluster_with_http_info
+
+```ruby
+begin
+  # List nodes that are part of the cluster handled by Node.
+  data, status_code, headers = api_instance.list_cluster_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Array&lt;String&gt;
+rescue EjabberdHttpClient::ApiError => e
+  puts "Error when calling ClusterApi->list_cluster_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+**Array&lt;String&gt;**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## set_master
+
+> String set_master(opts)
+
+Set master node of the clustered Mnesia tables.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ejabberd_http_client'
+
+api_instance = EjabberdHttpClient::ClusterApi.new
+opts = {
+  set_master_request: EjabberdHttpClient::SetMasterRequest.new # SetMasterRequest |
+}
+
+begin
+  # Set master node of the clustered Mnesia tables.
+  result = api_instance.set_master(opts)
+  p result
+rescue EjabberdHttpClient::ApiError => e
+  puts "Error when calling ClusterApi->set_master: #{e}"
+end
+```
+
+#### Using the set_master_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(String, Integer, Hash)> set_master_with_http_info(opts)
+
+```ruby
+begin
+  # Set master node of the clustered Mnesia tables.
+  data, status_code, headers = api_instance.set_master_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => String
+rescue EjabberdHttpClient::ApiError => e
+  puts "Error when calling ClusterApi->set_master_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **set_master_request** | [**SetMasterRequest**](SetMasterRequest.md) |  | [optional] |
+
+### Return type
+
+**String**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/CompileRequest.md

@@ -0,0 +1,18 @@
+# EjabberdHttpClient::CompileRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **file** | **String** | Filename of Erlang source file to compile. | [optional] |
+
+## Example
+
+```ruby
+require 'ejabberd_http_client'
+
+instance = EjabberdHttpClient::CompileRequest.new(
+  file: null
+)
+```
+

data/docs/ConfigApi.md

@@ -0,0 +1,192 @@
+# EjabberdHttpClient::ConfigApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**convert_to_yaml**](ConfigApi.md#convert_to_yaml) | **POST** /api/convert_to_yaml | Convert the input configuration file from Erlang to YAML format. |
+| [**dump_config**](ConfigApi.md#dump_config) | **POST** /api/dump_config | Dump configuration in YAML format as seen by ejabberd. |
+| [**reload_config**](ConfigApi.md#reload_config) | **POST** /api/reload_config | Reload config file in memory. |
+
+
+## convert_to_yaml
+
+> convert_to_yaml(convert_to_yaml_request)
+
+Convert the input configuration file from Erlang to YAML format.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ejabberd_http_client'
+
+api_instance = EjabberdHttpClient::ConfigApi.new
+convert_to_yaml_request = EjabberdHttpClient::ConvertToYamlRequest.new # ConvertToYamlRequest |
+
+begin
+  # Convert the input configuration file from Erlang to YAML format.
+  api_instance.convert_to_yaml(convert_to_yaml_request)
+rescue EjabberdHttpClient::ApiError => e
+  puts "Error when calling ConfigApi->convert_to_yaml: #{e}"
+end
+```
+
+#### Using the convert_to_yaml_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)> convert_to_yaml_with_http_info(convert_to_yaml_request)
+
+```ruby
+begin
+  # Convert the input configuration file from Erlang to YAML format.
+  data, status_code, headers = api_instance.convert_to_yaml_with_http_info(convert_to_yaml_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue EjabberdHttpClient::ApiError => e
+  puts "Error when calling ConfigApi->convert_to_yaml_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **convert_to_yaml_request** | [**ConvertToYamlRequest**](ConvertToYamlRequest.md) |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: Not defined
+
+
+## dump_config
+
+> Integer dump_config(dump_config_request)
+
+Dump configuration in YAML format as seen by ejabberd.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ejabberd_http_client'
+
+api_instance = EjabberdHttpClient::ConfigApi.new
+dump_config_request = EjabberdHttpClient::DumpConfigRequest.new # DumpConfigRequest |
+
+begin
+  # Dump configuration in YAML format as seen by ejabberd.
+  result = api_instance.dump_config(dump_config_request)
+  p result
+rescue EjabberdHttpClient::ApiError => e
+  puts "Error when calling ConfigApi->dump_config: #{e}"
+end
+```
+
+#### Using the dump_config_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Integer, Integer, Hash)> dump_config_with_http_info(dump_config_request)
+
+```ruby
+begin
+  # Dump configuration in YAML format as seen by ejabberd.
+  data, status_code, headers = api_instance.dump_config_with_http_info(dump_config_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Integer
+rescue EjabberdHttpClient::ApiError => e
+  puts "Error when calling ConfigApi->dump_config_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **dump_config_request** | [**DumpConfigRequest**](DumpConfigRequest.md) |  |  |
+
+### Return type
+
+**Integer**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## reload_config
+
+> Integer reload_config
+
+Reload config file in memory.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ejabberd_http_client'
+
+api_instance = EjabberdHttpClient::ConfigApi.new
+
+begin
+  # Reload config file in memory.
+  result = api_instance.reload_config
+  p result
+rescue EjabberdHttpClient::ApiError => e
+  puts "Error when calling ConfigApi->reload_config: #{e}"
+end
+```
+
+#### Using the reload_config_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Integer, Integer, Hash)> reload_config_with_http_info
+
+```ruby
+begin
+  # Reload config file in memory.
+  data, status_code, headers = api_instance.reload_config_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Integer
+rescue EjabberdHttpClient::ApiError => e
+  puts "Error when calling ConfigApi->reload_config_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+**Integer**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/ConnectedUsersInfo200ResponseInner.md

@@ -0,0 +1,36 @@
+# EjabberdHttpClient::ConnectedUsersInfo200ResponseInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **jid** | **String** | User JID. | [optional] |
+| **connection** | **String** | Connection type. | [optional] |
+| **ip** | **String** | IP address. | [optional] |
+| **port** | **Integer** | Port number. | [optional] |
+| **priority** | **Integer** | Priority. | [optional] |
+| **node** | **String** | Node. | [optional] |
+| **uptime** | **Integer** | Uptime. | [optional] |
+| **status** | **String** | Status. | [optional] |
+| **resource** | **String** | Resource. | [optional] |
+| **statustext** | **String** | Status text. | [optional] |
+
+## Example
+
+```ruby
+require 'ejabberd_http_client'
+
+instance = EjabberdHttpClient::ConnectedUsersInfo200ResponseInner.new(
+  jid: null,
+  connection: null,
+  ip: null,
+  port: null,
+  priority: null,
+  node: null,
+  uptime: null,
+  status: null,
+  resource: null,
+  statustext: null
+)
+```
+

data/docs/ConnectedUsersNumber200Response.md

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

data/docs/ConnectedUsersVHostRequest.md

@@ -0,0 +1,18 @@
+# EjabberdHttpClient::ConnectedUsersVHostRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **host** | **String** | Server name. | [optional] |
+
+## Example
+
+```ruby
+require 'ejabberd_http_client'
+
+instance = EjabberdHttpClient::ConnectedUsersVHostRequest.new(
+  host: null
+)
+```
+

data/docs/ConvertToScramRequest.md

@@ -0,0 +1,18 @@
+# EjabberdHttpClient::ConvertToScramRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **host** | **String** | Vhost which users' passwords will be scrammed. | [optional] |
+
+## Example
+
+```ruby
+require 'ejabberd_http_client'
+
+instance = EjabberdHttpClient::ConvertToScramRequest.new(
+  host: null
+)
+```
+

data/docs/ConvertToYamlRequest.md

@@ -0,0 +1,20 @@
+# EjabberdHttpClient::ConvertToYamlRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_in** | **String** | Full path to the original configuration file. | [optional] |
+| **out** | **String** | Full path to the final YAML configuration file. | [optional] |
+
+## Example
+
+```ruby
+require 'ejabberd_http_client'
+
+instance = EjabberdHttpClient::ConvertToYamlRequest.new(
+  _in: null,
+  out: null
+)
+```
+

data/docs/CreateRoomRequest.md

@@ -0,0 +1,22 @@
+# EjabberdHttpClient::CreateRoomRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Room name. | [optional] |
+| **service** | **String** | MUC service. | [optional] |
+| **host** | **String** | Server host. | [optional] |
+
+## Example
+
+```ruby
+require 'ejabberd_http_client'
+
+instance = EjabberdHttpClient::CreateRoomRequest.new(
+  name: null,
+  service: null,
+  host: null
+)
+```
+

data/docs/CreateRoomWithOptionsRequest.md

@@ -0,0 +1,24 @@
+# EjabberdHttpClient::CreateRoomWithOptionsRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Room name. | [optional] |
+| **service** | **String** | MUC service. | [optional] |
+| **host** | **String** | Server host. | [optional] |
+| **options** | [**Array<CreateRoomWithOptionsRequestOptionsInner>**](CreateRoomWithOptionsRequestOptionsInner.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ejabberd_http_client'
+
+instance = EjabberdHttpClient::CreateRoomWithOptionsRequest.new(
+  name: null,
+  service: null,
+  host: null,
+  options: null
+)
+```
+

data/docs/CreateRoomWithOptionsRequestOptionsInner.md

@@ -0,0 +1,20 @@
+# EjabberdHttpClient::CreateRoomWithOptionsRequestOptionsInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Option name. | [optional] |
+| **value** | **String** | Value for the option. | [optional] |
+
+## Example
+
+```ruby
+require 'ejabberd_http_client'
+
+instance = EjabberdHttpClient::CreateRoomWithOptionsRequestOptionsInner.new(
+  name: null,
+  value: null
+)
+```
+

data/docs/CreateRoomsFileRequest.md

@@ -0,0 +1,18 @@
+# EjabberdHttpClient::CreateRoomsFileRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **file** | **String** | Path to the text file with one room JID per line. | [optional] |
+
+## Example
+
+```ruby
+require 'ejabberd_http_client'
+
+instance = EjabberdHttpClient::CreateRoomsFileRequest.new(
+  file: null
+)
+```
+

data/docs/DeleteMnesiaRequest.md

@@ -0,0 +1,18 @@
+# EjabberdHttpClient::DeleteMnesiaRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **host** | **String** | Vhost which content will be deleted in Mnesia database. | [optional] |
+
+## Example
+
+```ruby
+require 'ejabberd_http_client'
+
+instance = EjabberdHttpClient::DeleteMnesiaRequest.new(
+  host: null
+)
+```
+