ejabberd_http_client 1.0.0

data/docs/AcmeApi.md

@@ -0,0 +1,197 @@
+# EjabberdHttpClient::AcmeApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**list_certificates**](AcmeApi.md#list_certificates) | **POST** /api/list_certificates | Lists all ACME certificates. |
+| [**request_certificate**](AcmeApi.md#request_certificate) | **POST** /api/request_certificate | Requests certificates for specified domains. |
+| [**revoke_certificate**](AcmeApi.md#revoke_certificate) | **POST** /api/revoke_certificate | Revokes the selected ACME certificate. |
+
+
+## list_certificates
+
+> <Array<ListCertificates200ResponseInner>> list_certificates
+
+Lists all ACME certificates.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ejabberd_http_client'
+
+api_instance = EjabberdHttpClient::AcmeApi.new
+
+begin
+  # Lists all ACME certificates.
+  result = api_instance.list_certificates
+  p result
+rescue EjabberdHttpClient::ApiError => e
+  puts "Error when calling AcmeApi->list_certificates: #{e}"
+end
+```
+
+#### Using the list_certificates_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<ListCertificates200ResponseInner>>, Integer, Hash)> list_certificates_with_http_info
+
+```ruby
+begin
+  # Lists all ACME certificates.
+  data, status_code, headers = api_instance.list_certificates_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<ListCertificates200ResponseInner>>
+rescue EjabberdHttpClient::ApiError => e
+  puts "Error when calling AcmeApi->list_certificates_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array&lt;ListCertificates200ResponseInner&gt;**](ListCertificates200ResponseInner.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## request_certificate
+
+> String request_certificate(opts)
+
+Requests certificates for specified domains.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ejabberd_http_client'
+
+api_instance = EjabberdHttpClient::AcmeApi.new
+opts = {
+  request_certificate_request: EjabberdHttpClient::RequestCertificateRequest.new # RequestCertificateRequest |
+}
+
+begin
+  # Requests certificates for specified domains.
+  result = api_instance.request_certificate(opts)
+  p result
+rescue EjabberdHttpClient::ApiError => e
+  puts "Error when calling AcmeApi->request_certificate: #{e}"
+end
+```
+
+#### Using the request_certificate_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(String, Integer, Hash)> request_certificate_with_http_info(opts)
+
+```ruby
+begin
+  # Requests certificates for specified domains.
+  data, status_code, headers = api_instance.request_certificate_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => String
+rescue EjabberdHttpClient::ApiError => e
+  puts "Error when calling AcmeApi->request_certificate_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **request_certificate_request** | [**RequestCertificateRequest**](RequestCertificateRequest.md) |  | [optional] |
+
+### Return type
+
+**String**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## revoke_certificate
+
+> String revoke_certificate(opts)
+
+Revokes the selected ACME certificate.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ejabberd_http_client'
+
+api_instance = EjabberdHttpClient::AcmeApi.new
+opts = {
+  revoke_certificate_request: EjabberdHttpClient::RevokeCertificateRequest.new # RevokeCertificateRequest |
+}
+
+begin
+  # Revokes the selected ACME certificate.
+  result = api_instance.revoke_certificate(opts)
+  p result
+rescue EjabberdHttpClient::ApiError => e
+  puts "Error when calling AcmeApi->revoke_certificate: #{e}"
+end
+```
+
+#### Using the revoke_certificate_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(String, Integer, Hash)> revoke_certificate_with_http_info(opts)
+
+```ruby
+begin
+  # Revokes the selected ACME certificate.
+  data, status_code, headers = api_instance.revoke_certificate_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => String
+rescue EjabberdHttpClient::ApiError => e
+  puts "Error when calling AcmeApi->revoke_certificate_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **revoke_certificate_request** | [**RevokeCertificateRequest**](RevokeCertificateRequest.md) |  | [optional] |
+
+### Return type
+
+**String**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/AddOAuthClientImplicitRequest.md

@@ -0,0 +1,22 @@
+# EjabberdHttpClient::AddOAuthClientImplicitRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **client_id** | **String** | Client ID. | [optional] |
+| **client_name** | **String** | Client Name. | [optional] |
+| **redirect_uri** | **String** | Redirect URI. | [optional] |
+
+## Example
+
+```ruby
+require 'ejabberd_http_client'
+
+instance = EjabberdHttpClient::AddOAuthClientImplicitRequest.new(
+  client_id: null,
+  client_name: null,
+  redirect_uri: null
+)
+```
+

data/docs/AddOAuthClientPasswordRequest.md

@@ -0,0 +1,22 @@
+# EjabberdHttpClient::AddOAuthClientPasswordRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **client_id** | **String** | Client ID. | [optional] |
+| **client_name** | **String** | Client Name. | [optional] |
+| **secret** | **String** | Secret. | [optional] |
+
+## Example
+
+```ruby
+require 'ejabberd_http_client'
+
+instance = EjabberdHttpClient::AddOAuthClientPasswordRequest.new(
+  client_id: null,
+  client_name: null,
+  secret: null
+)
+```
+

data/docs/AddRosterItemRequest.md

@@ -0,0 +1,30 @@
+# EjabberdHttpClient::AddRosterItemRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **localuser** | **String** | User name. | [optional] |
+| **localhost** | **String** | Server name. | [optional] |
+| **user** | **String** | Contact user name. | [optional] |
+| **host** | **String** | Contact server name. | [optional] |
+| **nick** | **String** | Nickname. | [optional] |
+| **group** | **String** | Group. | [optional] |
+| **subs** | **String** | Subscription. | [optional] |
+
+## Example
+
+```ruby
+require 'ejabberd_http_client'
+
+instance = EjabberdHttpClient::AddRosterItemRequest.new(
+  localuser: null,
+  localhost: null,
+  user: null,
+  host: null,
+  nick: null,
+  group: null,
+  subs: null
+)
+```
+

data/docs/BackupRequest.md

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

data/docs/BanAccountRequest.md

@@ -0,0 +1,22 @@
+# EjabberdHttpClient::BanAccountRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user** | **String** | User name to ban. | [optional] |
+| **host** | **String** | Server name. | [optional] |
+| **reason** | **String** | Reason for banning user. | [optional] |
+
+## Example
+
+```ruby
+require 'ejabberd_http_client'
+
+instance = EjabberdHttpClient::BanAccountRequest.new(
+  user: null,
+  host: null,
+  reason: null
+)
+```
+

data/docs/BookmarksToPepRequest.md

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

data/docs/ChangeNodeNameRequest.md

@@ -0,0 +1,24 @@
+# EjabberdHttpClient::ChangeNodeNameRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **oldnodename** | **String** | Name of the old erlang node. | [optional] |
+| **newnodename** | **String** | Name of the new node. | [optional] |
+| **oldbackup** | **String** | Path to old backup file. | [optional] |
+| **newbackup** | **String** | Path to the new backup file. | [optional] |
+
+## Example
+
+```ruby
+require 'ejabberd_http_client'
+
+instance = EjabberdHttpClient::ChangeNodeNameRequest.new(
+  oldnodename: null,
+  newnodename: null,
+  oldbackup: null,
+  newbackup: null
+)
+```
+

data/docs/ChangePasswordRequest.md

@@ -0,0 +1,22 @@
+# EjabberdHttpClient::ChangePasswordRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user** | **String** | User name. | [optional] |
+| **host** | **String** | Server name. | [optional] |
+| **newpass** | **String** | New password for the user. | [optional] |
+
+## Example
+
+```ruby
+require 'ejabberd_http_client'
+
+instance = EjabberdHttpClient::ChangePasswordRequest.new(
+  user: null,
+  host: null,
+  newpass: null
+)
+```
+

data/docs/ChangeRoomOptionRequest.md

@@ -0,0 +1,24 @@
+# EjabberdHttpClient::ChangeRoomOptionRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Room name. | [optional] |
+| **service** | **String** | MUC service. | [optional] |
+| **option** | **String** | Option name. | [optional] |
+| **value** | **String** | Value to assign. | [optional] |
+
+## Example
+
+```ruby
+require 'ejabberd_http_client'
+
+instance = EjabberdHttpClient::ChangeRoomOptionRequest.new(
+  name: null,
+  service: null,
+  option: null,
+  value: null
+)
+```
+

data/docs/CheckAccountRequest.md

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

data/docs/CheckModuleRequest.md

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

data/docs/CheckPasswordHashRequest.md

@@ -0,0 +1,24 @@
+# EjabberdHttpClient::CheckPasswordHashRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user** | **String** | User name to check. | [optional] |
+| **host** | **String** | Server to check. | [optional] |
+| **passwordhash** | **String** | Password's hash value. | [optional] |
+| **hashmethod** | **String** | Name of hash method. | [optional] |
+
+## Example
+
+```ruby
+require 'ejabberd_http_client'
+
+instance = EjabberdHttpClient::CheckPasswordHashRequest.new(
+  user: null,
+  host: null,
+  passwordhash: null,
+  hashmethod: null
+)
+```
+

data/docs/CheckPasswordRequest.md

@@ -0,0 +1,22 @@
+# EjabberdHttpClient::CheckPasswordRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user** | **String** | User name to check. | [optional] |
+| **host** | **String** | Server to check. | [optional] |
+| **password** | **String** | Password to check. | [optional] |
+
+## Example
+
+```ruby
+require 'ejabberd_http_client'
+
+instance = EjabberdHttpClient::CheckPasswordRequest.new(
+  user: null,
+  host: null,
+  password: null
+)
+```
+