OpenAPI definition

ApiChatController

deleteChat

Delete a chat


/api/v1/chats/{chatId}

Usage and SDK Samples

curl -X DELETE \
 "https://localhost:8443/api/v1/chats/{chatId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiChatControllerApi;

import java.io.File;
import java.util.*;

public class ApiChatControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiChatControllerApi apiInstance = new ApiChatControllerApi();
        Long chatId = 789; // Long | 

        try {
            apiInstance.deleteChat(chatId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiChatControllerApi#deleteChat");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiChatControllerApi;

public class ApiChatControllerApiExample {
    public static void main(String[] args) {
        ApiChatControllerApi apiInstance = new ApiChatControllerApi();
        Long chatId = 789; // Long | 

        try {
            apiInstance.deleteChat(chatId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiChatControllerApi#deleteChat");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiChatControllerApi *apiInstance = [[ApiChatControllerApi alloc] init];
Long *chatId = 789; //  (default to null)

// Delete a chat
[apiInstance deleteChatWith:chatId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiChatControllerApi()
var chatId = 789; // {Long} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteChat(chatId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteChatExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiChatControllerApi();
            var chatId = 789;  // Long |  (default to null)

            try {
                // Delete a chat
                apiInstance.deleteChat(chatId);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiChatControllerApi.deleteChat: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiChatControllerApi();
$chatId = 789; // Long | 

try {
    $api_instance->deleteChat($chatId);
} catch (Exception $e) {
    echo 'Exception when calling ApiChatControllerApi->deleteChat: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiChatControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiChatControllerApi->new();
my $chatId = 789; # Long | 

eval {
    $api_instance->deleteChat(chatId => $chatId);
};
if ($@) {
    warn "Exception when calling ApiChatControllerApi->deleteChat: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiChatControllerApi()
chatId = 789 # Long |  (default to null)

try:
    # Delete a chat
    api_instance.delete_chat(chatId)
except ApiException as e:
    print("Exception when calling ApiChatControllerApi->deleteChat: %s\n" % e)
extern crate ApiChatControllerApi;

pub fn main() {
    let chatId = 789; // Long

    let mut context = ApiChatControllerApi::Context::default();
    let result = client.deleteChat(chatId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
chatId*
Long (int64)
Required

Responses


getChatMessages

Get messages from a specific chat


/api/v1/chats/{chatId}/messages

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://localhost:8443/api/v1/chats/{chatId}/messages"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiChatControllerApi;

import java.io.File;
import java.util.*;

public class ApiChatControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiChatControllerApi apiInstance = new ApiChatControllerApi();
        Long chatId = 789; // Long | 

        try {
            Message_ChatMessageView result = apiInstance.getChatMessages(chatId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiChatControllerApi#getChatMessages");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiChatControllerApi;

public class ApiChatControllerApiExample {
    public static void main(String[] args) {
        ApiChatControllerApi apiInstance = new ApiChatControllerApi();
        Long chatId = 789; // Long | 

        try {
            Message_ChatMessageView result = apiInstance.getChatMessages(chatId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiChatControllerApi#getChatMessages");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiChatControllerApi *apiInstance = [[ApiChatControllerApi alloc] init];
Long *chatId = 789; //  (default to null)

// Get messages from a specific chat
[apiInstance getChatMessagesWith:chatId
              completionHandler: ^(Message_ChatMessageView output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiChatControllerApi()
var chatId = 789; // {Long} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getChatMessages(chatId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getChatMessagesExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiChatControllerApi();
            var chatId = 789;  // Long |  (default to null)

            try {
                // Get messages from a specific chat
                Message_ChatMessageView result = apiInstance.getChatMessages(chatId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiChatControllerApi.getChatMessages: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiChatControllerApi();
$chatId = 789; // Long | 

try {
    $result = $api_instance->getChatMessages($chatId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiChatControllerApi->getChatMessages: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiChatControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiChatControllerApi->new();
my $chatId = 789; # Long | 

eval {
    my $result = $api_instance->getChatMessages(chatId => $chatId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiChatControllerApi->getChatMessages: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiChatControllerApi()
chatId = 789 # Long |  (default to null)

try:
    # Get messages from a specific chat
    api_response = api_instance.get_chat_messages(chatId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiChatControllerApi->getChatMessages: %s\n" % e)
extern crate ApiChatControllerApi;

pub fn main() {
    let chatId = 789; // Long

    let mut context = ApiChatControllerApi::Context::default();
    let result = client.getChatMessages(chatId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
chatId*
Long (int64)
Required

Responses


getUnreadCount

Get count of unread messages


/api/v1/chats/unread-count

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://localhost:8443/api/v1/chats/unread-count"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiChatControllerApi;

import java.io.File;
import java.util.*;

public class ApiChatControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiChatControllerApi apiInstance = new ApiChatControllerApi();

        try {
            Long result = apiInstance.getUnreadCount();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiChatControllerApi#getUnreadCount");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiChatControllerApi;

public class ApiChatControllerApiExample {
    public static void main(String[] args) {
        ApiChatControllerApi apiInstance = new ApiChatControllerApi();

        try {
            Long result = apiInstance.getUnreadCount();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiChatControllerApi#getUnreadCount");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiChatControllerApi *apiInstance = [[ApiChatControllerApi alloc] init];

// Get count of unread messages
[apiInstance getUnreadCountWithCompletionHandler: 
              ^(Long output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiChatControllerApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUnreadCount(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getUnreadCountExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiChatControllerApi();

            try {
                // Get count of unread messages
                Long result = apiInstance.getUnreadCount();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiChatControllerApi.getUnreadCount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiChatControllerApi();

try {
    $result = $api_instance->getUnreadCount();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiChatControllerApi->getUnreadCount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiChatControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiChatControllerApi->new();

eval {
    my $result = $api_instance->getUnreadCount();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiChatControllerApi->getUnreadCount: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiChatControllerApi()

try:
    # Get count of unread messages
    api_response = api_instance.get_unread_count()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiChatControllerApi->getUnreadCount: %s\n" % e)
extern crate ApiChatControllerApi;

pub fn main() {

    let mut context = ApiChatControllerApi::Context::default();
    let result = client.getUnreadCount(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getUserChats

Get user's chats


/api/v1/chats

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://localhost:8443/api/v1/chats?page=56&size=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiChatControllerApi;

import java.io.File;
import java.util.*;

public class ApiChatControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiChatControllerApi apiInstance = new ApiChatControllerApi();
        Integer page = 56; // Integer | 
        Integer size = 56; // Integer | 

        try {
            Chat_ChatListBasicView result = apiInstance.getUserChats(page, size);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiChatControllerApi#getUserChats");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiChatControllerApi;

public class ApiChatControllerApiExample {
    public static void main(String[] args) {
        ApiChatControllerApi apiInstance = new ApiChatControllerApi();
        Integer page = 56; // Integer | 
        Integer size = 56; // Integer | 

        try {
            Chat_ChatListBasicView result = apiInstance.getUserChats(page, size);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiChatControllerApi#getUserChats");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiChatControllerApi *apiInstance = [[ApiChatControllerApi alloc] init];
Integer *page = 56; //  (optional) (default to 0)
Integer *size = 56; //  (optional) (default to 10)

// Get user's chats
[apiInstance getUserChatsWith:page
    size:size
              completionHandler: ^(Chat_ChatListBasicView output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiChatControllerApi()
var opts = {
  'page': 56, // {Integer} 
  'size': 56 // {Integer} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUserChats(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getUserChatsExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiChatControllerApi();
            var page = 56;  // Integer |  (optional)  (default to 0)
            var size = 56;  // Integer |  (optional)  (default to 10)

            try {
                // Get user's chats
                Chat_ChatListBasicView result = apiInstance.getUserChats(page, size);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiChatControllerApi.getUserChats: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiChatControllerApi();
$page = 56; // Integer | 
$size = 56; // Integer | 

try {
    $result = $api_instance->getUserChats($page, $size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiChatControllerApi->getUserChats: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiChatControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiChatControllerApi->new();
my $page = 56; # Integer | 
my $size = 56; # Integer | 

eval {
    my $result = $api_instance->getUserChats(page => $page, size => $size);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiChatControllerApi->getUserChats: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiChatControllerApi()
page = 56 # Integer |  (optional) (default to 0)
size = 56 # Integer |  (optional) (default to 10)

try:
    # Get user's chats
    api_response = api_instance.get_user_chats(page=page, size=size)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiChatControllerApi->getUserChats: %s\n" % e)
extern crate ApiChatControllerApi;

pub fn main() {
    let page = 56; // Integer
    let size = 56; // Integer

    let mut context = ApiChatControllerApi::Context::default();
    let result = client.getUserChats(page, size, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
page
Integer (int32)
size
Integer (int32)

Responses


markMessagesAsRead

Mark messages in a chat as read


/api/v1/chats/{chatId}/read

Usage and SDK Samples

curl -X POST \
 "https://localhost:8443/api/v1/chats/{chatId}/read"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiChatControllerApi;

import java.io.File;
import java.util.*;

public class ApiChatControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiChatControllerApi apiInstance = new ApiChatControllerApi();
        Long chatId = 789; // Long | 

        try {
            apiInstance.markMessagesAsRead(chatId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiChatControllerApi#markMessagesAsRead");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiChatControllerApi;

public class ApiChatControllerApiExample {
    public static void main(String[] args) {
        ApiChatControllerApi apiInstance = new ApiChatControllerApi();
        Long chatId = 789; // Long | 

        try {
            apiInstance.markMessagesAsRead(chatId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiChatControllerApi#markMessagesAsRead");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiChatControllerApi *apiInstance = [[ApiChatControllerApi alloc] init];
Long *chatId = 789; //  (default to null)

// Mark messages in a chat as read
[apiInstance markMessagesAsReadWith:chatId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiChatControllerApi()
var chatId = 789; // {Long} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.markMessagesAsRead(chatId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class markMessagesAsReadExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiChatControllerApi();
            var chatId = 789;  // Long |  (default to null)

            try {
                // Mark messages in a chat as read
                apiInstance.markMessagesAsRead(chatId);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiChatControllerApi.markMessagesAsRead: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiChatControllerApi();
$chatId = 789; // Long | 

try {
    $api_instance->markMessagesAsRead($chatId);
} catch (Exception $e) {
    echo 'Exception when calling ApiChatControllerApi->markMessagesAsRead: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiChatControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiChatControllerApi->new();
my $chatId = 789; # Long | 

eval {
    $api_instance->markMessagesAsRead(chatId => $chatId);
};
if ($@) {
    warn "Exception when calling ApiChatControllerApi->markMessagesAsRead: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiChatControllerApi()
chatId = 789 # Long |  (default to null)

try:
    # Mark messages in a chat as read
    api_instance.mark_messages_as_read(chatId)
except ApiException as e:
    print("Exception when calling ApiChatControllerApi->markMessagesAsRead: %s\n" % e)
extern crate ApiChatControllerApi;

pub fn main() {
    let chatId = 789; // Long

    let mut context = ApiChatControllerApi::Context::default();
    let result = client.markMessagesAsRead(chatId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
chatId*
Long (int64)
Required

Responses


ApiCommunityController

banUser

Ban a user from a community


/api/v1/bans

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://localhost:8443/api/v1/bans" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiCommunityControllerApi;

import java.io.File;
import java.util.*;

public class ApiCommunityControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiCommunityControllerApi apiInstance = new ApiCommunityControllerApi();
        map[String, String] requestBody = ; // map[String, String] | 

        try {
            Ban_BasicInfo result = apiInstance.banUser(requestBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiCommunityControllerApi#banUser");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiCommunityControllerApi;

public class ApiCommunityControllerApiExample {
    public static void main(String[] args) {
        ApiCommunityControllerApi apiInstance = new ApiCommunityControllerApi();
        map[String, String] requestBody = ; // map[String, String] | 

        try {
            Ban_BasicInfo result = apiInstance.banUser(requestBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiCommunityControllerApi#banUser");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiCommunityControllerApi *apiInstance = [[ApiCommunityControllerApi alloc] init];
map[String, String] *requestBody = ; // 

// Ban a user from a community
[apiInstance banUserWith:requestBody
              completionHandler: ^(Ban_BasicInfo output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiCommunityControllerApi()
var requestBody = ; // {map[String, String]} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.banUser(requestBody, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class banUserExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiCommunityControllerApi();
            var requestBody = new map[String, String](); // map[String, String] | 

            try {
                // Ban a user from a community
                Ban_BasicInfo result = apiInstance.banUser(requestBody);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiCommunityControllerApi.banUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiCommunityControllerApi();
$requestBody = ; // map[String, String] | 

try {
    $result = $api_instance->banUser($requestBody);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiCommunityControllerApi->banUser: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiCommunityControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiCommunityControllerApi->new();
my $requestBody = WWW::OPenAPIClient::Object::map[String, String]->new(); # map[String, String] | 

eval {
    my $result = $api_instance->banUser(requestBody => $requestBody);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiCommunityControllerApi->banUser: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiCommunityControllerApi()
requestBody =  # map[String, String] | 

try:
    # Ban a user from a community
    api_response = api_instance.ban_user(requestBody)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiCommunityControllerApi->banUser: %s\n" % e)
extern crate ApiCommunityControllerApi;

pub fn main() {
    let requestBody = ; // map[String, String]

    let mut context = ApiCommunityControllerApi::Context::default();
    let result = client.banUser(requestBody, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
requestBody *

Responses


createCommunity

Create a community


/api/v1/communities

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://localhost:8443/api/v1/communities" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiCommunityControllerApi;

import java.io.File;
import java.util.*;

public class ApiCommunityControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiCommunityControllerApi apiInstance = new ApiCommunityControllerApi();
        map[String, String] requestBody = ; // map[String, String] | 

        try {
            Community_CommunityBasicInfo result = apiInstance.createCommunity(requestBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiCommunityControllerApi#createCommunity");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiCommunityControllerApi;

public class ApiCommunityControllerApiExample {
    public static void main(String[] args) {
        ApiCommunityControllerApi apiInstance = new ApiCommunityControllerApi();
        map[String, String] requestBody = ; // map[String, String] | 

        try {
            Community_CommunityBasicInfo result = apiInstance.createCommunity(requestBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiCommunityControllerApi#createCommunity");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiCommunityControllerApi *apiInstance = [[ApiCommunityControllerApi alloc] init];
map[String, String] *requestBody = ; // 

// Create a community
[apiInstance createCommunityWith:requestBody
              completionHandler: ^(Community_CommunityBasicInfo output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiCommunityControllerApi()
var requestBody = ; // {map[String, String]} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createCommunity(requestBody, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class createCommunityExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiCommunityControllerApi();
            var requestBody = new map[String, String](); // map[String, String] | 

            try {
                // Create a community
                Community_CommunityBasicInfo result = apiInstance.createCommunity(requestBody);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiCommunityControllerApi.createCommunity: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiCommunityControllerApi();
$requestBody = ; // map[String, String] | 

try {
    $result = $api_instance->createCommunity($requestBody);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiCommunityControllerApi->createCommunity: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiCommunityControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiCommunityControllerApi->new();
my $requestBody = WWW::OPenAPIClient::Object::map[String, String]->new(); # map[String, String] | 

eval {
    my $result = $api_instance->createCommunity(requestBody => $requestBody);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiCommunityControllerApi->createCommunity: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiCommunityControllerApi()
requestBody =  # map[String, String] | 

try:
    # Create a community
    api_response = api_instance.create_community(requestBody)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiCommunityControllerApi->createCommunity: %s\n" % e)
extern crate ApiCommunityControllerApi;

pub fn main() {
    let requestBody = ; // map[String, String]

    let mut context = ApiCommunityControllerApi::Context::default();
    let result = client.createCommunity(requestBody, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
requestBody *

Responses


deleteCommunity

Delete a community


/api/v1/communities/{id}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "https://localhost:8443/api/v1/communities/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiCommunityControllerApi;

import java.io.File;
import java.util.*;

public class ApiCommunityControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiCommunityControllerApi apiInstance = new ApiCommunityControllerApi();
        Long id = 789; // Long | 

        try {
            Community result = apiInstance.deleteCommunity(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiCommunityControllerApi#deleteCommunity");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiCommunityControllerApi;

public class ApiCommunityControllerApiExample {
    public static void main(String[] args) {
        ApiCommunityControllerApi apiInstance = new ApiCommunityControllerApi();
        Long id = 789; // Long | 

        try {
            Community result = apiInstance.deleteCommunity(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiCommunityControllerApi#deleteCommunity");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiCommunityControllerApi *apiInstance = [[ApiCommunityControllerApi alloc] init];
Long *id = 789; //  (default to null)

// Delete a community
[apiInstance deleteCommunityWith:id
              completionHandler: ^(Community output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiCommunityControllerApi()
var id = 789; // {Long} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteCommunity(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteCommunityExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiCommunityControllerApi();
            var id = 789;  // Long |  (default to null)

            try {
                // Delete a community
                Community result = apiInstance.deleteCommunity(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiCommunityControllerApi.deleteCommunity: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiCommunityControllerApi();
$id = 789; // Long | 

try {
    $result = $api_instance->deleteCommunity($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiCommunityControllerApi->deleteCommunity: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiCommunityControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiCommunityControllerApi->new();
my $id = 789; # Long | 

eval {
    my $result = $api_instance->deleteCommunity(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiCommunityControllerApi->deleteCommunity: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiCommunityControllerApi()
id = 789 # Long |  (default to null)

try:
    # Delete a community
    api_response = api_instance.delete_community(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiCommunityControllerApi->deleteCommunity: %s\n" % e)
extern crate ApiCommunityControllerApi;

pub fn main() {
    let id = 789; // Long

    let mut context = ApiCommunityControllerApi::Context::default();
    let result = client.deleteCommunity(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
Required

Responses


getAdmin

Get admin of a community


/api/v1/communities/{id}/admins

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://localhost:8443/api/v1/communities/{id}/admins"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiCommunityControllerApi;

import java.io.File;
import java.util.*;

public class ApiCommunityControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiCommunityControllerApi apiInstance = new ApiCommunityControllerApi();
        Long id = 789; // Long | 

        try {
            Community_CommunityUsersInfo result = apiInstance.getAdmin(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiCommunityControllerApi#getAdmin");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiCommunityControllerApi;

public class ApiCommunityControllerApiExample {
    public static void main(String[] args) {
        ApiCommunityControllerApi apiInstance = new ApiCommunityControllerApi();
        Long id = 789; // Long | 

        try {
            Community_CommunityUsersInfo result = apiInstance.getAdmin(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiCommunityControllerApi#getAdmin");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiCommunityControllerApi *apiInstance = [[ApiCommunityControllerApi alloc] init];
Long *id = 789; //  (default to null)

// Get admin of a community
[apiInstance getAdminWith:id
              completionHandler: ^(Community_CommunityUsersInfo output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiCommunityControllerApi()
var id = 789; // {Long} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAdmin(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getAdminExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiCommunityControllerApi();
            var id = 789;  // Long |  (default to null)

            try {
                // Get admin of a community
                Community_CommunityUsersInfo result = apiInstance.getAdmin(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiCommunityControllerApi.getAdmin: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiCommunityControllerApi();
$id = 789; // Long | 

try {
    $result = $api_instance->getAdmin($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiCommunityControllerApi->getAdmin: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiCommunityControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiCommunityControllerApi->new();
my $id = 789; # Long | 

eval {
    my $result = $api_instance->getAdmin(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiCommunityControllerApi->getAdmin: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiCommunityControllerApi()
id = 789 # Long |  (default to null)

try:
    # Get admin of a community
    api_response = api_instance.get_admin(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiCommunityControllerApi->getAdmin: %s\n" % e)
extern crate ApiCommunityControllerApi;

pub fn main() {
    let id = 789; // Long

    let mut context = ApiCommunityControllerApi::Context::default();
    let result = client.getAdmin(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
Required

Responses


getBanInfo

Get ban info of a user in a community


/api/v1/bans/{id}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://localhost:8443/api/v1/bans/{id}?banInfo=banInfo_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiCommunityControllerApi;

import java.io.File;
import java.util.*;

public class ApiCommunityControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiCommunityControllerApi apiInstance = new ApiCommunityControllerApi();
        Long id = 789; // Long | 
        String banInfo = banInfo_example; // String | 

        try {
            Community_CommunityBanInfo result = apiInstance.getBanInfo(id, banInfo);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiCommunityControllerApi#getBanInfo");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiCommunityControllerApi;

public class ApiCommunityControllerApiExample {
    public static void main(String[] args) {
        ApiCommunityControllerApi apiInstance = new ApiCommunityControllerApi();
        Long id = 789; // Long | 
        String banInfo = banInfo_example; // String | 

        try {
            Community_CommunityBanInfo result = apiInstance.getBanInfo(id, banInfo);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiCommunityControllerApi#getBanInfo");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiCommunityControllerApi *apiInstance = [[ApiCommunityControllerApi alloc] init];
Long *id = 789; //  (default to null)
String *banInfo = banInfo_example; //  (optional) (default to null)

// Get ban info of a user in a community
[apiInstance getBanInfoWith:id
    banInfo:banInfo
              completionHandler: ^(Community_CommunityBanInfo output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiCommunityControllerApi()
var id = 789; // {Long} 
var opts = {
  'banInfo': banInfo_example // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getBanInfo(id, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getBanInfoExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiCommunityControllerApi();
            var id = 789;  // Long |  (default to null)
            var banInfo = banInfo_example;  // String |  (optional)  (default to null)

            try {
                // Get ban info of a user in a community
                Community_CommunityBanInfo result = apiInstance.getBanInfo(id, banInfo);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiCommunityControllerApi.getBanInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiCommunityControllerApi();
$id = 789; // Long | 
$banInfo = banInfo_example; // String | 

try {
    $result = $api_instance->getBanInfo($id, $banInfo);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiCommunityControllerApi->getBanInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiCommunityControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiCommunityControllerApi->new();
my $id = 789; # Long | 
my $banInfo = banInfo_example; # String | 

eval {
    my $result = $api_instance->getBanInfo(id => $id, banInfo => $banInfo);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiCommunityControllerApi->getBanInfo: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiCommunityControllerApi()
id = 789 # Long |  (default to null)
banInfo = banInfo_example # String |  (optional) (default to null)

try:
    # Get ban info of a user in a community
    api_response = api_instance.get_ban_info(id, banInfo=banInfo)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiCommunityControllerApi->getBanInfo: %s\n" % e)
extern crate ApiCommunityControllerApi;

pub fn main() {
    let id = 789; // Long
    let banInfo = banInfo_example; // String

    let mut context = ApiCommunityControllerApi::Context::default();
    let result = client.getBanInfo(id, banInfo, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
Required
Query parameters
Name Description
banInfo
String

Responses


getBannedUsers

Get all banned users in a community


/api/v1/bans/communities/{id}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://localhost:8443/api/v1/bans/communities/{id}?page=56&size=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiCommunityControllerApi;

import java.io.File;
import java.util.*;

public class ApiCommunityControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiCommunityControllerApi apiInstance = new ApiCommunityControllerApi();
        Long id = 789; // Long | 
        Integer page = 56; // Integer | 
        Integer size = 56; // Integer | 

        try {
            Community_CommunityBanInfo result = apiInstance.getBannedUsers(id, page, size);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiCommunityControllerApi#getBannedUsers");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiCommunityControllerApi;

public class ApiCommunityControllerApiExample {
    public static void main(String[] args) {
        ApiCommunityControllerApi apiInstance = new ApiCommunityControllerApi();
        Long id = 789; // Long | 
        Integer page = 56; // Integer | 
        Integer size = 56; // Integer | 

        try {
            Community_CommunityBanInfo result = apiInstance.getBannedUsers(id, page, size);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiCommunityControllerApi#getBannedUsers");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiCommunityControllerApi *apiInstance = [[ApiCommunityControllerApi alloc] init];
Long *id = 789; //  (default to null)
Integer *page = 56; //  (optional) (default to 0)
Integer *size = 56; //  (optional) (default to 10)

// Get all banned users in a community
[apiInstance getBannedUsersWith:id
    page:page
    size:size
              completionHandler: ^(Community_CommunityBanInfo output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiCommunityControllerApi()
var id = 789; // {Long} 
var opts = {
  'page': 56, // {Integer} 
  'size': 56 // {Integer} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getBannedUsers(id, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getBannedUsersExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiCommunityControllerApi();
            var id = 789;  // Long |  (default to null)
            var page = 56;  // Integer |  (optional)  (default to 0)
            var size = 56;  // Integer |  (optional)  (default to 10)

            try {
                // Get all banned users in a community
                Community_CommunityBanInfo result = apiInstance.getBannedUsers(id, page, size);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiCommunityControllerApi.getBannedUsers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiCommunityControllerApi();
$id = 789; // Long | 
$page = 56; // Integer | 
$size = 56; // Integer | 

try {
    $result = $api_instance->getBannedUsers($id, $page, $size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiCommunityControllerApi->getBannedUsers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiCommunityControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiCommunityControllerApi->new();
my $id = 789; # Long | 
my $page = 56; # Integer | 
my $size = 56; # Integer | 

eval {
    my $result = $api_instance->getBannedUsers(id => $id, page => $page, size => $size);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiCommunityControllerApi->getBannedUsers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiCommunityControllerApi()
id = 789 # Long |  (default to null)
page = 56 # Integer |  (optional) (default to 0)
size = 56 # Integer |  (optional) (default to 10)

try:
    # Get all banned users in a community
    api_response = api_instance.get_banned_users(id, page=page, size=size)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiCommunityControllerApi->getBannedUsers: %s\n" % e)
extern crate ApiCommunityControllerApi;

pub fn main() {
    let id = 789; // Long
    let page = 56; // Integer
    let size = 56; // Integer

    let mut context = ApiCommunityControllerApi::Context::default();
    let result = client.getBannedUsers(id, page, size, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
Required
Query parameters
Name Description
page
Integer (int32)
size
Integer (int32)

Responses


getCommunitiesByName

Get communities by specified criteria and sort: Default: search by name and description. Sortings: creationDate, members, lastPostDate, alphabetical (default) General: get all communities (no query). Sortings: creationDate, lastPostDate, members, alphabetical (default) Admin: get communities by admin username. Sortings: NONE Name: search by name. Sortings: creationDate, lastPostDate, members, alphabetical (default) Description: search by description. Sortings: creationDate, lastPostDate, members, alphabetical (default)


/api/v1/communities

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://localhost:8443/api/v1/communities?query=query_example&page=56&size=56&sort=sort_example&by=by_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiCommunityControllerApi;

import java.io.File;
import java.util.*;

public class ApiCommunityControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiCommunityControllerApi apiInstance = new ApiCommunityControllerApi();
        Integer page = 56; // Integer | 
        Integer size = 56; // Integer | 
        String by = by_example; // String | 
        String query = query_example; // String | 
        String sort = sort_example; // String | 

        try {
            Community_CommunityBasicInfo result = apiInstance.getCommunitiesByName(page, size, by, query, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiCommunityControllerApi#getCommunitiesByName");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiCommunityControllerApi;

public class ApiCommunityControllerApiExample {
    public static void main(String[] args) {
        ApiCommunityControllerApi apiInstance = new ApiCommunityControllerApi();
        Integer page = 56; // Integer | 
        Integer size = 56; // Integer | 
        String by = by_example; // String | 
        String query = query_example; // String | 
        String sort = sort_example; // String | 

        try {
            Community_CommunityBasicInfo result = apiInstance.getCommunitiesByName(page, size, by, query, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiCommunityControllerApi#getCommunitiesByName");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiCommunityControllerApi *apiInstance = [[ApiCommunityControllerApi alloc] init];
Integer *page = 56; //  (default to null)
Integer *size = 56; //  (default to null)
String *by = by_example; //  (default to null)
String *query = query_example; //  (optional) (default to null)
String *sort = sort_example; //  (optional) (default to null)

// Get communities by specified criteria and sort:
Default: search by name and description. Sortings: creationDate, members, lastPostDate, alphabetical (default)
General: get all communities (no query). Sortings: creationDate, lastPostDate, members, alphabetical (default)
Admin: get communities by admin username. Sortings: NONE
Name: search by name. Sortings: creationDate, lastPostDate, members, alphabetical (default)
Description: search by description. Sortings: creationDate, lastPostDate, members, alphabetical (default)

[apiInstance getCommunitiesByNameWith:page
    size:size
    by:by
    query:query
    sort:sort
              completionHandler: ^(Community_CommunityBasicInfo output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiCommunityControllerApi()
var page = 56; // {Integer} 
var size = 56; // {Integer} 
var by = by_example; // {String} 
var opts = {
  'query': query_example, // {String} 
  'sort': sort_example // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCommunitiesByName(page, size, by, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getCommunitiesByNameExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiCommunityControllerApi();
            var page = 56;  // Integer |  (default to null)
            var size = 56;  // Integer |  (default to null)
            var by = by_example;  // String |  (default to null)
            var query = query_example;  // String |  (optional)  (default to null)
            var sort = sort_example;  // String |  (optional)  (default to null)

            try {
                // Get communities by specified criteria and sort:
Default: search by name and description. Sortings: creationDate, members, lastPostDate, alphabetical (default)
General: get all communities (no query). Sortings: creationDate, lastPostDate, members, alphabetical (default)
Admin: get communities by admin username. Sortings: NONE
Name: search by name. Sortings: creationDate, lastPostDate, members, alphabetical (default)
Description: search by description. Sortings: creationDate, lastPostDate, members, alphabetical (default)

                Community_CommunityBasicInfo result = apiInstance.getCommunitiesByName(page, size, by, query, sort);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiCommunityControllerApi.getCommunitiesByName: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiCommunityControllerApi();
$page = 56; // Integer | 
$size = 56; // Integer | 
$by = by_example; // String | 
$query = query_example; // String | 
$sort = sort_example; // String | 

try {
    $result = $api_instance->getCommunitiesByName($page, $size, $by, $query, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiCommunityControllerApi->getCommunitiesByName: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiCommunityControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiCommunityControllerApi->new();
my $page = 56; # Integer | 
my $size = 56; # Integer | 
my $by = by_example; # String | 
my $query = query_example; # String | 
my $sort = sort_example; # String | 

eval {
    my $result = $api_instance->getCommunitiesByName(page => $page, size => $size, by => $by, query => $query, sort => $sort);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiCommunityControllerApi->getCommunitiesByName: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiCommunityControllerApi()
page = 56 # Integer |  (default to null)
size = 56 # Integer |  (default to null)
by = by_example # String |  (default to null)
query = query_example # String |  (optional) (default to null)
sort = sort_example # String |  (optional) (default to null)

try:
    # Get communities by specified criteria and sort:
Default: search by name and description. Sortings: creationDate, members, lastPostDate, alphabetical (default)
General: get all communities (no query). Sortings: creationDate, lastPostDate, members, alphabetical (default)
Admin: get communities by admin username. Sortings: NONE
Name: search by name. Sortings: creationDate, lastPostDate, members, alphabetical (default)
Description: search by description. Sortings: creationDate, lastPostDate, members, alphabetical (default)

    api_response = api_instance.get_communities_by_name(page, size, by, query=query, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiCommunityControllerApi->getCommunitiesByName: %s\n" % e)
extern crate ApiCommunityControllerApi;

pub fn main() {
    let page = 56; // Integer
    let size = 56; // Integer
    let by = by_example; // String
    let query = query_example; // String
    let sort = sort_example; // String

    let mut context = ApiCommunityControllerApi::Context::default();
    let result = client.getCommunitiesByName(page, size, by, query, sort, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
query
String
page*
Integer (int32)
Required
size*
Integer (int32)
Required
sort
String
by*
String
Required

Responses


getCommunityBanner

Get the banner of a community


/api/v1/communities/{id}/pictures

Usage and SDK Samples

curl -X GET \
 -H "Accept: image/jpeg" \
 "https://localhost:8443/api/v1/communities/{id}/pictures"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiCommunityControllerApi;

import java.io.File;
import java.util.*;

public class ApiCommunityControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiCommunityControllerApi apiInstance = new ApiCommunityControllerApi();
        Long id = 789; // Long | 

        try {
            Community result = apiInstance.getCommunityBanner(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiCommunityControllerApi#getCommunityBanner");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiCommunityControllerApi;

public class ApiCommunityControllerApiExample {
    public static void main(String[] args) {
        ApiCommunityControllerApi apiInstance = new ApiCommunityControllerApi();
        Long id = 789; // Long | 

        try {
            Community result = apiInstance.getCommunityBanner(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiCommunityControllerApi#getCommunityBanner");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiCommunityControllerApi *apiInstance = [[ApiCommunityControllerApi alloc] init];
Long *id = 789; //  (default to null)

// Get the banner of a community
[apiInstance getCommunityBannerWith:id
              completionHandler: ^(Community output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiCommunityControllerApi()
var id = 789; // {Long} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCommunityBanner(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getCommunityBannerExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiCommunityControllerApi();
            var id = 789;  // Long |  (default to null)

            try {
                // Get the banner of a community
                Community result = apiInstance.getCommunityBanner(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiCommunityControllerApi.getCommunityBanner: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiCommunityControllerApi();
$id = 789; // Long | 

try {
    $result = $api_instance->getCommunityBanner($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiCommunityControllerApi->getCommunityBanner: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiCommunityControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiCommunityControllerApi->new();
my $id = 789; # Long | 

eval {
    my $result = $api_instance->getCommunityBanner(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiCommunityControllerApi->getCommunityBanner: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiCommunityControllerApi()
id = 789 # Long |  (default to null)

try:
    # Get the banner of a community
    api_response = api_instance.get_community_banner(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiCommunityControllerApi->getCommunityBanner: %s\n" % e)
extern crate ApiCommunityControllerApi;

pub fn main() {
    let id = 789; // Long

    let mut context = ApiCommunityControllerApi::Context::default();
    let result = client.getCommunityBanner(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
Required

Responses


getCommunityById

Get a community by ID


/api/v1/communities/{id}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://localhost:8443/api/v1/communities/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiCommunityControllerApi;

import java.io.File;
import java.util.*;

public class ApiCommunityControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiCommunityControllerApi apiInstance = new ApiCommunityControllerApi();
        Long id = 789; // Long | 

        try {
            Community_CommunityBasicInfo result = apiInstance.getCommunityById(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiCommunityControllerApi#getCommunityById");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiCommunityControllerApi;

public class ApiCommunityControllerApiExample {
    public static void main(String[] args) {
        ApiCommunityControllerApi apiInstance = new ApiCommunityControllerApi();
        Long id = 789; // Long | 

        try {
            Community_CommunityBasicInfo result = apiInstance.getCommunityById(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiCommunityControllerApi#getCommunityById");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiCommunityControllerApi *apiInstance = [[ApiCommunityControllerApi alloc] init];
Long *id = 789; //  (default to null)

// Get a community by ID
[apiInstance getCommunityByIdWith:id
              completionHandler: ^(Community_CommunityBasicInfo output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiCommunityControllerApi()
var id = 789; // {Long} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCommunityById(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getCommunityByIdExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiCommunityControllerApi();
            var id = 789;  // Long |  (default to null)

            try {
                // Get a community by ID
                Community_CommunityBasicInfo result = apiInstance.getCommunityById(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiCommunityControllerApi.getCommunityById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiCommunityControllerApi();
$id = 789; // Long | 

try {
    $result = $api_instance->getCommunityById($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiCommunityControllerApi->getCommunityById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiCommunityControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiCommunityControllerApi->new();
my $id = 789; # Long | 

eval {
    my $result = $api_instance->getCommunityById(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiCommunityControllerApi->getCommunityById: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiCommunityControllerApi()
id = 789 # Long |  (default to null)

try:
    # Get a community by ID
    api_response = api_instance.get_community_by_id(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiCommunityControllerApi->getCommunityById: %s\n" % e)
extern crate ApiCommunityControllerApi;

pub fn main() {
    let id = 789; // Long

    let mut context = ApiCommunityControllerApi::Context::default();
    let result = client.getCommunityById(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
Required

Responses


getMembers

Get members of a community (pageable)


/api/v1/communities/{id}/users

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://localhost:8443/api/v1/communities/{id}/users?page=56&size=56&query=query_example&count=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiCommunityControllerApi;

import java.io.File;
import java.util.*;

public class ApiCommunityControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiCommunityControllerApi apiInstance = new ApiCommunityControllerApi();
        Long id = 789; // Long | 
        Integer page = 56; // Integer | 
        Integer size = 56; // Integer | 
        String query = query_example; // String | 
        Boolean count = true; // Boolean | 

        try {
            Community_CommunityUsersInfo result = apiInstance.getMembers(id, page, size, query, count);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiCommunityControllerApi#getMembers");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiCommunityControllerApi;

public class ApiCommunityControllerApiExample {
    public static void main(String[] args) {
        ApiCommunityControllerApi apiInstance = new ApiCommunityControllerApi();
        Long id = 789; // Long | 
        Integer page = 56; // Integer | 
        Integer size = 56; // Integer | 
        String query = query_example; // String | 
        Boolean count = true; // Boolean | 

        try {
            Community_CommunityUsersInfo result = apiInstance.getMembers(id, page, size, query, count);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiCommunityControllerApi#getMembers");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiCommunityControllerApi *apiInstance = [[ApiCommunityControllerApi alloc] init];
Long *id = 789; //  (default to null)
Integer *page = 56; //  (optional) (default to 0)
Integer *size = 56; //  (optional) (default to 10)
String *query = query_example; //  (optional) (default to null)
Boolean *count = true; //  (optional) (default to false)

// Get members of a community (pageable)
[apiInstance getMembersWith:id
    page:page
    size:size
    query:query
    count:count
              completionHandler: ^(Community_CommunityUsersInfo output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiCommunityControllerApi()
var id = 789; // {Long} 
var opts = {
  'page': 56, // {Integer} 
  'size': 56, // {Integer} 
  'query': query_example, // {String} 
  'count': true // {Boolean} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMembers(id, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getMembersExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiCommunityControllerApi();
            var id = 789;  // Long |  (default to null)
            var page = 56;  // Integer |  (optional)  (default to 0)
            var size = 56;  // Integer |  (optional)  (default to 10)
            var query = query_example;  // String |  (optional)  (default to null)
            var count = true;  // Boolean |  (optional)  (default to false)

            try {
                // Get members of a community (pageable)
                Community_CommunityUsersInfo result = apiInstance.getMembers(id, page, size, query, count);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiCommunityControllerApi.getMembers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiCommunityControllerApi();
$id = 789; // Long | 
$page = 56; // Integer | 
$size = 56; // Integer | 
$query = query_example; // String | 
$count = true; // Boolean | 

try {
    $result = $api_instance->getMembers($id, $page, $size, $query, $count);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiCommunityControllerApi->getMembers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiCommunityControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiCommunityControllerApi->new();
my $id = 789; # Long | 
my $page = 56; # Integer | 
my $size = 56; # Integer | 
my $query = query_example; # String | 
my $count = true; # Boolean | 

eval {
    my $result = $api_instance->getMembers(id => $id, page => $page, size => $size, query => $query, count => $count);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiCommunityControllerApi->getMembers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiCommunityControllerApi()
id = 789 # Long |  (default to null)
page = 56 # Integer |  (optional) (default to 0)
size = 56 # Integer |  (optional) (default to 10)
query = query_example # String |  (optional) (default to null)
count = true # Boolean |  (optional) (default to false)

try:
    # Get members of a community (pageable)
    api_response = api_instance.get_members(id, page=page, size=size, query=query, count=count)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiCommunityControllerApi->getMembers: %s\n" % e)
extern crate ApiCommunityControllerApi;

pub fn main() {
    let id = 789; // Long
    let page = 56; // Integer
    let size = 56; // Integer
    let query = query_example; // String
    let count = true; // Boolean

    let mut context = ApiCommunityControllerApi::Context::default();
    let result = client.getMembers(id, page, size, query, count, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
Required
Query parameters
Name Description
page
Integer (int32)
size
Integer (int32)
query
String
count
Boolean

Responses


getModerators

Get moderators of a community (pageable)


/api/v1/communities/{id}/moderators

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://localhost:8443/api/v1/communities/{id}/moderators?page=56&size=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiCommunityControllerApi;

import java.io.File;
import java.util.*;

public class ApiCommunityControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiCommunityControllerApi apiInstance = new ApiCommunityControllerApi();
        Long id = 789; // Long | 
        Integer page = 56; // Integer | 
        Integer size = 56; // Integer | 

        try {
            Community_CommunityUsersInfo result = apiInstance.getModerators(id, page, size);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiCommunityControllerApi#getModerators");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiCommunityControllerApi;

public class ApiCommunityControllerApiExample {
    public static void main(String[] args) {
        ApiCommunityControllerApi apiInstance = new ApiCommunityControllerApi();
        Long id = 789; // Long | 
        Integer page = 56; // Integer | 
        Integer size = 56; // Integer | 

        try {
            Community_CommunityUsersInfo result = apiInstance.getModerators(id, page, size);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiCommunityControllerApi#getModerators");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiCommunityControllerApi *apiInstance = [[ApiCommunityControllerApi alloc] init];
Long *id = 789; //  (default to null)
Integer *page = 56; //  (default to null)
Integer *size = 56; //  (default to null)

// Get moderators of a community (pageable)
[apiInstance getModeratorsWith:id
    page:page
    size:size
              completionHandler: ^(Community_CommunityUsersInfo output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiCommunityControllerApi()
var id = 789; // {Long} 
var page = 56; // {Integer} 
var size = 56; // {Integer} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getModerators(id, page, size, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getModeratorsExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiCommunityControllerApi();
            var id = 789;  // Long |  (default to null)
            var page = 56;  // Integer |  (default to null)
            var size = 56;  // Integer |  (default to null)

            try {
                // Get moderators of a community (pageable)
                Community_CommunityUsersInfo result = apiInstance.getModerators(id, page, size);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiCommunityControllerApi.getModerators: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiCommunityControllerApi();
$id = 789; // Long | 
$page = 56; // Integer | 
$size = 56; // Integer | 

try {
    $result = $api_instance->getModerators($id, $page, $size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiCommunityControllerApi->getModerators: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiCommunityControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiCommunityControllerApi->new();
my $id = 789; # Long | 
my $page = 56; # Integer | 
my $size = 56; # Integer | 

eval {
    my $result = $api_instance->getModerators(id => $id, page => $page, size => $size);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiCommunityControllerApi->getModerators: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiCommunityControllerApi()
id = 789 # Long |  (default to null)
page = 56 # Integer |  (default to null)
size = 56 # Integer |  (default to null)

try:
    # Get moderators of a community (pageable)
    api_response = api_instance.get_moderators(id, page, size)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiCommunityControllerApi->getModerators: %s\n" % e)
extern crate ApiCommunityControllerApi;

pub fn main() {
    let id = 789; // Long
    let page = 56; // Integer
    let size = 56; // Integer

    let mut context = ApiCommunityControllerApi::Context::default();
    let result = client.getModerators(id, page, size, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
Required
Query parameters
Name Description
page*
Integer (int32)
Required
size*
Integer (int32)
Required

Responses


getMostPopularCommunities

Get a list of community names and their respective member count


/api/v1/communities/most-popular

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://localhost:8443/api/v1/communities/most-popular?size=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiCommunityControllerApi;

import java.io.File;
import java.util.*;

public class ApiCommunityControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiCommunityControllerApi apiInstance = new ApiCommunityControllerApi();
        Integer size = 56; // Integer | 

        try {
            Community_CommunityBasicInfo result = apiInstance.getMostPopularCommunities(size);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiCommunityControllerApi#getMostPopularCommunities");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiCommunityControllerApi;

public class ApiCommunityControllerApiExample {
    public static void main(String[] args) {
        ApiCommunityControllerApi apiInstance = new ApiCommunityControllerApi();
        Integer size = 56; // Integer | 

        try {
            Community_CommunityBasicInfo result = apiInstance.getMostPopularCommunities(size);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiCommunityControllerApi#getMostPopularCommunities");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiCommunityControllerApi *apiInstance = [[ApiCommunityControllerApi alloc] init];
Integer *size = 56; //  (optional) (default to 10)

// Get a list of community names and their respective member count
[apiInstance getMostPopularCommunitiesWith:size
              completionHandler: ^(Community_CommunityBasicInfo output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiCommunityControllerApi()
var opts = {
  'size': 56 // {Integer} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMostPopularCommunities(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getMostPopularCommunitiesExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiCommunityControllerApi();
            var size = 56;  // Integer |  (optional)  (default to 10)

            try {
                // Get a list of community names and their respective member count
                Community_CommunityBasicInfo result = apiInstance.getMostPopularCommunities(size);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiCommunityControllerApi.getMostPopularCommunities: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiCommunityControllerApi();
$size = 56; // Integer | 

try {
    $result = $api_instance->getMostPopularCommunities($size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiCommunityControllerApi->getMostPopularCommunities: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiCommunityControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiCommunityControllerApi->new();
my $size = 56; # Integer | 

eval {
    my $result = $api_instance->getMostPopularCommunities(size => $size);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiCommunityControllerApi->getMostPopularCommunities: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiCommunityControllerApi()
size = 56 # Integer |  (optional) (default to 10)

try:
    # Get a list of community names and their respective member count
    api_response = api_instance.get_most_popular_communities(size=size)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiCommunityControllerApi->getMostPopularCommunities: %s\n" % e)
extern crate ApiCommunityControllerApi;

pub fn main() {
    let size = 56; // Integer

    let mut context = ApiCommunityControllerApi::Context::default();
    let result = client.getMostPopularCommunities(size, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
size
Integer (int32)

Responses


isUserBanned

Check if a user is banned from a community


/api/v1/bans/users/{username}/communities/{id}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://localhost:8443/api/v1/bans/users/{username}/communities/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiCommunityControllerApi;

import java.io.File;
import java.util.*;

public class ApiCommunityControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiCommunityControllerApi apiInstance = new ApiCommunityControllerApi();
        String username = username_example; // String | 
        Long id = 789; // Long | 

        try {
            Community_CommunityBanInfo result = apiInstance.isUserBanned(username, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiCommunityControllerApi#isUserBanned");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiCommunityControllerApi;

public class ApiCommunityControllerApiExample {
    public static void main(String[] args) {
        ApiCommunityControllerApi apiInstance = new ApiCommunityControllerApi();
        String username = username_example; // String | 
        Long id = 789; // Long | 

        try {
            Community_CommunityBanInfo result = apiInstance.isUserBanned(username, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiCommunityControllerApi#isUserBanned");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiCommunityControllerApi *apiInstance = [[ApiCommunityControllerApi alloc] init];
String *username = username_example; //  (default to null)
Long *id = 789; //  (default to null)

// Check if a user is banned from a community
[apiInstance isUserBannedWith:username
    id:id
              completionHandler: ^(Community_CommunityBanInfo output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiCommunityControllerApi()
var username = username_example; // {String} 
var id = 789; // {Long} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.isUserBanned(username, id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class isUserBannedExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiCommunityControllerApi();
            var username = username_example;  // String |  (default to null)
            var id = 789;  // Long |  (default to null)

            try {
                // Check if a user is banned from a community
                Community_CommunityBanInfo result = apiInstance.isUserBanned(username, id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiCommunityControllerApi.isUserBanned: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiCommunityControllerApi();
$username = username_example; // String | 
$id = 789; // Long | 

try {
    $result = $api_instance->isUserBanned($username, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiCommunityControllerApi->isUserBanned: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiCommunityControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiCommunityControllerApi->new();
my $username = username_example; # String | 
my $id = 789; # Long | 

eval {
    my $result = $api_instance->isUserBanned(username => $username, id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiCommunityControllerApi->isUserBanned: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiCommunityControllerApi()
username = username_example # String |  (default to null)
id = 789 # Long |  (default to null)

try:
    # Check if a user is banned from a community
    api_response = api_instance.is_user_banned(username, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiCommunityControllerApi->isUserBanned: %s\n" % e)
extern crate ApiCommunityControllerApi;

pub fn main() {
    let username = username_example; // String
    let id = 789; // Long

    let mut context = ApiCommunityControllerApi::Context::default();
    let result = client.isUserBanned(username, id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
username*
String
Required
id*
Long (int64)
Required

Responses


isUserMember

Check if a user is a member of a community


/api/v1/communities/{id}/users/{username}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://localhost:8443/api/v1/communities/{id}/users/{username}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiCommunityControllerApi;

import java.io.File;
import java.util.*;

public class ApiCommunityControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiCommunityControllerApi apiInstance = new ApiCommunityControllerApi();
        Long id = 789; // Long | 
        String username = username_example; // String | 

        try {
            Community result = apiInstance.isUserMember(id, username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiCommunityControllerApi#isUserMember");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiCommunityControllerApi;

public class ApiCommunityControllerApiExample {
    public static void main(String[] args) {
        ApiCommunityControllerApi apiInstance = new ApiCommunityControllerApi();
        Long id = 789; // Long | 
        String username = username_example; // String | 

        try {
            Community result = apiInstance.isUserMember(id, username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiCommunityControllerApi#isUserMember");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiCommunityControllerApi *apiInstance = [[ApiCommunityControllerApi alloc] init];
Long *id = 789; //  (default to null)
String *username = username_example; //  (default to null)

// Check if a user is a member of a community
[apiInstance isUserMemberWith:id
    username:username
              completionHandler: ^(Community output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiCommunityControllerApi()
var id = 789; // {Long} 
var username = username_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.isUserMember(id, username, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class isUserMemberExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiCommunityControllerApi();
            var id = 789;  // Long |  (default to null)
            var username = username_example;  // String |  (default to null)

            try {
                // Check if a user is a member of a community
                Community result = apiInstance.isUserMember(id, username);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiCommunityControllerApi.isUserMember: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiCommunityControllerApi();
$id = 789; // Long | 
$username = username_example; // String | 

try {
    $result = $api_instance->isUserMember($id, $username);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiCommunityControllerApi->isUserMember: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiCommunityControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiCommunityControllerApi->new();
my $id = 789; # Long | 
my $username = username_example; # String | 

eval {
    my $result = $api_instance->isUserMember(id => $id, username => $username);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiCommunityControllerApi->isUserMember: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiCommunityControllerApi()
id = 789 # Long |  (default to null)
username = username_example # String |  (default to null)

try:
    # Check if a user is a member of a community
    api_response = api_instance.is_user_member(id, username)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiCommunityControllerApi->isUserMember: %s\n" % e)
extern crate ApiCommunityControllerApi;

pub fn main() {
    let id = 789; // Long
    let username = username_example; // String

    let mut context = ApiCommunityControllerApi::Context::default();
    let result = client.isUserMember(id, username, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
Required
username*
String
Required

Responses


isUserModeratorOfCommunity

Check if a user is a moderator of a community


/api/v1/communities/{id}/moderators/{username}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://localhost:8443/api/v1/communities/{id}/moderators/{username}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiCommunityControllerApi;

import java.io.File;
import java.util.*;

public class ApiCommunityControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiCommunityControllerApi apiInstance = new ApiCommunityControllerApi();
        Long id = 789; // Long | 
        String username = username_example; // String | 

        try {
            Community_CommunityUsersInfo result = apiInstance.isUserModeratorOfCommunity(id, username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiCommunityControllerApi#isUserModeratorOfCommunity");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiCommunityControllerApi;

public class ApiCommunityControllerApiExample {
    public static void main(String[] args) {
        ApiCommunityControllerApi apiInstance = new ApiCommunityControllerApi();
        Long id = 789; // Long | 
        String username = username_example; // String | 

        try {
            Community_CommunityUsersInfo result = apiInstance.isUserModeratorOfCommunity(id, username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiCommunityControllerApi#isUserModeratorOfCommunity");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiCommunityControllerApi *apiInstance = [[ApiCommunityControllerApi alloc] init];
Long *id = 789; //  (default to null)
String *username = username_example; //  (default to null)

// Check if a user is a moderator of a community
[apiInstance isUserModeratorOfCommunityWith:id
    username:username
              completionHandler: ^(Community_CommunityUsersInfo output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiCommunityControllerApi()
var id = 789; // {Long} 
var username = username_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.isUserModeratorOfCommunity(id, username, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class isUserModeratorOfCommunityExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiCommunityControllerApi();
            var id = 789;  // Long |  (default to null)
            var username = username_example;  // String |  (default to null)

            try {
                // Check if a user is a moderator of a community
                Community_CommunityUsersInfo result = apiInstance.isUserModeratorOfCommunity(id, username);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiCommunityControllerApi.isUserModeratorOfCommunity: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiCommunityControllerApi();
$id = 789; // Long | 
$username = username_example; // String | 

try {
    $result = $api_instance->isUserModeratorOfCommunity($id, $username);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiCommunityControllerApi->isUserModeratorOfCommunity: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiCommunityControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiCommunityControllerApi->new();
my $id = 789; # Long | 
my $username = username_example; # String | 

eval {
    my $result = $api_instance->isUserModeratorOfCommunity(id => $id, username => $username);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiCommunityControllerApi->isUserModeratorOfCommunity: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiCommunityControllerApi()
id = 789 # Long |  (default to null)
username = username_example # String |  (default to null)

try:
    # Check if a user is a moderator of a community
    api_response = api_instance.is_user_moderator_of_community(id, username)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiCommunityControllerApi->isUserModeratorOfCommunity: %s\n" % e)
extern crate ApiCommunityControllerApi;

pub fn main() {
    let id = 789; // Long
    let username = username_example; // String

    let mut context = ApiCommunityControllerApi::Context::default();
    let result = client.isUserModeratorOfCommunity(id, username, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
Required
username*
String
Required

Responses


manageCommunityUsers

Add, remove or ban a user from a community


/api/v1/communities/{id}/users/{username}

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 "https://localhost:8443/api/v1/communities/{id}/users/{username}?action=action_example&duration=duration_example&reason=reason_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiCommunityControllerApi;

import java.io.File;
import java.util.*;

public class ApiCommunityControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiCommunityControllerApi apiInstance = new ApiCommunityControllerApi();
        Long id = 789; // Long | 
        String username = username_example; // String | 
        String action = action_example; // String | 
        String duration = duration_example; // String | 
        String reason = reason_example; // String | 

        try {
            Community_CommunityUsersInfo result = apiInstance.manageCommunityUsers(id, username, action, duration, reason);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiCommunityControllerApi#manageCommunityUsers");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiCommunityControllerApi;

public class ApiCommunityControllerApiExample {
    public static void main(String[] args) {
        ApiCommunityControllerApi apiInstance = new ApiCommunityControllerApi();
        Long id = 789; // Long | 
        String username = username_example; // String | 
        String action = action_example; // String | 
        String duration = duration_example; // String | 
        String reason = reason_example; // String | 

        try {
            Community_CommunityUsersInfo result = apiInstance.manageCommunityUsers(id, username, action, duration, reason);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiCommunityControllerApi#manageCommunityUsers");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiCommunityControllerApi *apiInstance = [[ApiCommunityControllerApi alloc] init];
Long *id = 789; //  (default to null)
String *username = username_example; //  (default to null)
String *action = action_example; //  (default to null)
String *duration = duration_example; //  (optional) (default to null)
String *reason = reason_example; //  (optional) (default to null)

// Add, remove or ban a user from a community
[apiInstance manageCommunityUsersWith:id
    username:username
    action:action
    duration:duration
    reason:reason
              completionHandler: ^(Community_CommunityUsersInfo output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiCommunityControllerApi()
var id = 789; // {Long} 
var username = username_example; // {String} 
var action = action_example; // {String} 
var opts = {
  'duration': duration_example, // {String} 
  'reason': reason_example // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.manageCommunityUsers(id, username, action, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class manageCommunityUsersExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiCommunityControllerApi();
            var id = 789;  // Long |  (default to null)
            var username = username_example;  // String |  (default to null)
            var action = action_example;  // String |  (default to null)
            var duration = duration_example;  // String |  (optional)  (default to null)
            var reason = reason_example;  // String |  (optional)  (default to null)

            try {
                // Add, remove or ban a user from a community
                Community_CommunityUsersInfo result = apiInstance.manageCommunityUsers(id, username, action, duration, reason);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiCommunityControllerApi.manageCommunityUsers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiCommunityControllerApi();
$id = 789; // Long | 
$username = username_example; // String | 
$action = action_example; // String | 
$duration = duration_example; // String | 
$reason = reason_example; // String | 

try {
    $result = $api_instance->manageCommunityUsers($id, $username, $action, $duration, $reason);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiCommunityControllerApi->manageCommunityUsers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiCommunityControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiCommunityControllerApi->new();
my $id = 789; # Long | 
my $username = username_example; # String | 
my $action = action_example; # String | 
my $duration = duration_example; # String | 
my $reason = reason_example; # String | 

eval {
    my $result = $api_instance->manageCommunityUsers(id => $id, username => $username, action => $action, duration => $duration, reason => $reason);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiCommunityControllerApi->manageCommunityUsers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiCommunityControllerApi()
id = 789 # Long |  (default to null)
username = username_example # String |  (default to null)
action = action_example # String |  (default to null)
duration = duration_example # String |  (optional) (default to null)
reason = reason_example # String |  (optional) (default to null)

try:
    # Add, remove or ban a user from a community
    api_response = api_instance.manage_community_users(id, username, action, duration=duration, reason=reason)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiCommunityControllerApi->manageCommunityUsers: %s\n" % e)
extern crate ApiCommunityControllerApi;

pub fn main() {
    let id = 789; // Long
    let username = username_example; // String
    let action = action_example; // String
    let duration = duration_example; // String
    let reason = reason_example; // String

    let mut context = ApiCommunityControllerApi::Context::default();
    let result = client.manageCommunityUsers(id, username, action, duration, reason, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
Required
username*
String
Required
Query parameters
Name Description
action*
String
Required
duration
String
reason
String

Responses


manageModerators

Add or remove a moderator from a community


/api/v1/communities/{id}/moderators/{username}

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 "https://localhost:8443/api/v1/communities/{id}/moderators/{username}?action=action_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiCommunityControllerApi;

import java.io.File;
import java.util.*;

public class ApiCommunityControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiCommunityControllerApi apiInstance = new ApiCommunityControllerApi();
        Long id = 789; // Long | 
        String username = username_example; // String | 
        String action = action_example; // String | 

        try {
            Community_CommunityUsersInfo result = apiInstance.manageModerators(id, username, action);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiCommunityControllerApi#manageModerators");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiCommunityControllerApi;

public class ApiCommunityControllerApiExample {
    public static void main(String[] args) {
        ApiCommunityControllerApi apiInstance = new ApiCommunityControllerApi();
        Long id = 789; // Long | 
        String username = username_example; // String | 
        String action = action_example; // String | 

        try {
            Community_CommunityUsersInfo result = apiInstance.manageModerators(id, username, action);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiCommunityControllerApi#manageModerators");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiCommunityControllerApi *apiInstance = [[ApiCommunityControllerApi alloc] init];
Long *id = 789; //  (default to null)
String *username = username_example; //  (default to null)
String *action = action_example; //  (default to null)

// Add or remove a moderator from a community
[apiInstance manageModeratorsWith:id
    username:username
    action:action
              completionHandler: ^(Community_CommunityUsersInfo output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiCommunityControllerApi()
var id = 789; // {Long} 
var username = username_example; // {String} 
var action = action_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.manageModerators(id, username, action, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class manageModeratorsExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiCommunityControllerApi();
            var id = 789;  // Long |  (default to null)
            var username = username_example;  // String |  (default to null)
            var action = action_example;  // String |  (default to null)

            try {
                // Add or remove a moderator from a community
                Community_CommunityUsersInfo result = apiInstance.manageModerators(id, username, action);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiCommunityControllerApi.manageModerators: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiCommunityControllerApi();
$id = 789; // Long | 
$username = username_example; // String | 
$action = action_example; // String | 

try {
    $result = $api_instance->manageModerators($id, $username, $action);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiCommunityControllerApi->manageModerators: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiCommunityControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiCommunityControllerApi->new();
my $id = 789; # Long | 
my $username = username_example; # String | 
my $action = action_example; # String | 

eval {
    my $result = $api_instance->manageModerators(id => $id, username => $username, action => $action);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiCommunityControllerApi->manageModerators: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiCommunityControllerApi()
id = 789 # Long |  (default to null)
username = username_example # String |  (default to null)
action = action_example # String |  (default to null)

try:
    # Add or remove a moderator from a community
    api_response = api_instance.manage_moderators(id, username, action)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiCommunityControllerApi->manageModerators: %s\n" % e)
extern crate ApiCommunityControllerApi;

pub fn main() {
    let id = 789; // Long
    let username = username_example; // String
    let action = action_example; // String

    let mut context = ApiCommunityControllerApi::Context::default();
    let result = client.manageModerators(id, username, action, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
Required
username*
String
Required
Query parameters
Name Description
action*
String
Required

Responses


unbanUser

Unban a user from a community


/api/v1/bans/{id}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "https://localhost:8443/api/v1/bans/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiCommunityControllerApi;

import java.io.File;
import java.util.*;

public class ApiCommunityControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiCommunityControllerApi apiInstance = new ApiCommunityControllerApi();
        Long id = 789; // Long | 

        try {
            Community result = apiInstance.unbanUser(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiCommunityControllerApi#unbanUser");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiCommunityControllerApi;

public class ApiCommunityControllerApiExample {
    public static void main(String[] args) {
        ApiCommunityControllerApi apiInstance = new ApiCommunityControllerApi();
        Long id = 789; // Long | 

        try {
            Community result = apiInstance.unbanUser(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiCommunityControllerApi#unbanUser");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiCommunityControllerApi *apiInstance = [[ApiCommunityControllerApi alloc] init];
Long *id = 789; //  (default to null)

// Unban a user from a community
[apiInstance unbanUserWith:id
              completionHandler: ^(Community output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiCommunityControllerApi()
var id = 789; // {Long} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.unbanUser(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class unbanUserExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiCommunityControllerApi();
            var id = 789;  // Long |  (default to null)

            try {
                // Unban a user from a community
                Community result = apiInstance.unbanUser(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiCommunityControllerApi.unbanUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiCommunityControllerApi();
$id = 789; // Long | 

try {
    $result = $api_instance->unbanUser($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiCommunityControllerApi->unbanUser: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiCommunityControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiCommunityControllerApi->new();
my $id = 789; # Long | 

eval {
    my $result = $api_instance->unbanUser(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiCommunityControllerApi->unbanUser: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiCommunityControllerApi()
id = 789 # Long |  (default to null)

try:
    # Unban a user from a community
    api_response = api_instance.unban_user(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiCommunityControllerApi->unbanUser: %s\n" % e)
extern crate ApiCommunityControllerApi;

pub fn main() {
    let id = 789; // Long

    let mut context = ApiCommunityControllerApi::Context::default();
    let result = client.unbanUser(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
Required

Responses


updateCommunity

Update a community


/api/v1/communities/{id}

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://localhost:8443/api/v1/communities/{id}" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiCommunityControllerApi;

import java.io.File;
import java.util.*;

public class ApiCommunityControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiCommunityControllerApi apiInstance = new ApiCommunityControllerApi();
        Long id = 789; // Long | 
        map[String, String] requestBody = ; // map[String, String] | 

        try {
            Community_CommunityBasicInfo result = apiInstance.updateCommunity(id, requestBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiCommunityControllerApi#updateCommunity");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiCommunityControllerApi;

public class ApiCommunityControllerApiExample {
    public static void main(String[] args) {
        ApiCommunityControllerApi apiInstance = new ApiCommunityControllerApi();
        Long id = 789; // Long | 
        map[String, String] requestBody = ; // map[String, String] | 

        try {
            Community_CommunityBasicInfo result = apiInstance.updateCommunity(id, requestBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiCommunityControllerApi#updateCommunity");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiCommunityControllerApi *apiInstance = [[ApiCommunityControllerApi alloc] init];
Long *id = 789; //  (default to null)
map[String, String] *requestBody = ; // 

// Update a community
[apiInstance updateCommunityWith:id
    requestBody:requestBody
              completionHandler: ^(Community_CommunityBasicInfo output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiCommunityControllerApi()
var id = 789; // {Long} 
var requestBody = ; // {map[String, String]} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateCommunity(id, requestBody, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class updateCommunityExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiCommunityControllerApi();
            var id = 789;  // Long |  (default to null)
            var requestBody = new map[String, String](); // map[String, String] | 

            try {
                // Update a community
                Community_CommunityBasicInfo result = apiInstance.updateCommunity(id, requestBody);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiCommunityControllerApi.updateCommunity: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiCommunityControllerApi();
$id = 789; // Long | 
$requestBody = ; // map[String, String] | 

try {
    $result = $api_instance->updateCommunity($id, $requestBody);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiCommunityControllerApi->updateCommunity: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiCommunityControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiCommunityControllerApi->new();
my $id = 789; # Long | 
my $requestBody = WWW::OPenAPIClient::Object::map[String, String]->new(); # map[String, String] | 

eval {
    my $result = $api_instance->updateCommunity(id => $id, requestBody => $requestBody);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiCommunityControllerApi->updateCommunity: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiCommunityControllerApi()
id = 789 # Long |  (default to null)
requestBody =  # map[String, String] | 

try:
    # Update a community
    api_response = api_instance.update_community(id, requestBody)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiCommunityControllerApi->updateCommunity: %s\n" % e)
extern crate ApiCommunityControllerApi;

pub fn main() {
    let id = 789; // Long
    let requestBody = ; // map[String, String]

    let mut context = ApiCommunityControllerApi::Context::default();
    let result = client.updateCommunity(id, requestBody, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
Required
Body parameters
Name Description
requestBody *

Responses


uploadCommunityBanner

Upload a banner to a community


/api/v1/communities/{id}/pictures

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://localhost:8443/api/v1/communities/{id}/pictures?action=action_example" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiCommunityControllerApi;

import java.io.File;
import java.util.*;

public class ApiCommunityControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiCommunityControllerApi apiInstance = new ApiCommunityControllerApi();
        Long id = 789; // Long | 
        String action = action_example; // String | 
        InlineObject2 inlineObject2 = ; // InlineObject2 | 

        try {
            Community_CommunityBasicInfo result = apiInstance.uploadCommunityBanner(id, action, inlineObject2);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiCommunityControllerApi#uploadCommunityBanner");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiCommunityControllerApi;

public class ApiCommunityControllerApiExample {
    public static void main(String[] args) {
        ApiCommunityControllerApi apiInstance = new ApiCommunityControllerApi();
        Long id = 789; // Long | 
        String action = action_example; // String | 
        InlineObject2 inlineObject2 = ; // InlineObject2 | 

        try {
            Community_CommunityBasicInfo result = apiInstance.uploadCommunityBanner(id, action, inlineObject2);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiCommunityControllerApi#uploadCommunityBanner");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiCommunityControllerApi *apiInstance = [[ApiCommunityControllerApi alloc] init];
Long *id = 789; //  (default to null)
String *action = action_example; //  (optional) (default to null)
InlineObject2 *inlineObject2 = ; //  (optional)

// Upload a banner to a community
[apiInstance uploadCommunityBannerWith:id
    action:action
    inlineObject2:inlineObject2
              completionHandler: ^(Community_CommunityBasicInfo output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiCommunityControllerApi()
var id = 789; // {Long} 
var opts = {
  'action': action_example, // {String} 
  'inlineObject2':  // {InlineObject2} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.uploadCommunityBanner(id, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class uploadCommunityBannerExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiCommunityControllerApi();
            var id = 789;  // Long |  (default to null)
            var action = action_example;  // String |  (optional)  (default to null)
            var inlineObject2 = new InlineObject2(); // InlineObject2 |  (optional) 

            try {
                // Upload a banner to a community
                Community_CommunityBasicInfo result = apiInstance.uploadCommunityBanner(id, action, inlineObject2);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiCommunityControllerApi.uploadCommunityBanner: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiCommunityControllerApi();
$id = 789; // Long | 
$action = action_example; // String | 
$inlineObject2 = ; // InlineObject2 | 

try {
    $result = $api_instance->uploadCommunityBanner($id, $action, $inlineObject2);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiCommunityControllerApi->uploadCommunityBanner: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiCommunityControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiCommunityControllerApi->new();
my $id = 789; # Long | 
my $action = action_example; # String | 
my $inlineObject2 = WWW::OPenAPIClient::Object::InlineObject2->new(); # InlineObject2 | 

eval {
    my $result = $api_instance->uploadCommunityBanner(id => $id, action => $action, inlineObject2 => $inlineObject2);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiCommunityControllerApi->uploadCommunityBanner: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiCommunityControllerApi()
id = 789 # Long |  (default to null)
action = action_example # String |  (optional) (default to null)
inlineObject2 =  # InlineObject2 |  (optional)

try:
    # Upload a banner to a community
    api_response = api_instance.upload_community_banner(id, action=action, inlineObject2=inlineObject2)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiCommunityControllerApi->uploadCommunityBanner: %s\n" % e)
extern crate ApiCommunityControllerApi;

pub fn main() {
    let id = 789; // Long
    let action = action_example; // String
    let inlineObject2 = ; // InlineObject2

    let mut context = ApiCommunityControllerApi::Context::default();
    let result = client.uploadCommunityBanner(id, action, inlineObject2, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
Long (int64)
Required
Body parameters
Name Description
inlineObject2

Query parameters
Name Description
action
String

Responses


ApiPostController

createPost

Create a post


/api/v1/communities/{communityID}/posts

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://localhost:8443/api/v1/communities/{communityID}/posts" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiPostControllerApi;

import java.io.File;
import java.util.*;

public class ApiPostControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiPostControllerApi apiInstance = new ApiPostControllerApi();
        Long communityID = 789; // Long | 
        PostDTOPostInfo postDTOPostInfo = ; // PostDTOPostInfo | 

        try {
            Post_PostInfo result = apiInstance.createPost(communityID, postDTOPostInfo);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiPostControllerApi#createPost");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiPostControllerApi;

public class ApiPostControllerApiExample {
    public static void main(String[] args) {
        ApiPostControllerApi apiInstance = new ApiPostControllerApi();
        Long communityID = 789; // Long | 
        PostDTOPostInfo postDTOPostInfo = ; // PostDTOPostInfo | 

        try {
            Post_PostInfo result = apiInstance.createPost(communityID, postDTOPostInfo);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiPostControllerApi#createPost");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiPostControllerApi *apiInstance = [[ApiPostControllerApi alloc] init];
Long *communityID = 789; //  (default to null)
PostDTOPostInfo *postDTOPostInfo = ; //  (optional)

// Create a post
[apiInstance createPostWith:communityID
    postDTOPostInfo:postDTOPostInfo
              completionHandler: ^(Post_PostInfo output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiPostControllerApi()
var communityID = 789; // {Long} 
var opts = {
  'postDTOPostInfo':  // {PostDTOPostInfo} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createPost(communityID, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class createPostExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiPostControllerApi();
            var communityID = 789;  // Long |  (default to null)
            var postDTOPostInfo = new PostDTOPostInfo(); // PostDTOPostInfo |  (optional) 

            try {
                // Create a post
                Post_PostInfo result = apiInstance.createPost(communityID, postDTOPostInfo);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiPostControllerApi.createPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiPostControllerApi();
$communityID = 789; // Long | 
$postDTOPostInfo = ; // PostDTOPostInfo | 

try {
    $result = $api_instance->createPost($communityID, $postDTOPostInfo);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiPostControllerApi->createPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiPostControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiPostControllerApi->new();
my $communityID = 789; # Long | 
my $postDTOPostInfo = WWW::OPenAPIClient::Object::PostDTOPostInfo->new(); # PostDTOPostInfo | 

eval {
    my $result = $api_instance->createPost(communityID => $communityID, postDTOPostInfo => $postDTOPostInfo);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiPostControllerApi->createPost: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiPostControllerApi()
communityID = 789 # Long |  (default to null)
postDTOPostInfo =  # PostDTOPostInfo |  (optional)

try:
    # Create a post
    api_response = api_instance.create_post(communityID, postDTOPostInfo=postDTOPostInfo)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiPostControllerApi->createPost: %s\n" % e)
extern crate ApiPostControllerApi;

pub fn main() {
    let communityID = 789; // Long
    let postDTOPostInfo = ; // PostDTOPostInfo

    let mut context = ApiPostControllerApi::Context::default();
    let result = client.createPost(communityID, postDTOPostInfo, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
communityID*
Long (int64)
Required
Body parameters
Name Description
postDTOPostInfo

Responses


createReply

Create a reply


/api/v1/posts/{postId}/replies

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://localhost:8443/api/v1/posts/{postId}/replies" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiPostControllerApi;

import java.io.File;
import java.util.*;

public class ApiPostControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiPostControllerApi apiInstance = new ApiPostControllerApi();
        Long postId = 789; // Long | 
        map[String, String] requestBody = ; // map[String, String] | 

        try {
            Reply_ReplyInfo result = apiInstance.createReply(postId, requestBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiPostControllerApi#createReply");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiPostControllerApi;

public class ApiPostControllerApiExample {
    public static void main(String[] args) {
        ApiPostControllerApi apiInstance = new ApiPostControllerApi();
        Long postId = 789; // Long | 
        map[String, String] requestBody = ; // map[String, String] | 

        try {
            Reply_ReplyInfo result = apiInstance.createReply(postId, requestBody);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiPostControllerApi#createReply");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiPostControllerApi *apiInstance = [[ApiPostControllerApi alloc] init];
Long *postId = 789; //  (default to null)
map[String, String] *requestBody = ; // 

// Create a reply
[apiInstance createReplyWith:postId
    requestBody:requestBody
              completionHandler: ^(Reply_ReplyInfo output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiPostControllerApi()
var postId = 789; // {Long} 
var requestBody = ; // {map[String, String]} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createReply(postId, requestBody, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class createReplyExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiPostControllerApi();
            var postId = 789;  // Long |  (default to null)
            var requestBody = new map[String, String](); // map[String, String] | 

            try {
                // Create a reply
                Reply_ReplyInfo result = apiInstance.createReply(postId, requestBody);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiPostControllerApi.createReply: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiPostControllerApi();
$postId = 789; // Long | 
$requestBody = ; // map[String, String] | 

try {
    $result = $api_instance->createReply($postId, $requestBody);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiPostControllerApi->createReply: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiPostControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiPostControllerApi->new();
my $postId = 789; # Long | 
my $requestBody = WWW::OPenAPIClient::Object::map[String, String]->new(); # map[String, String] | 

eval {
    my $result = $api_instance->createReply(postId => $postId, requestBody => $requestBody);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiPostControllerApi->createReply: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiPostControllerApi()
postId = 789 # Long |  (default to null)
requestBody =  # map[String, String] | 

try:
    # Create a reply
    api_response = api_instance.create_reply(postId, requestBody)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiPostControllerApi->createReply: %s\n" % e)
extern crate ApiPostControllerApi;

pub fn main() {
    let postId = 789; // Long
    let requestBody = ; // map[String, String]

    let mut context = ApiPostControllerApi::Context::default();
    let result = client.createReply(postId, requestBody, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
postId*
Long (int64)
Required
Body parameters
Name Description
requestBody *

Responses


deletePost

Delete a post


/api/v1/posts/{postId}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: */*" \
 "https://localhost:8443/api/v1/posts/{postId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiPostControllerApi;

import java.io.File;
import java.util.*;

public class ApiPostControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiPostControllerApi apiInstance = new ApiPostControllerApi();
        Long postId = 789; // Long | 

        try {
            'String' result = apiInstance.deletePost(postId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiPostControllerApi#deletePost");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiPostControllerApi;

public class ApiPostControllerApiExample {
    public static void main(String[] args) {
        ApiPostControllerApi apiInstance = new ApiPostControllerApi();
        Long postId = 789; // Long | 

        try {
            'String' result = apiInstance.deletePost(postId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiPostControllerApi#deletePost");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiPostControllerApi *apiInstance = [[ApiPostControllerApi alloc] init];
Long *postId = 789; //  (default to null)

// Delete a post
[apiInstance deletePostWith:postId
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiPostControllerApi()
var postId = 789; // {Long} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deletePost(postId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deletePostExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiPostControllerApi();
            var postId = 789;  // Long |  (default to null)

            try {
                // Delete a post
                'String' result = apiInstance.deletePost(postId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiPostControllerApi.deletePost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiPostControllerApi();
$postId = 789; // Long | 

try {
    $result = $api_instance->deletePost($postId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiPostControllerApi->deletePost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiPostControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiPostControllerApi->new();
my $postId = 789; # Long | 

eval {
    my $result = $api_instance->deletePost(postId => $postId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiPostControllerApi->deletePost: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiPostControllerApi()
postId = 789 # Long |  (default to null)

try:
    # Delete a post
    api_response = api_instance.delete_post(postId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiPostControllerApi->deletePost: %s\n" % e)
extern crate ApiPostControllerApi;

pub fn main() {
    let postId = 789; // Long

    let mut context = ApiPostControllerApi::Context::default();
    let result = client.deletePost(postId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
postId*
Long (int64)
Required

Responses


deletePostImage

Delete post image


/api/v1/posts/{postId}/pictures

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: */*" \
 "https://localhost:8443/api/v1/posts/{postId}/pictures"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiPostControllerApi;

import java.io.File;
import java.util.*;

public class ApiPostControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiPostControllerApi apiInstance = new ApiPostControllerApi();
        Long postId = 789; // Long | 

        try {
            'String' result = apiInstance.deletePostImage(postId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiPostControllerApi#deletePostImage");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiPostControllerApi;

public class ApiPostControllerApiExample {
    public static void main(String[] args) {
        ApiPostControllerApi apiInstance = new ApiPostControllerApi();
        Long postId = 789; // Long | 

        try {
            'String' result = apiInstance.deletePostImage(postId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiPostControllerApi#deletePostImage");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiPostControllerApi *apiInstance = [[ApiPostControllerApi alloc] init];
Long *postId = 789; //  (default to null)

// Delete post image
[apiInstance deletePostImageWith:postId
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiPostControllerApi()
var postId = 789; // {Long} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deletePostImage(postId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deletePostImageExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiPostControllerApi();
            var postId = 789;  // Long |  (default to null)

            try {
                // Delete post image
                'String' result = apiInstance.deletePostImage(postId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiPostControllerApi.deletePostImage: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiPostControllerApi();
$postId = 789; // Long | 

try {
    $result = $api_instance->deletePostImage($postId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiPostControllerApi->deletePostImage: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiPostControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiPostControllerApi->new();
my $postId = 789; # Long | 

eval {
    my $result = $api_instance->deletePostImage(postId => $postId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiPostControllerApi->deletePostImage: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiPostControllerApi()
postId = 789 # Long |  (default to null)

try:
    # Delete post image
    api_response = api_instance.delete_post_image(postId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiPostControllerApi->deletePostImage: %s\n" % e)
extern crate ApiPostControllerApi;

pub fn main() {
    let postId = 789; // Long

    let mut context = ApiPostControllerApi::Context::default();
    let result = client.deletePostImage(postId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
postId*
Long (int64)
Required

Responses


deleteReply

Delete a reply


/api/v1/replies/{replyId}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: */*" \
 "https://localhost:8443/api/v1/replies/{replyId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiPostControllerApi;

import java.io.File;
import java.util.*;

public class ApiPostControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiPostControllerApi apiInstance = new ApiPostControllerApi();
        Long replyId = 789; // Long | 

        try {
            'String' result = apiInstance.deleteReply(replyId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiPostControllerApi#deleteReply");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiPostControllerApi;

public class ApiPostControllerApiExample {
    public static void main(String[] args) {
        ApiPostControllerApi apiInstance = new ApiPostControllerApi();
        Long replyId = 789; // Long | 

        try {
            'String' result = apiInstance.deleteReply(replyId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiPostControllerApi#deleteReply");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiPostControllerApi *apiInstance = [[ApiPostControllerApi alloc] init];
Long *replyId = 789; //  (default to null)

// Delete a reply
[apiInstance deleteReplyWith:replyId
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiPostControllerApi()
var replyId = 789; // {Long} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteReply(replyId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteReplyExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiPostControllerApi();
            var replyId = 789;  // Long |  (default to null)

            try {
                // Delete a reply
                'String' result = apiInstance.deleteReply(replyId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiPostControllerApi.deleteReply: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiPostControllerApi();
$replyId = 789; // Long | 

try {
    $result = $api_instance->deleteReply($replyId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiPostControllerApi->deleteReply: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiPostControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiPostControllerApi->new();
my $replyId = 789; # Long | 

eval {
    my $result = $api_instance->deleteReply(replyId => $replyId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiPostControllerApi->deleteReply: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiPostControllerApi()
replyId = 789 # Long |  (default to null)

try:
    # Delete a reply
    api_response = api_instance.delete_reply(replyId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiPostControllerApi->deleteReply: %s\n" % e)
extern crate ApiPostControllerApi;

pub fn main() {
    let replyId = 789; // Long

    let mut context = ApiPostControllerApi::Context::default();
    let result = client.deleteReply(replyId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
replyId*
Long (int64)
Required

Responses


editPost

Edit a post (or upvote/downvote)


/api/v1/posts/{postId}

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://localhost:8443/api/v1/posts/{postId}?action=action_example" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiPostControllerApi;

import java.io.File;
import java.util.*;

public class ApiPostControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiPostControllerApi apiInstance = new ApiPostControllerApi();
        Long postId = 789; // Long | 
        String action = action_example; // String | 
        PostDTOPostInfo postDTOPostInfo = ; // PostDTOPostInfo | 

        try {
            Post_PostInfo result = apiInstance.editPost(postId, action, postDTOPostInfo);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiPostControllerApi#editPost");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiPostControllerApi;

public class ApiPostControllerApiExample {
    public static void main(String[] args) {
        ApiPostControllerApi apiInstance = new ApiPostControllerApi();
        Long postId = 789; // Long | 
        String action = action_example; // String | 
        PostDTOPostInfo postDTOPostInfo = ; // PostDTOPostInfo | 

        try {
            Post_PostInfo result = apiInstance.editPost(postId, action, postDTOPostInfo);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiPostControllerApi#editPost");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiPostControllerApi *apiInstance = [[ApiPostControllerApi alloc] init];
Long *postId = 789; //  (default to null)
String *action = action_example; //  (default to null)
PostDTOPostInfo *postDTOPostInfo = ; //  (optional)

// Edit a post (or upvote/downvote)
[apiInstance editPostWith:postId
    action:action
    postDTOPostInfo:postDTOPostInfo
              completionHandler: ^(Post_PostInfo output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiPostControllerApi()
var postId = 789; // {Long} 
var action = action_example; // {String} 
var opts = {
  'postDTOPostInfo':  // {PostDTOPostInfo} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.editPost(postId, action, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class editPostExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiPostControllerApi();
            var postId = 789;  // Long |  (default to null)
            var action = action_example;  // String |  (default to null)
            var postDTOPostInfo = new PostDTOPostInfo(); // PostDTOPostInfo |  (optional) 

            try {
                // Edit a post (or upvote/downvote)
                Post_PostInfo result = apiInstance.editPost(postId, action, postDTOPostInfo);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiPostControllerApi.editPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiPostControllerApi();
$postId = 789; // Long | 
$action = action_example; // String | 
$postDTOPostInfo = ; // PostDTOPostInfo | 

try {
    $result = $api_instance->editPost($postId, $action, $postDTOPostInfo);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiPostControllerApi->editPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiPostControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiPostControllerApi->new();
my $postId = 789; # Long | 
my $action = action_example; # String | 
my $postDTOPostInfo = WWW::OPenAPIClient::Object::PostDTOPostInfo->new(); # PostDTOPostInfo | 

eval {
    my $result = $api_instance->editPost(postId => $postId, action => $action, postDTOPostInfo => $postDTOPostInfo);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiPostControllerApi->editPost: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiPostControllerApi()
postId = 789 # Long |  (default to null)
action = action_example # String |  (default to null)
postDTOPostInfo =  # PostDTOPostInfo |  (optional)

try:
    # Edit a post (or upvote/downvote)
    api_response = api_instance.edit_post(postId, action, postDTOPostInfo=postDTOPostInfo)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiPostControllerApi->editPost: %s\n" % e)
extern crate ApiPostControllerApi;

pub fn main() {
    let postId = 789; // Long
    let action = action_example; // String
    let postDTOPostInfo = ; // PostDTOPostInfo

    let mut context = ApiPostControllerApi::Context::default();
    let result = client.editPost(postId, action, postDTOPostInfo, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
postId*
Long (int64)
Required
Body parameters
Name Description
postDTOPostInfo

Query parameters
Name Description
action*
String
Required

Responses


getCommunityPosts

Get posts of a community using its ID


/api/v1/communities/{communityID}/posts

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://localhost:8443/api/v1/communities/{communityID}/posts?count=true&page=56&size=56&sort=sort_example&query=query_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiPostControllerApi;

import java.io.File;
import java.util.*;

public class ApiPostControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiPostControllerApi apiInstance = new ApiPostControllerApi();
        Long communityID = 789; // Long | 
        Boolean count = true; // Boolean | 
        Integer page = 56; // Integer | 
        Integer size = 56; // Integer | 
        String sort = sort_example; // String | 
        String query = query_example; // String | 

        try {
            Post_PostInfo result = apiInstance.getCommunityPosts(communityID, count, page, size, sort, query);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiPostControllerApi#getCommunityPosts");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiPostControllerApi;

public class ApiPostControllerApiExample {
    public static void main(String[] args) {
        ApiPostControllerApi apiInstance = new ApiPostControllerApi();
        Long communityID = 789; // Long | 
        Boolean count = true; // Boolean | 
        Integer page = 56; // Integer | 
        Integer size = 56; // Integer | 
        String sort = sort_example; // String | 
        String query = query_example; // String | 

        try {
            Post_PostInfo result = apiInstance.getCommunityPosts(communityID, count, page, size, sort, query);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiPostControllerApi#getCommunityPosts");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiPostControllerApi *apiInstance = [[ApiPostControllerApi alloc] init];
Long *communityID = 789; //  (default to null)
Boolean *count = true; //  (optional) (default to false)
Integer *page = 56; //  (optional) (default to 0)
Integer *size = 56; //  (optional) (default to 10)
String *sort = sort_example; //  (optional) (default to lastModifiedDate)
String *query = query_example; //  (optional) (default to null)

// Get posts of a community using its ID
[apiInstance getCommunityPostsWith:communityID
    count:count
    page:page
    size:size
    sort:sort
    query:query
              completionHandler: ^(Post_PostInfo output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiPostControllerApi()
var communityID = 789; // {Long} 
var opts = {
  'count': true, // {Boolean} 
  'page': 56, // {Integer} 
  'size': 56, // {Integer} 
  'sort': sort_example, // {String} 
  'query': query_example // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCommunityPosts(communityID, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getCommunityPostsExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiPostControllerApi();
            var communityID = 789;  // Long |  (default to null)
            var count = true;  // Boolean |  (optional)  (default to false)
            var page = 56;  // Integer |  (optional)  (default to 0)
            var size = 56;  // Integer |  (optional)  (default to 10)
            var sort = sort_example;  // String |  (optional)  (default to lastModifiedDate)
            var query = query_example;  // String |  (optional)  (default to null)

            try {
                // Get posts of a community using its ID
                Post_PostInfo result = apiInstance.getCommunityPosts(communityID, count, page, size, sort, query);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiPostControllerApi.getCommunityPosts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiPostControllerApi();
$communityID = 789; // Long | 
$count = true; // Boolean | 
$page = 56; // Integer | 
$size = 56; // Integer | 
$sort = sort_example; // String | 
$query = query_example; // String | 

try {
    $result = $api_instance->getCommunityPosts($communityID, $count, $page, $size, $sort, $query);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiPostControllerApi->getCommunityPosts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiPostControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiPostControllerApi->new();
my $communityID = 789; # Long | 
my $count = true; # Boolean | 
my $page = 56; # Integer | 
my $size = 56; # Integer | 
my $sort = sort_example; # String | 
my $query = query_example; # String | 

eval {
    my $result = $api_instance->getCommunityPosts(communityID => $communityID, count => $count, page => $page, size => $size, sort => $sort, query => $query);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiPostControllerApi->getCommunityPosts: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiPostControllerApi()
communityID = 789 # Long |  (default to null)
count = true # Boolean |  (optional) (default to false)
page = 56 # Integer |  (optional) (default to 0)
size = 56 # Integer |  (optional) (default to 10)
sort = sort_example # String |  (optional) (default to lastModifiedDate)
query = query_example # String |  (optional) (default to null)

try:
    # Get posts of a community using its ID
    api_response = api_instance.get_community_posts(communityID, count=count, page=page, size=size, sort=sort, query=query)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiPostControllerApi->getCommunityPosts: %s\n" % e)
extern crate ApiPostControllerApi;

pub fn main() {
    let communityID = 789; // Long
    let count = true; // Boolean
    let page = 56; // Integer
    let size = 56; // Integer
    let sort = sort_example; // String
    let query = query_example; // String

    let mut context = ApiPostControllerApi::Context::default();
    let result = client.getCommunityPosts(communityID, count, page, size, sort, query, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
communityID*
Long (int64)
Required
Query parameters
Name Description
count
Boolean
page
Integer (int32)
size
Integer (int32)
sort
String
query
String

Responses


getMostLikedPostsOfAllCommunities

Get the most liked posts of the most followed (popular) communities


/api/v1/communities/most-popular/posts/most-liked

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://localhost:8443/api/v1/communities/most-popular/posts/most-liked?page=56&size=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiPostControllerApi;

import java.io.File;
import java.util.*;

public class ApiPostControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiPostControllerApi apiInstance = new ApiPostControllerApi();
        Integer page = 56; // Integer | 
        Integer size = 56; // Integer | 

        try {
            Post_PostInfo result = apiInstance.getMostLikedPostsOfAllCommunities(page, size);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiPostControllerApi#getMostLikedPostsOfAllCommunities");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiPostControllerApi;

public class ApiPostControllerApiExample {
    public static void main(String[] args) {
        ApiPostControllerApi apiInstance = new ApiPostControllerApi();
        Integer page = 56; // Integer | 
        Integer size = 56; // Integer | 

        try {
            Post_PostInfo result = apiInstance.getMostLikedPostsOfAllCommunities(page, size);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiPostControllerApi#getMostLikedPostsOfAllCommunities");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiPostControllerApi *apiInstance = [[ApiPostControllerApi alloc] init];
Integer *page = 56; //  (optional) (default to 0)
Integer *size = 56; //  (optional) (default to 10)

// Get the most liked posts of the most followed (popular) communities
[apiInstance getMostLikedPostsOfAllCommunitiesWith:page
    size:size
              completionHandler: ^(Post_PostInfo output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiPostControllerApi()
var opts = {
  'page': 56, // {Integer} 
  'size': 56 // {Integer} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMostLikedPostsOfAllCommunities(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getMostLikedPostsOfAllCommunitiesExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiPostControllerApi();
            var page = 56;  // Integer |  (optional)  (default to 0)
            var size = 56;  // Integer |  (optional)  (default to 10)

            try {
                // Get the most liked posts of the most followed (popular) communities
                Post_PostInfo result = apiInstance.getMostLikedPostsOfAllCommunities(page, size);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiPostControllerApi.getMostLikedPostsOfAllCommunities: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiPostControllerApi();
$page = 56; // Integer | 
$size = 56; // Integer | 

try {
    $result = $api_instance->getMostLikedPostsOfAllCommunities($page, $size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiPostControllerApi->getMostLikedPostsOfAllCommunities: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiPostControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiPostControllerApi->new();
my $page = 56; # Integer | 
my $size = 56; # Integer | 

eval {
    my $result = $api_instance->getMostLikedPostsOfAllCommunities(page => $page, size => $size);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiPostControllerApi->getMostLikedPostsOfAllCommunities: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiPostControllerApi()
page = 56 # Integer |  (optional) (default to 0)
size = 56 # Integer |  (optional) (default to 10)

try:
    # Get the most liked posts of the most followed (popular) communities
    api_response = api_instance.get_most_liked_posts_of_all_communities(page=page, size=size)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiPostControllerApi->getMostLikedPostsOfAllCommunities: %s\n" % e)
extern crate ApiPostControllerApi;

pub fn main() {
    let page = 56; // Integer
    let size = 56; // Integer

    let mut context = ApiPostControllerApi::Context::default();
    let result = client.getMostLikedPostsOfAllCommunities(page, size, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
page
Integer (int32)
size
Integer (int32)

Responses


getMostLikedPostsOfMostFollowedUsers

Get the most liked posts of the most followed users


/api/v1/users/posts/most-liked

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://localhost:8443/api/v1/users/posts/most-liked?page=56&size=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiPostControllerApi;

import java.io.File;
import java.util.*;

public class ApiPostControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiPostControllerApi apiInstance = new ApiPostControllerApi();
        Integer page = 56; // Integer | 
        Integer size = 56; // Integer | 

        try {
            Post_PostInfo result = apiInstance.getMostLikedPostsOfMostFollowedUsers(page, size);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiPostControllerApi#getMostLikedPostsOfMostFollowedUsers");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiPostControllerApi;

public class ApiPostControllerApiExample {
    public static void main(String[] args) {
        ApiPostControllerApi apiInstance = new ApiPostControllerApi();
        Integer page = 56; // Integer | 
        Integer size = 56; // Integer | 

        try {
            Post_PostInfo result = apiInstance.getMostLikedPostsOfMostFollowedUsers(page, size);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiPostControllerApi#getMostLikedPostsOfMostFollowedUsers");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiPostControllerApi *apiInstance = [[ApiPostControllerApi alloc] init];
Integer *page = 56; //  (optional) (default to 0)
Integer *size = 56; //  (optional) (default to 10)

// Get the most liked posts of the most followed users
[apiInstance getMostLikedPostsOfMostFollowedUsersWith:page
    size:size
              completionHandler: ^(Post_PostInfo output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiPostControllerApi()
var opts = {
  'page': 56, // {Integer} 
  'size': 56 // {Integer} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMostLikedPostsOfMostFollowedUsers(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getMostLikedPostsOfMostFollowedUsersExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiPostControllerApi();
            var page = 56;  // Integer |  (optional)  (default to 0)
            var size = 56;  // Integer |  (optional)  (default to 10)

            try {
                // Get the most liked posts of the most followed users
                Post_PostInfo result = apiInstance.getMostLikedPostsOfMostFollowedUsers(page, size);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiPostControllerApi.getMostLikedPostsOfMostFollowedUsers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiPostControllerApi();
$page = 56; // Integer | 
$size = 56; // Integer | 

try {
    $result = $api_instance->getMostLikedPostsOfMostFollowedUsers($page, $size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiPostControllerApi->getMostLikedPostsOfMostFollowedUsers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiPostControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiPostControllerApi->new();
my $page = 56; # Integer | 
my $size = 56; # Integer | 

eval {
    my $result = $api_instance->getMostLikedPostsOfMostFollowedUsers(page => $page, size => $size);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiPostControllerApi->getMostLikedPostsOfMostFollowedUsers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiPostControllerApi()
page = 56 # Integer |  (optional) (default to 0)
size = 56 # Integer |  (optional) (default to 10)

try:
    # Get the most liked posts of the most followed users
    api_response = api_instance.get_most_liked_posts_of_most_followed_users(page=page, size=size)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiPostControllerApi->getMostLikedPostsOfMostFollowedUsers: %s\n" % e)
extern crate ApiPostControllerApi;

pub fn main() {
    let page = 56; // Integer
    let size = 56; // Integer

    let mut context = ApiPostControllerApi::Context::default();
    let result = client.getMostLikedPostsOfMostFollowedUsers(page, size, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
page
Integer (int32)
size
Integer (int32)

Responses


getMostLikedPostsOfMostFollowedUsers1

Get the most liked posts of the most followed users the user follows


/api/v1/users/me/following/posts/most-liked

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://localhost:8443/api/v1/users/me/following/posts/most-liked?page=56&size=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiPostControllerApi;

import java.io.File;
import java.util.*;

public class ApiPostControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiPostControllerApi apiInstance = new ApiPostControllerApi();
        Integer page = 56; // Integer | 
        Integer size = 56; // Integer | 

        try {
            Post_PostInfo result = apiInstance.getMostLikedPostsOfMostFollowedUsers1(page, size);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiPostControllerApi#getMostLikedPostsOfMostFollowedUsers1");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiPostControllerApi;

public class ApiPostControllerApiExample {
    public static void main(String[] args) {
        ApiPostControllerApi apiInstance = new ApiPostControllerApi();
        Integer page = 56; // Integer | 
        Integer size = 56; // Integer | 

        try {
            Post_PostInfo result = apiInstance.getMostLikedPostsOfMostFollowedUsers1(page, size);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiPostControllerApi#getMostLikedPostsOfMostFollowedUsers1");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiPostControllerApi *apiInstance = [[ApiPostControllerApi alloc] init];
Integer *page = 56; //  (optional) (default to 0)
Integer *size = 56; //  (optional) (default to 10)

// Get the most liked posts of the most followed users the user follows
[apiInstance getMostLikedPostsOfMostFollowedUsers1With:page
    size:size
              completionHandler: ^(Post_PostInfo output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiPostControllerApi()
var opts = {
  'page': 56, // {Integer} 
  'size': 56 // {Integer} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMostLikedPostsOfMostFollowedUsers1(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getMostLikedPostsOfMostFollowedUsers1Example
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiPostControllerApi();
            var page = 56;  // Integer |  (optional)  (default to 0)
            var size = 56;  // Integer |  (optional)  (default to 10)

            try {
                // Get the most liked posts of the most followed users the user follows
                Post_PostInfo result = apiInstance.getMostLikedPostsOfMostFollowedUsers1(page, size);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiPostControllerApi.getMostLikedPostsOfMostFollowedUsers1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiPostControllerApi();
$page = 56; // Integer | 
$size = 56; // Integer | 

try {
    $result = $api_instance->getMostLikedPostsOfMostFollowedUsers1($page, $size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiPostControllerApi->getMostLikedPostsOfMostFollowedUsers1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiPostControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiPostControllerApi->new();
my $page = 56; # Integer | 
my $size = 56; # Integer | 

eval {
    my $result = $api_instance->getMostLikedPostsOfMostFollowedUsers1(page => $page, size => $size);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiPostControllerApi->getMostLikedPostsOfMostFollowedUsers1: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiPostControllerApi()
page = 56 # Integer |  (optional) (default to 0)
size = 56 # Integer |  (optional) (default to 10)

try:
    # Get the most liked posts of the most followed users the user follows
    api_response = api_instance.get_most_liked_posts_of_most_followed_users1(page=page, size=size)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiPostControllerApi->getMostLikedPostsOfMostFollowedUsers1: %s\n" % e)
extern crate ApiPostControllerApi;

pub fn main() {
    let page = 56; // Integer
    let size = 56; // Integer

    let mut context = ApiPostControllerApi::Context::default();
    let result = client.getMostLikedPostsOfMostFollowedUsers1(page, size, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
page
Integer (int32)
size
Integer (int32)

Responses


getMostLikedPostsOfUserCommunities

Get the most liked posts of the user's communities


/api/v1/users/me/communities/posts/most-liked

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://localhost:8443/api/v1/users/me/communities/posts/most-liked?page=56&size=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiPostControllerApi;

import java.io.File;
import java.util.*;

public class ApiPostControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiPostControllerApi apiInstance = new ApiPostControllerApi();
        Integer page = 56; // Integer | 
        Integer size = 56; // Integer | 

        try {
            Post_PostInfo result = apiInstance.getMostLikedPostsOfUserCommunities(page, size);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiPostControllerApi#getMostLikedPostsOfUserCommunities");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiPostControllerApi;

public class ApiPostControllerApiExample {
    public static void main(String[] args) {
        ApiPostControllerApi apiInstance = new ApiPostControllerApi();
        Integer page = 56; // Integer | 
        Integer size = 56; // Integer | 

        try {
            Post_PostInfo result = apiInstance.getMostLikedPostsOfUserCommunities(page, size);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiPostControllerApi#getMostLikedPostsOfUserCommunities");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiPostControllerApi *apiInstance = [[ApiPostControllerApi alloc] init];
Integer *page = 56; //  (optional) (default to 0)
Integer *size = 56; //  (optional) (default to 10)

// Get the most liked posts of the user's communities
[apiInstance getMostLikedPostsOfUserCommunitiesWith:page
    size:size
              completionHandler: ^(Post_PostInfo output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiPostControllerApi()
var opts = {
  'page': 56, // {Integer} 
  'size': 56 // {Integer} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMostLikedPostsOfUserCommunities(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getMostLikedPostsOfUserCommunitiesExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiPostControllerApi();
            var page = 56;  // Integer |  (optional)  (default to 0)
            var size = 56;  // Integer |  (optional)  (default to 10)

            try {
                // Get the most liked posts of the user's communities
                Post_PostInfo result = apiInstance.getMostLikedPostsOfUserCommunities(page, size);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiPostControllerApi.getMostLikedPostsOfUserCommunities: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiPostControllerApi();
$page = 56; // Integer | 
$size = 56; // Integer | 

try {
    $result = $api_instance->getMostLikedPostsOfUserCommunities($page, $size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiPostControllerApi->getMostLikedPostsOfUserCommunities: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiPostControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiPostControllerApi->new();
my $page = 56; # Integer | 
my $size = 56; # Integer | 

eval {
    my $result = $api_instance->getMostLikedPostsOfUserCommunities(page => $page, size => $size);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiPostControllerApi->getMostLikedPostsOfUserCommunities: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiPostControllerApi()
page = 56 # Integer |  (optional) (default to 0)
size = 56 # Integer |  (optional) (default to 10)

try:
    # Get the most liked posts of the user's communities
    api_response = api_instance.get_most_liked_posts_of_user_communities(page=page, size=size)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiPostControllerApi->getMostLikedPostsOfUserCommunities: %s\n" % e)
extern crate ApiPostControllerApi;

pub fn main() {
    let page = 56; // Integer
    let size = 56; // Integer

    let mut context = ApiPostControllerApi::Context::default();
    let result = client.getMostLikedPostsOfUserCommunities(page, size, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
page
Integer (int32)
size
Integer (int32)

Responses


getMostRecentPostsOfMostFollowedCommunities

Get the most recent posts of the most followed communities


/api/v1/communities/most-popular/posts/most-recent

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://localhost:8443/api/v1/communities/most-popular/posts/most-recent?page=56&size=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiPostControllerApi;

import java.io.File;
import java.util.*;

public class ApiPostControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiPostControllerApi apiInstance = new ApiPostControllerApi();
        Integer page = 56; // Integer | 
        Integer size = 56; // Integer | 

        try {
            Post_PostInfo result = apiInstance.getMostRecentPostsOfMostFollowedCommunities(page, size);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiPostControllerApi#getMostRecentPostsOfMostFollowedCommunities");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiPostControllerApi;

public class ApiPostControllerApiExample {
    public static void main(String[] args) {
        ApiPostControllerApi apiInstance = new ApiPostControllerApi();
        Integer page = 56; // Integer | 
        Integer size = 56; // Integer | 

        try {
            Post_PostInfo result = apiInstance.getMostRecentPostsOfMostFollowedCommunities(page, size);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiPostControllerApi#getMostRecentPostsOfMostFollowedCommunities");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiPostControllerApi *apiInstance = [[ApiPostControllerApi alloc] init];
Integer *page = 56; //  (optional) (default to 0)
Integer *size = 56; //  (optional) (default to 10)

// Get the most recent posts of the most followed communities
[apiInstance getMostRecentPostsOfMostFollowedCommunitiesWith:page
    size:size
              completionHandler: ^(Post_PostInfo output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiPostControllerApi()
var opts = {
  'page': 56, // {Integer} 
  'size': 56 // {Integer} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMostRecentPostsOfMostFollowedCommunities(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getMostRecentPostsOfMostFollowedCommunitiesExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiPostControllerApi();
            var page = 56;  // Integer |  (optional)  (default to 0)
            var size = 56;  // Integer |  (optional)  (default to 10)

            try {
                // Get the most recent posts of the most followed communities
                Post_PostInfo result = apiInstance.getMostRecentPostsOfMostFollowedCommunities(page, size);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiPostControllerApi.getMostRecentPostsOfMostFollowedCommunities: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiPostControllerApi();
$page = 56; // Integer | 
$size = 56; // Integer | 

try {
    $result = $api_instance->getMostRecentPostsOfMostFollowedCommunities($page, $size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiPostControllerApi->getMostRecentPostsOfMostFollowedCommunities: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiPostControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiPostControllerApi->new();
my $page = 56; # Integer | 
my $size = 56; # Integer | 

eval {
    my $result = $api_instance->getMostRecentPostsOfMostFollowedCommunities(page => $page, size => $size);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiPostControllerApi->getMostRecentPostsOfMostFollowedCommunities: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiPostControllerApi()
page = 56 # Integer |  (optional) (default to 0)
size = 56 # Integer |  (optional) (default to 10)

try:
    # Get the most recent posts of the most followed communities
    api_response = api_instance.get_most_recent_posts_of_most_followed_communities(page=page, size=size)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiPostControllerApi->getMostRecentPostsOfMostFollowedCommunities: %s\n" % e)
extern crate ApiPostControllerApi;

pub fn main() {
    let page = 56; // Integer
    let size = 56; // Integer

    let mut context = ApiPostControllerApi::Context::default();
    let result = client.getMostRecentPostsOfMostFollowedCommunities(page, size, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
page
Integer (int32)
size
Integer (int32)

Responses


getMostRecentPostsOfUserCommunities

Get the most recent posts of the user's communities


/api/v1/users/me/communities/posts/most-recent

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://localhost:8443/api/v1/users/me/communities/posts/most-recent?page=56&size=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiPostControllerApi;

import java.io.File;
import java.util.*;

public class ApiPostControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiPostControllerApi apiInstance = new ApiPostControllerApi();
        Integer page = 56; // Integer | 
        Integer size = 56; // Integer | 

        try {
            Post_PostInfo result = apiInstance.getMostRecentPostsOfUserCommunities(page, size);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiPostControllerApi#getMostRecentPostsOfUserCommunities");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiPostControllerApi;

public class ApiPostControllerApiExample {
    public static void main(String[] args) {
        ApiPostControllerApi apiInstance = new ApiPostControllerApi();
        Integer page = 56; // Integer | 
        Integer size = 56; // Integer | 

        try {
            Post_PostInfo result = apiInstance.getMostRecentPostsOfUserCommunities(page, size);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiPostControllerApi#getMostRecentPostsOfUserCommunities");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiPostControllerApi *apiInstance = [[ApiPostControllerApi alloc] init];
Integer *page = 56; //  (optional) (default to 0)
Integer *size = 56; //  (optional) (default to 10)

// Get the most recent posts of the user's communities
[apiInstance getMostRecentPostsOfUserCommunitiesWith:page
    size:size
              completionHandler: ^(Post_PostInfo output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiPostControllerApi()
var opts = {
  'page': 56, // {Integer} 
  'size': 56 // {Integer} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMostRecentPostsOfUserCommunities(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getMostRecentPostsOfUserCommunitiesExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiPostControllerApi();
            var page = 56;  // Integer |  (optional)  (default to 0)
            var size = 56;  // Integer |  (optional)  (default to 10)

            try {
                // Get the most recent posts of the user's communities
                Post_PostInfo result = apiInstance.getMostRecentPostsOfUserCommunities(page, size);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiPostControllerApi.getMostRecentPostsOfUserCommunities: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiPostControllerApi();
$page = 56; // Integer | 
$size = 56; // Integer | 

try {
    $result = $api_instance->getMostRecentPostsOfUserCommunities($page, $size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiPostControllerApi->getMostRecentPostsOfUserCommunities: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiPostControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiPostControllerApi->new();
my $page = 56; # Integer | 
my $size = 56; # Integer | 

eval {
    my $result = $api_instance->getMostRecentPostsOfUserCommunities(page => $page, size => $size);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiPostControllerApi->getMostRecentPostsOfUserCommunities: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiPostControllerApi()
page = 56 # Integer |  (optional) (default to 0)
size = 56 # Integer |  (optional) (default to 10)

try:
    # Get the most recent posts of the user's communities
    api_response = api_instance.get_most_recent_posts_of_user_communities(page=page, size=size)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiPostControllerApi->getMostRecentPostsOfUserCommunities: %s\n" % e)
extern crate ApiPostControllerApi;

pub fn main() {
    let page = 56; // Integer
    let size = 56; // Integer

    let mut context = ApiPostControllerApi::Context::default();
    let result = client.getMostRecentPostsOfUserCommunities(page, size, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
page
Integer (int32)
size
Integer (int32)

Responses


getPostById

Get post by ID


/api/v1/posts/{postId}

Usage and SDK Samples

curl -X GET \
 -H "Accept: */*,application/json" \
 "https://localhost:8443/api/v1/posts/{postId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiPostControllerApi;

import java.io.File;
import java.util.*;

public class ApiPostControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiPostControllerApi apiInstance = new ApiPostControllerApi();
        Long postId = 789; // Long | 

        try {
            Post_PostInfo result = apiInstance.getPostById(postId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiPostControllerApi#getPostById");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiPostControllerApi;

public class ApiPostControllerApiExample {
    public static void main(String[] args) {
        ApiPostControllerApi apiInstance = new ApiPostControllerApi();
        Long postId = 789; // Long | 

        try {
            Post_PostInfo result = apiInstance.getPostById(postId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiPostControllerApi#getPostById");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiPostControllerApi *apiInstance = [[ApiPostControllerApi alloc] init];
Long *postId = 789; //  (default to null)

// Get post by ID
[apiInstance getPostByIdWith:postId
              completionHandler: ^(Post_PostInfo output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiPostControllerApi()
var postId = 789; // {Long} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPostById(postId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getPostByIdExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiPostControllerApi();
            var postId = 789;  // Long |  (default to null)

            try {
                // Get post by ID
                Post_PostInfo result = apiInstance.getPostById(postId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiPostControllerApi.getPostById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiPostControllerApi();
$postId = 789; // Long | 

try {
    $result = $api_instance->getPostById($postId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiPostControllerApi->getPostById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiPostControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiPostControllerApi->new();
my $postId = 789; # Long | 

eval {
    my $result = $api_instance->getPostById(postId => $postId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiPostControllerApi->getPostById: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiPostControllerApi()
postId = 789 # Long |  (default to null)

try:
    # Get post by ID
    api_response = api_instance.get_post_by_id(postId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiPostControllerApi->getPostById: %s\n" % e)
extern crate ApiPostControllerApi;

pub fn main() {
    let postId = 789; // Long

    let mut context = ApiPostControllerApi::Context::default();
    let result = client.getPostById(postId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
postId*
Long (int64)
Required

Responses


getPostImage

Get post image


/api/v1/posts/{postId}/pictures

Usage and SDK Samples

curl -X GET \
 -H "Accept: image/jpeg,image/png" \
 "https://localhost:8443/api/v1/posts/{postId}/pictures"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiPostControllerApi;

import java.io.File;
import java.util.*;

public class ApiPostControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiPostControllerApi apiInstance = new ApiPostControllerApi();
        Long postId = 789; // Long | 

        try {
            apiInstance.getPostImage(postId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiPostControllerApi#getPostImage");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiPostControllerApi;

public class ApiPostControllerApiExample {
    public static void main(String[] args) {
        ApiPostControllerApi apiInstance = new ApiPostControllerApi();
        Long postId = 789; // Long | 

        try {
            apiInstance.getPostImage(postId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiPostControllerApi#getPostImage");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiPostControllerApi *apiInstance = [[ApiPostControllerApi alloc] init];
Long *postId = 789; //  (default to null)

// Get post image
[apiInstance getPostImageWith:postId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiPostControllerApi()
var postId = 789; // {Long} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getPostImage(postId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getPostImageExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiPostControllerApi();
            var postId = 789;  // Long |  (default to null)

            try {
                // Get post image
                apiInstance.getPostImage(postId);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiPostControllerApi.getPostImage: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiPostControllerApi();
$postId = 789; // Long | 

try {
    $api_instance->getPostImage($postId);
} catch (Exception $e) {
    echo 'Exception when calling ApiPostControllerApi->getPostImage: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiPostControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiPostControllerApi->new();
my $postId = 789; # Long | 

eval {
    $api_instance->getPostImage(postId => $postId);
};
if ($@) {
    warn "Exception when calling ApiPostControllerApi->getPostImage: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiPostControllerApi()
postId = 789 # Long |  (default to null)

try:
    # Get post image
    api_instance.get_post_image(postId)
except ApiException as e:
    print("Exception when calling ApiPostControllerApi->getPostImage: %s\n" % e)
extern crate ApiPostControllerApi;

pub fn main() {
    let postId = 789; // Long

    let mut context = ApiPostControllerApi::Context::default();
    let result = client.getPostImage(postId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
postId*
Long (int64)
Required

Responses


getPostsByUsername

Get posts by username


/api/v1/users/{username}/posts

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://localhost:8443/api/v1/users/{username}/posts?query=query_example&page=56&size=56&order=order_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiPostControllerApi;

import java.io.File;
import java.util.*;

public class ApiPostControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiPostControllerApi apiInstance = new ApiPostControllerApi();
        String username = username_example; // String | 
        String query = query_example; // String | 
        Integer page = 56; // Integer | 
        Integer size = 56; // Integer | 
        String order = order_example; // String | 

        try {
            Post_PostInfo result = apiInstance.getPostsByUsername(username, query, page, size, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiPostControllerApi#getPostsByUsername");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiPostControllerApi;

public class ApiPostControllerApiExample {
    public static void main(String[] args) {
        ApiPostControllerApi apiInstance = new ApiPostControllerApi();
        String username = username_example; // String | 
        String query = query_example; // String | 
        Integer page = 56; // Integer | 
        Integer size = 56; // Integer | 
        String order = order_example; // String | 

        try {
            Post_PostInfo result = apiInstance.getPostsByUsername(username, query, page, size, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiPostControllerApi#getPostsByUsername");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiPostControllerApi *apiInstance = [[ApiPostControllerApi alloc] init];
String *username = username_example; //  (default to null)
String *query = query_example; //  (optional) (default to null)
Integer *page = 56; //  (optional) (default to 0)
Integer *size = 56; //  (optional) (default to 10)
String *order = order_example; //  (optional) (default to creationDate)

// Get posts by username
[apiInstance getPostsByUsernameWith:username
    query:query
    page:page
    size:size
    order:order
              completionHandler: ^(Post_PostInfo output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiPostControllerApi()
var username = username_example; // {String} 
var opts = {
  'query': query_example, // {String} 
  'page': 56, // {Integer} 
  'size': 56, // {Integer} 
  'order': order_example // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPostsByUsername(username, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getPostsByUsernameExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiPostControllerApi();
            var username = username_example;  // String |  (default to null)
            var query = query_example;  // String |  (optional)  (default to null)
            var page = 56;  // Integer |  (optional)  (default to 0)
            var size = 56;  // Integer |  (optional)  (default to 10)
            var order = order_example;  // String |  (optional)  (default to creationDate)

            try {
                // Get posts by username
                Post_PostInfo result = apiInstance.getPostsByUsername(username, query, page, size, order);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiPostControllerApi.getPostsByUsername: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiPostControllerApi();
$username = username_example; // String | 
$query = query_example; // String | 
$page = 56; // Integer | 
$size = 56; // Integer | 
$order = order_example; // String | 

try {
    $result = $api_instance->getPostsByUsername($username, $query, $page, $size, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiPostControllerApi->getPostsByUsername: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiPostControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiPostControllerApi->new();
my $username = username_example; # String | 
my $query = query_example; # String | 
my $page = 56; # Integer | 
my $size = 56; # Integer | 
my $order = order_example; # String | 

eval {
    my $result = $api_instance->getPostsByUsername(username => $username, query => $query, page => $page, size => $size, order => $order);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiPostControllerApi->getPostsByUsername: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiPostControllerApi()
username = username_example # String |  (default to null)
query = query_example # String |  (optional) (default to null)
page = 56 # Integer |  (optional) (default to 0)
size = 56 # Integer |  (optional) (default to 10)
order = order_example # String |  (optional) (default to creationDate)

try:
    # Get posts by username
    api_response = api_instance.get_posts_by_username(username, query=query, page=page, size=size, order=order)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiPostControllerApi->getPostsByUsername: %s\n" % e)
extern crate ApiPostControllerApi;

pub fn main() {
    let username = username_example; // String
    let query = query_example; // String
    let page = 56; // Integer
    let size = 56; // Integer
    let order = order_example; // String

    let mut context = ApiPostControllerApi::Context::default();
    let result = client.getPostsByUsername(username, query, page, size, order, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
username*
String
Required
Query parameters
Name Description
query
String
page
Integer (int32)
size
Integer (int32)
order
String

Responses


getRepliesOfPost

Get replies of a post


/api/v1/posts/{postId}/replies/all

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://localhost:8443/api/v1/posts/{postId}/replies/all?page=56&size=56&order=order_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiPostControllerApi;

import java.io.File;
import java.util.*;

public class ApiPostControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiPostControllerApi apiInstance = new ApiPostControllerApi();
        Long postId = 789; // Long | 
        Integer page = 56; // Integer | 
        Integer size = 56; // Integer | 
        String order = order_example; // String | 

        try {
            Reply_ReplyInfo result = apiInstance.getRepliesOfPost(postId, page, size, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiPostControllerApi#getRepliesOfPost");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiPostControllerApi;

public class ApiPostControllerApiExample {
    public static void main(String[] args) {
        ApiPostControllerApi apiInstance = new ApiPostControllerApi();
        Long postId = 789; // Long | 
        Integer page = 56; // Integer | 
        Integer size = 56; // Integer | 
        String order = order_example; // String | 

        try {
            Reply_ReplyInfo result = apiInstance.getRepliesOfPost(postId, page, size, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiPostControllerApi#getRepliesOfPost");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiPostControllerApi *apiInstance = [[ApiPostControllerApi alloc] init];
Long *postId = 789; //  (default to null)
Integer *page = 56; //  (optional) (default to 0)
Integer *size = 56; //  (optional) (default to 10)
String *order = order_example; //  (optional) (default to creationDate)

// Get replies of a post
[apiInstance getRepliesOfPostWith:postId
    page:page
    size:size
    order:order
              completionHandler: ^(Reply_ReplyInfo output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiPostControllerApi()
var postId = 789; // {Long} 
var opts = {
  'page': 56, // {Integer} 
  'size': 56, // {Integer} 
  'order': order_example // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getRepliesOfPost(postId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getRepliesOfPostExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiPostControllerApi();
            var postId = 789;  // Long |  (default to null)
            var page = 56;  // Integer |  (optional)  (default to 0)
            var size = 56;  // Integer |  (optional)  (default to 10)
            var order = order_example;  // String |  (optional)  (default to creationDate)

            try {
                // Get replies of a post
                Reply_ReplyInfo result = apiInstance.getRepliesOfPost(postId, page, size, order);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiPostControllerApi.getRepliesOfPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiPostControllerApi();
$postId = 789; // Long | 
$page = 56; // Integer | 
$size = 56; // Integer | 
$order = order_example; // String | 

try {
    $result = $api_instance->getRepliesOfPost($postId, $page, $size, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiPostControllerApi->getRepliesOfPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiPostControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiPostControllerApi->new();
my $postId = 789; # Long | 
my $page = 56; # Integer | 
my $size = 56; # Integer | 
my $order = order_example; # String | 

eval {
    my $result = $api_instance->getRepliesOfPost(postId => $postId, page => $page, size => $size, order => $order);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiPostControllerApi->getRepliesOfPost: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiPostControllerApi()
postId = 789 # Long |  (default to null)
page = 56 # Integer |  (optional) (default to 0)
size = 56 # Integer |  (optional) (default to 10)
order = order_example # String |  (optional) (default to creationDate)

try:
    # Get replies of a post
    api_response = api_instance.get_replies_of_post(postId, page=page, size=size, order=order)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiPostControllerApi->getRepliesOfPost: %s\n" % e)
extern crate ApiPostControllerApi;

pub fn main() {
    let postId = 789; // Long
    let page = 56; // Integer
    let size = 56; // Integer
    let order = order_example; // String

    let mut context = ApiPostControllerApi::Context::default();
    let result = client.getRepliesOfPost(postId, page, size, order, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
postId*
Long (int64)
Required
Query parameters
Name Description
page
Integer (int32)
size
Integer (int32)
order
String

Responses


getReplyById

Get reply by ID


/api/v1/replies/{replyId}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://localhost:8443/api/v1/replies/{replyId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiPostControllerApi;

import java.io.File;
import java.util.*;

public class ApiPostControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiPostControllerApi apiInstance = new ApiPostControllerApi();
        Long replyId = 789; // Long | 

        try {
            Reply_ReplyInfo result = apiInstance.getReplyById(replyId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiPostControllerApi#getReplyById");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiPostControllerApi;

public class ApiPostControllerApiExample {
    public static void main(String[] args) {
        ApiPostControllerApi apiInstance = new ApiPostControllerApi();
        Long replyId = 789; // Long | 

        try {
            Reply_ReplyInfo result = apiInstance.getReplyById(replyId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiPostControllerApi#getReplyById");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiPostControllerApi *apiInstance = [[ApiPostControllerApi alloc] init];
Long *replyId = 789; //  (default to null)

// Get reply by ID
[apiInstance getReplyByIdWith:replyId
              completionHandler: ^(Reply_ReplyInfo output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiPostControllerApi()
var replyId = 789; // {Long} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getReplyById(replyId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getReplyByIdExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiPostControllerApi();
            var replyId = 789;  // Long |  (default to null)

            try {
                // Get reply by ID
                Reply_ReplyInfo result = apiInstance.getReplyById(replyId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiPostControllerApi.getReplyById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiPostControllerApi();
$replyId = 789; // Long | 

try {
    $result = $api_instance->getReplyById($replyId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiPostControllerApi->getReplyById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiPostControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiPostControllerApi->new();
my $replyId = 789; # Long | 

eval {
    my $result = $api_instance->getReplyById(replyId => $replyId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiPostControllerApi->getReplyById: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiPostControllerApi()
replyId = 789 # Long |  (default to null)

try:
    # Get reply by ID
    api_response = api_instance.get_reply_by_id(replyId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiPostControllerApi->getReplyById: %s\n" % e)
extern crate ApiPostControllerApi;

pub fn main() {
    let replyId = 789; // Long

    let mut context = ApiPostControllerApi::Context::default();
    let result = client.getReplyById(replyId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
replyId*
Long (int64)
Required

Responses


hasUserLikedReply

Returns whether the user has liked a reply


/api/v1/replies/{replyId}/votes

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://localhost:8443/api/v1/replies/{replyId}/votes?username=username_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiPostControllerApi;

import java.io.File;
import java.util.*;

public class ApiPostControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiPostControllerApi apiInstance = new ApiPostControllerApi();
        Long replyId = 789; // Long | 
        String username = username_example; // String | 

        try {
            'Boolean' result = apiInstance.hasUserLikedReply(replyId, username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiPostControllerApi#hasUserLikedReply");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiPostControllerApi;

public class ApiPostControllerApiExample {
    public static void main(String[] args) {
        ApiPostControllerApi apiInstance = new ApiPostControllerApi();
        Long replyId = 789; // Long | 
        String username = username_example; // String | 

        try {
            'Boolean' result = apiInstance.hasUserLikedReply(replyId, username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiPostControllerApi#hasUserLikedReply");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiPostControllerApi *apiInstance = [[ApiPostControllerApi alloc] init];
Long *replyId = 789; //  (default to null)
String *username = username_example; //  (default to null)

// Returns whether the user has liked a reply
[apiInstance hasUserLikedReplyWith:replyId
    username:username
              completionHandler: ^('Boolean' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiPostControllerApi()
var replyId = 789; // {Long} 
var username = username_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.hasUserLikedReply(replyId, username, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class hasUserLikedReplyExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiPostControllerApi();
            var replyId = 789;  // Long |  (default to null)
            var username = username_example;  // String |  (default to null)

            try {
                // Returns whether the user has liked a reply
                'Boolean' result = apiInstance.hasUserLikedReply(replyId, username);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiPostControllerApi.hasUserLikedReply: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiPostControllerApi();
$replyId = 789; // Long | 
$username = username_example; // String | 

try {
    $result = $api_instance->hasUserLikedReply($replyId, $username);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiPostControllerApi->hasUserLikedReply: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiPostControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiPostControllerApi->new();
my $replyId = 789; # Long | 
my $username = username_example; # String | 

eval {
    my $result = $api_instance->hasUserLikedReply(replyId => $replyId, username => $username);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiPostControllerApi->hasUserLikedReply: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiPostControllerApi()
replyId = 789 # Long |  (default to null)
username = username_example # String |  (default to null)

try:
    # Returns whether the user has liked a reply
    api_response = api_instance.has_user_liked_reply(replyId, username)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiPostControllerApi->hasUserLikedReply: %s\n" % e)
extern crate ApiPostControllerApi;

pub fn main() {
    let replyId = 789; // Long
    let username = username_example; // String

    let mut context = ApiPostControllerApi::Context::default();
    let result = client.hasUserLikedReply(replyId, username, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
replyId*
Long (int64)
Required
Query parameters
Name Description
username*
String
Required

Responses


hasUserVotedPost

Returns whether the user has upvoted or downvoted a post


/api/v1/posts/{postId}/votes

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://localhost:8443/api/v1/posts/{postId}/votes?username=username_example&type=type_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiPostControllerApi;

import java.io.File;
import java.util.*;

public class ApiPostControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiPostControllerApi apiInstance = new ApiPostControllerApi();
        Long postId = 789; // Long | 
        String username = username_example; // String | 
        String type = type_example; // String | 

        try {
            'Boolean' result = apiInstance.hasUserVotedPost(postId, username, type);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiPostControllerApi#hasUserVotedPost");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiPostControllerApi;

public class ApiPostControllerApiExample {
    public static void main(String[] args) {
        ApiPostControllerApi apiInstance = new ApiPostControllerApi();
        Long postId = 789; // Long | 
        String username = username_example; // String | 
        String type = type_example; // String | 

        try {
            'Boolean' result = apiInstance.hasUserVotedPost(postId, username, type);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiPostControllerApi#hasUserVotedPost");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiPostControllerApi *apiInstance = [[ApiPostControllerApi alloc] init];
Long *postId = 789; //  (default to null)
String *username = username_example; //  (default to null)
String *type = type_example; //  (default to null)

// Returns whether the user has upvoted or downvoted a post
[apiInstance hasUserVotedPostWith:postId
    username:username
    type:type
              completionHandler: ^('Boolean' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiPostControllerApi()
var postId = 789; // {Long} 
var username = username_example; // {String} 
var type = type_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.hasUserVotedPost(postId, username, type, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class hasUserVotedPostExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiPostControllerApi();
            var postId = 789;  // Long |  (default to null)
            var username = username_example;  // String |  (default to null)
            var type = type_example;  // String |  (default to null)

            try {
                // Returns whether the user has upvoted or downvoted a post
                'Boolean' result = apiInstance.hasUserVotedPost(postId, username, type);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiPostControllerApi.hasUserVotedPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiPostControllerApi();
$postId = 789; // Long | 
$username = username_example; // String | 
$type = type_example; // String | 

try {
    $result = $api_instance->hasUserVotedPost($postId, $username, $type);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiPostControllerApi->hasUserVotedPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiPostControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiPostControllerApi->new();
my $postId = 789; # Long | 
my $username = username_example; # String | 
my $type = type_example; # String | 

eval {
    my $result = $api_instance->hasUserVotedPost(postId => $postId, username => $username, type => $type);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiPostControllerApi->hasUserVotedPost: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiPostControllerApi()
postId = 789 # Long |  (default to null)
username = username_example # String |  (default to null)
type = type_example # String |  (default to null)

try:
    # Returns whether the user has upvoted or downvoted a post
    api_response = api_instance.has_user_voted_post(postId, username, type)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiPostControllerApi->hasUserVotedPost: %s\n" % e)
extern crate ApiPostControllerApi;

pub fn main() {
    let postId = 789; // Long
    let username = username_example; // String
    let type = type_example; // String

    let mut context = ApiPostControllerApi::Context::default();
    let result = client.hasUserVotedPost(postId, username, type, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
postId*
Long (int64)
Required
Query parameters
Name Description
username*
String
Required
type*
String
Required

Responses


likeReply

Modify a reply (like)


/api/v1/replies/{replyId}

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 "https://localhost:8443/api/v1/replies/{replyId}?action=action_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiPostControllerApi;

import java.io.File;
import java.util.*;

public class ApiPostControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiPostControllerApi apiInstance = new ApiPostControllerApi();
        Long replyId = 789; // Long | 
        String action = action_example; // String | 

        try {
            Reply_ReplyInfo result = apiInstance.likeReply(replyId, action);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiPostControllerApi#likeReply");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiPostControllerApi;

public class ApiPostControllerApiExample {
    public static void main(String[] args) {
        ApiPostControllerApi apiInstance = new ApiPostControllerApi();
        Long replyId = 789; // Long | 
        String action = action_example; // String | 

        try {
            Reply_ReplyInfo result = apiInstance.likeReply(replyId, action);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiPostControllerApi#likeReply");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiPostControllerApi *apiInstance = [[ApiPostControllerApi alloc] init];
Long *replyId = 789; //  (default to null)
String *action = action_example; //  (default to null)

// Modify a reply (like)
[apiInstance likeReplyWith:replyId
    action:action
              completionHandler: ^(Reply_ReplyInfo output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiPostControllerApi()
var replyId = 789; // {Long} 
var action = action_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.likeReply(replyId, action, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class likeReplyExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiPostControllerApi();
            var replyId = 789;  // Long |  (default to null)
            var action = action_example;  // String |  (default to null)

            try {
                // Modify a reply (like)
                Reply_ReplyInfo result = apiInstance.likeReply(replyId, action);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiPostControllerApi.likeReply: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiPostControllerApi();
$replyId = 789; // Long | 
$action = action_example; // String | 

try {
    $result = $api_instance->likeReply($replyId, $action);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiPostControllerApi->likeReply: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiPostControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiPostControllerApi->new();
my $replyId = 789; # Long | 
my $action = action_example; # String | 

eval {
    my $result = $api_instance->likeReply(replyId => $replyId, action => $action);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiPostControllerApi->likeReply: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiPostControllerApi()
replyId = 789 # Long |  (default to null)
action = action_example # String |  (default to null)

try:
    # Modify a reply (like)
    api_response = api_instance.like_reply(replyId, action)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiPostControllerApi->likeReply: %s\n" % e)
extern crate ApiPostControllerApi;

pub fn main() {
    let replyId = 789; // Long
    let action = action_example; // String

    let mut context = ApiPostControllerApi::Context::default();
    let result = client.likeReply(replyId, action, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
replyId*
Long (int64)
Required
Query parameters
Name Description
action*
String
Required

Responses


searchPosts

Search posts


/api/v1/posts

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://localhost:8443/api/v1/posts?query=query_example&page=56&size=56&order=order_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiPostControllerApi;

import java.io.File;
import java.util.*;

public class ApiPostControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiPostControllerApi apiInstance = new ApiPostControllerApi();
        String query = query_example; // String | 
        Integer page = 56; // Integer | 
        Integer size = 56; // Integer | 
        String order = order_example; // String | 

        try {
            Post_PostInfo result = apiInstance.searchPosts(query, page, size, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiPostControllerApi#searchPosts");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiPostControllerApi;

public class ApiPostControllerApiExample {
    public static void main(String[] args) {
        ApiPostControllerApi apiInstance = new ApiPostControllerApi();
        String query = query_example; // String | 
        Integer page = 56; // Integer | 
        Integer size = 56; // Integer | 
        String order = order_example; // String | 

        try {
            Post_PostInfo result = apiInstance.searchPosts(query, page, size, order);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiPostControllerApi#searchPosts");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiPostControllerApi *apiInstance = [[ApiPostControllerApi alloc] init];
String *query = query_example; //  (default to null)
Integer *page = 56; //  (optional) (default to 0)
Integer *size = 56; //  (optional) (default to 10)
String *order = order_example; //  (optional) (default to creationDate)

// Search posts
[apiInstance searchPostsWith:query
    page:page
    size:size
    order:order
              completionHandler: ^(Post_PostInfo output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiPostControllerApi()
var query = query_example; // {String} 
var opts = {
  'page': 56, // {Integer} 
  'size': 56, // {Integer} 
  'order': order_example // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchPosts(query, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class searchPostsExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiPostControllerApi();
            var query = query_example;  // String |  (default to null)
            var page = 56;  // Integer |  (optional)  (default to 0)
            var size = 56;  // Integer |  (optional)  (default to 10)
            var order = order_example;  // String |  (optional)  (default to creationDate)

            try {
                // Search posts
                Post_PostInfo result = apiInstance.searchPosts(query, page, size, order);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiPostControllerApi.searchPosts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiPostControllerApi();
$query = query_example; // String | 
$page = 56; // Integer | 
$size = 56; // Integer | 
$order = order_example; // String | 

try {
    $result = $api_instance->searchPosts($query, $page, $size, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiPostControllerApi->searchPosts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiPostControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiPostControllerApi->new();
my $query = query_example; # String | 
my $page = 56; # Integer | 
my $size = 56; # Integer | 
my $order = order_example; # String | 

eval {
    my $result = $api_instance->searchPosts(query => $query, page => $page, size => $size, order => $order);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiPostControllerApi->searchPosts: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiPostControllerApi()
query = query_example # String |  (default to null)
page = 56 # Integer |  (optional) (default to 0)
size = 56 # Integer |  (optional) (default to 10)
order = order_example # String |  (optional) (default to creationDate)

try:
    # Search posts
    api_response = api_instance.search_posts(query, page=page, size=size, order=order)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiPostControllerApi->searchPosts: %s\n" % e)
extern crate ApiPostControllerApi;

pub fn main() {
    let query = query_example; // String
    let page = 56; // Integer
    let size = 56; // Integer
    let order = order_example; // String

    let mut context = ApiPostControllerApi::Context::default();
    let result = client.searchPosts(query, page, size, order, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
query*
String
Required
page
Integer (int32)
size
Integer (int32)
order
String

Responses


searchReplies

Search replies


/api/v1/replies

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://localhost:8443/api/v1/replies?criteria=criteria_example&query=query_example&page=56&size=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiPostControllerApi;

import java.io.File;
import java.util.*;

public class ApiPostControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiPostControllerApi apiInstance = new ApiPostControllerApi();
        String criteria = criteria_example; // String | 
        String query = query_example; // String | 
        Integer page = 56; // Integer | 
        Integer size = 56; // Integer | 

        try {
            Reply_ReplyInfo result = apiInstance.searchReplies(criteria, query, page, size);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiPostControllerApi#searchReplies");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiPostControllerApi;

public class ApiPostControllerApiExample {
    public static void main(String[] args) {
        ApiPostControllerApi apiInstance = new ApiPostControllerApi();
        String criteria = criteria_example; // String | 
        String query = query_example; // String | 
        Integer page = 56; // Integer | 
        Integer size = 56; // Integer | 

        try {
            Reply_ReplyInfo result = apiInstance.searchReplies(criteria, query, page, size);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiPostControllerApi#searchReplies");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiPostControllerApi *apiInstance = [[ApiPostControllerApi alloc] init];
String *criteria = criteria_example; //  (default to null)
String *query = query_example; //  (default to null)
Integer *page = 56; //  (optional) (default to 0)
Integer *size = 56; //  (optional) (default to 10)

// Search replies
[apiInstance searchRepliesWith:criteria
    query:query
    page:page
    size:size
              completionHandler: ^(Reply_ReplyInfo output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiPostControllerApi()
var criteria = criteria_example; // {String} 
var query = query_example; // {String} 
var opts = {
  'page': 56, // {Integer} 
  'size': 56 // {Integer} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchReplies(criteria, query, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class searchRepliesExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiPostControllerApi();
            var criteria = criteria_example;  // String |  (default to null)
            var query = query_example;  // String |  (default to null)
            var page = 56;  // Integer |  (optional)  (default to 0)
            var size = 56;  // Integer |  (optional)  (default to 10)

            try {
                // Search replies
                Reply_ReplyInfo result = apiInstance.searchReplies(criteria, query, page, size);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiPostControllerApi.searchReplies: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiPostControllerApi();
$criteria = criteria_example; // String | 
$query = query_example; // String | 
$page = 56; // Integer | 
$size = 56; // Integer | 

try {
    $result = $api_instance->searchReplies($criteria, $query, $page, $size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiPostControllerApi->searchReplies: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiPostControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiPostControllerApi->new();
my $criteria = criteria_example; # String | 
my $query = query_example; # String | 
my $page = 56; # Integer | 
my $size = 56; # Integer | 

eval {
    my $result = $api_instance->searchReplies(criteria => $criteria, query => $query, page => $page, size => $size);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiPostControllerApi->searchReplies: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiPostControllerApi()
criteria = criteria_example # String |  (default to null)
query = query_example # String |  (default to null)
page = 56 # Integer |  (optional) (default to 0)
size = 56 # Integer |  (optional) (default to 10)

try:
    # Search replies
    api_response = api_instance.search_replies(criteria, query, page=page, size=size)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiPostControllerApi->searchReplies: %s\n" % e)
extern crate ApiPostControllerApi;

pub fn main() {
    let criteria = criteria_example; // String
    let query = query_example; // String
    let page = 56; // Integer
    let size = 56; // Integer

    let mut context = ApiPostControllerApi::Context::default();
    let result = client.searchReplies(criteria, query, page, size, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
criteria*
String
Required
query*
String
Required
page
Integer (int32)
size
Integer (int32)

Responses


searchRepliesByPost

Search replies by post


/api/v1/posts/{postId}/replies

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://localhost:8443/api/v1/posts/{postId}/replies?criteria=criteria_example&query=query_example&page=56&size=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiPostControllerApi;

import java.io.File;
import java.util.*;

public class ApiPostControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiPostControllerApi apiInstance = new ApiPostControllerApi();
        Long postId = 789; // Long | 
        String criteria = criteria_example; // String | 
        String query = query_example; // String | 
        Integer page = 56; // Integer | 
        Integer size = 56; // Integer | 

        try {
            Reply_ReplyInfo result = apiInstance.searchRepliesByPost(postId, criteria, query, page, size);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiPostControllerApi#searchRepliesByPost");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiPostControllerApi;

public class ApiPostControllerApiExample {
    public static void main(String[] args) {
        ApiPostControllerApi apiInstance = new ApiPostControllerApi();
        Long postId = 789; // Long | 
        String criteria = criteria_example; // String | 
        String query = query_example; // String | 
        Integer page = 56; // Integer | 
        Integer size = 56; // Integer | 

        try {
            Reply_ReplyInfo result = apiInstance.searchRepliesByPost(postId, criteria, query, page, size);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiPostControllerApi#searchRepliesByPost");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiPostControllerApi *apiInstance = [[ApiPostControllerApi alloc] init];
Long *postId = 789; //  (default to null)
String *criteria = criteria_example; //  (default to null)
String *query = query_example; //  (default to null)
Integer *page = 56; //  (optional) (default to 0)
Integer *size = 56; //  (optional) (default to 10)

// Search replies by post
[apiInstance searchRepliesByPostWith:postId
    criteria:criteria
    query:query
    page:page
    size:size
              completionHandler: ^(Reply_ReplyInfo output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiPostControllerApi()
var postId = 789; // {Long} 
var criteria = criteria_example; // {String} 
var query = query_example; // {String} 
var opts = {
  'page': 56, // {Integer} 
  'size': 56 // {Integer} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchRepliesByPost(postId, criteria, query, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class searchRepliesByPostExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiPostControllerApi();
            var postId = 789;  // Long |  (default to null)
            var criteria = criteria_example;  // String |  (default to null)
            var query = query_example;  // String |  (default to null)
            var page = 56;  // Integer |  (optional)  (default to 0)
            var size = 56;  // Integer |  (optional)  (default to 10)

            try {
                // Search replies by post
                Reply_ReplyInfo result = apiInstance.searchRepliesByPost(postId, criteria, query, page, size);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiPostControllerApi.searchRepliesByPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiPostControllerApi();
$postId = 789; // Long | 
$criteria = criteria_example; // String | 
$query = query_example; // String | 
$page = 56; // Integer | 
$size = 56; // Integer | 

try {
    $result = $api_instance->searchRepliesByPost($postId, $criteria, $query, $page, $size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiPostControllerApi->searchRepliesByPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiPostControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiPostControllerApi->new();
my $postId = 789; # Long | 
my $criteria = criteria_example; # String | 
my $query = query_example; # String | 
my $page = 56; # Integer | 
my $size = 56; # Integer | 

eval {
    my $result = $api_instance->searchRepliesByPost(postId => $postId, criteria => $criteria, query => $query, page => $page, size => $size);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiPostControllerApi->searchRepliesByPost: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiPostControllerApi()
postId = 789 # Long |  (default to null)
criteria = criteria_example # String |  (default to null)
query = query_example # String |  (default to null)
page = 56 # Integer |  (optional) (default to 0)
size = 56 # Integer |  (optional) (default to 10)

try:
    # Search replies by post
    api_response = api_instance.search_replies_by_post(postId, criteria, query, page=page, size=size)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiPostControllerApi->searchRepliesByPost: %s\n" % e)
extern crate ApiPostControllerApi;

pub fn main() {
    let postId = 789; // Long
    let criteria = criteria_example; // String
    let query = query_example; // String
    let page = 56; // Integer
    let size = 56; // Integer

    let mut context = ApiPostControllerApi::Context::default();
    let result = client.searchRepliesByPost(postId, criteria, query, page, size, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
postId*
Long (int64)
Required
Query parameters
Name Description
criteria*
String
Required
query*
String
Required
page
Integer (int32)
size
Integer (int32)

Responses


updatePostImage

Update post image


/api/v1/posts/{postId}/pictures

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://localhost:8443/api/v1/posts/{postId}/pictures?action=action_example" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiPostControllerApi;

import java.io.File;
import java.util.*;

public class ApiPostControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiPostControllerApi apiInstance = new ApiPostControllerApi();
        Long postId = 789; // Long | 
        String action = action_example; // String | 
        InlineObject1 inlineObject1 = ; // InlineObject1 | 

        try {
            Post_PostInfo result = apiInstance.updatePostImage(postId, action, inlineObject1);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiPostControllerApi#updatePostImage");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiPostControllerApi;

public class ApiPostControllerApiExample {
    public static void main(String[] args) {
        ApiPostControllerApi apiInstance = new ApiPostControllerApi();
        Long postId = 789; // Long | 
        String action = action_example; // String | 
        InlineObject1 inlineObject1 = ; // InlineObject1 | 

        try {
            Post_PostInfo result = apiInstance.updatePostImage(postId, action, inlineObject1);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiPostControllerApi#updatePostImage");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiPostControllerApi *apiInstance = [[ApiPostControllerApi alloc] init];
Long *postId = 789; //  (default to null)
String *action = action_example; //  (optional) (default to null)
InlineObject1 *inlineObject1 = ; //  (optional)

// Update post image
[apiInstance updatePostImageWith:postId
    action:action
    inlineObject1:inlineObject1
              completionHandler: ^(Post_PostInfo output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiPostControllerApi()
var postId = 789; // {Long} 
var opts = {
  'action': action_example, // {String} 
  'inlineObject1':  // {InlineObject1} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updatePostImage(postId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class updatePostImageExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiPostControllerApi();
            var postId = 789;  // Long |  (default to null)
            var action = action_example;  // String |  (optional)  (default to null)
            var inlineObject1 = new InlineObject1(); // InlineObject1 |  (optional) 

            try {
                // Update post image
                Post_PostInfo result = apiInstance.updatePostImage(postId, action, inlineObject1);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiPostControllerApi.updatePostImage: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiPostControllerApi();
$postId = 789; // Long | 
$action = action_example; // String | 
$inlineObject1 = ; // InlineObject1 | 

try {
    $result = $api_instance->updatePostImage($postId, $action, $inlineObject1);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiPostControllerApi->updatePostImage: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiPostControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiPostControllerApi->new();
my $postId = 789; # Long | 
my $action = action_example; # String | 
my $inlineObject1 = WWW::OPenAPIClient::Object::InlineObject1->new(); # InlineObject1 | 

eval {
    my $result = $api_instance->updatePostImage(postId => $postId, action => $action, inlineObject1 => $inlineObject1);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiPostControllerApi->updatePostImage: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiPostControllerApi()
postId = 789 # Long |  (default to null)
action = action_example # String |  (optional) (default to null)
inlineObject1 =  # InlineObject1 |  (optional)

try:
    # Update post image
    api_response = api_instance.update_post_image(postId, action=action, inlineObject1=inlineObject1)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiPostControllerApi->updatePostImage: %s\n" % e)
extern crate ApiPostControllerApi;

pub fn main() {
    let postId = 789; // Long
    let action = action_example; // String
    let inlineObject1 = ; // InlineObject1

    let mut context = ApiPostControllerApi::Context::default();
    let result = client.updatePostImage(postId, action, inlineObject1, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
postId*
Long (int64)
Required
Body parameters
Name Description
inlineObject1

Query parameters
Name Description
action
String

Responses


ApiSessionController

login

Login


/api/v1/login

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json,*/*" \
 -H "Content-Type: application/json" \
 "https://localhost:8443/api/v1/login" \
 -d '{
  "password" : "password",
  "username" : "username"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiSessionControllerApi;

import java.io.File;
import java.util.*;

public class ApiSessionControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiSessionControllerApi apiInstance = new ApiSessionControllerApi();
        LoginRequest loginRequest = ; // LoginRequest | 
        String accessToken = accessToken_example; // String | 
        String refreshToken = refreshToken_example; // String | 

        try {
            AuthResponse result = apiInstance.login(loginRequest, accessToken, refreshToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiSessionControllerApi#login");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiSessionControllerApi;

public class ApiSessionControllerApiExample {
    public static void main(String[] args) {
        ApiSessionControllerApi apiInstance = new ApiSessionControllerApi();
        LoginRequest loginRequest = ; // LoginRequest | 
        String accessToken = accessToken_example; // String | 
        String refreshToken = refreshToken_example; // String | 

        try {
            AuthResponse result = apiInstance.login(loginRequest, accessToken, refreshToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiSessionControllerApi#login");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiSessionControllerApi *apiInstance = [[ApiSessionControllerApi alloc] init];
LoginRequest *loginRequest = ; // 
String *accessToken = accessToken_example; //  (optional) (default to null)
String *refreshToken = refreshToken_example; //  (optional) (default to null)

// Login
[apiInstance loginWith:loginRequest
    accessToken:accessToken
    refreshToken:refreshToken
              completionHandler: ^(AuthResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiSessionControllerApi()
var loginRequest = ; // {LoginRequest} 
var opts = {
  'accessToken': accessToken_example, // {String} 
  'refreshToken': refreshToken_example // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.login(loginRequest, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class loginExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiSessionControllerApi();
            var loginRequest = new LoginRequest(); // LoginRequest | 
            var accessToken = accessToken_example;  // String |  (optional)  (default to null)
            var refreshToken = refreshToken_example;  // String |  (optional)  (default to null)

            try {
                // Login
                AuthResponse result = apiInstance.login(loginRequest, accessToken, refreshToken);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiSessionControllerApi.login: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiSessionControllerApi();
$loginRequest = ; // LoginRequest | 
$accessToken = accessToken_example; // String | 
$refreshToken = refreshToken_example; // String | 

try {
    $result = $api_instance->login($loginRequest, $accessToken, $refreshToken);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiSessionControllerApi->login: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiSessionControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiSessionControllerApi->new();
my $loginRequest = WWW::OPenAPIClient::Object::LoginRequest->new(); # LoginRequest | 
my $accessToken = accessToken_example; # String | 
my $refreshToken = refreshToken_example; # String | 

eval {
    my $result = $api_instance->login(loginRequest => $loginRequest, accessToken => $accessToken, refreshToken => $refreshToken);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiSessionControllerApi->login: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiSessionControllerApi()
loginRequest =  # LoginRequest | 
accessToken = accessToken_example # String |  (optional) (default to null)
refreshToken = refreshToken_example # String |  (optional) (default to null)

try:
    # Login
    api_response = api_instance.login(loginRequest, accessToken=accessToken, refreshToken=refreshToken)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiSessionControllerApi->login: %s\n" % e)
extern crate ApiSessionControllerApi;

pub fn main() {
    let loginRequest = ; // LoginRequest
    let accessToken = accessToken_example; // String
    let refreshToken = refreshToken_example; // String

    let mut context = ApiSessionControllerApi::Context::default();
    let result = client.login(loginRequest, accessToken, refreshToken, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
loginRequest *

Responses


logout

Logout


/api/v1/logout

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 "https://localhost:8443/api/v1/logout"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiSessionControllerApi;

import java.io.File;
import java.util.*;

public class ApiSessionControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiSessionControllerApi apiInstance = new ApiSessionControllerApi();

        try {
            AuthResponse result = apiInstance.logout();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiSessionControllerApi#logout");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiSessionControllerApi;

public class ApiSessionControllerApiExample {
    public static void main(String[] args) {
        ApiSessionControllerApi apiInstance = new ApiSessionControllerApi();

        try {
            AuthResponse result = apiInstance.logout();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiSessionControllerApi#logout");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiSessionControllerApi *apiInstance = [[ApiSessionControllerApi alloc] init];

// Logout
[apiInstance logoutWithCompletionHandler: 
              ^(AuthResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiSessionControllerApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.logout(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class logoutExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiSessionControllerApi();

            try {
                // Logout
                AuthResponse result = apiInstance.logout();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiSessionControllerApi.logout: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiSessionControllerApi();

try {
    $result = $api_instance->logout();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiSessionControllerApi->logout: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiSessionControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiSessionControllerApi->new();

eval {
    my $result = $api_instance->logout();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiSessionControllerApi->logout: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiSessionControllerApi()

try:
    # Logout
    api_response = api_instance.logout()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiSessionControllerApi->logout: %s\n" % e)
extern crate ApiSessionControllerApi;

pub fn main() {

    let mut context = ApiSessionControllerApi::Context::default();
    let result = client.logout(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


refreshToken

Refresh token


/api/v1/refresh

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json,*/*" \
 "https://localhost:8443/api/v1/refresh"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiSessionControllerApi;

import java.io.File;
import java.util.*;

public class ApiSessionControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiSessionControllerApi apiInstance = new ApiSessionControllerApi();
        String refreshToken = refreshToken_example; // String | 

        try {
            AuthResponse result = apiInstance.refreshToken(refreshToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiSessionControllerApi#refreshToken");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiSessionControllerApi;

public class ApiSessionControllerApiExample {
    public static void main(String[] args) {
        ApiSessionControllerApi apiInstance = new ApiSessionControllerApi();
        String refreshToken = refreshToken_example; // String | 

        try {
            AuthResponse result = apiInstance.refreshToken(refreshToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiSessionControllerApi#refreshToken");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiSessionControllerApi *apiInstance = [[ApiSessionControllerApi alloc] init];
String *refreshToken = refreshToken_example; //  (optional) (default to null)

// Refresh token
[apiInstance refreshTokenWith:refreshToken
              completionHandler: ^(AuthResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiSessionControllerApi()
var opts = {
  'refreshToken': refreshToken_example // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.refreshToken(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class refreshTokenExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiSessionControllerApi();
            var refreshToken = refreshToken_example;  // String |  (optional)  (default to null)

            try {
                // Refresh token
                AuthResponse result = apiInstance.refreshToken(refreshToken);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiSessionControllerApi.refreshToken: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiSessionControllerApi();
$refreshToken = refreshToken_example; // String | 

try {
    $result = $api_instance->refreshToken($refreshToken);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiSessionControllerApi->refreshToken: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiSessionControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiSessionControllerApi->new();
my $refreshToken = refreshToken_example; # String | 

eval {
    my $result = $api_instance->refreshToken(refreshToken => $refreshToken);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiSessionControllerApi->refreshToken: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiSessionControllerApi()
refreshToken = refreshToken_example # String |  (optional) (default to null)

try:
    # Refresh token
    api_response = api_instance.refresh_token(refreshToken=refreshToken)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiSessionControllerApi->refreshToken: %s\n" % e)
extern crate ApiSessionControllerApi;

pub fn main() {
    let refreshToken = refreshToken_example; // String

    let mut context = ApiSessionControllerApi::Context::default();
    let result = client.refreshToken(refreshToken, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


test

Test operation


/api/v1/test

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://localhost:8443/api/v1/test"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiSessionControllerApi;

import java.io.File;
import java.util.*;

public class ApiSessionControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiSessionControllerApi apiInstance = new ApiSessionControllerApi();

        try {
            AuthResponse result = apiInstance.test();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiSessionControllerApi#test");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiSessionControllerApi;

public class ApiSessionControllerApiExample {
    public static void main(String[] args) {
        ApiSessionControllerApi apiInstance = new ApiSessionControllerApi();

        try {
            AuthResponse result = apiInstance.test();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiSessionControllerApi#test");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiSessionControllerApi *apiInstance = [[ApiSessionControllerApi alloc] init];

// Test operation
[apiInstance testWithCompletionHandler: 
              ^(AuthResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiSessionControllerApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.test(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class testExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiSessionControllerApi();

            try {
                // Test operation
                AuthResponse result = apiInstance.test();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiSessionControllerApi.test: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiSessionControllerApi();

try {
    $result = $api_instance->test();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiSessionControllerApi->test: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiSessionControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiSessionControllerApi->new();

eval {
    my $result = $api_instance->test();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiSessionControllerApi->test: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiSessionControllerApi()

try:
    # Test operation
    api_response = api_instance.test()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiSessionControllerApi->test: %s\n" % e)
extern crate ApiSessionControllerApi;

pub fn main() {

    let mut context = ApiSessionControllerApi::Context::default();
    let result = client.test(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


ApiUserController

changeProfilePicture

Change user's profile picture


/api/v1/users/{username}/pictures

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://localhost:8443/api/v1/users/{username}/pictures" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiUserControllerApi;

import java.io.File;
import java.util.*;

public class ApiUserControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiUserControllerApi apiInstance = new ApiUserControllerApi();
        String username = username_example; // String | 
        InlineObject inlineObject = ; // InlineObject | 

        try {
            User_UserBasicView result = apiInstance.changeProfilePicture(username, inlineObject);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiUserControllerApi#changeProfilePicture");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiUserControllerApi;

public class ApiUserControllerApiExample {
    public static void main(String[] args) {
        ApiUserControllerApi apiInstance = new ApiUserControllerApi();
        String username = username_example; // String | 
        InlineObject inlineObject = ; // InlineObject | 

        try {
            User_UserBasicView result = apiInstance.changeProfilePicture(username, inlineObject);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiUserControllerApi#changeProfilePicture");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiUserControllerApi *apiInstance = [[ApiUserControllerApi alloc] init];
String *username = username_example; //  (default to null)
InlineObject *inlineObject = ; //  (optional)

// Change user's profile picture
[apiInstance changeProfilePictureWith:username
    inlineObject:inlineObject
              completionHandler: ^(User_UserBasicView output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiUserControllerApi()
var username = username_example; // {String} 
var opts = {
  'inlineObject':  // {InlineObject} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.changeProfilePicture(username, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class changeProfilePictureExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiUserControllerApi();
            var username = username_example;  // String |  (default to null)
            var inlineObject = new InlineObject(); // InlineObject |  (optional) 

            try {
                // Change user's profile picture
                User_UserBasicView result = apiInstance.changeProfilePicture(username, inlineObject);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiUserControllerApi.changeProfilePicture: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiUserControllerApi();
$username = username_example; // String | 
$inlineObject = ; // InlineObject | 

try {
    $result = $api_instance->changeProfilePicture($username, $inlineObject);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiUserControllerApi->changeProfilePicture: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiUserControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiUserControllerApi->new();
my $username = username_example; # String | 
my $inlineObject = WWW::OPenAPIClient::Object::InlineObject->new(); # InlineObject | 

eval {
    my $result = $api_instance->changeProfilePicture(username => $username, inlineObject => $inlineObject);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiUserControllerApi->changeProfilePicture: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiUserControllerApi()
username = username_example # String |  (default to null)
inlineObject =  # InlineObject |  (optional)

try:
    # Change user's profile picture
    api_response = api_instance.change_profile_picture(username, inlineObject=inlineObject)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiUserControllerApi->changeProfilePicture: %s\n" % e)
extern crate ApiUserControllerApi;

pub fn main() {
    let username = username_example; // String
    let inlineObject = ; // InlineObject

    let mut context = ApiUserControllerApi::Context::default();
    let result = client.changeProfilePicture(username, inlineObject, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
username*
String
Required
Body parameters
Name Description
inlineObject

Responses


deleteUser

Delete user


/api/v1/users/{username}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: */*" \
 "https://localhost:8443/api/v1/users/{username}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiUserControllerApi;

import java.io.File;
import java.util.*;

public class ApiUserControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiUserControllerApi apiInstance = new ApiUserControllerApi();
        String username = username_example; // String | 

        try {
            'String' result = apiInstance.deleteUser(username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiUserControllerApi#deleteUser");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiUserControllerApi;

public class ApiUserControllerApiExample {
    public static void main(String[] args) {
        ApiUserControllerApi apiInstance = new ApiUserControllerApi();
        String username = username_example; // String | 

        try {
            'String' result = apiInstance.deleteUser(username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiUserControllerApi#deleteUser");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiUserControllerApi *apiInstance = [[ApiUserControllerApi alloc] init];
String *username = username_example; //  (default to null)

// Delete user
[apiInstance deleteUserWith:username
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiUserControllerApi()
var username = username_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteUser(username, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteUserExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiUserControllerApi();
            var username = username_example;  // String |  (default to null)

            try {
                // Delete user
                'String' result = apiInstance.deleteUser(username);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiUserControllerApi.deleteUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiUserControllerApi();
$username = username_example; // String | 

try {
    $result = $api_instance->deleteUser($username);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiUserControllerApi->deleteUser: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiUserControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiUserControllerApi->new();
my $username = username_example; # String | 

eval {
    my $result = $api_instance->deleteUser(username => $username);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiUserControllerApi->deleteUser: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiUserControllerApi()
username = username_example # String |  (default to null)

try:
    # Delete user
    api_response = api_instance.delete_user(username)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiUserControllerApi->deleteUser: %s\n" % e)
extern crate ApiUserControllerApi;

pub fn main() {
    let username = username_example; // String

    let mut context = ApiUserControllerApi::Context::default();
    let result = client.deleteUser(username, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
username*
String
Required

Responses


disableUser

Disable a user account


/api/v1/users/{username}/disable

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 "https://localhost:8443/api/v1/users/{username}/disable?duration=duration_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiUserControllerApi;

import java.io.File;
import java.util.*;

public class ApiUserControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiUserControllerApi apiInstance = new ApiUserControllerApi();
        String username = username_example; // String | 
        String duration = duration_example; // String | 

        try {
            User_BanInfo result = apiInstance.disableUser(username, duration);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiUserControllerApi#disableUser");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiUserControllerApi;

public class ApiUserControllerApiExample {
    public static void main(String[] args) {
        ApiUserControllerApi apiInstance = new ApiUserControllerApi();
        String username = username_example; // String | 
        String duration = duration_example; // String | 

        try {
            User_BanInfo result = apiInstance.disableUser(username, duration);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiUserControllerApi#disableUser");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiUserControllerApi *apiInstance = [[ApiUserControllerApi alloc] init];
String *username = username_example; //  (default to null)
String *duration = duration_example; //  (default to null)

// Disable a user account
[apiInstance disableUserWith:username
    duration:duration
              completionHandler: ^(User_BanInfo output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiUserControllerApi()
var username = username_example; // {String} 
var duration = duration_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.disableUser(username, duration, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class disableUserExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiUserControllerApi();
            var username = username_example;  // String |  (default to null)
            var duration = duration_example;  // String |  (default to null)

            try {
                // Disable a user account
                User_BanInfo result = apiInstance.disableUser(username, duration);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiUserControllerApi.disableUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiUserControllerApi();
$username = username_example; // String | 
$duration = duration_example; // String | 

try {
    $result = $api_instance->disableUser($username, $duration);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiUserControllerApi->disableUser: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiUserControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiUserControllerApi->new();
my $username = username_example; # String | 
my $duration = duration_example; # String | 

eval {
    my $result = $api_instance->disableUser(username => $username, duration => $duration);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiUserControllerApi->disableUser: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiUserControllerApi()
username = username_example # String |  (default to null)
duration = duration_example # String |  (default to null)

try:
    # Disable a user account
    api_response = api_instance.disable_user(username, duration)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiUserControllerApi->disableUser: %s\n" % e)
extern crate ApiUserControllerApi;

pub fn main() {
    let username = username_example; // String
    let duration = duration_example; // String

    let mut context = ApiUserControllerApi::Context::default();
    let result = client.disableUser(username, duration, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
username*
String
Required
Query parameters
Name Description
duration*
String
Required

Responses


enableUser

Enable a user account


/api/v1/users/{username}/enable

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 "https://localhost:8443/api/v1/users/{username}/enable"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiUserControllerApi;

import java.io.File;
import java.util.*;

public class ApiUserControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiUserControllerApi apiInstance = new ApiUserControllerApi();
        String username = username_example; // String | 

        try {
            User_BanInfo result = apiInstance.enableUser(username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiUserControllerApi#enableUser");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiUserControllerApi;

public class ApiUserControllerApiExample {
    public static void main(String[] args) {
        ApiUserControllerApi apiInstance = new ApiUserControllerApi();
        String username = username_example; // String | 

        try {
            User_BanInfo result = apiInstance.enableUser(username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiUserControllerApi#enableUser");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiUserControllerApi *apiInstance = [[ApiUserControllerApi alloc] init];
String *username = username_example; //  (default to null)

// Enable a user account
[apiInstance enableUserWith:username
              completionHandler: ^(User_BanInfo output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiUserControllerApi()
var username = username_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.enableUser(username, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class enableUserExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiUserControllerApi();
            var username = username_example;  // String |  (default to null)

            try {
                // Enable a user account
                User_BanInfo result = apiInstance.enableUser(username);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiUserControllerApi.enableUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiUserControllerApi();
$username = username_example; // String | 

try {
    $result = $api_instance->enableUser($username);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiUserControllerApi->enableUser: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiUserControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiUserControllerApi->new();
my $username = username_example; # String | 

eval {
    my $result = $api_instance->enableUser(username => $username);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiUserControllerApi->enableUser: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiUserControllerApi()
username = username_example # String |  (default to null)

try:
    # Enable a user account
    api_response = api_instance.enable_user(username)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiUserControllerApi->enableUser: %s\n" % e)
extern crate ApiUserControllerApi;

pub fn main() {
    let username = username_example; // String

    let mut context = ApiUserControllerApi::Context::default();
    let result = client.enableUser(username, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
username*
String
Required

Responses


getCurrentUser

Get current user


/api/v1/users/me

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://localhost:8443/api/v1/users/me"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiUserControllerApi;

import java.io.File;
import java.util.*;

public class ApiUserControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiUserControllerApi apiInstance = new ApiUserControllerApi();

        try {
            User_UserBasicView result = apiInstance.getCurrentUser();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiUserControllerApi#getCurrentUser");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiUserControllerApi;

public class ApiUserControllerApiExample {
    public static void main(String[] args) {
        ApiUserControllerApi apiInstance = new ApiUserControllerApi();

        try {
            User_UserBasicView result = apiInstance.getCurrentUser();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiUserControllerApi#getCurrentUser");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiUserControllerApi *apiInstance = [[ApiUserControllerApi alloc] init];

// Get current user
[apiInstance getCurrentUserWithCompletionHandler: 
              ^(User_UserBasicView output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiUserControllerApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCurrentUser(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getCurrentUserExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiUserControllerApi();

            try {
                // Get current user
                User_UserBasicView result = apiInstance.getCurrentUser();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiUserControllerApi.getCurrentUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiUserControllerApi();

try {
    $result = $api_instance->getCurrentUser();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiUserControllerApi->getCurrentUser: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiUserControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiUserControllerApi->new();

eval {
    my $result = $api_instance->getCurrentUser();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiUserControllerApi->getCurrentUser: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiUserControllerApi()

try:
    # Get current user
    api_response = api_instance.get_current_user()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiUserControllerApi->getCurrentUser: %s\n" % e)
extern crate ApiUserControllerApi;

pub fn main() {

    let mut context = ApiUserControllerApi::Context::default();
    let result = client.getCurrentUser(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getMostBannedUsers

Get users with most bans


/api/v1/users/most-banned

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://localhost:8443/api/v1/users/most-banned?size=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiUserControllerApi;

import java.io.File;
import java.util.*;

public class ApiUserControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiUserControllerApi apiInstance = new ApiUserControllerApi();
        Integer size = 56; // Integer | 

        try {
            User_UserBasicView result = apiInstance.getMostBannedUsers(size);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiUserControllerApi#getMostBannedUsers");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiUserControllerApi;

public class ApiUserControllerApiExample {
    public static void main(String[] args) {
        ApiUserControllerApi apiInstance = new ApiUserControllerApi();
        Integer size = 56; // Integer | 

        try {
            User_UserBasicView result = apiInstance.getMostBannedUsers(size);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiUserControllerApi#getMostBannedUsers");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiUserControllerApi *apiInstance = [[ApiUserControllerApi alloc] init];
Integer *size = 56; //  (optional) (default to 10)

// Get users with most bans
[apiInstance getMostBannedUsersWith:size
              completionHandler: ^(User_UserBasicView output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiUserControllerApi()
var opts = {
  'size': 56 // {Integer} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMostBannedUsers(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getMostBannedUsersExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiUserControllerApi();
            var size = 56;  // Integer |  (optional)  (default to 10)

            try {
                // Get users with most bans
                User_UserBasicView result = apiInstance.getMostBannedUsers(size);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiUserControllerApi.getMostBannedUsers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiUserControllerApi();
$size = 56; // Integer | 

try {
    $result = $api_instance->getMostBannedUsers($size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiUserControllerApi->getMostBannedUsers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiUserControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiUserControllerApi->new();
my $size = 56; # Integer | 

eval {
    my $result = $api_instance->getMostBannedUsers(size => $size);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiUserControllerApi->getMostBannedUsers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiUserControllerApi()
size = 56 # Integer |  (optional) (default to 10)

try:
    # Get users with most bans
    api_response = api_instance.get_most_banned_users(size=size)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiUserControllerApi->getMostBannedUsers: %s\n" % e)
extern crate ApiUserControllerApi;

pub fn main() {
    let size = 56; // Integer

    let mut context = ApiUserControllerApi::Context::default();
    let result = client.getMostBannedUsers(size, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
size
Integer (int32)

Responses


getMostDislikedUsers

Get users with most dislikes


/api/v1/users/most-disliked

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://localhost:8443/api/v1/users/most-disliked?size=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiUserControllerApi;

import java.io.File;
import java.util.*;

public class ApiUserControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiUserControllerApi apiInstance = new ApiUserControllerApi();
        Integer size = 56; // Integer | 

        try {
            User_UserBasicView result = apiInstance.getMostDislikedUsers(size);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiUserControllerApi#getMostDislikedUsers");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiUserControllerApi;

public class ApiUserControllerApiExample {
    public static void main(String[] args) {
        ApiUserControllerApi apiInstance = new ApiUserControllerApi();
        Integer size = 56; // Integer | 

        try {
            User_UserBasicView result = apiInstance.getMostDislikedUsers(size);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiUserControllerApi#getMostDislikedUsers");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiUserControllerApi *apiInstance = [[ApiUserControllerApi alloc] init];
Integer *size = 56; //  (optional) (default to 10)

// Get users with most dislikes
[apiInstance getMostDislikedUsersWith:size
              completionHandler: ^(User_UserBasicView output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiUserControllerApi()
var opts = {
  'size': 56 // {Integer} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMostDislikedUsers(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getMostDislikedUsersExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiUserControllerApi();
            var size = 56;  // Integer |  (optional)  (default to 10)

            try {
                // Get users with most dislikes
                User_UserBasicView result = apiInstance.getMostDislikedUsers(size);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiUserControllerApi.getMostDislikedUsers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiUserControllerApi();
$size = 56; // Integer | 

try {
    $result = $api_instance->getMostDislikedUsers($size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiUserControllerApi->getMostDislikedUsers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiUserControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiUserControllerApi->new();
my $size = 56; # Integer | 

eval {
    my $result = $api_instance->getMostDislikedUsers(size => $size);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiUserControllerApi->getMostDislikedUsers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiUserControllerApi()
size = 56 # Integer |  (optional) (default to 10)

try:
    # Get users with most dislikes
    api_response = api_instance.get_most_disliked_users(size=size)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiUserControllerApi->getMostDislikedUsers: %s\n" % e)
extern crate ApiUserControllerApi;

pub fn main() {
    let size = 56; // Integer

    let mut context = ApiUserControllerApi::Context::default();
    let result = client.getMostDislikedUsers(size, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
size
Integer (int32)

Responses


getMostPopularUsers

Get users with the most liked posts


/api/v1/users/most-popular

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://localhost:8443/api/v1/users/most-popular?size=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiUserControllerApi;

import java.io.File;
import java.util.*;

public class ApiUserControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiUserControllerApi apiInstance = new ApiUserControllerApi();
        Integer size = 56; // Integer | 

        try {
            User_UserBasicView result = apiInstance.getMostPopularUsers(size);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiUserControllerApi#getMostPopularUsers");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiUserControllerApi;

public class ApiUserControllerApiExample {
    public static void main(String[] args) {
        ApiUserControllerApi apiInstance = new ApiUserControllerApi();
        Integer size = 56; // Integer | 

        try {
            User_UserBasicView result = apiInstance.getMostPopularUsers(size);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiUserControllerApi#getMostPopularUsers");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiUserControllerApi *apiInstance = [[ApiUserControllerApi alloc] init];
Integer *size = 56; //  (optional) (default to 10)

// Get users with the most liked posts
[apiInstance getMostPopularUsersWith:size
              completionHandler: ^(User_UserBasicView output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiUserControllerApi()
var opts = {
  'size': 56 // {Integer} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMostPopularUsers(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getMostPopularUsersExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiUserControllerApi();
            var size = 56;  // Integer |  (optional)  (default to 10)

            try {
                // Get users with the most liked posts
                User_UserBasicView result = apiInstance.getMostPopularUsers(size);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiUserControllerApi.getMostPopularUsers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiUserControllerApi();
$size = 56; // Integer | 

try {
    $result = $api_instance->getMostPopularUsers($size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiUserControllerApi->getMostPopularUsers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiUserControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiUserControllerApi->new();
my $size = 56; # Integer | 

eval {
    my $result = $api_instance->getMostPopularUsers(size => $size);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiUserControllerApi->getMostPopularUsers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiUserControllerApi()
size = 56 # Integer |  (optional) (default to 10)

try:
    # Get users with the most liked posts
    api_response = api_instance.get_most_popular_users(size=size)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiUserControllerApi->getMostPopularUsers: %s\n" % e)
extern crate ApiUserControllerApi;

pub fn main() {
    let size = 56; // Integer

    let mut context = ApiUserControllerApi::Context::default();
    let result = client.getMostPopularUsers(size, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
size
Integer (int32)

Responses


getProfilePicture

Get user's profile picture


/api/v1/users/{username}/pictures

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://localhost:8443/api/v1/users/{username}/pictures"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiUserControllerApi;

import java.io.File;
import java.util.*;

public class ApiUserControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiUserControllerApi apiInstance = new ApiUserControllerApi();
        String username = username_example; // String | 

        try {
            User result = apiInstance.getProfilePicture(username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiUserControllerApi#getProfilePicture");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiUserControllerApi;

public class ApiUserControllerApiExample {
    public static void main(String[] args) {
        ApiUserControllerApi apiInstance = new ApiUserControllerApi();
        String username = username_example; // String | 

        try {
            User result = apiInstance.getProfilePicture(username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiUserControllerApi#getProfilePicture");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiUserControllerApi *apiInstance = [[ApiUserControllerApi alloc] init];
String *username = username_example; //  (default to null)

// Get user's profile picture
[apiInstance getProfilePictureWith:username
              completionHandler: ^(User output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiUserControllerApi()
var username = username_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getProfilePicture(username, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getProfilePictureExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiUserControllerApi();
            var username = username_example;  // String |  (default to null)

            try {
                // Get user's profile picture
                User result = apiInstance.getProfilePicture(username);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiUserControllerApi.getProfilePicture: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiUserControllerApi();
$username = username_example; // String | 

try {
    $result = $api_instance->getProfilePicture($username);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiUserControllerApi->getProfilePicture: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiUserControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiUserControllerApi->new();
my $username = username_example; # String | 

eval {
    my $result = $api_instance->getProfilePicture(username => $username);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiUserControllerApi->getProfilePicture: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiUserControllerApi()
username = username_example # String |  (default to null)

try:
    # Get user's profile picture
    api_response = api_instance.get_profile_picture(username)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiUserControllerApi->getProfilePicture: %s\n" % e)
extern crate ApiUserControllerApi;

pub fn main() {
    let username = username_example; // String

    let mut context = ApiUserControllerApi::Context::default();
    let result = client.getProfilePicture(username, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
username*
String
Required

Responses


getUser

Get user by username or email


/api/v1/users/{username}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://localhost:8443/api/v1/users/{username}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiUserControllerApi;

import java.io.File;
import java.util.*;

public class ApiUserControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiUserControllerApi apiInstance = new ApiUserControllerApi();
        String username = username_example; // String | 

        try {
            User_UserBasicView result = apiInstance.getUser(username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiUserControllerApi#getUser");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiUserControllerApi;

public class ApiUserControllerApiExample {
    public static void main(String[] args) {
        ApiUserControllerApi apiInstance = new ApiUserControllerApi();
        String username = username_example; // String | 

        try {
            User_UserBasicView result = apiInstance.getUser(username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiUserControllerApi#getUser");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiUserControllerApi *apiInstance = [[ApiUserControllerApi alloc] init];
String *username = username_example; //  (default to null)

// Get user by username or email
[apiInstance getUserWith:username
              completionHandler: ^(User_UserBasicView output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiUserControllerApi()
var username = username_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUser(username, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getUserExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiUserControllerApi();
            var username = username_example;  // String |  (default to null)

            try {
                // Get user by username or email
                User_UserBasicView result = apiInstance.getUser(username);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiUserControllerApi.getUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiUserControllerApi();
$username = username_example; // String | 

try {
    $result = $api_instance->getUser($username);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiUserControllerApi->getUser: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiUserControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiUserControllerApi->new();
my $username = username_example; # String | 

eval {
    my $result = $api_instance->getUser(username => $username);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiUserControllerApi->getUser: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiUserControllerApi()
username = username_example # String |  (default to null)

try:
    # Get user by username or email
    api_response = api_instance.get_user(username)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiUserControllerApi->getUser: %s\n" % e)
extern crate ApiUserControllerApi;

pub fn main() {
    let username = username_example; // String

    let mut context = ApiUserControllerApi::Context::default();
    let result = client.getUser(username, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
username*
String
Required

Responses


getUserCommunities

Get user's communities list (pageable). If admin=true, returns the communities the user is an admin of


/api/v1/users/{username}/communities

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://localhost:8443/api/v1/users/{username}/communities?admin=true&page=56&size=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiUserControllerApi;

import java.io.File;
import java.util.*;

public class ApiUserControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiUserControllerApi apiInstance = new ApiUserControllerApi();
        String username = username_example; // String | 
        Boolean admin = true; // Boolean | 
        Integer page = 56; // Integer | 
        Integer size = 56; // Integer | 

        try {
            Community_CommunitiesBasicView result = apiInstance.getUserCommunities(username, admin, page, size);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiUserControllerApi#getUserCommunities");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiUserControllerApi;

public class ApiUserControllerApiExample {
    public static void main(String[] args) {
        ApiUserControllerApi apiInstance = new ApiUserControllerApi();
        String username = username_example; // String | 
        Boolean admin = true; // Boolean | 
        Integer page = 56; // Integer | 
        Integer size = 56; // Integer | 

        try {
            Community_CommunitiesBasicView result = apiInstance.getUserCommunities(username, admin, page, size);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiUserControllerApi#getUserCommunities");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiUserControllerApi *apiInstance = [[ApiUserControllerApi alloc] init];
String *username = username_example; //  (default to null)
Boolean *admin = true; //  (optional) (default to false)
Integer *page = 56; //  (optional) (default to 0)
Integer *size = 56; //  (optional) (default to 10)

// Get user's communities list (pageable). If admin=true, returns the communities the user is an admin of
[apiInstance getUserCommunitiesWith:username
    admin:admin
    page:page
    size:size
              completionHandler: ^(Community_CommunitiesBasicView output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiUserControllerApi()
var username = username_example; // {String} 
var opts = {
  'admin': true, // {Boolean} 
  'page': 56, // {Integer} 
  'size': 56 // {Integer} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUserCommunities(username, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getUserCommunitiesExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiUserControllerApi();
            var username = username_example;  // String |  (default to null)
            var admin = true;  // Boolean |  (optional)  (default to false)
            var page = 56;  // Integer |  (optional)  (default to 0)
            var size = 56;  // Integer |  (optional)  (default to 10)

            try {
                // Get user's communities list (pageable). If admin=true, returns the communities the user is an admin of
                Community_CommunitiesBasicView result = apiInstance.getUserCommunities(username, admin, page, size);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiUserControllerApi.getUserCommunities: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiUserControllerApi();
$username = username_example; // String | 
$admin = true; // Boolean | 
$page = 56; // Integer | 
$size = 56; // Integer | 

try {
    $result = $api_instance->getUserCommunities($username, $admin, $page, $size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiUserControllerApi->getUserCommunities: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiUserControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiUserControllerApi->new();
my $username = username_example; # String | 
my $admin = true; # Boolean | 
my $page = 56; # Integer | 
my $size = 56; # Integer | 

eval {
    my $result = $api_instance->getUserCommunities(username => $username, admin => $admin, page => $page, size => $size);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiUserControllerApi->getUserCommunities: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiUserControllerApi()
username = username_example # String |  (default to null)
admin = true # Boolean |  (optional) (default to false)
page = 56 # Integer |  (optional) (default to 0)
size = 56 # Integer |  (optional) (default to 10)

try:
    # Get user's communities list (pageable). If admin=true, returns the communities the user is an admin of
    api_response = api_instance.get_user_communities(username, admin=admin, page=page, size=size)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiUserControllerApi->getUserCommunities: %s\n" % e)
extern crate ApiUserControllerApi;

pub fn main() {
    let username = username_example; // String
    let admin = true; // Boolean
    let page = 56; // Integer
    let size = 56; // Integer

    let mut context = ApiUserControllerApi::Context::default();
    let result = client.getUserCommunities(username, admin, page, size, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
username*
String
Required
Query parameters
Name Description
admin
Boolean
page
Integer (int32)
size
Integer (int32)

Responses


getUserCommunitiesCount

Get the number of communities a user is a member of. If admin=true, returns the number of communities the user is an admin of


/api/v1/users/{username}/communities/count

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://localhost:8443/api/v1/users/{username}/communities/count?admin=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiUserControllerApi;

import java.io.File;
import java.util.*;

public class ApiUserControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiUserControllerApi apiInstance = new ApiUserControllerApi();
        String username = username_example; // String | 
        Boolean admin = true; // Boolean | 

        try {
            'Integer' result = apiInstance.getUserCommunitiesCount(username, admin);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiUserControllerApi#getUserCommunitiesCount");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiUserControllerApi;

public class ApiUserControllerApiExample {
    public static void main(String[] args) {
        ApiUserControllerApi apiInstance = new ApiUserControllerApi();
        String username = username_example; // String | 
        Boolean admin = true; // Boolean | 

        try {
            'Integer' result = apiInstance.getUserCommunitiesCount(username, admin);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiUserControllerApi#getUserCommunitiesCount");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiUserControllerApi *apiInstance = [[ApiUserControllerApi alloc] init];
String *username = username_example; //  (default to null)
Boolean *admin = true; //  (optional) (default to null)

// Get the number of communities a user is a member of. If admin=true, returns the number of communities the user is an admin of
[apiInstance getUserCommunitiesCountWith:username
    admin:admin
              completionHandler: ^('Integer' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiUserControllerApi()
var username = username_example; // {String} 
var opts = {
  'admin': true // {Boolean} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUserCommunitiesCount(username, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getUserCommunitiesCountExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiUserControllerApi();
            var username = username_example;  // String |  (default to null)
            var admin = true;  // Boolean |  (optional)  (default to null)

            try {
                // Get the number of communities a user is a member of. If admin=true, returns the number of communities the user is an admin of
                'Integer' result = apiInstance.getUserCommunitiesCount(username, admin);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiUserControllerApi.getUserCommunitiesCount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiUserControllerApi();
$username = username_example; // String | 
$admin = true; // Boolean | 

try {
    $result = $api_instance->getUserCommunitiesCount($username, $admin);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiUserControllerApi->getUserCommunitiesCount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiUserControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiUserControllerApi->new();
my $username = username_example; # String | 
my $admin = true; # Boolean | 

eval {
    my $result = $api_instance->getUserCommunitiesCount(username => $username, admin => $admin);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiUserControllerApi->getUserCommunitiesCount: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiUserControllerApi()
username = username_example # String |  (default to null)
admin = true # Boolean |  (optional) (default to null)

try:
    # Get the number of communities a user is a member of. If admin=true, returns the number of communities the user is an admin of
    api_response = api_instance.get_user_communities_count(username, admin=admin)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiUserControllerApi->getUserCommunitiesCount: %s\n" % e)
extern crate ApiUserControllerApi;

pub fn main() {
    let username = username_example; // String
    let admin = true; // Boolean

    let mut context = ApiUserControllerApi::Context::default();
    let result = client.getUserCommunitiesCount(username, admin, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
username*
String
Required
Query parameters
Name Description
admin
Boolean

Responses


getUserFollowers

Get user's followers list (pageable)


/api/v1/users/{username}/followers

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://localhost:8443/api/v1/users/{username}/followers?page=56&size=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiUserControllerApi;

import java.io.File;
import java.util.*;

public class ApiUserControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiUserControllerApi apiInstance = new ApiUserControllerApi();
        String username = username_example; // String | 
        Integer page = 56; // Integer | 
        Integer size = 56; // Integer | 

        try {
            User_UserBasicView result = apiInstance.getUserFollowers(username, page, size);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiUserControllerApi#getUserFollowers");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiUserControllerApi;

public class ApiUserControllerApiExample {
    public static void main(String[] args) {
        ApiUserControllerApi apiInstance = new ApiUserControllerApi();
        String username = username_example; // String | 
        Integer page = 56; // Integer | 
        Integer size = 56; // Integer | 

        try {
            User_UserBasicView result = apiInstance.getUserFollowers(username, page, size);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiUserControllerApi#getUserFollowers");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiUserControllerApi *apiInstance = [[ApiUserControllerApi alloc] init];
String *username = username_example; //  (default to null)
Integer *page = 56; //  (optional) (default to 0)
Integer *size = 56; //  (optional) (default to 10)

// Get user's followers list (pageable)
[apiInstance getUserFollowersWith:username
    page:page
    size:size
              completionHandler: ^(User_UserBasicView output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiUserControllerApi()
var username = username_example; // {String} 
var opts = {
  'page': 56, // {Integer} 
  'size': 56 // {Integer} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUserFollowers(username, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getUserFollowersExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiUserControllerApi();
            var username = username_example;  // String |  (default to null)
            var page = 56;  // Integer |  (optional)  (default to 0)
            var size = 56;  // Integer |  (optional)  (default to 10)

            try {
                // Get user's followers list (pageable)
                User_UserBasicView result = apiInstance.getUserFollowers(username, page, size);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiUserControllerApi.getUserFollowers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiUserControllerApi();
$username = username_example; // String | 
$page = 56; // Integer | 
$size = 56; // Integer | 

try {
    $result = $api_instance->getUserFollowers($username, $page, $size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiUserControllerApi->getUserFollowers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiUserControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiUserControllerApi->new();
my $username = username_example; # String | 
my $page = 56; # Integer | 
my $size = 56; # Integer | 

eval {
    my $result = $api_instance->getUserFollowers(username => $username, page => $page, size => $size);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiUserControllerApi->getUserFollowers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiUserControllerApi()
username = username_example # String |  (default to null)
page = 56 # Integer |  (optional) (default to 0)
size = 56 # Integer |  (optional) (default to 10)

try:
    # Get user's followers list (pageable)
    api_response = api_instance.get_user_followers(username, page=page, size=size)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiUserControllerApi->getUserFollowers: %s\n" % e)
extern crate ApiUserControllerApi;

pub fn main() {
    let username = username_example; // String
    let page = 56; // Integer
    let size = 56; // Integer

    let mut context = ApiUserControllerApi::Context::default();
    let result = client.getUserFollowers(username, page, size, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
username*
String
Required
Query parameters
Name Description
page
Integer (int32)
size
Integer (int32)

Responses


getUserFollowing

Get user's following list (pageable)


/api/v1/users/{username}/following

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://localhost:8443/api/v1/users/{username}/following?page=56&size=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiUserControllerApi;

import java.io.File;
import java.util.*;

public class ApiUserControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiUserControllerApi apiInstance = new ApiUserControllerApi();
        String username = username_example; // String | 
        Integer page = 56; // Integer | 
        Integer size = 56; // Integer | 

        try {
            User_UserBasicView result = apiInstance.getUserFollowing(username, page, size);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiUserControllerApi#getUserFollowing");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiUserControllerApi;

public class ApiUserControllerApiExample {
    public static void main(String[] args) {
        ApiUserControllerApi apiInstance = new ApiUserControllerApi();
        String username = username_example; // String | 
        Integer page = 56; // Integer | 
        Integer size = 56; // Integer | 

        try {
            User_UserBasicView result = apiInstance.getUserFollowing(username, page, size);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiUserControllerApi#getUserFollowing");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiUserControllerApi *apiInstance = [[ApiUserControllerApi alloc] init];
String *username = username_example; //  (default to null)
Integer *page = 56; //  (optional) (default to 0)
Integer *size = 56; //  (optional) (default to 10)

// Get user's following list (pageable)
[apiInstance getUserFollowingWith:username
    page:page
    size:size
              completionHandler: ^(User_UserBasicView output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiUserControllerApi()
var username = username_example; // {String} 
var opts = {
  'page': 56, // {Integer} 
  'size': 56 // {Integer} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUserFollowing(username, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getUserFollowingExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiUserControllerApi();
            var username = username_example;  // String |  (default to null)
            var page = 56;  // Integer |  (optional)  (default to 0)
            var size = 56;  // Integer |  (optional)  (default to 10)

            try {
                // Get user's following list (pageable)
                User_UserBasicView result = apiInstance.getUserFollowing(username, page, size);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiUserControllerApi.getUserFollowing: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiUserControllerApi();
$username = username_example; // String | 
$page = 56; // Integer | 
$size = 56; // Integer | 

try {
    $result = $api_instance->getUserFollowing($username, $page, $size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiUserControllerApi->getUserFollowing: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiUserControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiUserControllerApi->new();
my $username = username_example; # String | 
my $page = 56; # Integer | 
my $size = 56; # Integer | 

eval {
    my $result = $api_instance->getUserFollowing(username => $username, page => $page, size => $size);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiUserControllerApi->getUserFollowing: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiUserControllerApi()
username = username_example # String |  (default to null)
page = 56 # Integer |  (optional) (default to 0)
size = 56 # Integer |  (optional) (default to 10)

try:
    # Get user's following list (pageable)
    api_response = api_instance.get_user_following(username, page=page, size=size)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiUserControllerApi->getUserFollowing: %s\n" % e)
extern crate ApiUserControllerApi;

pub fn main() {
    let username = username_example; // String
    let page = 56; // Integer
    let size = 56; // Integer

    let mut context = ApiUserControllerApi::Context::default();
    let result = client.getUserFollowing(username, page, size, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
username*
String
Required
Query parameters
Name Description
page
Integer (int32)
size
Integer (int32)

Responses


getUserPostsCount

Get the number of posts a user has made


/api/v1/users/{username}/posts/count

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://localhost:8443/api/v1/users/{username}/posts/count"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiUserControllerApi;

import java.io.File;
import java.util.*;

public class ApiUserControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiUserControllerApi apiInstance = new ApiUserControllerApi();
        String username = username_example; // String | 

        try {
            'Integer' result = apiInstance.getUserPostsCount(username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiUserControllerApi#getUserPostsCount");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiUserControllerApi;

public class ApiUserControllerApiExample {
    public static void main(String[] args) {
        ApiUserControllerApi apiInstance = new ApiUserControllerApi();
        String username = username_example; // String | 

        try {
            'Integer' result = apiInstance.getUserPostsCount(username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiUserControllerApi#getUserPostsCount");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiUserControllerApi *apiInstance = [[ApiUserControllerApi alloc] init];
String *username = username_example; //  (default to null)

// Get the number of posts a user has made
[apiInstance getUserPostsCountWith:username
              completionHandler: ^('Integer' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiUserControllerApi()
var username = username_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUserPostsCount(username, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getUserPostsCountExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiUserControllerApi();
            var username = username_example;  // String |  (default to null)

            try {
                // Get the number of posts a user has made
                'Integer' result = apiInstance.getUserPostsCount(username);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiUserControllerApi.getUserPostsCount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiUserControllerApi();
$username = username_example; // String | 

try {
    $result = $api_instance->getUserPostsCount($username);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiUserControllerApi->getUserPostsCount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiUserControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiUserControllerApi->new();
my $username = username_example; # String | 

eval {
    my $result = $api_instance->getUserPostsCount(username => $username);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiUserControllerApi->getUserPostsCount: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiUserControllerApi()
username = username_example # String |  (default to null)

try:
    # Get the number of posts a user has made
    api_response = api_instance.get_user_posts_count(username)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiUserControllerApi->getUserPostsCount: %s\n" % e)
extern crate ApiUserControllerApi;

pub fn main() {
    let username = username_example; // String

    let mut context = ApiUserControllerApi::Context::default();
    let result = client.getUserPostsCount(username, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
username*
String
Required

Responses


isUserFollowing

Check if user is following another user


/api/v1/users/{follower}/following/{following}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://localhost:8443/api/v1/users/{follower}/following/{following}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiUserControllerApi;

import java.io.File;
import java.util.*;

public class ApiUserControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiUserControllerApi apiInstance = new ApiUserControllerApi();
        String follower = follower_example; // String | 
        String following = following_example; // String | 

        try {
            'Boolean' result = apiInstance.isUserFollowing(follower, following);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiUserControllerApi#isUserFollowing");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiUserControllerApi;

public class ApiUserControllerApiExample {
    public static void main(String[] args) {
        ApiUserControllerApi apiInstance = new ApiUserControllerApi();
        String follower = follower_example; // String | 
        String following = following_example; // String | 

        try {
            'Boolean' result = apiInstance.isUserFollowing(follower, following);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiUserControllerApi#isUserFollowing");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiUserControllerApi *apiInstance = [[ApiUserControllerApi alloc] init];
String *follower = follower_example; //  (default to null)
String *following = following_example; //  (default to null)

// Check if user is following another user
[apiInstance isUserFollowingWith:follower
    following:following
              completionHandler: ^('Boolean' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiUserControllerApi()
var follower = follower_example; // {String} 
var following = following_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.isUserFollowing(follower, following, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class isUserFollowingExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiUserControllerApi();
            var follower = follower_example;  // String |  (default to null)
            var following = following_example;  // String |  (default to null)

            try {
                // Check if user is following another user
                'Boolean' result = apiInstance.isUserFollowing(follower, following);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiUserControllerApi.isUserFollowing: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiUserControllerApi();
$follower = follower_example; // String | 
$following = following_example; // String | 

try {
    $result = $api_instance->isUserFollowing($follower, $following);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiUserControllerApi->isUserFollowing: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiUserControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiUserControllerApi->new();
my $follower = follower_example; # String | 
my $following = following_example; # String | 

eval {
    my $result = $api_instance->isUserFollowing(follower => $follower, following => $following);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiUserControllerApi->isUserFollowing: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiUserControllerApi()
follower = follower_example # String |  (default to null)
following = following_example # String |  (default to null)

try:
    # Check if user is following another user
    api_response = api_instance.is_user_following(follower, following)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiUserControllerApi->isUserFollowing: %s\n" % e)
extern crate ApiUserControllerApi;

pub fn main() {
    let follower = follower_example; // String
    let following = following_example; // String

    let mut context = ApiUserControllerApi::Context::default();
    let result = client.isUserFollowing(follower, following, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
follower*
String
Required
following*
String
Required

Responses


isUsernameTaken

Check if username is taken


/api/v1/users/{username}/taken

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://localhost:8443/api/v1/users/{username}/taken"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiUserControllerApi;

import java.io.File;
import java.util.*;

public class ApiUserControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiUserControllerApi apiInstance = new ApiUserControllerApi();
        String username = username_example; // String | 

        try {
            'Boolean' result = apiInstance.isUsernameTaken(username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiUserControllerApi#isUsernameTaken");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiUserControllerApi;

public class ApiUserControllerApiExample {
    public static void main(String[] args) {
        ApiUserControllerApi apiInstance = new ApiUserControllerApi();
        String username = username_example; // String | 

        try {
            'Boolean' result = apiInstance.isUsernameTaken(username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiUserControllerApi#isUsernameTaken");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiUserControllerApi *apiInstance = [[ApiUserControllerApi alloc] init];
String *username = username_example; //  (default to null)

// Check if username is taken
[apiInstance isUsernameTakenWith:username
              completionHandler: ^('Boolean' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiUserControllerApi()
var username = username_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.isUsernameTaken(username, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class isUsernameTakenExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiUserControllerApi();
            var username = username_example;  // String |  (default to null)

            try {
                // Check if username is taken
                'Boolean' result = apiInstance.isUsernameTaken(username);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiUserControllerApi.isUsernameTaken: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiUserControllerApi();
$username = username_example; // String | 

try {
    $result = $api_instance->isUsernameTaken($username);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiUserControllerApi->isUsernameTaken: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiUserControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiUserControllerApi->new();
my $username = username_example; # String | 

eval {
    my $result = $api_instance->isUsernameTaken(username => $username);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiUserControllerApi->isUsernameTaken: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiUserControllerApi()
username = username_example # String |  (default to null)

try:
    # Check if username is taken
    api_response = api_instance.is_username_taken(username)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiUserControllerApi->isUsernameTaken: %s\n" % e)
extern crate ApiUserControllerApi;

pub fn main() {
    let username = username_example; // String

    let mut context = ApiUserControllerApi::Context::default();
    let result = client.isUsernameTaken(username, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
username*
String
Required

Responses


registerUser

Register a new user


/api/v1/users

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://localhost:8443/api/v1/users" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiUserControllerApi;

import java.io.File;
import java.util.*;

public class ApiUserControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiUserControllerApi apiInstance = new ApiUserControllerApi();
        SignupRequestDTOUserBasicView signupRequestDTOUserBasicView = ; // SignupRequestDTOUserBasicView | 

        try {
            User_UserBasicView result = apiInstance.registerUser(signupRequestDTOUserBasicView);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiUserControllerApi#registerUser");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiUserControllerApi;

public class ApiUserControllerApiExample {
    public static void main(String[] args) {
        ApiUserControllerApi apiInstance = new ApiUserControllerApi();
        SignupRequestDTOUserBasicView signupRequestDTOUserBasicView = ; // SignupRequestDTOUserBasicView | 

        try {
            User_UserBasicView result = apiInstance.registerUser(signupRequestDTOUserBasicView);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiUserControllerApi#registerUser");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiUserControllerApi *apiInstance = [[ApiUserControllerApi alloc] init];
SignupRequestDTOUserBasicView *signupRequestDTOUserBasicView = ; //  (optional)

// Register a new user
[apiInstance registerUserWith:signupRequestDTOUserBasicView
              completionHandler: ^(User_UserBasicView output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiUserControllerApi()
var opts = {
  'signupRequestDTOUserBasicView':  // {SignupRequestDTOUserBasicView} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.registerUser(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class registerUserExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiUserControllerApi();
            var signupRequestDTOUserBasicView = new SignupRequestDTOUserBasicView(); // SignupRequestDTOUserBasicView |  (optional) 

            try {
                // Register a new user
                User_UserBasicView result = apiInstance.registerUser(signupRequestDTOUserBasicView);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiUserControllerApi.registerUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiUserControllerApi();
$signupRequestDTOUserBasicView = ; // SignupRequestDTOUserBasicView | 

try {
    $result = $api_instance->registerUser($signupRequestDTOUserBasicView);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiUserControllerApi->registerUser: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiUserControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiUserControllerApi->new();
my $signupRequestDTOUserBasicView = WWW::OPenAPIClient::Object::SignupRequestDTOUserBasicView->new(); # SignupRequestDTOUserBasicView | 

eval {
    my $result = $api_instance->registerUser(signupRequestDTOUserBasicView => $signupRequestDTOUserBasicView);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiUserControllerApi->registerUser: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiUserControllerApi()
signupRequestDTOUserBasicView =  # SignupRequestDTOUserBasicView |  (optional)

try:
    # Register a new user
    api_response = api_instance.register_user(signupRequestDTOUserBasicView=signupRequestDTOUserBasicView)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiUserControllerApi->registerUser: %s\n" % e)
extern crate ApiUserControllerApi;

pub fn main() {
    let signupRequestDTOUserBasicView = ; // SignupRequestDTOUserBasicView

    let mut context = ApiUserControllerApi::Context::default();
    let result = client.registerUser(signupRequestDTOUserBasicView, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
signupRequestDTOUserBasicView

Responses


searchUsers

Search users by username, email, alias or description. Search Engine's default behaviour


/api/v1/users

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://localhost:8443/api/v1/users?query=query_example&orderByCreationDate=true&page=56&size=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiUserControllerApi;

import java.io.File;
import java.util.*;

public class ApiUserControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiUserControllerApi apiInstance = new ApiUserControllerApi();
        String query = query_example; // String | 
        Boolean orderByCreationDate = true; // Boolean | 
        Integer page = 56; // Integer | 
        Integer size = 56; // Integer | 

        try {
            User_UserBasicView result = apiInstance.searchUsers(query, orderByCreationDate, page, size);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiUserControllerApi#searchUsers");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiUserControllerApi;

public class ApiUserControllerApiExample {
    public static void main(String[] args) {
        ApiUserControllerApi apiInstance = new ApiUserControllerApi();
        String query = query_example; // String | 
        Boolean orderByCreationDate = true; // Boolean | 
        Integer page = 56; // Integer | 
        Integer size = 56; // Integer | 

        try {
            User_UserBasicView result = apiInstance.searchUsers(query, orderByCreationDate, page, size);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiUserControllerApi#searchUsers");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiUserControllerApi *apiInstance = [[ApiUserControllerApi alloc] init];
String *query = query_example; //  (default to null)
Boolean *orderByCreationDate = true; //  (optional) (default to null)
Integer *page = 56; //  (optional) (default to 0)
Integer *size = 56; //  (optional) (default to 10)

// Search users by username, email, alias or description. Search Engine's default behaviour
[apiInstance searchUsersWith:query
    orderByCreationDate:orderByCreationDate
    page:page
    size:size
              completionHandler: ^(User_UserBasicView output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiUserControllerApi()
var query = query_example; // {String} 
var opts = {
  'orderByCreationDate': true, // {Boolean} 
  'page': 56, // {Integer} 
  'size': 56 // {Integer} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchUsers(query, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class searchUsersExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiUserControllerApi();
            var query = query_example;  // String |  (default to null)
            var orderByCreationDate = true;  // Boolean |  (optional)  (default to null)
            var page = 56;  // Integer |  (optional)  (default to 0)
            var size = 56;  // Integer |  (optional)  (default to 10)

            try {
                // Search users by username, email, alias or description. Search Engine's default behaviour
                User_UserBasicView result = apiInstance.searchUsers(query, orderByCreationDate, page, size);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiUserControllerApi.searchUsers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiUserControllerApi();
$query = query_example; // String | 
$orderByCreationDate = true; // Boolean | 
$page = 56; // Integer | 
$size = 56; // Integer | 

try {
    $result = $api_instance->searchUsers($query, $orderByCreationDate, $page, $size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiUserControllerApi->searchUsers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiUserControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiUserControllerApi->new();
my $query = query_example; # String | 
my $orderByCreationDate = true; # Boolean | 
my $page = 56; # Integer | 
my $size = 56; # Integer | 

eval {
    my $result = $api_instance->searchUsers(query => $query, orderByCreationDate => $orderByCreationDate, page => $page, size => $size);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiUserControllerApi->searchUsers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiUserControllerApi()
query = query_example # String |  (default to null)
orderByCreationDate = true # Boolean |  (optional) (default to null)
page = 56 # Integer |  (optional) (default to 0)
size = 56 # Integer |  (optional) (default to 10)

try:
    # Search users by username, email, alias or description. Search Engine's default behaviour
    api_response = api_instance.search_users(query, orderByCreationDate=orderByCreationDate, page=page, size=size)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiUserControllerApi->searchUsers: %s\n" % e)
extern crate ApiUserControllerApi;

pub fn main() {
    let query = query_example; // String
    let orderByCreationDate = true; // Boolean
    let page = 56; // Integer
    let size = 56; // Integer

    let mut context = ApiUserControllerApi::Context::default();
    let result = client.searchUsers(query, orderByCreationDate, page, size, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
query*
String
Required
orderByCreationDate
Boolean
page
Integer (int32)
size
Integer (int32)

Responses


searchUsersOrderByBanCount

Search users and sort by banCount (admin only)


/api/v1/users/bans

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://localhost:8443/api/v1/users/bans?query=query_example&page=56&size=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiUserControllerApi;

import java.io.File;
import java.util.*;

public class ApiUserControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiUserControllerApi apiInstance = new ApiUserControllerApi();
        String query = query_example; // String | 
        Integer page = 56; // Integer | 
        Integer size = 56; // Integer | 

        try {
            User_BanInfo result = apiInstance.searchUsersOrderByBanCount(query, page, size);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiUserControllerApi#searchUsersOrderByBanCount");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiUserControllerApi;

public class ApiUserControllerApiExample {
    public static void main(String[] args) {
        ApiUserControllerApi apiInstance = new ApiUserControllerApi();
        String query = query_example; // String | 
        Integer page = 56; // Integer | 
        Integer size = 56; // Integer | 

        try {
            User_BanInfo result = apiInstance.searchUsersOrderByBanCount(query, page, size);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiUserControllerApi#searchUsersOrderByBanCount");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiUserControllerApi *apiInstance = [[ApiUserControllerApi alloc] init];
String *query = query_example; //  (default to null)
Integer *page = 56; //  (optional) (default to 0)
Integer *size = 56; //  (optional) (default to 10)

// Search users and sort by banCount (admin only)
[apiInstance searchUsersOrderByBanCountWith:query
    page:page
    size:size
              completionHandler: ^(User_BanInfo output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiUserControllerApi()
var query = query_example; // {String} 
var opts = {
  'page': 56, // {Integer} 
  'size': 56 // {Integer} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchUsersOrderByBanCount(query, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class searchUsersOrderByBanCountExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiUserControllerApi();
            var query = query_example;  // String |  (default to null)
            var page = 56;  // Integer |  (optional)  (default to 0)
            var size = 56;  // Integer |  (optional)  (default to 10)

            try {
                // Search users and sort by banCount (admin only)
                User_BanInfo result = apiInstance.searchUsersOrderByBanCount(query, page, size);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiUserControllerApi.searchUsersOrderByBanCount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiUserControllerApi();
$query = query_example; // String | 
$page = 56; // Integer | 
$size = 56; // Integer | 

try {
    $result = $api_instance->searchUsersOrderByBanCount($query, $page, $size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiUserControllerApi->searchUsersOrderByBanCount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiUserControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiUserControllerApi->new();
my $query = query_example; # String | 
my $page = 56; # Integer | 
my $size = 56; # Integer | 

eval {
    my $result = $api_instance->searchUsersOrderByBanCount(query => $query, page => $page, size => $size);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiUserControllerApi->searchUsersOrderByBanCount: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiUserControllerApi()
query = query_example # String |  (default to null)
page = 56 # Integer |  (optional) (default to 0)
size = 56 # Integer |  (optional) (default to 10)

try:
    # Search users and sort by banCount (admin only)
    api_response = api_instance.search_users_order_by_ban_count(query, page=page, size=size)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiUserControllerApi->searchUsersOrderByBanCount: %s\n" % e)
extern crate ApiUserControllerApi;

pub fn main() {
    let query = query_example; // String
    let page = 56; // Integer
    let size = 56; // Integer

    let mut context = ApiUserControllerApi::Context::default();
    let result = client.searchUsersOrderByBanCount(query, page, size, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
query*
String
Required
page
Integer (int32)
size
Integer (int32)

Responses


updateUser

Update user data


/api/v1/users/{username}

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 "https://localhost:8443/api/v1/users/{username}?action=action_example&otherUsername=otherUsername_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ApiUserControllerApi;

import java.io.File;
import java.util.*;

public class ApiUserControllerApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ApiUserControllerApi apiInstance = new ApiUserControllerApi();
        String username = username_example; // String | 
        String action = action_example; // String | 
        String otherUsername = otherUsername_example; // String | 

        try {
            User_UserBasicView result = apiInstance.updateUser(username, action, otherUsername);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiUserControllerApi#updateUser");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ApiUserControllerApi;

public class ApiUserControllerApiExample {
    public static void main(String[] args) {
        ApiUserControllerApi apiInstance = new ApiUserControllerApi();
        String username = username_example; // String | 
        String action = action_example; // String | 
        String otherUsername = otherUsername_example; // String | 

        try {
            User_UserBasicView result = apiInstance.updateUser(username, action, otherUsername);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiUserControllerApi#updateUser");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ApiUserControllerApi *apiInstance = [[ApiUserControllerApi alloc] init];
String *username = username_example; //  (default to null)
String *action = action_example; //  (default to null)
String *otherUsername = otherUsername_example; //  (optional) (default to null)

// Update user data
[apiInstance updateUserWith:username
    action:action
    otherUsername:otherUsername
              completionHandler: ^(User_UserBasicView output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenApiDefinition = require('open_api_definition');

// Create an instance of the API class
var api = new OpenApiDefinition.ApiUserControllerApi()
var username = username_example; // {String} 
var action = action_example; // {String} 
var opts = {
  'otherUsername': otherUsername_example // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateUser(username, action, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class updateUserExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ApiUserControllerApi();
            var username = username_example;  // String |  (default to null)
            var action = action_example;  // String |  (default to null)
            var otherUsername = otherUsername_example;  // String |  (optional)  (default to null)

            try {
                // Update user data
                User_UserBasicView result = apiInstance.updateUser(username, action, otherUsername);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ApiUserControllerApi.updateUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ApiUserControllerApi();
$username = username_example; // String | 
$action = action_example; // String | 
$otherUsername = otherUsername_example; // String | 

try {
    $result = $api_instance->updateUser($username, $action, $otherUsername);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiUserControllerApi->updateUser: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ApiUserControllerApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ApiUserControllerApi->new();
my $username = username_example; # String | 
my $action = action_example; # String | 
my $otherUsername = otherUsername_example; # String | 

eval {
    my $result = $api_instance->updateUser(username => $username, action => $action, otherUsername => $otherUsername);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiUserControllerApi->updateUser: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ApiUserControllerApi()
username = username_example # String |  (default to null)
action = action_example # String |  (default to null)
otherUsername = otherUsername_example # String |  (optional) (default to null)

try:
    # Update user data
    api_response = api_instance.update_user(username, action, otherUsername=otherUsername)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiUserControllerApi->updateUser: %s\n" % e)
extern crate ApiUserControllerApi;

pub fn main() {
    let username = username_example; // String
    let action = action_example; // String
    let otherUsername = otherUsername_example; // String

    let mut context = ApiUserControllerApi::Context::default();
    let result = client.updateUser(username, action, otherUsername, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
username*
String
Required
Query parameters
Name Description
action*
String
Required
otherUsername
String

Responses