ejabberd_http_client 1.0.0

data/docs/SqlApi.md

@@ -0,0 +1,191 @@
+# EjabberdHttpClient::SqlApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**convert_to_scram**](SqlApi.md#convert_to_scram) | **POST** /api/convert_to_scram | Convert the passwords of users to SCRAM for a given vhost. |
+| [**import_prosody**](SqlApi.md#import_prosody) | **POST** /api/import_prosody | Import data from Prosody. |
+| [**update_sql**](SqlApi.md#update_sql) | **POST** /api/update_sql | Convert MS SQL, MySQL, or PostgreSQL DB to the new format. |
+
+
+## convert_to_scram
+
+> convert_to_scram(convert_to_scram_request)
+
+Convert the passwords of users to SCRAM for a given vhost.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ejabberd_http_client'
+
+api_instance = EjabberdHttpClient::SqlApi.new
+convert_to_scram_request = EjabberdHttpClient::ConvertToScramRequest.new # ConvertToScramRequest |
+
+begin
+  # Convert the passwords of users to SCRAM for a given vhost.
+  api_instance.convert_to_scram(convert_to_scram_request)
+rescue EjabberdHttpClient::ApiError => e
+  puts "Error when calling SqlApi->convert_to_scram: #{e}"
+end
+```
+
+#### Using the convert_to_scram_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_scram_with_http_info(convert_to_scram_request)
+
+```ruby
+begin
+  # Convert the passwords of users to SCRAM for a given vhost.
+  data, status_code, headers = api_instance.convert_to_scram_with_http_info(convert_to_scram_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue EjabberdHttpClient::ApiError => e
+  puts "Error when calling SqlApi->convert_to_scram_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **convert_to_scram_request** | [**ConvertToScramRequest**](ConvertToScramRequest.md) |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: Not defined
+
+
+## import_prosody
+
+> import_prosody(import_prosody_request)
+
+Import data from Prosody.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ejabberd_http_client'
+
+api_instance = EjabberdHttpClient::SqlApi.new
+import_prosody_request = EjabberdHttpClient::ImportProsodyRequest.new # ImportProsodyRequest |
+
+begin
+  # Import data from Prosody.
+  api_instance.import_prosody(import_prosody_request)
+rescue EjabberdHttpClient::ApiError => e
+  puts "Error when calling SqlApi->import_prosody: #{e}"
+end
+```
+
+#### Using the import_prosody_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)> import_prosody_with_http_info(import_prosody_request)
+
+```ruby
+begin
+  # Import data from Prosody.
+  data, status_code, headers = api_instance.import_prosody_with_http_info(import_prosody_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue EjabberdHttpClient::ApiError => e
+  puts "Error when calling SqlApi->import_prosody_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **import_prosody_request** | [**ImportProsodyRequest**](ImportProsodyRequest.md) |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: Not defined
+
+
+## update_sql
+
+> Integer update_sql
+
+Convert MS SQL, MySQL, or PostgreSQL DB to the new format.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ejabberd_http_client'
+
+api_instance = EjabberdHttpClient::SqlApi.new
+
+begin
+  # Convert MS SQL, MySQL, or PostgreSQL DB to the new format.
+  result = api_instance.update_sql
+  p result
+rescue EjabberdHttpClient::ApiError => e
+  puts "Error when calling SqlApi->update_sql: #{e}"
+end
+```
+
+#### Using the update_sql_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Integer, Integer, Hash)> update_sql_with_http_info
+
+```ruby
+begin
+  # Convert MS SQL, MySQL, or PostgreSQL DB to the new format.
+  data, status_code, headers = api_instance.update_sql_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Integer
+rescue EjabberdHttpClient::ApiError => e
+  puts "Error when calling SqlApi->update_sql_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/SrgCreateRequest.md

@@ -0,0 +1,26 @@
+# EjabberdHttpClient::SrgCreateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **group** | **String** | Group identifier. | [optional] |
+| **host** | **String** | Group server name. | [optional] |
+| **label** | **String** | Group name. | [optional] |
+| **description** | **String** | Group description. | [optional] |
+| **display** | **String** | Groups to display. | [optional] |
+
+## Example
+
+```ruby
+require 'ejabberd_http_client'
+
+instance = EjabberdHttpClient::SrgCreateRequest.new(
+  group: null,
+  host: null,
+  label: null,
+  description: null,
+  display: null
+)
+```
+

data/docs/SrgDeleteRequest.md

@@ -0,0 +1,20 @@
+# EjabberdHttpClient::SrgDeleteRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **group** | **String** | Group identifier. | [optional] |
+| **host** | **String** | Group server name. | [optional] |
+
+## Example
+
+```ruby
+require 'ejabberd_http_client'
+
+instance = EjabberdHttpClient::SrgDeleteRequest.new(
+  group: null,
+  host: null
+)
+```
+

data/docs/SrgGetInfo200ResponseInner.md

@@ -0,0 +1,20 @@
+# EjabberdHttpClient::SrgGetInfo200ResponseInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key** | **String** | Information key. | [optional] |
+| **value** | **String** | Information value. | [optional] |
+
+## Example
+
+```ruby
+require 'ejabberd_http_client'
+
+instance = EjabberdHttpClient::SrgGetInfo200ResponseInner.new(
+  key: null,
+  value: null
+)
+```
+

data/docs/SrgUserAddRequest.md

@@ -0,0 +1,24 @@
+# EjabberdHttpClient::SrgUserAddRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user** | **String** | Username. | [optional] |
+| **host** | **String** | User server name. | [optional] |
+| **group** | **String** | Group identifier. | [optional] |
+| **grouphost** | **String** | Group server name. | [optional] |
+
+## Example
+
+```ruby
+require 'ejabberd_http_client'
+
+instance = EjabberdHttpClient::SrgUserAddRequest.new(
+  user: null,
+  host: null,
+  group: null,
+  grouphost: null
+)
+```
+

data/docs/StanzaApi.md

@@ -0,0 +1,267 @@
+# EjabberdHttpClient::StanzaApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**privacy_set**](StanzaApi.md#privacy_set) | **POST** /api/privacy_set | Send a IQ set privacy stanza for a local account. |
+| [**send_message**](StanzaApi.md#send_message) | **POST** /api/send_message | Send a message to a local or remote bare of full JID. |
+| [**send_stanza**](StanzaApi.md#send_stanza) | **POST** /api/send_stanza | Send a stanza; provide From JID and valid To JID. |
+| [**send_stanza_c2_s**](StanzaApi.md#send_stanza_c2_s) | **POST** /api/send_stanza_c2s | Send a stanza from an existing C2S session. |
+
+
+## privacy_set
+
+> Integer privacy_set(opts)
+
+Send a IQ set privacy stanza for a local account.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ejabberd_http_client'
+
+api_instance = EjabberdHttpClient::StanzaApi.new
+opts = {
+  privacy_set_request: EjabberdHttpClient::PrivacySetRequest.new # PrivacySetRequest |
+}
+
+begin
+  # Send a IQ set privacy stanza for a local account.
+  result = api_instance.privacy_set(opts)
+  p result
+rescue EjabberdHttpClient::ApiError => e
+  puts "Error when calling StanzaApi->privacy_set: #{e}"
+end
+```
+
+#### Using the privacy_set_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Integer, Integer, Hash)> privacy_set_with_http_info(opts)
+
+```ruby
+begin
+  # Send a IQ set privacy stanza for a local account.
+  data, status_code, headers = api_instance.privacy_set_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Integer
+rescue EjabberdHttpClient::ApiError => e
+  puts "Error when calling StanzaApi->privacy_set_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **privacy_set_request** | [**PrivacySetRequest**](PrivacySetRequest.md) |  | [optional] |
+
+### Return type
+
+**Integer**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## send_message
+
+> Integer send_message(opts)
+
+Send a message to a local or remote bare of full JID.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ejabberd_http_client'
+
+api_instance = EjabberdHttpClient::StanzaApi.new
+opts = {
+  send_message_request: EjabberdHttpClient::SendMessageRequest.new # SendMessageRequest |
+}
+
+begin
+  # Send a message to a local or remote bare of full JID.
+  result = api_instance.send_message(opts)
+  p result
+rescue EjabberdHttpClient::ApiError => e
+  puts "Error when calling StanzaApi->send_message: #{e}"
+end
+```
+
+#### Using the send_message_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Integer, Integer, Hash)> send_message_with_http_info(opts)
+
+```ruby
+begin
+  # Send a message to a local or remote bare of full JID.
+  data, status_code, headers = api_instance.send_message_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Integer
+rescue EjabberdHttpClient::ApiError => e
+  puts "Error when calling StanzaApi->send_message_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **send_message_request** | [**SendMessageRequest**](SendMessageRequest.md) |  | [optional] |
+
+### Return type
+
+**Integer**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## send_stanza
+
+> Integer send_stanza(opts)
+
+Send a stanza; provide From JID and valid To JID.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ejabberd_http_client'
+
+api_instance = EjabberdHttpClient::StanzaApi.new
+opts = {
+  send_stanza_request: EjabberdHttpClient::SendStanzaRequest.new # SendStanzaRequest |
+}
+
+begin
+  # Send a stanza; provide From JID and valid To JID.
+  result = api_instance.send_stanza(opts)
+  p result
+rescue EjabberdHttpClient::ApiError => e
+  puts "Error when calling StanzaApi->send_stanza: #{e}"
+end
+```
+
+#### Using the send_stanza_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Integer, Integer, Hash)> send_stanza_with_http_info(opts)
+
+```ruby
+begin
+  # Send a stanza; provide From JID and valid To JID.
+  data, status_code, headers = api_instance.send_stanza_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Integer
+rescue EjabberdHttpClient::ApiError => e
+  puts "Error when calling StanzaApi->send_stanza_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **send_stanza_request** | [**SendStanzaRequest**](SendStanzaRequest.md) |  | [optional] |
+
+### Return type
+
+**Integer**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## send_stanza_c2_s
+
+> Integer send_stanza_c2_s(opts)
+
+Send a stanza from an existing C2S session.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ejabberd_http_client'
+
+api_instance = EjabberdHttpClient::StanzaApi.new
+opts = {
+  send_stanza_c2_s_request: EjabberdHttpClient::SendStanzaC2SRequest.new # SendStanzaC2SRequest |
+}
+
+begin
+  # Send a stanza from an existing C2S session.
+  result = api_instance.send_stanza_c2_s(opts)
+  p result
+rescue EjabberdHttpClient::ApiError => e
+  puts "Error when calling StanzaApi->send_stanza_c2_s: #{e}"
+end
+```
+
+#### Using the send_stanza_c2_s_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Integer, Integer, Hash)> send_stanza_c2_s_with_http_info(opts)
+
+```ruby
+begin
+  # Send a stanza from an existing C2S session.
+  data, status_code, headers = api_instance.send_stanza_c2_s_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Integer
+rescue EjabberdHttpClient::ApiError => e
+  puts "Error when calling StanzaApi->send_stanza_c2_s_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **send_stanza_c2_s_request** | [**SendStanzaC2SRequest**](SendStanzaC2SRequest.md) |  | [optional] |
+
+### Return type
+
+**Integer**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+